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