channel_layout.h (10445B)
1 /* 2 * Copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at> 3 * Copyright (c) 2008 Peter Ross 4 * 5 * This file is part of FFmpeg. 6 * 7 * FFmpeg is free software; you can redistribute it and/or 8 * modify it under the terms of the GNU Lesser General Public 9 * License as published by the Free Software Foundation; either 10 * version 2.1 of the License, or (at your option) any later version. 11 * 12 * FFmpeg is distributed in the hope that it will be useful, 13 * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 15 * Lesser General Public License for more details. 16 * 17 * You should have received a copy of the GNU Lesser General Public 18 * License along with FFmpeg; if not, write to the Free Software 19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 20 */ 21 22 #ifndef AVUTIL_CHANNEL_LAYOUT_H 23 #define AVUTIL_CHANNEL_LAYOUT_H 24 25 #include <stdint.h> 26 27 /** 28 * @file 29 * audio channel layout utility functions 30 */ 31 32 /** 33 * @addtogroup lavu_audio 34 * @{ 35 */ 36 37 /** 38 * @defgroup channel_masks Audio channel masks 39 * 40 * A channel layout is a 64-bits integer with a bit set for every channel. 41 * The number of bits set must be equal to the number of channels. 42 * The value 0 means that the channel layout is not known. 43 * @note this data structure is not powerful enough to handle channels 44 * combinations that have the same channel multiple times, such as 45 * dual-mono. 46 * 47 * @{ 48 */ 49 #define AV_CH_FRONT_LEFT 0x00000001 50 #define AV_CH_FRONT_RIGHT 0x00000002 51 #define AV_CH_FRONT_CENTER 0x00000004 52 #define AV_CH_LOW_FREQUENCY 0x00000008 53 #define AV_CH_BACK_LEFT 0x00000010 54 #define AV_CH_BACK_RIGHT 0x00000020 55 #define AV_CH_FRONT_LEFT_OF_CENTER 0x00000040 56 #define AV_CH_FRONT_RIGHT_OF_CENTER 0x00000080 57 #define AV_CH_BACK_CENTER 0x00000100 58 #define AV_CH_SIDE_LEFT 0x00000200 59 #define AV_CH_SIDE_RIGHT 0x00000400 60 #define AV_CH_TOP_CENTER 0x00000800 61 #define AV_CH_TOP_FRONT_LEFT 0x00001000 62 #define AV_CH_TOP_FRONT_CENTER 0x00002000 63 #define AV_CH_TOP_FRONT_RIGHT 0x00004000 64 #define AV_CH_TOP_BACK_LEFT 0x00008000 65 #define AV_CH_TOP_BACK_CENTER 0x00010000 66 #define AV_CH_TOP_BACK_RIGHT 0x00020000 67 #define AV_CH_STEREO_LEFT 0x20000000 ///< Stereo downmix. 68 #define AV_CH_STEREO_RIGHT 0x40000000 ///< See AV_CH_STEREO_LEFT. 69 #define AV_CH_WIDE_LEFT 0x0000000080000000ULL 70 #define AV_CH_WIDE_RIGHT 0x0000000100000000ULL 71 #define AV_CH_SURROUND_DIRECT_LEFT 0x0000000200000000ULL 72 #define AV_CH_SURROUND_DIRECT_RIGHT 0x0000000400000000ULL 73 #define AV_CH_LOW_FREQUENCY_2 0x0000000800000000ULL 74 #define AV_CH_TOP_SIDE_LEFT 0x0000001000000000ULL 75 #define AV_CH_TOP_SIDE_RIGHT 0x0000002000000000ULL 76 #define AV_CH_BOTTOM_FRONT_CENTER 0x0000004000000000ULL 77 #define AV_CH_BOTTOM_FRONT_LEFT 0x0000008000000000ULL 78 #define AV_CH_BOTTOM_FRONT_RIGHT 0x0000010000000000ULL 79 80 /** Channel mask value used for AVCodecContext.request_channel_layout 81 to indicate that the user requests the channel order of the decoder output 82 to be the native codec channel order. */ 83 #define AV_CH_LAYOUT_NATIVE 0x8000000000000000ULL 84 85 /** 86 * @} 87 * @defgroup channel_mask_c Audio channel layouts 88 * @{ 89 * */ 90 #define AV_CH_LAYOUT_MONO (AV_CH_FRONT_CENTER) 91 #define AV_CH_LAYOUT_STEREO (AV_CH_FRONT_LEFT | AV_CH_FRONT_RIGHT) 92 #define AV_CH_LAYOUT_2POINT1 (AV_CH_LAYOUT_STEREO | AV_CH_LOW_FREQUENCY) 93 #define AV_CH_LAYOUT_2_1 (AV_CH_LAYOUT_STEREO | AV_CH_BACK_CENTER) 94 #define AV_CH_LAYOUT_SURROUND (AV_CH_LAYOUT_STEREO | AV_CH_FRONT_CENTER) 95 #define AV_CH_LAYOUT_3POINT1 (AV_CH_LAYOUT_SURROUND | AV_CH_LOW_FREQUENCY) 96 #define AV_CH_LAYOUT_4POINT0 (AV_CH_LAYOUT_SURROUND | AV_CH_BACK_CENTER) 97 #define AV_CH_LAYOUT_4POINT1 (AV_CH_LAYOUT_4POINT0 | AV_CH_LOW_FREQUENCY) 98 #define AV_CH_LAYOUT_2_2 \ 99 (AV_CH_LAYOUT_STEREO | AV_CH_SIDE_LEFT | AV_CH_SIDE_RIGHT) 100 #define AV_CH_LAYOUT_QUAD \ 101 (AV_CH_LAYOUT_STEREO | AV_CH_BACK_LEFT | AV_CH_BACK_RIGHT) 102 #define AV_CH_LAYOUT_5POINT0 \ 103 (AV_CH_LAYOUT_SURROUND | AV_CH_SIDE_LEFT | AV_CH_SIDE_RIGHT) 104 #define AV_CH_LAYOUT_5POINT1 (AV_CH_LAYOUT_5POINT0 | AV_CH_LOW_FREQUENCY) 105 #define AV_CH_LAYOUT_5POINT0_BACK \ 106 (AV_CH_LAYOUT_SURROUND | AV_CH_BACK_LEFT | AV_CH_BACK_RIGHT) 107 #define AV_CH_LAYOUT_5POINT1_BACK \ 108 (AV_CH_LAYOUT_5POINT0_BACK | AV_CH_LOW_FREQUENCY) 109 #define AV_CH_LAYOUT_6POINT0 (AV_CH_LAYOUT_5POINT0 | AV_CH_BACK_CENTER) 110 #define AV_CH_LAYOUT_6POINT0_FRONT \ 111 (AV_CH_LAYOUT_2_2 | AV_CH_FRONT_LEFT_OF_CENTER | AV_CH_FRONT_RIGHT_OF_CENTER) 112 #define AV_CH_LAYOUT_HEXAGONAL (AV_CH_LAYOUT_5POINT0_BACK | AV_CH_BACK_CENTER) 113 #define AV_CH_LAYOUT_6POINT1 (AV_CH_LAYOUT_5POINT1 | AV_CH_BACK_CENTER) 114 #define AV_CH_LAYOUT_6POINT1_BACK \ 115 (AV_CH_LAYOUT_5POINT1_BACK | AV_CH_BACK_CENTER) 116 #define AV_CH_LAYOUT_6POINT1_FRONT \ 117 (AV_CH_LAYOUT_6POINT0_FRONT | AV_CH_LOW_FREQUENCY) 118 #define AV_CH_LAYOUT_7POINT0 \ 119 (AV_CH_LAYOUT_5POINT0 | AV_CH_BACK_LEFT | AV_CH_BACK_RIGHT) 120 #define AV_CH_LAYOUT_7POINT0_FRONT \ 121 (AV_CH_LAYOUT_5POINT0 | AV_CH_FRONT_LEFT_OF_CENTER | \ 122 AV_CH_FRONT_RIGHT_OF_CENTER) 123 #define AV_CH_LAYOUT_7POINT1 \ 124 (AV_CH_LAYOUT_5POINT1 | AV_CH_BACK_LEFT | AV_CH_BACK_RIGHT) 125 #define AV_CH_LAYOUT_7POINT1_WIDE \ 126 (AV_CH_LAYOUT_5POINT1 | AV_CH_FRONT_LEFT_OF_CENTER | \ 127 AV_CH_FRONT_RIGHT_OF_CENTER) 128 #define AV_CH_LAYOUT_7POINT1_WIDE_BACK \ 129 (AV_CH_LAYOUT_5POINT1_BACK | AV_CH_FRONT_LEFT_OF_CENTER | \ 130 AV_CH_FRONT_RIGHT_OF_CENTER) 131 #define AV_CH_LAYOUT_OCTAGONAL \ 132 (AV_CH_LAYOUT_5POINT0 | AV_CH_BACK_LEFT | AV_CH_BACK_CENTER | \ 133 AV_CH_BACK_RIGHT) 134 #define AV_CH_LAYOUT_HEXADECAGONAL \ 135 (AV_CH_LAYOUT_OCTAGONAL | AV_CH_WIDE_LEFT | AV_CH_WIDE_RIGHT | \ 136 AV_CH_TOP_BACK_LEFT | AV_CH_TOP_BACK_RIGHT | AV_CH_TOP_BACK_CENTER | \ 137 AV_CH_TOP_FRONT_CENTER | AV_CH_TOP_FRONT_LEFT | AV_CH_TOP_FRONT_RIGHT) 138 #define AV_CH_LAYOUT_STEREO_DOWNMIX (AV_CH_STEREO_LEFT | AV_CH_STEREO_RIGHT) 139 #define AV_CH_LAYOUT_22POINT2 \ 140 (AV_CH_LAYOUT_5POINT1_BACK | AV_CH_FRONT_LEFT_OF_CENTER | \ 141 AV_CH_FRONT_RIGHT_OF_CENTER | AV_CH_BACK_CENTER | AV_CH_LOW_FREQUENCY_2 | \ 142 AV_CH_SIDE_LEFT | AV_CH_SIDE_RIGHT | AV_CH_TOP_FRONT_LEFT | \ 143 AV_CH_TOP_FRONT_RIGHT | AV_CH_TOP_FRONT_CENTER | AV_CH_TOP_CENTER | \ 144 AV_CH_TOP_BACK_LEFT | AV_CH_TOP_BACK_RIGHT | AV_CH_TOP_SIDE_LEFT | \ 145 AV_CH_TOP_SIDE_RIGHT | AV_CH_TOP_BACK_CENTER | AV_CH_BOTTOM_FRONT_CENTER | \ 146 AV_CH_BOTTOM_FRONT_LEFT | AV_CH_BOTTOM_FRONT_RIGHT) 147 148 enum AVMatrixEncoding { 149 AV_MATRIX_ENCODING_NONE, 150 AV_MATRIX_ENCODING_DOLBY, 151 AV_MATRIX_ENCODING_DPLII, 152 AV_MATRIX_ENCODING_DPLIIX, 153 AV_MATRIX_ENCODING_DPLIIZ, 154 AV_MATRIX_ENCODING_DOLBYEX, 155 AV_MATRIX_ENCODING_DOLBYHEADPHONE, 156 AV_MATRIX_ENCODING_NB 157 }; 158 159 /** 160 * Return a channel layout id that matches name, or 0 if no match is found. 161 * 162 * name can be one or several of the following notations, 163 * separated by '+' or '|': 164 * - the name of an usual channel layout (mono, stereo, 4.0, quad, 5.0, 165 * 5.0(side), 5.1, 5.1(side), 7.1, 7.1(wide), downmix); 166 * - the name of a single channel (FL, FR, FC, LFE, BL, BR, FLC, FRC, BC, 167 * SL, SR, TC, TFL, TFC, TFR, TBL, TBC, TBR, DL, DR); 168 * - a number of channels, in decimal, followed by 'c', yielding 169 * the default channel layout for that number of channels (@see 170 * av_get_default_channel_layout); 171 * - a channel layout mask, in hexadecimal starting with "0x" (see the 172 * AV_CH_* macros). 173 * 174 * Example: "stereo+FC" = "2c+FC" = "2c+1c" = "0x7" 175 */ 176 uint64_t av_get_channel_layout(const char* name); 177 178 /** 179 * Return a channel layout and the number of channels based on the specified 180 * name. 181 * 182 * This function is similar to (@see av_get_channel_layout), but can also parse 183 * unknown channel layout specifications. 184 * 185 * @param[in] name channel layout specification string 186 * @param[out] channel_layout parsed channel layout (0 if unknown) 187 * @param[out] nb_channels number of channels 188 * 189 * @return 0 on success, AVERROR(EINVAL) if the parsing fails. 190 */ 191 int av_get_extended_channel_layout(const char* name, uint64_t* channel_layout, 192 int* nb_channels); 193 194 /** 195 * Return a description of a channel layout. 196 * If nb_channels is <= 0, it is guessed from the channel_layout. 197 * 198 * @param buf put here the string containing the channel layout 199 * @param buf_size size in bytes of the buffer 200 */ 201 void av_get_channel_layout_string(char* buf, int buf_size, int nb_channels, 202 uint64_t channel_layout); 203 204 struct AVBPrint; 205 /** 206 * Append a description of a channel layout to a bprint buffer. 207 */ 208 void av_bprint_channel_layout(struct AVBPrint* bp, int nb_channels, 209 uint64_t channel_layout); 210 211 /** 212 * Return the number of channels in the channel layout. 213 */ 214 int av_get_channel_layout_nb_channels(uint64_t channel_layout); 215 216 /** 217 * Return default channel layout for a given number of channels. 218 */ 219 int64_t av_get_default_channel_layout(int nb_channels); 220 221 /** 222 * Get the index of a channel in channel_layout. 223 * 224 * @param channel a channel layout describing exactly one channel which must be 225 * present in channel_layout. 226 * 227 * @return index of channel in channel_layout on success, a negative AVERROR 228 * on error. 229 */ 230 int av_get_channel_layout_channel_index(uint64_t channel_layout, 231 uint64_t channel); 232 233 /** 234 * Get the channel with the given index in channel_layout. 235 */ 236 uint64_t av_channel_layout_extract_channel(uint64_t channel_layout, int index); 237 238 /** 239 * Get the name of a given channel. 240 * 241 * @return channel name on success, NULL on error. 242 */ 243 const char* av_get_channel_name(uint64_t channel); 244 245 /** 246 * Get the description of a given channel. 247 * 248 * @param channel a channel layout with a single channel 249 * @return channel description on success, NULL on error 250 */ 251 const char* av_get_channel_description(uint64_t channel); 252 253 /** 254 * Get the value and name of a standard channel layout. 255 * 256 * @param[in] index index in an internal list, starting at 0 257 * @param[out] layout channel layout mask 258 * @param[out] name name of the layout 259 * @return 0 if the layout exists, 260 * <0 if index is beyond the limits 261 */ 262 int av_get_standard_channel_layout(unsigned index, uint64_t* layout, 263 const char** name); 264 265 /** 266 * @} 267 * @} 268 */ 269 270 #endif /* AVUTIL_CHANNEL_LAYOUT_H */