Audio filters

Data Structures
struct	aout_filters_cfg_t

Macros
#define	AOUT_CHAN_REMAP_INIT
#define	AOUT_FILTERS_CFG_INIT
#define	aout_FiltersNew(o, inf, outf, remap)    aout_FiltersNew(VLC_OBJECT(o),inf,outf,remap)
#define	aout_FiltersDelete(o, f)    aout_FiltersDelete(VLC_OBJECT(o),f)

Typedefs
typedef struct aout_filters	aout_filters_t

Enumerations
enum	vlc_chan_order_idx_t {   AOUT_CHANIDX_DISABLE = -1 , AOUT_CHANIDX_LEFT , AOUT_CHANIDX_RIGHT , AOUT_CHANIDX_MIDDLELEFT ,   AOUT_CHANIDX_MIDDLERIGHT , AOUT_CHANIDX_REARLEFT , AOUT_CHANIDX_REARRIGHT , AOUT_CHANIDX_REARCENTER ,   AOUT_CHANIDX_CENTER , AOUT_CHANIDX_LFE , AOUT_CHANIDX_MAX }

Functions
int	aout_EnableFilter (audio_output_t *aout, const char *name, bool add)
	Enable or disable an audio filter ("audio-filter")
aout_filters_t *	aout_FiltersNew (vlc_object_t *, const audio_sample_format_t *, const audio_sample_format_t *, const aout_filters_cfg_t *cfg)
void	aout_FiltersDelete (vlc_object_t *, aout_filters_t *)
	Destroys a chain of audio filters.
bool	aout_FiltersAdjustResampling (aout_filters_t *, int)
block_t *	aout_FiltersPlay (aout_filters_t *, block_t *, float rate)
block_t *	aout_FiltersDrain (aout_filters_t *)
void	aout_FiltersFlush (aout_filters_t *)
void	aout_FiltersChangeViewpoint (aout_filters_t *, const vlc_viewpoint_t *vp)
vout_thread_t *	aout_filter_GetVout (filter_t *, const video_format_t *)
	Create a vout from an "visualization" audio filter.

Detailed Description

Macro Definition Documentation

AOUT_CHAN_REMAP_INIT

#define AOUT_CHAN_REMAP_INIT

Value:

    { \
    AOUT_CHANIDX_LEFT,  \
    AOUT_CHANIDX_RIGHT, \
    AOUT_CHANIDX_MIDDLELEFT, \
    AOUT_CHANIDX_MIDDLERIGHT, \
    AOUT_CHANIDX_REARLEFT, \
    AOUT_CHANIDX_REARRIGHT, \
    AOUT_CHANIDX_REARCENTER, \
    AOUT_CHANIDX_CENTER, \
    AOUT_CHANIDX_LFE, \
}

AOUT_FILTERS_CFG_INIT

#define AOUT_FILTERS_CFG_INIT

Value:

    (aout_filters_cfg_t) \
    { .remap = AOUT_CHAN_REMAP_INIT, \
      .headphones = false, \
    };

aout_FiltersDelete

#define aout_FiltersDelete	(		o,
			f
	)		aout_FiltersDelete(VLC_OBJECT(o),f)

aout_FiltersNew

#define aout_FiltersNew	(		o,
			inf,
			outf,
			remap
	)		aout_FiltersNew(VLC_OBJECT(o),inf,outf,remap)

Typedef Documentation

aout_filters_t

typedef struct aout_filters aout_filters_t

Enumeration Type Documentation

vlc_chan_order_idx_t

enum vlc_chan_order_idx_t

Enumerator
AOUT_CHANIDX_DISABLE
AOUT_CHANIDX_LEFT
AOUT_CHANIDX_RIGHT
AOUT_CHANIDX_MIDDLELEFT
AOUT_CHANIDX_MIDDLERIGHT
AOUT_CHANIDX_REARLEFT
AOUT_CHANIDX_REARRIGHT
AOUT_CHANIDX_REARCENTER
AOUT_CHANIDX_CENTER
AOUT_CHANIDX_LFE
AOUT_CHANIDX_MAX

