Macros
#define	AV_CH_LAYOUT_MONO (AV_CH_FRONT_CENTER)

#define	AV_CH_LAYOUT_STEREO (AV_CH_FRONT_LEFT\|AV_CH_FRONT_RIGHT)

#define	AV_CH_LAYOUT_2POINT1 (AV_CH_LAYOUT_STEREO\|AV_CH_LOW_FREQUENCY)

#define	AV_CH_LAYOUT_2_1 (AV_CH_LAYOUT_STEREO\|AV_CH_BACK_CENTER)

#define	AV_CH_LAYOUT_SURROUND (AV_CH_LAYOUT_STEREO\|AV_CH_FRONT_CENTER)

#define	AV_CH_LAYOUT_3POINT1 (AV_CH_LAYOUT_SURROUND\|AV_CH_LOW_FREQUENCY)

#define	AV_CH_LAYOUT_4POINT0 (AV_CH_LAYOUT_SURROUND\|AV_CH_BACK_CENTER)

#define	AV_CH_LAYOUT_4POINT1 (AV_CH_LAYOUT_4POINT0\|AV_CH_LOW_FREQUENCY)

#define	AV_CH_LAYOUT_2_2 (AV_CH_LAYOUT_STEREO\|AV_CH_SIDE_LEFT\|AV_CH_SIDE_RIGHT)

#define	AV_CH_LAYOUT_QUAD (AV_CH_LAYOUT_STEREO\|AV_CH_BACK_LEFT\|AV_CH_BACK_RIGHT)

#define	AV_CH_LAYOUT_5POINT0 (AV_CH_LAYOUT_SURROUND\|AV_CH_SIDE_LEFT\|AV_CH_SIDE_RIGHT)

#define	AV_CH_LAYOUT_5POINT1 (AV_CH_LAYOUT_5POINT0\|AV_CH_LOW_FREQUENCY)

#define	AV_CH_LAYOUT_5POINT0_BACK (AV_CH_LAYOUT_SURROUND\|AV_CH_BACK_LEFT\|AV_CH_BACK_RIGHT)

#define	AV_CH_LAYOUT_5POINT1_BACK (AV_CH_LAYOUT_5POINT0_BACK\|AV_CH_LOW_FREQUENCY)

#define	AV_CH_LAYOUT_6POINT0 (AV_CH_LAYOUT_5POINT0\|AV_CH_BACK_CENTER)

#define	AV_CH_LAYOUT_6POINT0_FRONT (AV_CH_LAYOUT_2_2\|AV_CH_FRONT_LEFT_OF_CENTER\|AV_CH_FRONT_RIGHT_OF_CENTER)

#define	AV_CH_LAYOUT_HEXAGONAL (AV_CH_LAYOUT_5POINT0_BACK\|AV_CH_BACK_CENTER)

#define	AV_CH_LAYOUT_6POINT1 (AV_CH_LAYOUT_5POINT1\|AV_CH_BACK_CENTER)

#define	AV_CH_LAYOUT_6POINT1_BACK (AV_CH_LAYOUT_5POINT1_BACK\|AV_CH_BACK_CENTER)

#define	AV_CH_LAYOUT_6POINT1_FRONT (AV_CH_LAYOUT_6POINT0_FRONT\|AV_CH_LOW_FREQUENCY)

#define	AV_CH_LAYOUT_7POINT0 (AV_CH_LAYOUT_5POINT0\|AV_CH_BACK_LEFT\|AV_CH_BACK_RIGHT)

#define	AV_CH_LAYOUT_7POINT0_FRONT (AV_CH_LAYOUT_5POINT0\|AV_CH_FRONT_LEFT_OF_CENTER\|AV_CH_FRONT_RIGHT_OF_CENTER)

#define	AV_CH_LAYOUT_7POINT1 (AV_CH_LAYOUT_5POINT1\|AV_CH_BACK_LEFT\|AV_CH_BACK_RIGHT)

#define	AV_CH_LAYOUT_7POINT1_WIDE (AV_CH_LAYOUT_5POINT1\|AV_CH_FRONT_LEFT_OF_CENTER\|AV_CH_FRONT_RIGHT_OF_CENTER)

#define	AV_CH_LAYOUT_7POINT1_WIDE_BACK (AV_CH_LAYOUT_5POINT1_BACK\|AV_CH_FRONT_LEFT_OF_CENTER\|AV_CH_FRONT_RIGHT_OF_CENTER)

