Fix misleading comments about ec_{enc|dec}_tell()
[opus.git] / libcelt / bands.c
index 8458245..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, int tf_change, 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;
@@ -502,7 +502,7 @@ static void quant_band(int encode, const CELTMode *m, int i, celt_norm *X, celt_
             if (encode)
             {
                sign = x[0]<0;
-               ec_enc_bits(ec, sign, 1);
+               ec_enc_bits((ec_enc*)ec, sign, 1);
             } else {
                sign = ec_dec_bits((ec_dec*)ec, 1);
             }
@@ -553,6 +553,8 @@ static void quant_band(int encode, const CELTMode *m, int i, celt_norm *X, celt_
       spread0 = spread;
       N_B0 = N_B;
    }
+
+   /* Reorganize the samples in time order instead of frequency order */
    if (!stereo && spread0>1 && level==0)
    {
       if (encode)
@@ -583,6 +585,8 @@ static void quant_band(int encode, const CELTMode *m, int i, celt_norm *X, celt_
       celt_word16 mid, side;
       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--;
@@ -609,8 +613,12 @@ static void quant_band(int encode, const CELTMode *m, int i, celt_norm *X, celt_
             mid = renormalise_vector(X, Q15ONE, N, 1);
             side = renormalise_vector(Y, Q15ONE, N, 1);
 
-            /* 0.63662 = 2/pi */
+            /* 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));
@@ -624,7 +632,7 @@ static void quant_band(int encode, const CELTMode *m, int i, celt_norm *X, celt_
          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);
@@ -647,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;
@@ -685,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;
       }
 
@@ -734,7 +744,7 @@ static void quant_band(int encode, const CELTMode *m, int i, celt_norm *X, celt_
          {
             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;
             }
@@ -801,13 +811,16 @@ static void quant_band(int encode, const CELTMode *m, int i, celt_norm *X, celt_
       }
 
       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;
@@ -831,34 +844,26 @@ static void quant_band(int encode, const CELTMode *m, int i, celt_norm *X, celt_
          if (lowband)
             interleave_vector(lowband, N_B, spread0);
       }
-      if (time_divide)
+
+      /* Undo time-freq changes that we did earlier */
+      N_B = N_B0;
+      spread = spread0;
+      for (k=0;k<time_divide;k++)
       {
-         int k;
-         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);
-         }
+         spread >>= 1;
+         N_B <<= 1;
+         haar1(X, N_B, spread);
+         if (lowband)
+            haar1(lowband, N_B, spread);
       }
 
-      if (!stereo && level == 0)
+      for (k=0;k<recombine;k++)
       {
-         int k;
-         spread = spread0;
-         N_B = N_B0;
-         for (k=0;k<recombine;k++)
-         {
-            haar1(X, N_B, spread);
-            if (lowband)
-               haar1(lowband, N_B, spread);
-            N_B>>=1;
-            spread <<= 1;
-         }
+         haar1(X, N_B, spread);
+         if (lowband)
+            haar1(lowband, N_B, spread);
+         N_B>>=1;
+         spread <<= 1;
       }
 
       if (lowband_out && !stereo)
@@ -879,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 *tf_res, 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;
@@ -890,6 +895,7 @@ void quant_all_bands(int encode, const CELTMode *m, int start, celt_norm *_X, ce
    int spread;
    celt_norm *lowband;
    int update_lowband = 1;
+   int C = _Y != NULL ? 2 : 1;
    SAVE_STACK;
 
    M = 1<<LM;
@@ -916,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);
 
@@ -930,6 +936,9 @@ 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])
       {
@@ -938,12 +947,7 @@ void quant_all_bands(int encode, const CELTMode *m, int start, celt_norm *_X, ce
       } else
          lowband = NULL;
 
-      if (shortBlocks)
-      {
-         tf_change = tf_res[i] ? -1 : 2;
-      } else {
-         tf_change = tf_res[i] ? -2 : 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;