Function Documentation

aout_EnableFilter()

int aout_EnableFilter	(	audio_output_t *	aout,
		const char *	name,
		bool	add
	)

Enable or disable an audio filter ("audio-filter")

Parameters

aout	a valid audio output
name	a valid filter name
add	true to add the filter, false to remove it

Returns

0 on success, non-zero on failure.

References FilterOrder(), p, psz_name, unlikely, var_GetString(), var_SetString(), VLC_EGENERIC, VLC_ENOMEM, and VLC_SUCCESS.

Referenced by vlc_player_aout_EnableFilter().

aout_filter_GetVout()

vout_thread_t * aout_filter_GetVout	(	filter_t *	filter,
		const video_format_t *	fmt
	)

Create a vout from an "visualization" audio filter.

Warning

Can only be called once, from the probe function (Open).

Returns

a valid vout or NULL in case of error, the returned vout should not be freed via vout_Close().

References AUDIO_ES, filter_owner_sys::clock, filter_owner_sys::clock_source, filter_t::owner, filter_owner_t::sys, unlikely, video_format_AdjustColorSpace(), vlc_clock_CreateSlave(), vlc_clock_Delete(), vlc_clock_Lock(), vlc_clock_Unlock(), VLC_OBJECT, filter_owner_sys::vout, vout_configuration_t::vout, vout_Close(), vout_Create(), and vout_Request().

aout_FiltersAdjustResampling()

bool aout_FiltersAdjustResampling	(	aout_filters_t *	filters,
		int	adjust
	)

References aout_filter::f, aout_filters::resampler, and aout_filters::resampling.

Referenced by stream_HandleDrift(), and stream_StopResampling().

aout_FiltersChangeViewpoint()

void aout_FiltersChangeViewpoint	(	aout_filters_t *	filters,
		const vlc_viewpoint_t *	vp
	)

References aout_FiltersPipelineChangeViewpoint(), aout_filters::count, and aout_filters::tab.

Referenced by vlc_aout_stream_Play().

aout_FiltersDelete()

void aout_FiltersDelete	(	vlc_object_t *	obj,
		aout_filters_t *	filters
	)

Destroys a chain of audio filters.

Parameters

obj	object used with aout_FiltersNew()
filters	chain to be destroyed

References aout_FiltersPipelineDestroy(), aout_filters::count, aout_filter::f, aout_filters::resampler, aout_filters::tab, var_DelCallback(), and VisualizationCallback().

aout_FiltersDrain()

block_t * aout_FiltersDrain

(

aout_filters_t *

filters

)

References aout_FiltersPipelineDrain(), aout_FiltersPipelinePlay(), es_format_t::audio, block_ChainAppend, block_ChainGather, aout_filters::count, aout_filter::f, filter_t::fmt_in, audio_format_t::i_rate, aout_filters::resampler, aout_filters::resampling, and aout_filters::tab.

Referenced by vlc_aout_stream_Drain().

aout_FiltersFlush()

void aout_FiltersFlush

(

aout_filters_t *

filters

)

References aout_FiltersPipelineFlush(), aout_filters::count, aout_filter::f, aout_filters::resampler, and aout_filters::tab.

Referenced by stream_Reset().

aout_FiltersNew()

aout_filters_t * aout_FiltersNew	(	vlc_object_t *	,
		const audio_sample_format_t *	,
		const audio_sample_format_t *	,
		const aout_filters_cfg_t *	cfg
	)

aout_FiltersPlay()

block_t * aout_FiltersPlay	(	aout_filters_t *	filters,
		block_t *	block,
		float	rate
	)

References aout_FiltersPipelinePlay(), es_format_t::audio, block_Release, aout_filters::count, aout_filter::f, filter_t::fmt_in, audio_format_t::i_rate, aout_filters::rate_filter, aout_filters::resampler, aout_filters::resampling, and aout_filters::tab.

Referenced by vlc_aout_stream_Play().