#include <pulselayer.h>

Inheritance diagram for jami::PulseLayer:

Collaboration diagram for jami::PulseLayer:

Public Member Functions
int	getAudioDeviceIndex (const std::string &descr, AudioDeviceType type) const

int	getAudioDeviceIndexByName (const std::string &name, AudioDeviceType type) const

std::string	getAudioDeviceName (int index, AudioDeviceType type) const

virtual std::vector< std::string >	getCaptureDeviceList () const

virtual std::vector< std::string >	getPlaybackDeviceList () const

bool	inSinkList (const std::string &deviceName)

bool	inSourceList (const std::string &deviceName)

	PulseLayer (AudioPreference &pref)

void	readFromMic ()
	Write data from the ring buffer to the hardware and read data from the hardware.

void	ringtoneToSpeaker ()

virtual void	startCaptureStream (const std::string &id) override
	Start a capture stream on the given device (eg.

virtual void	startStream (AudioDeviceType stream)
	Start the capture stream and prepare the playback stream.

virtual void	stopCaptureStream (const std::string &id) override
	Stop an ongoing capture stream on the given device.

virtual void	stopStream (AudioDeviceType stream=AudioDeviceType::ALL)
	Stop the playback and capture streams.

void	updateServerInfo ()

void	updateSinkList ()

void	updateSourceList ()

void	writeToSpeaker ()

	~PulseLayer ()

Public Member Functions inherited from jami::AudioLayer
	AudioLayer (const AudioPreference &)

void	flushMain ()
	Flush main buffer.

void	flushUrgent ()
	Flush urgent buffer.

double	getCaptureGain () const
	Get capture stream gain (microphone)

AudioFormat	getFormat () const
	Get the audio format of the layer (sample rate & channel number).

double	getPlaybackGain () const
	Get playback stream gain (speaker)

unsigned int	getSampleRate () const
	Get the sample rate of the audio layer.

bool	isCaptureMuted () const

bool	isPlaybackMuted () const

bool	isRingtoneMuted () const

bool	isStarted () const
	Determine whether or not the audio layer is active (i.e.

void	muteCapture (bool muted)
	Mute capture (microphone)

void	mutePlayback (bool muted)
	Mute playback.

void	muteRingtone (bool muted)

void	notifyIncomingCall ()
	Emit an audio notification (beep) on incoming calls.

void	playIncomingCallNotification (bool play)
	Start/Stop playing the incoming call notification sound (beep) while playing back audio (typically during an ongoing call).

void	putUrgent (std::shared_ptr< AudioFrame > buffer)
	Send a chunk of data to the hardware buffer to start the playback Copy data in the urgent buffer.

void	setCaptureGain (double gain)
	Set capture stream gain (microphone) Range should be [-1.0, 1.0].

void	setPlaybackGain (double gain)
	Set playback stream gain (speaker) Range should be [-1.0, 1.0].

template<class Rep , class Period >
bool	waitForStart (const std::chrono::duration< Rep, Period > &rel_time) const

virtual	~AudioLayer ()

Friends
class	AudioLayerTest

Additional Inherited Members
Protected Types inherited from jami::AudioLayer
enum class	Status : uint8_t { Idle , Starting , Started }

Protected Member Functions inherited from jami::AudioLayer
void	devicesChanged ()

void	flush ()

std::shared_ptr< AudioFrame >	getPlayback (AudioFormat format, size_t samples)

std::shared_ptr< AudioFrame >	getToPlay (AudioFormat format, size_t writableSamples)

std::shared_ptr< AudioFrame >	getToRing (AudioFormat format, size_t writableSamples)

void	hardwareFormatAvailable (AudioFormat playback, size_t bufSize=0)
	Callback to be called by derived classes when the audio output is opened.

void	hardwareInputFormatAvailable (AudioFormat capture)
	Set the input format on necessary objects.

void	playbackChanged (bool started)

void	putRecorded (std::shared_ptr< AudioFrame > &&frame)

void	recordChanged (bool started)

void	setHasNativeAEC (bool hasEAC)

void	setHasNativeNS (bool hasNS)

Protected Attributes inherited from jami::AudioLayer
AudioFormat	audioFormat_
	Sample Rate that should be sent to the sound card.

AudioFormat	audioInputFormat_
	Sample Rate for input.

double	captureGain_
	Gain applied to mic signal.

bool	hasNativeAEC_ {true}

bool	hasNativeNS_ {false}

bool	isCaptureMuted_
	True if capture is not to be used.

bool	isPlaybackMuted_
	True if playback is not to be used.

bool	isRingtoneMuted_ {false}
	True if ringtone should be muted.

std::shared_ptr< RingBuffer >	mainRingBuffer_
	Buffers for audio processing.

std::mutex	mutex_ {}
	Lock for the entire audio layer.

size_t	nativeFrameSize_ {0}

double	playbackGain_
	Gain applied to playback signal.

std::unique_ptr< AudioFrameResizer >	playbackQueue_

bool	playbackStarted_ {false}

const AudioPreference &	pref_

bool	recordStarted_ {false}

std::unique_ptr< Resampler >	resampler_
	Manage sampling rate conversion.

std::condition_variable	startedCv_

std::atomic< Status >	status_ {Status::Idle}
	Whether or not the audio layer's playback stream is started.

RingBuffer	urgentRingBuffer_
	Urgent ring buffer used for ringtones.

Detailed Description

Definition at line 109 of file pulselayer.h.

Constructor & Destructor Documentation

◆ PulseLayer()

jami::PulseLayer::PulseLayer ( AudioPreference & pref )

Definition at line 55 of file pulselayer.cpp.

References jami::emitSignal(), JAMI_INFO, and jami::AudioLayer::setHasNativeNS().

Here is the call graph for this function:

◆ ~PulseLayer()

jami::PulseLayer::~PulseLayer ( )

Definition at line 97 of file pulselayer.cpp.

References jami::emitSignal(), jami::AudioLayer::playbackChanged(), and jami::AudioLayer::recordChanged().

Here is the call graph for this function:

Member Function Documentation

◆ getAudioDeviceIndex()

int jami::PulseLayer::getAudioDeviceIndex	(	const std::string &	descr,
		AudioDeviceType	type
	)		const

virtual

Implements jami::AudioLayer.

Definition at line 249 of file pulselayer.cpp.

References jami::CAPTURE, jami::emitSignal(), JAMI_ERR, jami::PLAYBACK, and jami::RINGTONE.

Here is the call graph for this function:

◆ getAudioDeviceIndexByName()

int jami::PulseLayer::getAudioDeviceIndexByName	(	const std::string &	name,
		AudioDeviceType	type
	)		const

Definition at line 270 of file pulselayer.cpp.

References jami::CAPTURE, JAMI_ERR, jami::PLAYBACK, and jami::RINGTONE.

◆ getAudioDeviceName()

std::string jami::PulseLayer::getAudioDeviceName	(	int	index,
		AudioDeviceType	type
	)		const

virtual

Implements jami::AudioLayer.

Definition at line 324 of file pulselayer.cpp.

References jami::CAPTURE, jami::emitSignal(), JAMI_ERR, jami::PLAYBACK, and jami::RINGTONE.

Here is the call graph for this function:

◆ getCaptureDeviceList()

std::vector< std::string > jami::PulseLayer::getCaptureDeviceList ( ) const

virtual

Implements jami::AudioLayer.

Definition at line 229 of file pulselayer.cpp.

References jami::emitSignal().

Here is the call graph for this function:

◆ getPlaybackDeviceList()

std::vector< std::string > jami::PulseLayer::getPlaybackDeviceList ( ) const

virtual

Implements jami::AudioLayer.

Definition at line 239 of file pulselayer.cpp.

References jami::emitSignal().

Here is the call graph for this function:

◆ inSinkList()

bool jami::PulseLayer::inSinkList ( const std::string & deviceName )

Definition at line 215 of file pulselayer.cpp.

◆ inSourceList()

bool jami::PulseLayer::inSourceList ( const std::string & deviceName )

Definition at line 222 of file pulselayer.cpp.

◆ readFromMic()

void jami::PulseLayer::readFromMic ( )

Write data from the ring buffer to the hardware and read data from the hardware.

Definition at line 558 of file pulselayer.cpp.

References jami::emitSignal(), jami::libav_utils::fillWithSilence(), jami::AudioLayer::isCaptureMuted_, JAMI_ERR, and jami::AudioLayer::putRecorded().

Referenced by startStream().

Here is the call graph for this function:

◆ ringtoneToSpeaker()

void jami::PulseLayer::ringtoneToSpeaker ( )

Definition at line 587 of file pulselayer.cpp.

References jami::emitSignal(), jami::AudioLayer::getToRing(), and jami::AudioLayer::isRingtoneMuted_.

Referenced by startStream().

Here is the call graph for this function:

◆ startCaptureStream()

void jami::PulseLayer::startCaptureStream ( const std::string & id )

overridevirtual

Start a capture stream on the given device (eg.

a window handle, or a hard-coded string like "desktop-audio"). Not all audio layers will implement this method, so default implementation does nothing.

Parameters