#define	AV_CH_LAYOUT_OCTAGONAL (AV_CH_LAYOUT_5POINT0\|AV_CH_BACK_LEFT\|AV_CH_BACK_CENTER\|AV_CH_BACK_RIGHT)

#define	AV_CH_LAYOUT_HEXADECAGONAL (AV_CH_LAYOUT_OCTAGONAL\|AV_CH_WIDE_LEFT\|AV_CH_WIDE_RIGHT\|AV_CH_TOP_BACK_LEFT\|AV_CH_TOP_BACK_RIGHT\|AV_CH_TOP_BACK_CENTER\|AV_CH_TOP_FRONT_CENTER\|AV_CH_TOP_FRONT_LEFT\|AV_CH_TOP_FRONT_RIGHT)

#define	AV_CH_LAYOUT_STEREO_DOWNMIX (AV_CH_STEREO_LEFT\|AV_CH_STEREO_RIGHT)

Enumerations
enum	AVMatrixEncoding { AV_MATRIX_ENCODING_NONE, AV_MATRIX_ENCODING_DOLBY, AV_MATRIX_ENCODING_DPLII, AV_MATRIX_ENCODING_DPLIIX, AV_MATRIX_ENCODING_DPLIIZ, AV_MATRIX_ENCODING_DOLBYEX, AV_MATRIX_ENCODING_DOLBYHEADPHONE, AV_MATRIX_ENCODING_NB }

Functions
uint64_t	av_get_channel_layout (const char *name)
	Return a channel layout id that matches name, or 0 if no match is found. More...

int	av_get_extended_channel_layout (const char name, uint64_t channel_layout, int *nb_channels)
	Return a channel layout and the number of channels based on the specified name. More...

void	av_get_channel_layout_string (char *buf, int buf_size, int nb_channels, uint64_t channel_layout)
	Return a description of a channel layout. More...

void	av_bprint_channel_layout (struct AVBPrint *bp, int nb_channels, uint64_t channel_layout)
	Append a description of a channel layout to a bprint buffer. More...

int	av_get_channel_layout_nb_channels (uint64_t channel_layout)
	Return the number of channels in the channel layout. More...

int64_t	av_get_default_channel_layout (int nb_channels)
	Return default channel layout for a given number of channels. More...

int	av_get_channel_layout_channel_index (uint64_t channel_layout, uint64_t channel)
	Get the index of a channel in channel_layout. More...

uint64_t	av_channel_layout_extract_channel (uint64_t channel_layout, int index)
	Get the channel with the given index in channel_layout. More...

const char *	av_get_channel_name (uint64_t channel)
	Get the name of a given channel. More...

const char *	av_get_channel_description (uint64_t channel)
	Get the description of a given channel. More...

int	av_get_standard_channel_layout (unsigned index, uint64_t layout, const char *name)
	Get the value and name of a standard channel layout. More...

Detailed Description

Macro Definition Documentation

◆ AV_CH_LAYOUT_MONO

#define AV_CH_LAYOUT_MONO (AV_CH_FRONT_CENTER)

Examples:: filtering_audio.c.

Definition at line 85 of file channel_layout.h.

Referenced by init_filters().

◆ AV_CH_LAYOUT_STEREO

#define AV_CH_LAYOUT_STEREO (AV_CH_FRONT_LEFT|AV_CH_FRONT_RIGHT)

Examples:: encode_audio.c, filter_audio.c, muxing.c, and resampling_audio.c.

Definition at line 86 of file channel_layout.h.

Referenced by add_stream(), init_filter_graph(), main(), and select_channel_layout().

◆ AV_CH_LAYOUT_2POINT1

#define AV_CH_LAYOUT_2POINT1 (AV_CH_LAYOUT_STEREO|AV_CH_LOW_FREQUENCY)

Definition at line 87 of file channel_layout.h.

◆ AV_CH_LAYOUT_2_1

#define AV_CH_LAYOUT_2_1 (AV_CH_LAYOUT_STEREO|AV_CH_BACK_CENTER)

Definition at line 88 of file channel_layout.h.

◆ AV_CH_LAYOUT_SURROUND

#define AV_CH_LAYOUT_SURROUND (AV_CH_LAYOUT_STEREO|AV_CH_FRONT_CENTER)

Examples:: resampling_audio.c.

Definition at line 89 of file channel_layout.h.

Referenced by main().

◆ AV_CH_LAYOUT_3POINT1

