Renamed celt_word* to opus_val*
[opus.git] / libcelt / vq.c
index c7ece7d..58173d8 100644 (file)
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.
    
-   - Neither the name of the Xiph.org Foundation nor the names of its
-   contributors may be used to endorse or promote products derived from
-   this software without specific prior written permission.
-   
    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 #include "vq.h"
 #include "arch.h"
 #include "os_support.h"
+#include "bands.h"
 #include "rate.h"
 
 #ifndef M_PI
 #define M_PI 3.141592653
 #endif
 
-static void exp_rotation(celt_norm_t *X, int len, int dir, int stride, int K)
+static void exp_rotation1(celt_norm *X, int len, int stride, opus_val16 c, opus_val16 s)
+{
+   int i;
+   celt_norm *Xptr;
+   Xptr = X;
+   for (i=0;i<len-stride;i++)
+   {
+      celt_norm x1, x2;
+      x1 = Xptr[0];
+      x2 = Xptr[stride];
+      Xptr[stride] = EXTRACT16(SHR32(MULT16_16(c,x2) + MULT16_16(s,x1), 15));
+      *Xptr++      = EXTRACT16(SHR32(MULT16_16(c,x1) - MULT16_16(s,x2), 15));
+   }
+   Xptr = &X[len-2*stride-1];
+   for (i=len-2*stride-1;i>=0;i--)
+   {
+      celt_norm x1, x2;
+      x1 = Xptr[0];
+      x2 = Xptr[stride];
+      Xptr[stride] = EXTRACT16(SHR32(MULT16_16(c,x2) + MULT16_16(s,x1), 15));
+      *Xptr--      = EXTRACT16(SHR32(MULT16_16(c,x1) - MULT16_16(s,x2), 15));
+   }
+}
+
+static void exp_rotation(celt_norm *X, int len, int dir, int stride, int K, int spread)
 {
-   int i, k, iter;
-   celt_word16_t c, s;
-   celt_word16_t gain, theta;
-   celt_norm_t *Xptr;
-   gain = celt_div((celt_word32_t)MULT16_16(Q15_ONE,len),(celt_word32_t)(3+len+6*K));
-   /* FIXME: Make that HALF16 instead of HALF32 */
-   theta = SUB16(Q15ONE, HALF32(MULT16_16_Q15(gain,gain)));
-   /*if (len==30)
+   static const int SPREAD_FACTOR[3]={15,10,5};
+   int i;
+   opus_val16 c, s;
+   opus_val16 gain, theta;
+   int stride2=0;
+   int factor;
+   /*int i;
+   if (len>=30)
    {
-   for (i=0;i<len;i++)
-   X[i] = 0;
-   X[14] = 1;
-}*/ 
+      for (i=0;i<len;i++)
+         X[i] = 0;
+      X[14] = 1;
+      K=5;
+   }*/
+   if (2*K>=len || spread==SPREAD_NONE)
+      return;
+   factor = SPREAD_FACTOR[spread-1];
+
+   gain = celt_div((opus_val32)MULT16_16(Q15_ONE,len),(opus_val32)(len+factor*K));
+   theta = HALF16(MULT16_16_Q15(gain,gain));
+
    c = celt_cos_norm(EXTEND32(theta));
