libavcodec/ra144.c

   1 /*
   2  * Real Audio 1.0 (14.4K)
   3  * Copyright (c) 2003 the ffmpeg project
   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 #include "avcodec.h"
  23 #include "bitstream.h"
  24 #include "ra144.h"
  25
  26 #define NBLOCKS         4       /* number of segments within a block */
  27 #define BLOCKSIZE       40      /* (quarter) block size in 16-bit words (80 bytes) */
  28 #define HALFBLOCK       20      /* BLOCKSIZE/2 */
  29 #define BUFFERSIZE      146     /* for do_output */
  30
  31
  32 typedef struct {
  33     unsigned int     old_energy;        ///< previous frame energy
  34
  35     /* the swapped buffers */
  36     unsigned int     lpc_tables[2][10];
  37     unsigned int    *lpc_coef;          ///< LPC coefficients
  38     unsigned int    *lpc_coef_old;      ///< previous frame LPC coefficients
  39     unsigned int     lpc_refl_rms;
  40     unsigned int     lpc_refl_rms_old;
  41
  42     unsigned int buffer[5];
  43     uint16_t adapt_cb[148];             ///< adaptive codebook
  44 } RA144Context;
  45
  46 static int ra144_decode_init(AVCodecContext * avctx)
  47 {
  48     RA144Context *ractx = avctx->priv_data;
  49
  50     ractx->lpc_coef     = ractx->lpc_tables[0];
  51     ractx->lpc_coef_old = ractx->lpc_tables[1];
  52
  53     return 0;
  54 }
  55
  56 /**
  57  * Evaluate sqrt(x << 24). x must fit in 20 bits. This value is evaluated in an
  58  * odd way to make the output identical to the binary decoder.
  59  */
  60 static int t_sqrt(unsigned int x)
  61 {
  62     int s = 0;
  63     while (x > 0xfff) {
  64         s++;
  65         x = x >> 2;
  66     }
  67
  68     return (ff_sqrt(x << 20) << s) << 2;
  69 }
  70
  71 /**
  72  * Evaluate the LPC filter coefficients from the reflection coefficients.
  73  * Does the inverse of the eval_refl() function.
  74  */
  75 static void eval_coefs(const int *refl, int *coefs)
  76 {
  77     int buffer[10];
  78     int *b1 = buffer;
  79     int *b2 = coefs;
  80     int x, y;
  81
  82     for (x=0; x < 10; x++) {
  83         b1[x] = refl[x] << 4;
  84
  85         for (y=0; y < x; y++)
  86             b1[y] = ((refl[x] * b2[x-y-1]) >> 12) + b2[y];
  87
  88         FFSWAP(int *, b1, b2);
  89     }
  90
  91     for (x=0; x < 10; x++)
  92         coefs[x] >>= 4;
  93 }
  94
  95 /* rotate block */
  96 static void rotate_block(const int16_t *source, int16_t *target, int offset)
  97 {
  98     int i=0, k=0;
  99     source += BUFFERSIZE - offset;
 100
 101     while (i<BLOCKSIZE) {
 102         target[i++] = source[k++];
 103
 104         if (k == offset)
 105             k = 0;
 106     }
 107 }
 108
 109 /* inverse root mean square */
 110 static int irms(const int16_t *data, int factor)
 111 {
 112     unsigned int i, sum = 0;
 113
 114     for (i=0; i < BLOCKSIZE; i++)
 115         sum += data[i] * data[i];
 116
 117     if (sum == 0)
 118         return 0; /* OOPS - division by zero */
 119
 120     return (0x20000000 / (t_sqrt(sum) >> 8)) * factor;
 121 }
 122
 123 /* multiply/add wavetable */
 124 static void add_wav(int n, int skip_first, int *m, const int16_t *s1,
 125                     const int8_t *s2, const int8_t *s3, int16_t *dest)
 126 {
 127     int i;
 128     int v[3];
 129
 130     v[0] = 0;
 131     for (i=!skip_first; i<3; i++)
 132         v[i] = (gain_val_tab[n][i] * m[i]) >> (gain_exp_tab[n][i] + 1);
 133
 134     for (i=0; i < BLOCKSIZE; i++)
 135         dest[i] = ((*(s1++))*v[0] + (*(s2++))*v[1] + (*(s3++))*v[2]) >> 12;
 136 }
 137
 138 static void lpc_filter(const int16_t *lpc_coefs, const int16_t *adapt_coef,
 139                        void *out, int *statbuf, int len)
 140 {
 141     int x, i;
 142     uint16_t work[50];
 143     int16_t *ptr = work;
 144
 145     memcpy(work, statbuf,20);
 146     memcpy(work + 10, adapt_coef, len * 2);
 147
 148     for (i=0; i<len; i++) {
 149         int sum = 0;
 150         int new_val;
 151
 152         for(x=0; x<10; x++)
 153             sum += lpc_coefs[9-x] * ptr[x];
 154
 155         sum >>= 12;
 156
 157         new_val = ptr[10] - sum;
 158
 159         if (new_val < -32768 || new_val > 32767) {
 160             memset(out, 0, len * 2);
 161             memset(statbuf, 0, 20);
 162             return;
 163         }
 164
 165         ptr[10] = new_val;
 166         ptr++;
 167     }
 168
 169     memcpy(out, work+10, len * 2);
 170     memcpy(statbuf, work + 40, 20);
 171 }
 172
 173 static unsigned int rescale_rms(int rms, int energy)
 174 {
 175     return (rms * energy) >> 10;
 176 }
 177
 178 static unsigned int rms(const int *data)
 179 {
 180     int x;
 181     unsigned int res = 0x10000;
 182     int b = 0;
 183
 184     for (x=0; x<10; x++) {
 185         res = (((0x1000000 - (*data) * (*data)) >> 12) * res) >> 12;
 186
 187         if (res == 0)
 188             return 0;
 189
 190         while (res <= 0x3fff) {
 191             b++;
 192             res <<= 2;
 193         }
 194         data++;
 195     }
 196
 197     if (res > 0)
 198         res = t_sqrt(res);
 199
 200     res >>= (b + 10);
 201     return res;
 202 }
 203
 204 /* do quarter-block output */
 205 static void do_output_subblock(RA144Context *ractx,
 206                                const uint16_t  *lpc_coefs, unsigned int gval,
 207                                int16_t *output_buffer, GetBitContext *gb)
 208 {
 209     uint16_t buffer_a[40];
 210     uint16_t *block;
 211     int cba_idx = get_bits(gb, 7); // index of the adaptive CB, 0 if none
 212     int gain    = get_bits(gb, 8);
 213     int cb1_idx = get_bits(gb, 7);
 214     int cb2_idx = get_bits(gb, 7);
 215     int m[3];
 216
 217     if (cba_idx) {
 218         cba_idx += HALFBLOCK - 1;
 219         rotate_block(ractx->adapt_cb, buffer_a, cba_idx);
 220         m[0] = irms(buffer_a, gval) >> 12;
 221     } else {
 222         m[0] = 0;
 223     }
 224
 225     m[1] = ((cb1_base[cb1_idx] >> 4) * gval) >> 8;
 226     m[2] = ((cb2_base[cb2_idx] >> 4) * gval) >> 8;
 227
 228     memmove(ractx->adapt_cb, ractx->adapt_cb + BLOCKSIZE,
 229             (BUFFERSIZE - BLOCKSIZE) * 2);
 230
 231     block = ractx->adapt_cb + BUFFERSIZE - BLOCKSIZE;
 232
 233     add_wav(gain, cba_idx, m, buffer_a, cb1_vects[cb1_idx], cb2_vects[cb2_idx],
 234             block);
 235
 236     lpc_filter(lpc_coefs, block, output_buffer, ractx->buffer, BLOCKSIZE);
 237 }
 238
 239 static void int_to_int16(int16_t *out, const int *inp)
 240 {
 241     int i;
 242
 243     for (i=0; i<30; i++)
 244         *(out++) = *(inp++);
 245 }
 246
 247 /**
 248  * Evaluate the reflection coefficients from the filter coefficients.
 249  * Does the inverse of the eval_coefs() function.
 250  *
 251  * @return 1 if one of the reflection coefficients is of magnitude greater than
 252  *         4095, 0 if not.
 253  */
 254 static int eval_refl(const int16_t *coefs, int *refl, RA144Context *ractx)
 255 {
 256     int retval = 0;
 257     int b, c, i;
 258     unsigned int u;
 259     int buffer1[10];
 260     int buffer2[10];
 261     int *bp1 = buffer1;
 262     int *bp2 = buffer2;
 263
 264     for (i=0; i < 10; i++)
 265         buffer2[i] = coefs[i];
 266
 267     u = refl[9] = bp2[9];
 268
 269     if (u + 0x1000 > 0x1fff) {
 270         av_log(ractx, AV_LOG_ERROR, "Overflow. Broken sample?\n");
 271         return 0;
 272     }
 273
 274     for (c=8; c >= 0; c--) {
 275         if (u == 0x1000)
 276             u++;
 277
 278         if (u == 0xfffff000)
 279             u--;
 280
 281         b = 0x1000-((u * u) >> 12);
 282
 283         if (b == 0)
 284             b++;
 285
 286         for (u=0; u<=c; u++)
 287             bp1[u] = ((bp2[u] - ((refl[c+1] * bp2[c-u]) >> 12)) * (0x1000000 / b)) >> 12;
 288
 289         refl[c] = u = bp1[c];
 290
 291         if ((u + 0x1000) > 0x1fff)
 292             retval = 1;
 293
 294         FFSWAP(int *, bp1, bp2);
 295     }
 296     return retval;
 297 }
 298
 299 static int interp(RA144Context *ractx, int16_t *out, int block_num,
 300                   int copynew, int energy)
 301 {
 302     int work[10];
 303     int a = block_num + 1;
 304     int b = NBLOCKS - a;
 305     int x;
 306
 307     // Interpolate block coefficients from the this frame forth block and
 308     // last frame forth block
 309     for (x=0; x<30; x++)
 310         out[x] = (a * ractx->lpc_coef[x] + b * ractx->lpc_coef_old[x])>> 2;
 311
 312     if (eval_refl(out, work, ractx)) {
 313         // The interpolated coefficients are unstable, copy either new or old
 314         // coefficients
 315         if (copynew) {
 316             int_to_int16(out, ractx->lpc_coef);
 317             return rescale_rms(ractx->lpc_refl_rms, energy);
 318         } else {
 319             int_to_int16(out, ractx->lpc_coef_old);
 320             return rescale_rms(ractx->lpc_refl_rms_old, energy);
 321         }
 322     } else {
 323         return rescale_rms(rms(work), energy);
 324     }
 325 }
 326
 327 /* Uncompress one block (20 bytes -> 160*2 bytes) */
 328 static int ra144_decode_frame(AVCodecContext * avctx,
 329                               void *vdata, int *data_size,
 330                               const uint8_t * buf, int buf_size)
 331 {
 332     static const uint8_t sizes[10] = {6, 5, 5, 4, 4, 3, 3, 3, 3, 2};
 333     unsigned int refl_rms[4];    // RMS of the reflection coefficients
 334     uint16_t block_coefs[4][30]; // LPC coefficients of each sub-block
 335     unsigned int lpc_refl[10];   // LPC reflection coefficients of the frame
 336     int i, c;
 337     int16_t *data = vdata;
 338     unsigned int energy;
 339
 340     RA144Context *ractx = avctx->priv_data;
 341     GetBitContext gb;
 342
 343     if(buf_size < 20) {
 344         av_log(avctx, AV_LOG_ERROR,
 345                "Frame too small (%d bytes). Truncated file?\n", buf_size);
 346         return buf_size;
 347     }
 348     init_get_bits(&gb, buf, 20 * 8);
 349
 350     for (i=0; i<10; i++)
 351         // "<< 1"? Doesn't this make one value out of two of the table useless?
 352         lpc_refl[i] = lpc_refl_cb[i][get_bits(&gb, sizes[i]) << 1];
 353
 354     eval_coefs(lpc_refl, ractx->lpc_coef);
 355     ractx->lpc_refl_rms = rms(lpc_refl);
 356
 357     energy = energy_tab[get_bits(&gb, 5) << 1]; // Useless table entries?
 358
 359     refl_rms[0] = interp(ractx, block_coefs[0], 0, 0, ractx->old_energy);
 360     refl_rms[1] = interp(ractx, block_coefs[1], 1, energy > ractx->old_energy,
 361                     t_sqrt(energy*ractx->old_energy) >> 12);
 362     refl_rms[2] = interp(ractx, block_coefs[2], 2, 1, energy);
 363     refl_rms[3] = rescale_rms(ractx->lpc_refl_rms, energy);
 364
 365     int_to_int16(block_coefs[3], ractx->lpc_coef);
 366
 367     /* do output */
 368     for (c=0; c<4; c++) {
 369         do_output_subblock(ractx, block_coefs[c], refl_rms[c], data, &gb);
 370
 371         for (i=0; i<BLOCKSIZE; i++) {
 372             *data = av_clip_int16(*data << 2);
 373             data++;
 374         }
 375     }
 376
 377     ractx->old_energy = energy;
 378     ractx->lpc_refl_rms_old = ractx->lpc_refl_rms;
 379
 380     FFSWAP(unsigned int *, ractx->lpc_coef_old, ractx->lpc_coef);
 381
 382     *data_size = 2*160;
 383     return 20;
 384 }
 385
 386 AVCodec ra_144_decoder =
 387 {
 388     "real_144",
 389     CODEC_TYPE_AUDIO,
 390     CODEC_ID_RA_144,
 391     sizeof(RA144Context),
 392     ra144_decode_init,
 393     NULL,
 394     NULL,
 395     ra144_decode_frame,
 396     .long_name = NULL_IF_CONFIG_SMALL("RealAudio 1.0 (14.4K)"),
 397 };