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