Remove redundant mid-only flag when side VAD flag is set.
[opus.git] / celt / opus_defines.h
1 /* Copyright (c) 2010-2011 Xiph.Org Foundation, Skype Limited
2    Written by Jean-Marc Valin and Koen Vos */
3 /*
4    Redistribution and use in source and binary forms, with or without
5    modification, are permitted provided that the following conditions
6    are met:
7
8    - Redistributions of source code must retain the above copyright
9    notice, this list of conditions and the following disclaimer.
10
11    - Redistributions in binary form must reproduce the above copyright
12    notice, this list of conditions and the following disclaimer in the
13    documentation and/or other materials provided with the distribution.
14
15    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
19    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
22    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
23    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
24    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28 /**
29  * @file opus_defines.h
30  * @brief Opus reference implementation constants
31  */
32
33 #ifndef OPUS_DEFINES_H
34 #define OPUS_DEFINES_H
35
36 #include "opus_types.h"
37
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41
42 /** @defgroup errorcodes Error codes
43  * @{
44  */
45 /** No error @hideinitializer*/
46 #define OPUS_OK                0
47 /** One or more invalid/out of range arguments @hideinitializer*/
48 #define OPUS_BAD_ARG          -1
49 /** The mode struct passed is invalid @hideinitializer*/
50 #define OPUS_BUFFER_TOO_SMALL -2
51 /** An internal error was detected @hideinitializer*/
52 #define OPUS_INTERNAL_ERROR   -3
53 /** The compressed data passed is corrupted @hideinitializer*/
54 #define OPUS_INVALID_PACKET   -4
55 /** Invalid/unsupported request number @hideinitializer*/
56 #define OPUS_UNIMPLEMENTED    -5
57 /** An encoder or decoder structure is invalid or already freed @hideinitializer*/
58 #define OPUS_INVALID_STATE    -6
59 /** Memory allocation has failed @hideinitializer*/
60 #define OPUS_ALLOC_FAIL       -7
61 /**@}*/
62
63 /** @cond OPUS_INTERNAL_DOC */
64 /**Export control for opus functions */
65
66 #if defined(__GNUC__) && defined(OPUS_BUILD)
67 # define OPUS_EXPORT __attribute__ ((visibility ("default")))
68 #elif defined(WIN32)
69 # ifdef OPUS_BUILD
70 #   define OPUS_EXPORT __declspec(dllexport)
71 # else
72 #   define OPUS_EXPORT __declspec(dllimport)
73 # endif
74 #else
75 # define OPUS_EXPORT
76 #endif
77
78 /** These are the actual Encoder CTL ID numbers.
79   * They should not be used directly by applications. */
80 #define OPUS_SET_COMPLEXITY_REQUEST          4010
81 #define OPUS_GET_COMPLEXITY_REQUEST          4011
82 #define OPUS_SET_BITRATE_REQUEST             4002
83 #define OPUS_GET_BITRATE_REQUEST             4003
84 #define OPUS_SET_VBR_REQUEST                 4006
85 #define OPUS_GET_VBR_REQUEST                 4007
86 #define OPUS_SET_VBR_CONSTRAINT_REQUEST      4020
87 #define OPUS_GET_VBR_CONSTRAINT_REQUEST      4021
88 #define OPUS_SET_FORCE_CHANNELS_REQUEST      4022
89 #define OPUS_GET_FORCE_CHANNELS_REQUEST      4023
90 #define OPUS_SET_BANDWIDTH_REQUEST           4008
91 #define OPUS_GET_BANDWIDTH_REQUEST           4009
92 #define OPUS_SET_SIGNAL_REQUEST              4024
93 #define OPUS_GET_SIGNAL_REQUEST              4025
94 #define OPUS_SET_VOICE_RATIO_REQUEST         4018
95 #define OPUS_GET_VOICE_RATIO_REQUEST         4019
96 #define OPUS_SET_APPLICATION_REQUEST         4000
97 #define OPUS_GET_APPLICATION_REQUEST         4001
98 #define OPUS_GET_LOOKAHEAD_REQUEST           4027
99 #define OPUS_SET_INBAND_FEC_REQUEST          4012
100 #define OPUS_GET_INBAND_FEC_REQUEST          4013
101 #define OPUS_SET_PACKET_LOSS_PERC_REQUEST    4014
102 #define OPUS_GET_PACKET_LOSS_PERC_REQUEST    4015
103 #define OPUS_SET_DTX_REQUEST                 4016
104 #define OPUS_GET_DTX_REQUEST                 4017
105 #define OPUS_GET_FINAL_RANGE_REQUEST         4031
106 #define OPUS_GET_PITCH_REQUEST               4033
107
108 /* Macros to trigger compilation errors when the wrong types are provided to a CTL */
109 #define __opus_check_int(x) (((void)((x) == (opus_int32)0)), (opus_int32)(x))
110 #define __opus_check_int_ptr(ptr) ((ptr) + ((ptr) - (opus_int32*)(ptr)))
111 #define __opus_check_uint_ptr(ptr) ((ptr) + ((ptr) - (opus_uint32*)(ptr)))
112 /** @endcond */
113
114 /** @defgroup ctlvalues Pre-defined values for CTL interface
115   * @see genericctls,encoderctls
116   * @{
117   */
118 /* Values for the various encoder CTLs */
119 #define OPUS_AUTO                           -1000 /**<Auto/default setting @hideinitializer*/
120 #define OPUS_BITRATE_MAX                       -1 /**<Maximum bitrate @hideinitializer*/
121
122 /** Best for "standard" VoIP/videoconference applications where listening quality and intelligibility matter most
123  * @hideinitializer */
124 #define OPUS_APPLICATION_VOIP                2048
125 /** Best for broadcast/high-fidelity application where the decoded audio should be as close as possible to the input
126  * @hideinitializer */
127 #define OPUS_APPLICATION_AUDIO               2049
128 /** Only use when lowest-achievable latency is what matters most. Voice-optimized modes cannot be used.
129  * @hideinitializer */
130 #define OPUS_APPLICATION_RESTRICTED_LOWDELAY 2051
131
132 #define OPUS_SIGNAL_VOICE                    3001 /**< Signal being encoded is voice */
133 #define OPUS_SIGNAL_MUSIC                    3002 /**< Signal being encoded is music */
134 #define OPUS_BANDWIDTH_NARROWBAND            1101 /**< 4kHz bandpass @hideinitializer*/
135 #define OPUS_BANDWIDTH_MEDIUMBAND            1102 /**< 6kHz bandpass @hideinitializer*/
136 #define OPUS_BANDWIDTH_WIDEBAND              1103 /**< 8kHz bandpass @hideinitializer*/
137 #define OPUS_BANDWIDTH_SUPERWIDEBAND         1104 /**<12kHz bandpass @hideinitializer*/
138 #define OPUS_BANDWIDTH_FULLBAND              1105 /**<20kHz bandpass @hideinitializer*/
139
140 /**@}*/
141
142
143 /** @defgroup encoderctls Encoder related CTLs
144   * @see genericctls,opusencoder
145   * @{
146   */
147
148 /** Configures the encoder's computational complexity.
149   * The supported range is 0-10 inclusive with 10 representing the highest complexity.
150   * The default value is 10.
151   * @param[in] x <tt>int</tt>:   0-10, inclusive
152   * @hideinitializer */
153 #define OPUS_SET_COMPLEXITY(x) OPUS_SET_COMPLEXITY_REQUEST, __opus_check_int(x)
154 /** Gets the encoder's complexity configuration, @see OPUS_SET_COMPLEXITY
155   * @param[out] x <tt>int*</tt>: 0-10, inclusive
156   * @hideinitializer */
157 #define OPUS_GET_COMPLEXITY(x) OPUS_GET_COMPLEXITY_REQUEST, __opus_check_int_ptr(x)
158
159 /** Configures the bitrate in the encoder.
160   * Rates from 500 to 512000 bits per second are meaningful as well as the
161   * special values OPUS_BITRATE_AUTO and OPUS_BITRATE_MAX.
162   * The value OPUS_BITRATE_MAX can be used to cause the codec to use as much rate
163   * as it can, which is useful for controlling the rate by adjusting the output
164   * buffer size.
165   * @param[in] x <tt>opus_int32</tt>:   bitrate in bits per second.
166   * @hideinitializer */
167 #define OPUS_SET_BITRATE(x) OPUS_SET_BITRATE_REQUEST, __opus_check_int(x)
168 /** Gets the encoder's bitrate configuration, @see OPUS_SET_BITRATE
169   * @param[out] x <tt>opus_int32*</tt>: bitrate in bits per second.
170   * @hideinitializer */
171 #define OPUS_GET_BITRATE(x) OPUS_GET_BITRATE_REQUEST, __opus_check_int_ptr(x)
172
173 /** Configures VBR in the encoder.
174   * The following values are currently supported:
175   *  - 0 CBR
176   *  - 1 VBR (default)
177   * The configured bitrate may not be met exactly because frames must
178   * be an integer number of bytes in length.
179   * @warning Only the MDCT mode of Opus can provide hard CBR behavior.
180   * @param[in] x <tt>int</tt>:   0; 1 (default)
181   * @hideinitializer */
182 #define OPUS_SET_VBR(x) OPUS_SET_VBR_REQUEST, __opus_check_int(x)
183 /** Gets the encoder's VBR configuration, @see OPUS_SET_VBR
184   * @param[out] x <tt>int*</tt>: 0; 1
185   * @hideinitializer */
186 #define OPUS_GET_VBR(x) OPUS_GET_VBR_REQUEST, __opus_check_int_ptr(x)
187
188 /** Configures constrained VBR in the encoder.
189   * The following values are currently supported:
190   *  - 0 Unconstrained VBR (default)
191   *  - 1 Maximum one frame buffering delay assuming transport with a serialization speed of the nominal bitrate
192   * This setting is irrelevant when the encoder is in CBR mode.
193   * @warning Only the MDCT mode of Opus currently heeds the constraint.
194   *  Speech mode ignores it completely, hybrid mode may fail to obey it
195   *  if the LPC layer uses more bitrate than the constraint would have
196   *  permitted.
197   * @param[in] x <tt>int</tt>:   0 (default); 1
198   * @hideinitializer */
199 #define OPUS_SET_VBR_CONSTRAINT(x) OPUS_SET_VBR_CONSTRAINT_REQUEST, __opus_check_int(x)
200 /** Gets the encoder's constrained VBR configuration @see OPUS_SET_VBR_CONSTRAINT
201   * @param[out] x <tt>int*</tt>: 0; 1
202   * @hideinitializer */
203 #define OPUS_GET_VBR_CONSTRAINT(x) OPUS_GET_VBR_CONSTRAINT_REQUEST, __opus_check_int_ptr(x)
204
205 /** Configures mono/stereo forcing in the encoder.
206   * This is useful when the caller knows that the input signal is currently a mono
207   * source embedded in a stereo stream.
208   * @param[in] x <tt>int</tt>:   OPUS_AUTO (default); 1 (forced mono); 2 (forced stereo)
209   * @hideinitializer */
210 #define OPUS_SET_FORCE_CHANNELS(x) OPUS_SET_FORCE_CHANNELS_REQUEST, __opus_check_int(x)
211 /** Gets the encoder's forced channel configuration, @see OPUS_SET_FORCE_CHANNELS
212   * @param[out] x <tt>int*</tt>: OPUS_AUTO; 0; 1
213   * @hideinitializer */
214 #define OPUS_GET_FORCE_CHANNELS(x) OPUS_GET_FORCE_CHANNELS_REQUEST, __opus_check_int_ptr(x)
215
216 /** Configures the encoder's bandpass, @see OPUS_GET_BANDWIDTH
217   * The supported values are:
218   *  - OPUS_AUTO (default)
219   *  - OPUS_BANDWIDTH_NARROWBAND     4kHz passband
220   *  - OPUS_BANDWIDTH_MEDIUMBAND     6kHz passband
221   *  - OPUS_BANDWIDTH_WIDEBAND       8kHz passband
222   *  - OPUS_BANDWIDTH_SUPERWIDEBAND 12kHz passband
223   *  - OPUS_BANDWIDTH_FULLBAND      20kHz passband
224   * @param[in] x <tt>int</tt>:   Bandwidth value
225   * @hideinitializer */
226 #define OPUS_SET_BANDWIDTH(x) OPUS_SET_BANDWIDTH_REQUEST, __opus_check_int(x)
227
228 /** Configures the type of signal being encoded.
229   * This is a hint which helps the encoder's mode selection.
230   * The supported values are:
231   *  - OPUS_SIGNAL_AUTO (default)
232   *  - OPUS_SIGNAL_VOICE
233   *  - OPUS_SIGNAL_MUSIC
234   * @param[in] x <tt>int</tt>:   Signal type
235   * @hideinitializer */
236 #define OPUS_SET_SIGNAL(x) OPUS_SET_SIGNAL_REQUEST, __opus_check_int(x)
237 /** Gets the encoder's configured signal type, @see OPUS_SET_SIGNAL
238   *
239   * @param[out] x <tt>int*</tt>: Signal type
240   * @hideinitializer */
241 #define OPUS_GET_SIGNAL(x) OPUS_GET_SIGNAL_REQUEST, __opus_check_int_ptr(x)
242
243 /** Configures the encoder's expected percentage of voice
244   * opposed to music or other signals.
245   *
246   * @note This interface is currently more aspiration than actuality. It's
247   * ultimately expected to bias an automatic signal classifier, but it currently
248   * just shifts the static bitrate to mode mapping around a little bit.
249   *
250   * @param[in] x <tt>int</tt>:   Voice percentage in the range 0-100, inclusive.
251   * @hideinitializer */
252 #define OPUS_SET_VOICE_RATIO(x) OPUS_SET_VOICE_RATIO_REQUEST, __opus_check_int(x)
253 /** Gets the encoder's configured voice ratio value, @see OPUS_SET_VOICE_RATIO
254   *
255   * @param[out] x <tt>int*</tt>:  Voice percentage in the range 0-100, inclusive.
256   * @hideinitializer */
257 #define OPUS_GET_VOICE_RATIO(x) OPUS_GET_VOICE_RATIO_REQUEST, __opus_check_int_ptr(x)
258
259 /** Configures the encoder's intended application.
260   * The initial value is a mandatory argument to the encoder_create function.
261   * The supported values are:
262   *  - OPUS_APPLICATION_VOIP Process signal for improved speech intelligibility
263   *  - OPUS_APPLICATION_AUDIO Favor faithfulness to the original input
264   * @param[in] x <tt>int</tt>:     Application value
265   * @hideinitializer */
266 #define OPUS_SET_APPLICATION(x) OPUS_SET_APPLICATION_REQUEST, __opus_check_int(x)
267 /** Gets the encoder's configured application, @see OPUS_SET_APPLICATION
268   *
269   * @param[out] x <tt>int*</tt>:   Application value
270   * @hideinitializer */
271 #define OPUS_GET_APPLICATION(x) OPUS_GET_APPLICATION_REQUEST, __opus_check_int_ptr(x)
272
273 /** Gets the total samples of delay added by the entire codec.
274   * This can be queried by the encoder and then the provided number of samples can be
275   * skipped on from the start of the decoder's output to provide time aligned input
276   * and output. From the perspective of a decoding application the real data begins this many
277   * samples late.
278   *
279   * The decoder contribution to this delay is identical for all decoders, but the
280   * encoder portion of the delay may vary from implementation to implementation,
281   * version to version, or even depend on the encoder's initial configuration.
282   * Applications needing delay compensation should call this CTL rather than
283   * hard-coding a value.
284   * @param[out] x <tt>int*</tt>:   Number of lookahead samples
285   * @hideinitializer */
286 #define OPUS_GET_LOOKAHEAD(x) OPUS_GET_LOOKAHEAD_REQUEST, __opus_check_int_ptr(x)
287
288 /** Configures the encoder's use of inband forward error correction.
289   * @note This is only applicable to the LPC layer
290   *
291   * @param[in] x <tt>int</tt>:   FEC flag, 0 (disabled) is default
292   * @hideinitializer */
293 #define OPUS_SET_INBAND_FEC(x) OPUS_SET_INBAND_FEC_REQUEST, __opus_check_int(x)
294 /** Gets encoder's configured use of inband forward error correction, @see OPUS_SET_INBAND_FEC
295   *
296   * @param[out] x <tt>int*</tt>: FEC flag
297   * @hideinitializer */
298 #define OPUS_GET_INBAND_FEC(x) OPUS_GET_INBAND_FEC_REQUEST, __opus_check_int_ptr(x)
299
300 /** Configures the encoder's expected packet loss percentage.
301   * Higher values with trigger progressively more loss resistant behavior in the encoder
302   * at the expense of quality at a given bitrate in the lossless case, but greater quality
303   * under loss.
304   *
305   * @param[in] x <tt>int</tt>:   Loss percentage in the range 0-100, inclusive.
306   * @hideinitializer */
307 #define OPUS_SET_PACKET_LOSS_PERC(x) OPUS_SET_PACKET_LOSS_PERC_REQUEST, __opus_check_int(x)
308 /** Gets the encoder's configured packet loss percentage, @see OPUS_SET_PACKET_LOSS_PERC
309   *
310   * @param[out] x <tt>int*</tt>: Loss percentage in the range 0-100, inclusive.
311   * @hideinitializer */
312 #define OPUS_GET_PACKET_LOSS_PERC(x) OPUS_GET_PACKET_LOSS_PERC_REQUEST, __opus_check_int_ptr(x)
313
314 /** Configures the encoder's use of discontinuous transmission.
315   * @note This is only applicable to the LPC layer
316   *
317   * @param[in] x <tt>int</tt>:   DTX flag, 0 (disabled) is default
318   * @hideinitializer */
319 #define OPUS_SET_DTX(x) OPUS_SET_DTX_REQUEST, __opus_check_int(x)
320 /** Gets encoder's configured use of discontinuous transmission, @see OPUS_SET_DTX
321   *
322   * @param[out] x <tt>int*</tt>:  DTX flag
323   * @hideinitializer */
324 #define OPUS_GET_DTX(x) OPUS_GET_DTX_REQUEST, __opus_check_int_ptr(x)
325 /**@}*/
326
327 /** @defgroup genericctls Generic CTLs
328   * @see opus_encoder_ctl,opusencoder,opusdecoder
329   * @{
330   */
331
332 /** Resets the codec state to be equivalent to a freshly initialized state.
333   * This should be called when switching streams in order to prevent
334   * the back to back decoding from giving different results from
335   * one at a time decoding.
336   * @hideinitializer */
337 #define OPUS_RESET_STATE 4028
338
339 /** Gets the final state of the codec's entropy coder.
340   * This is used for testing purposes,
341   * The encoder and decoder state should be identical after coding a payload
342   * (assuming no data corruption or software bugs)
343   *
344   * @param[out] x <tt>opus_uint32*</tt>: Entropy coder state
345   *
346   * @hideinitializer */
347 #define OPUS_GET_FINAL_RANGE(x) OPUS_GET_FINAL_RANGE_REQUEST, __opus_check_uint_ptr(x)
348
349 /** Gets the pitch of the last decoded frame, if available.
350   * This can be used for any post-processing algorithm requiring the use of pitch,
351   * e.g. time stretching/shortening. If the last frame was not voiced, or if the
352   * pitch was not coded in the frame, then zero is returned.
353   *
354   * @param[out] x <tt>opus_int32*</tt>: pitch period at 48 kHz (or 0 if not available)
355   *
356   * @hideinitializer */
357 #define OPUS_GET_PITCH(x) OPUS_GET_PITCH_REQUEST, __opus_check_int_ptr(x)
358
359 /** Gets the encoder's configured bandpass or the decoder's last bandpass, @see OPUS_SET_BANDWIDTH
360   * @param[out] x <tt>int*</tt>: Bandwidth value
361   * @hideinitializer */
362 #define OPUS_GET_BANDWIDTH(x) OPUS_GET_BANDWIDTH_REQUEST, __opus_check_int_ptr(x)
363
364 /**@}*/
365
366 /** @defgroup libinfo Opus library information functions
367   * @{
368   */
369
370 /** Converts an opus error code into a human readable string.
371   *
372   * @param[in] error <tt>int</tt>: Error number
373   * @returns Error string
374   */
375 OPUS_EXPORT const char *opus_strerror(int error);
376
377 /** Gets the libopus version string.
378   *
379   * @returns Version string
380   */
381 OPUS_EXPORT const char *opus_get_version_string(void);
382 /**@}*/
383
384 #ifdef __cplusplus
385 }
386 #endif
387
388 #endif /* OPUS_DEFINES_H */