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