54b13b2beae1417f21005e02f7ed467acf79a2c2
[libav.git] / libavutil / audioconvert.h
1 /*
2 * Copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
3 * Copyright (c) 2008 Peter Ross
4 *
5 * This file is part of Libav.
6 *
7 * Libav 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 * Libav 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 Libav; 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_AUDIOCONVERT_H
23 #define AVUTIL_AUDIOCONVERT_H
24
25 #include <stdint.h>
26
27 /**
28 * @file
29 * audio conversion routines
30 */
31
32 /**
33 * @addtogroup lavu_audio
34 * @{
35 */
36
37 /**
38 * @defgroup channel_masks Audio channel masks
39 * @{
40 */
41 #define AV_CH_FRONT_LEFT 0x00000001
42 #define AV_CH_FRONT_RIGHT 0x00000002
43 #define AV_CH_FRONT_CENTER 0x00000004
44 #define AV_CH_LOW_FREQUENCY 0x00000008
45 #define AV_CH_BACK_LEFT 0x00000010
46 #define AV_CH_BACK_RIGHT 0x00000020
47 #define AV_CH_FRONT_LEFT_OF_CENTER 0x00000040
48 #define AV_CH_FRONT_RIGHT_OF_CENTER 0x00000080
49 #define AV_CH_BACK_CENTER 0x00000100
50 #define AV_CH_SIDE_LEFT 0x00000200
51 #define AV_CH_SIDE_RIGHT 0x00000400
52 #define AV_CH_TOP_CENTER 0x00000800
53 #define AV_CH_TOP_FRONT_LEFT 0x00001000
54 #define AV_CH_TOP_FRONT_CENTER 0x00002000
55 #define AV_CH_TOP_FRONT_RIGHT 0x00004000
56 #define AV_CH_TOP_BACK_LEFT 0x00008000
57 #define AV_CH_TOP_BACK_CENTER 0x00010000
58 #define AV_CH_TOP_BACK_RIGHT 0x00020000
59 #define AV_CH_STEREO_LEFT 0x20000000 ///< Stereo downmix.
60 #define AV_CH_STEREO_RIGHT 0x40000000 ///< See AV_CH_STEREO_LEFT.
61
62 /** Channel mask value used for AVCodecContext.request_channel_layout
63 to indicate that the user requests the channel order of the decoder output
64 to be the native codec channel order. */
65 #define AV_CH_LAYOUT_NATIVE 0x8000000000000000ULL
66
67 /**
68 * @}
69 * @defgroup channel_mask_c Audio channel convenience macros
70 * @{
71 * */
72 #define AV_CH_LAYOUT_MONO (AV_CH_FRONT_CENTER)
73 #define AV_CH_LAYOUT_STEREO (AV_CH_FRONT_LEFT|AV_CH_FRONT_RIGHT)
74 #define AV_CH_LAYOUT_2_1 (AV_CH_LAYOUT_STEREO|AV_CH_BACK_CENTER)
75 #define AV_CH_LAYOUT_SURROUND (AV_CH_LAYOUT_STEREO|AV_CH_FRONT_CENTER)
76 #define AV_CH_LAYOUT_4POINT0 (AV_CH_LAYOUT_SURROUND|AV_CH_BACK_CENTER)
77 #define AV_CH_LAYOUT_2_2 (AV_CH_LAYOUT_STEREO|AV_CH_SIDE_LEFT|AV_CH_SIDE_RIGHT)
78 #define AV_CH_LAYOUT_QUAD (AV_CH_LAYOUT_STEREO|AV_CH_BACK_LEFT|AV_CH_BACK_RIGHT)
79 #define AV_CH_LAYOUT_5POINT0 (AV_CH_LAYOUT_SURROUND|AV_CH_SIDE_LEFT|AV_CH_SIDE_RIGHT)
80 #define AV_CH_LAYOUT_5POINT1 (AV_CH_LAYOUT_5POINT0|AV_CH_LOW_FREQUENCY)
81 #define AV_CH_LAYOUT_5POINT0_BACK (AV_CH_LAYOUT_SURROUND|AV_CH_BACK_LEFT|AV_CH_BACK_RIGHT)
82 #define AV_CH_LAYOUT_5POINT1_BACK (AV_CH_LAYOUT_5POINT0_BACK|AV_CH_LOW_FREQUENCY)
83 #define AV_CH_LAYOUT_7POINT0 (AV_CH_LAYOUT_5POINT0|AV_CH_BACK_LEFT|AV_CH_BACK_RIGHT)
84 #define AV_CH_LAYOUT_7POINT1 (AV_CH_LAYOUT_5POINT1|AV_CH_BACK_LEFT|AV_CH_BACK_RIGHT)
85 #define AV_CH_LAYOUT_7POINT1_WIDE (AV_CH_LAYOUT_5POINT1_BACK|AV_CH_FRONT_LEFT_OF_CENTER|AV_CH_FRONT_RIGHT_OF_CENTER)
86 #define AV_CH_LAYOUT_STEREO_DOWNMIX (AV_CH_STEREO_LEFT|AV_CH_STEREO_RIGHT)
87
88 /**
89 * @}
90 */
91
92 /**
93 * Return a channel layout id that matches name, 0 if no match.
94 */
95 uint64_t av_get_channel_layout(const char *name);
96
97 /**
98 * Return a description of a channel layout.
99 * If nb_channels is <= 0, it is guessed from the channel_layout.
100 *
101 * @param buf put here the string containing the channel layout
102 * @param buf_size size in bytes of the buffer
103 */
104 void av_get_channel_layout_string(char *buf, int buf_size, int nb_channels, uint64_t channel_layout);
105
106 /**
107 * Return the number of channels in the channel layout.
108 */
109 int av_get_channel_layout_nb_channels(uint64_t channel_layout);
110
111 /**
112 * @}
113 */
114
115 #endif /* AVUTIL_AUDIOCONVERT_H */