Better indexing for find_spectral_pitch()
[opus.git] / libcelt / pitch.c
1 /* (C) 2007-2008 Jean-Marc Valin, CSIRO
2 */
3 /**
4    @file pitch.c
5    @brief Pitch analysis
6  */
7
8 /*
9    Redistribution and use in source and binary forms, with or without
10    modification, are permitted provided that the following conditions
11    are met:
12    
13    - Redistributions of source code must retain the above copyright
14    notice, this list of conditions and the following disclaimer.
15    
16    - Redistributions in binary form must reproduce the above copyright
17    notice, this list of conditions and the following disclaimer in the
18    documentation and/or other materials provided with the distribution.
19    
20    - Neither the name of the Xiph.org Foundation nor the names of its
21    contributors may be used to endorse or promote products derived from
22    this software without specific prior written permission.
23    
24    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
28    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
29    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
30    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
31    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
32    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
33    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
34    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 */
36
37
38 #ifdef HAVE_CONFIG_H
39 #include "config.h"
40 #endif
41
42 /*#include "_kiss_fft_guts.h"
43 #include "kiss_fftr.h"*/
44 #include "kfft_single.h"
45
46 #include "pitch.h"
47 #include "psy.h"
48 #include "os_support.h"
49 #include "mathops.h"
50 #include "modes.h"
51 #include "stack_alloc.h"
52
53 kiss_fftr_cfg pitch_state_alloc(int max_lag)
54 {
55    return real16_fft_alloc(max_lag);
56 }
57
58 void pitch_state_free(kiss_fftr_cfg st)
59 {
60    real16_fft_free(st);
61 }
62
63 #ifdef FIXED_POINT
64 static void normalise16(celt_word16_t *x, int len, celt_word16_t val)
65 {
66    int i;
67    celt_word16_t maxabs;
68    maxabs = celt_maxabs16(x,len);
69    if (maxabs > val)
70    {
71       int shift = 0;
72       while (maxabs > val)
73       {
74          maxabs >>= 1;
75          shift++;
76       }
77       if (shift==0)
78          return;
79       i=0;
80       do{
81          x[i] = SHR16(x[i], shift);
82       } while (++i<len);
83    } else {
84       int shift=0;
85       if (maxabs == 0)
86          return;
87       val >>= 1;
88       while (maxabs < val)
89       {
90          val >>= 1;
91          shift++;
92       }
93       if (shift==0)
94          return;
95       i=0;
96       do{
97          x[i] = SHL16(x[i], shift);
98       } while (++i<len);
99    }
100 }
101 #else
102 #define normalise16(x,len,val)
103 #endif
104
105 #define INPUT_SHIFT 15
106
107 void find_spectral_pitch(const CELTMode *m, kiss_fftr_cfg fft, const struct PsyDecay *decay, const celt_sig_t * restrict x, const celt_sig_t * restrict y, const celt_word16_t * restrict window, int len, int *pitch)
108 {
109    int c, i;
110    VARDECL(celt_word16_t, _X);
111    VARDECL(celt_word16_t, _Y);
112    const celt_word16_t * restrict wptr;
113 #ifndef SHORTCUTS
114    VARDECL(celt_mask_t, curve);
115 #endif
116    celt_word16_t * restrict X, * restrict Y;
117    celt_word16_t * restrict Xptr, * restrict Yptr;
118    int n2;
119    int L2;
120    const int C = CHANNELS(m);
121    const int overlap = OVERLAP(m);
122    const int lag = MAX_PERIOD;
123    SAVE_STACK;
124    n2 = lag>>1;
125    L2 = len>>1;
126    ALLOC(_X, lag, celt_word16_t);
127    X = _X;
128 #ifndef SHORTCUTS
129    ALLOC(curve, n2, celt_mask_t);
130 #endif
131    CELT_MEMSET(X,0,lag);
132    /* Sum all channels of the current frame and copy into X in bit-reverse order */
133    for (c=0;c<C;c++)
134    {
135       const celt_sig_t * restrict xptr = &x[c];
136       for (i=0;i<L2;i++)
137       {
138          X[2*BITREV(fft,i)] += SHR32(*xptr,INPUT_SHIFT);
139          xptr += C;
140          X[2*BITREV(fft,i)+1] += SHR32(*xptr,INPUT_SHIFT);
141          xptr += C;
142       }
143    }
144    /* Applying the window in the bit-reverse domain. It's a bit weird, but it
145       can help save memory */
146    wptr = window;
147    for (i=0;i<overlap>>1;i++)
148    {
149       X[2*BITREV(fft,i)]        = MULT16_16_Q15(wptr[0], X[2*BITREV(fft,i)]);
150       X[2*BITREV(fft,i)+1]      = MULT16_16_Q15(wptr[1], X[2*BITREV(fft,i)+1]);
151       X[2*BITREV(fft,L2-i-1)]   = MULT16_16_Q15(wptr[1], X[2*BITREV(fft,L2-i-1)]);
152       X[2*BITREV(fft,L2-i-1)+1] = MULT16_16_Q15(wptr[0], X[2*BITREV(fft,L2-i-1)+1]);
153       wptr += 2;
154    }
155    normalise16(X, lag, 8192);
156    /*for (i=0;i<lag;i++) printf ("%d ", X[i]);printf ("\n");*/
157    /* Forward real FFT (in-place) */
158    real16_fft_inplace(fft, X, lag);
159
160 #ifndef SHORTCUTS
161    compute_masking(decay, X, curve, lag);
162 #endif
163    
164    /* Deferred allocation to reduce peak stack usage */
165    ALLOC(_Y, lag, celt_word16_t);
166    Y = _Y;
167    CELT_MEMSET(Y,0,lag);
168    /* Sum all channels of the past audio and copy into Y in bit-reverse order */
169    for (c=0;c<C;c++)
170    {
171       const celt_sig_t * restrict yptr = &y[c];
172       for (i=0;i<n2;i++)
173       {
174          Y[2*BITREV(fft,i)] += SHR32(*yptr,INPUT_SHIFT);
175          yptr += C;
176          Y[2*BITREV(fft,i)+1] += SHR32(*yptr,INPUT_SHIFT);
177          yptr += C;
178       }
179    }
180    normalise16(Y, lag, 8192);
181    /* Forward real FFT (in-place) */
182    real16_fft_inplace(fft, Y, lag);
183
184    /* Compute cross-spectrum using the inverse masking curve as weighting */
185    Xptr = &X[2];
186    Yptr = &Y[2];
187    for (i=1;i<n2;i++)
188    {
189       celt_word16_t Xr, Xi, n;
190       /* weight = 1/sqrt(curve) */
191       Xr = Xptr[0];
192       Xi = Xptr[1];
193 #ifdef SHORTCUTS
194       /*n = SHR32(32767,(celt_ilog2(EPSILON+curve[i])>>1));*/
195       n = SHR32(32767,(celt_ilog2(EPSILON+MULT16_16(Xr,Xr)+MULT16_16(Xi,Xi))>>1));
196 #else
197       n = celt_rsqrt(EPSILON+curve[i]);
198 #endif
199       /* Pre-multiply X by n, so we can keep everything in 16 bits */
200       Xr = EXTRACT16(SHR32(MULT16_16(n, Xr),3));
201       Xi = EXTRACT16(SHR32(MULT16_16(n, Xi),3));
202       /* Cross-spectrum between X and conj(Y) */
203       *Xptr++ = ADD16(MULT16_16_Q15(Xr, Yptr[0]), MULT16_16_Q15(Xi,Yptr[1]));
204       *Xptr++ = SUB16(MULT16_16_Q15(Xr, Yptr[1]), MULT16_16_Q15(Xi,Yptr[0]));
205       Yptr += 2;
206    }
207    /*printf ("\n");*/
208    X[0] = X[1] = 0;
209    /*for (i=0;i<lag;i++) printf ("%d ", X[i]);printf ("\n");*/
210    normalise16(X, lag, 50);
211    /* Inverse half-complex to real FFT gives us the correlation */
212    real16_ifft(fft, X, Y, lag);
213    
214    /* The peak in the correlation gives us the pitch */
215    *pitch = find_max16(Y, lag-len);
216    RESTORE_STACK;
217 }