MythTV  master
Public Member Functions | Protected Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
AudioOutputJACK Class Reference

#include <libmyth/audio/audiooutputjack.h>

Inheritance diagram for AudioOutputJACK:
[legend]
Collaboration diagram for AudioOutputJACK:
[legend]

Public Member Functions

 AudioOutputJACK (const AudioSettings &settings)
 
 ~AudioOutputJACK () override
 
int GetVolumeChannel (int channel) const override
 
void SetVolumeChannel (int channel, int volume) override
 
- Public Member Functions inherited from AudioOutputBase
 AudioOutputBase (const AudioSettings &settings)
 
 ~AudioOutputBase () override
 Destructor. More...
 
AudioOutputSettingsGetOutputSettingsCleaned (bool digital=true) override
 Returns capabilities supported by the audio device amended to take into account the digital audio options (AC3, DTS, E-AC3 and TrueHD) More...
 
AudioOutputSettingsGetOutputSettingsUsers (bool digital=false) override
 Returns capabilities supported by the audio device amended to take into account the digital audio options (AC3, DTS, E-AC3 and TrueHD) as well as the user settings. More...
 
void Reconfigure (const AudioSettings &settings) override
 (Re)Configure AudioOutputBase More...
 
void SetEffDsp (int dsprate) override
 Set the effective DSP rate. More...
 
void SetStretchFactor (float factor) override
 Set the timestretch factor. More...
 
float GetStretchFactor (void) const override
 Get the timetretch factor. More...
 
int GetChannels (void) const override
 
AudioFormat GetFormat (void) const override
 
int GetBytesPerFrame (void) const override
 
bool CanPassthrough (int samplerate, int channels, AVCodecID codec, int profile) const override
 Test if we can output digital audio and if sample rate is supported. More...
 
bool CanDownmix (void) const override
 
bool IsUpmixing (void) override
 Source is currently being upmixed. More...
 
bool ToggleUpmix (void) override
 Toggle between stereo and upmixed 5.1 if the source material is stereo. More...
 
bool CanUpmix (void) override
 Upmixing of the current source is available if requested. More...
 
bool CanProcess (AudioFormat) override
 
uint32_t CanProcess (void) override
 
void Reset (void) override
 Reset the audiobuffer, timecode and mythmusic visualisation. More...
 
void SetSWVolume (int new_volume, bool save) override
 Set the volume for software volume control. More...
 
int GetSWVolume (void) override
 Get the volume for software volume control. More...
 
bool AddFrames (void *buffer, int frames, std::chrono::milliseconds timecode) override
 Add frames to the audiobuffer and perform any required processing. More...
 
bool AddData (void *buffer, int len, std::chrono::milliseconds timecode, int frames) override
 Add data to the audiobuffer and perform any required processing. More...
 
bool NeedDecodingBeforePassthrough () const override
 
std::chrono::milliseconds LengthLastData (void) const override
 
void SetTimecode (std::chrono::milliseconds timecode) override
 Set the timecode of the samples most recently added to the audiobuffer. More...
 
bool IsPaused (void) const override
 
void Pause (bool paused) override
 
void PauseUntilBuffered (void) override
 
void Drain (void) override
 Block until all available frames have been written to the device. More...
 
std::chrono::milliseconds GetAudiotime (void) override
 Calculate the timecode of the samples that are about to become audible. More...
 
std::chrono::milliseconds GetAudioBufferedTime (void) override
 Get the difference in timecode between the samples that are about to become audible and the samples most recently added to the audiobuffer, i.e. More...
 
virtual void Status (void)
 Report status via an OutputEvent. More...
 
void SetSourceBitrate (int rate) override
 Set the bitrate of the source material, reported in periodic OutputEvents. More...
 
void GetBufferStatus (uint &fill, uint &total) override
 Fill in the number of bytes in the audiobuffer and the total size of the audiobuffer. More...
 
void bufferOutputData (bool y) override
 
int readOutputData (unsigned char *read_buffer, size_t max_length) override
 
- Public Member Functions inherited from AudioOutput
 AudioOutput ()=default
 
 ~AudioOutput () override
 
QString GetError (void) const
 
QString GetWarning (void) const
 
bool PulseStatus (void) const
 
virtual int DecodeAudio (AVCodecContext *ctx, uint8_t *buffer, int &data_size, const AVPacket *pkt)
 Utility routine. More...
 
- Public Member Functions inherited from VolumeBase
 VolumeBase ()
 
