Document how to tell if your build is fixed-point.
[opus.git] / celt / celt.c
1 /* Copyright (c) 2007-2008 CSIRO
2    Copyright (c) 2007-2010 Xiph.Org Foundation
3    Copyright (c) 2008 Gregory Maxwell
4    Written by Jean-Marc Valin and Gregory Maxwell */
5 /*
6    Redistribution and use in source and binary forms, with or without
7    modification, are permitted provided that the following conditions
8    are met:
9
10    - Redistributions of source code must retain the above copyright
11    notice, this list of conditions and the following disclaimer.
12
13    - Redistributions in binary form must reproduce the above copyright
14    notice, this list of conditions and the following disclaimer in the
15    documentation and/or other materials provided with the distribution.
16
17    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
21    OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29
30 #ifdef HAVE_CONFIG_H
31 #include "config.h"
32 #endif
33
34 #define CELT_C
35
36 #include "os_support.h"
37 #include "mdct.h"
38 #include <math.h>
39 #include "celt.h"
40 #include "pitch.h"
41 #include "bands.h"
42 #include "modes.h"
43 #include "entcode.h"
44 #include "quant_bands.h"
45 #include "rate.h"
46 #include "stack_alloc.h"
47 #include "mathops.h"
48 #include "float_cast.h"
49 #include <stdarg.h>
50 #include "celt_lpc.h"
51 #include "vq.h"
52
53 #ifndef PACKAGE_VERSION
54 #define PACKAGE_VERSION "unknown"
55 #endif
56
57 #if defined(MIPSr1_ASM)
58 #include "mips/celt_mipsr1.h"
59 #endif
60
61
62 int resampling_factor(opus_int32 rate)
63 {
64    int ret;
65    switch (rate)
66    {
67    case 48000:
68       ret = 1;
69       break;
70    case 24000:
71       ret = 2;
72       break;
73    case 16000:
74       ret = 3;
75       break;
76    case 12000:
77       ret = 4;
78       break;
79    case 8000:
80       ret = 6;
81       break;
82    default:
83 #ifndef CUSTOM_MODES
84       celt_assert(0);
85 #endif
86       ret = 0;
87       break;
88    }
89    return ret;
90 }
91
92 #ifndef OVERRIDE_COMB_FILTER_CONST
93 /* This version should be faster on ARM */
94 #ifdef OPUS_ARM_ASM
95 static void comb_filter_const(opus_val32 *y, opus_val32 *x, int T, int N,
96       opus_val16 g10, opus_val16 g11, opus_val16 g12)
97 {
98    opus_val32 x0, x1, x2, x3, x4;
99    int i;
100    x4 = SHL32(x[-T-2], 1);
101    x3 = SHL32(x[-T-1], 1);
102    x2 = SHL32(x[-T], 1);
103    x1 = SHL32(x[-T+1], 1);
104    for (i=0;i<N-4;i+=5)
105    {
106       opus_val32 t;
107       x0=SHL32(x[i-T+2],1);
108       t = MAC16_32_Q16(x[i], g10, x2);
109       t = MAC16_32_Q16(t, g11, ADD32(x1,x3));
110       t = MAC16_32_Q16(t, g12, ADD32(x0,x4));
111       y[i] = t;
112       x4=SHL32(x[i-T+3],1);
113       t = MAC16_32_Q16(x[i+1], g10, x1);
114       t = MAC16_32_Q16(t, g11, ADD32(x0,x2));
115       t = MAC16_32_Q16(t, g12, ADD32(x4,x3));
116       y[i+1] = t;
117       x3=SHL32(x[i-T+4],1);
118       t = MAC16_32_Q16(x[i+2], g10, x0);
119       t = MAC16_32_Q16(t, g11, ADD32(x4,x1));
120       t = MAC16_32_Q16(t, g12, ADD32(x3,x2));
121       y[i+2] = t;
122       x2=SHL32(x[i-T+5],1);
123       t = MAC16_32_Q16(x[i+3], g10, x4);
124       t = MAC16_32_Q16(t, g11, ADD32(x3,x0));
125       t = MAC16_32_Q16(t, g12, ADD32(x2,x1));
126       y[i+3] = t;
127       x1=SHL32(x[i-T+6],1);
128       t = MAC16_32_Q16(x[i+4], g10, x3);
129       t = MAC16_32_Q16(t, g11, ADD32(x2,x4));
130       t = MAC16_32_Q16(t, g12, ADD32(x1,x0));
131       y[i+4] = t;
132    }
133 #ifdef CUSTOM_MODES
134    for (;i<N;i++)
135    {
136       opus_val32 t;
137       x0=SHL32(x[i-T+2],1);
138       t = MAC16_32_Q16(x[i], g10, x2);
139       t = MAC16_32_Q16(t, g11, ADD32(x1,x3));
140       t = MAC16_32_Q16(t, g12, ADD32(x0,x4));
141       y[i] = t;
142       x4=x3;
143       x3=x2;
144       x2=x1;
145       x1=x0;
146    }
147 #endif
148 }
149 #else
150 static void comb_filter_const(opus_val32 *y, opus_val32 *x, int T, int N,
151       opus_val16 g10, opus_val16 g11, opus_val16 g12)
152 {
153    opus_val32 x0, x1, x2, x3, x4;
154    int i;
155    x4 = x[-T-2];
156    x3 = x[-T-1];
157    x2 = x[-T];
158    x1 = x[-T+1];
159    for (i=0;i<N;i++)
160    {
161       x0=x[i-T+2];
162       y[i] = x[i]
163                + MULT16_32_Q15(g10,x2)
164                + MULT16_32_Q15(g11,ADD32(x1,x3))
165                + MULT16_32_Q15(g12,ADD32(x0,x4));
166       x4=x3;
167       x3=x2;
168       x2=x1;
169       x1=x0;
170    }
171
172 }
173 #endif
174 #endif
175
176 #ifndef OVERRIDE_comb_filter
177 void comb_filter(opus_val32 *y, opus_val32 *x, int T0, int T1, int N,
178       opus_val16 g0, opus_val16 g1, int tapset0, int tapset1,
179       const opus_val16 *window, int overlap)
180 {
181    int i;
182    /* printf ("%d %d %f %f\n", T0, T1, g0, g1); */
183    opus_val16 g00, g01, g02, g10, g11, g12;
184    opus_val32 x0, x1, x2, x3, x4;
185    static const opus_val16 gains[3][3] = {
186          {QCONST16(0.3066406250f, 15), QCONST16(0.2170410156f, 15), QCONST16(0.1296386719f, 15)},
187          {QCONST16(0.4638671875f, 15), QCONST16(0.2680664062f, 15), QCONST16(0.f, 15)},
188          {QCONST16(0.7998046875f, 15), QCONST16(0.1000976562f, 15), QCONST16(0.f, 15)}};
189
190    if (g0==0 && g1==0)
191    {
192       /* OPT: Happens to work without the OPUS_MOVE(), but only because the current encoder already copies x to y */
193       if (x!=y)
194          OPUS_MOVE(y, x, N);
195       return;
196    }
197    g00 = MULT16_16_P15(g0, gains[tapset0][0]);
198    g01 = MULT16_16_P15(g0, gains[tapset0][1]);
199    g02 = MULT16_16_P15(g0, gains[tapset0][2]);
200    g10 = MULT16_16_P15(g1, gains[tapset1][0]);
201    g11 = MULT16_16_P15(g1, gains[tapset1][1]);
202    g12 = MULT16_16_P15(g1, gains[tapset1][2]);
203    x1 = x[-T1+1];
204    x2 = x[-T1  ];
205    x3 = x[-T1-1];
206    x4 = x[-T1-2];
207    /* If the filter didn't change, we don't need the overlap */
208    if (g0==g1 && T0==T1 && tapset0==tapset1)
209       overlap=0;
210    for (i=0;i<overlap;i++)
211    {
212       opus_val16 f;
213       x0=x[i-T1+2];
214       f = MULT16_16_Q15(window[i],window[i]);
215       y[i] = x[i]
216                + MULT16_32_Q15(MULT16_16_Q15((Q15ONE-f),g00),x[i-T0])
217                + MULT16_32_Q15(MULT16_16_Q15((Q15ONE-f),g01),ADD32(x[i-T0+1],x[i-T0-1]))
218                + MULT16_32_Q15(MULT16_16_Q15((Q15ONE-f),g02),ADD32(x[i-T0+2],x[i-T0-2]))
219                + MULT16_32_Q15(MULT16_16_Q15(f,g10),x2)
220                + MULT16_32_Q15(MULT16_16_Q15(f,g11),ADD32(x1,x3))
221                + MULT16_32_Q15(MULT16_16_Q15(f,g12),ADD32(x0,x4));
222       x4=x3;
223       x3=x2;
224       x2=x1;
225       x1=x0;
226
227    }
228    if (g1==0)
229    {
230       /* OPT: Happens to work without the OPUS_MOVE(), but only because the current encoder already copies x to y */
231       if (x!=y)
232          OPUS_MOVE(y+overlap, x+overlap, N-overlap);
233       return;
234    }
235
236    /* Compute the part with the constant filter. */
237    comb_filter_const(y+i, x+i, T1, N-i, g10, g11, g12);
238 }
239 #endif /* OVERRIDE_comb_filter */
240
241 const signed char tf_select_table[4][8] = {
242       {0, -1, 0, -1,    0,-1, 0,-1},
243       {0, -1, 0, -2,    1, 0, 1,-1},
244       {0, -2, 0, -3,    2, 0, 1,-1},
245       {0, -2, 0, -3,    3, 0, 1,-1},
246 };
247
248
249 void init_caps(const CELTMode *m,int *cap,int LM,int C)
250 {
251    int i;
252    for (i=0;i<m->nbEBands;i++)
253    {
254       int N;
255       N=(m->eBands[i+1]-m->eBands[i])<<LM;
256       cap[i] = (m->cache.caps[m->nbEBands*(2*LM+C-1)+i]+64)*C*N>>2;
257    }
258 }
259
260
261
262 const char *opus_strerror(int error)
263 {
264    static const char * const error_strings[8] = {
265       "success",
266       "invalid argument",
267       "buffer too small",
268       "internal error",
269       "corrupted stream",
270       "request not implemented",
271       "invalid state",
272       "memory allocation failed"
273    };
274    if (error > 0 || error < -7)
275       return "unknown error";
276    else
277       return error_strings[-error];
278 }
279
280 const char *opus_get_version_string(void)
281 {
282     return "libopus " PACKAGE_VERSION
283     /* Applications may rely on the presence of this substring in the version
284        string to determine if they have a fixed-point or floating-point build
285        at runtime. */
286 #ifdef FIXED_POINT
287           "-fixed"
288 #endif
289 #ifdef FUZZING
290           "-fuzzing"
291 #endif
292           ;
293 }