Fix celt_pitch_xcorr_c signature.
[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  || defined(OPUS_X86_MAY_HAVE_SSE4_1) || defined(OPUS_X86_MAY_HAVE_SSE2)
42 #include "x86/pitch_sse.h"
43 #endif
44
45 #if defined(MIPSr1_ASM)
46 #include "mips/pitch_mipsr1.h"
47 #endif
48
49 #if defined(OPUS_ARM_ASM) && defined(FIXED_POINT)
50 # include "arm/pitch_arm.h"
51 #endif
52
53 void pitch_downsample(celt_sig * OPUS_RESTRICT x[], opus_val16 * OPUS_RESTRICT x_lp,
54       int len, int C, int arch);
55
56 void pitch_search(const opus_val16 * OPUS_RESTRICT x_lp, opus_val16 * OPUS_RESTRICT y,
57                   int len, int max_pitch, int *pitch, int arch);
58
59 opus_val16 remove_doubling(opus_val16 *x, int maxperiod, int minperiod,
60       int N, int *T0, int prev_period, opus_val16 prev_gain, int arch);
61
62
63 /* OPT: This is the kernel you really want to optimize. It gets used a lot
64    by the prefilter and by the PLC. */
65 static OPUS_INLINE void xcorr_kernel_c(const opus_val16 * x, const opus_val16 * y, opus_val32 sum[4], int len)
66 {
67    int j;
68    opus_val16 y_0, y_1, y_2, y_3;
69    celt_assert(len>=3);
70    y_3=0; /* gcc doesn't realize that y_3 can't be used uninitialized */
71    y_0=*y++;
72    y_1=*y++;
73    y_2=*y++;
74    for (j=0;j<len-3;j+=4)
75    {
76       opus_val16 tmp;
77       tmp = *x++;
78       y_3=*y++;
79       sum[0] = MAC16_16(sum[0],tmp,y_0);
80       sum[1] = MAC16_16(sum[1],tmp,y_1);
81       sum[2] = MAC16_16(sum[2],tmp,y_2);
82       sum[3] = MAC16_16(sum[3],tmp,y_3);
83       tmp=*x++;
84       y_0=*y++;
85       sum[0] = MAC16_16(sum[0],tmp,y_1);
86       sum[1] = MAC16_16(sum[1],tmp,y_2);
87       sum[2] = MAC16_16(sum[2],tmp,y_3);
88       sum[3] = MAC16_16(sum[3],tmp,y_0);
89       tmp=*x++;
90       y_1=*y++;
91       sum[0] = MAC16_16(sum[0],tmp,y_2);
92       sum[1] = MAC16_16(sum[1],tmp,y_3);
93       sum[2] = MAC16_16(sum[2],tmp,y_0);
94       sum[3] = MAC16_16(sum[3],tmp,y_1);
95       tmp=*x++;
96       y_2=*y++;
97       sum[0] = MAC16_16(sum[0],tmp,y_3);
98       sum[1] = MAC16_16(sum[1],tmp,y_0);
99       sum[2] = MAC16_16(sum[2],tmp,y_1);
100       sum[3] = MAC16_16(sum[3],tmp,y_2);
101    }
102    if (j++<len)
103    {
104       opus_val16 tmp = *x++;
105       y_3=*y++;
106       sum[0] = MAC16_16(sum[0],tmp,y_0);
107       sum[1] = MAC16_16(sum[1],tmp,y_1);
108       sum[2] = MAC16_16(sum[2],tmp,y_2);
109       sum[3] = MAC16_16(sum[3],tmp,y_3);
110    }
111    if (j++<len)
112    {
113       opus_val16 tmp=*x++;
114       y_0=*y++;
115       sum[0] = MAC16_16(sum[0],tmp,y_1);
116       sum[1] = MAC16_16(sum[1],tmp,y_2);
117       sum[2] = MAC16_16(sum[2],tmp,y_3);
118       sum[3] = MAC16_16(sum[3],tmp,y_0);
119    }
120    if (j<len)
121    {
122       opus_val16 tmp=*x++;
123       y_1=*y++;
124       sum[0] = MAC16_16(sum[0],tmp,y_2);
125       sum[1] = MAC16_16(sum[1],tmp,y_3);
126       sum[2] = MAC16_16(sum[2],tmp,y_0);
127       sum[3] = MAC16_16(sum[3],tmp,y_1);
128    }
129 }
130
131 #ifndef OVERRIDE_XCORR_KERNEL
132 #define xcorr_kernel(x, y, sum, len, arch) \
133     ((void)(arch),xcorr_kernel_c(x, y, sum, len))
134 #endif /* OVERRIDE_XCORR_KERNEL */
135
136
137 #ifndef OVERRIDE_DUAL_INNER_PROD
138 static OPUS_INLINE void dual_inner_prod(const opus_val16 *x, const opus_val16 *y01, const opus_val16 *y02,
139       int N, opus_val32 *xy1, opus_val32 *xy2)
140 {
141    int i;
142    opus_val32 xy01=0;
143    opus_val32 xy02=0;
144    for (i=0;i<N;i++)
145    {
146       xy01 = MAC16_16(xy01, x[i], y01[i]);
147       xy02 = MAC16_16(xy02, x[i], y02[i]);
148    }
149    *xy1 = xy01;
150    *xy2 = xy02;
151 }
152 #endif
153
154 /*We make sure a C version is always available for cases where the overhead of
155   vectorization and passing around an arch flag aren't worth it.*/
156 static OPUS_INLINE opus_val32 celt_inner_prod_c(const opus_val16 *x,
157       const opus_val16 *y, int N)
158 {
159    int i;
160    opus_val32 xy=0;
161    for (i=0;i<N;i++)
162       xy = MAC16_16(xy, x[i], y[i]);
163    return xy;
164 }
165
166 #if !defined(OVERRIDE_CELT_INNER_PROD)
167 # define celt_inner_prod(x, y, N, arch) \
168     ((void)(arch),celt_inner_prod_c(x, y, N))
169 #endif
170
171 #ifdef FIXED_POINT
172 opus_val32
173 #else
174 void
175 #endif
176 celt_pitch_xcorr_c(const opus_val16 *_x, const opus_val16 *_y,
177       opus_val32 *xcorr, int len, int max_pitch);
178
179 #if !defined(OVERRIDE_PITCH_XCORR)
180 /*Is run-time CPU detection enabled on this platform?*/
181 # if defined(OPUS_HAVE_RTCD) && defined(OPUS_ARM_ASM)
182 extern
183 #  if defined(FIXED_POINT)
184 opus_val32
185 #  else
186 void
187 #  endif
188 (*const CELT_PITCH_XCORR_IMPL[OPUS_ARCHMASK+1])(const opus_val16 *,
189       const opus_val16 *, opus_val32 *, int, int);
190
191 #  define OVERRIDE_PITCH_XCORR
192 #  define celt_pitch_xcorr(_x, _y, xcorr, len, max_pitch, arch) \
193   ((*CELT_PITCH_XCORR_IMPL[(arch)&OPUS_ARCHMASK])(_x, _y, \
194         xcorr, len, max_pitch))
195 # else
196
197 #ifdef FIXED_POINT
198 opus_val32
199 #else
200 void
201 #endif
202 celt_pitch_xcorr(const opus_val16 *_x, const opus_val16 *_y,
203       opus_val32 *xcorr, int len, int max_pitch, int arch);
204
205 # endif
206 #endif
207
208 #endif