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