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