Reducing the size of the pulses->bits cache by restricting the number of pulses
[opus.git] / libcelt / vq.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 "mathops.h"
37 #include "cwrs.h"
38 #include "vq.h"
39 #include "arch.h"
40 #include "os_support.h"
41 #include "rate.h"
42
43 /** Takes the pitch vector and the decoded residual vector, computes the gain
44     that will give ||p+g*y||=1 and mixes the residual with the pitch. */
45 static void mix_pitch_and_residual(int * restrict iy, celt_norm_t * restrict X, int N, int K, const celt_norm_t * restrict P)
46 {
47    int i;
48    celt_word32_t Ryp, Ryy, Rpp;
49    celt_word16_t ryp, ryy, rpp;
50    celt_word32_t g;
51    VARDECL(celt_norm_t, y);
52 #ifdef FIXED_POINT
53    int yshift;
54 #endif
55    SAVE_STACK;
56 #ifdef FIXED_POINT
57    yshift = 13-celt_ilog2(K);
58 #endif
59    ALLOC(y, N, celt_norm_t);
60
61    Rpp = 0;
62    i=0;
63    do {
64       Rpp = MAC16_16(Rpp,P[i],P[i]);
65       y[i] = SHL16(iy[i],yshift);
66    } while (++i < N);
67
68    Ryp = 0;
69    Ryy = 0;
70    /* If this doesn't generate a dual MAC (on supported archs), fire the compiler guy */
71    i=0;
72    do {
73       Ryp = MAC16_16(Ryp, y[i], P[i]);
74       Ryy = MAC16_16(Ryy, y[i], y[i]);
75    } while (++i < N);
76
77    ryp = ROUND16(Ryp,14);
78    ryy = ROUND16(Ryy,14);
79    rpp = ROUND16(Rpp,14);
80    /* g = (sqrt(Ryp^2 + Ryy - Rpp*Ryy)-Ryp)/Ryy */
81    g = MULT16_32_Q15(celt_sqrt(MAC16_16(Ryy, ryp,ryp) - MULT16_16(ryy,rpp)) - ryp,
82                      celt_rcp(SHR32(Ryy,9)));
83
84    i=0;
85    do 
86       X[i] = ADD16(P[i], ROUND16(MULT16_16(y[i], g),11));
87    while (++i < N);
88
89    RESTORE_STACK;
90 }
91
92
93 void alg_quant(celt_norm_t *X, celt_mask_t *W, int N, int K, celt_norm_t *P, ec_enc *enc)
94 {
95    VARDECL(celt_norm_t, y);
96    VARDECL(int, iy);
97    VARDECL(celt_word16_t, signx);
98    int j, is;
99    celt_word16_t s;
100    int pulsesLeft;
101    celt_word32_t sum;
102    celt_word32_t xy, yy, yp;
103    celt_word16_t Rpp;
104    int N_1; /* Inverse of N, in Q14 format (even for float) */
105 #ifdef FIXED_POINT
106    int yshift;
107 #endif
108    SAVE_STACK;
109
110    K = get_pulses(K);
111 #ifdef FIXED_POINT
112    yshift = 13-celt_ilog2(K);
113 #endif
114
115    ALLOC(y, N, celt_norm_t);
116    ALLOC(iy, N, int);
117    ALLOC(signx, N, celt_word16_t);
118    N_1 = 512/N;
119
120    sum = 0;
121    j=0; do {
122       X[j] -= P[j];
123       if (X[j]>0)
124          signx[j]=1;
125       else {
126          signx[j]=-1;
127          X[j]=-X[j];
128          P[j]=-P[j];
129       }
130       iy[j] = 0;
131       y[j] = 0;
132       sum = MAC16_16(sum, P[j],P[j]);
133    } while (++j<N);
134    Rpp = ROUND16(sum, NORM_SHIFT);
135
136    celt_assert2(Rpp<=NORM_SCALING, "Rpp should never have a norm greater than unity");
137
138    xy = yy = yp = 0;
139
140    pulsesLeft = K;
141
142    /* Do a pre-search by projecting on the pyramid */
143    if (K > (N>>1))
144    {
145       celt_word16_t rcp;
146       sum=0;
147       j=0; do {
148          sum += X[j];
149       }  while (++j<N);
150
151 #ifdef FIXED_POINT
152       if (sum <= K)
153 #else
154       if (sum <= EPSILON)
155 #endif
156       {
157          X[0] = QCONST16(1.f,14);
158          j=1; do
159             X[j]=0;
160          while (++j<N);
161          sum = QCONST16(1.f,14);
162       }
163       /* Do we have sufficient accuracy here? */
164       rcp = EXTRACT16(MULT16_32_Q16(K-1, celt_rcp(sum)));
165       j=0; do {
166 #ifdef FIXED_POINT
167          /* It's really important to round *towards zero* here */
168          iy[j] = MULT16_16_Q15(X[j],rcp);
169 #else
170          iy[j] = floor(rcp*X[j]);
171 #endif
172          y[j] = SHL16(iy[j],yshift);
173          yy = MAC16_16(yy, y[j],y[j]);
174          xy = MAC16_16(xy, X[j],y[j]);
175          yp += P[j]*y[j];
176          y[j] *= 2;
177          pulsesLeft -= iy[j];
178       }  while (++j<N);
179    }
180    celt_assert2(pulsesLeft>=1, "Allocated too many pulses in the quick pass");
181
182    while (pulsesLeft > 1)
183    {
184       int pulsesAtOnce=1;
185       int best_id;
186       celt_word16_t magnitude;
187       celt_word32_t best_num = -VERY_LARGE16;
188       celt_word16_t best_den = 0;
189 #ifdef FIXED_POINT
190       int rshift;
191 #endif
192       /* Decide on how many pulses to find at once */
193       pulsesAtOnce = (pulsesLeft*N_1)>>9; /* pulsesLeft/N */
194       if (pulsesAtOnce<1)
195          pulsesAtOnce = 1;
196 #ifdef FIXED_POINT
197       rshift = yshift+1+celt_ilog2(K-pulsesLeft+pulsesAtOnce);
198 #endif
199       magnitude = SHL16(pulsesAtOnce, yshift);
200
201       best_id = 0;
202       /* The squared magnitude term gets added anyway, so we might as well 
203          add it outside the loop */
204       yy = MAC16_16(yy, magnitude,magnitude);
205       /* Choose between fast and accurate strategy depending on where we are in the search */
206          /* This should ensure that anything we can process will have a better score */
207       j=0;
208       do {
209          celt_word16_t Rxy, Ryy;
210          /* Select sign based on X[j] alone */
211          s = magnitude;
212          /* Temporary sums of the new pulse(s) */
213          Rxy = EXTRACT16(SHR32(MAC16_16(xy, s,X[j]),rshift));
214          /* We're multiplying y[j] by two so we don't have to do it here */
215          Ryy = EXTRACT16(SHR32(MAC16_16(yy, s,y[j]),rshift));
216             
217             /* Approximate score: we maximise Rxy/sqrt(Ryy) (we're guaranteed that 
218          Rxy is positive because the sign is pre-computed) */
219          Rxy = MULT16_16_Q15(Rxy,Rxy);
220             /* The idea is to check for num/den >= best_num/best_den, but that way
221          we can do it without any division */
222          /* OPT: Make sure to use conditional moves here */
223          if (MULT16_16(best_den, Rxy) > MULT16_16(Ryy, best_num))
224          {
225             best_den = Ryy;
226             best_num = Rxy;
227             best_id = j;
228          }
229       } while (++j<N);
230       
231       j = best_id;
232       is = pulsesAtOnce;
233       s = SHL16(is, yshift);
234
235       /* Updating the sums of the new pulse(s) */
236       xy = xy + MULT16_16(s,X[j]);
237       /* We're multiplying y[j] by two so we don't have to do it here */
238       yy = yy + MULT16_16(s,y[j]);
239       yp = yp + MULT16_16(s, P[j]);
240
241       /* Only now that we've made the final choice, update y/iy */
242       /* Multiplying y[j] by 2 so we don't have to do it everywhere else */
243       y[j] += 2*s;
244       iy[j] += is;
245       pulsesLeft -= pulsesAtOnce;
246    }
247    
248    if (pulsesLeft > 0)
249    {
250       celt_word16_t g;
251       celt_word16_t best_num = -VERY_LARGE16;
252       celt_word16_t best_den = 0;
253       int best_id = 0;
254       celt_word16_t magnitude = SHL16(1, yshift);
255
256       /* The squared magnitude term gets added anyway, so we might as well 
257       add it outside the loop */
258       yy = MAC16_16(yy, magnitude,magnitude);
259       j=0;
260       do {
261          celt_word16_t Rxy, Ryy, Ryp;
262          celt_word16_t num;
263          /* Select sign based on X[j] alone */
264          s = magnitude;
265          /* Temporary sums of the new pulse(s) */
266          Rxy = ROUND16(MAC16_16(xy, s,X[j]), 14);
267          /* We're multiplying y[j] by two so we don't have to do it here */
268          Ryy = ROUND16(MAC16_16(yy, s,y[j]), 14);
269          Ryp = ROUND16(MAC16_16(yp, s,P[j]), 14);
270
271             /* Compute the gain such that ||p + g*y|| = 1 
272          ...but instead, we compute g*Ryy to avoid dividing */
273          g = celt_psqrt(MULT16_16(Ryp,Ryp) + MULT16_16(Ryy,QCONST16(1.f,14)-Rpp)) - Ryp;
274             /* Knowing that gain, what's the error: (x-g*y)^2 
275          (result is negated and we discard x^2 because it's constant) */
276          /* score = 2*g*Rxy - g*g*Ryy;*/
277 #ifdef FIXED_POINT
278          /* No need to multiply Rxy by 2 because we did it earlier */
279          num = MULT16_16_Q15(ADD16(SUB16(Rxy,g),Rxy),g);
280 #else
281          num = g*(2*Rxy-g);
282 #endif
283          if (MULT16_16(best_den, num) > MULT16_16(Ryy, best_num))
284          {
285             best_den = Ryy;
286             best_num = num;
287             best_id = j;
288          }
289       } while (++j<N);
290       iy[best_id] += 1;
291    }
292    j=0;
293    do {
294       P[j] = MULT16_16(signx[j],P[j]);
295       X[j] = MULT16_16(signx[j],X[j]);
296       if (signx[j] < 0)
297          iy[j] = -iy[j];
298    } while (++j<N);
299    encode_pulses(iy, N, K, enc);
300    
301    /* Recompute the gain in one pass to reduce the encoder-decoder mismatch
302    due to the recursive computation used in quantisation. */
303    mix_pitch_and_residual(iy, X, N, K, P);
304    RESTORE_STACK;
305 }
306
307
308 /** Decode pulse vector and combine the result with the pitch vector to produce
309     the final normalised signal in the current band. */
310 void alg_unquant(celt_norm_t *X, int N, int K, celt_norm_t *P, ec_dec *dec)
311 {
312    VARDECL(int, iy);
313    SAVE_STACK;
314    K = get_pulses(K);
315    ALLOC(iy, N, int);
316    decode_pulses(iy, N, K, dec);
317    mix_pitch_and_residual(iy, X, N, K, P);
318    RESTORE_STACK;
319 }
320
321 celt_word16_t renormalise_vector(celt_norm_t *X, celt_word16_t value, int N, int stride)
322 {
323    int i;
324    celt_word32_t E = EPSILON;
325    celt_word16_t rE;
326    celt_word16_t g;
327    celt_norm_t *xptr = X;
328    for (i=0;i<N;i++)
329    {
330       E = MAC16_16(E, *xptr, *xptr);
331       xptr += stride;
332    }
333
334    rE = celt_sqrt(E);
335 #ifdef FIXED_POINT
336    if (rE <= 128)
337       g = Q15ONE;
338    else
339 #endif
340       g = MULT16_16_Q15(value,celt_rcp(SHL32(rE,9)));
341    xptr = X;
342    for (i=0;i<N;i++)
343    {
344       *xptr = PSHR32(MULT16_16(g, *xptr),8);
345       xptr += stride;
346    }
347    return rE;
348 }
349
350 static void fold(const CELTMode *m, int N, celt_norm_t *Y, celt_norm_t * restrict P, int N0, int B)
351 {
352    int j;
353    const int C = CHANNELS(m);
354    int id = (N0*C) % (C*B);
355    /* Here, we assume that id will never be greater than N0, i.e. that 
356       no band is wider than N0. In the unlikely case it happens, we set
357       everything to zero */
358    /*{
359            int offset = (N0*C - (id+C*N))/2;
360            if (offset > C*N0/16)
361                    offset = C*N0/16;
362            offset -= offset % (C*B);
363            if (offset < 0)
364                    offset = 0;
365            //printf ("%d\n", offset);
366            id += offset;
367    }*/
368    if (id+C*N>N0*C)
369       for (j=0;j<C*N;j++)
370          P[j] = 0;
371    else
372       for (j=0;j<C*N;j++)
373          P[j] = Y[id++];
374 }
375
376 void intra_fold(const CELTMode *m, celt_norm_t * restrict x, int N, int *pulses, celt_norm_t *Y, celt_norm_t * restrict P, int N0, int B)
377 {
378    int c;
379    celt_word16_t pred_gain;
380    const int C = CHANNELS(m);
381
382    fold(m, N, Y, P, N0, B);
383    c=0;
384    do {
385       int K = get_pulses(pulses[c]);
386       if (K==0)
387          pred_gain = Q15ONE;
388       else
389          pred_gain = celt_div((celt_word32_t)MULT16_16(Q15_ONE,N),(celt_word32_t)(N+2*K*(K+1)));
390
391       renormalise_vector(P+c, pred_gain, N, C);
392    } while (++c < C);
393 }
394