Changed all the celt*int*_t types to remove the _t suffix, which is reserved
[opus.git] / libcelt / quant_bands.c
1 /* (C) 2007-2008 Jean-Marc Valin, CSIRO
2 */
3 /*
4    Redistribution and use in source and binary forms, with or without
5    modification, are permitted provided that the following conditions
6    are met:
7    
8    - Redistributions of source code must retain the above copyright
9    notice, this list of conditions and the following disclaimer.
10    
11    - Redistributions in binary form must reproduce the above copyright
12    notice, this list of conditions and the following disclaimer in the
13    documentation and/or other materials provided with the distribution.
14    
15    - Neither the name of the Xiph.org Foundation nor the names of its
16    contributors may be used to endorse or promote products derived from
17    this software without specific prior written permission.
18    
19    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
23    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31
32 #ifdef HAVE_CONFIG_H
33 #include "config.h"
34 #endif
35
36 #include "quant_bands.h"
37 #include "laplace.h"
38 #include <math.h>
39 #include "os_support.h"
40 #include "arch.h"
41 #include "mathops.h"
42 #include "stack_alloc.h"
43
44 #ifdef FIXED_POINT
45 const celt_word16_t 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};
46 #else
47 const celt_word16_t 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};
48 #endif
49
50 /* FIXME: Implement for stereo */
51 int intra_decision(celt_word16_t *eBands, celt_word16_t *oldEBands, int len)
52 {
53    int i;
54    celt_word32_t dist = 0;
55    for (i=0;i<len;i++)
56    {
57       celt_word16_t d = SUB16(eBands[i], oldEBands[i]);
58       dist = MAC16_16(dist, d,d);
59    }
60    return SHR32(dist,16) > 2*len;
61 }
62
63 int *quant_prob_alloc(const CELTMode *m)
64 {
65    int i;
66    int *prob;
67    prob = celt_alloc(4*m->nbEBands*sizeof(int));
68    if (prob==NULL)
69      return NULL;
70    for (i=0;i<m->nbEBands;i++)
71    {
72       prob[2*i] = 6000-i*200;
73       prob[2*i+1] = ec_laplace_get_start_freq(prob[2*i]);
74    }
75    for (i=0;i<m->nbEBands;i++)
76    {
77       prob[2*m->nbEBands+2*i] = 9000-i*240;
78       prob[2*m->nbEBands+2*i+1] = ec_laplace_get_start_freq(prob[2*m->nbEBands+2*i]);
79    }
80    return prob;
81 }
82
83 void quant_prob_free(int *freq)
84 {
85    celt_free(freq);
86 }
87
88 unsigned quant_coarse_energy(const CELTMode *m, celt_word16_t *eBands, celt_word16_t *oldEBands, int budget, int intra, int *prob, celt_word16_t *error, ec_enc *enc, int _C)
89 {
90    int i, c;
91    unsigned bits;
92    unsigned bits_used = 0;
93    celt_word16_t prev[2] = {0,0};
94    celt_word16_t coef = m->ePredCoef;
95    celt_word16_t 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    bits = ec_enc_tell(enc, 0);
107    /* Encode at a fixed coarse resolution */
108    for (i=0;i<m->nbEBands;i++)
109    {
110       c=0;
111       do {
112          int qi;
113          celt_word16_t q;   /* dB */
114          celt_word16_t x;   /* dB */
115          celt_word16_t f;   /* Q8 */
116          celt_word16_t mean = MULT16_16_Q15(Q15ONE-coef,eMeans[i]);
117          x = eBands[i+c*m->nbEBands];
118 #ifdef FIXED_POINT
119          f = x-mean -MULT16_16_Q15(coef,oldEBands[i+c*m->nbEBands])-prev[c];
120          /* Rounding to nearest integer here is really important! */
121          qi = (f+128)>>8;
122 #else
123          f = x-mean-coef*oldEBands[i+c*m->nbEBands]-prev[c];
124          /* Rounding to nearest integer here is really important! */
125          qi = (int)floor(.5f+f);
126 #endif
127          /* If we don't have enough bits to encode all the energy, just assume something safe.
128             We allow slightly busting the budget here */
129          bits_used=ec_enc_tell(enc, 0) - bits;
130          if (bits_used > budget)
131          {
132             qi = -1;
133             error[i+c*m->nbEBands] = 128;
134          } else {
135             ec_laplace_encode_start(enc, &qi, prob[2*i], prob[2*i+1]);
136             error[i+c*m->nbEBands] = f - SHL16(qi,8);
137          }
138          q = qi*DB_SCALING;
139          
140          oldEBands[i+c*m->nbEBands] = MULT16_16_Q15(coef,oldEBands[i+c*m->nbEBands])+(mean+prev[c]+q);
141          prev[c] = mean+prev[c]+MULT16_16_Q15(Q15ONE-beta,q);
142       } while (++c < C);
143    }
144    return bits_used;
145 }
146
147 void quant_fine_energy(const CELTMode *m, celt_ener_t *eBands, celt_word16_t *oldEBands, celt_word16_t *error, int *fine_quant, ec_enc *enc, int _C)
148 {
149    int i, c;
150    const int C = CHANNELS(_C);
151
152    /* Encode finer resolution */
153    for (i=0;i<m->nbEBands;i++)
154    {
155       celt_int16 frac = 1<<fine_quant[i];
156       if (fine_quant[i] <= 0)
157          continue;
158       c=0;
159       do {
160          int q2;
161          celt_word16_t offset;
162 #ifdef FIXED_POINT
163          /* Has to be without rounding */
164          q2 = (error[i+c*m->nbEBands]+QCONST16(.5f,8))>>(8-fine_quant[i]);
165 #else
166          q2 = (int)floor((error[i+c*m->nbEBands]+.5f)*frac);
167 #endif
168          if (q2 > frac-1)
169             q2 = frac-1;
170          ec_enc_bits(enc, q2, fine_quant[i]);
171 #ifdef FIXED_POINT
172          offset = SUB16(SHR16(SHL16(q2,8)+QCONST16(.5,8),fine_quant[i]),QCONST16(.5f,8));
173 #else
174          offset = (q2+.5f)*(1<<(14-fine_quant[i]))*(1.f/16384) - .5f;
175 #endif
176          oldEBands[i+c*m->nbEBands] += offset;
177          error[i+c*m->nbEBands] -= offset;
178          eBands[i+c*m->nbEBands] = log2Amp(oldEBands[i+c*m->nbEBands]);
179          /*printf ("%f ", error[i] - offset);*/
180       } while (++c < C);
181    }
182    for (i=0;i<C*m->nbEBands;i++)
183       eBands[i] = log2Amp(oldEBands[i]);
184 }
185
186 void quant_energy_finalise(const CELTMode *m, celt_ener_t *eBands, celt_word16_t *oldEBands, celt_word16_t *error, int *fine_quant, int *fine_priority, int bits_left, ec_enc *enc, int _C)
187 {
188    int i, prio, c;
189    const int C = CHANNELS(_C);
190
191    /* Use up the remaining bits */
192    for (prio=0;prio<2;prio++)
193    {
194       for (i=0;i<m->nbEBands && bits_left>=C ;i++)
195       {
196          if (fine_quant[i] >= 7 || fine_priority[i]!=prio)
197             continue;
198          c=0;
199          do {
200             int q2;
201             celt_word16_t offset;
202             q2 = error[i+c*m->nbEBands]<0 ? 0 : 1;
203             ec_enc_bits(enc, q2, 1);
204 #ifdef FIXED_POINT
205             offset = SHR16(SHL16(q2,8)-QCONST16(.5,8),fine_quant[i]+1);
206 #else
207             offset = (q2-.5f)*(1<<(14-fine_quant[i]-1))*(1.f/16384);
208 #endif
209             oldEBands[i+c*m->nbEBands] += offset;
210             bits_left--;
211          } while (++c < C);
212       }
213    }
214    for (i=0;i<C*m->nbEBands;i++)
215    {
216       eBands[i] = log2Amp(oldEBands[i]);
217       if (oldEBands[i] < -QCONST16(7.f,8))
218          oldEBands[i] = -QCONST16(7.f,8);
219    }
220 }
221
222 void unquant_coarse_energy(const CELTMode *m, celt_ener_t *eBands, celt_word16_t *oldEBands, int budget, int intra, int *prob, ec_dec *dec, int _C)
223 {
224    int i, c;
225    unsigned bits;
226    celt_word16_t prev[2] = {0, 0};
227    celt_word16_t coef = m->ePredCoef;
228    celt_word16_t beta;
229    const int C = CHANNELS(_C);
230
231    if (intra)
232    {
233       coef = 0;
234       prob += 2*m->nbEBands;
235    }
236    /* The .8 is a heuristic */
237    beta = MULT16_16_Q15(QCONST16(.8f,15),coef);
238    
239    bits = ec_dec_tell(dec, 0);
240    /* Decode at a fixed coarse resolution */
241    for (i=0;i<m->nbEBands;i++)
242    {
243       c=0; 
244       do {
245          int qi;
246          celt_word16_t q;
247          celt_word16_t mean = MULT16_16_Q15(Q15ONE-coef,eMeans[i]);
248          /* If we didn't have enough bits to encode all the energy, just assume something safe.
249             We allow slightly busting the budget here */
250          if (ec_dec_tell(dec, 0) - bits > budget)
251             qi = -1;
252          else
253             qi = ec_laplace_decode_start(dec, prob[2*i], prob[2*i+1]);
254          q = qi*DB_SCALING;
255
256          oldEBands[i+c*m->nbEBands] = MULT16_16_Q15(coef,oldEBands[i+c*m->nbEBands])+(mean+prev[c]+q);
257          prev[c] = mean+prev[c]+MULT16_16_Q15(Q15ONE-beta,q);
258       } while (++c < C);
259    }
260 }
261
262 void unquant_fine_energy(const CELTMode *m, celt_ener_t *eBands, celt_word16_t *oldEBands, int *fine_quant, ec_dec *dec, int _C)
263 {
264    int i, c;
265    const int C = CHANNELS(_C);
266    /* Decode finer resolution */
267    for (i=0;i<m->nbEBands;i++)
268    {
269       if (fine_quant[i] <= 0)
270          continue;
271       c=0; 
272       do {
273          int q2;
274          celt_word16_t offset;
275          q2 = ec_dec_bits(dec, fine_quant[i]);
276 #ifdef FIXED_POINT
277          offset = SUB16(SHR16(SHL16(q2,8)+QCONST16(.5,8),fine_quant[i]),QCONST16(.5f,8));
278 #else
279          offset = (q2+.5f)*(1<<(14-fine_quant[i]))*(1.f/16384) - .5f;
280 #endif
281          oldEBands[i+c*m->nbEBands] += offset;
282       } while (++c < C);
283    }
284    for (i=0;i<C*m->nbEBands;i++)
285       eBands[i] = log2Amp(oldEBands[i]);
286 }
287
288 void unquant_energy_finalise(const CELTMode *m, celt_ener_t *eBands, celt_word16_t *oldEBands, int *fine_quant,  int *fine_priority, int bits_left, ec_dec *dec, int _C)
289 {
290    int i, prio, c;
291    const int C = CHANNELS(_C);
292
293    /* Use up the remaining bits */
294    for (prio=0;prio<2;prio++)
295    {
296       for (i=0;i<m->nbEBands && bits_left>=C ;i++)
297       {
298          if (fine_quant[i] >= 7 || fine_priority[i]!=prio)
299             continue;
300          c=0;
301          do {
302             int q2;
303             celt_word16_t offset;
304             q2 = ec_dec_bits(dec, 1);
305 #ifdef FIXED_POINT
306             offset = SHR16(SHL16(q2,8)-QCONST16(.5,8),fine_quant[i]+1);
307 #else
308             offset = (q2-.5f)*(1<<(14-fine_quant[i]-1))*(1.f/16384);
309 #endif
310             oldEBands[i+c*m->nbEBands] += offset;
311             bits_left--;
312          } while (++c < C);
313       }
314    }
315    for (i=0;i<C*m->nbEBands;i++)
316    {
317       eBands[i] = log2Amp(oldEBands[i]);
318       if (oldEBands[i] < -QCONST16(7.f,8))
319          oldEBands[i] = -QCONST16(7.f,8);
320    }
321 }