libcelt/vq.c

   1 /* Copyright (c) 2007-2008 CSIRO
   2    Copyright (c) 2007-2009 Xiph.Org Foundation
   3    Written by Jean-Marc Valin */
   4 /*
   5    Redistribution and use in source and binary forms, with or without
   6    modification, are permitted provided that the following conditions
   7    are met:
   8
   9    - Redistributions of source code must retain the above copyright
  10    notice, this list of conditions and the following disclaimer.
  11
  12    - Redistributions in binary form must reproduce the above copyright
  13    notice, this list of conditions and the following disclaimer in the
  14    documentation and/or other materials provided with the distribution.
  15
  16    - Neither the name of the Xiph.org Foundation nor the names of its
  17    contributors may be used to endorse or promote products derived from
  18    this software without specific prior written permission.
  19
  20    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  23    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
  24    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  25    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  26    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  27    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  28    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  29    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  30    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31 */
  32
  33 #ifdef HAVE_CONFIG_H
  34 #include "config.h"
  35 #endif
  36
  37 #include "mathops.h"
  38 #include "cwrs.h"
  39 #include "vq.h"
  40 #include "arch.h"
  41 #include "os_support.h"
  42 #include "rate.h"
  43
  44 #ifndef M_PI
  45 #define M_PI 3.141592653
  46 #endif
  47
  48 static celt_uint32 lcg_rand(celt_uint32 seed)
  49 {
  50    return 1664525 * seed + 1013904223;
  51 }
  52
  53 static void exp_rotation1(celt_norm *X, int len, int stride, celt_word16 c, celt_word16 s)
  54 {
  55    int i;
  56    celt_norm *Xptr;
  57    Xptr = X;
  58    for (i=0;i<len-stride;i++)
  59    {
  60       celt_norm x1, x2;
  61       x1 = Xptr[0];
  62       x2 = Xptr[stride];
  63       Xptr[stride] = EXTRACT16(SHR32(MULT16_16(c,x2) + MULT16_16(s,x1), 15));
  64       *Xptr++      = EXTRACT16(SHR32(MULT16_16(c,x1) - MULT16_16(s,x2), 15));
  65    }
  66    Xptr = &X[len-2*stride-1];
  67    for (i=len-2*stride-1;i>=0;i--)
  68    {
  69       celt_norm x1, x2;
  70       x1 = Xptr[0];
  71       x2 = Xptr[stride];
  72       Xptr[stride] = EXTRACT16(SHR32(MULT16_16(c,x2) + MULT16_16(s,x1), 15));
  73       *Xptr--      = EXTRACT16(SHR32(MULT16_16(c,x1) - MULT16_16(s,x2), 15));
  74    }
  75 }
  76
  77 static void exp_rotation(celt_norm *X, int len, int dir, int stride, int K, int spread)
  78 {
  79    int i;
  80    celt_word16 c, s;
  81    celt_word16 gain, theta;
  82    int stride2=0;
  83    int factor;
  84    /*int i;
  85    if (len>=30)
  86    {
  87       for (i=0;i<len;i++)
  88          X[i] = 0;
  89       X[14] = 1;
  90       K=5;
  91    }*/
  92    if (2*K>=len || spread==0)
  93       return;
  94    if (spread==1)
  95       factor=10;
  96    else if (spread==2)
  97       factor=5;
  98    else
  99       factor=15;
 100
 101    gain = celt_div((celt_word32)MULT16_16(Q15_ONE,len),(celt_word32)(len+factor*K));
 102    /* FIXME: Make that HALF16 instead of HALF32 */
 103    theta = HALF32(MULT16_16_Q15(gain,gain));
 104
 105    c = celt_cos_norm(EXTEND32(theta));
 106    s = celt_cos_norm(EXTEND32(SUB16(Q15ONE,theta))); /*  sin(theta) */
 107
 108    if (len>=8*stride)
 109    {
 110       stride2 = 1;
 111       /* This is just a simple way of computing sqrt(len/stride) with rounding.
 112          It's basically incrementing long as (stride2+0.5)^2 < len/stride.
 113          I _think_ it is bit-exact */
 114       while ((stride2*stride2+stride2)*stride + (stride>>2) < len)
 115          stride2++;
 116    }
 117    len /= stride;
 118    for (i=0;i<stride;i++)
 119    {
 120       if (dir < 0)
 121       {
 122          if (stride2)
 123             exp_rotation1(X+i*len, len, stride2, s, c);
 124          exp_rotation1(X+i*len, len, 1, c, s);
 125       } else {
 126          exp_rotation1(X+i*len, len, 1, c, -s);
 127          if (stride2)
 128             exp_rotation1(X+i*len, len, stride2, s, -c);
 129       }
 130    }
 131    /*if (len>=30)
 132    {
 133       for (i=0;i<len;i++)
 134          printf ("%f ", X[i]);
 135       printf ("\n");
 136       exit(0);
 137    }*/
 138 }
 139
 140 /** Takes the pitch vector and the decoded residual vector, computes the gain
 141     that will give ||p+g*y||=1 and mixes the residual with the pitch. */
 142 static void normalise_residual(int * restrict iy, celt_norm * restrict X, int N, int K, celt_word32 Ryy)
 143 {
 144    int i;
 145 #ifdef FIXED_POINT
 146    int k;
 147 #endif
 148    celt_word32 t;
 149    celt_word16 g;
 150
 151 #ifdef FIXED_POINT
 152    k = celt_ilog2(Ryy)>>1;
 153 #endif
 154    t = VSHR32(Ryy, (k-7)<<1);
 155    g = celt_rsqrt_norm(t);
 156
 157    i=0;
 158    do
 159       X[i] = EXTRACT16(PSHR32(MULT16_16(g, iy[i]), k+1));
 160    while (++i < N);
 161 }
 162
 163 void alg_quant(celt_norm *X, int N, int K, int spread, int B, celt_norm *lowband, int resynth, ec_enc *enc, celt_int32 *seed)
 164 {
 165    VARDECL(celt_norm, y);
 166    VARDECL(int, iy);
 167    VARDECL(celt_word16, signx);
 168    int j, is;
 169    celt_word16 s;
 170    int pulsesLeft;
 171    celt_word32 sum;
 172    celt_word32 xy, yy;
 173    int N_1; /* Inverse of N, in Q14 format (even for float) */
 174 #ifdef FIXED_POINT
 175    int yshift;
 176 #endif
 177    SAVE_STACK;
 178
 179    /* When there's no pulse, fill with noise or folded spectrum */
 180    if (K==0)
 181    {
 182       if (lowband != NULL && resynth)
 183       {
 184          for (j=0;j<N;j++)
 185             X[j] = lowband[j];
 186       } else {
 187          /* This is important for encoding the side in stereo mode */
 188          for (j=0;j<N;j++)
 189          {
 190             *seed = lcg_rand(*seed);
 191             X[j] = (int)(*seed)>>20;
 192          }
 193       }
 194       renormalise_vector(X, Q15ONE, N, 1);
 195       return;
 196    }
 197    K = get_pulses(K);
 198 #ifdef FIXED_POINT
 199    yshift = 13-celt_ilog2(K);
 200 #endif
 201
 202    ALLOC(y, N, celt_norm);
 203    ALLOC(iy, N, int);
 204    ALLOC(signx, N, celt_word16);
 205    N_1 = 512/N;
 206
 207    exp_rotation(X, N, 1, B, K, spread);
 208
 209    /* Get rid of the sign */
 210    sum = 0;
 211    j=0; do {
 212       if (X[j]>0)
 213          signx[j]=1;
 214       else {
 215          signx[j]=-1;
 216          X[j]=-X[j];
 217       }
 218       iy[j] = 0;
 219       y[j] = 0;
 220    } while (++j<N);
 221
 222    xy = yy = 0;
 223
 224    pulsesLeft = K;
 225
 226    /* Do a pre-search by projecting on the pyramid */
 227    if (K > (N>>1))
 228    {
 229       celt_word16 rcp;
 230       j=0; do {
 231          sum += X[j];
 232       }  while (++j<N);
 233
 234       /* If X is too small, just replace it with a pulse at 0 */
 235 #ifdef FIXED_POINT
 236       if (sum <= K)
 237 #else
 238       if (sum <= EPSILON)
 239 #endif
 240       {
 241          X[0] = QCONST16(1.f,14);
 242          j=1; do
 243             X[j]=0;
 244          while (++j<N);
 245          sum = QCONST16(1.f,14);
 246       }
 247       /* Do we have sufficient accuracy here? */
 248       rcp = EXTRACT16(MULT16_32_Q16(K-1, celt_rcp(sum)));
 249       j=0; do {
 250 #ifdef FIXED_POINT
 251          /* It's really important to round *towards zero* here */
 252          iy[j] = MULT16_16_Q15(X[j],rcp);
 253 #else
 254          iy[j] = (int)floor(rcp*X[j]);
 255 #endif
 256          y[j] = SHL16(iy[j],yshift);
 257          yy = MAC16_16(yy, y[j],y[j]);
 258          xy = MAC16_16(xy, X[j],y[j]);
 259          y[j] *= 2;
 260          pulsesLeft -= iy[j];
 261       }  while (++j<N);
 262    }
 263    celt_assert2(pulsesLeft>=1, "Allocated too many pulses in the quick pass");
 264
 265    while (pulsesLeft > 0)
 266    {
 267       int pulsesAtOnce=1;
 268       int best_id;
 269       celt_word16 magnitude;
 270       celt_word32 best_num = -VERY_LARGE16;
 271       celt_word16 best_den = 0;
 272 #ifdef FIXED_POINT
 273       int rshift;
 274 #endif
 275       /* Decide on how many pulses to find at once */
 276       pulsesAtOnce = (pulsesLeft*N_1)>>9; /* pulsesLeft/N */
 277       if (pulsesAtOnce<1)
 278          pulsesAtOnce = 1;
 279 #ifdef FIXED_POINT
 280       rshift = yshift+1+celt_ilog2(K-pulsesLeft+pulsesAtOnce);
 281 #endif
 282       magnitude = SHL16(pulsesAtOnce, yshift);
 283
 284       best_id = 0;
 285       /* The squared magnitude term gets added anyway, so we might as well
 286          add it outside the loop */
 287       yy = MAC16_16(yy, magnitude,magnitude);
 288       /* Choose between fast and accurate strategy depending on where we are in the search */
 289          /* This should ensure that anything we can process will have a better score */
 290       j=0;
 291       do {
 292          celt_word16 Rxy, Ryy;
 293          /* Select sign based on X[j] alone */
 294          s = magnitude;
 295          /* Temporary sums of the new pulse(s) */
 296          Rxy = EXTRACT16(SHR32(MAC16_16(xy, s,X[j]),rshift));
 297          /* We're multiplying y[j] by two so we don't have to do it here */
 298          Ryy = EXTRACT16(SHR32(MAC16_16(yy, s,y[j]),rshift));
 299
 300          /* Approximate score: we maximise Rxy/sqrt(Ryy) (we're guaranteed that
 301             Rxy is positive because the sign is pre-computed) */
 302          Rxy = MULT16_16_Q15(Rxy,Rxy);
 303          /* The idea is to check for num/den >= best_num/best_den, but that way
 304             we can do it without any division */
 305          /* OPT: Make sure to use conditional moves here */
 306          if (MULT16_16(best_den, Rxy) > MULT16_16(Ryy, best_num))
 307          {
 308             best_den = Ryy;
 309             best_num = Rxy;
 310             best_id = j;
 311          }
 312       } while (++j<N);
 313
 314       j = best_id;
 315       is = pulsesAtOnce;
 316       s = SHL16(is, yshift);
 317
 318       /* Updating the sums of the new pulse(s) */
 319       xy = xy + MULT16_16(s,X[j]);
 320       /* We're multiplying y[j] by two so we don't have to do it here */
 321       yy = yy + MULT16_16(s,y[j]);
 322
 323       /* Only now that we've made the final choice, update y/iy */
 324       /* Multiplying y[j] by 2 so we don't have to do it everywhere else */
 325       y[j] += 2*s;
 326       iy[j] += is;
 327       pulsesLeft -= pulsesAtOnce;
 328    }
 329
 330    /* Put the original sign back */
 331    j=0;
 332    do {
 333       X[j] = MULT16_16(signx[j],X[j]);
 334       if (signx[j] < 0)
 335          iy[j] = -iy[j];
 336    } while (++j<N);
 337    encode_pulses(iy, N, K, enc);
 338
 339    if (resynth)
 340    {
 341       normalise_residual(iy, X, N, K, EXTRACT16(SHR32(yy,2*yshift)));
 342       exp_rotation(X, N, -1, B, K, spread);
 343    }
 344    RESTORE_STACK;
 345 }
 346
 347
 348 /** Decode pulse vector and combine the result with the pitch vector to produce
 349     the final normalised signal in the current band. */
 350 void alg_unquant(celt_norm *X, int N, int K, int spread, int B, celt_norm *lowband, ec_dec *dec, celt_int32 *seed)
 351 {
 352    int i;
 353    celt_word32 Ryy;
 354    VARDECL(int, iy);
 355    SAVE_STACK;
 356
 357    if (K==0)
 358    {
 359       if (lowband != NULL)
 360       {
 361          for (i=0;i<N;i++)
 362             X[i] = lowband[i];
 363       } else {
 364          /* This is important for encoding the side in stereo mode */
 365          for (i=0;i<N;i++)
 366          {
 367             *seed = lcg_rand(*seed);
 368             X[i] = (int)(*seed)>>20;
 369          }
 370       }
 371       renormalise_vector(X, Q15ONE, N, 1);
 372       return;
 373    }
 374    K = get_pulses(K);
 375    ALLOC(iy, N, int);
 376    decode_pulses(iy, N, K, dec);
 377    Ryy = 0;
 378    i=0;
 379    do {
 380       Ryy = MAC16_16(Ryy, iy[i], iy[i]);
 381    } while (++i < N);
 382    normalise_residual(iy, X, N, K, Ryy);
 383    exp_rotation(X, N, -1, B, K, spread);
 384    RESTORE_STACK;
 385 }
 386
 387 celt_word16 renormalise_vector(celt_norm *X, celt_word16 value, int N, int stride)
 388 {
 389    int i;
 390 #ifdef FIXED_POINT
 391    int k;
 392 #endif
 393    celt_word32 E = EPSILON;
 394    celt_word16 g;
 395    celt_word32 t;
 396    celt_norm *xptr = X;
 397    for (i=0;i<N;i++)
 398    {
 399       E = MAC16_16(E, *xptr, *xptr);
 400       xptr += stride;
 401    }
 402 #ifdef FIXED_POINT
 403    k = celt_ilog2(E)>>1;
 404 #endif
 405    t = VSHR32(E, (k-7)<<1);
 406    g = MULT16_16_Q15(value, celt_rsqrt_norm(t));
 407
 408    xptr = X;
 409    for (i=0;i<N;i++)
 410    {
 411       *xptr = EXTRACT16(PSHR32(MULT16_16(g, *xptr), k+1));
 412       xptr += stride;
 413    }
 414    return celt_sqrt(E);
 415 }
 416