virtual ~VolumeBase ()=default
 
void SWVolume (bool set)
 
bool SWVolume (void) const
 
virtual uint GetCurrentVolume (void) const
 
virtual void SetCurrentVolume (int value)
 
virtual void AdjustCurrentVolume (int change)
 
virtual void ToggleMute (void)
 
virtual MuteState GetMuteState (void) const
 
virtual MuteState SetMuteState (MuteState)
 
- Public Member Functions inherited from OutputListeners
 OutputListeners ()=default
 
 ~OutputListeners () override=default
 
bool hasVisual (void)
 
void addVisual (MythTV::Visual *v)
 
void removeVisual (MythTV::Visual *v)
 
QMutex * mutex ()
 
void setBufferSize (unsigned int sz)
 
unsigned int bufferSize () const
 
- Public Member Functions inherited from MythObservable
 MythObservable ()
 
virtual ~MythObservable ()
 
void addListener (QObject *listener)
 Add a listener to the observable. More...
 
void removeListener (QObject *listener)
 Remove a listener to the observable. More...
 
void dispatch (const MythEvent &event)
 Dispatch an event to all listeners. More...
 
bool hasListeners (void)
 
- Public Member Functions inherited from MThread
 MThread (const QString &objectName)
 Standard constructor. More...
 
 MThread (const QString &objectName, QRunnable *runnable)
 Use this constructor if you want the default run() method to run the QRunnable's run() method instead of entering the Qt event loop. More...
 
virtual ~MThread ()
 
 MThread (const MThread &)=delete
 
MThreadoperator= (const MThread &)=delete
 
void RunProlog (void)
 Sets up a thread, call this if you reimplement run(). More...
 
void RunEpilog (void)
 Cleans up a thread's resources, call this if you reimplement run(). More...
 
QThread * qthread (void)
 Returns the thread, this will always return the same pointer no matter how often you restart the thread. More...
 
void setObjectName (const QString &name)
 
QString objectName (void) const
 
void setPriority (QThread::Priority priority)
 
QThread::Priority priority (void) const
 
bool isFinished (void) const
 
bool isRunning (void) const
 
void setStackSize (uint stackSize)
 
uint stackSize (void) const
 
void exit (int retcode=0)
 Use this to exit from the thread if you are using a Qt event loop. More...
 
void start (QThread::Priority p=QThread::InheritPriority)
 Tell MThread to start running the thread in the near future. More...
 
void terminate (void)
 Kill a thread unsafely. More...
 
void quit (void)
 calls exit(0) More...
 
bool wait (std::chrono::milliseconds time=std::chrono::milliseconds::max())
 Wait for the MThread to exit, with a maximum timeout. More...
 

Protected Member Functions

bool OpenDevice (void) override
 
void CloseDevice (void) override
 
void WriteAudio (unsigned char *aubuf, int size) override
 
int GetBufferedOnSoundcard (void) const override
 Return the size in bytes of frames currently in the audio buffer adjusted with the audio playback latency. More...
 
AudioOutputSettingsGetOutputSettings (bool digital) override
 
bool StartOutputThread (void) override
 
void StopOutputThread (void) override
 
- Protected Member Functions inherited from AudioOutputBase
void InitSettings (const AudioSettings &settings)
 
void KillAudio (void)
 Kill the output thread and cleanup. More...
 
int GetAudioData (uchar *buffer, int buf_size, bool full_buffer, volatile uint *local_raud=nullptr)
 Copy frames from the audiobuffer into the buffer provided. More...
 
void OutputAudioLoop (void)
 Run in the output thread, write frames to the output device as they become available and there's space in the device buffer to write them. More...
 
void run () override
 Main routine for the output thread. More...
 
int CheckFreeSpace (int &frames)
 Check that there's enough space in the audiobuffer to write the provided number of frames. More...
 
int audiolen () const
 Get the number of bytes in the audiobuffer. More...
 
int audiofree () const
 Get the free space in the audiobuffer in bytes. More...
 
int audioready () const
 Get the scaled number of bytes in the audiobuffer, i.e. More...
 
void SetStretchFactorLocked (float factor)
 Set the timestretch factor. More...
 
std::chrono::milliseconds GetBaseAudBufTimeCode () const
 
bool usesSpdif () const
 
- Protected Member Functions inherited from AudioOutput
void Error (const QString &msg)
 
void SilentError (const QString &msg)
 
