audioconvert: add av_get_standard_channel_layout().
[ffmpeg.git] / libavutil / audioconvert.c
1 /*
2  * Copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 /**
22  * @file
23  * audio conversion routines
24  */
25
26 #include "avstring.h"
27 #include "avutil.h"
28 #include "audioconvert.h"
29 #include "bprint.h"
30
31 struct channel_name {
32     const char *name;
33     const char *description;
34 };
35
36 static const struct channel_name channel_names[] = {
37      [0] = { "FL",        "front left"            },
38      [1] = { "FR",        "front right"           },
39      [2] = { "FC",        "front center"          },
40      [3] = { "LFE",       "low frequency"         },
41      [4] = { "BL",        "back left"             },
42      [5] = { "BR",        "back right"            },
43      [6] = { "FLC",       "front left-of-center"  },
44      [7] = { "FRC",       "front right-of-center" },
45      [8] = { "BC",        "back center"           },
46      [9] = { "SL",        "side left"             },
47     [10] = { "SR",        "side right"            },
48     [11] = { "TC",        "top center"            },
49     [12] = { "TFL",       "top front left"        },
50     [13] = { "TFC",       "top front center"      },
51     [14] = { "TFR",       "top front right"       },
52     [15] = { "TBL",       "top back left"         },
53     [16] = { "TBC",       "top back center"       },
54     [17] = { "TBR",       "top back right"        },
55     [29] = { "DL",        "downmix left"          },
56     [30] = { "DR",        "downmix right"         },
57     [31] = { "WL",        "wide left"             },
58     [32] = { "WR",        "wide right"            },
59     [33] = { "SDL",       "surround direct left"  },
60     [34] = { "SDR",       "surround direct right" },
61 };
62
63 static const char *get_channel_name(int channel_id)
64 {
65     if (channel_id < 0 || channel_id >= FF_ARRAY_ELEMS(channel_names))
66         return NULL;
67     return channel_names[channel_id].name;
68 }
69
70 static const struct {
71     const char *name;
72     int         nb_channels;
73     uint64_t     layout;
74 } channel_layout_map[] = {
75     { "mono",        1,  AV_CH_LAYOUT_MONO },
76     { "stereo",      2,  AV_CH_LAYOUT_STEREO },
77     { "2.1",         3,  AV_CH_LAYOUT_2POINT1 },
78     { "3.0",         3,  AV_CH_LAYOUT_SURROUND },
79     { "3.0(back)",   3,  AV_CH_LAYOUT_2_1 },
80     { "4.0",         4,  AV_CH_LAYOUT_4POINT0 },
81     { "quad",        4,  AV_CH_LAYOUT_QUAD },
82     { "quad(side)",  4,  AV_CH_LAYOUT_2_2 },
83     { "3.1",         4,  AV_CH_LAYOUT_3POINT1 },
84     { "5.0",         5,  AV_CH_LAYOUT_5POINT0_BACK },
85     { "5.0(side)",   5,  AV_CH_LAYOUT_5POINT0 },
86     { "4.1",         5,  AV_CH_LAYOUT_4POINT1 },
87     { "5.1",         6,  AV_CH_LAYOUT_5POINT1_BACK },
88     { "5.1(side)",   6,  AV_CH_LAYOUT_5POINT1 },
89     { "6.0",         6,  AV_CH_LAYOUT_6POINT0 },
90     { "6.0(front)",  6,  AV_CH_LAYOUT_6POINT0_FRONT },
91     { "hexagonal",   6,  AV_CH_LAYOUT_HEXAGONAL },
92     { "6.1",         7,  AV_CH_LAYOUT_6POINT1 },
93     { "6.1",         7,  AV_CH_LAYOUT_6POINT1_BACK },
94     { "6.1(front)",  7,  AV_CH_LAYOUT_6POINT1_FRONT },
95     { "7.0",         7,  AV_CH_LAYOUT_7POINT0 },
96     { "7.0(front)",  7,  AV_CH_LAYOUT_7POINT0_FRONT },
97     { "7.1",         8,  AV_CH_LAYOUT_7POINT1 },
98     { "7.1(wide)",   8,  AV_CH_LAYOUT_7POINT1_WIDE },
99     { "octagonal",   8,  AV_CH_LAYOUT_OCTAGONAL },
100     { "downmix",     2,  AV_CH_LAYOUT_STEREO_DOWNMIX, },
101 };
102
103 static uint64_t get_channel_layout_single(const char *name, int name_len)
104 {
105     int i;
106     char *end;
107     int64_t layout;
108
109     for (i = 0; i < FF_ARRAY_ELEMS(channel_layout_map); i++) {
110         if (strlen(channel_layout_map[i].name) == name_len &&
111             !memcmp(channel_layout_map[i].name, name, name_len))
112             return channel_layout_map[i].layout;
113     }
114     for (i = 0; i < FF_ARRAY_ELEMS(channel_names); i++)
115         if (channel_names[i].name &&
116             strlen(channel_names[i].name) == name_len &&
117             !memcmp(channel_names[i].name, name, name_len))
118             return (int64_t)1 << i;
119     i = strtol(name, &end, 10);
120     if (end - name == name_len ||
121         (end + 1 - name == name_len && *end  == 'c'))
122         return av_get_default_channel_layout(i);
123     layout = strtoll(name, &end, 0);
124     if (end - name == name_len)
125         return FFMAX(layout, 0);
126     return 0;
127 }
128
129 uint64_t av_get_channel_layout(const char *name)
130 {
131     const char *n, *e;
132     const char *name_end = name + strlen(name);
133     int64_t layout = 0, layout_single;
134
135     for (n = name; n < name_end; n = e + 1) {
136         for (e = n; e < name_end && *e != '+' && *e != '|'; e++);
137         layout_single = get_channel_layout_single(n, e - n);
138         if (!layout_single)
139             return 0;
140         layout |= layout_single;
141     }
142     return layout;
143 }
144
145 void av_bprint_channel_layout(struct AVBPrint *bp,
146                               int nb_channels, uint64_t channel_layout)
147 {
148     int i;
149
150     if (nb_channels <= 0)
151         nb_channels = av_get_channel_layout_nb_channels(channel_layout);
152
153     for (i = 0; i < FF_ARRAY_ELEMS(channel_layout_map); i++)
154         if (nb_channels    == channel_layout_map[i].nb_channels &&
155             channel_layout == channel_layout_map[i].layout) {
156             av_bprintf(bp, "%s", channel_layout_map[i].name);
157             return;
158         }
159
160     av_bprintf(bp, "%d channels", nb_channels);
161     if (channel_layout) {
162         int i, ch;
163         av_bprintf(bp, " (");
164         for (i = 0, ch = 0; i < 64; i++) {
165             if ((channel_layout & (UINT64_C(1) << i))) {
166                 const char *name = get_channel_name(i);
167                 if (name) {
168                     if (ch > 0)
169                         av_bprintf(bp, "+");
170                     av_bprintf(bp, "%s", name);
171                 }
172                 ch++;
173             }
174         }
175         av_bprintf(bp, ")");
176     }
177 }
178
179 void av_get_channel_layout_string(char *buf, int buf_size,
180                                   int nb_channels, uint64_t channel_layout)
181 {
182     AVBPrint bp;
183
184     av_bprint_init_for_buffer(&bp, buf, buf_size);
185     av_bprint_channel_layout(&bp, nb_channels, channel_layout);
186 }
187
188 int av_get_channel_layout_nb_channels(uint64_t channel_layout)
189 {
190     return av_popcount64(channel_layout);
191 }
192
193 int64_t av_get_default_channel_layout(int nb_channels) {
194     int i;
195     for (i = 0; i < FF_ARRAY_ELEMS(channel_layout_map); i++)
196         if (nb_channels == channel_layout_map[i].nb_channels)
197             return channel_layout_map[i].layout;
198     return 0;
199 }
200
201 int av_get_channel_layout_channel_index(uint64_t channel_layout,
202                                         uint64_t channel)
203 {
204     if (!(channel_layout & channel) ||
205         av_get_channel_layout_nb_channels(channel) != 1)
206         return AVERROR(EINVAL);
207     channel_layout &= channel - 1;
208     return av_get_channel_layout_nb_channels(channel_layout);
209 }
210
211 const char *av_get_channel_name(uint64_t channel)
212 {
213     int i;
214     if (av_get_channel_layout_nb_channels(channel) != 1)
215         return NULL;
216     for (i = 0; i < 64; i++)
217         if ((1ULL<<i) & channel)
218             return get_channel_name(i);
219     return NULL;
220 }
221
222 const char *av_get_channel_description(uint64_t channel)
223 {
224     int i;
225     if (av_get_channel_layout_nb_channels(channel) != 1)
226         return NULL;
227     for (i = 0; i < FF_ARRAY_ELEMS(channel_names); i++)
228         if ((1ULL<<i) & channel)
229             return channel_names[i].description;
230     return NULL;
231 }
232
233 uint64_t av_channel_layout_extract_channel(uint64_t channel_layout, int index)
234 {
235     int i;
236
237     if (av_get_channel_layout_nb_channels(channel_layout) <= index)
238         return 0;
239
240     for (i = 0; i < 64; i++) {
241         if ((1ULL << i) & channel_layout && !index--)
242             return 1ULL << i;
243     }
244     return 0;
245 }
246
247 int av_get_standard_channel_layout(unsigned index, uint64_t *layout,
248                                    const char **name)
249 {
250     if (index >= FF_ARRAY_ELEMS(channel_layout_map))
251         return AVERROR_EOF;
252     if (layout) *layout = channel_layout_map[index].layout;
253     if (name)   *name   = channel_layout_map[index].name;
254     return 0;
255 }