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 module ffmpeg.libavutil.channel_layout; 23 24 extern (C): 25 import ffmpeg; @nogc nothrow: 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 enum AV_CH_FRONT_LEFT = 0x00000001; 50 enum AV_CH_FRONT_RIGHT = 0x00000002; 51 enum AV_CH_FRONT_CENTER = 0x00000004; 52 enum AV_CH_LOW_FREQUENCY = 0x00000008; 53 enum AV_CH_BACK_LEFT = 0x00000010; 54 enum AV_CH_BACK_RIGHT = 0x00000020; 55 enum AV_CH_FRONT_LEFT_OF_CENTER = 0x00000040; 56 enum AV_CH_FRONT_RIGHT_OF_CENTER = 0x00000080; 57 enum AV_CH_BACK_CENTER = 0x00000100; 58 enum AV_CH_SIDE_LEFT = 0x00000200; 59 enum AV_CH_SIDE_RIGHT = 0x00000400; 60 enum AV_CH_TOP_CENTER = 0x00000800; 61 enum AV_CH_TOP_FRONT_LEFT = 0x00001000; 62 enum AV_CH_TOP_FRONT_CENTER = 0x00002000; 63 enum AV_CH_TOP_FRONT_RIGHT = 0x00004000; 64 enum AV_CH_TOP_BACK_LEFT = 0x00008000; 65 enum AV_CH_TOP_BACK_CENTER = 0x00010000; 66 enum AV_CH_TOP_BACK_RIGHT = 0x00020000; 67 enum AV_CH_STEREO_LEFT = 0x20000000; ///< Stereo downmix. 68 enum AV_CH_STEREO_RIGHT = 0x40000000; ///< See AV_CH_STEREO_LEFT. 69 enum AV_CH_WIDE_LEFT = 0x0000000080000000UL; 70 enum AV_CH_WIDE_RIGHT = 0x0000000100000000UL; 71 enum AV_CH_SURROUND_DIRECT_LEFT = 0x0000000200000000UL; 72 enum AV_CH_SURROUND_DIRECT_RIGHT = 0x0000000400000000UL; 73 enum AV_CH_LOW_FREQUENCY_2 = 0x0000000800000000UL; 74 75 /** Channel mask value used for AVCodecContext.request_channel_layout 76 to indicate that the user requests the channel order of the decoder output 77 to be the native codec channel order. */ 78 enum AV_CH_LAYOUT_NATIVE = 0x8000000000000000UL; 79 80 /** 81 * @} 82 * @defgroup channel_mask_c Audio channel layouts 83 * @{ 84 * */ 85 enum AV_CH_LAYOUT_MONO = AV_CH_FRONT_CENTER; 86 enum AV_CH_LAYOUT_STEREO = AV_CH_FRONT_LEFT | AV_CH_FRONT_RIGHT; 87 enum AV_CH_LAYOUT_2POINT1 = AV_CH_LAYOUT_STEREO | AV_CH_LOW_FREQUENCY; 88 enum AV_CH_LAYOUT_2_1 = AV_CH_LAYOUT_STEREO | AV_CH_BACK_CENTER; 89 enum AV_CH_LAYOUT_SURROUND = AV_CH_LAYOUT_STEREO | AV_CH_FRONT_CENTER; 90 enum AV_CH_LAYOUT_3POINT1 = AV_CH_LAYOUT_SURROUND | AV_CH_LOW_FREQUENCY; 91 enum AV_CH_LAYOUT_4POINT0 = AV_CH_LAYOUT_SURROUND | AV_CH_BACK_CENTER; 92 enum AV_CH_LAYOUT_4POINT1 = AV_CH_LAYOUT_4POINT0 | AV_CH_LOW_FREQUENCY; 93 enum AV_CH_LAYOUT_2_2 = AV_CH_LAYOUT_STEREO | AV_CH_SIDE_LEFT | AV_CH_SIDE_RIGHT; 94 enum AV_CH_LAYOUT_QUAD = AV_CH_LAYOUT_STEREO | AV_CH_BACK_LEFT | AV_CH_BACK_RIGHT; 95 enum AV_CH_LAYOUT_5POINT0 = AV_CH_LAYOUT_SURROUND | AV_CH_SIDE_LEFT | AV_CH_SIDE_RIGHT; 96 enum AV_CH_LAYOUT_5POINT1 = AV_CH_LAYOUT_5POINT0 | AV_CH_LOW_FREQUENCY; 97 enum AV_CH_LAYOUT_5POINT0_BACK = AV_CH_LAYOUT_SURROUND | AV_CH_BACK_LEFT | AV_CH_BACK_RIGHT; 98 enum AV_CH_LAYOUT_5POINT1_BACK = AV_CH_LAYOUT_5POINT0_BACK | AV_CH_LOW_FREQUENCY; 99 enum AV_CH_LAYOUT_6POINT0 = AV_CH_LAYOUT_5POINT0 | AV_CH_BACK_CENTER; 100 enum AV_CH_LAYOUT_6POINT0_FRONT = AV_CH_LAYOUT_2_2 | AV_CH_FRONT_LEFT_OF_CENTER | AV_CH_FRONT_RIGHT_OF_CENTER; 101 enum AV_CH_LAYOUT_HEXAGONAL = AV_CH_LAYOUT_5POINT0_BACK | AV_CH_BACK_CENTER; 102 enum AV_CH_LAYOUT_6POINT1 = AV_CH_LAYOUT_5POINT1 | AV_CH_BACK_CENTER; 103 enum AV_CH_LAYOUT_6POINT1_BACK = AV_CH_LAYOUT_5POINT1_BACK | AV_CH_BACK_CENTER; 104 enum AV_CH_LAYOUT_6POINT1_FRONT = AV_CH_LAYOUT_6POINT0_FRONT | AV_CH_LOW_FREQUENCY; 105 enum AV_CH_LAYOUT_7POINT0 = AV_CH_LAYOUT_5POINT0 | AV_CH_BACK_LEFT | AV_CH_BACK_RIGHT; 106 enum AV_CH_LAYOUT_7POINT0_FRONT = AV_CH_LAYOUT_5POINT0 | AV_CH_FRONT_LEFT_OF_CENTER | AV_CH_FRONT_RIGHT_OF_CENTER; 107 enum AV_CH_LAYOUT_7POINT1 = AV_CH_LAYOUT_5POINT1 | AV_CH_BACK_LEFT | AV_CH_BACK_RIGHT; 108 enum AV_CH_LAYOUT_7POINT1_WIDE = AV_CH_LAYOUT_5POINT1 | AV_CH_FRONT_LEFT_OF_CENTER | AV_CH_FRONT_RIGHT_OF_CENTER; 109 enum AV_CH_LAYOUT_7POINT1_WIDE_BACK = AV_CH_LAYOUT_5POINT1_BACK | AV_CH_FRONT_LEFT_OF_CENTER | AV_CH_FRONT_RIGHT_OF_CENTER; 110 enum AV_CH_LAYOUT_OCTAGONAL = AV_CH_LAYOUT_5POINT0 | AV_CH_BACK_LEFT | AV_CH_BACK_CENTER | AV_CH_BACK_RIGHT; 111 enum 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; 112 enum AV_CH_LAYOUT_STEREO_DOWNMIX = AV_CH_STEREO_LEFT | AV_CH_STEREO_RIGHT; 113 114 enum AVMatrixEncoding 115 { 116 AV_MATRIX_ENCODING_NONE = 0, 117 AV_MATRIX_ENCODING_DOLBY = 1, 118 AV_MATRIX_ENCODING_DPLII = 2, 119 AV_MATRIX_ENCODING_DPLIIX = 3, 120 AV_MATRIX_ENCODING_DPLIIZ = 4, 121 AV_MATRIX_ENCODING_DOLBYEX = 5, 122 AV_MATRIX_ENCODING_DOLBYHEADPHONE = 6, 123 AV_MATRIX_ENCODING_NB = 7 124 } 125 126 /** 127 * Return a channel layout id that matches name, or 0 if no match is found. 128 * 129 * name can be one or several of the following notations, 130 * separated by '+' or '|': 131 * - the name of an usual channel layout (mono, stereo, 4.0, quad, 5.0, 132 * 5.0(side), 5.1, 5.1(side), 7.1, 7.1(wide), downmix); 133 * - the name of a single channel (FL, FR, FC, LFE, BL, BR, FLC, FRC, BC, 134 * SL, SR, TC, TFL, TFC, TFR, TBL, TBC, TBR, DL, DR); 135 * - a number of channels, in decimal, followed by 'c', yielding 136 * the default channel layout for that number of channels (@see 137 * av_get_default_channel_layout); 138 * - a channel layout mask, in hexadecimal starting with "0x" (see the 139 * AV_CH_* macros). 140 * 141 * Example: "stereo+FC" = "2c+FC" = "2c+1c" = "0x7" 142 */ 143 ulong av_get_channel_layout (const(char)* name); 144 145 /** 146 * Return a channel layout and the number of channels based on the specified name. 147 * 148 * This function is similar to (@see av_get_channel_layout), but can also parse 149 * unknown channel layout specifications. 150 * 151 * @param[in] name channel layout specification string 152 * @param[out] channel_layout parsed channel layout (0 if unknown) 153 * @param[out] nb_channels number of channels 154 * 155 * @return 0 on success, AVERROR(EINVAL) if the parsing fails. 156 */ 157 int av_get_extended_channel_layout (const(char)* name, ulong* channel_layout, int* nb_channels); 158 159 /** 160 * Return a description of a channel layout. 161 * If nb_channels is <= 0, it is guessed from the channel_layout. 162 * 163 * @param buf put here the string containing the channel layout 164 * @param buf_size size in bytes of the buffer 165 */ 166 void av_get_channel_layout_string (char* buf, int buf_size, int nb_channels, ulong channel_layout); 167 168 struct AVBPrint; 169 /** 170 * Append a description of a channel layout to a bprint buffer. 171 */ 172 void av_bprint_channel_layout (AVBPrint* bp, int nb_channels, ulong channel_layout); 173 174 /** 175 * Return the number of channels in the channel layout. 176 */ 177 int av_get_channel_layout_nb_channels (ulong channel_layout); 178 179 /** 180 * Return default channel layout for a given number of channels. 181 */ 182 long av_get_default_channel_layout (int nb_channels); 183 184 /** 185 * Get the index of a channel in channel_layout. 186 * 187 * @param channel a channel layout describing exactly one channel which must be 188 * present in channel_layout. 189 * 190 * @return index of channel in channel_layout on success, a negative AVERROR 191 * on error. 192 */ 193 int av_get_channel_layout_channel_index (ulong channel_layout, ulong channel); 194 195 /** 196 * Get the channel with the given index in channel_layout. 197 */ 198 ulong av_channel_layout_extract_channel (ulong channel_layout, int index); 199 200 /** 201 * Get the name of a given channel. 202 * 203 * @return channel name on success, NULL on error. 204 */ 205 const(char)* av_get_channel_name (ulong channel); 206 207 /** 208 * Get the description of a given channel. 209 * 210 * @param channel a channel layout with a single channel 211 * @return channel description on success, NULL on error 212 */ 213 const(char)* av_get_channel_description (ulong channel); 214 215 /** 216 * Get the value and name of a standard channel layout. 217 * 218 * @param[in] index index in an internal list, starting at 0 219 * @param[out] layout channel layout mask 220 * @param[out] name name of the layout 221 * @return 0 if the layout exists, 222 * <0 if index is beyond the limits 223 */ 224 int av_get_standard_channel_layout ( 225 uint index, 226 ulong* layout, 227 const(char*)* name); 228 229 /** 230 * @} 231 * @} 232 */ 233 234 /* AVUTIL_CHANNEL_LAYOUT_H */