void Warn (const QString &msg)
 
void ClearError (void)
 
void ClearWarning (void)
 
- Protected Member Functions inherited from VolumeBase
void UpdateVolume (void)
 
void SyncVolume (void)
 
void SetChannels (int new_channels)
 
- Protected Member Functions inherited from OutputListeners
void error (const QString &e)
 
void dispatchVisual (uchar *b, unsigned long b_len, std::chrono::milliseconds timecode, int chan, int prec)
 
void prepareVisuals ()
 
- Protected Member Functions inherited from MThread
int exec (void)
 Enters the qt event loop. call exit or quit to exit thread. More...
 

Private Member Functions

 Q_DECLARE_TR_FUNCTIONS (AudioOutputJACK)
 
void VolumeInit (void)
 
int JackCallback (jack_nframes_t nframes)
 
int JackXRunCallback ()
 
int JackGraphOrderCallback ()
 
const char ** JackGetPorts (void)
 
bool JackConnectPorts (const char **)
 
void JackClientClose (jack_client_t **client)
 
void DeinterleaveAudio (const float *aubuf, float **bufs, int nframes, const jack_vol_array &channel_volumes)
 

Static Private Member Functions

static int JackCallbackHelper (jack_nframes_t nframes, void *arg)
 
static int JackXRunCallbackHelper (void *arg)
 
static int JackGraphOrderCallbackHelper (void *arg)
 
static jack_client_t * JackClientOpen (void)
 

Private Attributes

jack_port_array m_ports {}
 
jack_vol_array m_chanVolumes {}
 
jack_client_t * m_client {nullptr}
 
jack_client_t * m_staleClient {nullptr}
 
int m_jackLatency {0}
 
int m_jackXruns {0}
 
unsigned char * m_auBuf {nullptr}
 

Additional Inherited Members

- Public Types inherited from AudioOutput
using ADCVect = QVector< AudioDeviceConfig >
 
- Static Public Member Functions inherited from AudioOutputBase
static const char * quality_string (int q)
 
- Static Public Member Functions inherited from AudioOutput
static void Cleanup (void)
 
static ADCVectGetOutputList (void)
 
static AudioDeviceConfigGetAudioDeviceConfig (QString &name, const QString &desc, bool willsuspendpa=false)
 
static AudioOutputOpenAudio (const QString &main_device, const QString &passthru_device, AudioFormat format, int channels, AVCodecID codec, int samplerate, AudioOutputSource source, bool set_initial_vol, bool passthru, int upmixer_startup=0, AudioOutputSettings *custom=nullptr)
 
static AudioOutputOpenAudio (AudioSettings &settings, bool willsuspendpa=true)
 
static AudioOutputOpenAudio (const QString &main_device, const QString &passthru_device=QString(), bool willsuspendpa=true)
 
- Static Public Member Functions inherited from VolumeBase
static MuteState NextMuteState (MuteState)
 
- Static Public Member Functions inherited from MThread
static void ThreadSetup (const QString &name)
 This is to be called on startup in those few threads that haven't been ported to MThread. More...
 
static void ThreadCleanup (void)
 This is to be called on exit in those few threads that haven't been ported to MThread. More...
 
static void Cleanup (void)
 This will print out all the running threads, call exit(1) on each and then wait up to 5 seconds total for all the threads to exit. More...
 
static void GetAllThreadNames (QStringList &list)
 
static void GetAllRunningThreadNames (QStringList &list)
 
- Static Public Attributes inherited from AudioOutputBase
static const uint kAudioSRCInputSize = 16384
 
static const uint kAudioRingBufferSize = 10239936U
 Audio Buffer Size – should be divisible by 32,24,16,12,10,8,6,4,2.. More...
 
- Static Public Attributes inherited from AudioOutput
static const int kMaxSizeBuffer = 384000
 kMaxSizeBuffer is the maximum size of a buffer to be used with DecodeAudio More...
 
- Protected Types inherited from AudioOutputBase
enum  : std::int8_t { QUALITY_DISABLED = -1, QUALITY_LOW = 0, QUALITY_MEDIUM = 1, QUALITY_HIGH = 2 }
 
- Static Protected Member Functions inherited from MThread
static void setTerminationEnabled (bool enabled=true)
 
static void usleep (std::chrono::microseconds time)
 
template<typename R , typename P >
static std::enable_if_t< std::chrono::treat_as_floating_point< R >::value, void > usleep (std::chrono::duration< R, P > time)
 
