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