#define AV_CH_LAYOUT_3POINT1 (AV_CH_LAYOUT_SURROUND|AV_CH_LOW_FREQUENCY)

Definition at line 90 of file channel_layout.h.

◆ AV_CH_LAYOUT_4POINT0

#define AV_CH_LAYOUT_4POINT0 (AV_CH_LAYOUT_SURROUND|AV_CH_BACK_CENTER)

Definition at line 91 of file channel_layout.h.

◆ AV_CH_LAYOUT_4POINT1

#define AV_CH_LAYOUT_4POINT1 (AV_CH_LAYOUT_4POINT0|AV_CH_LOW_FREQUENCY)

Definition at line 92 of file channel_layout.h.

◆ AV_CH_LAYOUT_2_2

#define AV_CH_LAYOUT_2_2 (AV_CH_LAYOUT_STEREO|AV_CH_SIDE_LEFT|AV_CH_SIDE_RIGHT)

Definition at line 93 of file channel_layout.h.

◆ AV_CH_LAYOUT_QUAD

#define AV_CH_LAYOUT_QUAD (AV_CH_LAYOUT_STEREO|AV_CH_BACK_LEFT|AV_CH_BACK_RIGHT)

Definition at line 94 of file channel_layout.h.

◆ AV_CH_LAYOUT_5POINT0

#define AV_CH_LAYOUT_5POINT0 (AV_CH_LAYOUT_SURROUND|AV_CH_SIDE_LEFT|AV_CH_SIDE_RIGHT)

Definition at line 95 of file channel_layout.h.

◆ AV_CH_LAYOUT_5POINT1

#define AV_CH_LAYOUT_5POINT1 (AV_CH_LAYOUT_5POINT0|AV_CH_LOW_FREQUENCY)

Definition at line 96 of file channel_layout.h.

◆ AV_CH_LAYOUT_5POINT0_BACK

#define AV_CH_LAYOUT_5POINT0_BACK (AV_CH_LAYOUT_SURROUND|AV_CH_BACK_LEFT|AV_CH_BACK_RIGHT)

Definition at line 97 of file channel_layout.h.

◆ AV_CH_LAYOUT_5POINT1_BACK

#define AV_CH_LAYOUT_5POINT1_BACK (AV_CH_LAYOUT_5POINT0_BACK|AV_CH_LOW_FREQUENCY)

Definition at line 98 of file channel_layout.h.

◆ AV_CH_LAYOUT_6POINT0

#define AV_CH_LAYOUT_6POINT0 (AV_CH_LAYOUT_5POINT0|AV_CH_BACK_CENTER)

Definition at line 99 of file channel_layout.h.

◆ AV_CH_LAYOUT_6POINT0_FRONT

#define AV_CH_LAYOUT_6POINT0_FRONT (AV_CH_LAYOUT_2_2|AV_CH_FRONT_LEFT_OF_CENTER|AV_CH_FRONT_RIGHT_OF_CENTER)

Definition at line 100 of file channel_layout.h.

◆ AV_CH_LAYOUT_HEXAGONAL

#define AV_CH_LAYOUT_HEXAGONAL (AV_CH_LAYOUT_5POINT0_BACK|AV_CH_BACK_CENTER)

Definition at line 101 of file channel_layout.h.

◆ AV_CH_LAYOUT_6POINT1

#define AV_CH_LAYOUT_6POINT1 (AV_CH_LAYOUT_5POINT1|AV_CH_BACK_CENTER)

Definition at line 102 of file channel_layout.h.

◆ AV_CH_LAYOUT_6POINT1_BACK

#define AV_CH_LAYOUT_6POINT1_BACK (AV_CH_LAYOUT_5POINT1_BACK|AV_CH_BACK_CENTER)

Definition at line 103 of file channel_layout.h.

◆ AV_CH_LAYOUT_6POINT1_FRONT

#define AV_CH_LAYOUT_6POINT1_FRONT (AV_CH_LAYOUT_6POINT0_FRONT|AV_CH_LOW_FREQUENCY)

Definition at line 104 of file channel_layout.h.

◆ AV_CH_LAYOUT_7POINT0

#define AV_CH_LAYOUT_7POINT0 (AV_CH_LAYOUT_5POINT0|AV_CH_BACK_LEFT|AV_CH_BACK_RIGHT)

Definition at line 105 of file channel_layout.h.

◆ AV_CH_LAYOUT_7POINT0_FRONT

