shorten: Use a checked bytestream reader for the wave header
[ffmpeg.git] / libavcodec / shorten.c
1 /*
2  * Shorten decoder
3  * Copyright (c) 2005 Jeff Muizelaar
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  * Shorten decoder
25  * @author Jeff Muizelaar
26  *
27  */
28
29 #include <limits.h>
30 #include "avcodec.h"
31 #include "bytestream.h"
32 #include "get_bits.h"
33 #include "golomb.h"
34 #include "internal.h"
35
36 #define MAX_CHANNELS 8
37 #define MAX_BLOCKSIZE 65535
38
39 #define OUT_BUFFER_SIZE 16384
40
41 #define ULONGSIZE 2
42
43 #define WAVE_FORMAT_PCM 0x0001
44
45 #define DEFAULT_BLOCK_SIZE 256
46
47 #define TYPESIZE 4
48 #define CHANSIZE 0
49 #define LPCQSIZE 2
50 #define ENERGYSIZE 3
51 #define BITSHIFTSIZE 2
52
53 #define TYPE_S16HL 3
54 #define TYPE_S16LH 5
55
56 #define NWRAP 3
57 #define NSKIPSIZE 1
58
59 #define LPCQUANT 5
60 #define V2LPCQOFFSET (1 << LPCQUANT)
61
62 #define FNSIZE 2
63 #define FN_DIFF0        0
64 #define FN_DIFF1        1
65 #define FN_DIFF2        2
66 #define FN_DIFF3        3
67 #define FN_QUIT         4
68 #define FN_BLOCKSIZE    5
69 #define FN_BITSHIFT     6
70 #define FN_QLPC         7
71 #define FN_ZERO         8
72 #define FN_VERBATIM     9
73
74 /** indicates if the FN_* command is audio or non-audio */
75 static const uint8_t is_audio_command[10] = { 1, 1, 1, 1, 0, 0, 0, 1, 1, 0 };
76
77 #define VERBATIM_CKSIZE_SIZE 5
78 #define VERBATIM_BYTE_SIZE 8
79 #define CANONICAL_HEADER_SIZE 44
80
81 typedef struct ShortenContext {
82     AVCodecContext *avctx;
83     GetBitContext gb;
84
85     int min_framesize, max_framesize;
86     unsigned channels;
87
88     int32_t *decoded[MAX_CHANNELS];
89     int32_t *decoded_base[MAX_CHANNELS];
90     int32_t *offset[MAX_CHANNELS];
91     int *coeffs;
92     uint8_t *bitstream;
93     int bitstream_size;
94     int bitstream_index;
95     unsigned int allocated_bitstream_size;
96     int header_size;
97     uint8_t header[OUT_BUFFER_SIZE];
98     int version;
99     int cur_chan;
100     int bitshift;
101     int nmean;
102     int internal_ftype;
103     int nwrap;
104     int blocksize;
105     int bitindex;
106     int32_t lpcqoffset;
107     int got_header;
108     int got_quit_command;
109 } ShortenContext;
110
111 static av_cold int shorten_decode_init(AVCodecContext *avctx)
112 {
113     ShortenContext *s = avctx->priv_data;
114     s->avctx          = avctx;
115     avctx->sample_fmt = AV_SAMPLE_FMT_S16P;
116
117     return 0;
118 }
119
120 static int allocate_buffers(ShortenContext *s)
121 {
122     int i, chan;
123     int *coeffs;
124     void *tmp_ptr;
125
126     for (chan = 0; chan < s->channels; chan++) {
127         if (FFMAX(1, s->nmean) >= UINT_MAX / sizeof(int32_t)) {
128             av_log(s->avctx, AV_LOG_ERROR, "nmean too large\n");
129             return AVERROR_INVALIDDATA;
130         }
131         if (s->blocksize + s->nwrap >= UINT_MAX / sizeof(int32_t) ||
132             s->blocksize + s->nwrap <= (unsigned)s->nwrap) {
133             av_log(s->avctx, AV_LOG_ERROR,
134                    "s->blocksize + s->nwrap too large\n");
135             return AVERROR_INVALIDDATA;
136         }
137
138         tmp_ptr =
139             av_realloc(s->offset[chan], sizeof(int32_t) * FFMAX(1, s->nmean));
140         if (!tmp_ptr)
141             return AVERROR(ENOMEM);
142         s->offset[chan] = tmp_ptr;
143
144         tmp_ptr = av_realloc(s->decoded_base[chan], (s->blocksize + s->nwrap) *
145                              sizeof(s->decoded_base[0][0]));
146         if (!tmp_ptr)
147             return AVERROR(ENOMEM);
148         s->decoded_base[chan] = tmp_ptr;
149         for (i = 0; i < s->nwrap; i++)
150             s->decoded_base[chan][i] = 0;
151         s->decoded[chan] = s->decoded_base[chan] + s->nwrap;
152     }
153
154     coeffs = av_realloc(s->coeffs, s->nwrap * sizeof(*s->coeffs));
155     if (!coeffs)
156         return AVERROR(ENOMEM);
157     s->coeffs = coeffs;
158
159     return 0;
160 }
161
162 static inline unsigned int get_uint(ShortenContext *s, int k)
163 {
164     if (s->version != 0)
165         k = get_ur_golomb_shorten(&s->gb, ULONGSIZE);
166     return get_ur_golomb_shorten(&s->gb, k);
167 }
168
169 static void fix_bitshift(ShortenContext *s, int32_t *buffer)
170 {
171     int i;
172
173     if (s->bitshift != 0)
174         for (i = 0; i < s->blocksize; i++)
175             buffer[i] <<= s->bitshift;
176 }
177
178 static int init_offset(ShortenContext *s)
179 {
180     int32_t mean = 0;
181     int chan, i;
182     int nblock = FFMAX(1, s->nmean);
183     /* initialise offset */
184     switch (s->internal_ftype) {
185     case TYPE_S16HL:
186     case TYPE_S16LH:
187         mean = 0;
188         break;
189     default:
190         av_log(s->avctx, AV_LOG_ERROR, "unknown audio type");
191         return AVERROR_INVALIDDATA;
192     }
193
194     for (chan = 0; chan < s->channels; chan++)
195         for (i = 0; i < nblock; i++)
196             s->offset[chan][i] = mean;
197     return 0;
198 }
199
200 static int decode_wave_header(AVCodecContext *avctx, const uint8_t *header,
201                               int header_size)
202 {
203     int len;
204     short wave_format;
205     GetByteContext gb;
206
207     bytestream2_init(&gb, header, header_size);
208
209     if (bytestream2_get_le32(&gb) != MKTAG('R', 'I', 'F', 'F')) {
210         av_log(avctx, AV_LOG_ERROR, "missing RIFF tag\n");
211         return AVERROR_INVALIDDATA;
212     }
213
214     bytestream2_skip(&gb, 4); /* chunk size */
215
216     if (bytestream2_get_le32(&gb) != MKTAG('W', 'A', 'V', 'E')) {
217         av_log(avctx, AV_LOG_ERROR, "missing WAVE tag\n");
218         return AVERROR_INVALIDDATA;
219     }
220
221     while (bytestream2_get_le32(&gb) != MKTAG('f', 'm', 't', ' ')) {
222         len = bytestream2_get_le32(&gb);
223         bytestream2_skip(&gb, len);
224     }
225     len = bytestream2_get_le32(&gb);
226
227     if (len < 16) {
228         av_log(avctx, AV_LOG_ERROR, "fmt chunk was too short\n");
229         return AVERROR_INVALIDDATA;
230     }
231
232     wave_format = bytestream2_get_le16(&gb);
233
234     switch (wave_format) {
235     case WAVE_FORMAT_PCM:
236         break;
237     default:
238         av_log(avctx, AV_LOG_ERROR, "unsupported wave format\n");
239         return AVERROR(ENOSYS);
240     }
241
242     bytestream2_skip(&gb, 2); // skip channels    (already got from shorten header)
243     avctx->sample_rate = bytestream2_get_le32(&gb);
244     bytestream2_skip(&gb, 4); // skip bit rate    (represents original uncompressed bit rate)
245     bytestream2_skip(&gb, 2); // skip block align (not needed)
246     avctx->bits_per_coded_sample = bytestream2_get_le16(&gb);
247
248     if (avctx->bits_per_coded_sample != 16) {
249         av_log(avctx, AV_LOG_ERROR, "unsupported number of bits per sample\n");
250         return AVERROR(ENOSYS);
251     }
252
253     len -= 16;
254     if (len > 0)
255         av_log(avctx, AV_LOG_INFO, "%d header bytes unparsed\n", len);
256
257     return 0;
258 }
259
260 static void output_buffer(int16_t **samples, int nchan, int blocksize,
261                           int32_t **buffer)
262 {
263     int i, ch;
264     for (ch = 0; ch < nchan; ch++) {
265         int32_t *in  = buffer[ch];
266         int16_t *out = samples[ch];
267         for (i = 0; i < blocksize; i++)
268             out[i] = av_clip_int16(in[i]);
269     }
270 }
271
272 static const int fixed_coeffs[3][3] = {
273     { 1,  0,  0 },
274     { 2, -1,  0 },
275     { 3, -3,  1 }
276 };
277
278 static int decode_subframe_lpc(ShortenContext *s, int command, int channel,
279                                int residual_size, int32_t coffset)
280 {
281     int pred_order, sum, qshift, init_sum, i, j;
282     const int *coeffs;
283
284     if (command == FN_QLPC) {
285         /* read/validate prediction order */
286         pred_order = get_ur_golomb_shorten(&s->gb, LPCQSIZE);
287         if (pred_order > s->nwrap) {
288             av_log(s->avctx, AV_LOG_ERROR, "invalid pred_order %d\n",
289                    pred_order);
290             return AVERROR(EINVAL);
291         }
292         /* read LPC coefficients */
293         for (i = 0; i < pred_order; i++)
294             s->coeffs[i] = get_sr_golomb_shorten(&s->gb, LPCQUANT);
295         coeffs = s->coeffs;
296
297         qshift = LPCQUANT;
298     } else {
299         /* fixed LPC coeffs */
300         pred_order = command;
301         coeffs     = fixed_coeffs[pred_order - 1];
302         qshift     = 0;
303     }
304
305     /* subtract offset from previous samples to use in prediction */
306     if (command == FN_QLPC && coffset)
307         for (i = -pred_order; i < 0; i++)
308             s->decoded[channel][i] -= coffset;
309
310     /* decode residual and do LPC prediction */
311     init_sum = pred_order ? (command == FN_QLPC ? s->lpcqoffset : 0) : coffset;
312     for (i = 0; i < s->blocksize; i++) {
313         sum = init_sum;
314         for (j = 0; j < pred_order; j++)
315             sum += coeffs[j] * s->decoded[channel][i - j - 1];
316         s->decoded[channel][i] = get_sr_golomb_shorten(&s->gb, residual_size) +
317                                  (sum >> qshift);
318     }
319
320     /* add offset to current samples */
321     if (command == FN_QLPC && coffset)
322         for (i = 0; i < s->blocksize; i++)
323             s->decoded[channel][i] += coffset;
324
325     return 0;
326 }
327
328 static int read_header(ShortenContext *s)
329 {
330     int i, ret;
331     int maxnlpc = 0;
332     /* shorten signature */
333     if (get_bits_long(&s->gb, 32) != AV_RB32("ajkg")) {
334         av_log(s->avctx, AV_LOG_ERROR, "missing shorten magic 'ajkg'\n");
335         return AVERROR_INVALIDDATA;
336     }
337
338     s->lpcqoffset     = 0;
339     s->blocksize      = DEFAULT_BLOCK_SIZE;
340     s->nmean          = -1;
341     s->version        = get_bits(&s->gb, 8);
342     s->internal_ftype = get_uint(s, TYPESIZE);
343
344     s->channels = get_uint(s, CHANSIZE);
345     if (!s->channels) {
346         av_log(s->avctx, AV_LOG_ERROR, "No channels reported\n");
347         return AVERROR_INVALIDDATA;
348     }
349     if (s->channels > MAX_CHANNELS) {
350         av_log(s->avctx, AV_LOG_ERROR, "too many channels: %d\n", s->channels);
351         s->channels = 0;
352         return AVERROR_INVALIDDATA;
353     }
354     s->avctx->channels = s->channels;
355
356     /* get blocksize if version > 0 */
357     if (s->version > 0) {
358         int skip_bytes;
359         unsigned blocksize;
360
361         blocksize = get_uint(s, av_log2(DEFAULT_BLOCK_SIZE));
362         if (!blocksize || blocksize > MAX_BLOCKSIZE) {
363             av_log(s->avctx, AV_LOG_ERROR,
364                    "invalid or unsupported block size: %d\n",
365                    blocksize);
366             return AVERROR(EINVAL);
367         }
368         s->blocksize = blocksize;
369
370         maxnlpc  = get_uint(s, LPCQSIZE);
371         s->nmean = get_uint(s, 0);
372
373         skip_bytes = get_uint(s, NSKIPSIZE);
374         for (i = 0; i < skip_bytes; i++)
375             skip_bits(&s->gb, 8);
376     }
377     s->nwrap = FFMAX(NWRAP, maxnlpc);
378
379     if ((ret = allocate_buffers(s)) < 0)
380         return ret;
381
382     if ((ret = init_offset(s)) < 0)
383         return ret;
384
385     if (s->version > 1)
386         s->lpcqoffset = V2LPCQOFFSET;
387
388     if (get_ur_golomb_shorten(&s->gb, FNSIZE) != FN_VERBATIM) {
389         av_log(s->avctx, AV_LOG_ERROR,
390                "missing verbatim section at beginning of stream\n");
391         return AVERROR_INVALIDDATA;
392     }
393
394     s->header_size = get_ur_golomb_shorten(&s->gb, VERBATIM_CKSIZE_SIZE);
395     if (s->header_size >= OUT_BUFFER_SIZE ||
396         s->header_size < CANONICAL_HEADER_SIZE) {
397         av_log(s->avctx, AV_LOG_ERROR, "header is wrong size: %d\n",
398                s->header_size);
399         return AVERROR_INVALIDDATA;
400     }
401
402     for (i = 0; i < s->header_size; i++)
403         s->header[i] = (char)get_ur_golomb_shorten(&s->gb, VERBATIM_BYTE_SIZE);
404
405     if ((ret = decode_wave_header(s->avctx, s->header, s->header_size)) < 0)
406         return ret;
407
408     s->cur_chan = 0;
409     s->bitshift = 0;
410
411     s->got_header = 1;
412
413     return 0;
414 }
415
416 static int shorten_decode_frame(AVCodecContext *avctx, void *data,
417                                 int *got_frame_ptr, AVPacket *avpkt)
418 {
419     AVFrame *frame     = data;
420     const uint8_t *buf = avpkt->data;
421     int buf_size       = avpkt->size;
422     ShortenContext *s  = avctx->priv_data;
423     int i, input_buf_size = 0;
424     int ret;
425
426     /* allocate internal bitstream buffer */
427     if (s->max_framesize == 0) {
428         void *tmp_ptr;
429         s->max_framesize = 1024; // should hopefully be enough for the first header
430         tmp_ptr = av_fast_realloc(s->bitstream, &s->allocated_bitstream_size,
431                                   s->max_framesize);
432         if (!tmp_ptr) {
433             av_log(avctx, AV_LOG_ERROR, "error allocating bitstream buffer\n");
434             return AVERROR(ENOMEM);
435         }
436         s->bitstream = tmp_ptr;
437     }
438
439     /* append current packet data to bitstream buffer */
440     if (1 && s->max_framesize) { //FIXME truncated
441         buf_size       = FFMIN(buf_size, s->max_framesize - s->bitstream_size);
442         input_buf_size = buf_size;
443
444         if (s->bitstream_index + s->bitstream_size + buf_size >
445             s->allocated_bitstream_size) {
446             memmove(s->bitstream, &s->bitstream[s->bitstream_index],
447                     s->bitstream_size);
448             s->bitstream_index = 0;
449         }
450         if (buf)
451             memcpy(&s->bitstream[s->bitstream_index + s->bitstream_size], buf,
452                    buf_size);
453         buf               = &s->bitstream[s->bitstream_index];
454         buf_size         += s->bitstream_size;
455         s->bitstream_size = buf_size;
456
457         /* do not decode until buffer has at least max_framesize bytes or
458          * the end of the file has been reached */
459         if (buf_size < s->max_framesize && avpkt->data) {
460             *got_frame_ptr = 0;
461             return input_buf_size;
462         }
463     }
464     /* init and position bitstream reader */
465     init_get_bits(&s->gb, buf, buf_size * 8);
466     skip_bits(&s->gb, s->bitindex);
467
468     /* process header or next subblock */
469     if (!s->got_header) {
470         if ((ret = read_header(s)) < 0)
471             return ret;
472         *got_frame_ptr = 0;
473         goto finish_frame;
474     }
475
476     /* if quit command was read previously, don't decode anything */
477     if (s->got_quit_command) {
478         *got_frame_ptr = 0;
479         return avpkt->size;
480     }
481
482     s->cur_chan = 0;
483     while (s->cur_chan < s->channels) {
484         unsigned cmd;
485         int len;
486
487         if (get_bits_left(&s->gb) < 3 + FNSIZE) {
488             *got_frame_ptr = 0;
489             break;
490         }
491
492         cmd = get_ur_golomb_shorten(&s->gb, FNSIZE);
493
494         if (cmd > FN_VERBATIM) {
495             av_log(avctx, AV_LOG_ERROR, "unknown shorten function %d\n", cmd);
496             *got_frame_ptr = 0;
497             break;
498         }
499
500         if (!is_audio_command[cmd]) {
501             /* process non-audio command */
502             switch (cmd) {
503             case FN_VERBATIM:
504                 len = get_ur_golomb_shorten(&s->gb, VERBATIM_CKSIZE_SIZE);
505                 while (len--)
506                     get_ur_golomb_shorten(&s->gb, VERBATIM_BYTE_SIZE);
507                 break;
508             case FN_BITSHIFT:
509                 s->bitshift = get_ur_golomb_shorten(&s->gb, BITSHIFTSIZE);
510                 break;
511             case FN_BLOCKSIZE: {
512                 unsigned blocksize = get_uint(s, av_log2(s->blocksize));
513                 if (blocksize > s->blocksize) {
514                     av_log(avctx, AV_LOG_ERROR,
515                            "Increasing block size is not supported\n");
516                     return AVERROR_PATCHWELCOME;
517                 }
518                 if (!blocksize || blocksize > MAX_BLOCKSIZE) {
519                     av_log(avctx, AV_LOG_ERROR, "invalid or unsupported "
520                                                 "block size: %d\n", blocksize);
521                     return AVERROR(EINVAL);
522                 }
523                 s->blocksize = blocksize;
524                 break;
525             }
526             case FN_QUIT:
527                 s->got_quit_command = 1;
528                 break;
529             }
530             if (cmd == FN_BLOCKSIZE || cmd == FN_QUIT) {
531                 *got_frame_ptr = 0;
532                 break;
533             }
534         } else {
535             /* process audio command */
536             int residual_size = 0;
537             int channel = s->cur_chan;
538             int32_t coffset;
539
540             /* get Rice code for residual decoding */
541             if (cmd != FN_ZERO) {
542                 residual_size = get_ur_golomb_shorten(&s->gb, ENERGYSIZE);
543                 /* This is a hack as version 0 differed in the definition
544                  * of get_sr_golomb_shorten(). */
545                 if (s->version == 0)
546                     residual_size--;
547             }
548
549             /* calculate sample offset using means from previous blocks */
550             if (s->nmean == 0)
551                 coffset = s->offset[channel][0];
552             else {
553                 int32_t sum = (s->version < 2) ? 0 : s->nmean / 2;
554                 for (i = 0; i < s->nmean; i++)
555                     sum += s->offset[channel][i];
556                 coffset = sum / s->nmean;
557                 if (s->version >= 2)
558                     coffset >>= FFMIN(1, s->bitshift);
559             }
560
561             /* decode samples for this channel */
562             if (cmd == FN_ZERO) {
563                 for (i = 0; i < s->blocksize; i++)
564                     s->decoded[channel][i] = 0;
565             } else {
566                 if ((ret = decode_subframe_lpc(s, cmd, channel,
567                                                residual_size, coffset)) < 0)
568                     return ret;
569             }
570
571             /* update means with info from the current block */
572             if (s->nmean > 0) {
573                 int32_t sum = (s->version < 2) ? 0 : s->blocksize / 2;
574                 for (i = 0; i < s->blocksize; i++)
575                     sum += s->decoded[channel][i];
576
577                 for (i = 1; i < s->nmean; i++)
578                     s->offset[channel][i - 1] = s->offset[channel][i];
579
580                 if (s->version < 2)
581                     s->offset[channel][s->nmean - 1] = sum / s->blocksize;
582                 else
583                     s->offset[channel][s->nmean - 1] = (sum / s->blocksize) << s->bitshift;
584             }
585
586             /* copy wrap samples for use with next block */
587             for (i = -s->nwrap; i < 0; i++)
588                 s->decoded[channel][i] = s->decoded[channel][i + s->blocksize];
589
590             /* shift samples to add in unused zero bits which were removed
591              * during encoding */
592             fix_bitshift(s, s->decoded[channel]);
593
594             /* if this is the last channel in the block, output the samples */
595             s->cur_chan++;
596             if (s->cur_chan == s->channels) {
597                 /* get output buffer */
598                 frame->nb_samples = s->blocksize;
599                 if ((ret = ff_get_buffer(avctx, frame, 0)) < 0) {
600                     av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
601                     return ret;
602                 }
603                 /* interleave output */
604                 output_buffer((int16_t **)frame->extended_data, s->channels,
605                               s->blocksize, s->decoded);
606
607                 *got_frame_ptr = 1;
608             }
609         }
610     }
611     if (s->cur_chan < s->channels)
612         *got_frame_ptr = 0;
613
614 finish_frame:
615     s->bitindex = get_bits_count(&s->gb) - 8 * (get_bits_count(&s->gb) / 8);
616     i           = get_bits_count(&s->gb) / 8;
617     if (i > buf_size) {
618         av_log(s->avctx, AV_LOG_ERROR, "overread: %d\n", i - buf_size);
619         s->bitstream_size  = 0;
620         s->bitstream_index = 0;
621         return AVERROR_INVALIDDATA;
622     }
623     if (s->bitstream_size) {
624         s->bitstream_index += i;
625         s->bitstream_size  -= i;
626         return input_buf_size;
627     } else
628         return i;
629 }
630
631 static av_cold int shorten_decode_close(AVCodecContext *avctx)
632 {
633     ShortenContext *s = avctx->priv_data;
634     int i;
635
636     for (i = 0; i < s->channels; i++) {
637         s->decoded[i] = NULL;
638         av_freep(&s->decoded_base[i]);
639         av_freep(&s->offset[i]);
640     }
641     av_freep(&s->bitstream);
642     av_freep(&s->coeffs);
643
644     return 0;
645 }
646
647 AVCodec ff_shorten_decoder = {
648     .name           = "shorten",
649     .type           = AVMEDIA_TYPE_AUDIO,
650     .id             = AV_CODEC_ID_SHORTEN,
651     .priv_data_size = sizeof(ShortenContext),
652     .init           = shorten_decode_init,
653     .close          = shorten_decode_close,
654     .decode         = shorten_decode_frame,
655     .capabilities   = CODEC_CAP_DELAY | CODEC_CAP_DR1,
656     .long_name      = NULL_IF_CONFIG_SMALL("Shorten"),
657     .sample_fmts    = (const enum AVSampleFormat[]) { AV_SAMPLE_FMT_S16P,
658                                                       AV_SAMPLE_FMT_NONE },
659 };