Reduce the scope of Ne10 includes
[opus.git] / celt / celt.h
1 /* Copyright (c) 2007-2008 CSIRO
2    Copyright (c) 2007-2009 Xiph.Org Foundation
3    Copyright (c) 2008 Gregory Maxwell
4    Written by Jean-Marc Valin and Gregory Maxwell */
5 /**
6   @file celt.h
7   @brief Contains all the functions for encoding and decoding audio
8  */
9
10 /*
11    Redistribution and use in source and binary forms, with or without
12    modification, are permitted provided that the following conditions
13    are met:
14
15    - Redistributions of source code must retain the above copyright
16    notice, this list of conditions and the following disclaimer.
17
18    - Redistributions in binary form must reproduce the above copyright
19    notice, this list of conditions and the following disclaimer in the
20    documentation and/or other materials provided with the distribution.
21
22    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
26    OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
27    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
28    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
29    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
30    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
31    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 */
34
35 #ifndef CELT_H
36 #define CELT_H
37
38 #include "opus_types.h"
39 #include "opus_defines.h"
40 #include "opus_custom.h"
41 #include "entenc.h"
42 #include "entdec.h"
43 #include "arch.h"
44
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48
49 #define CELTEncoder OpusCustomEncoder
50 #define CELTDecoder OpusCustomDecoder
51 #define CELTMode OpusCustomMode
52
53 typedef struct {
54    int valid;
55    float tonality;
56    float tonality_slope;
57    float noisiness;
58    float activity;
59    float music_prob;
60    float vad_prob;
61    int   bandwidth;
62    float activity_probability;
63 } AnalysisInfo;
64
65 typedef struct {
66    int signalType;
67    int offset;
68 } SILKInfo;
69
70 #define __celt_check_mode_ptr_ptr(ptr) ((ptr) + ((ptr) - (const CELTMode**)(ptr)))
71
72 #define __celt_check_analysis_ptr(ptr) ((ptr) + ((ptr) - (const AnalysisInfo*)(ptr)))
73
74 #define __celt_check_silkinfo_ptr(ptr) ((ptr) + ((ptr) - (const SILKInfo*)(ptr)))
75
76 /* Encoder/decoder Requests */
77
78
79 #define CELT_SET_PREDICTION_REQUEST    10002
80 /** Controls the use of interframe prediction.
81     0=Independent frames
82     1=Short term interframe prediction allowed
83     2=Long term prediction allowed
84  */
85 #define CELT_SET_PREDICTION(x) CELT_SET_PREDICTION_REQUEST, __opus_check_int(x)
86
87 #define CELT_SET_INPUT_CLIPPING_REQUEST    10004
88 #define CELT_SET_INPUT_CLIPPING(x) CELT_SET_INPUT_CLIPPING_REQUEST, __opus_check_int(x)
89
90 #define CELT_GET_AND_CLEAR_ERROR_REQUEST   10007
91 #define CELT_GET_AND_CLEAR_ERROR(x) CELT_GET_AND_CLEAR_ERROR_REQUEST, __opus_check_int_ptr(x)
92
93 #define CELT_SET_CHANNELS_REQUEST    10008
94 #define CELT_SET_CHANNELS(x) CELT_SET_CHANNELS_REQUEST, __opus_check_int(x)
95
96
97 /* Internal */
98 #define CELT_SET_START_BAND_REQUEST    10010
99 #define CELT_SET_START_BAND(x) CELT_SET_START_BAND_REQUEST, __opus_check_int(x)
100
101 #define CELT_SET_END_BAND_REQUEST    10012
102 #define CELT_SET_END_BAND(x) CELT_SET_END_BAND_REQUEST, __opus_check_int(x)
103
104 #define CELT_GET_MODE_REQUEST    10015
105 /** Get the CELTMode used by an encoder or decoder */
106 #define CELT_GET_MODE(x) CELT_GET_MODE_REQUEST, __celt_check_mode_ptr_ptr(x)
107
108 #define CELT_SET_SIGNALLING_REQUEST    10016
109 #define CELT_SET_SIGNALLING(x) CELT_SET_SIGNALLING_REQUEST, __opus_check_int(x)
110
111 #define CELT_SET_TONALITY_REQUEST    10018
112 #define CELT_SET_TONALITY(x) CELT_SET_TONALITY_REQUEST, __opus_check_int(x)
113 #define CELT_SET_TONALITY_SLOPE_REQUEST    10020
114 #define CELT_SET_TONALITY_SLOPE(x) CELT_SET_TONALITY_SLOPE_REQUEST, __opus_check_int(x)
115
116 #define CELT_SET_ANALYSIS_REQUEST    10022
117 #define CELT_SET_ANALYSIS(x) CELT_SET_ANALYSIS_REQUEST, __celt_check_analysis_ptr(x)
118
119 #define OPUS_SET_LFE_REQUEST    10024
120 #define OPUS_SET_LFE(x) OPUS_SET_LFE_REQUEST, __opus_check_int(x)
121
122 #define OPUS_SET_ENERGY_MASK_REQUEST    10026
123 #define OPUS_SET_ENERGY_MASK(x) OPUS_SET_ENERGY_MASK_REQUEST, __opus_check_val16_ptr(x)
124
125 #define CELT_SET_SILK_INFO_REQUEST    10028
126 #define CELT_SET_SILK_INFO(x) CELT_SET_SILK_INFO_REQUEST, __celt_check_silkinfo_ptr(x)
127
128 /* Encoder stuff */
129
130 int celt_encoder_get_size(int channels);
131
132 int celt_encode_with_ec(OpusCustomEncoder * OPUS_RESTRICT st, const opus_val16 * pcm, int frame_size, unsigned char *compressed, int nbCompressedBytes, ec_enc *enc);
133
134 int celt_encoder_init(CELTEncoder *st, opus_int32 sampling_rate, int channels,
135                       int arch);
136
137
138
139 /* Decoder stuff */
140
141 int celt_decoder_get_size(int channels);
142
143
144 int celt_decoder_init(CELTDecoder *st, opus_int32 sampling_rate, int channels);
145
146 int celt_decode_with_ec(OpusCustomDecoder * OPUS_RESTRICT st, const unsigned char *data,
147       int len, opus_val16 * OPUS_RESTRICT pcm, int frame_size, ec_dec *dec, int accum);
148
149 #define celt_encoder_ctl opus_custom_encoder_ctl
150 #define celt_decoder_ctl opus_custom_decoder_ctl
151
152
153 #ifdef CUSTOM_MODES
154 #define OPUS_CUSTOM_NOSTATIC
155 #else
156 #define OPUS_CUSTOM_NOSTATIC static OPUS_INLINE
157 #endif
158
159 static const unsigned char trim_icdf[11] = {126, 124, 119, 109, 87, 41, 19, 9, 4, 2, 0};
160 /* Probs: NONE: 21.875%, LIGHT: 6.25%, NORMAL: 65.625%, AGGRESSIVE: 6.25% */
161 static const unsigned char spread_icdf[4] = {25, 23, 2, 0};
162
163 static const unsigned char tapset_icdf[3]={2,1,0};
164
165 #ifdef CUSTOM_MODES
166 static const unsigned char toOpusTable[20] = {
167       0xE0, 0xE8, 0xF0, 0xF8,
168       0xC0, 0xC8, 0xD0, 0xD8,
169       0xA0, 0xA8, 0xB0, 0xB8,
170       0x00, 0x00, 0x00, 0x00,
171       0x80, 0x88, 0x90, 0x98,
172 };
173
174 static const unsigned char fromOpusTable[16] = {
175       0x80, 0x88, 0x90, 0x98,
176       0x40, 0x48, 0x50, 0x58,
177       0x20, 0x28, 0x30, 0x38,
178       0x00, 0x08, 0x10, 0x18
179 };
180
181 static OPUS_INLINE int toOpus(unsigned char c)
182 {
183    int ret=0;
184    if (c<0xA0)
185       ret = toOpusTable[c>>3];
186    if (ret == 0)
187       return -1;
188    else
189       return ret|(c&0x7);
190 }
191
192 static OPUS_INLINE int fromOpus(unsigned char c)
193 {
194    if (c<0x80)
195       return -1;
196    else
197       return fromOpusTable[(c>>3)-16] | (c&0x7);
198 }
199 #endif /* CUSTOM_MODES */
200
201 #define COMBFILTER_MAXPERIOD 1024
202 #define COMBFILTER_MINPERIOD 15
203
204 extern const signed char tf_select_table[4][8];
205
206 int resampling_factor(opus_int32 rate);
207
208 void celt_preemphasis(const opus_val16 * OPUS_RESTRICT pcmp, celt_sig * OPUS_RESTRICT inp,
209                         int N, int CC, int upsample, const opus_val16 *coef, celt_sig *mem, int clip);
210
211 void comb_filter(opus_val32 *y, opus_val32 *x, int T0, int T1, int N,
212       opus_val16 g0, opus_val16 g1, int tapset0, int tapset1,
213       const opus_val16 *window, int overlap, int arch);
214
215 #ifdef NON_STATIC_COMB_FILTER_CONST_C
216 void comb_filter_const_c(opus_val32 *y, opus_val32 *x, int T, int N,
217                          opus_val16 g10, opus_val16 g11, opus_val16 g12);
218 #endif
219
220 #ifndef OVERRIDE_COMB_FILTER_CONST
221 # define comb_filter_const(y, x, T, N, g10, g11, g12, arch) \
222     ((void)(arch),comb_filter_const_c(y, x, T, N, g10, g11, g12))
223 #endif
224
225 void init_caps(const CELTMode *m,int *cap,int LM,int C);
226
227 #ifdef RESYNTH
228 void deemphasis(celt_sig *in[], opus_val16 *pcm, int N, int C, int downsample, const opus_val16 *coef, celt_sig *mem);
229 void celt_synthesis(const CELTMode *mode, celt_norm *X, celt_sig * out_syn[],
230       opus_val16 *oldBandE, int start, int effEnd, int C, int CC, int isTransient,
231       int LM, int downsample, int silence);
232 #endif
233
234 #ifdef __cplusplus
235 }
236 #endif
237
238 #endif /* CELT_H */