comb_filter() bypass for the case where the gain is zero.
[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 }AnalysisInfo;
61
62 #define __celt_check_mode_ptr_ptr(ptr) ((ptr) + ((ptr) - (const CELTMode**)(ptr)))
63
64 #define __celt_check_analysis_ptr(ptr) ((ptr) + ((ptr) - (const AnalysisInfo*)(ptr)))
65
66 /* Encoder/decoder Requests */
67
68 #define CELT_SET_PREDICTION_REQUEST    10002
69 /** Controls the use of interframe prediction.
70     0=Independent frames
71     1=Short term interframe prediction allowed
72     2=Long term prediction allowed
73  */
74 #define CELT_SET_PREDICTION(x) CELT_SET_PREDICTION_REQUEST, __opus_check_int(x)
75
76 #define CELT_SET_INPUT_CLIPPING_REQUEST    10004
77 #define CELT_SET_INPUT_CLIPPING(x) CELT_SET_INPUT_CLIPPING_REQUEST, __opus_check_int(x)
78
79 #define CELT_GET_AND_CLEAR_ERROR_REQUEST   10007
80 #define CELT_GET_AND_CLEAR_ERROR(x) CELT_GET_AND_CLEAR_ERROR_REQUEST, __opus_check_int_ptr(x)
81
82 #define CELT_SET_CHANNELS_REQUEST    10008
83 #define CELT_SET_CHANNELS(x) CELT_SET_CHANNELS_REQUEST, __opus_check_int(x)
84
85
86 /* Internal */
87 #define CELT_SET_START_BAND_REQUEST    10010
88 #define CELT_SET_START_BAND(x) CELT_SET_START_BAND_REQUEST, __opus_check_int(x)
89
90 #define CELT_SET_END_BAND_REQUEST    10012
91 #define CELT_SET_END_BAND(x) CELT_SET_END_BAND_REQUEST, __opus_check_int(x)
92
93 #define CELT_GET_MODE_REQUEST    10015
94 /** Get the CELTMode used by an encoder or decoder */
95 #define CELT_GET_MODE(x) CELT_GET_MODE_REQUEST, __celt_check_mode_ptr_ptr(x)
96
97 #define CELT_SET_SIGNALLING_REQUEST    10016
98 #define CELT_SET_SIGNALLING(x) CELT_SET_SIGNALLING_REQUEST, __opus_check_int(x)
99
100 #define CELT_SET_TONALITY_REQUEST    10018
101 #define CELT_SET_TONALITY(x) CELT_SET_TONALITY_REQUEST, __opus_check_int(x)
102 #define CELT_SET_TONALITY_SLOPE_REQUEST    10020
103 #define CELT_SET_TONALITY_SLOPE(x) CELT_SET_TONALITY_SLOPE_REQUEST, __opus_check_int(x)
104
105 #define CELT_SET_ANALYSIS_REQUEST    10022
106 #define CELT_SET_ANALYSIS(x) CELT_SET_ANALYSIS_REQUEST, __celt_check_analysis_ptr(x)
107
108
109 /* Encoder stuff */
110
111 int celt_encoder_get_size(int channels);
112
113 int celt_encode_with_ec(OpusCustomEncoder * OPUS_RESTRICT st, const opus_val16 * pcm, int frame_size, unsigned char *compressed, int nbCompressedBytes, ec_enc *enc);
114
115 int celt_encoder_init(CELTEncoder *st, opus_int32 sampling_rate, int channels);
116
117
118
119 /* Decoder stuff */
120
121 int celt_decoder_get_size(int channels);
122
123
124 int celt_decoder_init(CELTDecoder *st, opus_int32 sampling_rate, int channels);
125
126 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);
127
128 #define celt_encoder_ctl opus_custom_encoder_ctl
129 #define celt_decoder_ctl opus_custom_decoder_ctl
130
131 #ifdef __cplusplus
132 }
133 #endif
134
135 #endif /* CELT_H */