FFmpeg 5.1.6
Macros
Audio channel masks

A channel layout is a 64-bits integer with a bit set for every channel. More...

Macros

#define AV_CH_FRONT_LEFT   (1ULL << AV_CHAN_FRONT_LEFT )
 
#define AV_CH_FRONT_RIGHT   (1ULL << AV_CHAN_FRONT_RIGHT )
 
#define AV_CH_FRONT_CENTER   (1ULL << AV_CHAN_FRONT_CENTER )
 
#define AV_CH_LOW_FREQUENCY   (1ULL << AV_CHAN_LOW_FREQUENCY )
 
#define AV_CH_BACK_LEFT   (1ULL << AV_CHAN_BACK_LEFT )
 
#define AV_CH_BACK_RIGHT   (1ULL << AV_CHAN_BACK_RIGHT )
 
#define AV_CH_FRONT_LEFT_OF_CENTER   (1ULL << AV_CHAN_FRONT_LEFT_OF_CENTER )
 
#define AV_CH_FRONT_RIGHT_OF_CENTER   (1ULL << AV_CHAN_FRONT_RIGHT_OF_CENTER)
 
#define AV_CH_BACK_CENTER   (1ULL << AV_CHAN_BACK_CENTER )
 
#define AV_CH_SIDE_LEFT   (1ULL << AV_CHAN_SIDE_LEFT )
 
#define AV_CH_SIDE_RIGHT   (1ULL << AV_CHAN_SIDE_RIGHT )
 
#define AV_CH_TOP_CENTER   (1ULL << AV_CHAN_TOP_CENTER )
 
#define AV_CH_TOP_FRONT_LEFT   (1ULL << AV_CHAN_TOP_FRONT_LEFT )
 
#define AV_CH_TOP_FRONT_CENTER   (1ULL << AV_CHAN_TOP_FRONT_CENTER )
 
#define AV_CH_TOP_FRONT_RIGHT   (1ULL << AV_CHAN_TOP_FRONT_RIGHT )
 
#define AV_CH_TOP_BACK_LEFT   (1ULL << AV_CHAN_TOP_BACK_LEFT )
 
#define AV_CH_TOP_BACK_CENTER   (1ULL << AV_CHAN_TOP_BACK_CENTER )
 
#define AV_CH_TOP_BACK_RIGHT   (1ULL << AV_CHAN_TOP_BACK_RIGHT )
 
#define AV_CH_STEREO_LEFT   (1ULL << AV_CHAN_STEREO_LEFT )
 
#define AV_CH_STEREO_RIGHT   (1ULL << AV_CHAN_STEREO_RIGHT )
 
#define AV_CH_WIDE_LEFT   (1ULL << AV_CHAN_WIDE_LEFT )
 
#define AV_CH_WIDE_RIGHT   (1ULL << AV_CHAN_WIDE_RIGHT )
 
#define AV_CH_SURROUND_DIRECT_LEFT   (1ULL << AV_CHAN_SURROUND_DIRECT_LEFT )
 
#define AV_CH_SURROUND_DIRECT_RIGHT   (1ULL << AV_CHAN_SURROUND_DIRECT_RIGHT)
 
#define AV_CH_LOW_FREQUENCY_2   (1ULL << AV_CHAN_LOW_FREQUENCY_2 )
 
#define AV_CH_TOP_SIDE_LEFT   (1ULL << AV_CHAN_TOP_SIDE_LEFT )
 
#define AV_CH_TOP_SIDE_RIGHT   (1ULL << AV_CHAN_TOP_SIDE_RIGHT )
 
#define AV_CH_BOTTOM_FRONT_CENTER   (1ULL << AV_CHAN_BOTTOM_FRONT_CENTER )
 
#define AV_CH_BOTTOM_FRONT_LEFT   (1ULL << AV_CHAN_BOTTOM_FRONT_LEFT )
 
