audioconvert.h 8.1 KB

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