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