Audio output modules

Collaboration diagram for Audio output modules:

Data Structures
struct	vlc_audio_output_events
struct	audio_output
	Audio output object. More...

Functions
static void	aout_TimingReport (audio_output_t *aout, vlc_tick_t system_ts, vlc_tick_t audio_pts)
	Report a new timing point.
static void	aout_DrainedReport (audio_output_t *aout)
	Report than the stream is drained (after a call to aout->drain_async)
static void	aout_VolumeReport (audio_output_t *aout, float volume)
	Report change of configured audio volume to the core and UI.
static void	aout_MuteReport (audio_output_t *aout, bool mute)
	Report change of muted flag to the core and UI.
static void	aout_PolicyReport (audio_output_t *aout, bool cork)
	Report audio policy status.
static void	aout_DeviceReport (audio_output_t *aout, const char *id)
	Report change of output device.
static void	aout_HotplugReport (audio_output_t *aout, const char *id, const char *name)
	Report a device hot-plug event.
static int	aout_GainRequest (audio_output_t *aout, float gain)
	Request a change of software audio amplification.
static void	aout_RestartRequest (audio_output_t *aout, bool restart_dec)

Detailed Description

Function Documentation

aout_DeviceReport()

static void aout_DeviceReport ( audio_output_t *  aout, const char *  id  )

inlinestatic

Report change of output device.

References vlc_audio_output_events::device_report, and audio_output::events.

aout_DrainedReport()

static void aout_DrainedReport ( audio_output_t *  aout )

inlinestatic

Report than the stream is drained (after a call to aout->drain_async)

References vlc_audio_output_events::drained_report, and audio_output::events.

aout_GainRequest()

static int aout_GainRequest ( audio_output_t *  aout, float  gain  )

inlinestatic

Request a change of software audio amplification.

Parameters

aout	the audio output instance requesting software gain
gain	linear amplitude gain (must be positive)

Warning

Values in excess 1.0 may cause overflow and distortion.

References audio_output::events, and vlc_audio_output_events::gain_request.

aout_HotplugReport()

static void aout_HotplugReport ( audio_output_t *  aout, const char *  id, const char *  name  )

inlinestatic

Report a device hot-plug event.

Parameters

aout	the audio output instance reporting the new device
id	device ID
name	human-readable device name (NULL for hot unplug)

References audio_output::events, vlc_audio_output_events::hotplug_report, and name.

aout_MuteReport()

static void aout_MuteReport ( audio_output_t *  aout, bool  mute  )

inlinestatic

Report change of muted flag to the core and UI.

References audio_output::events, and vlc_audio_output_events::mute_report.

aout_PolicyReport()

static void aout_PolicyReport ( audio_output_t *  aout, bool  cork  )

inlinestatic

Report audio policy status.

Parameters

aout	the audio output instance reporting the cork policy
cork	true to request a cork, false to undo any pending cork.

References audio_output::events, and vlc_audio_output_events::policy_report.

aout_RestartRequest()

static void aout_RestartRequest ( audio_output_t *  aout, bool  restart_dec  )

inlinestatic

References audio_output::events, and vlc_audio_output_events::restart_request.

aout_TimingReport()

static void aout_TimingReport ( audio_output_t *  aout, vlc_tick_t  system_ts, vlc_tick_t  audio_pts  )

inlinestatic

Report a new timing point.

It is important to report the first point as soon as possible (and the following points if the audio delay take some time to be stabilized). Once the audio is stabilized, it is recommended to report timing points every seconds.

This function can be called from the play() callback or from any threads after the first play(). This should not be called after a flush(), a stop(), a drain() or while paused. After a flush(), play() need to be called again before reporting a new timing. In that case, audio_ts should start again at 0 (for the first sample played).

Parameters

aout	the audio output instance
system_ts	system timestamp when audio_ts is played, based on vlc_tick_now(), can be now, in the past or in the future.
audio_pts	audio timestamp played at system_ts, starts at block->i_pts for the first sample played.

References audio_output::events, and vlc_audio_output_events::timing_report.

aout_VolumeReport()

static void aout_VolumeReport ( audio_output_t *  aout, float  volume  )

inlinestatic

Report change of configured audio volume to the core and UI.

References audio_output::events, and vlc_audio_output_events::volume_report.