- Protected Attributes inherited from AudioOutputBase
int m_channels {-1}
 
AVCodecID m_codec {AV_CODEC_ID_NONE}
 
int m_bytesPerFrame {0}
 
int m_outputBytesPerFrame {0}
 
AudioFormat m_format {FORMAT_NONE}
 
AudioFormat m_outputFormat {FORMAT_NONE}
 
int m_sampleRate {-1}
 
int m_effDsp {0}
 
int m_fragmentSize {0}
 
long m_soundcardBufferSize {0}
 
QString m_mainDevice
 
QString m_passthruDevice
 
bool m_discreteDigital {false}
 
bool m_passthru {false}
 
bool m_enc {false}
 
bool m_reEnc {false}
 
float m_stretchFactor {1.0F}
 
int m_effStretchFactor {100000}
 
AudioOutputSource m_source
 
bool m_killAudio {false}
 
bool m_pauseAudio {false}
 
bool m_actuallyPaused {false}
 
bool m_wasPaused {false}
 
bool m_unpauseWhenReady {false}
 
bool m_setInitialVol
 
bool m_bufferOutputDataForUse {false}
 
int m_configuredChannels {0}
 
int m_maxChannels {0}
 
int m_srcQuality {QUALITY_MEDIUM}
 
long m_sourceBitRate {-1}
 
int m_sourceSampleRate {0}
 
- Protected Attributes inherited from AudioOutput
QString m_lastError
 
QString m_lastWarn
 
bool m_pulseWasSuspended {false}
 
AVFramem_frame {nullptr}
 
- Protected Attributes inherited from VolumeBase
bool m_internalVol {false}
 
- Protected Attributes inherited from MythObservable
QMutex * m_lock {nullptr}
 
QSet< QObject * > m_listeners
 
- Protected Attributes inherited from MThread
MThreadInternalm_thread {nullptr}
 
QRunnable * m_runnable {nullptr}
 
bool m_prologExecuted {true}
 
bool m_epilogExecuted {true}
 

Detailed Description

Definition at line 19 of file audiooutputjack.h.

Constructor & Destructor Documentation

◆ AudioOutputJACK()

AudioOutputJACK::AudioOutputJACK ( const AudioSettings settings)
explicit

Definition at line 38 of file audiooutputjack.cpp.

◆ ~AudioOutputJACK()

AudioOutputJACK::~AudioOutputJACK ( )
override

Definition at line 113 of file audiooutputjack.cpp.

Member Function Documentation

◆ Q_DECLARE_TR_FUNCTIONS()

AudioOutputJACK::Q_DECLARE_TR_FUNCTIONS ( AudioOutputJACK  )
private

◆ GetVolumeChannel()

int AudioOutputJACK::GetVolumeChannel ( int  channel) const
overridevirtual

Implements VolumeBase.

Definition at line 511 of file audiooutputjack.cpp.

◆ SetVolumeChannel()

void AudioOutputJACK::SetVolumeChannel ( int  channel,
int  volume 
)
overridevirtual

Implements VolumeBase.

Definition at line 524 of file audiooutputjack.cpp.

◆ OpenDevice()

bool AudioOutputJACK::OpenDevice ( void  )
overrideprotectedvirtual

Implements AudioOutputBase.

Definition at line 119 of file audiooutputjack.cpp.

◆ CloseDevice()

void AudioOutputJACK::CloseDevice ( void  )
overrideprotectedvirtual

Implements AudioOutputBase.

Definition at line 224 of file audiooutputjack.cpp.

◆ WriteAudio()

void AudioOutputJACK::WriteAudio ( unsigned char *  aubuf,
int  size 
)
overrideprotectedvirtual

Implements AudioOutputBase.

Definition at line 561 of file audiooutputjack.cpp.

◆ GetBufferedOnSoundcard()

int AudioOutputJACK::GetBufferedOnSoundcard ( void  ) const
overrideprotectedvirtual

Return the size in bytes of frames currently in the audio buffer adjusted with the audio playback latency.

Implements AudioOutputBase.

Definition at line 240 of file audiooutputjack.cpp.

◆ GetOutputSettings()

AudioOutputSettings * AudioOutputJACK::GetOutputSettings ( bool  digital)
overrideprotectedvirtual

Reimplemented from AudioOutputBase.

Definition at line 50 of file audiooutputjack.cpp.

◆ StartOutputThread()

