Add missing include to the list
[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 #define LEAK_BANDS 19
54
55 typedef struct {
56    int valid;
57    float tonality;
58    float tonality_slope;
59    float noisiness;
60    float activity;
61    float music_prob;
62    float music_prob_min;
63    float music_prob_max;
64    int   bandwidth;
65    float activity_probability;
66    /* Store as Q6 char to save space. */
67    unsigned char leak_boost[LEAK_BANDS];
68 } AnalysisInfo;
69
70 typedef struct {
71    int signalType;
72    int offset;
73 } SILKInfo;
74
75 #define __celt_check_mode_ptr_ptr(ptr) ((ptr) + ((ptr) - (const CELTMode**)(ptr)))
76
77 #define __celt_check_analysis_ptr(ptr) ((ptr) + ((ptr) - (const AnalysisInfo*)(ptr)))
78
79 #define __celt_check_silkinfo_ptr(ptr) ((ptr) + ((ptr) - (const SILKInfo*)(ptr)))
80
81 /* Encoder/decoder Requests */
82
83
84 #define CELT_SET_PREDICTION_REQUEST    10002
85 /** Controls the use of interframe prediction.
86     0=Independent frames
87     1=Short term interframe prediction allowed
88     2=Long term prediction allowed
89  */
90 #define CELT_SET_PREDICTION(x) CELT_SET_PREDICTION_REQUEST, __opus_check_int(x)
91
92 #define CELT_SET_INPUT_CLIPPING_REQUEST    10004
93 #define CELT_SET_INPUT_CLIPPING(x) CELT_SET_INPUT_CLIPPING_REQUEST, __opus_check_int(x)
94
95 #define CELT_GET_AND_CLEAR_ERROR_REQUEST   10007
96 #define CELT_GET_AND_CLEAR_ERROR(x) CELT_GET_AND_CLEAR_ERROR_REQUEST, __opus_check_int_ptr(x)
97
98 #define CELT_SET_CHANNELS_REQUEST    10008
99 #define CELT_SET_CHANNELS(x) CELT_SET_CHANNELS_REQUEST, __opus_check_int(x)
100
101
102 /* Internal */
103 #define CELT_SET_START_BAND_REQUEST    10010
104 #define CELT_SET_START_BAND(x) CELT_SET_START_BAND_REQUEST, __opus_check_int(x)
105
106 #define CELT_SET_END_BAND_REQUEST    10012
107 #define CELT_SET_END_BAND(x) CELT_SET_END_BAND_REQUEST, __opus_check_int(x)
108
109 #define CELT_GET_MODE_REQUEST    10015
110 /** Get the CELTMode used by an encoder or decoder */
111 #define CELT_GET_MODE(x) CELT_GET_MODE_REQUEST, __celt_check_mode_ptr_ptr(x)
112
113 #define CELT_SET_SIGNALLING_REQUEST    10016
114 #define CELT_SET_SIGNALLING(x) CELT_SET_SIGNALLING_REQUEST, __opus_check_int(x)
115
116 #define CELT_SET_TONALITY_REQUEST    10018
117 #define CELT_SET_TONALITY(x) CELT_SET_TONALITY_REQUEST, __opus_check_int(x)
118 #define CELT_SET_TONALITY_SLOPE_REQUEST    10020
119 #define CELT_SET_TONALITY_SLOPE(x) CELT_SET_TONALITY_SLOPE_REQUEST, __opus_check_int(x)
120
121 #define CELT_SET_ANALYSIS_REQUEST    10022
122 #define CELT_SET_ANALYSIS(x) CELT_SET_ANALYSIS_REQUEST, __celt_check_analysis_ptr(x)
123
124 #define OPUS_SET_LFE_REQUEST    10024
125 #define OPUS_SET_LFE(x) OPUS_SET_LFE_REQUEST, __opus_check_int(x)
126
127 #define OPUS_SET_ENERGY_MASK_REQUEST    10026
128 #define OPUS_SET_ENERGY_MASK(x) OPUS_SET_ENERGY_MASK_REQUEST, __opus_check_val16_ptr(x)
129
130 #define CELT_SET_SILK_INFO_REQUEST    10028
131 #define CELT_SET_SILK_INFO(x) CELT_SET_SILK_INFO_REQUEST, __celt_check_silkinfo_ptr(x)
132
133 /* Encoder stuff */
134
135 int celt_encoder_get_size(int channels);
136
137 int celt_encode_with_ec(OpusCustomEncoder * OPUS_RESTRICT st, const opus_val16 * pcm, int frame_size, unsigned char *compressed, int nbCompressedBytes, ec_enc *enc);
138
139 int celt_encoder_init(CELTEncoder *st, opus_int32 sampling_rate, int channels,
140                       int arch);
141
142
143
144 /* Decoder stuff */
145
146 int celt_decoder_get_size(int channels);
147
148
149 int celt_decoder_init(CELTDecoder *st, opus_int32 sampling_rate, int channels);
150
151 int celt_decode_with_ec(OpusCustomDecoder * OPUS_RESTRICT st, const unsigned char *data,
152       int len, opus_val16 * OPUS_RESTRICT pcm, int frame_size, ec_dec *dec, int accum);
153
154 #define celt_encoder_ctl opus_custom_encoder_ctl
155 #define celt_decoder_ctl opus_custom_decoder_ctl
156
157
158 #ifdef CUSTOM_MODES
159 #define OPUS_CUSTOM_NOSTATIC
160 #else
161 #define OPUS_CUSTOM_NOSTATIC static OPUS_INLINE
162 #endif
163
164 static const unsigned char trim_icdf[11] = {126, 124, 119, 109, 87, 41, 19, 9, 4, 2, 0};
165 /* Probs: NONE: 21.875%, LIGHT: 6.25%, NORMAL: 65.625%, AGGRESSIVE: 6.25% */
166 static const unsigned char spread_icdf[4] = {25, 23, 2, 0};
167
168 static const unsigned char tapset_icdf[3]={2,1,0};
169
170 #ifdef CUSTOM_MODES
171 static const unsigned char toOpusTable[20] = {
172       0xE0, 0xE8, 0xF0, 0xF8,
173       0xC0, 0xC8, 0xD0, 0xD8,
174       0xA0, 0xA8, 0xB0, 0xB8,
175       0x00, 0x00, 0x00, 0x00,
176       0x80, 0x88, 0x90, 0x98,
177 };
178
179 static const unsigned char fromOpusTable[16] = {
180       0x80, 0x88, 0x90, 0x98,
181       0x40, 0x48, 0x50, 0x58,
182       0x20, 0x28, 0x30, 0x38,
183       0x00, 0x08, 0x10, 0x18
184 };
185
186 static OPUS_INLINE int toOpus(unsigned char c)
187 {
188    int ret=0;
189    if (c<0xA0)
190       ret = toOpusTable[c>>3];
191    if (ret == 0)
192       return -1;
193    else
194       return ret|(c&0x7);
195 }
196
197 static OPUS_INLINE int fromOpus(unsigned char c)
198 {
199    if (c<0x80)
200       return -1;
201    else
202       return fromOpusTable[(c>>3)-16] | (c&0x7);
203 }
204 #endif /* CUSTOM_MODES */
205
206 #define COMBFILTER_MAXPERIOD 1024
207 #define COMBFILTER_MINPERIOD 15
208
209 extern const signed char tf_select_table[4][8];
210
211 int resampling_factor(opus_int32 rate);
212
213 void celt_preemphasis(const opus_val16 * OPUS_RESTRICT pcmp, celt_sig * OPUS_RESTRICT inp,
214                         int N, int CC, int upsample, const opus_val16 *coef, celt_sig *mem, int clip);
215
216 void comb_filter(opus_val32 *y, opus_val32 *x, int T0, int T1, int N,
217       opus_val16 g0, opus_val16 g1, int tapset0, int tapset1,
218       const opus_val16 *window, int overlap, int arch);
219
220 #ifdef NON_STATIC_COMB_FILTER_CONST_C
221 void comb_filter_const_c(opus_val32 *y, opus_val32 *x, int T, int N,
222                          opus_val16 g10, opus_val16 g11, opus_val16 g12);
223 #endif
224
225 #ifndef OVERRIDE_COMB_FILTER_CONST
226 # define comb_filter_const(y, x, T, N, g10, g11, g12, arch) \
227     ((void)(arch),comb_filter_const_c(y, x, T, N, g10, g11, g12))
228 #endif
229
230 void init_caps(const CELTMode *m,int *cap,int LM,int C);
231
232 #ifdef RESYNTH
233 void deemphasis(celt_sig *in[], opus_val16 *pcm, int N, int C, int downsample, const opus_val16 *coef, celt_sig *mem);
234 void celt_synthesis(const CELTMode *mode, celt_norm *X, celt_sig * out_syn[],
235       opus_val16 *oldBandE, int start, int effEnd, int C, int CC, int isTransient,
236       int LM, int downsample, int silence);
237 #endif
238
239 #ifdef __cplusplus
240 }
241 #endif
242
243 #endif /* CELT_H */