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