opus_pvq: remove outdated/incorrect comments and redundant variables
[ffmpeg.git] / libavcodec / opus_pvq.c
1 /*
2  * Copyright (c) 2007-2008 CSIRO
3  * Copyright (c) 2007-2009 Xiph.Org Foundation
4  * Copyright (c) 2008-2009 Gregory Maxwell
5  * Copyright (c) 2012 Andrew D'Addesio
6  * Copyright (c) 2013-2014 Mozilla Corporation
7  * Copyright (c) 2017 Rostislav Pehlivanov <atomnuker@gmail.com>
8  *
9  * This file is part of FFmpeg.
10  *
11  * FFmpeg is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU Lesser General Public
13  * License as published by the Free Software Foundation; either
14  * version 2.1 of the License, or (at your option) any later version.
15  *
16  * FFmpeg is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19  * Lesser General Public License for more details.
20  *
21  * You should have received a copy of the GNU Lesser General Public
22  * License along with FFmpeg; if not, write to the Free Software
23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24  */
25
26 #include "opustab.h"
27 #include "opus_pvq.h"
28
29 #define CELT_PVQ_U(n, k) (ff_celt_pvq_u_row[FFMIN(n, k)][FFMAX(n, k)])
30 #define CELT_PVQ_V(n, k) (CELT_PVQ_U(n, k) + CELT_PVQ_U(n, (k) + 1))
31
32 static inline int16_t celt_cos(int16_t x)
33 {
34     x = (MUL16(x, x) + 4096) >> 13;
35     x = (32767-x) + ROUND_MUL16(x, (-7651 + ROUND_MUL16(x, (8277 + ROUND_MUL16(-626, x)))));
36     return x + 1;
37 }
38
39 static inline int celt_log2tan(int isin, int icos)
40 {
41     int lc, ls;
42     lc = opus_ilog(icos);
43     ls = opus_ilog(isin);
44     icos <<= 15 - lc;
45     isin <<= 15 - ls;
46     return (ls << 11) - (lc << 11) +
47            ROUND_MUL16(isin, ROUND_MUL16(isin, -2597) + 7932) -
48            ROUND_MUL16(icos, ROUND_MUL16(icos, -2597) + 7932);
49 }
50
51 static inline int celt_bits2pulses(const uint8_t *cache, int bits)
52 {
53     // TODO: Find the size of cache and make it into an array in the parameters list
54     int i, low = 0, high;
55
56     high = cache[0];
57     bits--;
58
59     for (i = 0; i < 6; i++) {
60         int center = (low + high + 1) >> 1;
61         if (cache[center] >= bits)
62             high = center;
63         else
64             low = center;
65     }
66
67     return (bits - (low == 0 ? -1 : cache[low]) <= cache[high] - bits) ? low : high;
68 }
69
70 static inline int celt_pulses2bits(const uint8_t *cache, int pulses)
71 {
72     // TODO: Find the size of cache and make it into an array in the parameters list
73    return (pulses == 0) ? 0 : cache[pulses] + 1;
74 }
75
76 static inline void celt_normalize_residual(const int * av_restrict iy, float * av_restrict X,
77                                            int N, float g)
78 {
79     int i;
80     for (i = 0; i < N; i++)
81         X[i] = g * iy[i];
82 }
83
84 static void celt_exp_rotation_impl(float *X, uint32_t len, uint32_t stride,
85                                    float c, float s)
86 {
87     float *Xptr;
88     int i;
89
90     Xptr = X;
91     for (i = 0; i < len - stride; i++) {
92         float x1     = Xptr[0];
93         float x2     = Xptr[stride];
94         Xptr[stride] = c * x2 + s * x1;
95         *Xptr++      = c * x1 - s * x2;
96     }
97
98     Xptr = &X[len - 2 * stride - 1];
99     for (i = len - 2 * stride - 1; i >= 0; i--) {
100         float x1     = Xptr[0];
101         float x2     = Xptr[stride];
102         Xptr[stride] = c * x2 + s * x1;
103         *Xptr--      = c * x1 - s * x2;
104     }
105 }
106
107 static inline void celt_exp_rotation(float *X, uint32_t len,
108                                      uint32_t stride, uint32_t K,
109                                      enum CeltSpread spread, const int encode)
110 {
111     uint32_t stride2 = 0;
112     float c, s;
113     float gain, theta;
114     int i;
115
116     if (2*K >= len || spread == CELT_SPREAD_NONE)
117         return;
118
119     gain = (float)len / (len + (20 - 5*spread) * K);
120     theta = M_PI * gain * gain / 4;
121
122     c = cosf(theta);
123     s = sinf(theta);
124
125     if (len >= stride << 3) {
126         stride2 = 1;
127         /* This is just a simple (equivalent) way of computing sqrt(len/stride) with rounding.
128         It's basically incrementing long as (stride2+0.5)^2 < len/stride. */
129         while ((stride2 * stride2 + stride2) * stride + (stride >> 2) < len)
130             stride2++;
131     }
132
133     len /= stride;
134     for (i = 0; i < stride; i++) {
135         if (encode) {
136             celt_exp_rotation_impl(X + i * len, len, 1, c, -s);
137             if (stride2)
138                 celt_exp_rotation_impl(X + i * len, len, stride2, s, -c);
139         } else {
140             if (stride2)
141                 celt_exp_rotation_impl(X + i * len, len, stride2, s, c);
142             celt_exp_rotation_impl(X + i * len, len, 1, c, s);
143         }
144     }
145 }
146
147 static inline uint32_t celt_extract_collapse_mask(const int *iy, uint32_t N, uint32_t B)
148 {
149     int i, j, N0 = N / B;
150     uint32_t collapse_mask = 0;
151
152     if (B <= 1)
153         return 1;
154
155     for (i = 0; i < B; i++)
156         for (j = 0; j < N0; j++)
157             collapse_mask |= (!!iy[i*N0+j]) << i;
158     return collapse_mask;
159 }
160
161 static inline void celt_stereo_merge(float *X, float *Y, float mid, int N)
162 {
163     int i;
164     float xp = 0, side = 0;
165     float E[2];
166     float mid2;
167     float gain[2];
168
169     /* Compute the norm of X+Y and X-Y as |X|^2 + |Y|^2 +/- sum(xy) */
170     for (i = 0; i < N; i++) {
171         xp   += X[i] * Y[i];
172         side += Y[i] * Y[i];
173     }
174
175     /* Compensating for the mid normalization */
176     xp *= mid;
177     mid2 = mid;
178     E[0] = mid2 * mid2 + side - 2 * xp;
179     E[1] = mid2 * mid2 + side + 2 * xp;
180     if (E[0] < 6e-4f || E[1] < 6e-4f) {
181         for (i = 0; i < N; i++)
182             Y[i] = X[i];
183         return;
184     }
185
186     gain[0] = 1.0f / sqrtf(E[0]);
187     gain[1] = 1.0f / sqrtf(E[1]);
188
189     for (i = 0; i < N; i++) {
190         float value[2];
191         /* Apply mid scaling (side is already scaled) */
192         value[0] = mid * X[i];
193         value[1] = Y[i];
194         X[i] = gain[0] * (value[0] - value[1]);
195         Y[i] = gain[1] * (value[0] + value[1]);
196     }
197 }
198
199 static void celt_interleave_hadamard(float *tmp, float *X, int N0,
200                                      int stride, int hadamard)
201 {
202     int i, j, N = N0*stride;
203     const uint8_t *order = &ff_celt_hadamard_order[hadamard ? stride - 2 : 30];
204
205     for (i = 0; i < stride; i++)
206         for (j = 0; j < N0; j++)
207             tmp[j*stride+i] = X[order[i]*N0+j];
208
209     memcpy(X, tmp, N*sizeof(float));
210 }
211
212 static void celt_deinterleave_hadamard(float *tmp, float *X, int N0,
213                                        int stride, int hadamard)
214 {
215     int i, j, N = N0*stride;
216     const uint8_t *order = &ff_celt_hadamard_order[hadamard ? stride - 2 : 30];
217
218     for (i = 0; i < stride; i++)
219         for (j = 0; j < N0; j++)
220             tmp[order[i]*N0+j] = X[j*stride+i];
221
222     memcpy(X, tmp, N*sizeof(float));
223 }
224
225 static void celt_haar1(float *X, int N0, int stride)
226 {
227     int i, j;
228     N0 >>= 1;
229     for (i = 0; i < stride; i++) {
230         for (j = 0; j < N0; j++) {
231             float x0 = X[stride * (2 * j + 0) + i];
232             float x1 = X[stride * (2 * j + 1) + i];
233             X[stride * (2 * j + 0) + i] = (x0 + x1) * M_SQRT1_2;
234             X[stride * (2 * j + 1) + i] = (x0 - x1) * M_SQRT1_2;
235         }
236     }
237 }
238
239 static inline int celt_compute_qn(int N, int b, int offset, int pulse_cap,
240                                   int stereo)
241 {
242     int qn, qb;
243     int N2 = 2 * N - 1;
244     if (stereo && N == 2)
245         N2--;
246
247     /* The upper limit ensures that in a stereo split with itheta==16384, we'll
248      * always have enough bits left over to code at least one pulse in the
249      * side; otherwise it would collapse, since it doesn't get folded. */
250     qb = FFMIN3(b - pulse_cap - (4 << 3), (b + N2 * offset) / N2, 8 << 3);
251     qn = (qb < (1 << 3 >> 1)) ? 1 : ((ff_celt_qn_exp2[qb & 0x7] >> (14 - (qb >> 3))) + 1) >> 1 << 1;
252     return qn;
253 }
254
255 /* Convert the quantized vector to an index */
256 static inline uint32_t celt_icwrsi(uint32_t N, uint32_t K, const int *y)
257 {
258     int i, idx = 0, sum = 0;
259     for (i = N - 1; i >= 0; i--) {
260         const uint32_t i_s = CELT_PVQ_U(N - i, sum + FFABS(y[i]) + 1);
261         idx += CELT_PVQ_U(N - i, sum) + (y[i] < 0)*i_s;
262         sum += FFABS(y[i]);
263     }
264     return idx;
265 }
266
267 // this code was adapted from libopus
268 static inline uint64_t celt_cwrsi(uint32_t N, uint32_t K, uint32_t i, int *y)
269 {
270     uint64_t norm = 0;
271     uint32_t q, p;
272     int s, val;
273     int k0;
274
275     while (N > 2) {
276         /*Lots of pulses case:*/
277         if (K >= N) {
278             const uint32_t *row = ff_celt_pvq_u_row[N];
279
280             /* Are the pulses in this dimension negative? */
281             p  = row[K + 1];
282             s  = -(i >= p);
283             i -= p & s;
284
285             /*Count how many pulses were placed in this dimension.*/
286             k0 = K;
287             q = row[N];
288             if (q > i) {
289                 K = N;
290                 do {
291                     p = ff_celt_pvq_u_row[--K][N];
292                 } while (p > i);
293             } else
294                 for (p = row[K]; p > i; p = row[K])
295                     K--;
296
297             i    -= p;
298             val   = (k0 - K + s) ^ s;
299             norm += val * val;
300             *y++  = val;
301         } else { /*Lots of dimensions case:*/
302             /*Are there any pulses in this dimension at all?*/
303             p = ff_celt_pvq_u_row[K    ][N];
304             q = ff_celt_pvq_u_row[K + 1][N];
305
306             if (p <= i && i < q) {
307                 i -= p;
308                 *y++ = 0;
309             } else {
310                 /*Are the pulses in this dimension negative?*/
311                 s  = -(i >= q);
312                 i -= q & s;
313
314                 /*Count how many pulses were placed in this dimension.*/
315                 k0 = K;
316                 do p = ff_celt_pvq_u_row[--K][N];
317                 while (p > i);
318
319                 i    -= p;
320                 val   = (k0 - K + s) ^ s;
321                 norm += val * val;
322                 *y++  = val;
323             }
324         }
325         N--;
326     }
327
328     /* N == 2 */
329     p  = 2 * K + 1;
330     s  = -(i >= p);
331     i -= p & s;
332     k0 = K;
333     K  = (i + 1) / 2;
334
335     if (K)
336         i -= 2 * K - 1;
337
338     val   = (k0 - K + s) ^ s;
339     norm += val * val;
340     *y++  = val;
341
342     /* N==1 */
343     s     = -i;
344     val   = (K + s) ^ s;
345     norm += val * val;
346     *y    = val;
347
348     return norm;
349 }
350
351 static inline void celt_encode_pulses(OpusRangeCoder *rc, int *y, uint32_t N, uint32_t K)
352 {
353     ff_opus_rc_enc_uint(rc, celt_icwrsi(N, K, y), CELT_PVQ_V(N, K));
354 }
355
356 static inline float celt_decode_pulses(OpusRangeCoder *rc, int *y, uint32_t N, uint32_t K)
357 {
358     const uint32_t idx = ff_opus_rc_dec_uint(rc, CELT_PVQ_V(N, K));
359     return celt_cwrsi(N, K, idx, y);
360 }
361
362 /*
363  * Faster than libopus's search, operates entirely in the signed domain.
364  * Slightly worse/better depending on N, K and the input vector.
365  */
366 static int celt_pvq_search(float *X, int *y, int K, int N)
367 {
368     int i, y_norm = 0;
369     float res = 0.0f, xy_norm = 0.0f;
370
371     for (i = 0; i < N; i++)
372         res += FFABS(X[i]);
373
374     res = K/(res + FLT_EPSILON);
375
376     for (i = 0; i < N; i++) {
377         y[i] = lrintf(res*X[i]);
378         y_norm  += y[i]*y[i];
379         xy_norm += y[i]*X[i];
380         K -= FFABS(y[i]);
381     }
382
383     while (K) {
384         int max_idx = 0, max_den = 1, phase = FFSIGN(K);
385         float max_num = 0.0f;
386         y_norm += 1.0f;
387
388         for (i = 0; i < N; i++) {
389             /* If the sum has been overshot and the best place has 0 pulses allocated
390              * to it, attempting to decrease it further will actually increase the
391              * sum. Prevent this by disregarding any 0 positions when decrementing. */
392             const int ca = 1 ^ ((y[i] == 0) & (phase < 0));
393             const int y_new = y_norm  + 2*phase*FFABS(y[i]);
394             float xy_new = xy_norm + 1*phase*FFABS(X[i]);
395             xy_new = xy_new * xy_new;
396             if (ca && (max_den*xy_new) > (y_new*max_num)) {
397                 max_den = y_new;
398                 max_num = xy_new;
399                 max_idx = i;
400             }
401         }
402
403         K -= phase;
404
405         phase *= FFSIGN(X[max_idx]);
406         xy_norm += 1*phase*X[max_idx];
407         y_norm  += 2*phase*y[max_idx];
408         y[max_idx] += phase;
409     }
410
411     return y_norm;
412 }
413
414 static uint32_t celt_alg_quant(OpusRangeCoder *rc, float *X, uint32_t N, uint32_t K,
415                                enum CeltSpread spread, uint32_t blocks, float gain)
416 {
417     int y[176];
418
419     celt_exp_rotation(X, N, blocks, K, spread, 1);
420     gain /= sqrtf(celt_pvq_search(X, y, K, N));
421     celt_encode_pulses(rc, y,  N, K);
422     celt_normalize_residual(y, X, N, gain);
423     celt_exp_rotation(X, N, blocks, K, spread, 0);
424     return celt_extract_collapse_mask(y, N, blocks);
425 }
426
427 /** Decode pulse vector and combine the result with the pitch vector to produce
428     the final normalised signal in the current band. */
429 static uint32_t celt_alg_unquant(OpusRangeCoder *rc, float *X, uint32_t N, uint32_t K,
430                                  enum CeltSpread spread, uint32_t blocks, float gain)
431 {
432     int y[176];
433
434     gain /= sqrtf(celt_decode_pulses(rc, y, N, K));
435     celt_normalize_residual(y, X, N, gain);
436     celt_exp_rotation(X, N, blocks, K, spread, 0);
437     return celt_extract_collapse_mask(y, N, blocks);
438 }
439
440 uint32_t ff_celt_decode_band(CeltFrame *f, OpusRangeCoder *rc, const int band,
441                              float *X, float *Y, int N, int b, uint32_t blocks,
442                              float *lowband, int duration, float *lowband_out, int level,
443                              float gain, float *lowband_scratch, int fill)
444 {
445     int i;
446     const uint8_t *cache;
447     int stereo = !!Y, split = !!Y;
448     int imid = 0, iside = 0;
449     uint32_t N0 = N;
450     int N_B = N / blocks;
451     int N_B0 = N_B;
452     int B0 = blocks;
453     int time_divide = 0;
454     int recombine = 0;
455     int inv = 0;
456     float mid = 0, side = 0;
457     int longblocks = (B0 == 1);
458     uint32_t cm = 0;
459
460     if (N == 1) {
461         /* special case for one sample */
462         float *x = X;
463         for (i = 0; i <= stereo; i++) {
464             int sign = 0;
465             if (f->remaining2 >= 1<<3) {
466                 sign           = ff_opus_rc_get_raw(rc, 1);
467                 f->remaining2 -= 1 << 3;
468                 b             -= 1 << 3;
469             }
470             x[0] = sign ? -1.0f : 1.0f;
471             x = Y;
472         }
473         if (lowband_out)
474             lowband_out[0] = X[0];
475         return 1;
476     }
477
478     if (!stereo && level == 0) {
479         int tf_change = f->tf_change[band];
480         int k;
481         if (tf_change > 0)
482             recombine = tf_change;
483         /* Band recombining to increase frequency resolution */
484
485         if (lowband &&
486             (recombine || ((N_B & 1) == 0 && tf_change < 0) || B0 > 1)) {
487             for (i = 0; i < N; i++)
488                 lowband_scratch[i] = lowband[i];
489             lowband = lowband_scratch;
490         }
491
492         for (k = 0; k < recombine; k++) {
493             if (lowband)
494                 celt_haar1(lowband, N >> k, 1 << k);
495             fill = ff_celt_bit_interleave[fill & 0xF] | ff_celt_bit_interleave[fill >> 4] << 2;
496         }
497         blocks >>= recombine;
498         N_B <<= recombine;
499
500         /* Increasing the time resolution */
501         while ((N_B & 1) == 0 && tf_change < 0) {
502             if (lowband)
503                 celt_haar1(lowband, N_B, blocks);
504             fill |= fill << blocks;
505             blocks <<= 1;
506             N_B >>= 1;
507             time_divide++;
508             tf_change++;
509         }
510         B0 = blocks;
511         N_B0 = N_B;
512
513         /* Reorganize the samples in time order instead of frequency order */
514         if (B0 > 1 && lowband)
515             celt_deinterleave_hadamard(f->scratch, lowband, N_B >> recombine,
516                                        B0 << recombine, longblocks);
517     }
518
519     /* If we need 1.5 more bit than we can produce, split the band in two. */
520     cache = ff_celt_cache_bits +
521             ff_celt_cache_index[(duration + 1) * CELT_MAX_BANDS + band];
522     if (!stereo && duration >= 0 && b > cache[cache[0]] + 12 && N > 2) {
523         N >>= 1;
524         Y = X + N;
525         split = 1;
526         duration -= 1;
527         if (blocks == 1)
528             fill = (fill & 1) | (fill << 1);
529         blocks = (blocks + 1) >> 1;
530     }
531
532     if (split) {
533         int qn;
534         int itheta = 0;
535         int mbits, sbits, delta;
536         int qalloc;
537         int pulse_cap;
538         int offset;
539         int orig_fill;
540         int tell;
541
542         /* Decide on the resolution to give to the split parameter theta */
543         pulse_cap = ff_celt_log_freq_range[band] + duration * 8;
544         offset = (pulse_cap >> 1) - (stereo && N == 2 ? CELT_QTHETA_OFFSET_TWOPHASE :
545                                                           CELT_QTHETA_OFFSET);
546         qn = (stereo && band >= f->intensity_stereo) ? 1 :
547              celt_compute_qn(N, b, offset, pulse_cap, stereo);
548         tell = opus_rc_tell_frac(rc);
549         if (qn != 1) {
550             /* Entropy coding of the angle. We use a uniform pdf for the
551             time split, a step for stereo, and a triangular one for the rest. */
552             if (stereo && N > 2)
553                 itheta = ff_opus_rc_dec_uint_step(rc, qn/2);
554             else if (stereo || B0 > 1)
555                 itheta = ff_opus_rc_dec_uint(rc, qn+1);
556             else
557                 itheta = ff_opus_rc_dec_uint_tri(rc, qn);
558             itheta = itheta * 16384 / qn;
559             /* NOTE: Renormalising X and Y *may* help fixed-point a bit at very high rate.
560             Let's do that at higher complexity */
561         } else if (stereo) {
562             inv = (b > 2 << 3 && f->remaining2 > 2 << 3) ? ff_opus_rc_dec_log(rc, 2) : 0;
563             itheta = 0;
564         }
565         qalloc = opus_rc_tell_frac(rc) - tell;
566         b -= qalloc;
567
568         orig_fill = fill;
569         if (itheta == 0) {
570             imid = 32767;
571             iside = 0;
572             fill = av_mod_uintp2(fill, blocks);
573             delta = -16384;
574         } else if (itheta == 16384) {
575             imid = 0;
576             iside = 32767;
577             fill &= ((1 << blocks) - 1) << blocks;
578             delta = 16384;
579         } else {
580             imid = celt_cos(itheta);
581             iside = celt_cos(16384-itheta);
582             /* This is the mid vs side allocation that minimizes squared error
583             in that band. */
584             delta = ROUND_MUL16((N - 1) << 7, celt_log2tan(iside, imid));
585         }
586
587         mid  = imid  / 32768.0f;
588         side = iside / 32768.0f;
589
590         /* This is a special case for N=2 that only works for stereo and takes
591         advantage of the fact that mid and side are orthogonal to encode
592         the side with just one bit. */
593         if (N == 2 && stereo) {
594             int c;
595             int sign = 0;
596             float tmp;
597             float *x2, *y2;
598             mbits = b;
599             /* Only need one bit for the side */
600             sbits = (itheta != 0 && itheta != 16384) ? 1 << 3 : 0;
601             mbits -= sbits;
602             c = (itheta > 8192);
603             f->remaining2 -= qalloc+sbits;
604
605             x2 = c ? Y : X;
606             y2 = c ? X : Y;
607             if (sbits)
608                 sign = ff_opus_rc_get_raw(rc, 1);
609             sign = 1 - 2 * sign;
610             /* We use orig_fill here because we want to fold the side, but if
611             itheta==16384, we'll have cleared the low bits of fill. */
612             cm = ff_celt_decode_band(f, rc, band, x2, NULL, N, mbits, blocks,
613                                      lowband, duration, lowband_out, level, gain,
614                                      lowband_scratch, orig_fill);
615             /* We don't split N=2 bands, so cm is either 1 or 0 (for a fold-collapse),
616             and there's no need to worry about mixing with the other channel. */
617             y2[0] = -sign * x2[1];
618             y2[1] =  sign * x2[0];
619             X[0] *= mid;
620             X[1] *= mid;
621             Y[0] *= side;
622             Y[1] *= side;
623             tmp = X[0];
624             X[0] = tmp - Y[0];
625             Y[0] = tmp + Y[0];
626             tmp = X[1];
627             X[1] = tmp - Y[1];
628             Y[1] = tmp + Y[1];
629         } else {
630             /* "Normal" split code */
631             float *next_lowband2     = NULL;
632             float *next_lowband_out1 = NULL;
633             int next_level = 0;
634             int rebalance;
635
636             /* Give more bits to low-energy MDCTs than they would
637              * otherwise deserve */
638             if (B0 > 1 && !stereo && (itheta & 0x3fff)) {
639                 if (itheta > 8192)
640                     /* Rough approximation for pre-echo masking */
641                     delta -= delta >> (4 - duration);
642                 else
643                     /* Corresponds to a forward-masking slope of
644                      * 1.5 dB per 10 ms */
645                     delta = FFMIN(0, delta + (N << 3 >> (5 - duration)));
646             }
647             mbits = av_clip((b - delta) / 2, 0, b);
648             sbits = b - mbits;
649             f->remaining2 -= qalloc;
650
651             if (lowband && !stereo)
652                 next_lowband2 = lowband + N; /* >32-bit split case */
653
654             /* Only stereo needs to pass on lowband_out.
655              * Otherwise, it's handled at the end */
656             if (stereo)
657                 next_lowband_out1 = lowband_out;
658             else
659                 next_level = level + 1;
660
661             rebalance = f->remaining2;
662             if (mbits >= sbits) {
663                 /* In stereo mode, we do not apply a scaling to the mid
664                  * because we need the normalized mid for folding later */
665                 cm = ff_celt_decode_band(f, rc, band, X, NULL, N, mbits, blocks,
666                                          lowband, duration, next_lowband_out1,
667                                          next_level, stereo ? 1.0f : (gain * mid),
668                                          lowband_scratch, fill);
669
670                 rebalance = mbits - (rebalance - f->remaining2);
671                 if (rebalance > 3 << 3 && itheta != 0)
672                     sbits += rebalance - (3 << 3);
673
674                 /* For a stereo split, the high bits of fill are always zero,
675                  * so no folding will be done to the side. */
676                 cm |= ff_celt_decode_band(f, rc, band, Y, NULL, N, sbits, blocks,
677                                           next_lowband2, duration, NULL,
678                                           next_level, gain * side, NULL,
679                                           fill >> blocks) << ((B0 >> 1) & (stereo - 1));
680             } else {
681                 /* For a stereo split, the high bits of fill are always zero,
682                  * so no folding will be done to the side. */
683                 cm = ff_celt_decode_band(f, rc, band, Y, NULL, N, sbits, blocks,
684                                          next_lowband2, duration, NULL,
685                                          next_level, gain * side, NULL,
686                                          fill >> blocks) << ((B0 >> 1) & (stereo - 1));
687
688                 rebalance = sbits - (rebalance - f->remaining2);
689                 if (rebalance > 3 << 3 && itheta != 16384)
690                     mbits += rebalance - (3 << 3);
691
692                 /* In stereo mode, we do not apply a scaling to the mid because
693                  * we need the normalized mid for folding later */
694                 cm |= ff_celt_decode_band(f, rc, band, X, NULL, N, mbits, blocks,
695                                           lowband, duration, next_lowband_out1,
696                                           next_level, stereo ? 1.0f : (gain * mid),
697                                           lowband_scratch, fill);
698             }
699         }
700     } else {
701         /* This is the basic no-split case */
702         uint32_t q         = celt_bits2pulses(cache, b);
703         uint32_t curr_bits = celt_pulses2bits(cache, q);
704         f->remaining2 -= curr_bits;
705
706         /* Ensures we can never bust the budget */
707         while (f->remaining2 < 0 && q > 0) {
708             f->remaining2 += curr_bits;
709             curr_bits      = celt_pulses2bits(cache, --q);
710             f->remaining2 -= curr_bits;
711         }
712
713         if (q != 0) {
714             /* Finally do the actual quantization */
715             cm = celt_alg_unquant(rc, X, N, (q < 8) ? q : (8 + (q & 7)) << ((q >> 3) - 1),
716                                   f->spread, blocks, gain);
717         } else {
718             /* If there's no pulse, fill the band anyway */
719             uint32_t cm_mask = (1 << blocks) - 1;
720             fill &= cm_mask;
721             if (fill) {
722                 if (!lowband) {
723                     /* Noise */
724                     for (i = 0; i < N; i++)
725                         X[i] = (((int32_t)celt_rng(f)) >> 20);
726                     cm = cm_mask;
727                 } else {
728                     /* Folded spectrum */
729                     for (i = 0; i < N; i++) {
730                         /* About 48 dB below the "normal" folding level */
731                         X[i] = lowband[i] + (((celt_rng(f)) & 0x8000) ? 1.0f / 256 : -1.0f / 256);
732                     }
733                     cm = fill;
734                 }
735                 celt_renormalize_vector(X, N, gain);
736             } else {
737                 memset(X, 0, N*sizeof(float));
738             }
739         }
740     }
741
742     /* This code is used by the decoder and by the resynthesis-enabled encoder */
743     if (stereo) {
744         if (N > 2)
745             celt_stereo_merge(X, Y, mid, N);
746         if (inv) {
747             for (i = 0; i < N; i++)
748                 Y[i] *= -1;
749         }
750     } else if (level == 0) {
751         int k;
752
753         /* Undo the sample reorganization going from time order to frequency order */
754         if (B0 > 1)
755             celt_interleave_hadamard(f->scratch, X, N_B >> recombine,
756                                      B0 << recombine, longblocks);
757
758         /* Undo time-freq changes that we did earlier */
759         N_B = N_B0;
760         blocks = B0;
761         for (k = 0; k < time_divide; k++) {
762             blocks >>= 1;
763             N_B <<= 1;
764             cm |= cm >> blocks;
765             celt_haar1(X, N_B, blocks);
766         }
767
768         for (k = 0; k < recombine; k++) {
769             cm = ff_celt_bit_deinterleave[cm];
770             celt_haar1(X, N0>>k, 1<<k);
771         }
772         blocks <<= recombine;
773
774         /* Scale output for later folding */
775         if (lowband_out) {
776             float n = sqrtf(N0);
777             for (i = 0; i < N0; i++)
778                 lowband_out[i] = n * X[i];
779         }
780         cm = av_mod_uintp2(cm, blocks);
781     }
782
783     return cm;
784 }
785
786 /* This has to be, AND MUST BE done by the psychoacoustic system, this has a very
787  * big impact on the entire quantization and especially huge on transients */
788 static int celt_calc_theta(const float *X, const float *Y, int coupling, int N)
789 {
790     int i;
791     float e[2] = { 0.0f, 0.0f };
792     if (coupling) { /* Coupling case */
793         for (i = 0; i < N; i++) {
794             e[0] += (X[i] + Y[i])*(X[i] + Y[i]);
795             e[1] += (X[i] - Y[i])*(X[i] - Y[i]);
796         }
797     } else {
798         for (i = 0; i < N; i++) {
799             e[0] += X[i]*X[i];
800             e[1] += Y[i]*Y[i];
801         }
802     }
803     return lrintf(32768.0f*atan2f(sqrtf(e[1]), sqrtf(e[0]))/M_PI);
804 }
805
806 static void celt_stereo_is_decouple(float *X, float *Y, float e_l, float e_r, int N)
807 {
808     int i;
809     const float energy_n = 1.0f/(sqrtf(e_l*e_l + e_r*e_r) + FLT_EPSILON);
810     e_l *= energy_n;
811     e_r *= energy_n;
812     for (i = 0; i < N; i++)
813         X[i] = e_l*X[i] + e_r*Y[i];
814 }
815
816 static void celt_stereo_ms_decouple(float *X, float *Y, int N)
817 {
818     int i;
819     for (i = 0; i < N; i++) {
820         const float Xret = X[i];
821         X[i] = (X[i] + Y[i])*M_SQRT1_2;
822         Y[i] = (Y[i] - Xret)*M_SQRT1_2;
823     }
824 }
825
826 uint32_t ff_celt_encode_band(CeltFrame *f, OpusRangeCoder *rc, const int band,
827                              float *X, float *Y, int N, int b, uint32_t blocks,
828                              float *lowband, int duration, float *lowband_out, int level,
829                              float gain, float *lowband_scratch, int fill)
830 {
831     int i;
832     const uint8_t *cache;
833     int stereo = !!Y, split = !!Y;
834     int imid = 0, iside = 0;
835     uint32_t N0 = N;
836     int N_B = N / blocks;
837     int N_B0 = N_B;
838     int B0 = blocks;
839     int time_divide = 0;
840     int recombine = 0;
841     int inv = 0;
842     float mid = 0, side = 0;
843     int longblocks = (B0 == 1);
844     uint32_t cm = 0;
845
846     if (N == 1) {
847         /* special case for one sample - the decoder's output will be +- 1.0f!!! */
848         float *x = X;
849         for (i = 0; i <= stereo; i++) {
850             if (f->remaining2 >= 1<<3) {
851                 ff_opus_rc_put_raw(rc, x[0] < 0, 1);
852                 f->remaining2 -= 1 << 3;
853                 b             -= 1 << 3;
854             }
855             x[0] = 1.0f - 2.0f*(x[0] < 0);
856             x = Y;
857         }
858         if (lowband_out)
859             lowband_out[0] = X[0];
860         return 1;
861     }
862
863     if (!stereo && level == 0) {
864         int tf_change = f->tf_change[band];
865         int k;
866         if (tf_change > 0)
867             recombine = tf_change;
868         /* Band recombining to increase frequency resolution */
869
870         if (lowband &&
871             (recombine || ((N_B & 1) == 0 && tf_change < 0) || B0 > 1)) {
872             for (i = 0; i < N; i++)
873                 lowband_scratch[i] = lowband[i];
874             lowband = lowband_scratch;
875         }
876
877         for (k = 0; k < recombine; k++) {
878             celt_haar1(X, N >> k, 1 << k);
879             fill = ff_celt_bit_interleave[fill & 0xF] | ff_celt_bit_interleave[fill >> 4] << 2;
880         }
881         blocks >>= recombine;
882         N_B <<= recombine;
883
884         /* Increasing the time resolution */
885         while ((N_B & 1) == 0 && tf_change < 0) {
886             celt_haar1(X, N_B, blocks);
887             fill |= fill << blocks;
888             blocks <<= 1;
889             N_B >>= 1;
890             time_divide++;
891             tf_change++;
892         }
893         B0 = blocks;
894         N_B0 = N_B;
895
896         /* Reorganize the samples in time order instead of frequency order */
897         if (B0 > 1)
898             celt_deinterleave_hadamard(f->scratch, X, N_B >> recombine,
899                                        B0 << recombine, longblocks);
900     }
901
902     /* If we need 1.5 more bit than we can produce, split the band in two. */
903     cache = ff_celt_cache_bits +
904             ff_celt_cache_index[(duration + 1) * CELT_MAX_BANDS + band];
905     if (!stereo && duration >= 0 && b > cache[cache[0]] + 12 && N > 2) {
906         N >>= 1;
907         Y = X + N;
908         split = 1;
909         duration -= 1;
910         if (blocks == 1)
911             fill = (fill & 1) | (fill << 1);
912         blocks = (blocks + 1) >> 1;
913     }
914
915     if (split) {
916         int qn;
917         int itheta = celt_calc_theta(X, Y, stereo, N);
918         int mbits, sbits, delta;
919         int qalloc;
920         int pulse_cap;
921         int offset;
922         int orig_fill;
923         int tell;
924
925         /* Decide on the resolution to give to the split parameter theta */
926         pulse_cap = ff_celt_log_freq_range[band] + duration * 8;
927         offset = (pulse_cap >> 1) - (stereo && N == 2 ? CELT_QTHETA_OFFSET_TWOPHASE :
928                                                           CELT_QTHETA_OFFSET);
929         qn = (stereo && band >= f->intensity_stereo) ? 1 :
930              celt_compute_qn(N, b, offset, pulse_cap, stereo);
931         tell = opus_rc_tell_frac(rc);
932
933         if (qn != 1) {
934
935             itheta = (itheta*qn + 8192) >> 14;
936
937             /* Entropy coding of the angle. We use a uniform pdf for the
938              * time split, a step for stereo, and a triangular one for the rest. */
939             if (stereo && N > 2)
940                 ff_opus_rc_enc_uint_step(rc, itheta, qn / 2);
941             else if (stereo || B0 > 1)
942                 ff_opus_rc_enc_uint(rc, itheta, qn + 1);
943             else
944                 ff_opus_rc_enc_uint_tri(rc, itheta, qn);
945             itheta = itheta * 16384 / qn;
946
947             if (stereo) {
948                 if (itheta == 0)
949                     celt_stereo_is_decouple(X, Y, f->block[0].lin_energy[band],
950                                             f->block[1].lin_energy[band], N);
951                 else
952                     celt_stereo_ms_decouple(X, Y, N);
953             }
954         } else if (stereo) {
955              inv = itheta > 8192;
956              if (inv) {
957                 for (i = 0; i < N; i++)
958                    Y[i] *= -1;
959              }
960              celt_stereo_is_decouple(X, Y, f->block[0].lin_energy[band],
961                                      f->block[1].lin_energy[band], N);
962
963             if (b > 2 << 3 && f->remaining2 > 2 << 3) {
964                 ff_opus_rc_enc_log(rc, inv, 2);
965             } else {
966                 inv = 0;
967             }
968
969             itheta = 0;
970         }
971         qalloc = opus_rc_tell_frac(rc) - tell;
972         b -= qalloc;
973
974         orig_fill = fill;
975         if (itheta == 0) {
976             imid = 32767;
977             iside = 0;
978             fill = av_mod_uintp2(fill, blocks);
979             delta = -16384;
980         } else if (itheta == 16384) {
981             imid = 0;
982             iside = 32767;
983             fill &= ((1 << blocks) - 1) << blocks;
984             delta = 16384;
985         } else {
986             imid = celt_cos(itheta);
987             iside = celt_cos(16384-itheta);
988             /* This is the mid vs side allocation that minimizes squared error
989             in that band. */
990             delta = ROUND_MUL16((N - 1) << 7, celt_log2tan(iside, imid));
991         }
992
993         mid  = imid  / 32768.0f;
994         side = iside / 32768.0f;
995
996         /* This is a special case for N=2 that only works for stereo and takes
997         advantage of the fact that mid and side are orthogonal to encode
998         the side with just one bit. */
999         if (N == 2 && stereo) {
1000             int c;
1001             int sign = 0;
1002             float tmp;
1003             float *x2, *y2;
1004             mbits = b;
1005             /* Only need one bit for the side */
1006             sbits = (itheta != 0 && itheta != 16384) ? 1 << 3 : 0;
1007             mbits -= sbits;
1008             c = (itheta > 8192);
1009             f->remaining2 -= qalloc+sbits;
1010
1011             x2 = c ? Y : X;
1012             y2 = c ? X : Y;
1013             if (sbits) {
1014                 sign = x2[0]*y2[1] - x2[1]*y2[0] < 0;
1015                 ff_opus_rc_put_raw(rc, sign, 1);
1016             }
1017             sign = 1 - 2 * sign;
1018             /* We use orig_fill here because we want to fold the side, but if
1019             itheta==16384, we'll have cleared the low bits of fill. */
1020             cm = ff_celt_encode_band(f, rc, band, x2, NULL, N, mbits, blocks,
1021                                      lowband, duration, lowband_out, level, gain,
1022                                      lowband_scratch, orig_fill);
1023             /* We don't split N=2 bands, so cm is either 1 or 0 (for a fold-collapse),
1024             and there's no need to worry about mixing with the other channel. */
1025             y2[0] = -sign * x2[1];
1026             y2[1] =  sign * x2[0];
1027             X[0] *= mid;
1028             X[1] *= mid;
1029             Y[0] *= side;
1030             Y[1] *= side;
1031             tmp = X[0];
1032             X[0] = tmp - Y[0];
1033             Y[0] = tmp + Y[0];
1034             tmp = X[1];
1035             X[1] = tmp - Y[1];
1036             Y[1] = tmp + Y[1];
1037         } else {
1038             /* "Normal" split code */
1039             float *next_lowband2     = NULL;
1040             float *next_lowband_out1 = NULL;
1041             int next_level = 0;
1042             int rebalance;
1043
1044             /* Give more bits to low-energy MDCTs than they would
1045              * otherwise deserve */
1046             if (B0 > 1 && !stereo && (itheta & 0x3fff)) {
1047                 if (itheta > 8192)
1048                     /* Rough approximation for pre-echo masking */
1049                     delta -= delta >> (4 - duration);
1050                 else
1051                     /* Corresponds to a forward-masking slope of
1052                      * 1.5 dB per 10 ms */
1053                     delta = FFMIN(0, delta + (N << 3 >> (5 - duration)));
1054             }
1055             mbits = av_clip((b - delta) / 2, 0, b);
1056             sbits = b - mbits;
1057             f->remaining2 -= qalloc;
1058
1059             if (lowband && !stereo)
1060                 next_lowband2 = lowband + N; /* >32-bit split case */
1061
1062             /* Only stereo needs to pass on lowband_out.
1063              * Otherwise, it's handled at the end */
1064             if (stereo)
1065                 next_lowband_out1 = lowband_out;
1066             else
1067                 next_level = level + 1;
1068
1069             rebalance = f->remaining2;
1070             if (mbits >= sbits) {
1071                 /* In stereo mode, we do not apply a scaling to the mid
1072                  * because we need the normalized mid for folding later */
1073                 cm = ff_celt_encode_band(f, rc, band, X, NULL, N, mbits, blocks,
1074                                          lowband, duration, next_lowband_out1,
1075                                          next_level, stereo ? 1.0f : (gain * mid),
1076                                          lowband_scratch, fill);
1077
1078                 rebalance = mbits - (rebalance - f->remaining2);
1079                 if (rebalance > 3 << 3 && itheta != 0)
1080                     sbits += rebalance - (3 << 3);
1081
1082                 /* For a stereo split, the high bits of fill are always zero,
1083                  * so no folding will be done to the side. */
1084                 cm |= ff_celt_encode_band(f, rc, band, Y, NULL, N, sbits, blocks,
1085                                           next_lowband2, duration, NULL,
1086                                           next_level, gain * side, NULL,
1087                                           fill >> blocks) << ((B0 >> 1) & (stereo - 1));
1088             } else {
1089                 /* For a stereo split, the high bits of fill are always zero,
1090                  * so no folding will be done to the side. */
1091                 cm = ff_celt_encode_band(f, rc, band, Y, NULL, N, sbits, blocks,
1092                                          next_lowband2, duration, NULL,
1093                                          next_level, gain * side, NULL,
1094                                          fill >> blocks) << ((B0 >> 1) & (stereo - 1));
1095
1096                 rebalance = sbits - (rebalance - f->remaining2);
1097                 if (rebalance > 3 << 3 && itheta != 16384)
1098                     mbits += rebalance - (3 << 3);
1099
1100                 /* In stereo mode, we do not apply a scaling to the mid because
1101                  * we need the normalized mid for folding later */
1102                 cm |= ff_celt_encode_band(f, rc, band, X, NULL, N, mbits, blocks,
1103                                           lowband, duration, next_lowband_out1,
1104                                           next_level, stereo ? 1.0f : (gain * mid),
1105                                           lowband_scratch, fill);
1106             }
1107         }
1108     } else {
1109         /* This is the basic no-split case */
1110         uint32_t q         = celt_bits2pulses(cache, b);
1111         uint32_t curr_bits = celt_pulses2bits(cache, q);
1112         f->remaining2 -= curr_bits;
1113
1114         /* Ensures we can never bust the budget */
1115         while (f->remaining2 < 0 && q > 0) {
1116             f->remaining2 += curr_bits;
1117             curr_bits      = celt_pulses2bits(cache, --q);
1118             f->remaining2 -= curr_bits;
1119         }
1120
1121         if (q != 0) {
1122             /* Finally do the actual quantization */
1123             cm = celt_alg_quant(rc, X, N, (q < 8) ? q : (8 + (q & 7)) << ((q >> 3) - 1),
1124                                 f->spread, blocks, gain);
1125         } else {
1126             /* If there's no pulse, fill the band anyway */
1127             uint32_t cm_mask = (1 << blocks) - 1;
1128             fill &= cm_mask;
1129             if (fill) {
1130                 if (!lowband) {
1131                     /* Noise */
1132                     for (i = 0; i < N; i++)
1133                         X[i] = (((int32_t)celt_rng(f)) >> 20);
1134                     cm = cm_mask;
1135                 } else {
1136                     /* Folded spectrum */
1137                     for (i = 0; i < N; i++) {
1138                         /* About 48 dB below the "normal" folding level */
1139                         X[i] = lowband[i] + (((celt_rng(f)) & 0x8000) ? 1.0f / 256 : -1.0f / 256);
1140                     }
1141                     cm = fill;
1142                 }
1143                 celt_renormalize_vector(X, N, gain);
1144             } else {
1145                 memset(X, 0, N*sizeof(float));
1146             }
1147         }
1148     }
1149
1150     /* This code is used by the decoder and by the resynthesis-enabled encoder */
1151     if (stereo) {
1152         if (N > 2)
1153             celt_stereo_merge(X, Y, mid, N);
1154         if (inv) {
1155             for (i = 0; i < N; i++)
1156                 Y[i] *= -1;
1157         }
1158     } else if (level == 0) {
1159         int k;
1160
1161         /* Undo the sample reorganization going from time order to frequency order */
1162         if (B0 > 1)
1163             celt_interleave_hadamard(f->scratch, X, N_B >> recombine,
1164                                      B0 << recombine, longblocks);
1165
1166         /* Undo time-freq changes that we did earlier */
1167         N_B = N_B0;
1168         blocks = B0;
1169         for (k = 0; k < time_divide; k++) {
1170             blocks >>= 1;
1171             N_B <<= 1;
1172             cm |= cm >> blocks;
1173             celt_haar1(X, N_B, blocks);
1174         }
1175
1176         for (k = 0; k < recombine; k++) {
1177             cm = ff_celt_bit_deinterleave[cm];
1178             celt_haar1(X, N0>>k, 1<<k);
1179         }
1180         blocks <<= recombine;
1181
1182         /* Scale output for later folding */
1183         if (lowband_out) {
1184             float n = sqrtf(N0);
1185             for (i = 0; i < N0; i++)
1186                 lowband_out[i] = n * X[i];
1187         }
1188         cm = av_mod_uintp2(cm, blocks);
1189     }
1190
1191     return cm;
1192 }
1193
1194 float ff_celt_quant_band_cost(CeltFrame *f, OpusRangeCoder *rc, int band, float *bits,
1195                               float lambda)
1196 {
1197     int i, b = 0;
1198     uint32_t cm[2] = { (1 << f->blocks) - 1, (1 << f->blocks) - 1 };
1199     const int band_size = ff_celt_freq_range[band] << f->size;
1200     float buf[352], lowband_scratch[176], norm1[176], norm2[176];
1201     float dist, cost, err_x = 0.0f, err_y = 0.0f;
1202     float *X = buf;
1203     float *X_orig = f->block[0].coeffs + (ff_celt_freq_bands[band] << f->size);
1204     float *Y = (f->channels == 2) ? &buf[176] : NULL;
1205     float *Y_orig = f->block[1].coeffs + (ff_celt_freq_bands[band] << f->size);
1206     OPUS_RC_CHECKPOINT_SPAWN(rc);
1207
1208     memcpy(X, X_orig, band_size*sizeof(float));
1209     if (Y)
1210         memcpy(Y, Y_orig, band_size*sizeof(float));
1211
1212     f->remaining2 = ((f->framebits << 3) - f->anticollapse_needed) - opus_rc_tell_frac(rc) - 1;
1213     if (band <= f->coded_bands - 1) {
1214         int curr_balance = f->remaining / FFMIN(3, f->coded_bands - band);
1215         b = av_clip_uintp2(FFMIN(f->remaining2 + 1, f->pulses[band] + curr_balance), 14);
1216     }
1217
1218     if (f->dual_stereo) {
1219         ff_celt_encode_band(f, rc, band, X, NULL, band_size, b / 2, f->blocks, NULL,
1220                             f->size, norm1, 0, 1.0f, lowband_scratch, cm[0]);
1221
1222         ff_celt_encode_band(f, rc, band, Y, NULL, band_size, b / 2, f->blocks, NULL,
1223                             f->size, norm2, 0, 1.0f, lowband_scratch, cm[1]);
1224     } else {
1225         ff_celt_encode_band(f, rc, band, X, Y, band_size, b, f->blocks, NULL, f->size,
1226                             norm1, 0, 1.0f, lowband_scratch, cm[0] | cm[1]);
1227     }
1228
1229     for (i = 0; i < band_size; i++) {
1230         err_x += (X[i] - X_orig[i])*(X[i] - X_orig[i]);
1231         err_y += (Y[i] - Y_orig[i])*(Y[i] - Y_orig[i]);
1232     }
1233
1234     dist = sqrtf(err_x) + sqrtf(err_y);
1235     cost = OPUS_RC_CHECKPOINT_BITS(rc)/8.0f;
1236     *bits += cost;
1237
1238     OPUS_RC_CHECKPOINT_ROLLBACK(rc);
1239
1240     return lambda*dist*cost;
1241 }