Intensity stereo update, partially based on Monty's listening
[opus.git] / celt / pitch.h
1 /* Copyright (c) 2007-2008 CSIRO
2    Copyright (c) 2007-2009 Xiph.Org Foundation
3    Written by Jean-Marc Valin */
4 /**
5    @file pitch.h
6    @brief Pitch analysis
7  */
8
9 /*
10    Redistribution and use in source and binary forms, with or without
11    modification, are permitted provided that the following conditions
12    are met:
13
14    - Redistributions of source code must retain the above copyright
15    notice, this list of conditions and the following disclaimer.
16
17    - Redistributions in binary form must reproduce the above copyright
18    notice, this list of conditions and the following disclaimer in the
19    documentation and/or other materials provided with the distribution.
20
21    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
25    OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
28    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 */
33
34 #ifndef PITCH_H
35 #define PITCH_H
36
37 #include "modes.h"
38 #include "cpu_support.h"
39
40 #if defined(__SSE__) && !defined(FIXED_POINT)
41 #include "x86/pitch_sse.h"
42 #endif
43
44 #if defined(OPUS_ARM_ASM) && defined(FIXED_POINT)
45 # include "arm/pitch_arm.h"
46 #endif
47
48 void pitch_downsample(celt_sig * OPUS_RESTRICT x[], opus_val16 * OPUS_RESTRICT x_lp,
49       int len, int C, int arch);
50
51 void pitch_search(const opus_val16 * OPUS_RESTRICT x_lp, opus_val16 * OPUS_RESTRICT y,
52                   int len, int max_pitch, int *pitch, int arch);
53
54 opus_val16 remove_doubling(opus_val16 *x, int maxperiod, int minperiod,
55       int N, int *T0, int prev_period, opus_val16 prev_gain);
56
57 /* OPT: This is the kernel you really want to optimize. It gets used a lot
58    by the prefilter and by the PLC. */
59 #ifndef OVERRIDE_XCORR_KERNEL
60 static OPUS_INLINE void xcorr_kernel(const opus_val16 * x, const opus_val16 * y, opus_val32 sum[4], int len)
61 {
62    int j;
63    opus_val16 y_0, y_1, y_2, y_3;
64    y_3=0; /* gcc doesn't realize that y_3 can't be used uninitialized */
65    y_0=*y++;
66    y_1=*y++;
67    y_2=*y++;
68    for (j=0;j<len-3;j+=4)
69    {
70       opus_val16 tmp;
71       tmp = *x++;
72       y_3=*y++;
73       sum[0] = MAC16_16(sum[0],tmp,y_0);
74       sum[1] = MAC16_16(sum[1],tmp,y_1);
75       sum[2] = MAC16_16(sum[2],tmp,y_2);
76       sum[3] = MAC16_16(sum[3],tmp,y_3);
77       tmp=*x++;
78       y_0=*y++;
79       sum[0] = MAC16_16(sum[0],tmp,y_1);
80       sum[1] = MAC16_16(sum[1],tmp,y_2);
81       sum[2] = MAC16_16(sum[2],tmp,y_3);
82       sum[3] = MAC16_16(sum[3],tmp,y_0);
83       tmp=*x++;
84       y_1=*y++;
85       sum[0] = MAC16_16(sum[0],tmp,y_2);
86       sum[1] = MAC16_16(sum[1],tmp,y_3);
87       sum[2] = MAC16_16(sum[2],tmp,y_0);
88       sum[3] = MAC16_16(sum[3],tmp,y_1);
89       tmp=*x++;
90       y_2=*y++;
91       sum[0] = MAC16_16(sum[0],tmp,y_3);
92       sum[1] = MAC16_16(sum[1],tmp,y_0);
93       sum[2] = MAC16_16(sum[2],tmp,y_1);
94       sum[3] = MAC16_16(sum[3],tmp,y_2);
95    }
96    if (j++<len)
97    {
98       opus_val16 tmp = *x++;
99       y_3=*y++;
100       sum[0] = MAC16_16(sum[0],tmp,y_0);
101       sum[1] = MAC16_16(sum[1],tmp,y_1);
102       sum[2] = MAC16_16(sum[2],tmp,y_2);
103       sum[3] = MAC16_16(sum[3],tmp,y_3);
104    }
105    if (j++<len)
106    {
107       opus_val16 tmp=*x++;
108       y_0=*y++;
109       sum[0] = MAC16_16(sum[0],tmp,y_1);
110       sum[1] = MAC16_16(sum[1],tmp,y_2);
111       sum[2] = MAC16_16(sum[2],tmp,y_3);
112       sum[3] = MAC16_16(sum[3],tmp,y_0);
113    }
114    if (j<len)
115    {
116       opus_val16 tmp=*x++;
117       y_1=*y++;
118       sum[0] = MAC16_16(sum[0],tmp,y_2);
119       sum[1] = MAC16_16(sum[1],tmp,y_3);
120       sum[2] = MAC16_16(sum[2],tmp,y_0);
121       sum[3] = MAC16_16(sum[3],tmp,y_1);
122    }
123 }
124 #endif /* OVERRIDE_XCORR_KERNEL */
125
126 #ifndef OVERRIDE_DUAL_INNER_PROD
127 static OPUS_INLINE void dual_inner_prod(const opus_val16 *x, const opus_val16 *y01, const opus_val16 *y02,
128       int N, opus_val32 *xy1, opus_val32 *xy2)
129 {
130    int i;
131    opus_val32 xy01=0;
132    opus_val32 xy02=0;
133    for (i=0;i<N;i++)
134    {
135       xy01 = MAC16_16(xy01, x[i], y01[i]);
136       xy02 = MAC16_16(xy02, x[i], y02[i]);
137    }
138    *xy1 = xy01;
139    *xy2 = xy02;
140 }
141 #endif
142
143 #ifdef FIXED_POINT
144 opus_val32
145 #else
146 void
147 #endif
148 celt_pitch_xcorr_c(const opus_val16 *_x, const opus_val16 *_y,
149       opus_val32 *xcorr, int len, int max_pitch);
150
151 #if !defined(OVERRIDE_PITCH_XCORR)
152 /*Is run-time CPU detection enabled on this platform?*/
153 # if defined(OPUS_HAVE_RTCD)
154 extern
155 #  if defined(FIXED_POINT)
156 opus_val32
157 #  else
158 void
159 #  endif
160 (*const CELT_PITCH_XCORR_IMPL[OPUS_ARCHMASK+1])(const opus_val16 *,
161       const opus_val16 *, opus_val32 *, int, int);
162
163 #  define celt_pitch_xcorr(_x, _y, xcorr, len, max_pitch, arch) \
164   ((*CELT_PITCH_XCORR_IMPL[(arch)&OPUS_ARCHMASK])(_x, _y, \
165         xcorr, len, max_pitch))
166 # else
167 #  define celt_pitch_xcorr(_x, _y, xcorr, len, max_pitch, arch) \
168   ((void)(arch),celt_pitch_xcorr_c(_x, _y, xcorr, len, max_pitch))
169 # endif
170 #else
171
172 /*static inline opus_val32 real_celt_pitch_xcorr(const opus_val16 *_x,
173  const opus_val16 *_y,opus_val32 *xcorr,int len,int max_pitch,int arch){
174   opus_val32 *xcorr_tmp;
175   opus_val32  ret_tmp;
176   opus_val32  ret;
177   int         i;
178   xcorr_tmp=(opus_val32 *)malloc(max_pitch*sizeof(*xcorr));
179   ret_tmp=celt_pitch_xcorr_c(_x,_y,xcorr_tmp,len,max_pitch);
180   ret=celt_pitch_xcorr(_x,_y,xcorr,len,max_pitch,arch);
181   for(i=0;i<max_pitch;i++)if(xcorr[i]!=xcorr_tmp[i]){
182     fprintf(stderr,"xcorr[%i] (0x%08X) != xcorr_tmp[%i] (0x%08X)\n",
183      i,xcorr[i],i,xcorr_tmp[i]);
184   }
185   if(ret!=ret_tmp){
186     fprintf(stderr,"ret (0x%08X) != ret_tmp (0x%08X)\n",ret,ret_tmp);
187   }
188   return ret_tmp;
189 }
190
191 #undef celt_pitch_xcorr
192 #define celt_pitch_xcorr real_celt_pitch_xcorr*/
193
194 #endif
195
196 #endif