channel_layout.h 9.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232
  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. #ifndef AVUTIL_CHANNEL_LAYOUT_H
  22. #define AVUTIL_CHANNEL_LAYOUT_H
  23. #include <stdint.h>
  24. /**
  25. * @file
  26. * audio channel layout utility functions
  27. */
  28. /**
  29. * @addtogroup lavu_audio
  30. * @{
  31. */
  32. /**
  33. * @defgroup channel_masks Audio channel masks
  34. *
  35. * A channel layout is a 64-bits integer with a bit set for every channel.
  36. * The number of bits set must be equal to the number of channels.
  37. * The value 0 means that the channel layout is not known.
  38. * @note this data structure is not powerful enough to handle channels
  39. * combinations that have the same channel multiple times, such as
  40. * dual-mono.
  41. *
  42. * @{
  43. */
  44. #define AV_CH_FRONT_LEFT 0x00000001
  45. #define AV_CH_FRONT_RIGHT 0x00000002
  46. #define AV_CH_FRONT_CENTER 0x00000004
  47. #define AV_CH_LOW_FREQUENCY 0x00000008
  48. #define AV_CH_BACK_LEFT 0x00000010
  49. #define AV_CH_BACK_RIGHT 0x00000020
  50. #define AV_CH_FRONT_LEFT_OF_CENTER 0x00000040
  51. #define AV_CH_FRONT_RIGHT_OF_CENTER 0x00000080
  52. #define AV_CH_BACK_CENTER 0x00000100
  53. #define AV_CH_SIDE_LEFT 0x00000200
  54. #define AV_CH_SIDE_RIGHT 0x00000400
  55. #define AV_CH_TOP_CENTER 0x00000800
  56. #define AV_CH_TOP_FRONT_LEFT 0x00001000
  57. #define AV_CH_TOP_FRONT_CENTER 0x00002000
  58. #define AV_CH_TOP_FRONT_RIGHT 0x00004000
  59. #define AV_CH_TOP_BACK_LEFT 0x00008000
  60. #define AV_CH_TOP_BACK_CENTER 0x00010000
  61. #define AV_CH_TOP_BACK_RIGHT 0x00020000
  62. #define AV_CH_STEREO_LEFT 0x20000000 ///< Stereo downmix.
  63. #define AV_CH_STEREO_RIGHT 0x40000000 ///< See AV_CH_STEREO_LEFT.
  64. #define AV_CH_WIDE_LEFT 0x0000000080000000ULL
  65. #define AV_CH_WIDE_RIGHT 0x0000000100000000ULL
  66. #define AV_CH_SURROUND_DIRECT_LEFT 0x0000000200000000ULL
  67. #define AV_CH_SURROUND_DIRECT_RIGHT 0x0000000400000000ULL
  68. #define AV_CH_LOW_FREQUENCY_2 0x0000000800000000ULL
  69. /** Channel mask value used for AVCodecContext.request_channel_layout
  70. to indicate that the user requests the channel order of the decoder output
  71. to be the native codec channel order. */
  72. #define AV_CH_LAYOUT_NATIVE 0x8000000000000000ULL
  73. /**
  74. * @}
  75. * @defgroup channel_mask_c Audio channel layouts
  76. * @{
  77. * */
  78. #define AV_CH_LAYOUT_MONO (AV_CH_FRONT_CENTER)
  79. #define AV_CH_LAYOUT_STEREO (AV_CH_FRONT_LEFT|AV_CH_FRONT_RIGHT)
  80. #define AV_CH_LAYOUT_2POINT1 (AV_CH_LAYOUT_STEREO|AV_CH_LOW_FREQUENCY)
  81. #define AV_CH_LAYOUT_2_1 (AV_CH_LAYOUT_STEREO|AV_CH_BACK_CENTER)
  82. #define AV_CH_LAYOUT_SURROUND (AV_CH_LAYOUT_STEREO|AV_CH_FRONT_CENTER)
  83. #define AV_CH_LAYOUT_3POINT1 (AV_CH_LAYOUT_SURROUND|AV_CH_LOW_FREQUENCY)
  84. #define AV_CH_LAYOUT_4POINT0 (AV_CH_LAYOUT_SURROUND|AV_CH_BACK_CENTER)
  85. #define AV_CH_LAYOUT_4POINT1 (AV_CH_LAYOUT_4POINT0|AV_CH_LOW_FREQUENCY)
  86. #define AV_CH_LAYOUT_2_2 (AV_CH_LAYOUT_STEREO|AV_CH_SIDE_LEFT|AV_CH_SIDE_RIGHT)
  87. #define AV_CH_LAYOUT_QUAD (AV_CH_LAYOUT_STEREO|AV_CH_BACK_LEFT|AV_CH_BACK_RIGHT)
  88. #define AV_CH_LAYOUT_5POINT0 (AV_CH_LAYOUT_SURROUND|AV_CH_SIDE_LEFT|AV_CH_SIDE_RIGHT)
  89. #define AV_CH_LAYOUT_5POINT1 (AV_CH_LAYOUT_5POINT0|AV_CH_LOW_FREQUENCY)
  90. #define AV_CH_LAYOUT_5POINT0_BACK (AV_CH_LAYOUT_SURROUND|AV_CH_BACK_LEFT|AV_CH_BACK_RIGHT)
  91. #define AV_CH_LAYOUT_5POINT1_BACK (AV_CH_LAYOUT_5POINT0_BACK|AV_CH_LOW_FREQUENCY)
  92. #define AV_CH_LAYOUT_6POINT0 (AV_CH_LAYOUT_5POINT0|AV_CH_BACK_CENTER)
  93. #define AV_CH_LAYOUT_6POINT0_FRONT (AV_CH_LAYOUT_2_2|AV_CH_FRONT_LEFT_OF_CENTER|AV_CH_FRONT_RIGHT_OF_CENTER)
  94. #define AV_CH_LAYOUT_HEXAGONAL (AV_CH_LAYOUT_5POINT0_BACK|AV_CH_BACK_CENTER)
  95. #define AV_CH_LAYOUT_6POINT1 (AV_CH_LAYOUT_5POINT1|AV_CH_BACK_CENTER)
  96. #define AV_CH_LAYOUT_6POINT1_BACK (AV_CH_LAYOUT_5POINT1_BACK|AV_CH_BACK_CENTER)
  97. #define AV_CH_LAYOUT_6POINT1_FRONT (AV_CH_LAYOUT_6POINT0_FRONT|AV_CH_LOW_FREQUENCY)
  98. #define AV_CH_LAYOUT_7POINT0 (AV_CH_LAYOUT_5POINT0|AV_CH_BACK_LEFT|AV_CH_BACK_RIGHT)
  99. #define AV_CH_LAYOUT_7POINT0_FRONT (AV_CH_LAYOUT_5POINT0|AV_CH_FRONT_LEFT_OF_CENTER|AV_CH_FRONT_RIGHT_OF_CENTER)
  100. #define AV_CH_LAYOUT_7POINT1 (AV_CH_LAYOUT_5POINT1|AV_CH_BACK_LEFT|AV_CH_BACK_RIGHT)
  101. #define AV_CH_LAYOUT_7POINT1_WIDE (AV_CH_LAYOUT_5POINT1|AV_CH_FRONT_LEFT_OF_CENTER|AV_CH_FRONT_RIGHT_OF_CENTER)
  102. #define AV_CH_LAYOUT_7POINT1_WIDE_BACK (AV_CH_LAYOUT_5POINT1_BACK|AV_CH_FRONT_LEFT_OF_CENTER|AV_CH_FRONT_RIGHT_OF_CENTER)
  103. #define AV_CH_LAYOUT_OCTAGONAL (AV_CH_LAYOUT_5POINT0|AV_CH_BACK_LEFT|AV_CH_BACK_CENTER|AV_CH_BACK_RIGHT)
  104. #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)
  105. #define AV_CH_LAYOUT_STEREO_DOWNMIX (AV_CH_STEREO_LEFT|AV_CH_STEREO_RIGHT)
  106. enum AVMatrixEncoding {
  107. AV_MATRIX_ENCODING_NONE,
  108. AV_MATRIX_ENCODING_DOLBY,
  109. AV_MATRIX_ENCODING_DPLII,
  110. AV_MATRIX_ENCODING_DPLIIX,
  111. AV_MATRIX_ENCODING_DPLIIZ,
  112. AV_MATRIX_ENCODING_DOLBYEX,
  113. AV_MATRIX_ENCODING_DOLBYHEADPHONE,
  114. AV_MATRIX_ENCODING_NB
  115. };
  116. /**
  117. * Return a channel layout id that matches name, or 0 if no match is found.
  118. *
  119. * name can be one or several of the following notations,
  120. * separated by '+' or '|':
  121. * - the name of an usual channel layout (mono, stereo, 4.0, quad, 5.0,
  122. * 5.0(side), 5.1, 5.1(side), 7.1, 7.1(wide), downmix);
  123. * - the name of a single channel (FL, FR, FC, LFE, BL, BR, FLC, FRC, BC,
  124. * SL, SR, TC, TFL, TFC, TFR, TBL, TBC, TBR, DL, DR);
  125. * - a number of channels, in decimal, followed by 'c', yielding
  126. * the default channel layout for that number of channels (@see
  127. * av_get_default_channel_layout);
  128. * - a channel layout mask, in hexadecimal starting with "0x" (see the
  129. * AV_CH_* macros).
  130. *
  131. * Example: "stereo+FC" = "2c+FC" = "2c+1c" = "0x7"
  132. */
  133. uint64_t av_get_channel_layout(const char *name);
  134. /**
  135. * Return a channel layout and the number of channels based on the specified name.
  136. *
  137. * This function is similar to (@see av_get_channel_layout), but can also parse
  138. * unknown channel layout specifications.
  139. *
  140. * @param[in] name channel layout specification string
  141. * @param[out] channel_layout parsed channel layout (0 if unknown)
  142. * @param[out] nb_channels number of channels
  143. *
  144. * @return 0 on success, AVERROR(EINVAL) if the parsing fails.
  145. */
  146. int av_get_extended_channel_layout(const char *name, uint64_t* channel_layout, int* nb_channels);
  147. /**
  148. * Return a description of a channel layout.
  149. * If nb_channels is <= 0, it is guessed from the channel_layout.
  150. *
  151. * @param buf put here the string containing the channel layout
  152. * @param buf_size size in bytes of the buffer
  153. */
  154. void av_get_channel_layout_string(char *buf, int buf_size, int nb_channels, uint64_t channel_layout);
  155. struct AVBPrint;
  156. /**
  157. * Append a description of a channel layout to a bprint buffer.
  158. */
  159. void av_bprint_channel_layout(struct AVBPrint *bp, int nb_channels, uint64_t channel_layout);
  160. /**
  161. * Return the number of channels in the channel layout.
  162. */
  163. int av_get_channel_layout_nb_channels(uint64_t channel_layout);
  164. /**
  165. * Return default channel layout for a given number of channels.
  166. */
  167. int64_t av_get_default_channel_layout(int nb_channels);
  168. /**
  169. * Get the index of a channel in channel_layout.
  170. *
  171. * @param channel a channel layout describing exactly one channel which must be
  172. * present in channel_layout.
  173. *
  174. * @return index of channel in channel_layout on success, a negative AVERROR
  175. * on error.
  176. */
  177. int av_get_channel_layout_channel_index(uint64_t channel_layout,
  178. uint64_t channel);
  179. /**
  180. * Get the channel with the given index in channel_layout.
  181. */
  182. uint64_t av_channel_layout_extract_channel(uint64_t channel_layout, int index);
  183. /**
  184. * Get the name of a given channel.
  185. *
  186. * @return channel name on success, NULL on error.
  187. */
  188. const char *av_get_channel_name(uint64_t channel);
  189. /**
  190. * Get the description of a given channel.
  191. *
  192. * @param channel a channel layout with a single channel
  193. * @return channel description on success, NULL on error
  194. */
  195. const char *av_get_channel_description(uint64_t channel);
  196. /**
  197. * Get the value and name of a standard channel layout.
  198. *
  199. * @param[in] index index in an internal list, starting at 0
  200. * @param[out] layout channel layout mask
  201. * @param[out] name name of the layout
  202. * @return 0 if the layout exists,
  203. * <0 if index is beyond the limits
  204. */
  205. int av_get_standard_channel_layout(unsigned index, uint64_t *layout,
  206. const char **name);
  207. /**
  208. * @}
  209. * @}
  210. */
  211. #endif /* AVUTIL_CHANNEL_LAYOUT_H */