#define AV_CH_LAYOUT_7POINT0_FRONT (AV_CH_LAYOUT_5POINT0|AV_CH_FRONT_LEFT_OF_CENTER|AV_CH_FRONT_RIGHT_OF_CENTER)

Definition at line 106 of file channel_layout.h.

◆ AV_CH_LAYOUT_7POINT1

#define AV_CH_LAYOUT_7POINT1 (AV_CH_LAYOUT_5POINT1|AV_CH_BACK_LEFT|AV_CH_BACK_RIGHT)

Definition at line 107 of file channel_layout.h.

◆ AV_CH_LAYOUT_7POINT1_WIDE

#define AV_CH_LAYOUT_7POINT1_WIDE (AV_CH_LAYOUT_5POINT1|AV_CH_FRONT_LEFT_OF_CENTER|AV_CH_FRONT_RIGHT_OF_CENTER)

Definition at line 108 of file channel_layout.h.

◆ AV_CH_LAYOUT_7POINT1_WIDE_BACK

#define AV_CH_LAYOUT_7POINT1_WIDE_BACK (AV_CH_LAYOUT_5POINT1_BACK|AV_CH_FRONT_LEFT_OF_CENTER|AV_CH_FRONT_RIGHT_OF_CENTER)

Definition at line 109 of file channel_layout.h.

◆ AV_CH_LAYOUT_OCTAGONAL

#define AV_CH_LAYOUT_OCTAGONAL (AV_CH_LAYOUT_5POINT0|AV_CH_BACK_LEFT|AV_CH_BACK_CENTER|AV_CH_BACK_RIGHT)

Definition at line 110 of file channel_layout.h.

◆ AV_CH_LAYOUT_HEXADECAGONAL

Definition at line 111 of file channel_layout.h.

◆ AV_CH_LAYOUT_STEREO_DOWNMIX

#define AV_CH_LAYOUT_STEREO_DOWNMIX (AV_CH_STEREO_LEFT|AV_CH_STEREO_RIGHT)

Definition at line 112 of file channel_layout.h.

Enumeration Type Documentation

◆ AVMatrixEncoding

enum AVMatrixEncoding

Enumerator
AV_MATRIX_ENCODING_NONE
AV_MATRIX_ENCODING_DOLBY
AV_MATRIX_ENCODING_DPLII
AV_MATRIX_ENCODING_DPLIIX
AV_MATRIX_ENCODING_DPLIIZ
AV_MATRIX_ENCODING_DOLBYEX
AV_MATRIX_ENCODING_DOLBYHEADPHONE
AV_MATRIX_ENCODING_NB

Definition at line 114 of file channel_layout.h.

Function Documentation

◆ av_get_channel_layout()

uint64_t av_get_channel_layout ( const char * name )

Return a channel layout id that matches name, or 0 if no match is found.

name can be one or several of the following notations, separated by '+' or '|':

the name of an usual channel layout (mono, stereo, 4.0, quad, 5.0, 5.0(side), 5.1, 5.1(side), 7.1, 7.1(wide), downmix);
the name of a single channel (FL, FR, FC, LFE, BL, BR, FLC, FRC, BC, SL, SR, TC, TFL, TFC, TFR, TBL, TBC, TBR, DL, DR);
a number of channels, in decimal, followed by 'c', yielding the default channel layout for that number of channels (
See also
av_get_default_channel_layout);
a channel layout mask, in hexadecimal starting with "0x" (see the AV_CH_* macros).

Example: "stereo+FC" = "2c+FC" = "2c+1c" = "0x7"

◆ av_get_extended_channel_layout()

int av_get_extended_channel_layout	(	const char *	name,
		uint64_t *	channel_layout,
		int *	nb_channels
	)

Return a channel layout and the number of channels based on the specified name.

This function is similar to (

See also: av_get_channel_layout), but can also parse unknown channel layout specifications.

Parameters

[in]	name	channel layout specification string
[out]	channel_layout	parsed channel layout (0 if unknown)
[out]	nb_channels	number of channels

Returns: 0 on success, AVERROR(EINVAL) if the parsing fails.

◆ av_get_channel_layout_string()

void av_get_channel_layout_string	(	char *	buf,
		int	buf_size,
		int	nb_channels,
		uint64_t	channel_layout
	)

Return a description of a channel layout.

If nb_channels is <= 0, it is guessed from the channel_layout.

Parameters

buf	put here the string containing the channel layout
buf_size	size in bytes of the buffer

Examples:: filter_audio.c, and filtering_audio.c.

Referenced by init_filter_graph(), and init_filters().