-   s = dir*celt_cos_norm(EXTEND32(SUB16(Q15ONE,theta))); /*  sin(theta) */
-   if (len > 8*stride)
-      stride *= len/(8*stride);
-   iter = 1;
-   for (k=0;k<iter;k++)
+   s = celt_cos_norm(EXTEND32(SUB16(Q15ONE,theta))); /*  sin(theta) */
+
+   if (len>=8*stride)
    {
-      /* We could use MULT16_16_P15 instead of MULT16_16_Q15 for more accuracy, 
-      but at this point, I really don't think it's necessary */
-      Xptr = X;
-      for (i=0;i<len-stride;i++)
-      {
-         celt_norm_t x1, x2;
-         x1 = Xptr[0];
-         x2 = Xptr[stride];
-         Xptr[stride] = MULT16_16_Q15(c,x2) + MULT16_16_Q15(s,x1);
-         *Xptr++      = MULT16_16_Q15(c,x1) - MULT16_16_Q15(s,x2);
-      }
-      Xptr = &X[len-2*stride-1];
-      for (i=len-2*stride-1;i>=0;i--)
+      stride2 = 1;
+      /* This is just a simple way of computing sqrt(len/stride) with rounding.
+         It's basically incrementing long as (stride2+0.5)^2 < len/stride.
+         I _think_ it is bit-exact */
+      while ((stride2*stride2+stride2)*stride + (stride>>2) < len)
+         stride2++;
+   }
+   /*TODO: We should be passing around log2(B), not B, for both this and for
+      extract_collapse_mask().*/
+   len /= stride;
+   for (i=0;i<stride;i++)
+   {
+      if (dir < 0)
       {
-         celt_norm_t x1, x2;
-         x1 = Xptr[0];
-         x2 = Xptr[stride];
-         Xptr[stride] = MULT16_16_Q15(c,x2) + MULT16_16_Q15(s,x1);
-         *Xptr--      = MULT16_16_Q15(c,x1) - MULT16_16_Q15(s,x2);
+         if (stride2)
+            exp_rotation1(X+i*len, len, stride2, s, c);
+         exp_rotation1(X+i*len, len, 1, c, s);
+      } else {
+         exp_rotation1(X+i*len, len, 1, c, -s);
+         if (stride2)
+            exp_rotation1(X+i*len, len, stride2, s, -c);
       }
    }
-   /*if (len==30)
+   /*if (len>=30)
    {
-   for (i=0;i<len;i++)
-   printf ("%f ", X[i]);
-   printf ("\n");
-   exit(0);
-}*/
+      for (i=0;i<len;i++)
+         printf ("%f ", X[i]);
+      printf ("\n");
+      exit(0);
+   }*/
 }
 
-
 /** Takes the pitch vector and the decoded residual vector, computes the gain
     that will give ||p+g*y||=1 and mixes the residual with the pitch. */
-static void normalise_residual(int * restrict iy, celt_norm_t * restrict X, int N, int K, celt_word32_t Ryy)
+static void normalise_residual(int * restrict iy, celt_norm * restrict X,
+      int N, opus_val32 Ryy, opus_val16 gain)
 {
    int i;
-   celt_word32_t g;
+#ifdef FIXED_POINT
+   int k;
+#endif
+   opus_val32 t;
+   opus_val16 g;
 
-   g = celt_rsqrt(Ryy);
+#ifdef FIXED_POINT
+   k = celt_ilog2(Ryy)>>1;
+#endif
+   t = VSHR32(Ryy, (k-7)<<1);
+   g = MULT16_16_P15(celt_rsqrt_norm(t),gain);
 
    i=0;
    do
-      X[i] = SHR16(MULT16_16_16(g, iy[i]),1);
+      X[i] = EXTRACT16(PSHR32(MULT16_16(g, iy[i]), k+1));
    while (++i < N);
 }
 
