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