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