#define AV_CH_BOTTOM_FRONT_RIGHT   (1ULL << AV_CHAN_BOTTOM_FRONT_RIGHT )
 
#define AV_CH_LAYOUT_NATIVE   0x8000000000000000ULL
 Channel mask value used for AVCodecContext.request_channel_layout to indicate that the user requests the channel order of the decoder output to be the native codec channel order. More...
 

Detailed Description

A channel layout is a 64-bits integer with a bit set for every channel.

The number of bits set must be equal to the number of channels. The value 0 means that the channel layout is not known.

Note
this data structure is not powerful enough to handle channels combinations that have the same channel multiple times, such as dual-mono.

Macro Definition Documentation

◆ AV_CH_FRONT_LEFT

#define AV_CH_FRONT_LEFT   (1ULL << AV_CHAN_FRONT_LEFT )

Definition at line 158 of file channel_layout.h.

◆ AV_CH_FRONT_RIGHT

#define AV_CH_FRONT_RIGHT   (1ULL << AV_CHAN_FRONT_RIGHT )

Definition at line 159 of file channel_layout.h.

◆ AV_CH_FRONT_CENTER

#define AV_CH_FRONT_CENTER   (1ULL << AV_CHAN_FRONT_CENTER )

Definition at line 160 of file channel_layout.h.

◆ AV_CH_LOW_FREQUENCY

#define AV_CH_LOW_FREQUENCY   (1ULL << AV_CHAN_LOW_FREQUENCY )

Definition at line 161 of file channel_layout.h.

◆ AV_CH_BACK_LEFT

#define AV_CH_BACK_LEFT   (1ULL << AV_CHAN_BACK_LEFT )

Definition at line 162 of file channel_layout.h.

◆ AV_CH_BACK_RIGHT

#define AV_CH_BACK_RIGHT   (1ULL << AV_CHAN_BACK_RIGHT )

Definition at line 163 of file channel_layout.h.

◆ AV_CH_FRONT_LEFT_OF_CENTER

#define AV_CH_FRONT_LEFT_OF_CENTER   (1ULL << AV_CHAN_FRONT_LEFT_OF_CENTER )

Definition at line 164 of file channel_layout.h.

◆ AV_CH_FRONT_RIGHT_OF_CENTER

#define AV_CH_FRONT_RIGHT_OF_CENTER   (1ULL << AV_CHAN_FRONT_RIGHT_OF_CENTER)

Definition at line 165 of file channel_layout.h.

◆ AV_CH_BACK_CENTER

#define AV_CH_BACK_CENTER   (1ULL << AV_CHAN_BACK_CENTER )

Definition at line 166 of file channel_layout.h.

◆ AV_CH_SIDE_LEFT

#define AV_CH_SIDE_LEFT   (1ULL << AV_CHAN_SIDE_LEFT )

Definition at line 167 of file channel_layout.h.

◆ AV_CH_SIDE_RIGHT

#define AV_CH_SIDE_RIGHT   (1ULL << AV_CHAN_SIDE_RIGHT )

Definition at line 168 of file channel_layout.h.

◆ AV_CH_TOP_CENTER

#define AV_CH_TOP_CENTER   (1ULL << AV_CHAN_TOP_CENTER )

Definition at line 169 of file channel_layout.h.

◆ AV_CH_TOP_FRONT_LEFT

#define AV_CH_TOP_FRONT_LEFT   (1ULL << AV_CHAN_TOP_FRONT_LEFT )

Definition at line 170 of file channel_layout.h.

◆ AV_CH_TOP_FRONT_CENTER

#define AV_CH_TOP_FRONT_CENTER   (1ULL << AV_CHAN_TOP_FRONT_CENTER )

Definition at line 171 of file channel_layout.h.

◆ AV_CH_TOP_FRONT_RIGHT

#define AV_CH_TOP_FRONT_RIGHT   (1ULL << AV_CHAN_TOP_FRONT_RIGHT )

Definition at line 172 of file channel_layout.h.

