Trying to clean up celt_ilog2() vs. EC_ILOG a bit.
[opus.git] / libcelt / cwrs.c
1 /* (C) 2007 Timothy B. Terriberry
2    (C) 2008 Jean-Marc Valin */
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 /* Functions for encoding and decoding pulse vectors. For more details, see:
33    http://people.xiph.org/~tterribe/notes/cwrs.html
34 */
35
36 #ifdef HAVE_CONFIG_H
37 #include "config.h"
38 #endif
39
40 #include <stdlib.h>
41 #include "cwrs.h"
42 #include "mathops.h"
43
44 /* Knowing ncwrs() for a fixed number of pulses m and for all vector sizes n,
45    compute ncwrs() for m+1, for all n. Could also be used when m and n are
46    swapped just by changing nc */
47 static inline void next_ncwrs32(celt_uint32_t *nc, int len, int nc0)
48 {
49    int i;
50    celt_uint32_t mem;
51    
52    mem = nc[0];
53    nc[0] = nc0;
54    for (i=1;i<len;i++)
55    {
56       celt_uint32_t tmp = nc[i]+nc[i-1]+mem;
57       mem = nc[i];
58       nc[i] = tmp;
59    }
60 }
61
62 /* Knowing ncwrs() for a fixed number of pulses m and for all vector sizes n,
63    compute ncwrs() for m-1, for all n. Could also be used when m and n are
64    swapped just by changing nc */
65 static inline void prev_ncwrs32(celt_uint32_t *nc, int len, int nc0)
66 {
67    int i;
68    celt_uint32_t mem;
69    
70    mem = nc[0];
71    nc[0] = nc0;
72    for (i=1;i<len;i++)
73    {
74       celt_uint32_t tmp = nc[i]-nc[i-1]-mem;
75       mem = nc[i];
76       nc[i] = tmp;
77    }
78 }
79
80 static inline void next_ncwrs64(celt_uint64_t *nc, int len, int nc0)
81 {
82    int i;
83    celt_uint64_t mem;
84    
85    mem = nc[0];
86    nc[0] = nc0;
87    for (i=1;i<len;i++)
88    {
89       celt_uint64_t tmp = nc[i]+nc[i-1]+mem;
90       mem = nc[i];
91       nc[i] = tmp;
92    }
93 }
94
95 static inline void prev_ncwrs64(celt_uint64_t *nc, int len, int nc0)
96 {
97    int i;
98    celt_uint64_t mem;
99    
100    mem = nc[0];
101    nc[0] = nc0;
102    for (i=1;i<len;i++)
103    {
104       celt_uint64_t tmp = nc[i]-nc[i-1]-mem;
105       mem = nc[i];
106       nc[i] = tmp;
107    }
108 }
109
110 /*Returns the numer of ways of choosing _m elements from a set of size _n with
111    replacement when a sign bit is needed for each unique element.*/
112 celt_uint32_t ncwrs(int _n,int _m)
113 {
114    int i;
115    celt_uint32_t ret;
116    VARDECL(celt_uint32_t, nc);
117    SAVE_STACK;
118    ALLOC(nc,_n+1, celt_uint32_t);
119    for (i=0;i<_n+1;i++)
120       nc[i] = 1;
121    for (i=0;i<_m;i++)
122       next_ncwrs32(nc, _n+1, 0);
123    ret = nc[_n];
124    RESTORE_STACK;
125    return ret;
126 }
127
128 /*Returns the numer of ways of choosing _m elements from a set of size _n with
129    replacement when a sign bit is needed for each unique element.*/
130 celt_uint64_t ncwrs64(int _n,int _m)
131 {
132    int i;
133    celt_uint64_t ret;
134    VARDECL(celt_uint64_t, nc);
135    SAVE_STACK;
136    ALLOC(nc,_n+1, celt_uint64_t);
137    for (i=0;i<_n+1;i++)
138       nc[i] = 1;
139    for (i=0;i<_m;i++)
140       next_ncwrs64(nc, _n+1, 0);
141    ret = nc[_n];
142    RESTORE_STACK;
143    return ret;
144 }
145
146
147 /*Returns the _i'th combination of _m elements chosen from a set of size _n
148    with associated sign bits.
149   _x:      Returns the combination with elements sorted in ascending order.
150   _s:      Returns the associated sign bits.*/
151 void cwrsi(int _n,int _m,celt_uint32_t _i,int * restrict _x,int * restrict _s){
152   int j;
153   int k;
154   VARDECL(celt_uint32_t, nc);
155   SAVE_STACK;
156   ALLOC(nc,_n+1, celt_uint32_t);
157   for (j=0;j<_n+1;j++)
158     nc[j] = 1;
159   for (k=0;k<_m-1;k++)
160     next_ncwrs32(nc, _n+1, 0);
161   for(k=j=0;k<_m;k++){
162     celt_uint32_t pn, p, t;
163     /*p=ncwrs(_n-j,_m-k-1);
164     pn=ncwrs(_n-j-1,_m-k-1);*/
165     p=nc[_n-j];
166     pn=nc[_n-j-1];
167     p+=pn;
168     if(k>0){
169       t=p>>1;
170       if(t<=_i||_s[k-1])_i+=t;
171     }
172     while(p<=_i){
173       _i-=p;
174       j++;
175       p=pn;
176       /*pn=ncwrs(_n-j-1,_m-k-1);*/
177       pn=nc[_n-j-1];
178       p+=pn;
179     }
180     t=p>>1;
181     _s[k]=_i>=t;
182     _x[k]=j;
183     if(_s[k])_i-=t;
184     if (k<_m-2)
185       prev_ncwrs32(nc, _n-j+1, 0);
186     else
187       prev_ncwrs32(nc, _n-j+1, 1);
188   }
189   RESTORE_STACK;
190 }
191
192 /*Returns the index of the given combination of _m elements chosen from a set
193    of size _n with associated sign bits.
194   _x:      The combination with elements sorted in ascending order.
195   _s:      The associated sign bits.*/
196 celt_uint32_t icwrs(int _n,int _m,const int *_x,const int *_s, celt_uint32_t *bound){
197   celt_uint32_t i;
198   int      j;
199   int      k;
200   VARDECL(celt_uint32_t, nc);
201   SAVE_STACK;
202   ALLOC(nc,_n+1, celt_uint32_t);
203   for (j=0;j<_n+1;j++)
204     nc[j] = 1;
205   for (k=0;k<_m;k++)
206     next_ncwrs32(nc, _n+1, 0);
207   if (bound)
208     *bound = nc[_n];
209   i=0;
210   for(k=j=0;k<_m;k++){
211     celt_uint32_t pn;
212     celt_uint32_t p;
213     if (k<_m-1)
214       prev_ncwrs32(nc, _n-j+1, 0);
215     else
216       prev_ncwrs32(nc, _n-j+1, 1);
217     /*p=ncwrs(_n-j,_m-k-1);
218     pn=ncwrs(_n-j-1,_m-k-1);*/
219     p=nc[_n-j];
220     pn=nc[_n-j-1];
221     p+=pn;
222     if(k>0)p>>=1;
223     while(j<_x[k]){
224       i+=p;
225       j++;
226       p=pn;
227       /*pn=ncwrs(_n-j-1,_m-k-1);*/
228       pn=nc[_n-j-1];
229       p+=pn;
230     }
231     if((k==0||_x[k]!=_x[k-1])&&_s[k])i+=p>>1;
232   }
233   RESTORE_STACK;
234   return i;
235 }
236
237 /*Returns the _i'th combination of _m elements chosen from a set of size _n
238    with associated sign bits.
239   _x:      Returns the combination with elements sorted in ascending order.
240   _s:      Returns the associated sign bits.*/
241 void cwrsi64(int _n,int _m,celt_uint64_t _i,int * restrict _x,int * restrict _s){
242   int j;
243   int k;
244   VARDECL(celt_uint64_t, nc);
245   SAVE_STACK;
246   ALLOC(nc,_n+1, celt_uint64_t);
247   for (j=0;j<_n+1;j++)
248     nc[j] = 1;
249   for (k=0;k<_m-1;k++)
250     next_ncwrs64(nc, _n+1, 0);
251   for(k=j=0;k<_m;k++){
252     celt_uint64_t pn, p, t;
253     /*p=ncwrs64(_n-j,_m-k-1);
254     pn=ncwrs64(_n-j-1,_m-k-1);*/
255     p=nc[_n-j];
256     pn=nc[_n-j-1];
257     p+=pn;
258     if(k>0){
259       t=p>>1;
260       if(t<=_i||_s[k-1])_i+=t;
261     }
262     while(p<=_i){
263       _i-=p;
264       j++;
265       p=pn;
266       /*pn=ncwrs64(_n-j-1,_m-k-1);*/
267       pn=nc[_n-j-1];
268       p+=pn;
269     }
270     t=p>>1;
271     _s[k]=_i>=t;
272     _x[k]=j;
273     if(_s[k])_i-=t;
274     if (k<_m-2)
275       prev_ncwrs64(nc, _n-j+1, 0);
276     else
277       prev_ncwrs64(nc, _n-j+1, 1);
278   }
279   RESTORE_STACK;
280 }
281
282 /*Returns the index of the given combination of _m elements chosen from a set
283    of size _n with associated sign bits.
284   _x:      The combination with elements sorted in ascending order.
285   _s:      The associated sign bits.*/
286 celt_uint64_t icwrs64(int _n,int _m,const int *_x,const int *_s, celt_uint64_t *bound){
287   celt_uint64_t i;
288   int           j;
289   int           k;
290   VARDECL(celt_uint64_t, nc);
291   SAVE_STACK;
292   ALLOC(nc,_n+1, celt_uint64_t);
293   for (j=0;j<_n+1;j++)
294     nc[j] = 1;
295   for (k=0;k<_m;k++)
296     next_ncwrs64(nc, _n+1, 0);
297   if (bound)
298      *bound = nc[_n];
299   i=0;
300   for(k=j=0;k<_m;k++){
301     celt_uint64_t pn;
302     celt_uint64_t p;
303     if (k<_m-1)
304       prev_ncwrs64(nc, _n-j+1, 0);
305     else
306       prev_ncwrs64(nc, _n-j+1, 1);
307     /*p=ncwrs64(_n-j,_m-k-1);
308     pn=ncwrs64(_n-j-1,_m-k-1);*/
309     p=nc[_n-j];
310     pn=nc[_n-j-1];
311     p+=pn;
312     if(k>0)p>>=1;
313     while(j<_x[k]){
314       i+=p;
315       j++;
316       p=pn;
317       /*pn=ncwrs64(_n-j-1,_m-k-1);*/
318       pn=nc[_n-j-1];
319       p+=pn;
320     }
321     if((k==0||_x[k]!=_x[k-1])&&_s[k])i+=p>>1;
322   }
323   RESTORE_STACK;
324   return i;
325 }
326
327 /*Converts a combination _x of _m unit pulses with associated sign bits _s into
328    a pulse vector _y of length _n.
329   _y: Returns the vector of pulses.
330   _x: The combination with elements sorted in ascending order.
331   _s: The associated sign bits.*/
332 void comb2pulse(int _n,int _m,int *_y,const int *_x,const int *_s){
333   int j;
334   int k;
335   int n;
336   for(k=j=0;k<_m;k+=n){
337     for(n=1;k+n<_m&&_x[k+n]==_x[k];n++);
338     while(j<_x[k])_y[j++]=0;
339     _y[j++]=_s[k]?-n:n;
340   }
341   while(j<_n)_y[j++]=0;
342 }
343
344 /*Converts a pulse vector vector _y of length _n into a combination of _m unit
345    pulses with associated sign bits _s.
346   _x: Returns the combination with elements sorted in ascending order.
347   _s: Returns the associated sign bits.
348   _y: The vector of pulses, whose sum of absolute values must be _m.*/
349 void pulse2comb(int _n,int _m,int *_x,int *_s,const int *_y){
350   int j;
351   int k;
352   for(k=j=0;j<_n;j++){
353     if(_y[j]){
354       int n;
355       int s;
356       n=abs(_y[j]);
357       s=_y[j]<0;
358       for(;n-->0;k++){
359         _x[k]=j;
360         _s[k]=s;
361       }
362     }
363   }
364 }
365
366 void encode_pulses(int *_y, int N, int K, ec_enc *enc)
367 {
368    VARDECL(int, comb);
369    VARDECL(int, signs);
370    SAVE_STACK;
371    
372    ALLOC(comb, K, int);
373    ALLOC(signs, K, int);
374    
375    pulse2comb(N, K, comb, signs, _y);
376    /* Simple heuristic to figure out whether it fits in 32 bits */
377    if((N+4)*(K+4)<250 || (celt_ilog2(N)+1)*K<31)
378    {
379       celt_uint32_t bound, id;
380       id = icwrs(N, K, comb, signs, &bound);
381       ec_enc_uint(enc,id,bound);
382    } else {
383       celt_uint64_t bound, id;
384       id = icwrs64(N, K, comb, signs, &bound);
385       ec_enc_uint64(enc,id,bound);
386    }
387    RESTORE_STACK;
388 }
389
390 void decode_pulses(int *_y, int N, int K, ec_dec *dec)
391 {
392    VARDECL(int, comb);
393    VARDECL(int, signs);
394    SAVE_STACK;
395    
396    ALLOC(comb, K, int);
397    ALLOC(signs, K, int);
398    /* Simple heuristic to figure out whether it fits in 32 bits */
399    if((N+4)*(K+4)<250 || (celt_ilog2(N)+1)*K<31)
400    {
401       cwrsi(N, K, ec_dec_uint(dec, ncwrs(N, K)), comb, signs);
402       comb2pulse(N, K, _y, comb, signs);
403    } else {
404       cwrsi64(N, K, ec_dec_uint64(dec, ncwrs64(N, K)), comb, signs);
405       comb2pulse(N, K, _y, comb, signs);
406    }
407    RESTORE_STACK;
408 }
409