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