Allow coarse energy to take almost all the bits. Also, fixed a some issues with
[opus.git] / libcelt / quant_bands.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 "quant_bands.h"
38 #include "laplace.h"
39 #include <math.h>
40 #include "os_support.h"
41 #include "arch.h"
42 #include "mathops.h"
43 #include "stack_alloc.h"
44
45 #ifdef FIXED_POINT
46 const celt_word16 eMeans[24] = {1920, -341, -512, -107, 43, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
47 #else
48 const celt_word16 eMeans[24] = {7.5f, -1.33f, -2.f, -0.42f, 0.17f, 0.f, 0.f, 0.f, 0.f, 0.f, 0.f, 0.f, 0.f, 0.f, 0.f, 0.f, 0.f, 0.f, 0.f, 0.f, 0.f, 0.f, 0.f, 0.f};
49 #endif
50
51 /* FIXME: Implement for stereo */
52 int intra_decision(celt_word16 *eBands, celt_word16 *oldEBands, int len)
53 {
54    int i;
55    celt_word32 dist = 0;
56    for (i=0;i<len;i++)
57    {
58       celt_word16 d = SUB16(eBands[i], oldEBands[i]);
59       dist = MAC16_16(dist, d,d);
60    }
61    return SHR32(dist,16) > 2*len;
62 }
63
64 int *quant_prob_alloc(const CELTMode *m)
65 {
66    int i;
67    int *prob;
68    prob = celt_alloc(4*m->nbEBands*sizeof(int));
69    if (prob==NULL)
70      return NULL;
71    for (i=0;i<m->nbEBands;i++)
72    {
73       prob[2*i] = 6000-i*200;
74       prob[2*i+1] = ec_laplace_get_start_freq(prob[2*i]);
75    }
76    for (i=0;i<m->nbEBands;i++)
77    {
78       prob[2*m->nbEBands+2*i] = 9000-i*240;
79       prob[2*m->nbEBands+2*i+1] = ec_laplace_get_start_freq(prob[2*m->nbEBands+2*i]);
80    }
81    return prob;
82 }
83
84 void quant_prob_free(int *freq)
85 {
86    celt_free(freq);
87 }
88
89 unsigned quant_coarse_energy(const CELTMode *m, celt_word16 *eBands, celt_word16 *oldEBands, int budget, int intra, int *prob, celt_word16 *error, ec_enc *enc, int _C)
90 {
91    int i, c;
92    unsigned bits_used = 0;
93    celt_word16 prev[2] = {0,0};
94    celt_word16 coef = m->ePredCoef;
95    celt_word16 beta;
96    const int C = CHANNELS(_C);
97
98    if (intra)
99    {
100       coef = 0;
101       prob += 2*m->nbEBands;
102    }
103    /* The .8 is a heuristic */
104    beta = MULT16_16_Q15(QCONST16(.8f,15),coef);
105
106    /* Encode at a fixed coarse resolution */
107    for (i=0;i<m->nbEBands;i++)
108    {
109       c=0;
110       do {
111          int qi;
112          celt_word16 q;   /* dB */
113          celt_word16 x;   /* dB */
114          celt_word16 f;   /* Q8 */
115          celt_word16 mean = MULT16_16_Q15(Q15ONE-coef,eMeans[i]);
116          x = eBands[i+c*m->nbEBands];
117 #ifdef FIXED_POINT
118          f = x-mean -MULT16_16_Q15(coef,oldEBands[i+c*m->nbEBands])-prev[c];
119          /* Rounding to nearest integer here is really important! */
120          qi = (f+128)>>8;
121 #else
122          f = x-mean-coef*oldEBands[i+c*m->nbEBands]-prev[c];
123          /* Rounding to nearest integer here is really important! */
124          qi = (int)floor(.5f+f);
125 #endif
126          /* If we don't have enough bits to encode all the energy, just assume something safe.
127             We allow slightly busting the budget here */
128          bits_used=ec_enc_tell(enc, 0);
129          if (bits_used > budget)
130          {
131             qi = -1;
132             error[i+c*m->nbEBands] = 128;
133          } else {
134             ec_laplace_encode_start(enc, &qi, prob[2*i], prob[2*i+1]);
135             error[i+c*m->nbEBands] = f - SHL16(qi,8);
136          }
137          q = SHL16(qi,DB_SHIFT);
138          
139          oldEBands[i+c*m->nbEBands] = MULT16_16_Q15(coef,oldEBands[i+c*m->nbEBands])+(mean+prev[c]+q);
140          prev[c] = mean+prev[c]+MULT16_16_Q15(Q15ONE-beta,q);
141       } while (++c < C);
142    }
143    return bits_used;
144 }
145
146 void quant_fine_energy(const CELTMode *m, celt_ener *eBands, celt_word16 *oldEBands, celt_word16 *error, int *fine_quant, ec_enc *enc, int _C)
147 {
148    int i, c;
149    const int C = CHANNELS(_C);
150
151    /* Encode finer resolution */
152    for (i=0;i<m->nbEBands;i++)
153    {
154       celt_int16 frac = 1<<fine_quant[i];
155       if (fine_quant[i] <= 0)
156          continue;
157       c=0;
158       do {
159          int q2;
160          celt_word16 offset;
161 #ifdef FIXED_POINT
162          /* Has to be without rounding */
163          q2 = (error[i+c*m->nbEBands]+QCONST16(.5f,8))>>(8-fine_quant[i]);
164 #else
165          q2 = (int)floor((error[i+c*m->nbEBands]+.5f)*frac);
166 #endif
167          if (q2 > frac-1)
168             q2 = frac-1;
169          ec_enc_bits(enc, q2, fine_quant[i]);
170 #ifdef FIXED_POINT
171          offset = SUB16(SHR16(SHL16(q2,8)+QCONST16(.5,8),fine_quant[i]),QCONST16(.5f,8));
172 #else
173          offset = (q2+.5f)*(1<<(14-fine_quant[i]))*(1.f/16384) - .5f;
174 #endif
175          oldEBands[i+c*m->nbEBands] += offset;
176          error[i+c*m->nbEBands] -= offset;
177          eBands[i+c*m->nbEBands] = log2Amp(oldEBands[i+c*m->nbEBands]);
178          /*printf ("%f ", error[i] - offset);*/
179       } while (++c < C);
180    }
181    for (i=0;i<C*m->nbEBands;i++)
182       eBands[i] = log2Amp(oldEBands[i]);
183 }
184
185 void quant_energy_finalise(const CELTMode *m, celt_ener *eBands, celt_word16 *oldEBands, celt_word16 *error, int *fine_quant, int *fine_priority, int bits_left, ec_enc *enc, int _C)
186 {
187    int i, prio, c;
188    const int C = CHANNELS(_C);
189
190    /* Use up the remaining bits */
191    for (prio=0;prio<2;prio++)
192    {
193       for (i=0;i<m->nbEBands && bits_left>=C ;i++)
194       {
195          if (fine_quant[i] >= 7 || fine_priority[i]!=prio)
196             continue;
197          c=0;
198          do {
199             int q2;
200             celt_word16 offset;
201             q2 = error[i+c*m->nbEBands]<0 ? 0 : 1;
202             ec_enc_bits(enc, q2, 1);
203 #ifdef FIXED_POINT
204             offset = SHR16(SHL16(q2,8)-QCONST16(.5,8),fine_quant[i]+1);
205 #else
206             offset = (q2-.5f)*(1<<(14-fine_quant[i]-1))*(1.f/16384);
207 #endif
208             oldEBands[i+c*m->nbEBands] += offset;
209             bits_left--;
210          } while (++c < C);
211       }
212    }
213    for (i=0;i<C*m->nbEBands;i++)
214    {
215       eBands[i] = log2Amp(oldEBands[i]);
216       if (oldEBands[i] < -QCONST16(7.f,8))
217          oldEBands[i] = -QCONST16(7.f,8);
218    }
219 }
220
221 void unquant_coarse_energy(const CELTMode *m, celt_ener *eBands, celt_word16 *oldEBands, int budget, int intra, int *prob, ec_dec *dec, int _C)
222 {
223    int i, c;
224    celt_word16 prev[2] = {0, 0};
225    celt_word16 coef = m->ePredCoef;
226    celt_word16 beta;
227    const int C = CHANNELS(_C);
228
229    if (intra)
230    {
231       coef = 0;
232       prob += 2*m->nbEBands;
233    }
234    /* The .8 is a heuristic */
235    beta = MULT16_16_Q15(QCONST16(.8f,15),coef);
236
237    /* Decode at a fixed coarse resolution */
238    for (i=0;i<m->nbEBands;i++)
239    {
240       c=0; 
241       do {
242          int qi;
243          celt_word16 q;
244          celt_word16 mean = MULT16_16_Q15(Q15ONE-coef,eMeans[i]);
245          /* If we didn't have enough bits to encode all the energy, just assume something safe.
246             We allow slightly busting the budget here */
247          if (ec_dec_tell(dec, 0) > budget)
248             qi = -1;
249          else
250             qi = ec_laplace_decode_start(dec, prob[2*i], prob[2*i+1]);
251          q = SHL16(qi,DB_SHIFT);
252
253          oldEBands[i+c*m->nbEBands] = MULT16_16_Q15(coef,oldEBands[i+c*m->nbEBands])+(mean+prev[c]+q);
254          prev[c] = mean+prev[c]+MULT16_16_Q15(Q15ONE-beta,q);
255       } while (++c < C);
256    }
257 }
258
259 void unquant_fine_energy(const CELTMode *m, celt_ener *eBands, celt_word16 *oldEBands, int *fine_quant, ec_dec *dec, int _C)
260 {
261    int i, c;
262    const int C = CHANNELS(_C);
263    /* Decode finer resolution */
264    for (i=0;i<m->nbEBands;i++)
265    {
266       if (fine_quant[i] <= 0)
267          continue;
268       c=0; 
269       do {
270          int q2;
271          celt_word16 offset;
272          q2 = ec_dec_bits(dec, fine_quant[i]);
273 #ifdef FIXED_POINT
274          offset = SUB16(SHR16(SHL16(q2,8)+QCONST16(.5,8),fine_quant[i]),QCONST16(.5f,8));
275 #else
276          offset = (q2+.5f)*(1<<(14-fine_quant[i]))*(1.f/16384) - .5f;
277 #endif
278          oldEBands[i+c*m->nbEBands] += offset;
279       } while (++c < C);
280    }
281    for (i=0;i<C*m->nbEBands;i++)
282       eBands[i] = log2Amp(oldEBands[i]);
283 }
284
285 void unquant_energy_finalise(const CELTMode *m, celt_ener *eBands, celt_word16 *oldEBands, int *fine_quant,  int *fine_priority, int bits_left, ec_dec *dec, int _C)
286 {
287    int i, prio, c;
288    const int C = CHANNELS(_C);
289
290    /* Use up the remaining bits */
291    for (prio=0;prio<2;prio++)
292    {
293       for (i=0;i<m->nbEBands && bits_left>=C ;i++)
294       {
295          if (fine_quant[i] >= 7 || fine_priority[i]!=prio)
296             continue;
297          c=0;
298          do {
299             int q2;
300             celt_word16 offset;
301             q2 = ec_dec_bits(dec, 1);
302 #ifdef FIXED_POINT
303             offset = SHR16(SHL16(q2,8)-QCONST16(.5,8),fine_quant[i]+1);
304 #else
305             offset = (q2-.5f)*(1<<(14-fine_quant[i]-1))*(1.f/16384);
306 #endif
307             oldEBands[i+c*m->nbEBands] += offset;
308             bits_left--;
309          } while (++c < C);
310       }
311    }
312    for (i=0;i<C*m->nbEBands;i++)
313    {
314       eBands[i] = log2Amp(oldEBands[i]);
315       if (oldEBands[i] < -QCONST16(7.f,8))
316          oldEBands[i] = -QCONST16(7.f,8);
317    }
318 }