Fix misleading comments about ec_{enc|dec}_tell()
[opus.git] / libcelt / bands.c
index 71be4c7..31d4788 100644 (file)
@@ -469,7 +469,7 @@ static void haar1(celt_norm *X, int N0, int stride)
    in two and transmit the energy difference with the two half-bands. It
    can be called recursively so bands can end up being split in 8 parts. */
 static void quant_band(int encode, const CELTMode *m, int i, celt_norm *X, celt_norm *Y,
-      int N, int b, int spread, celt_norm *lowband, int resynth, ec_enc *ec,
+      int N, int b, int spread, int tf_change, celt_norm *lowband, int resynth, void *ec,
       celt_int32 *remaining_bits, int LM, celt_norm *lowband_out, const celt_ener *bandE, int level)
 {
    int q;
@@ -480,7 +480,8 @@ static void quant_band(int encode, const CELTMode *m, int i, celt_norm *X, celt_
    int N_B=N;
    int N_B0;
    int spread0=spread;
-   int do_haar = 0;
+   int time_divide=0;
+   int recombine=0;
 
    if (spread)
       N_B /= spread;
@@ -488,19 +489,74 @@ static void quant_band(int encode, const CELTMode *m, int i, celt_norm *X, celt_
 
    split = stereo = Y != NULL;
 
-   if (!stereo && spread>1 && level==0)
+   /* Special case for one sample */
+   if (N==1)
    {
-      if ((N_B&1) == 0)
+      int c;
+      celt_norm *x = X;
+      for (c=0;c<1+stereo;c++)
       {
-         spread <<= 1;
-         N_B >>= 1;
-         do_haar = 1;
+         int sign=0;
+         if (b>=1<<BITRES && *remaining_bits>=1<<BITRES)
+         {
+            if (encode)
+            {
+               sign = x[0]<0;
+               ec_enc_bits((ec_enc*)ec, sign, 1);
+            } else {
+               sign = ec_dec_bits((ec_dec*)ec, 1);
+            }
+            *remaining_bits -= 1<<BITRES;
+            b-=1<<BITRES;
+         }
+         if (resynth)
+            x[0] = sign ? -NORM_SCALING : NORM_SCALING;
+         x = Y;
+      }
+      if (lowband_out)
+         lowband_out[0] = X[0];
+      return;
+   }
+
+   /* Band recombining to increase frequency resolution */
+   if (!stereo && spread > 1 && level == 0 && tf_change>0)
+   {
+      while (spread>1 && tf_change>0)
+      {
+         spread>>=1;
+         N_B<<=1;
          if (encode)
-            haar1(X, N_B0, spread0);
+            haar1(X, N_B, spread);
          if (lowband)
-            haar1(lowband, N_B0, spread0);
-         spread0 = spread;
+            haar1(lowband, N_B, spread);
+         recombine++;
+         tf_change--;
       }
+      spread0=spread;
+      N_B0 = N_B;
+   }
+
+   /* Increasing the time resolution */
+   if (!stereo && level==0)
+   {
+      while ((N_B&1) == 0 && tf_change<0 && spread <= (1<<LM))
+      {
+         if (encode)
+            haar1(X, N_B, spread);
+         if (lowband)
+            haar1(lowband, N_B, spread);
+         spread <<= 1;
+         N_B >>= 1;
+         time_divide++;
+         tf_change++;
+      }
+      spread0 = spread;
+      N_B0 = N_B;
+   }
+
+   /* Reorganize the samples in time order instead of frequency order */
+   if (!stereo && spread0>1 && level==0)
+   {
       if (encode)
          deinterleave_vector(X, N_B, spread0);
       if (lowband)
@@ -508,7 +564,7 @@ static void quant_band(int encode, const CELTMode *m, int i, celt_norm *X, celt_
    }
 
    /* If we need more than 32 bits, try splitting the band in two. */
-   if (!stereo && LM != -1 && !fits_in32(N, get_pulses(bits2pulses(m, m->bits[LM][i], N, b))))
+   if (!stereo && LM != -1 && b > 32<<BITRES && N>2)
    {
       if (LM>0 || (N&1)==0)
       {
@@ -523,56 +579,60 @@ static void quant_band(int encode, const CELTMode *m, int i, celt_norm *X, celt_
    if (split)
    {
       int qb;
-      int itheta;
+      int itheta=0;
       int mbits, sbits, delta;
       int qalloc;
       celt_word16 mid, side;
-      if (N>1)
-      {
-         qb = (b-2*(N-1)*(QTHETA_OFFSET-m->logN[i]-(LM<<BITRES)))/(2*(N-1)<<BITRES);
-         if (qb > (b>>(BITRES+1))-1)
-            qb = (b>>(BITRES+1))-1;
-      } else {
-         /* For N==1, allocate two bits for the signs and the rest goes to qb */
-         qb = b-(2<<BITRES);
-      }
+      int offset, N2;
+      offset = m->logN[i]+(LM<<BITRES)-QTHETA_OFFSET;
+
+      /* Decide on the resolution to give to the split parameter theta */
+      N2 = 2*N-1;
+      if (stereo && N>2)
+         N2--;
+      qb = (b+N2*offset)/(N2<<BITRES);
+      if (qb > (b>>(BITRES+1))-1)
+         qb = (b>>(BITRES+1))-1;
+
       if (qb<0)
          qb = 0;
       if (qb>14)
          qb = 14;
 
-      if (encode)
-      {
-         if (stereo)
-            stereo_band_mix(m, X, Y, bandE, qb==0, i, 1, N);
-
-         mid = renormalise_vector(X, Q15ONE, N, 1);
-         side = renormalise_vector(Y, Q15ONE, N, 1);
-
-         /* 0.63662 = 2/pi */
-#ifdef FIXED_POINT
-         itheta = MULT16_16_Q15(QCONST16(0.63662f,15),celt_atan2p(side, mid));
-#else
-         itheta = floor(.5f+16384*0.63662f*atan2(side,mid));
-#endif
-      }
-
       qalloc = 0;
-      if (qb==0)
+      if (qb!=0)
       {
-         itheta=0;
-      } else {
          int shift;
          shift = 14-qb;
 
-         /* Entropy coding of the angle. We use a uniform pdf for the
-            first stereo split but a triangular one for the rest. */
          if (encode)
+         {
+            if (stereo)
+               stereo_band_mix(m, X, Y, bandE, qb==0, i, 1, N);
+
+            mid = renormalise_vector(X, Q15ONE, N, 1);
+            side = renormalise_vector(Y, Q15ONE, N, 1);
+
+            /* theta is the atan() of the ration between the (normalized)
+               side and mid. With just that parameter, we can re-scale both
+               mid and side because we know that 1) they have unit norm and
+               2) they are orthogonal. */
+   #ifdef FIXED_POINT
+            /* 0.63662 = 2/pi */
+            itheta = MULT16_16_Q15(QCONST16(0.63662f,15),celt_atan2p(side, mid));
+   #else
+            itheta = floor(.5f+16384*0.63662f*atan2(side,mid));
+   #endif
+
             itheta = (itheta+(1<<shift>>1))>>shift;
+         }
+
+         /* Entropy coding of the angle. We use a uniform pdf for the
+            first stereo split but a triangular one for the rest. */
          if (stereo || qb>9 || spread>1)
          {
             if (encode)
-               ec_enc_uint(ec, itheta, (1<<qb)+1);
+               ec_enc_uint((ec_enc*)ec, itheta, (1<<qb)+1);
             else
                itheta = ec_dec_uint((ec_dec*)ec, (1<<qb)+1);
             qalloc = log2_frac((1<<qb)+1,BITRES);
@@ -595,7 +655,7 @@ static void quant_band(int encode, const CELTMode *m, int i, celt_norm *X, celt_
                      fs--;
                   j++;
                }
-               ec_encode(ec, fl, fl+fs, ft);
+               ec_encode((ec_enc*)ec, fl, fl+fs, ft);
             } else {
                int fl=0;
                int j, fm;
@@ -633,6 +693,8 @@ static void quant_band(int encode, const CELTMode *m, int i, celt_norm *X, celt_
       } else {
          imid = bitexact_cos(itheta);
          iside = bitexact_cos(16384-itheta);
+         /* This is the mid vs side allocation that minimizes squared error
+            in that band. */
          delta = (N-1)*(log2_frac(iside,BITRES+2)-log2_frac(imid,BITRES+2))>>2;
       }
 
@@ -677,12 +739,12 @@ static void quant_band(int encode, const CELTMode *m, int i, celt_norm *X, celt_
             else
                sign = -1;
          }
-         quant_band(encode, m, i, v, NULL, N, mbits, spread, lowband, resynth, ec, remaining_bits, LM, lowband_out, NULL, level+1);
+         quant_band(encode, m, i, v, NULL, N, mbits, spread, tf_change, lowband, resynth, ec, remaining_bits, LM, lowband_out, NULL, level+1);
          if (sbits)
          {
             if (encode)
             {
-               ec_enc_bits(ec, sign==1, 1);
+               ec_enc_bits((ec_enc*)ec, sign==1, 1);
             } else {
                sign = 2*ec_dec_bits((ec_dec*)ec, 1)-1;
             }
@@ -729,8 +791,8 @@ static void quant_band(int encode, const CELTMode *m, int i, celt_norm *X, celt_
          else
             next_level = level+1;
 
-         quant_band(encode, m, i, X, NULL, N, mbits, spread, lowband, resynth, ec, remaining_bits, LM, next_lowband_out1, NULL, next_level);
-         quant_band(encode, m, i, Y, NULL, N, sbits, spread, next_lowband2, resynth, ec, remaining_bits, LM, NULL, NULL, level);
+         quant_band(encode, m, i, X, NULL, N, mbits, spread, tf_change, lowband, resynth, ec, remaining_bits, LM, next_lowband_out1, NULL, next_level);
+         quant_band(encode, m, i, Y, NULL, N, sbits, spread, tf_change, next_lowband2, resynth, ec, remaining_bits, LM, NULL, NULL, level);
       }
 
    } else {
@@ -748,18 +810,17 @@ static void quant_band(int encode, const CELTMode *m, int i, celt_norm *X, celt_
          *remaining_bits -= curr_bits;
       }
 
-      /* Making sure we will *never* need more than 32 bits for the PVQ */
-      while (!fits_in32(N, get_pulses(q)))
-         q--;
-
       if (encode)
-         alg_quant(X, N, q, spread, lowband, resynth, ec);
+         alg_quant(X, N, q, spread, lowband, resynth, (ec_enc*)ec);
       else
          alg_unquant(X, N, q, spread, lowband, (ec_dec*)ec);
    }
 
+   /* This code is used by the decoder and by the resynthesis-enabled encoder */
    if (resynth)
    {
+      int k;
+
       if (split)
       {
          int j;
@@ -777,18 +838,32 @@ static void quant_band(int encode, const CELTMode *m, int i, celt_norm *X, celt_
             Y[j] = MULT16_16_Q15(Y[j], side);
       }
 
-
       if (!stereo && spread0>1 && level==0)
       {
          interleave_vector(X, N_B, spread0);
          if (lowband)
             interleave_vector(lowband, N_B, spread0);
-         if (do_haar)
-         {
-            haar1(X, N_B0, spread0>>1);
-            if (lowband)
-               haar1(lowband, N_B0, spread0>>1);
-         }
+      }
+
+      /* Undo time-freq changes that we did earlier */
+      N_B = N_B0;
+      spread = spread0;
+      for (k=0;k<time_divide;k++)
+      {
+         spread >>= 1;
+         N_B <<= 1;
+         haar1(X, N_B, spread);
+         if (lowband)
+            haar1(lowband, N_B, spread);
+      }
+
+      for (k=0;k<recombine;k++)
+      {
+         haar1(X, N_B, spread);
+         if (lowband)
+            haar1(lowband, N_B, spread);
+         N_B>>=1;
+         spread <<= 1;
       }
 
       if (lowband_out && !stereo)
@@ -809,7 +884,7 @@ static void quant_band(int encode, const CELTMode *m, int i, celt_norm *X, celt_
    }
 }
 
-void quant_all_bands(int encode, const CELTMode *m, int start, celt_norm *_X, celt_norm *_Y, const celt_ener *bandE, int *pulses, int shortBlocks, int fold, int resynth, int total_bits, ec_enc *ec, int LM)
+void quant_all_bands(int encode, const CELTMode *m, int start, celt_norm *_X, celt_norm *_Y, const celt_ener *bandE, int *pulses, int shortBlocks, int fold, int *tf_res, int resynth, int total_bits, void *ec, int LM)
 {
    int i, remaining_bits, balance;
    const celt_int16 * restrict eBands = m->eBands;
@@ -818,6 +893,9 @@ void quant_all_bands(int encode, const CELTMode *m, int start, celt_norm *_X, ce
    int B;
    int M;
    int spread;
+   celt_norm *lowband;
+   int update_lowband = 1;
+   int C = _Y != NULL ? 2 : 1;
    SAVE_STACK;
 
    M = 1<<LM;
@@ -827,6 +905,7 @@ void quant_all_bands(int encode, const CELTMode *m, int start, celt_norm *_X, ce
    norm = _norm;
 
    balance = 0;
+   lowband = NULL;
    for (i=start;i<m->nbEBands;i++)
    {
       int tell;
@@ -834,7 +913,7 @@ void quant_all_bands(int encode, const CELTMode *m, int start, celt_norm *_X, ce
       int N;
       int curr_balance;
       celt_norm * restrict X, * restrict Y;
-      celt_norm *lowband;
+      int tf_change=0;
       
       X = _X+M*eBands[i];
       if (_Y!=NULL)
@@ -843,7 +922,7 @@ void quant_all_bands(int encode, const CELTMode *m, int start, celt_norm *_X, ce
          Y = NULL;
       N = M*eBands[i+1]-M*eBands[i];
       if (encode)
-         tell = ec_enc_tell(ec, BITRES);
+         tell = ec_enc_tell((ec_enc*)ec, BITRES);
       else
          tell = ec_dec_tell((ec_dec*)ec, BITRES);
 
@@ -857,14 +936,24 @@ void quant_all_bands(int encode, const CELTMode *m, int start, celt_norm *_X, ce
       b = IMIN(remaining_bits+1,pulses[i]+curr_balance);
       if (b<0)
          b = 0;
+      /* Prevents ridiculous bit depths */
+      if (b > C*16*N<<BITRES)
+         b = C*16*N<<BITRES;
 
       if (M*eBands[i]-N >= M*eBands[start])
-         lowband = norm+M*eBands[i]-N;
-      else
+      {
+         if (update_lowband)
+            lowband = norm+M*eBands[i]-N;
+      } else
          lowband = NULL;
-      quant_band(encode, m, i, X, Y, N, b, spread, lowband, resynth, ec, &remaining_bits, LM, norm+M*eBands[i], bandE, 0);
+
+      tf_change = tf_res[i];
+      quant_band(encode, m, i, X, Y, N, b, spread, tf_change, lowband, resynth, ec, &remaining_bits, LM, norm+M*eBands[i], bandE, 0);
 
       balance += pulses[i] + tell;
+
+      /* Update the folding position only as long as we have 2 bit/sample depth */
+      update_lowband = (b>>BITRES)>2*N;
    }
    RESTORE_STACK;
 }