Jean-Marc Valin | 8b2ff0d | 2009-10-17 21:40:10 -0400 | [diff] [blame] | 1 | /* Copyright (c) 2007-2008 CSIRO |
| 2 | Copyright (c) 2007-2009 Xiph.Org Foundation |
Gregory Maxwell | 71d39ad | 2011-07-30 00:00:29 -0400 | [diff] [blame] | 3 | Copyright (c) 2008 Gregory Maxwell |
Jean-Marc Valin | 8b2ff0d | 2009-10-17 21:40:10 -0400 | [diff] [blame] | 4 | Written by Jean-Marc Valin and Gregory Maxwell */ |
Jean-Marc Valin | 879fbfd | 2008-02-20 17:17:13 +1100 | [diff] [blame] | 5 | /** |
| 6 | @file celt.h |
Jean-Marc Valin | 56522ad | 2009-06-05 17:17:25 -0400 | [diff] [blame] | 7 | @brief Contains all the functions for encoding and decoding audio |
Jean-Marc Valin | 879fbfd | 2008-02-20 17:17:13 +1100 | [diff] [blame] | 8 | */ |
| 9 | |
Jean-Marc Valin | 013c31d | 2007-11-30 11:36:46 +1100 | [diff] [blame] | 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: |
Gregory Maxwell | 71d39ad | 2011-07-30 00:00:29 -0400 | [diff] [blame] | 14 | |
Jean-Marc Valin | 013c31d | 2007-11-30 11:36:46 +1100 | [diff] [blame] | 15 | - Redistributions of source code must retain the above copyright |
| 16 | notice, this list of conditions and the following disclaimer. |
Gregory Maxwell | 71d39ad | 2011-07-30 00:00:29 -0400 | [diff] [blame] | 17 | |
Jean-Marc Valin | 013c31d | 2007-11-30 11:36:46 +1100 | [diff] [blame] | 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. |
Gregory Maxwell | 71d39ad | 2011-07-30 00:00:29 -0400 | [diff] [blame] | 21 | |
Jean-Marc Valin | 013c31d | 2007-11-30 11:36:46 +1100 | [diff] [blame] | 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 |
Jean-Marc Valin | cb05e7c | 2012-04-20 16:40:24 -0400 | [diff] [blame] | 25 | A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER |
| 26 | OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, |
Jean-Marc Valin | 013c31d | 2007-11-30 11:36:46 +1100 | [diff] [blame] | 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 | |
Jean-Marc Valin | d77d6a5 | 2011-07-29 17:33:06 -0400 | [diff] [blame] | 38 | #include "opus_types.h" |
Jean-Marc Valin | f9e701a | 2011-08-31 17:47:48 -0400 | [diff] [blame] | 39 | #include "opus_defines.h" |
Jean-Marc Valin | 06237d7 | 2011-09-01 13:20:40 -0400 | [diff] [blame] | 40 | #include "opus_custom.h" |
Jean-Marc Valin | fbbd9bf | 2011-09-05 21:13:53 -0400 | [diff] [blame] | 41 | #include "entenc.h" |
| 42 | #include "entdec.h" |
| 43 | #include "arch.h" |
Jean-Marc Valin | 3d3bb68 | 2008-01-31 10:05:39 +1100 | [diff] [blame] | 44 | |
Jean-Marc Valin | 77ff83a | 2008-01-22 13:16:36 +1100 | [diff] [blame] | 45 | #ifdef __cplusplus |
| 46 | extern "C" { |
| 47 | #endif |
| 48 | |
Jean-Marc Valin | 242da53 | 2011-09-05 20:53:33 -0400 | [diff] [blame] | 49 | #define CELTEncoder OpusCustomEncoder |
| 50 | #define CELTDecoder OpusCustomDecoder |
| 51 | #define CELTMode OpusCustomMode |
| 52 | |
Jean-Marc Valin | e9c353a | 2011-11-14 17:58:29 +0800 | [diff] [blame] | 53 | typedef struct { |
| 54 | int valid; |
Jean-Marc Valin | 3ab03e0 | 2013-09-06 16:00:39 -0400 | [diff] [blame] | 55 | float tonality; |
| 56 | float tonality_slope; |
| 57 | float noisiness; |
| 58 | float activity; |
| 59 | float music_prob; |
Jean-Marc Valin | 7509fdb | 2012-12-20 22:48:35 -0500 | [diff] [blame] | 60 | int bandwidth; |
Jean-Marc Valin | e9c353a | 2011-11-14 17:58:29 +0800 | [diff] [blame] | 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))) |
Jean-Marc Valin | a76a0b2 | 2008-01-17 22:43:05 +1100 | [diff] [blame] | 66 | |
Jean-Marc Valin | c3086a9 | 2011-03-21 13:26:03 -0400 | [diff] [blame] | 67 | /* Encoder/decoder Requests */ |
Jean-Marc Valin | 7bb26e1 | 2011-02-01 17:04:27 -0500 | [diff] [blame] | 68 | |
Jean-Marc Valin | 5174817 | 2013-11-08 19:54:03 -0500 | [diff] [blame] | 69 | /* Expose this option again when variable framesize actually works */ |
| 70 | #define OPUS_FRAMESIZE_VARIABLE 5010 /**< Optimize the frame size dynamically */ |
| 71 | |
| 72 | |
Jean-Marc Valin | fbbd9bf | 2011-09-05 21:13:53 -0400 | [diff] [blame] | 73 | #define CELT_SET_PREDICTION_REQUEST 10002 |
Gregory Maxwell | 2dd3d32 | 2009-06-05 14:05:51 -0400 | [diff] [blame] | 74 | /** Controls the use of interframe prediction. |
| 75 | 0=Independent frames |
| 76 | 1=Short term interframe prediction allowed |
| 77 | 2=Long term prediction allowed |
| 78 | */ |
Jean-Marc Valin | f9e701a | 2011-08-31 17:47:48 -0400 | [diff] [blame] | 79 | #define CELT_SET_PREDICTION(x) CELT_SET_PREDICTION_REQUEST, __opus_check_int(x) |
Jean-Marc Valin | 7bb26e1 | 2011-02-01 17:04:27 -0500 | [diff] [blame] | 80 | |
Jean-Marc Valin | fbbd9bf | 2011-09-05 21:13:53 -0400 | [diff] [blame] | 81 | #define CELT_SET_INPUT_CLIPPING_REQUEST 10004 |
Jean-Marc Valin | f9e701a | 2011-08-31 17:47:48 -0400 | [diff] [blame] | 82 | #define CELT_SET_INPUT_CLIPPING(x) CELT_SET_INPUT_CLIPPING_REQUEST, __opus_check_int(x) |
Jean-Marc Valin | 7bb26e1 | 2011-02-01 17:04:27 -0500 | [diff] [blame] | 83 | |
Jean-Marc Valin | fbbd9bf | 2011-09-05 21:13:53 -0400 | [diff] [blame] | 84 | #define CELT_GET_AND_CLEAR_ERROR_REQUEST 10007 |
Jean-Marc Valin | f9e701a | 2011-08-31 17:47:48 -0400 | [diff] [blame] | 85 | #define CELT_GET_AND_CLEAR_ERROR(x) CELT_GET_AND_CLEAR_ERROR_REQUEST, __opus_check_int_ptr(x) |
Jean-Marc Valin | c18fb1d | 2008-09-30 07:36:54 -0400 | [diff] [blame] | 86 | |
Jean-Marc Valin | fbbd9bf | 2011-09-05 21:13:53 -0400 | [diff] [blame] | 87 | #define CELT_SET_CHANNELS_REQUEST 10008 |
Jean-Marc Valin | f9e701a | 2011-08-31 17:47:48 -0400 | [diff] [blame] | 88 | #define CELT_SET_CHANNELS(x) CELT_SET_CHANNELS_REQUEST, __opus_check_int(x) |
Jean-Marc Valin | 79b34eb | 2010-12-05 17:22:06 -0500 | [diff] [blame] | 89 | |
Jean-Marc Valin | 6965388 | 2011-04-21 10:41:13 -0400 | [diff] [blame] | 90 | |
Jean-Marc Valin | ef20e39 | 2011-03-18 15:34:11 -0400 | [diff] [blame] | 91 | /* Internal */ |
Jean-Marc Valin | fbbd9bf | 2011-09-05 21:13:53 -0400 | [diff] [blame] | 92 | #define CELT_SET_START_BAND_REQUEST 10010 |
Jean-Marc Valin | f9e701a | 2011-08-31 17:47:48 -0400 | [diff] [blame] | 93 | #define CELT_SET_START_BAND(x) CELT_SET_START_BAND_REQUEST, __opus_check_int(x) |
Jean-Marc Valin | 5f96146 | 2010-05-19 13:38:10 -0400 | [diff] [blame] | 94 | |
Jean-Marc Valin | fbbd9bf | 2011-09-05 21:13:53 -0400 | [diff] [blame] | 95 | #define CELT_SET_END_BAND_REQUEST 10012 |
Jean-Marc Valin | f9e701a | 2011-08-31 17:47:48 -0400 | [diff] [blame] | 96 | #define CELT_SET_END_BAND(x) CELT_SET_END_BAND_REQUEST, __opus_check_int(x) |
Jean-Marc Valin | 525d7cf | 2010-07-13 14:14:16 -0400 | [diff] [blame] | 97 | |
Jean-Marc Valin | fbbd9bf | 2011-09-05 21:13:53 -0400 | [diff] [blame] | 98 | #define CELT_GET_MODE_REQUEST 10015 |
| 99 | /** Get the CELTMode used by an encoder or decoder */ |
Jean-Marc Valin | e9c353a | 2011-11-14 17:58:29 +0800 | [diff] [blame] | 100 | #define CELT_GET_MODE(x) CELT_GET_MODE_REQUEST, __celt_check_mode_ptr_ptr(x) |
Jean-Marc Valin | 06cee2b | 2011-08-19 16:11:41 -0400 | [diff] [blame] | 101 | |
Jean-Marc Valin | fbbd9bf | 2011-09-05 21:13:53 -0400 | [diff] [blame] | 102 | #define CELT_SET_SIGNALLING_REQUEST 10016 |
| 103 | #define CELT_SET_SIGNALLING(x) CELT_SET_SIGNALLING_REQUEST, __opus_check_int(x) |
Jean-Marc Valin | 013c31d | 2007-11-30 11:36:46 +1100 | [diff] [blame] | 104 | |
Jean-Marc Valin | 1a2e765 | 2011-11-06 23:27:16 -0500 | [diff] [blame] | 105 | #define CELT_SET_TONALITY_REQUEST 10018 |
| 106 | #define CELT_SET_TONALITY(x) CELT_SET_TONALITY_REQUEST, __opus_check_int(x) |
| 107 | #define CELT_SET_TONALITY_SLOPE_REQUEST 10020 |
| 108 | #define CELT_SET_TONALITY_SLOPE(x) CELT_SET_TONALITY_SLOPE_REQUEST, __opus_check_int(x) |
Jean-Marc Valin | 8c19b03 | 2008-02-20 15:53:15 +1100 | [diff] [blame] | 109 | |
Jean-Marc Valin | e9c353a | 2011-11-14 17:58:29 +0800 | [diff] [blame] | 110 | #define CELT_SET_ANALYSIS_REQUEST 10022 |
| 111 | #define CELT_SET_ANALYSIS(x) CELT_SET_ANALYSIS_REQUEST, __celt_check_analysis_ptr(x) |
Jean-Marc Valin | 8c19b03 | 2008-02-20 15:53:15 +1100 | [diff] [blame] | 112 | |
Jean-Marc Valin | b08c4ca | 2013-04-26 16:32:10 -0400 | [diff] [blame] | 113 | #define OPUS_SET_LFE_REQUEST 10024 |
Jean-Marc Valin | 1b72386 | 2013-04-25 21:34:04 -0400 | [diff] [blame] | 114 | #define OPUS_SET_LFE(x) OPUS_SET_LFE_REQUEST, __opus_check_int(x) |
Jean-Marc Valin | 8c19b03 | 2008-02-20 15:53:15 +1100 | [diff] [blame] | 115 | |
Jean-Marc Valin | fdceae8 | 2013-08-30 21:58:02 -0400 | [diff] [blame] | 116 | #define OPUS_SET_ENERGY_MASK_REQUEST 10026 |
Jean-Marc Valin | a4dccd3 | 2013-05-04 23:54:20 -0400 | [diff] [blame] | 117 | #define OPUS_SET_ENERGY_MASK(x) OPUS_SET_ENERGY_MASK_REQUEST, __opus_check_val16_ptr(x) |
Jean-Marc Valin | 8c19b03 | 2008-02-20 15:53:15 +1100 | [diff] [blame] | 118 | |
Jean-Marc Valin | 8c19b03 | 2008-02-20 15:53:15 +1100 | [diff] [blame] | 119 | /* Encoder stuff */ |
| 120 | |
Jean-Marc Valin | 06237d7 | 2011-09-01 13:20:40 -0400 | [diff] [blame] | 121 | int celt_encoder_get_size(int channels); |
Jean-Marc Valin | 8cf29f0 | 2011-01-30 23:38:28 -0500 | [diff] [blame] | 122 | |
Gregory Maxwell | de0b532 | 2012-07-18 12:12:35 -0400 | [diff] [blame] | 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); |
Jean-Marc Valin | 879fbfd | 2008-02-20 17:17:13 +1100 | [diff] [blame] | 124 | |
Timothy B. Terriberry | 39386e0 | 2013-11-18 13:30:13 -0500 | [diff] [blame] | 125 | int celt_encoder_init(CELTEncoder *st, opus_int32 sampling_rate, int channels, |
| 126 | int arch); |
Jean-Marc Valin | 8c19b03 | 2008-02-20 15:53:15 +1100 | [diff] [blame] | 127 | |
Jean-Marc Valin | c97b258 | 2011-01-28 23:07:32 -0500 | [diff] [blame] | 128 | |
Jean-Marc Valin | c18fb1d | 2008-09-30 07:36:54 -0400 | [diff] [blame] | 129 | |
Jean-Marc Valin | 8c19b03 | 2008-02-20 15:53:15 +1100 | [diff] [blame] | 130 | /* Decoder stuff */ |
| 131 | |
Jean-Marc Valin | 06237d7 | 2011-09-01 13:20:40 -0400 | [diff] [blame] | 132 | int celt_decoder_get_size(int channels); |
Jean-Marc Valin | 8cf29f0 | 2011-01-30 23:38:28 -0500 | [diff] [blame] | 133 | |
Jean-Marc Valin | 879fbfd | 2008-02-20 17:17:13 +1100 | [diff] [blame] | 134 | |
Gregory Maxwell | 64a3541 | 2011-09-02 10:31:17 -0400 | [diff] [blame] | 135 | int celt_decoder_init(CELTDecoder *st, opus_int32 sampling_rate, int channels); |
Jean-Marc Valin | 8c19b03 | 2008-02-20 15:53:15 +1100 | [diff] [blame] | 136 | |
Jean-Marc Valin | 4d07b13 | 2014-01-06 17:43:20 -0500 | [diff] [blame] | 137 | int celt_decode_with_ec(OpusCustomDecoder * OPUS_RESTRICT st, const unsigned char *data, |
| 138 | int len, opus_val16 * OPUS_RESTRICT pcm, int frame_size, ec_dec *dec, int accum); |
Jean-Marc Valin | a3803a9 | 2009-10-24 11:24:34 -0400 | [diff] [blame] | 139 | |
Jean-Marc Valin | 06237d7 | 2011-09-01 13:20:40 -0400 | [diff] [blame] | 140 | #define celt_encoder_ctl opus_custom_encoder_ctl |
| 141 | #define celt_decoder_ctl opus_custom_decoder_ctl |
| 142 | |
Jean-Marc Valin | 6906210 | 2012-11-08 09:42:27 -0500 | [diff] [blame] | 143 | |
Jean-Marc Valin | 6906210 | 2012-11-08 09:42:27 -0500 | [diff] [blame] | 144 | #ifdef CUSTOM_MODES |
| 145 | #define OPUS_CUSTOM_NOSTATIC |
| 146 | #else |
Gregory Maxwell | 7830cf1 | 2013-10-17 15:56:52 -0700 | [diff] [blame] | 147 | #define OPUS_CUSTOM_NOSTATIC static OPUS_INLINE |
Jean-Marc Valin | 6906210 | 2012-11-08 09:42:27 -0500 | [diff] [blame] | 148 | #endif |
| 149 | |
| 150 | static const unsigned char trim_icdf[11] = {126, 124, 119, 109, 87, 41, 19, 9, 4, 2, 0}; |
| 151 | /* Probs: NONE: 21.875%, LIGHT: 6.25%, NORMAL: 65.625%, AGGRESSIVE: 6.25% */ |
| 152 | static const unsigned char spread_icdf[4] = {25, 23, 2, 0}; |
| 153 | |
| 154 | static const unsigned char tapset_icdf[3]={2,1,0}; |
| 155 | |
| 156 | #ifdef CUSTOM_MODES |
| 157 | static const unsigned char toOpusTable[20] = { |
| 158 | 0xE0, 0xE8, 0xF0, 0xF8, |
| 159 | 0xC0, 0xC8, 0xD0, 0xD8, |
| 160 | 0xA0, 0xA8, 0xB0, 0xB8, |
| 161 | 0x00, 0x00, 0x00, 0x00, |
| 162 | 0x80, 0x88, 0x90, 0x98, |
| 163 | }; |
| 164 | |
| 165 | static const unsigned char fromOpusTable[16] = { |
| 166 | 0x80, 0x88, 0x90, 0x98, |
| 167 | 0x40, 0x48, 0x50, 0x58, |
| 168 | 0x20, 0x28, 0x30, 0x38, |
| 169 | 0x00, 0x08, 0x10, 0x18 |
| 170 | }; |
| 171 | |
Gregory Maxwell | 7830cf1 | 2013-10-17 15:56:52 -0700 | [diff] [blame] | 172 | static OPUS_INLINE int toOpus(unsigned char c) |
Jean-Marc Valin | 6906210 | 2012-11-08 09:42:27 -0500 | [diff] [blame] | 173 | { |
| 174 | int ret=0; |
| 175 | if (c<0xA0) |
| 176 | ret = toOpusTable[c>>3]; |
| 177 | if (ret == 0) |
| 178 | return -1; |
| 179 | else |
| 180 | return ret|(c&0x7); |
| 181 | } |
| 182 | |
Gregory Maxwell | 7830cf1 | 2013-10-17 15:56:52 -0700 | [diff] [blame] | 183 | static OPUS_INLINE int fromOpus(unsigned char c) |
Jean-Marc Valin | 6906210 | 2012-11-08 09:42:27 -0500 | [diff] [blame] | 184 | { |
| 185 | if (c<0x80) |
| 186 | return -1; |
| 187 | else |
| 188 | return fromOpusTable[(c>>3)-16] | (c&0x7); |
| 189 | } |
| 190 | #endif /* CUSTOM_MODES */ |
| 191 | |
| 192 | #define COMBFILTER_MAXPERIOD 1024 |
| 193 | #define COMBFILTER_MINPERIOD 15 |
| 194 | |
| 195 | extern const signed char tf_select_table[4][8]; |
| 196 | |
| 197 | int resampling_factor(opus_int32 rate); |
| 198 | |
Jean-Marc Valin | 2dc27df | 2013-11-13 19:35:43 -0500 | [diff] [blame] | 199 | void celt_preemphasis(const opus_val16 * OPUS_RESTRICT pcmp, celt_sig * OPUS_RESTRICT inp, |
Jean-Marc Valin | fdceae8 | 2013-08-30 21:58:02 -0400 | [diff] [blame] | 200 | int N, int CC, int upsample, const opus_val16 *coef, celt_sig *mem, int clip); |
| 201 | |
Jean-Marc Valin | 6906210 | 2012-11-08 09:42:27 -0500 | [diff] [blame] | 202 | void comb_filter(opus_val32 *y, opus_val32 *x, int T0, int T1, int N, |
| 203 | opus_val16 g0, opus_val16 g1, int tapset0, int tapset1, |
Jonathan Lennox | 43120f0 | 2015-08-03 17:04:27 -0400 | [diff] [blame] | 204 | const opus_val16 *window, int overlap, int arch); |
| 205 | |
| 206 | #ifdef NON_STATIC_COMB_FILTER_CONST_C |
| 207 | void comb_filter_const_c(opus_val32 *y, opus_val32 *x, int T, int N, |
| 208 | opus_val16 g10, opus_val16 g11, opus_val16 g12); |
| 209 | #endif |
| 210 | |
| 211 | #ifndef OVERRIDE_COMB_FILTER_CONST |
| 212 | # define comb_filter_const(y, x, T, N, g10, g11, g12, arch) \ |
| 213 | ((void)(arch),comb_filter_const_c(y, x, T, N, g10, g11, g12)) |
| 214 | #endif |
Jean-Marc Valin | 6906210 | 2012-11-08 09:42:27 -0500 | [diff] [blame] | 215 | |
| 216 | void init_caps(const CELTMode *m,int *cap,int LM,int C); |
| 217 | |
| 218 | #ifdef RESYNTH |
Jean-Marc Valin | bdc7b93 | 2014-01-06 08:58:38 -0500 | [diff] [blame] | 219 | void deemphasis(celt_sig *in[], opus_val16 *pcm, int N, int C, int downsample, const opus_val16 *coef, celt_sig *mem); |
| 220 | void celt_synthesis(const CELTMode *mode, celt_norm *X, celt_sig * out_syn[], |
| 221 | opus_val16 *oldBandE, int start, int effEnd, int C, int CC, int isTransient, |
| 222 | int LM, int downsample, int silence); |
Jean-Marc Valin | 6906210 | 2012-11-08 09:42:27 -0500 | [diff] [blame] | 223 | #endif |
| 224 | |
Jean-Marc Valin | 77ff83a | 2008-01-22 13:16:36 +1100 | [diff] [blame] | 225 | #ifdef __cplusplus |
| 226 | } |
| 227 | #endif |
| 228 | |
Ralph Giles | 120800f | 2011-11-25 13:02:00 -0800 | [diff] [blame] | 229 | #endif /* CELT_H */ |