cannam@154: /* Copyright (c) 2007-2008 CSIRO
cannam@154:    Copyright (c) 2007-2009 Xiph.Org Foundation
cannam@154:    Copyright (c) 2008 Gregory Maxwell
cannam@154:    Written by Jean-Marc Valin and Gregory Maxwell */
cannam@154: /**
cannam@154:   @file celt.h
cannam@154:   @brief Contains all the functions for encoding and decoding audio
cannam@154:  */
cannam@154: 
cannam@154: /*
cannam@154:    Redistribution and use in source and binary forms, with or without
cannam@154:    modification, are permitted provided that the following conditions
cannam@154:    are met:
cannam@154: 
cannam@154:    - Redistributions of source code must retain the above copyright
cannam@154:    notice, this list of conditions and the following disclaimer.
cannam@154: 
cannam@154:    - Redistributions in binary form must reproduce the above copyright
cannam@154:    notice, this list of conditions and the following disclaimer in the
cannam@154:    documentation and/or other materials provided with the distribution.
cannam@154: 
cannam@154:    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
cannam@154:    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
cannam@154:    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
cannam@154:    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
cannam@154:    OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
cannam@154:    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
cannam@154:    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
cannam@154:    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
cannam@154:    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
cannam@154:    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
cannam@154:    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
cannam@154: */
cannam@154: 
cannam@154: #ifndef CELT_H
cannam@154: #define CELT_H
cannam@154: 
cannam@154: #include "opus_types.h"
cannam@154: #include "opus_defines.h"
cannam@154: #include "opus_custom.h"
cannam@154: #include "entenc.h"
cannam@154: #include "entdec.h"
cannam@154: #include "arch.h"
cannam@154: 
cannam@154: #ifdef __cplusplus
cannam@154: extern "C" {
cannam@154: #endif
cannam@154: 
cannam@154: #define CELTEncoder OpusCustomEncoder
cannam@154: #define CELTDecoder OpusCustomDecoder
cannam@154: #define CELTMode OpusCustomMode
cannam@154: 
cannam@154: #define LEAK_BANDS 19
cannam@154: 
cannam@154: typedef struct {
cannam@154:    int valid;
cannam@154:    float tonality;
cannam@154:    float tonality_slope;
cannam@154:    float noisiness;
cannam@154:    float activity;
cannam@154:    float music_prob;
cannam@154:    float music_prob_min;
cannam@154:    float music_prob_max;
cannam@154:    int   bandwidth;
cannam@154:    float activity_probability;
cannam@154:    float max_pitch_ratio;
cannam@154:    /* Store as Q6 char to save space. */
cannam@154:    unsigned char leak_boost[LEAK_BANDS];
cannam@154: } AnalysisInfo;
cannam@154: 
cannam@154: typedef struct {
cannam@154:    int signalType;
cannam@154:    int offset;
cannam@154: } SILKInfo;
cannam@154: 
cannam@154: #define __celt_check_mode_ptr_ptr(ptr) ((ptr) + ((ptr) - (const CELTMode**)(ptr)))
cannam@154: 
cannam@154: #define __celt_check_analysis_ptr(ptr) ((ptr) + ((ptr) - (const AnalysisInfo*)(ptr)))
cannam@154: 
cannam@154: #define __celt_check_silkinfo_ptr(ptr) ((ptr) + ((ptr) - (const SILKInfo*)(ptr)))
cannam@154: 
cannam@154: /* Encoder/decoder Requests */
cannam@154: 
cannam@154: 
cannam@154: #define CELT_SET_PREDICTION_REQUEST    10002
cannam@154: /** Controls the use of interframe prediction.
cannam@154:     0=Independent frames
cannam@154:     1=Short term interframe prediction allowed
cannam@154:     2=Long term prediction allowed
cannam@154:  */
cannam@154: #define CELT_SET_PREDICTION(x) CELT_SET_PREDICTION_REQUEST, __opus_check_int(x)
cannam@154: 
cannam@154: #define CELT_SET_INPUT_CLIPPING_REQUEST    10004
cannam@154: #define CELT_SET_INPUT_CLIPPING(x) CELT_SET_INPUT_CLIPPING_REQUEST, __opus_check_int(x)
cannam@154: 
cannam@154: #define CELT_GET_AND_CLEAR_ERROR_REQUEST   10007
cannam@154: #define CELT_GET_AND_CLEAR_ERROR(x) CELT_GET_AND_CLEAR_ERROR_REQUEST, __opus_check_int_ptr(x)
cannam@154: 
cannam@154: #define CELT_SET_CHANNELS_REQUEST    10008
cannam@154: #define CELT_SET_CHANNELS(x) CELT_SET_CHANNELS_REQUEST, __opus_check_int(x)
cannam@154: 
cannam@154: 
cannam@154: /* Internal */
cannam@154: #define CELT_SET_START_BAND_REQUEST    10010
cannam@154: #define CELT_SET_START_BAND(x) CELT_SET_START_BAND_REQUEST, __opus_check_int(x)
cannam@154: 
cannam@154: #define CELT_SET_END_BAND_REQUEST    10012
cannam@154: #define CELT_SET_END_BAND(x) CELT_SET_END_BAND_REQUEST, __opus_check_int(x)
cannam@154: 
cannam@154: #define CELT_GET_MODE_REQUEST    10015
cannam@154: /** Get the CELTMode used by an encoder or decoder */
cannam@154: #define CELT_GET_MODE(x) CELT_GET_MODE_REQUEST, __celt_check_mode_ptr_ptr(x)
cannam@154: 
cannam@154: #define CELT_SET_SIGNALLING_REQUEST    10016
cannam@154: #define CELT_SET_SIGNALLING(x) CELT_SET_SIGNALLING_REQUEST, __opus_check_int(x)
cannam@154: 
cannam@154: #define CELT_SET_TONALITY_REQUEST    10018
cannam@154: #define CELT_SET_TONALITY(x) CELT_SET_TONALITY_REQUEST, __opus_check_int(x)
cannam@154: #define CELT_SET_TONALITY_SLOPE_REQUEST    10020
cannam@154: #define CELT_SET_TONALITY_SLOPE(x) CELT_SET_TONALITY_SLOPE_REQUEST, __opus_check_int(x)
cannam@154: 
cannam@154: #define CELT_SET_ANALYSIS_REQUEST    10022
cannam@154: #define CELT_SET_ANALYSIS(x) CELT_SET_ANALYSIS_REQUEST, __celt_check_analysis_ptr(x)
cannam@154: 
cannam@154: #define OPUS_SET_LFE_REQUEST    10024
cannam@154: #define OPUS_SET_LFE(x) OPUS_SET_LFE_REQUEST, __opus_check_int(x)
cannam@154: 
cannam@154: #define OPUS_SET_ENERGY_MASK_REQUEST    10026
cannam@154: #define OPUS_SET_ENERGY_MASK(x) OPUS_SET_ENERGY_MASK_REQUEST, __opus_check_val16_ptr(x)
cannam@154: 
cannam@154: #define CELT_SET_SILK_INFO_REQUEST    10028
cannam@154: #define CELT_SET_SILK_INFO(x) CELT_SET_SILK_INFO_REQUEST, __celt_check_silkinfo_ptr(x)
cannam@154: 
cannam@154: /* Encoder stuff */
cannam@154: 
cannam@154: int celt_encoder_get_size(int channels);
cannam@154: 
cannam@154: int celt_encode_with_ec(OpusCustomEncoder * OPUS_RESTRICT st, const opus_val16 * pcm, int frame_size, unsigned char *compressed, int nbCompressedBytes, ec_enc *enc);
cannam@154: 
cannam@154: int celt_encoder_init(CELTEncoder *st, opus_int32 sampling_rate, int channels,
cannam@154:                       int arch);
cannam@154: 
cannam@154: 
cannam@154: 
cannam@154: /* Decoder stuff */
cannam@154: 
cannam@154: int celt_decoder_get_size(int channels);
cannam@154: 
cannam@154: 
cannam@154: int celt_decoder_init(CELTDecoder *st, opus_int32 sampling_rate, int channels);
cannam@154: 
cannam@154: int celt_decode_with_ec(OpusCustomDecoder * OPUS_RESTRICT st, const unsigned char *data,
cannam@154:       int len, opus_val16 * OPUS_RESTRICT pcm, int frame_size, ec_dec *dec, int accum);
cannam@154: 
cannam@154: #define celt_encoder_ctl opus_custom_encoder_ctl
cannam@154: #define celt_decoder_ctl opus_custom_decoder_ctl
cannam@154: 
cannam@154: 
cannam@154: #ifdef CUSTOM_MODES
cannam@154: #define OPUS_CUSTOM_NOSTATIC
cannam@154: #else
cannam@154: #define OPUS_CUSTOM_NOSTATIC static OPUS_INLINE
cannam@154: #endif
cannam@154: 
cannam@154: static const unsigned char trim_icdf[11] = {126, 124, 119, 109, 87, 41, 19, 9, 4, 2, 0};
cannam@154: /* Probs: NONE: 21.875%, LIGHT: 6.25%, NORMAL: 65.625%, AGGRESSIVE: 6.25% */
cannam@154: static const unsigned char spread_icdf[4] = {25, 23, 2, 0};
cannam@154: 
cannam@154: static const unsigned char tapset_icdf[3]={2,1,0};
cannam@154: 
cannam@154: #ifdef CUSTOM_MODES
cannam@154: static const unsigned char toOpusTable[20] = {
cannam@154:       0xE0, 0xE8, 0xF0, 0xF8,
cannam@154:       0xC0, 0xC8, 0xD0, 0xD8,
cannam@154:       0xA0, 0xA8, 0xB0, 0xB8,
cannam@154:       0x00, 0x00, 0x00, 0x00,
cannam@154:       0x80, 0x88, 0x90, 0x98,
cannam@154: };
cannam@154: 
cannam@154: static const unsigned char fromOpusTable[16] = {
cannam@154:       0x80, 0x88, 0x90, 0x98,
cannam@154:       0x40, 0x48, 0x50, 0x58,
cannam@154:       0x20, 0x28, 0x30, 0x38,
cannam@154:       0x00, 0x08, 0x10, 0x18
cannam@154: };
cannam@154: 
cannam@154: static OPUS_INLINE int toOpus(unsigned char c)
cannam@154: {
cannam@154:    int ret=0;
cannam@154:    if (c<0xA0)
cannam@154:       ret = toOpusTable[c>>3];
cannam@154:    if (ret == 0)
cannam@154:       return -1;
cannam@154:    else
cannam@154:       return ret|(c&0x7);
cannam@154: }
cannam@154: 
cannam@154: static OPUS_INLINE int fromOpus(unsigned char c)
cannam@154: {
cannam@154:    if (c<0x80)
cannam@154:       return -1;
cannam@154:    else
cannam@154:       return fromOpusTable[(c>>3)-16] | (c&0x7);
cannam@154: }
cannam@154: #endif /* CUSTOM_MODES */
cannam@154: 
cannam@154: #define COMBFILTER_MAXPERIOD 1024
cannam@154: #define COMBFILTER_MINPERIOD 15
cannam@154: 
cannam@154: extern const signed char tf_select_table[4][8];
cannam@154: 
cannam@154: #if defined(ENABLE_HARDENING) || defined(ENABLE_ASSERTIONS)
cannam@154: void validate_celt_decoder(CELTDecoder *st);
cannam@154: #define VALIDATE_CELT_DECODER(st) validate_celt_decoder(st)
cannam@154: #else
cannam@154: #define VALIDATE_CELT_DECODER(st)
cannam@154: #endif
cannam@154: 
cannam@154: int resampling_factor(opus_int32 rate);
cannam@154: 
cannam@154: void celt_preemphasis(const opus_val16 * OPUS_RESTRICT pcmp, celt_sig * OPUS_RESTRICT inp,
cannam@154:                         int N, int CC, int upsample, const opus_val16 *coef, celt_sig *mem, int clip);
cannam@154: 
cannam@154: void comb_filter(opus_val32 *y, opus_val32 *x, int T0, int T1, int N,
cannam@154:       opus_val16 g0, opus_val16 g1, int tapset0, int tapset1,
cannam@154:       const opus_val16 *window, int overlap, int arch);
cannam@154: 
cannam@154: #ifdef NON_STATIC_COMB_FILTER_CONST_C
cannam@154: void comb_filter_const_c(opus_val32 *y, opus_val32 *x, int T, int N,
cannam@154:                          opus_val16 g10, opus_val16 g11, opus_val16 g12);
cannam@154: #endif
cannam@154: 
cannam@154: #ifndef OVERRIDE_COMB_FILTER_CONST
cannam@154: # define comb_filter_const(y, x, T, N, g10, g11, g12, arch) \
cannam@154:     ((void)(arch),comb_filter_const_c(y, x, T, N, g10, g11, g12))
cannam@154: #endif
cannam@154: 
cannam@154: void init_caps(const CELTMode *m,int *cap,int LM,int C);
cannam@154: 
cannam@154: #ifdef RESYNTH
cannam@154: void deemphasis(celt_sig *in[], opus_val16 *pcm, int N, int C, int downsample, const opus_val16 *coef, celt_sig *mem);
cannam@154: void celt_synthesis(const CELTMode *mode, celt_norm *X, celt_sig * out_syn[],
cannam@154:       opus_val16 *oldBandE, int start, int effEnd, int C, int CC, int isTransient,
cannam@154:       int LM, int downsample, int silence);
cannam@154: #endif
cannam@154: 
cannam@154: #ifdef __cplusplus
cannam@154: }
cannam@154: #endif
cannam@154: 
cannam@154: #endif /* CELT_H */