7d73058e4cf12c3526c1dc8f301b18c19cf25ecc
[ffmpeg.git] / libavcodec / mlp_parser.c
1 /*
2  * MLP parser
3  * Copyright (c) 2007 Ian Caulfield
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 /**
23  * @file
24  * MLP parser
25  */
26
27 #include <stdint.h>
28
29 #include "libavutil/channel_layout.h"
30 #include "libavutil/crc.h"
31 #include "libavutil/internal.h"
32
33 #include "bitstream.h"
34 #include "parser.h"
35 #include "mlp_parser.h"
36 #include "mlp.h"
37
38 static const uint8_t mlp_quants[16] = {
39     16, 20, 24, 0, 0, 0, 0, 0,
40      0,  0,  0, 0, 0, 0, 0, 0,
41 };
42
43 static const uint8_t mlp_channels[32] = {
44     1, 2, 3, 4, 3, 4, 5, 3, 4, 5, 4, 5, 6, 4, 5, 4,
45     5, 6, 5, 5, 6, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
46 };
47
48 static const uint64_t mlp_layout[32] = {
49     AV_CH_LAYOUT_MONO,
50     AV_CH_LAYOUT_STEREO,
51     AV_CH_LAYOUT_2_1,
52     AV_CH_LAYOUT_2_2,
53     AV_CH_LAYOUT_STEREO|AV_CH_LOW_FREQUENCY,
54     AV_CH_LAYOUT_2_1|AV_CH_LOW_FREQUENCY,
55     AV_CH_LAYOUT_2_2|AV_CH_LOW_FREQUENCY,
56     AV_CH_LAYOUT_SURROUND,
57     AV_CH_LAYOUT_4POINT0,
58     AV_CH_LAYOUT_5POINT0,
59     AV_CH_LAYOUT_SURROUND|AV_CH_LOW_FREQUENCY,
60     AV_CH_LAYOUT_4POINT0|AV_CH_LOW_FREQUENCY,
61     AV_CH_LAYOUT_5POINT1,
62     AV_CH_LAYOUT_4POINT0,
63     AV_CH_LAYOUT_5POINT0,
64     AV_CH_LAYOUT_SURROUND|AV_CH_LOW_FREQUENCY,
65     AV_CH_LAYOUT_4POINT0|AV_CH_LOW_FREQUENCY,
66     AV_CH_LAYOUT_5POINT1,
67     AV_CH_LAYOUT_2_2|AV_CH_LOW_FREQUENCY,
68     AV_CH_LAYOUT_5POINT0,
69     AV_CH_LAYOUT_5POINT1,
70     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
71 };
72
73 static const uint8_t thd_chancount[13] = {
74 //  LR    C   LFE  LRs LRvh  LRc LRrs  Cs   Ts  LRsd  LRw  Cvh  LFE2
75      2,   1,   1,   2,   2,   2,   2,   1,   1,   2,   2,   1,   1
76 };
77
78 static const uint64_t thd_layout[13] = {
79     AV_CH_FRONT_LEFT|AV_CH_FRONT_RIGHT,                     // LR
80     AV_CH_FRONT_CENTER,                                     // C
81     AV_CH_LOW_FREQUENCY,                                    // LFE
82     AV_CH_SIDE_LEFT|AV_CH_SIDE_RIGHT,                       // LRs
83     AV_CH_TOP_FRONT_LEFT|AV_CH_TOP_FRONT_RIGHT,             // LRvh
84     AV_CH_FRONT_LEFT_OF_CENTER|AV_CH_FRONT_RIGHT_OF_CENTER, // LRc
85     AV_CH_BACK_LEFT|AV_CH_BACK_RIGHT,                       // LRrs
86     AV_CH_BACK_CENTER,                                      // Cs
87     AV_CH_TOP_CENTER,                                       // Ts
88     AV_CH_SURROUND_DIRECT_LEFT|AV_CH_SURROUND_DIRECT_RIGHT, // LRsd
89     AV_CH_WIDE_LEFT|AV_CH_WIDE_RIGHT,                       // LRw
90     AV_CH_TOP_FRONT_CENTER,                                 // Cvh
91     AV_CH_LOW_FREQUENCY_2,                                  // LFE2
92 };
93
94 static int mlp_samplerate(int in)
95 {
96     if (in == 0xF)
97         return 0;
98
99     return (in & 8 ? 44100 : 48000) << (in & 7) ;
100 }
101
102 static int truehd_channels(int chanmap)
103 {
104     int channels = 0, i;
105
106     for (i = 0; i < 13; i++)
107         channels += thd_chancount[i] * ((chanmap >> i) & 1);
108
109     return channels;
110 }
111
112 static uint64_t truehd_layout(int chanmap)
113 {
114     int i;
115     uint64_t layout = 0;
116
117     for (i = 0; i < 13; i++)
118         layout |= thd_layout[i] * ((chanmap >> i) & 1);
119
120     return layout;
121 }
122
123 int ff_mlp_channel_layout_subset(uint64_t channel_layout, uint64_t mask)
124 {
125     return channel_layout && ((channel_layout & mask) == channel_layout);
126 }
127
128 static int mlp_get_major_sync_size(const uint8_t * buf, int bufsize)
129 {
130     int has_extension, extensions = 0;
131     int size = 28;
132     if (bufsize < 28)
133         return -1;
134
135     if (AV_RB32(buf) == 0xf8726fba) {
136         has_extension = buf[25] & 1;
137         if (has_extension) {
138             extensions = buf[26] >> 4;
139             size += 2 + extensions * 2;
140         }
141     }
142     return size;
143 }
144
145 /** Read a major sync info header - contains high level information about
146  *  the stream - sample rate, channel arrangement etc. Most of this
147  *  information is not actually necessary for decoding, only for playback.
148  *  bc must be a freshly-initialized BitstreamContext with no bits read.
149  */
150
151 int ff_mlp_read_major_sync(void *log, MLPHeaderInfo *mh, BitstreamContext *bc)
152 {
153     int ratebits, channel_arrangement, header_size;
154     uint16_t checksum;
155
156     assert(bitstream_tell(bc) == 0);
157
158     header_size = mlp_get_major_sync_size(bc->buffer, bc->size_in_bits >> 3);
159     if (header_size < 0 || bc->size_in_bits < header_size << 3) {
160         av_log(log, AV_LOG_ERROR, "packet too short, unable to read major sync\n");
161         return -1;
162     }
163
164     checksum = ff_mlp_checksum16(bc->buffer, header_size - 2);
165     if (checksum != AV_RL16(bc->buffer + header_size - 2)) {
166         av_log(log, AV_LOG_ERROR, "major sync info header checksum error\n");
167         return AVERROR_INVALIDDATA;
168     }
169
170     if (bitstream_read(bc, 24) != 0xf8726f) /* Sync words */
171         return AVERROR_INVALIDDATA;
172
173     mh->stream_type = bitstream_read(bc, 8);
174     mh->header_size = header_size;
175
176     if (mh->stream_type == 0xbb) {
177         mh->group1_bits = mlp_quants[bitstream_read(bc, 4)];
178         mh->group2_bits = mlp_quants[bitstream_read(bc, 4)];
179
180         ratebits = bitstream_read(bc, 4);
181         mh->group1_samplerate = mlp_samplerate(ratebits);
182         mh->group2_samplerate = mlp_samplerate(bitstream_read(bc, 4));
183
184         bitstream_skip(bc, 11);
185
186         channel_arrangement    = bitstream_read(bc, 5);
187         mh->channels_mlp       = mlp_channels[channel_arrangement];
188         mh->channel_layout_mlp = mlp_layout[channel_arrangement];
189     } else if (mh->stream_type == 0xba) {
190         mh->group1_bits = 24; // TODO: Is this information actually conveyed anywhere?
191         mh->group2_bits = 0;
192
193         ratebits = bitstream_read(bc, 4);
194         mh->group1_samplerate = mlp_samplerate(ratebits);
195         mh->group2_samplerate = 0;
196
197         bitstream_skip(bc, 4);
198
199         mh->channel_modifier_thd_stream0 = bitstream_read(bc, 2);
200         mh->channel_modifier_thd_stream1 = bitstream_read(bc, 2);
201
202         channel_arrangement            = bitstream_read(bc, 5);
203         mh->channels_thd_stream1       = truehd_channels(channel_arrangement);
204         mh->channel_layout_thd_stream1 = truehd_layout(channel_arrangement);
205
206         mh->channel_modifier_thd_stream2 = bitstream_read(bc, 2);
207
208         channel_arrangement            = bitstream_read(bc, 13);
209         mh->channels_thd_stream2       = truehd_channels(channel_arrangement);
210         mh->channel_layout_thd_stream2 = truehd_layout(channel_arrangement);
211     } else
212         return AVERROR_INVALIDDATA;
213
214     mh->access_unit_size = 40 << (ratebits & 7);
215     mh->access_unit_size_pow2 = 64 << (ratebits & 7);
216
217     bitstream_skip(bc, 48);
218
219     mh->is_vbr = bitstream_read_bit(bc);
220
221     mh->peak_bitrate = (bitstream_read(bc, 15) * mh->group1_samplerate + 8) >> 4;
222
223     mh->num_substreams = bitstream_read(bc, 4);
224
225     bitstream_skip(bc, 4 + (header_size - 17) * 8);
226
227     return 0;
228 }
229
230 typedef struct MLPParseContext
231 {
232     ParseContext pc;
233
234     int bytes_left;
235
236     int in_sync;
237
238     int num_substreams;
239 } MLPParseContext;
240
241 static av_cold int mlp_init(AVCodecParserContext *s)
242 {
243     ff_mlp_init_crc();
244     return 0;
245 }
246
247 static int mlp_parse(AVCodecParserContext *s,
248                      AVCodecContext *avctx,
249                      const uint8_t **poutbuf, int *poutbuf_size,
250                      const uint8_t *buf, int buf_size)
251 {
252     MLPParseContext *mp = s->priv_data;
253     int sync_present;
254     uint8_t parity_bits;
255     int next;
256     int i, p = 0;
257
258     *poutbuf_size = 0;
259     if (buf_size == 0)
260         return 0;
261
262     if (!mp->in_sync) {
263         // Not in sync - find a major sync header
264
265         for (i = 0; i < buf_size; i++) {
266             mp->pc.state = (mp->pc.state << 8) | buf[i];
267             if ((mp->pc.state & 0xfffffffe) == 0xf8726fba &&
268                 // ignore if we do not have the data for the start of header
269                 mp->pc.index + i >= 7) {
270                 mp->in_sync = 1;
271                 mp->bytes_left = 0;
272                 break;
273             }
274         }
275
276         if (!mp->in_sync) {
277             ff_combine_frame(&mp->pc, END_NOT_FOUND, &buf, &buf_size);
278             return buf_size;
279         }
280
281         ff_combine_frame(&mp->pc, i - 7, &buf, &buf_size);
282
283         return i - 7;
284     }
285
286     if (mp->bytes_left == 0) {
287         // Find length of this packet
288
289         /* Copy overread bytes from last frame into buffer. */
290         for(; mp->pc.overread>0; mp->pc.overread--) {
291             mp->pc.buffer[mp->pc.index++]= mp->pc.buffer[mp->pc.overread_index++];
292         }
293
294         if (mp->pc.index + buf_size < 2) {
295             ff_combine_frame(&mp->pc, END_NOT_FOUND, &buf, &buf_size);
296             return buf_size;
297         }
298
299         mp->bytes_left = ((mp->pc.index > 0 ? mp->pc.buffer[0] : buf[0]) << 8)
300                        |  (mp->pc.index > 1 ? mp->pc.buffer[1] : buf[1-mp->pc.index]);
301         mp->bytes_left = (mp->bytes_left & 0xfff) * 2;
302         mp->bytes_left -= mp->pc.index;
303     }
304
305     next = (mp->bytes_left > buf_size) ? END_NOT_FOUND : mp->bytes_left;
306
307     if (ff_combine_frame(&mp->pc, next, &buf, &buf_size) < 0) {
308         mp->bytes_left -= buf_size;
309         return buf_size;
310     }
311
312     mp->bytes_left = 0;
313
314     sync_present = (AV_RB32(buf + 4) & 0xfffffffe) == 0xf8726fba;
315
316     if (!sync_present) {
317         /* The first nibble of a frame is a parity check of the 4-byte
318          * access unit header and all the 2- or 4-byte substream headers. */
319         // Only check when this isn't a sync frame - syncs have a checksum.
320
321         parity_bits = 0;
322         for (i = -1; i < mp->num_substreams; i++) {
323             parity_bits ^= buf[p++];
324             parity_bits ^= buf[p++];
325
326             if (i < 0 || buf[p-2] & 0x80) {
327                 parity_bits ^= buf[p++];
328                 parity_bits ^= buf[p++];
329             }
330         }
331
332         if ((((parity_bits >> 4) ^ parity_bits) & 0xF) != 0xF) {
333             av_log(avctx, AV_LOG_INFO, "mlpparse: Parity check failed.\n");
334             goto lost_sync;
335         }
336     } else {
337         BitstreamContext bc;
338         MLPHeaderInfo mh;
339         int stereo_requested = ff_mlp_channel_layout_subset(avctx->request_channel_layout,
340                                                             AV_CH_LAYOUT_STEREO);
341
342         bitstream_init8(&bc, buf + 4, buf_size - 4);
343         if (ff_mlp_read_major_sync(avctx, &mh, &bc) < 0)
344             goto lost_sync;
345
346         avctx->bits_per_raw_sample = mh.group1_bits;
347         if (avctx->bits_per_raw_sample > 16)
348             avctx->sample_fmt = AV_SAMPLE_FMT_S32;
349         else
350             avctx->sample_fmt = AV_SAMPLE_FMT_S16;
351         avctx->sample_rate = mh.group1_samplerate;
352         s->duration = mh.access_unit_size;
353
354         if (mh.stream_type == 0xbb) {
355             /* MLP stream */
356             if (stereo_requested && mh.num_substreams > 1) {
357                 avctx->channels       = 2;
358                 avctx->channel_layout = AV_CH_LAYOUT_STEREO;
359             } else {
360                 avctx->channels       = mh.channels_mlp;
361                 avctx->channel_layout = mh.channel_layout_mlp;
362             }
363         } else { /* mh.stream_type == 0xba */
364             /* TrueHD stream */
365             if (stereo_requested && mh.num_substreams > 1) {
366                 avctx->channels       = 2;
367                 avctx->channel_layout = AV_CH_LAYOUT_STEREO;
368             } else if (!mh.channels_thd_stream2 ||
369                        ff_mlp_channel_layout_subset(avctx->request_channel_layout,
370                                                     mh.channel_layout_thd_stream1)) {
371                 avctx->channels       = mh.channels_thd_stream1;
372                 avctx->channel_layout = mh.channel_layout_thd_stream1;
373             } else {
374                 avctx->channels       = mh.channels_thd_stream2;
375                 avctx->channel_layout = mh.channel_layout_thd_stream2;
376             }
377         }
378
379         if (!mh.is_vbr) /* Stream is CBR */
380             avctx->bit_rate = mh.peak_bitrate;
381
382         mp->num_substreams = mh.num_substreams;
383     }
384
385     *poutbuf = buf;
386     *poutbuf_size = buf_size;
387
388     return next;
389
390 lost_sync:
391     mp->in_sync = 0;
392     return 1;
393 }
394
395 AVCodecParser ff_mlp_parser = {
396     .codec_ids      = { AV_CODEC_ID_MLP, AV_CODEC_ID_TRUEHD },
397     .priv_data_size = sizeof(MLPParseContext),
398     .parser_init    = mlp_init,
399     .parser_parse   = mlp_parse,
400     .parser_close   = ff_parse_close,
401 };