52bf2b247137d30a7e24da95ea1b1db5eb002d86
[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 "get_bits.h"
32 #include "golomb.h"
33
34 #define MAX_CHANNELS 8
35 #define MAX_BLOCKSIZE 65535
36
37 #define OUT_BUFFER_SIZE 16384
38
39 #define ULONGSIZE 2
40
41 #define WAVE_FORMAT_PCM 0x0001
42
43 #define DEFAULT_BLOCK_SIZE 256
44
45 #define TYPESIZE 4
46 #define CHANSIZE 0
47 #define LPCQSIZE 2
48 #define ENERGYSIZE 3
49 #define BITSHIFTSIZE 2
50
51 #define TYPE_S16HL 3
52 #define TYPE_S16LH 5
53
54 #define NWRAP 3
55 #define NSKIPSIZE 1
56
57 #define LPCQUANT 5
58 #define V2LPCQOFFSET (1 << LPCQUANT)
59
60 #define FNSIZE 2
61 #define FN_DIFF0        0
62 #define FN_DIFF1        1
63 #define FN_DIFF2        2
64 #define FN_DIFF3        3
65 #define FN_QUIT         4
66 #define FN_BLOCKSIZE    5
67 #define FN_BITSHIFT     6
68 #define FN_QLPC         7
69 #define FN_ZERO         8
70 #define FN_VERBATIM     9
71
72 /** indicates if the FN_* command is audio or non-audio */
73 static const uint8_t is_audio_command[10] = { 1, 1, 1, 1, 0, 0, 0, 1, 1, 0 };
74
75 #define VERBATIM_CKSIZE_SIZE 5
76 #define VERBATIM_BYTE_SIZE 8
77 #define CANONICAL_HEADER_SIZE 44
78
79 typedef struct ShortenContext {
80     AVCodecContext *avctx;
81     GetBitContext gb;
82
83     int min_framesize, max_framesize;
84     int channels;
85
86     int32_t *decoded[MAX_CHANNELS];
87     int32_t *offset[MAX_CHANNELS];
88     int *coeffs;
89     uint8_t *bitstream;
90     int bitstream_size;
91     int bitstream_index;
92     unsigned int allocated_bitstream_size;
93     int header_size;
94     uint8_t header[OUT_BUFFER_SIZE];
95     int version;
96     int cur_chan;
97     int bitshift;
98     int nmean;
99     int internal_ftype;
100     int nwrap;
101     int blocksize;
102     int bitindex;
103     int32_t lpcqoffset;
104 } ShortenContext;
105
106 static av_cold int shorten_decode_init(AVCodecContext * avctx)
107 {
108     ShortenContext *s = avctx->priv_data;
109     s->avctx = avctx;
110     avctx->sample_fmt = AV_SAMPLE_FMT_S16;
111
112     return 0;
113 }
114
115 static int allocate_buffers(ShortenContext *s)
116 {
117     int i, chan;
118     int *coeffs;
119
120     for (chan=0; chan<s->channels; chan++) {
121         if(FFMAX(1, s->nmean) >= UINT_MAX/sizeof(int32_t)){
122             av_log(s->avctx, AV_LOG_ERROR, "nmean too large\n");
123             return -1;
124         }
125         if(s->blocksize + s->nwrap >= UINT_MAX/sizeof(int32_t) || s->blocksize + s->nwrap <= (unsigned)s->nwrap){
126             av_log(s->avctx, AV_LOG_ERROR, "s->blocksize + s->nwrap too large\n");
127             return -1;
128         }
129
130         s->offset[chan] = av_realloc(s->offset[chan], sizeof(int32_t)*FFMAX(1, s->nmean));
131
132         s->decoded[chan] = av_realloc(s->decoded[chan], sizeof(int32_t)*(s->blocksize + s->nwrap));
133         for (i=0; i<s->nwrap; i++)
134             s->decoded[chan][i] = 0;
135         s->decoded[chan] += s->nwrap;
136     }
137
138     coeffs = av_realloc(s->coeffs, s->nwrap * sizeof(*s->coeffs));
139     if (!coeffs)
140         return AVERROR(ENOMEM);
141     s->coeffs = coeffs;
142
143     return 0;
144 }
145
146
147 static inline unsigned int get_uint(ShortenContext *s, int k)
148 {
149     if (s->version != 0)
150         k = get_ur_golomb_shorten(&s->gb, ULONGSIZE);
151     return get_ur_golomb_shorten(&s->gb, k);
152 }
153
154
155 static void fix_bitshift(ShortenContext *s, int32_t *buffer)
156 {
157     int i;
158
159     if (s->bitshift != 0)
160         for (i = 0; i < s->blocksize; i++)
161             buffer[i] <<= s->bitshift;
162 }
163
164
165 static void init_offset(ShortenContext *s)
166 {
167     int32_t mean = 0;
168     int  chan, i;
169     int nblock = FFMAX(1, s->nmean);
170     /* initialise offset */
171     switch (s->internal_ftype)
172     {
173         case TYPE_S16HL:
174         case TYPE_S16LH:
175             mean = 0;
176             break;
177         default:
178             av_log(s->avctx, AV_LOG_ERROR, "unknown audio type");
179             abort();
180     }
181
182     for (chan = 0; chan < s->channels; chan++)
183         for (i = 0; i < nblock; i++)
184             s->offset[chan][i] = mean;
185 }
186
187 static inline int get_le32(GetBitContext *gb)
188 {
189     return av_bswap32(get_bits_long(gb, 32));
190 }
191
192 static inline short get_le16(GetBitContext *gb)
193 {
194     return av_bswap16(get_bits_long(gb, 16));
195 }
196
197 static int decode_wave_header(AVCodecContext *avctx, uint8_t *header, int header_size)
198 {
199     GetBitContext hb;
200     int len;
201     short wave_format;
202
203     init_get_bits(&hb, header, header_size*8);
204     if (get_le32(&hb) != MKTAG('R','I','F','F')) {
205         av_log(avctx, AV_LOG_ERROR, "missing RIFF tag\n");
206         return -1;
207     }
208
209     skip_bits_long(&hb, 32);    /* chunk_size */
210
211     if (get_le32(&hb) != MKTAG('W','A','V','E')) {
212         av_log(avctx, AV_LOG_ERROR, "missing WAVE tag\n");
213         return -1;
214     }
215
216     while (get_le32(&hb) != MKTAG('f','m','t',' ')) {
217         len = get_le32(&hb);
218         skip_bits(&hb, 8*len);
219     }
220     len = get_le32(&hb);
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 = get_le16(&hb);
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     skip_bits(&hb, 16); // skip channels    (already got from shorten header)
238     avctx->sample_rate = get_le32(&hb);
239     skip_bits(&hb, 32); // skip bit rate    (represents original uncompressed bit rate)
240     skip_bits(&hb, 16); // skip block align (not needed)
241     avctx->bits_per_coded_sample = get_le16(&hb);
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++ = FFMIN(buffer[chan][i], 32768);
260     return samples;
261 }
262
263 static int decode_subframe_lpc(ShortenContext *s, int channel,
264                                int residual_size, int32_t coffset)
265 {
266     int pred_order, sum, i, j;
267     int *coeffs = s->coeffs;
268
269     /* read/validate prediction order */
270     pred_order = get_ur_golomb_shorten(&s->gb, LPCQSIZE);
271     if (pred_order > s->nwrap) {
272         av_log(s->avctx, AV_LOG_ERROR, "invalid pred_order %d\n", pred_order);
273         return AVERROR(EINVAL);
274     }
275     /* read LPC coefficients */
276     for (i=0; i<pred_order; i++)
277         coeffs[i] = get_sr_golomb_shorten(&s->gb, LPCQUANT);
278
279     /* subtract offset from previous samples to use in prediction */
280     if (coffset)
281         for (i = -pred_order; i < 0; i++)
282             s->decoded[channel][i] -= coffset;
283
284     /* decode residual and do LPC prediction */
285     for (i=0; i < s->blocksize; i++) {
286         sum = s->lpcqoffset;
287         for (j=0; j<pred_order; j++)
288             sum += coeffs[j] * s->decoded[channel][i-j-1];
289         s->decoded[channel][i] = get_sr_golomb_shorten(&s->gb, residual_size) + (sum >> LPCQUANT);
290     }
291
292     /* add offset to current samples */
293     if (coffset != 0)
294         for (i = 0; i < s->blocksize; i++)
295             s->decoded[channel][i] += coffset;
296
297     return 0;
298 }
299
300 static int read_header(ShortenContext *s)
301 {
302     int i;
303     int maxnlpc = 0;
304     /* shorten signature */
305     if (get_bits_long(&s->gb, 32) != AV_RB32("ajkg")) {
306         av_log(s->avctx, AV_LOG_ERROR, "missing shorten magic 'ajkg'\n");
307         return -1;
308     }
309
310     s->lpcqoffset = 0;
311     s->blocksize = DEFAULT_BLOCK_SIZE;
312     s->channels = 1;
313     s->nmean = -1;
314     s->version = get_bits(&s->gb, 8);
315     s->internal_ftype = get_uint(s, TYPESIZE);
316
317     s->channels = get_uint(s, CHANSIZE);
318     if (s->channels > MAX_CHANNELS) {
319         av_log(s->avctx, AV_LOG_ERROR, "too many channels: %d\n", s->channels);
320         return -1;
321     }
322     s->avctx->channels = s->channels;
323
324     /* get blocksize if version > 0 */
325     if (s->version > 0) {
326         int skip_bytes;
327         s->blocksize = get_uint(s, av_log2(DEFAULT_BLOCK_SIZE));
328         maxnlpc = get_uint(s, LPCQSIZE);
329         s->nmean = get_uint(s, 0);
330
331         skip_bytes = get_uint(s, NSKIPSIZE);
332         for (i=0; i<skip_bytes; i++) {
333             skip_bits(&s->gb, 8);
334         }
335     }
336     s->nwrap = FFMAX(NWRAP, maxnlpc);
337
338     if (allocate_buffers(s))
339         return -1;
340
341     init_offset(s);
342
343     if (s->version > 1)
344         s->lpcqoffset = V2LPCQOFFSET;
345
346     if (get_ur_golomb_shorten(&s->gb, FNSIZE) != FN_VERBATIM) {
347         av_log(s->avctx, AV_LOG_ERROR, "missing verbatim section at beginning of stream\n");
348         return -1;
349     }
350
351     s->header_size = get_ur_golomb_shorten(&s->gb, VERBATIM_CKSIZE_SIZE);
352     if (s->header_size >= OUT_BUFFER_SIZE || s->header_size < CANONICAL_HEADER_SIZE) {
353         av_log(s->avctx, AV_LOG_ERROR, "header is wrong size: %d\n", s->header_size);
354         return -1;
355     }
356
357     for (i=0; i<s->header_size; i++)
358         s->header[i] = (char)get_ur_golomb_shorten(&s->gb, VERBATIM_BYTE_SIZE);
359
360     if (decode_wave_header(s->avctx, s->header, s->header_size) < 0)
361         return -1;
362
363     s->cur_chan = 0;
364     s->bitshift = 0;
365
366     return 0;
367 }
368
369 static int shorten_decode_frame(AVCodecContext *avctx,
370         void *data, int *data_size,
371         AVPacket *avpkt)
372 {
373     const uint8_t *buf = avpkt->data;
374     int buf_size = avpkt->size;
375     ShortenContext *s = avctx->priv_data;
376     int i, input_buf_size = 0;
377     int16_t *samples = data;
378     if(s->max_framesize == 0){
379         s->max_framesize= 1024; // should hopefully be enough for the first header
380         s->bitstream= av_fast_realloc(s->bitstream, &s->allocated_bitstream_size, s->max_framesize);
381     }
382
383     if(1 && s->max_framesize){//FIXME truncated
384         buf_size= FFMIN(buf_size, s->max_framesize - s->bitstream_size);
385         input_buf_size= buf_size;
386
387         if(s->bitstream_index + s->bitstream_size + buf_size > s->allocated_bitstream_size){
388             //                printf("memmove\n");
389             memmove(s->bitstream, &s->bitstream[s->bitstream_index], s->bitstream_size);
390             s->bitstream_index=0;
391         }
392         memcpy(&s->bitstream[s->bitstream_index + s->bitstream_size], buf, buf_size);
393         buf= &s->bitstream[s->bitstream_index];
394         buf_size += s->bitstream_size;
395         s->bitstream_size= buf_size;
396
397         if(buf_size < s->max_framesize){
398             *data_size = 0;
399             return input_buf_size;
400         }
401     }
402     init_get_bits(&s->gb, buf, buf_size*8);
403     skip_bits(&s->gb, s->bitindex);
404     if (!s->blocksize)
405     {
406         int ret;
407         if ((ret = read_header(s)) < 0)
408             return ret;
409         *data_size = 0;
410     }
411     else
412     {
413         int cmd;
414         int len;
415         cmd = get_ur_golomb_shorten(&s->gb, FNSIZE);
416
417         if (cmd > FN_VERBATIM) {
418             av_log(avctx, AV_LOG_ERROR, "unknown shorten function %d\n", cmd);
419             if (s->bitstream_size > 0) {
420                 s->bitstream_index++;
421                 s->bitstream_size--;
422             }
423             return -1;
424         }
425
426         if (!is_audio_command[cmd]) {
427             /* process non-audio command */
428             switch (cmd) {
429                 case FN_VERBATIM:
430                     len = get_ur_golomb_shorten(&s->gb, VERBATIM_CKSIZE_SIZE);
431                     while (len--) {
432                         get_ur_golomb_shorten(&s->gb, VERBATIM_BYTE_SIZE);
433                     }
434                     break;
435                 case FN_BITSHIFT:
436                     s->bitshift = get_ur_golomb_shorten(&s->gb, BITSHIFTSIZE);
437                     break;
438                 case FN_BLOCKSIZE: {
439                     int blocksize = get_uint(s, av_log2(s->blocksize));
440                     if (blocksize > s->blocksize) {
441                         av_log(avctx, AV_LOG_ERROR, "Increasing block size is not supported\n");
442                         return AVERROR_PATCHWELCOME;
443                     }
444                     s->blocksize = blocksize;
445                     break;
446                 }
447                 case FN_QUIT:
448                     break;
449             }
450             *data_size = 0;
451         } else {
452             /* process audio command */
453             int ret;
454             int residual_size = 0;
455             int channel = s->cur_chan;
456             int32_t coffset;
457             if (cmd != FN_ZERO) {
458                 residual_size = get_ur_golomb_shorten(&s->gb, ENERGYSIZE);
459                 /* this is a hack as version 0 differed in defintion of get_sr_golomb_shorten */
460                 if (s->version == 0)
461                     residual_size--;
462             }
463
464             if (s->nmean == 0)
465                 coffset = s->offset[channel][0];
466             else {
467                 int32_t sum = (s->version < 2) ? 0 : s->nmean / 2;
468                 for (i=0; i<s->nmean; i++)
469                     sum += s->offset[channel][i];
470                 coffset = sum / s->nmean;
471                 if (s->version >= 2)
472                     coffset >>= FFMIN(1, s->bitshift);
473             }
474             switch (cmd) {
475                 case FN_ZERO:
476                     for (i=0; i<s->blocksize; i++)
477                         s->decoded[channel][i] = 0;
478                     break;
479                 case FN_DIFF0:
480                     for (i=0; i<s->blocksize; i++)
481                         s->decoded[channel][i] = get_sr_golomb_shorten(&s->gb, residual_size) + coffset;
482                     break;
483                 case FN_DIFF1:
484                     for (i=0; i<s->blocksize; i++)
485                         s->decoded[channel][i] = get_sr_golomb_shorten(&s->gb, residual_size) + s->decoded[channel][i - 1];
486                     break;
487                 case FN_DIFF2:
488                     for (i=0; i<s->blocksize; i++)
489                         s->decoded[channel][i] = get_sr_golomb_shorten(&s->gb, residual_size) + 2*s->decoded[channel][i-1]
490                                                                                               -   s->decoded[channel][i-2];
491                     break;
492                 case FN_DIFF3:
493                     for (i=0; i<s->blocksize; i++)
494                         s->decoded[channel][i] = get_sr_golomb_shorten(&s->gb, residual_size) + 3*s->decoded[channel][i-1]
495                                                                                               - 3*s->decoded[channel][i-2]
496                                                                                               +   s->decoded[channel][i-3];
497                     break;
498                 case FN_QLPC:
499                     if ((ret = decode_subframe_lpc(s, channel, residual_size, coffset)) < 0)
500                         return ret;
501                     break;
502             }
503             if (s->nmean > 0) {
504                 int32_t sum = (s->version < 2) ? 0 : s->blocksize / 2;
505                 for (i=0; i<s->blocksize; i++)
506                     sum += s->decoded[channel][i];
507
508                 for (i=1; i<s->nmean; i++)
509                     s->offset[channel][i-1] = s->offset[channel][i];
510
511                 if (s->version < 2)
512                     s->offset[channel][s->nmean - 1] = sum / s->blocksize;
513                 else
514                     s->offset[channel][s->nmean - 1] = (sum / s->blocksize) << s->bitshift;
515             }
516             for (i=-s->nwrap; i<0; i++)
517                 s->decoded[channel][i] = s->decoded[channel][i + s->blocksize];
518
519             fix_bitshift(s, s->decoded[channel]);
520
521             s->cur_chan++;
522             if (s->cur_chan == s->channels) {
523                 samples = interleave_buffer(samples, s->channels, s->blocksize, s->decoded);
524                 s->cur_chan = 0;
525                 *data_size = (int8_t *)samples - (int8_t *)data;
526             } else {
527                 *data_size = 0;
528             }
529         }
530     }
531
532     //    s->last_blocksize = s->blocksize;
533     s->bitindex = get_bits_count(&s->gb) - 8*((get_bits_count(&s->gb))/8);
534     i= (get_bits_count(&s->gb))/8;
535     if (i > buf_size) {
536         av_log(s->avctx, AV_LOG_ERROR, "overread: %d\n", i - buf_size);
537         s->bitstream_size=0;
538         s->bitstream_index=0;
539         return -1;
540     }
541     if (s->bitstream_size) {
542         s->bitstream_index += i;
543         s->bitstream_size  -= i;
544         return input_buf_size;
545     } else
546         return i;
547 }
548
549 static av_cold int shorten_decode_close(AVCodecContext *avctx)
550 {
551     ShortenContext *s = avctx->priv_data;
552     int i;
553
554     for (i = 0; i < s->channels; i++) {
555         s->decoded[i] -= s->nwrap;
556         av_freep(&s->decoded[i]);
557         av_freep(&s->offset[i]);
558     }
559     av_freep(&s->bitstream);
560     av_freep(&s->coeffs);
561     return 0;
562 }
563
564 AVCodec ff_shorten_decoder = {
565     .name           = "shorten",
566     .type           = AVMEDIA_TYPE_AUDIO,
567     .id             = CODEC_ID_SHORTEN,
568     .priv_data_size = sizeof(ShortenContext),
569     .init           = shorten_decode_init,
570     .close          = shorten_decode_close,
571     .decode         = shorten_decode_frame,
572     .long_name= NULL_IF_CONFIG_SMALL("Shorten"),
573 };