Oops, forgot the #defines for OPUS_{SET|GET}_MAX_BANDWIDTH()
[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_APPLICATION_REQUEST         4000
81 #define OPUS_GET_APPLICATION_REQUEST         4001
82 #define OPUS_SET_BITRATE_REQUEST             4002
83 #define OPUS_GET_BITRATE_REQUEST             4003
84 #define OPUS_SET_MAX_BANDWIDTH_REQUEST       4004
85 #define OPUS_GET_MAX_BANDWIDTH_REQUEST       4005
86 #define OPUS_SET_VBR_REQUEST                 4006
87 #define OPUS_GET_VBR_REQUEST                 4007
88 #define OPUS_SET_BANDWIDTH_REQUEST           4008
89 #define OPUS_GET_BANDWIDTH_REQUEST           4009
90 #define OPUS_SET_COMPLEXITY_REQUEST          4010
91 #define OPUS_GET_COMPLEXITY_REQUEST          4011
92 #define OPUS_SET_INBAND_FEC_REQUEST          4012
93 #define OPUS_GET_INBAND_FEC_REQUEST          4013
94 #define OPUS_SET_PACKET_LOSS_PERC_REQUEST    4014
95 #define OPUS_GET_PACKET_LOSS_PERC_REQUEST    4015
96 #define OPUS_SET_DTX_REQUEST                 4016
97 #define OPUS_GET_DTX_REQUEST                 4017
98 #define OPUS_SET_VOICE_RATIO_REQUEST         4018
99 #define OPUS_GET_VOICE_RATIO_REQUEST         4019
100 #define OPUS_SET_VBR_CONSTRAINT_REQUEST      4020
101 #define OPUS_GET_VBR_CONSTRAINT_REQUEST      4021
102 #define OPUS_SET_FORCE_CHANNELS_REQUEST      4022
103 #define OPUS_GET_FORCE_CHANNELS_REQUEST      4023
104 #define OPUS_SET_SIGNAL_REQUEST              4024
105 #define OPUS_GET_SIGNAL_REQUEST              4025
106 #define OPUS_GET_LOOKAHEAD_REQUEST           4027
107 /* #define OPUS_RESET_STATE 4028 */
108 #define OPUS_GET_FINAL_RANGE_REQUEST         4031
109 #define OPUS_GET_PITCH_REQUEST               4033
110
111 /* Macros to trigger compilation errors when the wrong types are provided to a CTL */
112 #define __opus_check_int(x) (((void)((x) == (opus_int32)0)), (opus_int32)(x))
113 #define __opus_check_int_ptr(ptr) ((ptr) + ((ptr) - (opus_int32*)(ptr)))
114 #define __opus_check_uint_ptr(ptr) ((ptr) + ((ptr) - (opus_uint32*)(ptr)))
115 /** @endcond */
116
117 /** @defgroup ctlvalues Pre-defined values for CTL interface
118   * @see genericctls,encoderctls
119   * @{
120   */
121 /* Values for the various encoder CTLs */
122 #define OPUS_AUTO                           -1000 /**<Auto/default setting @hideinitializer*/
123 #define OPUS_BITRATE_MAX                       -1 /**<Maximum bitrate @hideinitializer*/
124
125 /** Best for "standard" VoIP/videoconference applications where listening quality and intelligibility matter most
126  * @hideinitializer */
127 #define OPUS_APPLICATION_VOIP                2048
128 /** Best for broadcast/high-fidelity application where the decoded audio should be as close as possible to the input
129  * @hideinitializer */
130 #define OPUS_APPLICATION_AUDIO               2049
131 /** Only use when lowest-achievable latency is what matters most. Voice-optimized modes cannot be used.
132  * @hideinitializer */
133 #define OPUS_APPLICATION_RESTRICTED_LOWDELAY 2051
134
135 #define OPUS_SIGNAL_VOICE                    3001 /**< Signal being encoded is voice */
136 #define OPUS_SIGNAL_MUSIC                    3002 /**< Signal being encoded is music */
137 #define OPUS_BANDWIDTH_NARROWBAND            1101 /**< 4kHz bandpass @hideinitializer*/
138 #define OPUS_BANDWIDTH_MEDIUMBAND            1102 /**< 6kHz bandpass @hideinitializer*/
139 #define OPUS_BANDWIDTH_WIDEBAND              1103 /**< 8kHz bandpass @hideinitializer*/
140 #define OPUS_BANDWIDTH_SUPERWIDEBAND         1104 /**<12kHz bandpass @hideinitializer*/
141 #define OPUS_BANDWIDTH_FULLBAND              1105 /**<20kHz bandpass @hideinitializer*/
142
143 /**@}*/
144
145
146 /** @defgroup encoderctls Encoder related CTLs
147   * @see genericctls,opusencoder
148   * @{
149   */
150
151 /** Configures the encoder's computational complexity.
152   * The supported range is 0-10 inclusive with 10 representing the highest complexity.
153   * The default value is 10.
154   * @param[in] x <tt>int</tt>:   0-10, inclusive
155   * @hideinitializer */
156 #define OPUS_SET_COMPLEXITY(x) OPUS_SET_COMPLEXITY_REQUEST, __opus_check_int(x)
157 /** Gets the encoder's complexity configuration, @see OPUS_SET_COMPLEXITY
158   * @param[out] x <tt>int*</tt>: 0-10, inclusive
159   * @hideinitializer */
160 #define OPUS_GET_COMPLEXITY(x) OPUS_GET_COMPLEXITY_REQUEST, __opus_check_int_ptr(x)
161
162 /** Configures the bitrate in the encoder.
163   * Rates from 500 to 512000 bits per second are meaningful as well as the
164   * special values OPUS_BITRATE_AUTO and OPUS_BITRATE_MAX.
165   * The value OPUS_BITRATE_MAX can be used to cause the codec to use as much rate
166   * as it can, which is useful for controlling the rate by adjusting the output
167   * buffer size.
168   * @param[in] x <tt>opus_int32</tt>:   bitrate in bits per second.
169   * @hideinitializer */
170 #define OPUS_SET_BITRATE(x) OPUS_SET_BITRATE_REQUEST, __opus_check_int(x)
171 /** Gets the encoder's bitrate configuration, @see OPUS_SET_BITRATE
172   * @param[out] x <tt>opus_int32*</tt>: bitrate in bits per second.
173   * @hideinitializer */
174 #define OPUS_GET_BITRATE(x) OPUS_GET_BITRATE_REQUEST, __opus_check_int_ptr(x)
175
176 /** Configures VBR in the encoder.
177   * The following values are currently supported:
178   *  - 0 CBR
179   *  - 1 VBR (default)
180   * The configured bitrate may not be met exactly because frames must
181   * be an integer number of bytes in length.
182   * @warning Only the MDCT mode of Opus can provide hard CBR behavior.
183   * @param[in] x <tt>int</tt>:   0; 1 (default)
184   * @hideinitializer */
185 #define OPUS_SET_VBR(x) OPUS_SET_VBR_REQUEST, __opus_check_int(x)
186 /** Gets the encoder's VBR configuration, @see OPUS_SET_VBR
187   * @param[out] x <tt>int*</tt>: 0; 1
188   * @hideinitializer */
189 #define OPUS_GET_VBR(x) OPUS_GET_VBR_REQUEST, __opus_check_int_ptr(x)
190
191 /** Configures constrained VBR in the encoder.
192   * The following values are currently supported:
193   *  - 0 Unconstrained VBR (default)
194   *  - 1 Maximum one frame buffering delay assuming transport with a serialization speed of the nominal bitrate
195   * This setting is irrelevant when the encoder is in CBR mode.
196   * @warning Only the MDCT mode of Opus currently heeds the constraint.
197   *  Speech mode ignores it completely, hybrid mode may fail to obey it
198   *  if the LPC layer uses more bitrate than the constraint would have
199   *  permitted.
200   * @param[in] x <tt>int</tt>:   0 (default); 1
201   * @hideinitializer */
202 #define OPUS_SET_VBR_CONSTRAINT(x) OPUS_SET_VBR_CONSTRAINT_REQUEST, __opus_check_int(x)
203 /** Gets the encoder's constrained VBR configuration @see OPUS_SET_VBR_CONSTRAINT
204   * @param[out] x <tt>int*</tt>: 0; 1
205   * @hideinitializer */
206 #define OPUS_GET_VBR_CONSTRAINT(x) OPUS_GET_VBR_CONSTRAINT_REQUEST, __opus_check_int_ptr(x)
207
208 /** Configures mono/stereo forcing in the encoder.
209   * This is useful when the caller knows that the input signal is currently a mono
210   * source embedded in a stereo stream.
211   * @param[in] x <tt>int</tt>:   OPUS_AUTO (default); 1 (forced mono); 2 (forced stereo)
212   * @hideinitializer */
213 #define OPUS_SET_FORCE_CHANNELS(x) OPUS_SET_FORCE_CHANNELS_REQUEST, __opus_check_int(x)
214 /** Gets the encoder's forced channel configuration, @see OPUS_SET_FORCE_CHANNELS
215   * @param[out] x <tt>int*</tt>: OPUS_AUTO; 0; 1
216   * @hideinitializer */
217 #define OPUS_GET_FORCE_CHANNELS(x) OPUS_GET_FORCE_CHANNELS_REQUEST, __opus_check_int_ptr(x)
218
219 /** Configures the encoder's maximum bandpass allowed, @see OPUS_GET_MAX_BANDWIDTH
220   * The supported values are:
221   *  - OPUS_BANDWIDTH_NARROWBAND     4kHz passband
222   *  - OPUS_BANDWIDTH_MEDIUMBAND     6kHz passband
223   *  - OPUS_BANDWIDTH_WIDEBAND       8kHz passband
224   *  - OPUS_BANDWIDTH_SUPERWIDEBAND 12kHz passband
225   *  - OPUS_BANDWIDTH_FULLBAND      20kHz passband (default)
226   * @param[in] x <tt>int</tt>:   Bandwidth value
227   * @hideinitializer */
228 #define OPUS_SET_MAX_BANDWIDTH(x) OPUS_SET_MAX_BANDWIDTH_REQUEST, __opus_check_int(x)
229
230 /** Gets the encoder's configured maximum bandpass allowed, @see OPUS_SET_MAX_BANDWIDTH
231   * @param[out] x <tt>int*</tt>: Bandwidth value
232   * @hideinitializer */
233 #define OPUS_GET_MAX_BANDWIDTH(x) OPUS_GET_MAX_BANDWIDTH_REQUEST, __opus_check_int_ptr(x)
234
235 /** Configures the encoder's bandpass, @see OPUS_GET_BANDWIDTH
236   * The supported values are:
237   *  - OPUS_AUTO (default)
238   *  - OPUS_BANDWIDTH_NARROWBAND     4kHz passband
239   *  - OPUS_BANDWIDTH_MEDIUMBAND     6kHz passband
240   *  - OPUS_BANDWIDTH_WIDEBAND       8kHz passband
241   *  - OPUS_BANDWIDTH_SUPERWIDEBAND 12kHz passband
242   *  - OPUS_BANDWIDTH_FULLBAND      20kHz passband
243   * @param[in] x <tt>int</tt>:   Bandwidth value
244   * @hideinitializer */
245 #define OPUS_SET_BANDWIDTH(x) OPUS_SET_BANDWIDTH_REQUEST, __opus_check_int(x)
246
247 /** Configures the type of signal being encoded.
248   * This is a hint which helps the encoder's mode selection.
249   * The supported values are:
250   *  - OPUS_SIGNAL_AUTO (default)
251   *  - OPUS_SIGNAL_VOICE
252   *  - OPUS_SIGNAL_MUSIC
253   * @param[in] x <tt>int</tt>:   Signal type
254   * @hideinitializer */
255 #define OPUS_SET_SIGNAL(x) OPUS_SET_SIGNAL_REQUEST, __opus_check_int(x)
256 /** Gets the encoder's configured signal type, @see OPUS_SET_SIGNAL
257   *
258   * @param[out] x <tt>int*</tt>: Signal type
259   * @hideinitializer */
260 #define OPUS_GET_SIGNAL(x) OPUS_GET_SIGNAL_REQUEST, __opus_check_int_ptr(x)
261
262 /** Configures the encoder's expected percentage of voice
263   * opposed to music or other signals.
264   *
265   * @note This interface is currently more aspiration than actuality. It's
266   * ultimately expected to bias an automatic signal classifier, but it currently
267   * just shifts the static bitrate to mode mapping around a little bit.
268   *
269   * @param[in] x <tt>int</tt>:   Voice percentage in the range 0-100, inclusive.
270   * @hideinitializer */
271 #define OPUS_SET_VOICE_RATIO(x) OPUS_SET_VOICE_RATIO_REQUEST, __opus_check_int(x)
272 /** Gets the encoder's configured voice ratio value, @see OPUS_SET_VOICE_RATIO
273   *
274   * @param[out] x <tt>int*</tt>:  Voice percentage in the range 0-100, inclusive.
275   * @hideinitializer */
276 #define OPUS_GET_VOICE_RATIO(x) OPUS_GET_VOICE_RATIO_REQUEST, __opus_check_int_ptr(x)
277
278 /** Configures the encoder's intended application.
279   * The initial value is a mandatory argument to the encoder_create function.
280   * The supported values are:
281   *  - OPUS_APPLICATION_VOIP Process signal for improved speech intelligibility
282   *  - OPUS_APPLICATION_AUDIO Favor faithfulness to the original input
283   * @param[in] x <tt>int</tt>:     Application value
284   * @hideinitializer */
285 #define OPUS_SET_APPLICATION(x) OPUS_SET_APPLICATION_REQUEST, __opus_check_int(x)
286 /** Gets the encoder's configured application, @see OPUS_SET_APPLICATION
287   *
288   * @param[out] x <tt>int*</tt>:   Application value
289   * @hideinitializer */
290 #define OPUS_GET_APPLICATION(x) OPUS_GET_APPLICATION_REQUEST, __opus_check_int_ptr(x)
291
292 /** Gets the total samples of delay added by the entire codec.
293   * This can be queried by the encoder and then the provided number of samples can be
294   * skipped on from the start of the decoder's output to provide time aligned input
295   * and output. From the perspective of a decoding application the real data begins this many
296   * samples late.
297   *
298   * The decoder contribution to this delay is identical for all decoders, but the
299   * encoder portion of the delay may vary from implementation to implementation,
300   * version to version, or even depend on the encoder's initial configuration.
301   * Applications needing delay compensation should call this CTL rather than
302   * hard-coding a value.
303   * @param[out] x <tt>int*</tt>:   Number of lookahead samples
304   * @hideinitializer */
305 #define OPUS_GET_LOOKAHEAD(x) OPUS_GET_LOOKAHEAD_REQUEST, __opus_check_int_ptr(x)
306
307 /** Configures the encoder's use of inband forward error correction.
308   * @note This is only applicable to the LPC layer
309   *
310   * @param[in] x <tt>int</tt>:   FEC flag, 0 (disabled) is default
311   * @hideinitializer */
312 #define OPUS_SET_INBAND_FEC(x) OPUS_SET_INBAND_FEC_REQUEST, __opus_check_int(x)
313 /** Gets encoder's configured use of inband forward error correction, @see OPUS_SET_INBAND_FEC
314   *
315   * @param[out] x <tt>int*</tt>: FEC flag
316   * @hideinitializer */
317 #define OPUS_GET_INBAND_FEC(x) OPUS_GET_INBAND_FEC_REQUEST, __opus_check_int_ptr(x)
318
319 /** Configures the encoder's expected packet loss percentage.
320   * Higher values with trigger progressively more loss resistant behavior in the encoder
321   * at the expense of quality at a given bitrate in the lossless case, but greater quality
322   * under loss.
323   *
324   * @param[in] x <tt>int</tt>:   Loss percentage in the range 0-100, inclusive.
325   * @hideinitializer */
326 #define OPUS_SET_PACKET_LOSS_PERC(x) OPUS_SET_PACKET_LOSS_PERC_REQUEST, __opus_check_int(x)
327 /** Gets the encoder's configured packet loss percentage, @see OPUS_SET_PACKET_LOSS_PERC
328   *
329   * @param[out] x <tt>int*</tt>: Loss percentage in the range 0-100, inclusive.
330   * @hideinitializer */
331 #define OPUS_GET_PACKET_LOSS_PERC(x) OPUS_GET_PACKET_LOSS_PERC_REQUEST, __opus_check_int_ptr(x)
332
333 /** Configures the encoder's use of discontinuous transmission.
334   * @note This is only applicable to the LPC layer
335   *
336   * @param[in] x <tt>int</tt>:   DTX flag, 0 (disabled) is default
337   * @hideinitializer */
338 #define OPUS_SET_DTX(x) OPUS_SET_DTX_REQUEST, __opus_check_int(x)
339 /** Gets encoder's configured use of discontinuous transmission, @see OPUS_SET_DTX
340   *
341   * @param[out] x <tt>int*</tt>:  DTX flag
342   * @hideinitializer */
343 #define OPUS_GET_DTX(x) OPUS_GET_DTX_REQUEST, __opus_check_int_ptr(x)
344 /**@}*/
345
346 /** @defgroup genericctls Generic CTLs
347   * @see opus_encoder_ctl,opusencoder,opusdecoder
348   * @{
349   */
350
351 /** Resets the codec state to be equivalent to a freshly initialized state.
352   * This should be called when switching streams in order to prevent
353   * the back to back decoding from giving different results from
354   * one at a time decoding.
355   * @hideinitializer */
356 #define OPUS_RESET_STATE 4028
357
358 /** Gets the final state of the codec's entropy coder.
359   * This is used for testing purposes,
360   * The encoder and decoder state should be identical after coding a payload
361   * (assuming no data corruption or software bugs)
362   *
363   * @param[out] x <tt>opus_uint32*</tt>: Entropy coder state
364   *
365   * @hideinitializer */
366 #define OPUS_GET_FINAL_RANGE(x) OPUS_GET_FINAL_RANGE_REQUEST, __opus_check_uint_ptr(x)
367
368 /** Gets the pitch of the last decoded frame, if available.
369   * This can be used for any post-processing algorithm requiring the use of pitch,
370   * e.g. time stretching/shortening. If the last frame was not voiced, or if the
371   * pitch was not coded in the frame, then zero is returned.
372   *
373   * @param[out] x <tt>opus_int32*</tt>: pitch period at 48 kHz (or 0 if not available)
374   *
375   * @hideinitializer */
376 #define OPUS_GET_PITCH(x) OPUS_GET_PITCH_REQUEST, __opus_check_int_ptr(x)
377
378 /** Gets the encoder's configured bandpass or the decoder's last bandpass, @see OPUS_SET_BANDWIDTH
379   * @param[out] x <tt>int*</tt>: Bandwidth value
380   * @hideinitializer */
381 #define OPUS_GET_BANDWIDTH(x) OPUS_GET_BANDWIDTH_REQUEST, __opus_check_int_ptr(x)
382
383 /**@}*/
384
385 /** @defgroup libinfo Opus library information functions
386   * @{
387   */
388
389 /** Converts an opus error code into a human readable string.
390   *
391   * @param[in] error <tt>int</tt>: Error number
392   * @returns Error string
393   */
394 OPUS_EXPORT const char *opus_strerror(int error);
395
396 /** Gets the libopus version string.
397   *
398   * @returns Version string
399   */
400 OPUS_EXPORT const char *opus_get_version_string(void);
401 /**@}*/
402
403 #ifdef __cplusplus
404 }
405 #endif
406
407 #endif /* OPUS_DEFINES_H */