added a shortcut (SHORTCUT) to skip the spreading function in the pitch search
[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 #ifndef SHORTCUTS
113    VARDECL(celt_mask_t, curve);
114 #endif
115    celt_word16_t * restrict X, * restrict Y;
116    int n2;
117    int L2;
118    const int C = CHANNELS(m);
119    const int overlap = OVERLAP(m);
120    const int lag = MAX_PERIOD;
121    SAVE_STACK;
122    n2 = lag>>1;
123    L2 = len>>1;
124    ALLOC(_X, lag, celt_word16_t);
125    X = _X;
126 #ifndef SHORTCUTS
127    ALLOC(curve, n2, celt_mask_t);
128 #endif
129    CELT_MEMSET(X,0,lag);
130    /* Sum all channels of the current frame and copy into X in bit-reverse order */
131    for (c=0;c<C;c++)
132    {
133       for (i=0;i<L2;i++)
134       {
135          X[2*BITREV(fft,i)] += SHR32(x[C*(2*i)+c],INPUT_SHIFT);
136          X[2*BITREV(fft,i)+1] += SHR32(x[C*(2*i+1)+c],INPUT_SHIFT);
137       }
138    }
139    /* Applying the window in the bit-reverse domain. It's a bit weird, but it
140       can help save memory */
141    for (i=0;i<overlap>>1;i++)
142    {
143       X[2*BITREV(fft,i)] = MULT16_16_Q15(window[2*i], X[2*BITREV(fft,i)]);
144       X[2*BITREV(fft,i)+1] = MULT16_16_Q15(window[2*i+1], X[2*BITREV(fft,i)+1]);
145       X[2*BITREV(fft,L2-i-1)] = MULT16_16_Q15(window[2*i+1], X[2*BITREV(fft,L2-i-1)]);
146       X[2*BITREV(fft,L2-i-1)+1] = MULT16_16_Q15(window[2*i], X[2*BITREV(fft,L2-i-1)+1]);
147    }
148    normalise16(X, lag, 8192);
149    /*for (i=0;i<lag;i++) printf ("%d ", X[i]);printf ("\n");*/
150    /* Forward real FFT (in-place) */
151    real16_fft_inplace(fft, X, lag);
152
153 #ifndef SHORTCUTS
154    compute_masking(decay, X, curve, lag);
155 #endif
156    
157    /* Deferred allocation to reduce peak stack usage */
158    ALLOC(_Y, lag, celt_word16_t);
159    Y = _Y;
160    CELT_MEMSET(Y,0,lag);
161    /* Sum all channels of the past audio and copy into Y in bit-reverse order */
162    for (c=0;c<C;c++)
163    {
164       for (i=0;i<n2;i++)
165       {
166          Y[2*BITREV(fft,i)] += SHR32(y[C*(2*i)+c],INPUT_SHIFT);
167          Y[2*BITREV(fft,i)+1] += SHR32(y[C*(2*i+1)+c],INPUT_SHIFT);
168       }
169    }
170    normalise16(Y, lag, 8192);
171    /* Forward real FFT (in-place) */
172    real16_fft_inplace(fft, Y, lag);
173
174    /* Compute cross-spectrum using the inverse masking curve as weighting */
175    for (i=1;i<n2;i++)
176    {
177       celt_word16_t Xr, Xi, n;
178       /* weight = 1/sqrt(curve) */
179       Xr = X[2*i];
180       Xi = X[2*i+1];
181 #ifdef SHORTCUTS
182       /*n = SHR32(32767,(celt_ilog2(EPSILON+curve[i])>>1));*/
183       n = SHR32(32767,(celt_ilog2(EPSILON+MULT16_16(Xr,Xr)+MULT16_16(Xi,Xi))>>1));
184 #else
185       n = celt_rsqrt(EPSILON+curve[i]);
186 #endif
187       /* Pre-multiply X by n, so we can keep everything in 16 bits */
188       Xr = EXTRACT16(SHR32(MULT16_16(n, Xr),3));
189       Xi = EXTRACT16(SHR32(MULT16_16(n, Xi),3));
190       /* Cross-spectrum between X and conj(Y) */
191       X[2*i]   = ADD16(MULT16_16_Q15(Xr, Y[2*i  ]), MULT16_16_Q15(Xi,Y[2*i+1]));
192       X[2*i+1] = SUB16(MULT16_16_Q15(Xr, Y[2*i+1]), MULT16_16_Q15(Xi,Y[2*i  ]));
193    }
194    /*printf ("\n");*/
195    X[0] = X[1] = 0;
196    /*for (i=0;i<lag;i++) printf ("%d ", X[i]);printf ("\n");*/
197    normalise16(X, lag, 50);
198    /* Inverse half-complex to real FFT gives us the correlation */
199    real16_ifft(fft, X, Y, lag);
200    
201    /* The peak in the correlation gives us the pitch */
202    *pitch = find_max16(Y, lag-len);
203    RESTORE_STACK;
204 }