Initial surround code with new API
[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    10022
111 #define OPUS_SET_LFE(x) OPUS_SET_LFE_REQUEST, __opus_check_int(x)
112
113 /* Encoder stuff */
114
115 int celt_encoder_get_size(int channels);
116
117 int celt_encode_with_ec(OpusCustomEncoder * OPUS_RESTRICT st, const opus_val16 * pcm, int frame_size, unsigned char *compressed, int nbCompressedBytes, ec_enc *enc);
118
119 int celt_encoder_init(CELTEncoder *st, opus_int32 sampling_rate, int channels);
120
121
122
123 /* Decoder stuff */
124
125 int celt_decoder_get_size(int channels);
126
127
128 int celt_decoder_init(CELTDecoder *st, opus_int32 sampling_rate, int channels);
129
130 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);
131
132 #define celt_encoder_ctl opus_custom_encoder_ctl
133 #define celt_decoder_ctl opus_custom_decoder_ctl
134
135
136 #ifndef OPUS_VERSION
137 #define OPUS_VERSION "unknown"
138 #endif
139
140 #ifdef CUSTOM_MODES
141 #define OPUS_CUSTOM_NOSTATIC
142 #else
143 #define OPUS_CUSTOM_NOSTATIC static inline
144 #endif
145
146 static const unsigned char trim_icdf[11] = {126, 124, 119, 109, 87, 41, 19, 9, 4, 2, 0};
147 /* Probs: NONE: 21.875%, LIGHT: 6.25%, NORMAL: 65.625%, AGGRESSIVE: 6.25% */
148 static const unsigned char spread_icdf[4] = {25, 23, 2, 0};
149
150 static const unsigned char tapset_icdf[3]={2,1,0};
151
152 #ifdef CUSTOM_MODES
153 static const unsigned char toOpusTable[20] = {
154       0xE0, 0xE8, 0xF0, 0xF8,
155       0xC0, 0xC8, 0xD0, 0xD8,
156       0xA0, 0xA8, 0xB0, 0xB8,
157       0x00, 0x00, 0x00, 0x00,
158       0x80, 0x88, 0x90, 0x98,
159 };
160
161 static const unsigned char fromOpusTable[16] = {
162       0x80, 0x88, 0x90, 0x98,
163       0x40, 0x48, 0x50, 0x58,
164       0x20, 0x28, 0x30, 0x38,
165       0x00, 0x08, 0x10, 0x18
166 };
167
168 static inline int toOpus(unsigned char c)
169 {
170    int ret=0;
171    if (c<0xA0)
172       ret = toOpusTable[c>>3];
173    if (ret == 0)
174       return -1;
175    else
176       return ret|(c&0x7);
177 }
178
179 static inline int fromOpus(unsigned char c)
180 {
181    if (c<0x80)
182       return -1;
183    else
184       return fromOpusTable[(c>>3)-16] | (c&0x7);
185 }
186 #endif /* CUSTOM_MODES */
187
188 #define COMBFILTER_MAXPERIOD 1024
189 #define COMBFILTER_MINPERIOD 15
190
191 extern const signed char tf_select_table[4][8];
192
193 int resampling_factor(opus_int32 rate);
194
195 void comb_filter(opus_val32 *y, opus_val32 *x, int T0, int T1, int N,
196       opus_val16 g0, opus_val16 g1, int tapset0, int tapset1,
197       const opus_val16 *window, int overlap);
198
199 void init_caps(const CELTMode *m,int *cap,int LM,int C);
200
201 #ifdef RESYNTH
202 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);
203
204 void compute_inv_mdcts(const CELTMode *mode, int shortBlocks, celt_sig *X,
205       celt_sig * OPUS_RESTRICT out_mem[], int C, int LM);
206 #endif
207
208 #ifdef __cplusplus
209 }
210 #endif
211
212 #endif /* CELT_H */