dca: Split code for handling the EXSS extension off into a separate file
[ffmpeg.git] / libavcodec / dca_exss.c
1 /*
2  * DCA ExSS extension
3  *
4  * This file is part of Libav.
5  *
6  * Libav 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  * Libav 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 Libav; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 #include "libavutil/common.h"
22 #include "libavutil/log.h"
23
24 #include "dca.h"
25 #include "dca_exss.h"
26 #include "get_bits.h"
27
28 /* extensions that reside in core substream */
29 #define DCA_CORE_EXTS (DCA_EXT_XCH | DCA_EXT_XXCH | DCA_EXT_X96)
30
31 /* these are unconfirmed but should be mostly correct */
32 enum DCAExSSSpeakerMask {
33     DCA_EXSS_FRONT_CENTER          = 0x0001,
34     DCA_EXSS_FRONT_LEFT_RIGHT      = 0x0002,
35     DCA_EXSS_SIDE_REAR_LEFT_RIGHT  = 0x0004,
36     DCA_EXSS_LFE                   = 0x0008,
37     DCA_EXSS_REAR_CENTER           = 0x0010,
38     DCA_EXSS_FRONT_HIGH_LEFT_RIGHT = 0x0020,
39     DCA_EXSS_REAR_LEFT_RIGHT       = 0x0040,
40     DCA_EXSS_FRONT_HIGH_CENTER     = 0x0080,
41     DCA_EXSS_OVERHEAD              = 0x0100,
42     DCA_EXSS_CENTER_LEFT_RIGHT     = 0x0200,
43     DCA_EXSS_WIDE_LEFT_RIGHT       = 0x0400,
44     DCA_EXSS_SIDE_LEFT_RIGHT       = 0x0800,
45     DCA_EXSS_LFE2                  = 0x1000,
46     DCA_EXSS_SIDE_HIGH_LEFT_RIGHT  = 0x2000,
47     DCA_EXSS_REAR_HIGH_CENTER      = 0x4000,
48     DCA_EXSS_REAR_HIGH_LEFT_RIGHT  = 0x8000,
49 };
50
51 /**
52  * Return the number of channels in an ExSS speaker mask (HD)
53  */
54 static int dca_exss_mask2count(int mask)
55 {
56     /* count bits that mean speaker pairs twice */
57     return av_popcount(mask) +
58            av_popcount(mask & (DCA_EXSS_CENTER_LEFT_RIGHT      |
59                                DCA_EXSS_FRONT_LEFT_RIGHT       |
60                                DCA_EXSS_FRONT_HIGH_LEFT_RIGHT  |
61                                DCA_EXSS_WIDE_LEFT_RIGHT        |
62                                DCA_EXSS_SIDE_LEFT_RIGHT        |
63                                DCA_EXSS_SIDE_HIGH_LEFT_RIGHT   |
64                                DCA_EXSS_SIDE_REAR_LEFT_RIGHT   |
65                                DCA_EXSS_REAR_LEFT_RIGHT        |
66                                DCA_EXSS_REAR_HIGH_LEFT_RIGHT));
67 }
68
69 /**
70  * Skip mixing coefficients of a single mix out configuration (HD)
71  */
72 static void dca_exss_skip_mix_coeffs(GetBitContext *gb, int channels, int out_ch)
73 {
74     int i;
75
76     for (i = 0; i < channels; i++) {
77         int mix_map_mask = get_bits(gb, out_ch);
78         int num_coeffs = av_popcount(mix_map_mask);
79         skip_bits_long(gb, num_coeffs * 6);
80     }
81 }
82
83 /**
84  * Parse extension substream asset header (HD)
85  */
86 static int dca_exss_parse_asset_header(DCAContext *s)
87 {
88     int header_pos = get_bits_count(&s->gb);
89     int header_size;
90     int channels = 0;
91     int embedded_stereo = 0;
92     int embedded_6ch    = 0;
93     int drc_code_present;
94     int extensions_mask = 0;
95     int i, j;
96
97     if (get_bits_left(&s->gb) < 16)
98         return -1;
99
100     /* We will parse just enough to get to the extensions bitmask with which
101      * we can set the profile value. */
102
103     header_size = get_bits(&s->gb, 9) + 1;
104     skip_bits(&s->gb, 3); // asset index
105
106     if (s->static_fields) {
107         if (get_bits1(&s->gb))
108             skip_bits(&s->gb, 4); // asset type descriptor
109         if (get_bits1(&s->gb))
110             skip_bits_long(&s->gb, 24); // language descriptor
111
112         if (get_bits1(&s->gb)) {
113             /* How can one fit 1024 bytes of text here if the maximum value
114              * for the asset header size field above was 512 bytes? */
115             int text_length = get_bits(&s->gb, 10) + 1;
116             if (get_bits_left(&s->gb) < text_length * 8)
117                 return -1;
118             skip_bits_long(&s->gb, text_length * 8); // info text
119         }
120
121         skip_bits(&s->gb, 5); // bit resolution - 1
122         skip_bits(&s->gb, 4); // max sample rate code
123         channels = get_bits(&s->gb, 8) + 1;
124
125         if (get_bits1(&s->gb)) { // 1-to-1 channels to speakers
126             int spkr_remap_sets;
127             int spkr_mask_size = 16;
128             int num_spkrs[7];
129
130             if (channels > 2)
131                 embedded_stereo = get_bits1(&s->gb);
132             if (channels > 6)
133                 embedded_6ch = get_bits1(&s->gb);
134
135             if (get_bits1(&s->gb)) {
136                 spkr_mask_size = (get_bits(&s->gb, 2) + 1) << 2;
137                 skip_bits(&s->gb, spkr_mask_size); // spkr activity mask
138             }
139
140             spkr_remap_sets = get_bits(&s->gb, 3);
141
142             for (i = 0; i < spkr_remap_sets; i++) {
143                 /* std layout mask for each remap set */
144                 num_spkrs[i] = dca_exss_mask2count(get_bits(&s->gb, spkr_mask_size));
145             }
146
147             for (i = 0; i < spkr_remap_sets; i++) {
148                 int num_dec_ch_remaps = get_bits(&s->gb, 5) + 1;
149                 if (get_bits_left(&s->gb) < 0)
150                     return -1;
151
152                 for (j = 0; j < num_spkrs[i]; j++) {
153                     int remap_dec_ch_mask = get_bits_long(&s->gb, num_dec_ch_remaps);
154                     int num_dec_ch = av_popcount(remap_dec_ch_mask);
155                     skip_bits_long(&s->gb, num_dec_ch * 5); // remap codes
156                 }
157             }
158         } else {
159             skip_bits(&s->gb, 3); // representation type
160         }
161     }
162
163     drc_code_present = get_bits1(&s->gb);
164     if (drc_code_present)
165         get_bits(&s->gb, 8); // drc code
166
167     if (get_bits1(&s->gb))
168         skip_bits(&s->gb, 5); // dialog normalization code
169
170     if (drc_code_present && embedded_stereo)
171         get_bits(&s->gb, 8); // drc stereo code
172
173     if (s->mix_metadata && get_bits1(&s->gb)) {
174         skip_bits(&s->gb, 1); // external mix
175         skip_bits(&s->gb, 6); // post mix gain code
176
177         if (get_bits(&s->gb, 2) != 3) // mixer drc code
178             skip_bits(&s->gb, 3); // drc limit
179         else
180             skip_bits(&s->gb, 8); // custom drc code
181
182         if (get_bits1(&s->gb)) // channel specific scaling
183             for (i = 0; i < s->num_mix_configs; i++)
184                 skip_bits_long(&s->gb, s->mix_config_num_ch[i] * 6); // scale codes
185         else
186             skip_bits_long(&s->gb, s->num_mix_configs * 6); // scale codes
187
188         for (i = 0; i < s->num_mix_configs; i++) {
189             if (get_bits_left(&s->gb) < 0)
190                 return -1;
191             dca_exss_skip_mix_coeffs(&s->gb, channels, s->mix_config_num_ch[i]);
192             if (embedded_6ch)
193                 dca_exss_skip_mix_coeffs(&s->gb, 6, s->mix_config_num_ch[i]);
194             if (embedded_stereo)
195                 dca_exss_skip_mix_coeffs(&s->gb, 2, s->mix_config_num_ch[i]);
196         }
197     }
198
199     switch (get_bits(&s->gb, 2)) {
200     case 0:
201         extensions_mask = get_bits(&s->gb, 12);
202         break;
203     case 1:
204         extensions_mask = DCA_EXT_EXSS_XLL;
205         break;
206     case 2:
207         extensions_mask = DCA_EXT_EXSS_LBR;
208         break;
209     case 3:
210         extensions_mask = 0; /* aux coding */
211         break;
212     }
213
214     /* not parsed further, we were only interested in the extensions mask */
215
216     if (get_bits_left(&s->gb) < 0)
217         return -1;
218
219     if (get_bits_count(&s->gb) - header_pos > header_size * 8) {
220         av_log(s->avctx, AV_LOG_WARNING, "Asset header size mismatch.\n");
221         return -1;
222     }
223     skip_bits_long(&s->gb, header_pos + header_size * 8 - get_bits_count(&s->gb));
224
225     if (extensions_mask & DCA_EXT_EXSS_XLL)
226         s->profile = FF_PROFILE_DTS_HD_MA;
227     else if (extensions_mask & (DCA_EXT_EXSS_XBR | DCA_EXT_EXSS_X96 |
228                                 DCA_EXT_EXSS_XXCH))
229         s->profile = FF_PROFILE_DTS_HD_HRA;
230
231     if (!(extensions_mask & DCA_EXT_CORE))
232         av_log(s->avctx, AV_LOG_WARNING, "DTS core detection mismatch.\n");
233     if ((extensions_mask & DCA_CORE_EXTS) != s->core_ext_mask)
234         av_log(s->avctx, AV_LOG_WARNING,
235                "DTS extensions detection mismatch (%d, %d)\n",
236                extensions_mask & DCA_CORE_EXTS, s->core_ext_mask);
237
238     return 0;
239 }
240
241 /**
242  * Parse extension substream header (HD)
243  */
244 void ff_dca_exss_parse_header(DCAContext *s)
245 {
246     int ss_index;
247     int blownup;
248     int num_audiop = 1;
249     int num_assets = 1;
250     int active_ss_mask[8];
251     int i, j;
252
253     if (get_bits_left(&s->gb) < 52)
254         return;
255
256     skip_bits(&s->gb, 8); // user data
257     ss_index = get_bits(&s->gb, 2);
258
259     blownup = get_bits1(&s->gb);
260     skip_bits(&s->gb,  8 + 4 * blownup); // header_size
261     skip_bits(&s->gb, 16 + 4 * blownup); // hd_size
262
263     s->static_fields = get_bits1(&s->gb);
264     if (s->static_fields) {
265         skip_bits(&s->gb, 2); // reference clock code
266         skip_bits(&s->gb, 3); // frame duration code
267
268         if (get_bits1(&s->gb))
269             skip_bits_long(&s->gb, 36); // timestamp
270
271         /* a single stream can contain multiple audio assets that can be
272          * combined to form multiple audio presentations */
273
274         num_audiop = get_bits(&s->gb, 3) + 1;
275         if (num_audiop > 1) {
276             avpriv_request_sample(s->avctx,
277                                   "Multiple DTS-HD audio presentations");
278             /* ignore such streams for now */
279             return;
280         }
281
282         num_assets = get_bits(&s->gb, 3) + 1;
283         if (num_assets > 1) {
284             avpriv_request_sample(s->avctx, "Multiple DTS-HD audio assets");
285             /* ignore such streams for now */
286             return;
287         }
288
289         for (i = 0; i < num_audiop; i++)
290             active_ss_mask[i] = get_bits(&s->gb, ss_index + 1);
291
292         for (i = 0; i < num_audiop; i++)
293             for (j = 0; j <= ss_index; j++)
294                 if (active_ss_mask[i] & (1 << j))
295                     skip_bits(&s->gb, 8); // active asset mask
296
297         s->mix_metadata = get_bits1(&s->gb);
298         if (s->mix_metadata) {
299             int mix_out_mask_size;
300
301             skip_bits(&s->gb, 2); // adjustment level
302             mix_out_mask_size  = (get_bits(&s->gb, 2) + 1) << 2;
303             s->num_mix_configs =  get_bits(&s->gb, 2) + 1;
304
305             for (i = 0; i < s->num_mix_configs; i++) {
306                 int mix_out_mask        = get_bits(&s->gb, mix_out_mask_size);
307                 s->mix_config_num_ch[i] = dca_exss_mask2count(mix_out_mask);
308             }
309         }
310     }
311
312     for (i = 0; i < num_assets; i++)
313         skip_bits_long(&s->gb, 16 + 4 * blownup);  // asset size
314
315     for (i = 0; i < num_assets; i++) {
316         if (dca_exss_parse_asset_header(s))
317             return;
318     }
319
320     /* not parsed further, we were only interested in the extensions mask
321      * from the asset header */
322 }