◆ av_bprint_channel_layout()

void av_bprint_channel_layout	(	struct AVBPrint *	bp,
		int	nb_channels,
		uint64_t	channel_layout
	)

Append a description of a channel layout to a bprint buffer.

◆ av_get_channel_layout_nb_channels()

int av_get_channel_layout_nb_channels ( uint64_t channel_layout )

Return the number of channels in the channel layout.

Examples:: encode_audio.c, filter_audio.c, filtering_audio.c, muxing.c, resampling_audio.c, and transcoding.c.

Referenced by add_stream(), main(), open_output_file(), print_frame(), process_output(), and select_channel_layout().

◆ av_get_default_channel_layout()

int64_t av_get_default_channel_layout ( int nb_channels )

Return default channel layout for a given number of channels.

Examples:: filtering_audio.c, transcode_aac.c, and transcoding.c.

Referenced by init_filter(), init_filters(), init_resampler(), and open_output_file().

◆ av_get_channel_layout_channel_index()

int av_get_channel_layout_channel_index	(	uint64_t	channel_layout,
		uint64_t	channel
	)

Get the index of a channel in channel_layout.

Parameters

channel a channel layout describing exactly one channel which must be present in channel_layout.

Returns: index of channel in channel_layout on success, a negative AVERROR on error.

◆ av_channel_layout_extract_channel()

uint64_t av_channel_layout_extract_channel	(	uint64_t	channel_layout,
		int	index
	)

Get the channel with the given index in channel_layout.

◆ av_get_channel_name()

const char* av_get_channel_name ( uint64_t channel )

Get the name of a given channel.

Returns: channel name on success, NULL on error.

◆ av_get_channel_description()

const char* av_get_channel_description ( uint64_t channel )

Get the description of a given channel.

Parameters

channel a channel layout with a single channel

Returns: channel description on success, NULL on error

◆ av_get_standard_channel_layout()

int av_get_standard_channel_layout	(	unsigned	index,
		uint64_t *	layout,
		const char **	name
	)

Get the value and name of a standard channel layout.

Parameters

[in]	index	index in an internal list, starting at 0
[out]	layout	channel layout mask
[out]	name	name of the layout

Returns: 0 if the layout exists, <0 if index is beyond the limits

Macros

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ AV_CH_LAYOUT_MONO

◆ AV_CH_LAYOUT_STEREO

◆ AV_CH_LAYOUT_2POINT1

◆ AV_CH_LAYOUT_2_1

◆ AV_CH_LAYOUT_SURROUND

◆ AV_CH_LAYOUT_3POINT1

◆ AV_CH_LAYOUT_4POINT0

◆ AV_CH_LAYOUT_4POINT1

◆ AV_CH_LAYOUT_2_2

◆ AV_CH_LAYOUT_QUAD

◆ AV_CH_LAYOUT_5POINT0

◆ AV_CH_LAYOUT_5POINT1

◆ AV_CH_LAYOUT_5POINT0_BACK

◆ AV_CH_LAYOUT_5POINT1_BACK

◆ AV_CH_LAYOUT_6POINT0

◆ AV_CH_LAYOUT_6POINT0_FRONT

◆ AV_CH_LAYOUT_HEXAGONAL

◆ AV_CH_LAYOUT_6POINT1

◆ AV_CH_LAYOUT_6POINT1_BACK

◆ AV_CH_LAYOUT_6POINT1_FRONT

◆ AV_CH_LAYOUT_7POINT0

◆ AV_CH_LAYOUT_7POINT0_FRONT

◆ AV_CH_LAYOUT_7POINT1

◆ AV_CH_LAYOUT_7POINT1_WIDE

◆ AV_CH_LAYOUT_7POINT1_WIDE_BACK

◆ AV_CH_LAYOUT_OCTAGONAL

◆ AV_CH_LAYOUT_HEXADECAGONAL

◆ AV_CH_LAYOUT_STEREO_DOWNMIX

Enumeration Type Documentation

◆ AVMatrixEncoding

Function Documentation

◆ av_get_channel_layout()

◆ av_get_extended_channel_layout()

◆ av_get_channel_layout_string()

◆ av_bprint_channel_layout()

◆ av_get_channel_layout_nb_channels()

◆ av_get_default_channel_layout()

◆ av_get_channel_layout_channel_index()

◆ av_channel_layout_extract_channel()

◆ av_get_channel_name()

◆ av_get_channel_description()

◆ av_get_standard_channel_layout()