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