bool AudioOutputJACK::StartOutputThread ( void  )
overrideprotectedvirtual

Reimplemented from AudioOutputBase.

Definition at line 551 of file audiooutputjack.cpp.

◆ StopOutputThread()

void AudioOutputJACK::StopOutputThread ( void  )
overrideprotectedvirtual

Reimplemented from AudioOutputBase.

Definition at line 556 of file audiooutputjack.cpp.

◆ VolumeInit()

void AudioOutputJACK::VolumeInit ( void  )
private

Definition at line 498 of file audiooutputjack.cpp.

Referenced by OpenDevice().

◆ JackCallback()

int AudioOutputJACK::JackCallback ( jack_nframes_t  nframes)
inlineprivate

Definition at line 358 of file audiooutputjack.cpp.

Referenced by JackCallbackHelper().

◆ JackCallbackHelper()

int AudioOutputJACK::JackCallbackHelper ( jack_nframes_t  nframes,
void *  arg 
)
staticprivate

Definition at line 343 of file audiooutputjack.cpp.

Referenced by OpenDevice().

◆ JackXRunCallback()

int AudioOutputJACK::JackXRunCallback ( )
inlineprivate

Definition at line 448 of file audiooutputjack.cpp.

Referenced by JackXRunCallbackHelper().

◆ JackXRunCallbackHelper()

int AudioOutputJACK::JackXRunCallbackHelper ( void *  arg)
staticprivate

Definition at line 439 of file audiooutputjack.cpp.

Referenced by OpenDevice().

◆ JackGraphOrderCallback()

int AudioOutputJACK::JackGraphOrderCallback ( )
inlineprivate

Definition at line 477 of file audiooutputjack.cpp.

Referenced by JackGraphOrderCallbackHelper().

◆ JackGraphOrderCallbackHelper()

int AudioOutputJACK::JackGraphOrderCallbackHelper ( void *  arg)
staticprivate

Definition at line 467 of file audiooutputjack.cpp.

Referenced by OpenDevice().

◆ JackClientOpen()

jack_client_t * AudioOutputJACK::JackClientOpen ( void  )
staticprivate

Definition at line 571 of file audiooutputjack.cpp.

Referenced by GetOutputSettings(), and OpenDevice().

◆ JackGetPorts()

const char ** AudioOutputJACK::JackGetPorts ( void  )
private

Definition at line 583 of file audiooutputjack.cpp.

Referenced by GetOutputSettings(), and OpenDevice().

◆ JackConnectPorts()

bool AudioOutputJACK::JackConnectPorts ( const char **  matching_ports)
private

Definition at line 605 of file audiooutputjack.cpp.

Referenced by OpenDevice().

◆ JackClientClose()

void AudioOutputJACK::JackClientClose ( jack_client_t **  client)
inlineprivate

Definition at line 622 of file audiooutputjack.cpp.

Referenced by CloseDevice(), GetOutputSettings(), JackCallback(), and OpenDevice().

◆ DeinterleaveAudio()

void AudioOutputJACK::DeinterleaveAudio ( const float *  aubuf,
float **  bufs,
int  nframes,
const jack_vol_array channel_volumes 
)
private

Definition at line 254 of file audiooutputjack.cpp.

Referenced by JackCallback().

Member Data Documentation

◆ m_ports

jack_port_array AudioOutputJACK::m_ports {}
private

◆ m_chanVolumes

jack_vol_array AudioOutputJACK::m_chanVolumes {}
private

◆ m_client

jack_client_t* AudioOutputJACK::m_client {nullptr}
private

◆ m_staleClient

jack_client_t* AudioOutputJACK::m_staleClient {nullptr}
private

Definition at line 67 of file audiooutputjack.h.

Referenced by CloseDevice(), and JackCallback().

◆ m_jackLatency

int AudioOutputJACK::m_jackLatency {0}
private

Definition at line 68 of file audiooutputjack.h.

Referenced by JackGraphOrderCallback().

◆ m_jackXruns

int AudioOutputJACK::m_jackXruns {0}
private

Definition at line 69 of file audiooutputjack.h.

Referenced by JackCallback(), and JackXRunCallback().

◆ m_auBuf

unsigned char* AudioOutputJACK::m_auBuf {nullptr}
private

Definition at line 70 of file audiooutputjack.h.

Referenced by CloseDevice(), JackCallback(), and OpenDevice().


The documentation for this class was generated from the following files: