Making the real/single FFT easier to replace
[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 maxval = 0;
67    for (i=0;i<len;i++)
68       maxval = MAX16(maxval, ABS16(x[i]));
69    if (maxval > val)
70    {
71       int shift = 0;
72       while (maxval > val)
73       {
74          maxval >>= 1;
75          shift++;
76       }
77       if (shift==0)
78          return;
79       for (i=0;i<len;i++)
80          x[i] = SHR16(x[i], shift);
81    } else {
82       int shift=0;
83       if (maxval == 0)
84          return;
85       val >>= 1;
86       while (maxval < val)
87       {
88          val >>= 1;
89          shift++;
90       }
91       if (shift==0)
92          return;
93       for (i=0;i<len;i++)
94          x[i] = SHL16(x[i], shift);
95    }
96 }
97 #else
98 #define normalise16(x,len,val)
99 #endif
100
101 #define INPUT_SHIFT 15
102
103 void find_spectral_pitch(kiss_fftr_cfg fft, const struct PsyDecay *decay, const celt_sig_t *x, const celt_sig_t *y, const celt_word16_t *window, int overlap, int lag, int len, int C, int *pitch)
104 {
105    int c, i;
106    celt_word32_t max_corr;
107    VARDECL(celt_word16_t, X);
108    VARDECL(celt_word16_t, Y);
109    VARDECL(celt_mask_t, curve);
110    int n2;
111    int L2;
112    const int *bitrev;
113    SAVE_STACK;
114    n2 = lag/2;
115    L2 = len/2;
116    ALLOC(X, lag, celt_word16_t);
117    ALLOC(curve, n2, celt_mask_t);
118
119    bitrev = fft->substate->bitrev;
120    for (i=0;i<lag;i++)
121       X[i] = 0;
122    /* Sum all channels of the current frame and copy into X in bit-reverse order */
123    for (c=0;c<C;c++)
124    {
125       for (i=0;i<L2;i++)
126       {
127          X[2*BITREV(fft,i)] += SHR32(x[C*(2*i)+c],INPUT_SHIFT);
128          X[2*BITREV(fft,i)+1] += SHR32(x[C*(2*i+1)+c],INPUT_SHIFT);
129       }
130    }
131    /* Applying the window in the bit-reverse domain. It's a bit weird, but it
132       can help save memory */
133    for (i=0;i<overlap/2;i++)
134    {
135       X[2*BITREV(fft,i)] = MULT16_16_Q15(window[2*i], X[2*BITREV(fft,i)]);
136       X[2*BITREV(fft,i)+1] = MULT16_16_Q15(window[2*i+1], X[2*BITREV(fft,i)+1]);
137       X[2*BITREV(fft,L2-i-1)] = MULT16_16_Q15(window[2*i+1], X[2*BITREV(fft,L2-i-1)]);
138       X[2*BITREV(fft,L2-i-1)+1] = MULT16_16_Q15(window[2*i], X[2*BITREV(fft,L2-i-1)+1]);
139    }
140    normalise16(X, lag, 8192);
141    /*for (i=0;i<lag;i++) printf ("%d ", X[i]);printf ("\n");*/
142    /* Forward real FFT (in-place) */
143    real16_fft_inplace(fft, X);
144
145    compute_masking(decay, X, curve, lag);
146
147    /* Deferred allocation to reduce peak stack usage */
148    ALLOC(Y, lag, celt_word16_t);
149    for (i=0;i<lag;i++)
150       Y[i] = 0;
151    /* Sum all channels of the past audio and copy into Y in bit-reverse order */
152    for (c=0;c<C;c++)
153    {
154       for (i=0;i<n2;i++)
155       {
156          Y[2*BITREV(fft,i)] += SHR32(y[C*(2*i)+c],INPUT_SHIFT);
157          Y[2*BITREV(fft,i)+1] += SHR32(y[C*(2*i+1)+c],INPUT_SHIFT);
158       }
159    }
160    normalise16(Y, lag, 8192);
161    /* Forward real FFT (in-place) */
162    real16_fft_inplace(fft, Y);
163
164    /* Compute cross-spectrum using the inverse masking curve as weighting */
165    for (i=1;i<n2;i++)
166    {
167       celt_word16_t n;
168       celt_word32_t tmp;
169       /*printf ("%d %d ", X[2*i]*X[2*i]+X[2*i+1]*X[2*i+1], Y[2*i]*Y[2*i]+Y[2*i+1]*Y[2*i+1]);*/
170       /*n = DIV32_16(Q15ONE,celt_sqrt(EPSILON+curve[i]));*/
171       n = ROUND(celt_rcp(celt_sqrt(EPSILON+curve[i])),16);
172       /*printf ("%f ", n);*/
173       tmp = X[2*i];
174       X[2*i] = MULT16_32_Q15(n, ADD32(MULT16_16(X[2*i  ],Y[2*i  ]), MULT16_16(X[2*i+1],Y[2*i+1])));
175       X[2*i+1] = MULT16_32_Q15(n, SUB32(MULT16_16(tmp,Y[2*i+1]), MULT16_16(X[2*i+1],Y[2*i  ])));
176    }
177    /*printf ("\n");*/
178    X[0] = X[1] = 0;
179    /*for (i=0;i<lag;i++) printf ("%d ", X[i]);printf ("\n");*/
180    normalise16(X, lag, 50);
181    /* Inverse half-complex to real FFT gives us the correlation */
182    real16_ifft(fft, X, Y);
183    
184    /* The peak in the correlation gives us the pitch */
185    max_corr=-VERY_LARGE32;
186    *pitch = 0;
187    for (i=0;i<lag-len;i++)
188    {
189       /*printf ("%f ", xx[i]);*/
190       if (Y[i] > max_corr)
191       {
192          *pitch = i;
193          max_corr = Y[i];
194       }
195    }
196    RESTORE_STACK;
197 }