cf007c42c3a44e281dc4216dda1f5f70a0021970
[opus.git] / libcelt / cwrs.c
1 /* Copyright (c) 2007-2008 CSIRO
2    Copyright (c) 2007-2009 Xiph.Org Foundation
3    Copyright (c) 2007-2009 Timothy B. Terriberry
4    Written by Timothy B. Terriberry and Jean-Marc Valin */
5 /*
6    Redistribution and use in source and binary forms, with or without
7    modification, are permitted provided that the following conditions
8    are met:
9
10    - Redistributions of source code must retain the above copyright
11    notice, this list of conditions and the following disclaimer.
12
13    - Redistributions in binary form must reproduce the above copyright
14    notice, this list of conditions and the following disclaimer in the
15    documentation and/or other materials provided with the distribution.
16
17    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
21    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29
30 #ifdef HAVE_CONFIG_H
31 #include "config.h"
32 #endif
33
34 #include "os_support.h"
35 #include <stdlib.h>
36 #include <string.h>
37 #include "cwrs.h"
38 #include "mathops.h"
39 #include "arch.h"
40
41 #ifdef CUSTOM_MODES
42
43 /*Guaranteed to return a conservatively large estimate of the binary logarithm
44    with frac bits of fractional precision.
45   Tested for all possible 32-bit inputs with frac=4, where the maximum
46    overestimation is 0.06254243 bits.*/
47 int log2_frac(opus_uint32 val, int frac)
48 {
49   int l;
50   l=EC_ILOG(val);
51   if(val&val-1){
52     /*This is (val>>l-16), but guaranteed to round up, even if adding a bias
53        before the shift would cause overflow (e.g., for 0xFFFFxxxx).*/
54     if(l>16)val=(val>>l-16)+((val&(1<<l-16)-1)+(1<<l-16)-1>>l-16);
55     else val<<=16-l;
56     l=l-1<<frac;
57     /*Note that we always need one iteration, since the rounding up above means
58        that we might need to adjust the integer part of the logarithm.*/
59     do{
60       int b;
61       b=(int)(val>>16);
62       l+=b<<frac;
63       val=val+b>>b;
64       val=val*val+0x7FFF>>15;
65     }
66     while(frac-->0);
67     /*If val is not exactly 0x8000, then we have to round up the remainder.*/
68     return l+(val>0x8000);
69   }
70   /*Exact powers of two require no rounding.*/
71   else return l-1<<frac;
72 }
73 #endif
74
75 #ifndef SMALL_FOOTPRINT
76
77 #define MASK32 (0xFFFFFFFF)
78
79 /*INV_TABLE[i] holds the multiplicative inverse of (2*i+1) mod 2**32.*/
80 static const opus_uint32 INV_TABLE[64]={
81   0x00000001,0xAAAAAAAB,0xCCCCCCCD,0xB6DB6DB7,
82   0x38E38E39,0xBA2E8BA3,0xC4EC4EC5,0xEEEEEEEF,
83   0xF0F0F0F1,0x286BCA1B,0x3CF3CF3D,0xE9BD37A7,
84   0xC28F5C29,0x684BDA13,0x4F72C235,0xBDEF7BDF,
85   0x3E0F83E1,0x8AF8AF8B,0x914C1BAD,0x96F96F97,
86   0xC18F9C19,0x2FA0BE83,0xA4FA4FA5,0x677D46CF,
87   0x1A1F58D1,0xFAFAFAFB,0x8C13521D,0x586FB587,
88   0xB823EE09,0xA08AD8F3,0xC10C9715,0xBEFBEFBF,
89   0xC0FC0FC1,0x07A44C6B,0xA33F128D,0xE327A977,
90   0xC7E3F1F9,0x962FC963,0x3F2B3885,0x613716AF,
91   0x781948B1,0x2B2E43DB,0xFCFCFCFD,0x6FD0EB67,
92   0xFA3F47E9,0xD2FD2FD3,0x3F4FD3F5,0xD4E25B9F,
93   0x5F02A3A1,0xBF5A814B,0x7C32B16D,0xD3431B57,
94   0xD8FD8FD9,0x8D28AC43,0xDA6C0965,0xDB195E8F,
95   0x0FDBC091,0x61F2A4BB,0xDCFDCFDD,0x46FDD947,
96   0x56BE69C9,0xEB2FDEB3,0x26E978D5,0xEFDFBF7F,
97 };
98
99 /*Computes (_a*_b-_c)/(2*_d+1) when the quotient is known to be exact.
100   _a, _b, _c, and _d may be arbitrary so long as the arbitrary precision result
101    fits in 32 bits, but currently the table for multiplicative inverses is only
102    valid for _d<64.*/
103 static inline opus_uint32 imusdiv32odd(opus_uint32 _a,opus_uint32 _b,
104  opus_uint32 _c,int _d){
105   return (_a*_b-_c)*INV_TABLE[_d]&MASK32;
106 }
107
108 /*Computes (_a*_b-_c)/_d when the quotient is known to be exact.
109   _d does not actually have to be even, but imusdiv32odd will be faster when
110    it's odd, so you should use that instead.
111   _a and _d are assumed to be small (e.g., _a*_d fits in 32 bits; currently the
112    table for multiplicative inverses is only valid for _d<=127).
113   _b and _c may be arbitrary so long as the arbitrary precision reuslt fits in
114    32 bits.*/
115 static inline opus_uint32 imusdiv32even(opus_uint32 _a,opus_uint32 _b,
116  opus_uint32 _c,int _d){
117   opus_uint32 inv;
118   int           mask;
119   int           shift;
120   int           one;
121   celt_assert(_d>0);
122   shift=EC_ILOG(_d^_d-1);
123   celt_assert(_d<=127);
124   inv=INV_TABLE[_d-1>>shift];
125   shift--;
126   one=1<<shift;
127   mask=one-1;
128   return (_a*(_b>>shift)-(_c>>shift)+
129    (_a*(_b&mask)+one-(_c&mask)>>shift)-1)*inv&MASK32;
130 }
131
132 #endif /* SMALL_FOOTPRINT */
133
134 /*Although derived separately, the pulse vector coding scheme is equivalent to
135    a Pyramid Vector Quantizer \cite{Fis86}.
136   Some additional notes about an early version appear at
137    http://people.xiph.org/~tterribe/notes/cwrs.html, but the codebook ordering
138    and the definitions of some terms have evolved since that was written.
139
140   The conversion from a pulse vector to an integer index (encoding) and back
141    (decoding) is governed by two related functions, V(N,K) and U(N,K).
142
143   V(N,K) = the number of combinations, with replacement, of N items, taken K
144    at a time, when a sign bit is added to each item taken at least once (i.e.,
145    the number of N-dimensional unit pulse vectors with K pulses).
146   One way to compute this is via
147     V(N,K) = K>0 ? sum(k=1...K,2**k*choose(N,k)*choose(K-1,k-1)) : 1,
148    where choose() is the binomial function.
149   A table of values for N<10 and K<10 looks like:
150   V[10][10] = {
151     {1,  0,   0,    0,    0,     0,     0,      0,      0,       0},
152     {1,  2,   2,    2,    2,     2,     2,      2,      2,       2},
153     {1,  4,   8,   12,   16,    20,    24,     28,     32,      36},
154     {1,  6,  18,   38,   66,   102,   146,    198,    258,     326},
155     {1,  8,  32,   88,  192,   360,   608,    952,   1408,    1992},
156     {1, 10,  50,  170,  450,  1002,  1970,   3530,   5890,    9290},
157     {1, 12,  72,  292,  912,  2364,  5336,  10836,  20256,   35436},
158     {1, 14,  98,  462, 1666,  4942, 12642,  28814,  59906,  115598},
159     {1, 16, 128,  688, 2816,  9424, 27008,  68464, 157184,  332688},
160     {1, 18, 162,  978, 4482, 16722, 53154, 148626, 374274,  864146}
161   };
162
163   U(N,K) = the number of such combinations wherein N-1 objects are taken at
164    most K-1 at a time.
165   This is given by
166     U(N,K) = sum(k=0...K-1,V(N-1,k))
167            = K>0 ? (V(N-1,K-1) + V(N,K-1))/2 : 0.
168   The latter expression also makes clear that U(N,K) is half the number of such
169    combinations wherein the first object is taken at least once.
170   Although it may not be clear from either of these definitions, U(N,K) is the
171    natural function to work with when enumerating the pulse vector codebooks,
172    not V(N,K).
173   U(N,K) is not well-defined for N=0, but with the extension
174     U(0,K) = K>0 ? 0 : 1,
175    the function becomes symmetric: U(N,K) = U(K,N), with a similar table:
176   U[10][10] = {
177     {1, 0,  0,   0,    0,    0,     0,     0,      0,      0},
178     {0, 1,  1,   1,    1,    1,     1,     1,      1,      1},
179     {0, 1,  3,   5,    7,    9,    11,    13,     15,     17},
180     {0, 1,  5,  13,   25,   41,    61,    85,    113,    145},
181     {0, 1,  7,  25,   63,  129,   231,   377,    575,    833},
182     {0, 1,  9,  41,  129,  321,   681,  1289,   2241,   3649},
183     {0, 1, 11,  61,  231,  681,  1683,  3653,   7183,  13073},
184     {0, 1, 13,  85,  377, 1289,  3653,  8989,  19825,  40081},
185     {0, 1, 15, 113,  575, 2241,  7183, 19825,  48639, 108545},
186     {0, 1, 17, 145,  833, 3649, 13073, 40081, 108545, 265729}
187   };
188
189   With this extension, V(N,K) may be written in terms of U(N,K):
190     V(N,K) = U(N,K) + U(N,K+1)
191    for all N>=0, K>=0.
192   Thus U(N,K+1) represents the number of combinations where the first element
193    is positive or zero, and U(N,K) represents the number of combinations where
194    it is negative.
195   With a large enough table of U(N,K) values, we could write O(N) encoding
196    and O(min(N*log(K),N+K)) decoding routines, but such a table would be
197    prohibitively large for small embedded devices (K may be as large as 32767
198    for small N, and N may be as large as 200).
199
200   Both functions obey the same recurrence relation:
201     V(N,K) = V(N-1,K) + V(N,K-1) + V(N-1,K-1),
202     U(N,K) = U(N-1,K) + U(N,K-1) + U(N-1,K-1),
203    for all N>0, K>0, with different initial conditions at N=0 or K=0.
204   This allows us to construct a row of one of the tables above given the
205    previous row or the next row.
206   Thus we can derive O(NK) encoding and decoding routines with O(K) memory
207    using only addition and subtraction.
208
209   When encoding, we build up from the U(2,K) row and work our way forwards.
210   When decoding, we need to start at the U(N,K) row and work our way backwards,
211    which requires a means of computing U(N,K).
212   U(N,K) may be computed from two previous values with the same N:
213     U(N,K) = ((2*N-1)*U(N,K-1) - U(N,K-2))/(K-1) + U(N,K-2)
214    for all N>1, and since U(N,K) is symmetric, a similar relation holds for two
215    previous values with the same K:
216     U(N,K>1) = ((2*K-1)*U(N-1,K) - U(N-2,K))/(N-1) + U(N-2,K)
217    for all K>1.
218   This allows us to construct an arbitrary row of the U(N,K) table by starting
219    with the first two values, which are constants.
220   This saves roughly 2/3 the work in our O(NK) decoding routine, but costs O(K)
221    multiplications.
222   Similar relations can be derived for V(N,K), but are not used here.
223
224   For N>0 and K>0, U(N,K) and V(N,K) take on the form of an (N-1)-degree
225    polynomial for fixed N.
226   The first few are
227     U(1,K) = 1,
228     U(2,K) = 2*K-1,
229     U(3,K) = (2*K-2)*K+1,
230     U(4,K) = (((4*K-6)*K+8)*K-3)/3,
231     U(5,K) = ((((2*K-4)*K+10)*K-8)*K+3)/3,
232    and
233     V(1,K) = 2,
234     V(2,K) = 4*K,
235     V(3,K) = 4*K*K+2,
236     V(4,K) = 8*(K*K+2)*K/3,
237     V(5,K) = ((4*K*K+20)*K*K+6)/3,
238    for all K>0.
239   This allows us to derive O(N) encoding and O(N*log(K)) decoding routines for
240    small N (and indeed decoding is also O(N) for N<3).
241
242   @ARTICLE{Fis86,
243     author="Thomas R. Fischer",
244     title="A Pyramid Vector Quantizer",
245     journal="IEEE Transactions on Information Theory",
246     volume="IT-32",
247     number=4,
248     pages="568--583",
249     month=Jul,
250     year=1986
251   }*/
252
253 #ifndef SMALL_FOOTPRINT
254 /*Compute V(1,_k).*/
255 static inline unsigned ncwrs1(int _k){
256   return _k?2:1;
257 }
258
259 /*Compute U(2,_k).
260   Note that this may be called with _k=32768 (maxK[2]+1).*/
261 static inline unsigned ucwrs2(unsigned _k){
262   return _k?_k+(_k-1):0;
263 }
264
265 /*Compute V(2,_k).*/
266 static inline opus_uint32 ncwrs2(int _k){
267   return _k?4*(opus_uint32)_k:1;
268 }
269
270 /*Compute U(3,_k).
271   Note that this may be called with _k=32768 (maxK[3]+1).*/
272 static inline opus_uint32 ucwrs3(unsigned _k){
273   return _k?(2*(opus_uint32)_k-2)*_k+1:0;
274 }
275
276 /*Compute V(3,_k).*/
277 static inline opus_uint32 ncwrs3(int _k){
278   return _k?2*(2*(unsigned)_k*(opus_uint32)_k+1):1;
279 }
280
281 /*Compute U(4,_k).*/
282 static inline opus_uint32 ucwrs4(int _k){
283   return _k?imusdiv32odd(2*_k,(2*_k-3)*(opus_uint32)_k+4,3,1):0;
284 }
285
286 /*Compute V(4,_k).*/
287 static inline opus_uint32 ncwrs4(int _k){
288   return _k?((_k*(opus_uint32)_k+2)*_k)/3<<3:1;
289 }
290
291 /*Compute U(5,_k).*/
292 static inline opus_uint32 ucwrs5(int _k){
293   return _k?(((((_k-2)*(unsigned)_k+5)*(opus_uint32)_k-4)*_k)/3<<1)+1:0;
294 }
295
296 /*Compute V(5,_k).*/
297 static inline opus_uint32 ncwrs5(int _k){
298   return _k?(((_k*(unsigned)_k+5)*(opus_uint32)_k*_k)/3<<2)+2:1;
299 }
300
301 #endif /* SMALL_FOOTPRINT */
302
303 /*Computes the next row/column of any recurrence that obeys the relation
304    u[i][j]=u[i-1][j]+u[i][j-1]+u[i-1][j-1].
305   _ui0 is the base case for the new row/column.*/
306 static inline void unext(opus_uint32 *_ui,unsigned _len,opus_uint32 _ui0){
307   opus_uint32 ui1;
308   unsigned      j;
309   /*This do-while will overrun the array if we don't have storage for at least
310      2 values.*/
311   j=1; do {
312     ui1=UADD32(UADD32(_ui[j],_ui[j-1]),_ui0);
313     _ui[j-1]=_ui0;
314     _ui0=ui1;
315   } while (++j<_len);
316   _ui[j-1]=_ui0;
317 }
318
319 /*Computes the previous row/column of any recurrence that obeys the relation
320    u[i-1][j]=u[i][j]-u[i][j-1]-u[i-1][j-1].
321   _ui0 is the base case for the new row/column.*/
322 static inline void uprev(opus_uint32 *_ui,unsigned _n,opus_uint32 _ui0){
323   opus_uint32 ui1;
324   unsigned      j;
325   /*This do-while will overrun the array if we don't have storage for at least
326      2 values.*/
327   j=1; do {
328     ui1=USUB32(USUB32(_ui[j],_ui[j-1]),_ui0);
329     _ui[j-1]=_ui0;
330     _ui0=ui1;
331   } while (++j<_n);
332   _ui[j-1]=_ui0;
333 }
334
335 /*Compute V(_n,_k), as well as U(_n,0..._k+1).
336   _u: On exit, _u[i] contains U(_n,i) for i in [0..._k+1].*/
337 static opus_uint32 ncwrs_urow(unsigned _n,unsigned _k,opus_uint32 *_u){
338   opus_uint32 um2;
339   unsigned      len;
340   unsigned      k;
341   len=_k+2;
342   /*We require storage at least 3 values (e.g., _k>0).*/
343   celt_assert(len>=3);
344   _u[0]=0;
345   _u[1]=um2=1;
346 #ifndef SMALL_FOOTPRINT
347   if(_n<=6 || _k>127)
348 #endif
349  {
350     /*If _n==0, _u[0] should be 1 and the rest should be 0.*/
351     /*If _n==1, _u[i] should be 1 for i>1.*/
352     celt_assert(_n>=2);
353     /*If _k==0, the following do-while loop will overflow the buffer.*/
354     celt_assert(_k>0);
355     k=2;
356     do _u[k]=(k<<1)-1;
357     while(++k<len);
358     for(k=2;k<_n;k++)unext(_u+1,_k+1,1);
359   }
360 #ifndef SMALL_FOOTPRINT
361   else{
362     opus_uint32 um1;
363     opus_uint32 n2m1;
364     _u[2]=n2m1=um1=(_n<<1)-1;
365     for(k=3;k<len;k++){
366       /*U(N,K) = ((2*N-1)*U(N,K-1)-U(N,K-2))/(K-1) + U(N,K-2)*/
367       _u[k]=um2=imusdiv32even(n2m1,um1,um2,k-1)+um2;
368       if(++k>=len)break;
369       _u[k]=um1=imusdiv32odd(n2m1,um2,um1,k-1>>1)+um1;
370     }
371   }
372 #endif /* SMALL_FOOTPRINT */
373   return _u[_k]+_u[_k+1];
374 }
375
376 #ifndef SMALL_FOOTPRINT
377
378 /*Returns the _i'th combination of _k elements (at most 32767) chosen from a
379    set of size 1 with associated sign bits.
380   _y: Returns the vector of pulses.*/
381 static inline void cwrsi1(int _k,opus_uint32 _i,int *_y){
382   int s;
383   s=-(int)_i;
384   _y[0]=_k+s^s;
385 }
386
387 /*Returns the _i'th combination of _k elements (at most 32767) chosen from a
388    set of size 2 with associated sign bits.
389   _y: Returns the vector of pulses.*/
390 static inline void cwrsi2(int _k,opus_uint32 _i,int *_y){
391   opus_uint32 p;
392   int           s;
393   int           yj;
394   p=ucwrs2(_k+1U);
395   s=-(_i>=p);
396   _i-=p&s;
397   yj=_k;
398   _k=_i+1>>1;
399   p=ucwrs2(_k);
400   _i-=p;
401   yj-=_k;
402   _y[0]=yj+s^s;
403   cwrsi1(_k,_i,_y+1);
404 }
405
406 /*Returns the _i'th combination of _k elements (at most 32767) chosen from a
407    set of size 3 with associated sign bits.
408   _y: Returns the vector of pulses.*/
409 static void cwrsi3(int _k,opus_uint32 _i,int *_y){
410   opus_uint32 p;
411   int           s;
412   int           yj;
413   p=ucwrs3(_k+1U);
414   s=-(_i>=p);
415   _i-=p&s;
416   yj=_k;
417   /*Finds the maximum _k such that ucwrs3(_k)<=_i (tested for all
418      _i<2147418113=U(3,32768)).*/
419   _k=_i>0?isqrt32(2*_i-1)+1>>1:0;
420   p=ucwrs3(_k);
421   _i-=p;
422   yj-=_k;
423   _y[0]=yj+s^s;
424   cwrsi2(_k,_i,_y+1);
425 }
426
427 /*Returns the _i'th combination of _k elements (at most 1172) chosen from a set
428    of size 4 with associated sign bits.
429   _y: Returns the vector of pulses.*/
430 static void cwrsi4(int _k,opus_uint32 _i,int *_y){
431   opus_uint32 p;
432   int           s;
433   int           yj;
434   int           kl;
435   int           kr;
436   p=ucwrs4(_k+1);
437   s=-(_i>=p);
438   _i-=p&s;
439   yj=_k;
440   /*We could solve a cubic for k here, but the form of the direct solution does
441      not lend itself well to exact integer arithmetic.
442     Instead we do a binary search on U(4,K).*/
443   kl=0;
444   kr=_k;
445   for(;;){
446     _k=kl+kr>>1;
447     p=ucwrs4(_k);
448     if(p<_i){
449       if(_k>=kr)break;
450       kl=_k+1;
451     }
452     else if(p>_i)kr=_k-1;
453     else break;
454   }
455   _i-=p;
456   yj-=_k;
457   _y[0]=yj+s^s;
458   cwrsi3(_k,_i,_y+1);
459 }
460
461 #endif /* SMALL_FOOTPRINT */
462
463 /*Returns the _i'th combination of _k elements chosen from a set of size _n
464    with associated sign bits.
465   _y: Returns the vector of pulses.
466   _u: Must contain entries [0..._k+1] of row _n of U() on input.
467       Its contents will be destructively modified.*/
468 static void cwrsi(int _n,int _k,opus_uint32 _i,int *_y,opus_uint32 *_u){
469   int j;
470   celt_assert(_n>0);
471   j=0;
472   do{
473     opus_uint32 p;
474     int           s;
475     int           yj;
476     p=_u[_k+1];
477     s=-(_i>=p);
478     _i-=p&s;
479     yj=_k;
480     p=_u[_k];
481     while(p>_i)p=_u[--_k];
482     _i-=p;
483     yj-=_k;
484     _y[j]=yj+s^s;
485     uprev(_u,_k+2,0);
486   }
487   while(++j<_n);
488 }
489
490 /*Returns the index of the given combination of K elements chosen from a set
491    of size 1 with associated sign bits.
492   _y: The vector of pulses, whose sum of absolute values is K.
493   _k: Returns K.*/
494 static inline opus_uint32 icwrs1(const int *_y,int *_k){
495   *_k=abs(_y[0]);
496   return _y[0]<0;
497 }
498
499 #ifndef SMALL_FOOTPRINT
500
501 /*Returns the index of the given combination of K elements chosen from a set
502    of size 2 with associated sign bits.
503   _y: The vector of pulses, whose sum of absolute values is K.
504   _k: Returns K.*/
505 static inline opus_uint32 icwrs2(const int *_y,int *_k){
506   opus_uint32 i;
507   int           k;
508   i=icwrs1(_y+1,&k);
509   i+=ucwrs2(k);
510   k+=abs(_y[0]);
511   if(_y[0]<0)i+=ucwrs2(k+1U);
512   *_k=k;
513   return i;
514 }
515
516 /*Returns the index of the given combination of K elements chosen from a set
517    of size 3 with associated sign bits.
518   _y: The vector of pulses, whose sum of absolute values is K.
519   _k: Returns K.*/
520 static inline opus_uint32 icwrs3(const int *_y,int *_k){
521   opus_uint32 i;
522   int           k;
523   i=icwrs2(_y+1,&k);
524   i+=ucwrs3(k);
525   k+=abs(_y[0]);
526   if(_y[0]<0)i+=ucwrs3(k+1U);
527   *_k=k;
528   return i;
529 }
530
531 /*Returns the index of the given combination of K elements chosen from a set
532    of size 4 with associated sign bits.
533   _y: The vector of pulses, whose sum of absolute values is K.
534   _k: Returns K.*/
535 static inline opus_uint32 icwrs4(const int *_y,int *_k){
536   opus_uint32 i;
537   int           k;
538   i=icwrs3(_y+1,&k);
539   i+=ucwrs4(k);
540   k+=abs(_y[0]);
541   if(_y[0]<0)i+=ucwrs4(k+1);
542   *_k=k;
543   return i;
544 }
545
546 /*Returns the index of the given combination of K elements chosen from a set
547    of size 5 with associated sign bits.
548   _y: The vector of pulses, whose sum of absolute values is K.
549   _k: Returns K.*/
550 static inline opus_uint32 icwrs5(const int *_y,int *_k){
551   opus_uint32 i;
552   int           k;
553   i=icwrs4(_y+1,&k);
554   i+=ucwrs5(k);
555   k+=abs(_y[0]);
556   if(_y[0]<0)i+=ucwrs5(k+1);
557   *_k=k;
558   return i;
559 }
560 #endif /* SMALL_FOOTPRINT */
561
562 /*Returns the index of the given combination of K elements chosen from a set
563    of size _n with associated sign bits.
564   _y:  The vector of pulses, whose sum of absolute values must be _k.
565   _nc: Returns V(_n,_k).*/
566 opus_uint32 icwrs(int _n,int _k,opus_uint32 *_nc,const int *_y,
567  opus_uint32 *_u){
568   opus_uint32 i;
569   int           j;
570   int           k;
571   /*We can't unroll the first two iterations of the loop unless _n>=2.*/
572   celt_assert(_n>=2);
573   _u[0]=0;
574   for(k=1;k<=_k+1;k++)_u[k]=(k<<1)-1;
575   i=icwrs1(_y+_n-1,&k);
576   j=_n-2;
577   i+=_u[k];
578   k+=abs(_y[j]);
579   if(_y[j]<0)i+=_u[k+1];
580   while(j-->0){
581     unext(_u,_k+2,0);
582     i+=_u[k];
583     k+=abs(_y[j]);
584     if(_y[j]<0)i+=_u[k+1];
585   }
586   *_nc=_u[k]+_u[k+1];
587   return i;
588 }
589
590 #ifdef CUSTOM_MODES
591 void get_required_bits(opus_int16 *_bits,int _n,int _maxk,int _frac){
592   int k;
593   /*_maxk==0 => there's nothing to do.*/
594   celt_assert(_maxk>0);
595   _bits[0]=0;
596   if (_n==1)
597   {
598     for (k=1;k<=_maxk;k++)
599       _bits[k] = 1<<_frac;
600   }
601   else {
602     VARDECL(opus_uint32,u);
603     SAVE_STACK;
604     ALLOC(u,_maxk+2U,opus_uint32);
605     ncwrs_urow(_n,_maxk,u);
606     for(k=1;k<=_maxk;k++)
607       _bits[k]=log2_frac(u[k]+u[k+1],_frac);
608     RESTORE_STACK;
609   }
610 }
611 #endif /* CUSTOM_MODES */
612
613 void encode_pulses(const int *_y,int _n,int _k,ec_enc *_enc){
614   opus_uint32 i;
615 #ifndef SMALL_FOOTPRINT
616   switch(_n){
617     case 2:{
618       i=icwrs2(_y,&_k);
619       ec_enc_uint(_enc,i,ncwrs2(_k));
620     }break;
621     case 3:{
622       i=icwrs3(_y,&_k);
623       ec_enc_uint(_enc,i,ncwrs3(_k));
624     }break;
625     case 4:{
626       i=icwrs4(_y,&_k);
627       ec_enc_uint(_enc,i,ncwrs4(_k));
628     }break;
629      default:
630     {
631 #endif
632       VARDECL(opus_uint32,u);
633       opus_uint32 nc;
634       SAVE_STACK;
635       ALLOC(u,_k+2U,opus_uint32);
636       i=icwrs(_n,_k,&nc,_y,u);
637       ec_enc_uint(_enc,i,nc);
638       RESTORE_STACK;
639 #ifndef SMALL_FOOTPRINT
640     };
641   }
642 #endif
643 }
644
645 void decode_pulses(int *_y,int _n,int _k,ec_dec *_dec)
646 {
647 #ifndef SMALL_FOOTPRINT
648    switch(_n){
649     case 2:cwrsi2(_k,ec_dec_uint(_dec,ncwrs2(_k)),_y);break;
650     case 3:cwrsi3(_k,ec_dec_uint(_dec,ncwrs3(_k)),_y);break;
651     case 4:cwrsi4(_k,ec_dec_uint(_dec,ncwrs4(_k)),_y);break;
652       default:
653     {
654 #endif
655       VARDECL(opus_uint32,u);
656       SAVE_STACK;
657       ALLOC(u,_k+2U,opus_uint32);
658       cwrsi(_n,_k,ec_dec_uint(_dec,ncwrs_urow(_n,_k,u)),_y,u);
659       RESTORE_STACK;
660 #ifndef SMALL_FOOTPRINT
661     }
662   }
663 #endif
664 }