2ab71226623922205ae87f6340cd20a60201ded5
[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 "stack_alloc.h"
51
52 kiss_fftr_cfg pitch_state_alloc(int max_lag)
53 {
54    return real16_fft_alloc(max_lag);
55 }
56
57 void pitch_state_free(kiss_fftr_cfg st)
58 {
59    real16_fft_free(st);
60 }
61
62 #ifdef FIXED_POINT
63 static void normalise16(celt_word16_t *x, int len, celt_word16_t val)
64 {
65    int i;
66    celt_word16_t maxabs;
67    maxabs = celt_maxabs16(x,len);
68    if (maxabs > val)
69    {
70       int shift = 0;
71       while (maxabs > val)
72       {
73          maxabs >>= 1;
74          shift++;
75       }
76       if (shift==0)
77          return;
78       i=0;
79       do{
80          x[i] = SHR16(x[i], shift);
81       } while (++i<len);
82    } else {
83       int shift=0;
84       if (maxabs == 0)
85          return;
86       val >>= 1;
87       while (maxabs < val)
88       {
89          val >>= 1;
90          shift++;
91       }
92       if (shift==0)
93          return;
94       i=0;
95       do{
96          x[i] = SHL16(x[i], shift);
97       } while (++i<len);
98    }
99 }
100 #else
101 #define normalise16(x,len,val)
102 #endif
103
104 #define INPUT_SHIFT 15
105
106 void find_spectral_pitch(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 overlap, int lag, int len, int C, int *pitch)
107 {
108    int c, i;
109    VARDECL(celt_word16_t, _X);
110    VARDECL(celt_word16_t, _Y);
111    VARDECL(celt_mask_t, curve);
112    celt_word16_t * restrict X, * restrict Y;
113    int n2;
114    int L2;
115    SAVE_STACK;
116    n2 = lag>>1;
117    L2 = len>>1;
118    ALLOC(_X, lag, celt_word16_t);
119    X = _X;
120    ALLOC(curve, n2, celt_mask_t);
121
122    CELT_MEMSET(X,0,lag);
123    /* Sum all channels of the current frame and copy into X in bit-reverse order */
124    for (c=0;c<C;c++)
125    {
126       for (i=0;i<L2;i++)
127       {
128          X[2*BITREV(fft,i)] += SHR32(x[C*(2*i)+c],INPUT_SHIFT);
129          X[2*BITREV(fft,i)+1] += SHR32(x[C*(2*i+1)+c],INPUT_SHIFT);
130       }
131    }
132    /* Applying the window in the bit-reverse domain. It's a bit weird, but it
133       can help save memory */
134    for (i=0;i<overlap>>1;i++)
135    {
136       X[2*BITREV(fft,i)] = MULT16_16_Q15(window[2*i], X[2*BITREV(fft,i)]);
137       X[2*BITREV(fft,i)+1] = MULT16_16_Q15(window[2*i+1], X[2*BITREV(fft,i)+1]);
138       X[2*BITREV(fft,L2-i-1)] = MULT16_16_Q15(window[2*i+1], X[2*BITREV(fft,L2-i-1)]);
139       X[2*BITREV(fft,L2-i-1)+1] = MULT16_16_Q15(window[2*i], X[2*BITREV(fft,L2-i-1)+1]);
140    }
141    normalise16(X, lag, 8192);
142    /*for (i=0;i<lag;i++) printf ("%d ", X[i]);printf ("\n");*/
143    /* Forward real FFT (in-place) */
144    real16_fft_inplace(fft, X, lag);
145
146    compute_masking(decay, X, curve, lag);
147
148    /* Deferred allocation to reduce peak stack usage */
149    ALLOC(_Y, lag, celt_word16_t);
150    Y = _Y;
151    CELT_MEMSET(Y,0,lag);
152    /* Sum all channels of the past audio and copy into Y in bit-reverse order */
153    for (c=0;c<C;c++)
154    {
155       for (i=0;i<n2;i++)
156       {
157          Y[2*BITREV(fft,i)] += SHR32(y[C*(2*i)+c],INPUT_SHIFT);
158          Y[2*BITREV(fft,i)+1] += SHR32(y[C*(2*i+1)+c],INPUT_SHIFT);
159       }
160    }
161    normalise16(Y, lag, 8192);
162    /* Forward real FFT (in-place) */
163    real16_fft_inplace(fft, Y, lag);
164
165    /* Compute cross-spectrum using the inverse masking curve as weighting */
166    for (i=1;i<n2;i++)
167    {
168       celt_word16_t Xr, Xi, n;
169       /* weight = 1/sqrt(curve) */
170       n = celt_rsqrt(EPSILON+curve[i]);
171       /* Pre-multiply X by n, so we can keep everything in 16 bits */
172       Xr = SHR32(MULT16_16(n, X[2*i  ]),3);
173       Xi = SHR32(MULT16_16(n, X[2*i+1]),3);
174       /* Cross-spectrum between X and conj(Y) */
175       X[2*i]   = ADD16(MULT16_16_Q15(Xr, Y[2*i  ]), MULT16_16_Q15(Xi,Y[2*i+1]));
176       X[2*i+1] = SUB16(MULT16_16_Q15(Xr, Y[2*i+1]), MULT16_16_Q15(Xi,Y[2*i  ]));
177    }
178    /*printf ("\n");*/
179    X[0] = X[1] = 0;
180    /*for (i=0;i<lag;i++) printf ("%d ", X[i]);printf ("\n");*/
181    normalise16(X, lag, 50);
182    /* Inverse half-complex to real FFT gives us the correlation */
183    real16_ifft(fft, X, Y, lag);
184    
185    /* The peak in the correlation gives us the pitch */
186    *pitch = find_max16(Y, lag-len);
187    RESTORE_STACK;
188 }