-void alg_quant(celt_norm_t *X, int N, int K, int spread, ec_enc *enc)
+static unsigned extract_collapse_mask(int *iy, int N, int B)
 {
-   VARDECL(celt_norm_t, y);
+   unsigned collapse_mask;
+   int N0;
+   int i;
+   if (B<=1)
+      return 1;
+   /*TODO: We should be passing around log2(B), not B, for both this and for
+      exp_rotation().*/
+   N0 = N/B;
+   collapse_mask = 0;
+   i=0; do {
+      int j;
+      j=0; do {
+         collapse_mask |= (iy[i*N0+j]!=0)<<i;
+      } while (++j<N0);
+   } while (++i<B);
+   return collapse_mask;
+}
+
+unsigned alg_quant(celt_norm *X, int N, int K, int spread, int B,
+      int resynth, ec_enc *enc, opus_val16 gain)
+{
+   VARDECL(celt_norm, y);
    VARDECL(int, iy);
-   VARDECL(celt_word16_t, signx);
-   int j, is;
-   celt_word16_t s;
+   VARDECL(opus_val16, signx);
+   int i, j;
+   opus_val16 s;
    int pulsesLeft;
-   celt_word32_t sum;
-   celt_word32_t xy, yy;
-   int N_1; /* Inverse of N, in Q14 format (even for float) */
-#ifdef FIXED_POINT
-   int yshift;
-#endif
+   opus_val32 sum;
+   opus_val32 xy;
+   opus_val16 yy;
+   unsigned collapse_mask;
    SAVE_STACK;
 
-   K = get_pulses(K);
-#ifdef FIXED_POINT
-   yshift = 13-celt_ilog2(K);
-#endif
+   celt_assert2(K!=0, "alg_quant() needs at least one pulse");
 
-   ALLOC(y, N, celt_norm_t);
+   ALLOC(y, N, celt_norm);
    ALLOC(iy, N, int);
-   ALLOC(signx, N, celt_word16_t);
-   N_1 = 512/N;
+   ALLOC(signx, N, opus_val16);
    
-   if (spread)
-      exp_rotation(X, N, 1, spread, K);
+   exp_rotation(X, N, 1, B, K, spread);
 
+   /* Get rid of the sign */
    sum = 0;
    j=0; do {
       if (X[j]>0)
@@ -161,16 +213,18 @@ void alg_quant(celt_norm_t *X, int N, int K, int spread, ec_enc *enc)
    /* Do a pre-search by projecting on the pyramid */
    if (K > (N>>1))
    {
-      celt_word16_t rcp;
-      sum=0;
+      opus_val16 rcp;
       j=0; do {
          sum += X[j];
       }  while (++j<N);
 
+      /* If X is too small, just replace it with a pulse at 0 */
 #ifdef FIXED_POINT
       if (sum <= K)
 #else
-      if (sum <= EPSILON)
+      /* Prevents infinities and NaNs from causing too many pulses
+         to be allocated. 64 is an approximation of infinity here. */
+      if (!(sum > EPSILON && sum < 64))
 #endif
       {
          X[0] = QCONST16(1.f,14);
@@ -186,9 +240,9 @@ void alg_quant(celt_norm_t *X, int N, int K, int spread, ec_enc *enc)
          /* It's really important to round *towards zero* here */
          iy[j] = MULT16_16_Q15(X[j],rcp);
 #else
-         iy[j] = floor(rcp*X[j]);
+         iy[j] = (int)floor(rcp*X[j]);
 #endif
-         y[j] = SHL16(iy[j],yshift);
+         y[j] = iy[j];
          yy = MAC16_16(yy, y[j],y[j]);
          xy = MAC16_16(xy, X[j],y[j]);
          y[j] *= 2;
@@ -197,46 +251,49 @@ void alg_quant(celt_norm_t *X, int N, int K, int spread, ec_enc *enc)
    }
    celt_assert2(pulsesLeft>=1, "Allocated too many pulses in the quick pass");
 
-   while (pulsesLeft > 0)
+   /* This should never happen, but just in case it does (e.g. on silence)
+      we fill the first bin with pulses. */
+#ifdef FIXED_POINT_DEBUG
+   celt_assert2(pulsesLeft<=N+3, "Not enough pulses in the quick pass");
+#endif
+   if (pulsesLeft > N+3)
+   {
+      opus_val16 tmp = pulsesLeft;
+      yy = MAC16_16(yy, tmp, tmp);
+      yy = MAC16_16(yy, tmp, y[0]);
+      iy[0] += pulsesLeft;
+      pulsesLeft=0;
+   }
+
+   s = 1;
+   for (i=0;i<pulsesLeft;i++)
    {
-      int pulsesAtOnce=1;
       int best_id;
-      celt_word16_t magnitude;
-      celt_word32_t best_num = -VERY_LARGE16;
-      celt_word16_t best_den = 0;
+      opus_val32 best_num = -VERY_LARGE16;
+      opus_val16 best_den = 0;
 #ifdef FIXED_POINT
       int rshift;
 #endif
-      /* Decide on how many pulses to find at once */
-      pulsesAtOnce = (pulsesLeft*N_1)>>9; /* pulsesLeft/N */
-      if (pulsesAtOnce<1)
-         pulsesAtOnce = 1;
 #ifdef FIXED_POINT
-      rshift = yshift+1+celt_ilog2(K-pulsesLeft+pulsesAtOnce);
+      rshift = 1+celt_ilog2(K-pulsesLeft+i+1);
 #endif
-      magnitude = SHL16(pulsesAtOnce, yshift);
-
       best_id = 0;
       /* The squared magnitude term gets added anyway, so we might as well 
          add it outside the loop */
-      yy = MAC16_16(yy, magnitude,magnitude);
-      /* Choose between fast and accurate strategy depending on where we are in the search */
-         /* This should ensure that anything we can process will have a better score */
+      yy = ADD32(yy, 1);
       j=0;
       do {
-         celt_word16_t Rxy, Ryy;
-         /* Select sign based on X[j] alone */
-         s = magnitude;
+         opus_val16 Rxy, Ryy;
          /* Temporary sums of the new pulse(s) */
-         Rxy = EXTRACT16(SHR32(MAC16_16(xy, s,X[j]),rshift));
+         Rxy = EXTRACT16(SHR32(ADD32(xy, EXTEND32(X[j])),rshift));
          /* We're multiplying y[j] by two so we don't have to do it here */
-         Ryy = EXTRACT16(SHR32(MAC16_16(yy, s,y[j]),rshift));
-            
-            /* Approximate score: we maximise Rxy/sqrt(Ryy) (we're guaranteed that 
-         Rxy is positive because the sign is pre-computed) */
+         Ryy = ADD16(yy, y[j]);
+
+         /* Approximate score: we maximise Rxy/sqrt(Ryy) (we're guaranteed that
+            Rxy is positive because the sign is pre-computed) */
          Rxy = MULT16_16_Q15(Rxy,Rxy);
-            /* The idea is to check for num/den >= best_num/best_den, but that way
-         we can do it without any division */
+         /* The idea is to check for num/den >= best_num/best_den, but that way
+            we can do it without any division */
          /* OPT: Make sure to use conditional moves here */
          if (MULT16_16(best_den, Rxy) > MULT16_16(Ryy, best_num))
          {
@@ -246,21 +303,18 @@ void alg_quant(celt_norm_t *X, int N, int K, int spread, ec_enc *enc)
          }
       } while (++j<N);
       
-      j = best_id;
-      is = pulsesAtOnce;
-      s = SHL16(is, yshift);
-
       /* Updating the sums of the new pulse(s) */
-      xy = xy + MULT16_16(s,X[j]);
+      xy = ADD32(xy, EXTEND32(X[best_id]));
       /* We're multiplying y[j] by two so we don't have to do it here */
-      yy = yy + MULT16_16(s,y[j]);
+      yy = ADD16(yy, y[best_id]);
 
       /* Only now that we've made the final choice, update y/iy */
       /* Multiplying y[j] by 2 so we don't have to do it everywhere else */
-      y[j] += 2*s;
-      iy[j] += is;
-      pulsesLeft -= pulsesAtOnce;
+      y[best_id] += 2*s;
+      iy[best_id]++;
    }
+
+   /* Put the original sign back */
    j=0;
    do {
       X[j] = MULT16_16(signx[j],X[j]);
@@ -269,24 +323,29 @@ void alg_quant(celt_norm_t *X, int N, int K, int spread, ec_enc *enc)
    } while (++j<N);
    encode_pulses(iy, N, K, enc);
    
-   /* Recompute the gain in one pass to reduce the encoder-decoder mismatch
-   due to the recursive computation used in quantisation. */
-   normalise_residual(iy, X, N, K, EXTRACT16(SHR32(yy,2*yshift)));
-   if (spread)
-      exp_rotation(X, N, -1, spread, K);
+   if (resynth)
+   {
+      normalise_residual(iy, X, N, yy, gain);
+      exp_rotation(X, N, -1, B, K, spread);
+   }
+   collapse_mask = extract_collapse_mask(iy, N, B);
    RESTORE_STACK;
+   return collapse_mask;
 }
 
 
 /** Decode pulse vector and combine the result with the pitch vector to produce
     the final normalised signal in the current band. */
-void alg_unquant(celt_norm_t *X, int N, int K, int spread, ec_dec *dec)
+unsigned alg_unquant(celt_norm *X, int N, int K, int spread, int B,
+      ec_dec *dec, opus_val16 gain)
 {
    int i;
-   celt_word32_t Ryy;
+   opus_val32 Ryy;
+   unsigned collapse_mask;
    VARDECL(int, iy);
    SAVE_STACK;
-   K = get_pulses(K);
+
+   celt_assert2(K!=0, "alg_unquant() needs at least one pulse");
    ALLOC(iy, N, int);
    decode_pulses(iy, N, K, dec);
    Ryy = 0;
@@ -294,69 +353,79 @@ void alg_unquant(celt_norm_t *X, int N, int K, int spread, ec_dec *dec)
    do {
       Ryy = MAC16_16(Ryy, iy[i], iy[i]);
    } while (++i < N);
-   normalise_residual(iy, X, N, K, Ryy);
-   if (spread)
-      exp_rotation(X, N, -1, spread, K);
+   normalise_residual(iy, X, N, Ryy, gain);
+   exp_rotation(X, N, -1, B, K, spread);
+   collapse_mask = extract_collapse_mask(iy, N, B);
    RESTORE_STACK;
+   return collapse_mask;
 }
 
-celt_word16_t renormalise_vector(celt_norm_t *X, celt_word16_t value, int N, int stride)
+void renormalise_vector(celt_norm *X, int N, opus_val16 gain)
 {
    int i;
-   celt_word32_t E = EPSILON;
-   celt_word16_t rE;
-   celt_word16_t g;
-   celt_norm_t *xptr = X;
+#ifdef FIXED_POINT
+   int k;
+#endif
+   opus_val32 E = EPSILON;
+   opus_val16 g;
+   opus_val32 t;
+   celt_norm *xptr = X;
    for (i=0;i<N;i++)
    {
       E = MAC16_16(E, *xptr, *xptr);
-      xptr += stride;
+      xptr++;
    }
-
-   rE = celt_sqrt(E);
 #ifdef FIXED_POINT
-   if (rE <= 128)
-      g = Q15ONE;
-   else
+   k = celt_ilog2(E)>>1;
 #endif
-      g = MULT16_16_Q15(value,celt_rcp(SHL32(rE,9)));
+   t = VSHR32(E, (k-7)<<1);
+   g = MULT16_16_P15(celt_rsqrt_norm(t),gain);
+
    xptr = X;
    for (i=0;i<N;i++)
    {
-      *xptr = PSHR32(MULT16_16(g, *xptr),8);
-      xptr += stride;
+      *xptr = EXTRACT16(PSHR32(MULT16_16(g, *xptr), k+1));
+      xptr++;
    }
-   return rE;
+   /*return celt_sqrt(E);*/
 }
 
-static void fold(const CELTMode *m, int N, const celt_norm_t * restrict Y, celt_norm_t * restrict P, int N0, int B)
+int stereo_itheta(celt_norm *X, celt_norm *Y, int stereo, int N)
 {
-   int j;
-   int id = N0 % B;
-   /* Here, we assume that id will never be greater than N0, i.e. that 
-      no band is wider than N0. In the unlikely case it happens, we set
-      everything to zero */
-   /*{
-          int offset = (N0*C - (id+C*N))/2;
-          if (offset > C*N0/16)
-                  offset = C*N0/16;
-          offset -= offset % (C*B);
-          if (offset < 0)
-                  offset = 0;
-          //printf ("%d\n", offset);
-          id += offset;
-   }*/
-   if (id+N>N0)
-      for (j=0;j<N;j++)
-         P[j] = 0;
-   else
-      for (j=0;j<N;j++)
-         P[j] = Y[id++];
-}
+   int i;
+   int itheta;
+   opus_val16 mid, side;
+   opus_val32 Emid, Eside;
 
-void intra_fold(const CELTMode *m, int N, const celt_norm_t * restrict Y, celt_norm_t * restrict P, int N0, int B)
-{
-   fold(m, N, Y, P, N0, B);
-   renormalise_vector(P, Q15ONE, N, 1);
-}
+   Emid = Eside = EPSILON;
+   if (stereo)
+   {
+      for (i=0;i<N;i++)
+      {
+         celt_norm m, s;
+         m = ADD16(SHR16(X[i],1),SHR16(Y[i],1));
+         s = SUB16(SHR16(X[i],1),SHR16(Y[i],1));
+         Emid = MAC16_16(Emid, m, m);
+         Eside = MAC16_16(Eside, s, s);
+      }
+   } else {
+      for (i=0;i<N;i++)
+      {
+         celt_norm m, s;
+         m = X[i];
+         s = Y[i];
+         Emid = MAC16_16(Emid, m, m);
+         Eside = MAC16_16(Eside, s, s);
+      }
+   }
+   mid = celt_sqrt(Emid);
+   side = celt_sqrt(Eside);
+#ifdef FIXED_POINT
+   /* 0.63662 = 2/pi */
+   itheta = MULT16_16_Q15(QCONST16(0.63662f,15),celt_atan2p(side, mid));
+#else
+   itheta = (int)floor(.5f+16384*0.63662f*atan2(side,mid));
+#endif
 
+   return itheta;
+}