◆ AV_CH_TOP_BACK_LEFT

#define AV_CH_TOP_BACK_LEFT   (1ULL << AV_CHAN_TOP_BACK_LEFT )

Definition at line 173 of file channel_layout.h.

◆ AV_CH_TOP_BACK_CENTER

#define AV_CH_TOP_BACK_CENTER   (1ULL << AV_CHAN_TOP_BACK_CENTER )

Definition at line 174 of file channel_layout.h.

◆ AV_CH_TOP_BACK_RIGHT

#define AV_CH_TOP_BACK_RIGHT   (1ULL << AV_CHAN_TOP_BACK_RIGHT )

Definition at line 175 of file channel_layout.h.

◆ AV_CH_STEREO_LEFT

#define AV_CH_STEREO_LEFT   (1ULL << AV_CHAN_STEREO_LEFT )

Definition at line 176 of file channel_layout.h.

◆ AV_CH_STEREO_RIGHT

#define AV_CH_STEREO_RIGHT   (1ULL << AV_CHAN_STEREO_RIGHT )

Definition at line 177 of file channel_layout.h.

◆ AV_CH_WIDE_LEFT

#define AV_CH_WIDE_LEFT   (1ULL << AV_CHAN_WIDE_LEFT )

Definition at line 178 of file channel_layout.h.

◆ AV_CH_WIDE_RIGHT

#define AV_CH_WIDE_RIGHT   (1ULL << AV_CHAN_WIDE_RIGHT )

Definition at line 179 of file channel_layout.h.

◆ AV_CH_SURROUND_DIRECT_LEFT

#define AV_CH_SURROUND_DIRECT_LEFT   (1ULL << AV_CHAN_SURROUND_DIRECT_LEFT )

Definition at line 180 of file channel_layout.h.

◆ AV_CH_SURROUND_DIRECT_RIGHT

#define AV_CH_SURROUND_DIRECT_RIGHT   (1ULL << AV_CHAN_SURROUND_DIRECT_RIGHT)

Definition at line 181 of file channel_layout.h.

◆ AV_CH_LOW_FREQUENCY_2

#define AV_CH_LOW_FREQUENCY_2   (1ULL << AV_CHAN_LOW_FREQUENCY_2 )

Definition at line 182 of file channel_layout.h.

◆ AV_CH_TOP_SIDE_LEFT

#define AV_CH_TOP_SIDE_LEFT   (1ULL << AV_CHAN_TOP_SIDE_LEFT )

Definition at line 183 of file channel_layout.h.

◆ AV_CH_TOP_SIDE_RIGHT

#define AV_CH_TOP_SIDE_RIGHT   (1ULL << AV_CHAN_TOP_SIDE_RIGHT )

Definition at line 184 of file channel_layout.h.

◆ AV_CH_BOTTOM_FRONT_CENTER

#define AV_CH_BOTTOM_FRONT_CENTER   (1ULL << AV_CHAN_BOTTOM_FRONT_CENTER )

Definition at line 185 of file channel_layout.h.

◆ AV_CH_BOTTOM_FRONT_LEFT

#define AV_CH_BOTTOM_FRONT_LEFT   (1ULL << AV_CHAN_BOTTOM_FRONT_LEFT )

Definition at line 186 of file channel_layout.h.

◆ AV_CH_BOTTOM_FRONT_RIGHT

#define AV_CH_BOTTOM_FRONT_RIGHT   (1ULL << AV_CHAN_BOTTOM_FRONT_RIGHT )

Definition at line 187 of file channel_layout.h.

◆ AV_CH_LAYOUT_NATIVE

#define AV_CH_LAYOUT_NATIVE   0x8000000000000000ULL

Channel mask value used for AVCodecContext.request_channel_layout to indicate that the user requests the channel order of the decoder output to be the native codec channel order.

Deprecated:
channel order is now indicated in a special field in AVChannelLayout

Definition at line 196 of file channel_layout.h.