Squashed commit of the following:
[opus.git] / libcelt / rate.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 <math.h>
38 #include "modes.h"
39 #include "cwrs.h"
40 #include "arch.h"
41 #include "os_support.h"
42
43 #include "entcode.h"
44 #include "rate.h"
45
46
47 #ifndef STATIC_MODES
48
49 /*Determines if V(N,K) fits in a 32-bit unsigned integer.
50   N and K are themselves limited to 15 bits.*/
51 static int fits_in32(int _n, int _k)
52 {
53    static const celt_int16 maxN[15] = {
54       32767, 32767, 32767, 1476, 283, 109,  60,  40,
55        29,  24,  20,  18,  16,  14,  13};
56    static const celt_int16 maxK[15] = {
57       32767, 32767, 32767, 32767, 1172, 238,  95,  53,
58        36,  27,  22,  18,  16,  15,  13};
59    if (_n>=14)
60    {
61       if (_k>=14)
62          return 0;
63       else
64          return _n <= maxN[_k];
65    } else {
66       return _k <= maxK[_n];
67    }
68 }
69
70 void compute_pulse_cache(CELTMode *m, int LM)
71 {
72    int i;
73    int curr=0;
74    int nbEntries=0;
75    int entryN[100], entryK[100], entryI[100];
76    const celt_int16 *eBands = m->eBands;
77    PulseCache *cache = &m->cache;
78    celt_int16 *cindex;
79    unsigned char *bits;
80
81    cindex = celt_alloc(sizeof(cache->index[0])*m->nbEBands*(LM+2));
82    cache->index = cindex;
83
84    /* Scan for all unique band sizes */
85    for (i=0;i<=LM+1;i++)
86    {
87       int j;
88       for (j=0;j<m->nbEBands;j++)
89       {
90          int k;
91          int N = (eBands[j+1]-eBands[j])<<i>>1;
92          cindex[i*m->nbEBands+j] = -1;
93          /* Find other bands that have the same size */
94          for (k=0;k<=i;k++)
95          {
96             int n;
97             for (n=0;n<m->nbEBands && (k!=i || n<j);n++)
98             {
99                if (N == (eBands[n+1]-eBands[n])<<k>>1)
100                {
101                   cindex[i*m->nbEBands+j] = cindex[k*m->nbEBands+n];
102                   break;
103                }
104             }
105          }
106          if (cache->index[i*m->nbEBands+j] == -1 && N!=0)
107          {
108             int K;
109             entryN[nbEntries] = N;
110             K = 0;
111             while (fits_in32(N,get_pulses(K+1)) && K<MAX_PSEUDO)
112                K++;
113             entryK[nbEntries] = K;
114             cindex[i*m->nbEBands+j] = curr;
115             entryI[nbEntries] = curr;
116
117             curr += K+1;
118             nbEntries++;
119          }
120       }
121    }
122    bits = celt_alloc(sizeof(unsigned char)*curr);
123    cache->bits = bits;
124    cache->size = curr;
125    /* Compute the cache for all unique sizes */
126    for (i=0;i<nbEntries;i++)
127    {
128       int j;
129       unsigned char *ptr = bits+entryI[i];
130       celt_int16 tmp[MAX_PULSES+1];
131       get_required_bits(tmp, entryN[i], get_pulses(entryK[i]), BITRES);
132       for (j=1;j<=entryK[i];j++)
133          ptr[j] = tmp[get_pulses(j)]-1;
134       ptr[0] = entryK[i];
135    }
136 }
137
138 #endif /* !STATIC_MODES */
139
140
141 #define ALLOC_STEPS 6
142
143 static inline int interp_bits2pulses(const CELTMode *m, int start, int end, int *bits1, int *bits2, int total, int *bits, int *ebits, int *fine_priority, int len, int _C, int LM)
144 {
145    int psum;
146    int lo, hi;
147    int i, j;
148    int logM;
149    const int C = CHANNELS(_C);
150    int codedBands=-1;
151    VARDECL(int, thresh);
152    SAVE_STACK;
153
154    ALLOC(thresh, len, int);
155
156    /* Threshold: don't allow any band to go below 3/8 bit/sample */
157    for (j=start;j<end;j++)
158       thresh[j] = 3*(C*(m->eBands[j+1]-m->eBands[j])<<LM<<BITRES)>>3;
159    logM = LM<<BITRES;
160    lo = 0;
161    hi = 1<<ALLOC_STEPS;
162    for (i=0;i<ALLOC_STEPS;i++)
163    {
164       int mid = (lo+hi)>>1;
165       psum = 0;
166       for (j=start;j<end;j++)
167       {
168          int tmp = bits1[j] + (mid*bits2[j]>>ALLOC_STEPS);
169          if (tmp >= thresh[j])
170             psum += tmp;
171          else if (tmp >= 1<<BITRES)
172             psum += 1<<BITRES;
173       }
174       if (psum > (total<<BITRES))
175          hi = mid;
176       else
177          lo = mid;
178    }
179    psum = 0;
180    /*printf ("interp bisection gave %d\n", lo);*/
181    for (j=start;j<end;j++)
182    {
183       int tmp = bits1[j] + (lo*bits2[j]>>ALLOC_STEPS);
184       if (tmp >= thresh[j])
185       {
186          bits[j] = tmp;
187          codedBands = j;
188       } else if (tmp >= 1<<BITRES)
189          bits[j] = 1<<BITRES;
190       else
191          bits[j] = 0;
192       psum += bits[j];
193    }
194    codedBands++;
195    /* Allocate the remaining bits */
196    if (codedBands) {
197       int left, perband;
198       left = (total<<BITRES)-psum;
199       perband = left/(codedBands-start);
200       for (j=start;j<codedBands;j++)
201          bits[j] += perband;
202       left = left-codedBands*perband;
203       for (j=start;j<start+left;j++)
204          bits[j]++;
205    }
206    for (j=start;j<end;j++)
207    {
208       int N0, N, den;
209       int offset;
210       int NClogN;
211
212       N0 = m->eBands[j+1]-m->eBands[j];
213       N=N0<<LM;
214       NClogN = N*C*(m->logN[j] + logM);
215
216       /* Compensate for the extra DoF in stereo */
217       den=(C*N+ ((C==2 && N>2) ? 1 : 0));
218
219       /* Offset for the number of fine bits by log2(N)/2 + FINE_OFFSET
220          compared to their "fair share" of total/N */
221       offset = (NClogN>>1)-N*C*FINE_OFFSET;
222
223       /* N=2 is the only point that doesn't match the curve */
224       if (N==2)
225          offset += N*C<<BITRES>>2;
226
227       /* Changing the offset for allocating the second and third fine energy bit */
228       if (bits[j] + offset < den*2<<BITRES)
229          offset += NClogN>>2;
230       else if (bits[j] + offset < den*3<<BITRES)
231          offset += NClogN>>3;
232
233       /* Divide with rounding */
234       ebits[j] = (bits[j] + offset + (den<<(BITRES-1))) / (den<<BITRES);
235
236       /* If we rounded down, make it a candidate for final fine energy pass */
237       fine_priority[j] = ebits[j]*(den<<BITRES) >= bits[j]+offset;
238
239       /* For N=1, all bits go to fine energy except for a single sign bit */
240       if (N==1)
241          ebits[j] = (bits[j]/C >> BITRES)-1;
242       /* Make sure the first bit is spent on fine energy */
243       if (ebits[j] < 1)
244          ebits[j] = 1;
245
246       /* Make sure not to bust */
247       if (C*ebits[j] > (bits[j]>>BITRES))
248          ebits[j] = bits[j]/C >> BITRES;
249
250       /* More than that is useless because that's about as far as PVQ can go */
251       if (ebits[j]>7)
252          ebits[j]=7;
253
254       /* The other bits are assigned to PVQ */
255       bits[j] -= C*ebits[j]<<BITRES;
256       if (bits[j] < 0)
257          bits[j] = 0;
258    }
259    RESTORE_STACK;
260    return codedBands;
261 }
262
263 int compute_allocation(const CELTMode *m, int start, int end, int *offsets, int alloc_trim,
264       int total, int *pulses, int *ebits, int *fine_priority, int _C, int LM)
265 {
266    int lo, hi, len, j;
267    const int C = CHANNELS(_C);
268    int codedBands;
269    VARDECL(int, bits1);
270    VARDECL(int, bits2);
271    VARDECL(int, thresh);
272    VARDECL(int, trim_offset);
273    SAVE_STACK;
274    
275    len = m->nbEBands;
276    ALLOC(bits1, len, int);
277    ALLOC(bits2, len, int);
278    ALLOC(thresh, len, int);
279    ALLOC(trim_offset, len, int);
280
281    /* Below this threshold, we don't allocate any PVQ bits */
282    for (j=start;j<end;j++)
283       thresh[j] = 3*(C*(m->eBands[j+1]-m->eBands[j])<<LM<<BITRES)>>3;
284    /* Tilt of the allocation curve */
285    for (j=start;j<end;j++)
286       trim_offset[j] = C*(m->eBands[j+1]-m->eBands[j])*(2*alloc_trim-7)*(m->nbEBands-j-1)
287             <<(LM+BITRES)>>6;
288
289    lo = 0;
290    hi = m->nbAllocVectors - 1;
291    while (hi-lo != 1)
292    {
293       int psum = 0;
294       int mid = (lo+hi) >> 1;
295       for (j=start;j<end;j++)
296       {
297          int N = m->eBands[j+1]-m->eBands[j];
298          bits1[j] = C*N*m->allocVectors[mid*len+j]<<LM>>2;
299          if (bits1[j] > 0)
300             bits1[j] += trim_offset[j];
301          if (bits1[j] < 0)
302             bits1[j] = 0;
303          bits1[j] += offsets[j];
304          if (bits1[j] >= thresh[j])
305             psum += bits1[j];
306          else if (bits1[j] >= 1<<BITRES)
307             psum += 1<<BITRES;
308
309          /*printf ("%d ", bits[j]);*/
310       }
311       /*printf ("\n");*/
312       if (psum > (total<<BITRES))
313          hi = mid;
314       else
315          lo = mid;
316       /*printf ("lo = %d, hi = %d\n", lo, hi);*/
317    }
318    /*printf ("interp between %d and %d\n", lo, hi);*/
319    for (j=start;j<end;j++)
320    {
321       int N = m->eBands[j+1]-m->eBands[j];
322       bits1[j] = (C*N*m->allocVectors[lo*len+j]<<LM>>2);
323       bits2[j] = (C*N*m->allocVectors[hi*len+j]<<LM>>2) - bits1[j];
324       if (bits1[j] > 0)
325          bits1[j] += trim_offset[j];
326       if (bits1[j] < 0)
327          bits1[j] = 0;
328       bits1[j] += offsets[j];
329    }
330    codedBands = interp_bits2pulses(m, start, end, bits1, bits2, total, pulses, ebits, fine_priority, len, C, LM);
331    RESTORE_STACK;
332    return codedBands;
333 }
334