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