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