14d5e5ebbe8d29b720cfabcac97105782d2ebab7
[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    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 COPYRIGHT OWNER
19    OR 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 opus_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) && !defined(__MINGW32__)
69 # ifdef OPUS_BUILD
70 #   define OPUS_EXPORT __declspec(dllexport)
71 # else
72 #   define OPUS_EXPORT
73 # endif
74 #else
75 # define OPUS_EXPORT
76 #endif
77
78 # if !defined(OPUS_GNUC_PREREQ)
79 #  if defined(__GNUC__)&&defined(__GNUC_MINOR__)
80 #   define OPUS_GNUC_PREREQ(_maj,_min) \
81  ((__GNUC__<<16)+__GNUC_MINOR__>=((_maj)<<16)+(_min))
82 #  else
83 #   define OPUS_GNUC_PREREQ(_maj,_min) 0
84 #  endif
85 # endif
86
87 #if (!defined(__STDC_VERSION__) || (__STDC_VERSION__ < 199901L) )
88 # if OPUS_GNUC_PREREQ(3,0)
89 #  define OPUS_RESTRICT __restrict__
90 # elif (defined(_MSC_VER) && _MSC_VER >= 1400)
91 #  define OPUS_RESTRICT __restrict
92 # else
93 #  define OPUS_RESTRICT
94 # endif
95 #else
96 # define OPUS_RESTRICT restrict
97 #endif
98
99 /**Warning attributes for opus functions
100   * NONNULL is not used in OPUS_BUILD to avoid the compiler optimizing out
101   * some paranoid null checks. */
102 #if defined(__GNUC__) && OPUS_GNUC_PREREQ(3, 4)
103 # define OPUS_WARN_UNUSED_RESULT __attribute__ ((__warn_unused_result__))
104 #else
105 # define OPUS_WARN_UNUSED_RESULT
106 #endif
107 #if !defined(OPUS_BUILD) && defined(__GNUC__) && OPUS_GNUC_PREREQ(3, 4)
108 # define OPUS_ARG_NONNULL(_x)  __attribute__ ((__nonnull__(_x)))
109 #else
110 # define OPUS_ARG_NONNULL(_x)
111 #endif
112
113 /** These are the actual Encoder CTL ID numbers.
114   * They should not be used directly by applications. */
115 #define OPUS_SET_APPLICATION_REQUEST         4000
116 #define OPUS_GET_APPLICATION_REQUEST         4001
117 #define OPUS_SET_BITRATE_REQUEST             4002
118 #define OPUS_GET_BITRATE_REQUEST             4003
119 #define OPUS_SET_MAX_BANDWIDTH_REQUEST       4004
120 #define OPUS_GET_MAX_BANDWIDTH_REQUEST       4005
121 #define OPUS_SET_VBR_REQUEST                 4006
122 #define OPUS_GET_VBR_REQUEST                 4007
123 #define OPUS_SET_BANDWIDTH_REQUEST           4008
124 #define OPUS_GET_BANDWIDTH_REQUEST           4009
125 #define OPUS_SET_COMPLEXITY_REQUEST          4010
126 #define OPUS_GET_COMPLEXITY_REQUEST          4011
127 #define OPUS_SET_INBAND_FEC_REQUEST          4012
128 #define OPUS_GET_INBAND_FEC_REQUEST          4013
129 #define OPUS_SET_PACKET_LOSS_PERC_REQUEST    4014
130 #define OPUS_GET_PACKET_LOSS_PERC_REQUEST    4015
131 #define OPUS_SET_DTX_REQUEST                 4016
132 #define OPUS_GET_DTX_REQUEST                 4017
133 #define OPUS_SET_VBR_CONSTRAINT_REQUEST      4020
134 #define OPUS_GET_VBR_CONSTRAINT_REQUEST      4021
135 #define OPUS_SET_FORCE_CHANNELS_REQUEST      4022
136 #define OPUS_GET_FORCE_CHANNELS_REQUEST      4023
137 #define OPUS_SET_SIGNAL_REQUEST              4024
138 #define OPUS_GET_SIGNAL_REQUEST              4025
139 #define OPUS_GET_LOOKAHEAD_REQUEST           4027
140 /* #define OPUS_RESET_STATE 4028 */
141 #define OPUS_GET_FINAL_RANGE_REQUEST         4031
142 #define OPUS_GET_PITCH_REQUEST               4033
143 #define OPUS_SET_GAIN_REQUEST                4034
144 #define OPUS_GET_GAIN_REQUEST                4045
145 #define OPUS_SET_LSB_DEPTH_REQUEST           4036
146 #define OPUS_GET_LSB_DEPTH_REQUEST           4037
147
148 /* Macros to trigger compilation errors when the wrong types are provided to a CTL */
149 #define __opus_check_int(x) (((void)((x) == (opus_int32)0)), (opus_int32)(x))
150 #define __opus_check_int_ptr(ptr) ((ptr) + ((ptr) - (opus_int32*)(ptr)))
151 #define __opus_check_uint_ptr(ptr) ((ptr) + ((ptr) - (opus_uint32*)(ptr)))
152 /** @endcond */
153
154 /** @defgroup opus_ctlvalues Pre-defined values for CTL interface
155   * @see opus_genericctls, opus_encoderctls
156   * @{
157   */
158 /* Values for the various encoder CTLs */
159 #define OPUS_AUTO                           -1000 /**<Auto/default setting @hideinitializer*/
160 #define OPUS_BITRATE_MAX                       -1 /**<Maximum bitrate @hideinitializer*/
161
162 /** Best for most VoIP/videoconference applications where listening quality and intelligibility matter most
163  * @hideinitializer */
164 #define OPUS_APPLICATION_VOIP                2048
165 /** Best for broadcast/high-fidelity application where the decoded audio should be as close as possible to the input
166  * @hideinitializer */
167 #define OPUS_APPLICATION_AUDIO               2049
168 /** Only use when lowest-achievable latency is what matters most. Voice-optimized modes cannot be used.
169  * @hideinitializer */
170 #define OPUS_APPLICATION_RESTRICTED_LOWDELAY 2051
171
172 #define OPUS_SIGNAL_VOICE                    3001 /**< Signal being encoded is voice */
173 #define OPUS_SIGNAL_MUSIC                    3002 /**< Signal being encoded is music */
174 #define OPUS_BANDWIDTH_NARROWBAND            1101 /**< 4kHz bandpass @hideinitializer*/
175 #define OPUS_BANDWIDTH_MEDIUMBAND            1102 /**< 6kHz bandpass @hideinitializer*/
176 #define OPUS_BANDWIDTH_WIDEBAND              1103 /**< 8kHz bandpass @hideinitializer*/
177 #define OPUS_BANDWIDTH_SUPERWIDEBAND         1104 /**<12kHz bandpass @hideinitializer*/
178 #define OPUS_BANDWIDTH_FULLBAND              1105 /**<20kHz bandpass @hideinitializer*/
179
180 /**@}*/
181
182
183 /** @defgroup opus_encoderctls Encoder related CTLs
184   *
185   * These are convenience macros for use with the \c opus_encode_ctl
186   * interface. They are used to generate the appropriate series of
187   * arguments for that call, passing the correct type, size and so
188   * on as expected for each particular request.
189   *
190   * Some usage examples:
191   *
192   * @code
193   * int ret;
194   * ret = opus_encoder_ctl(enc_ctx, OPUS_SET_BANDWIDTH(OPUS_AUTO));
195   * if (ret != OPUS_OK) return ret;
196   *
197   * int rate;
198   * opus_encoder_ctl(enc_ctx, OPUS_GET_BANDWIDTH(&rate));
199   *
200   * opus_encoder_ctl(enc_ctx, OPUS_RESET_STATE);
201   * @endcode
202   *
203   * @see opus_genericctls, opus_encoder
204   * @{
205   */
206
207 /** Configures the encoder's computational complexity.
208   * The supported range is 0-10 inclusive with 10 representing the highest complexity.
209   * The default value is 10.
210   * @param[in] x <tt>int</tt>:   0-10, inclusive
211   * @hideinitializer */
212 #define OPUS_SET_COMPLEXITY(x) OPUS_SET_COMPLEXITY_REQUEST, __opus_check_int(x)
213 /** Gets the encoder's complexity configuration. @see OPUS_SET_COMPLEXITY
214   * @param[out] x <tt>int*</tt>: 0-10, inclusive
215   * @hideinitializer */
216 #define OPUS_GET_COMPLEXITY(x) OPUS_GET_COMPLEXITY_REQUEST, __opus_check_int_ptr(x)
217
218 /** Configures the bitrate in the encoder.
219   * Rates from 500 to 512000 bits per second are meaningful as well as the
220   * special values OPUS_BITRATE_AUTO and OPUS_BITRATE_MAX.
221   * The value OPUS_BITRATE_MAX can be used to cause the codec to use as much rate
222   * as it can, which is useful for controlling the rate by adjusting the output
223   * buffer size.
224   * @param[in] x <tt>opus_int32</tt>:   bitrate in bits per second.
225   * @hideinitializer */
226 #define OPUS_SET_BITRATE(x) OPUS_SET_BITRATE_REQUEST, __opus_check_int(x)
227 /** Gets the encoder's bitrate configuration. @see OPUS_SET_BITRATE
228   * @param[out] x <tt>opus_int32*</tt>: bitrate in bits per second.
229   * @hideinitializer */
230 #define OPUS_GET_BITRATE(x) OPUS_GET_BITRATE_REQUEST, __opus_check_int_ptr(x)
231
232 /** Configures VBR in the encoder.
233   * The following values are currently supported:
234   *  - 0 CBR
235   *  - 1 VBR (default)
236   * The configured bitrate may not be met exactly because frames must
237   * be an integer number of bytes in length.
238   * @warning Only the MDCT mode of Opus can provide hard CBR behavior.
239   * @param[in] x <tt>int</tt>:   0; 1 (default)
240   * @hideinitializer */
241 #define OPUS_SET_VBR(x) OPUS_SET_VBR_REQUEST, __opus_check_int(x)
242 /** Gets the encoder's VBR configuration. @see OPUS_SET_VBR
243   * @param[out] x <tt>int*</tt>: 0; 1
244   * @hideinitializer */
245 #define OPUS_GET_VBR(x) OPUS_GET_VBR_REQUEST, __opus_check_int_ptr(x)
246
247 /** Configures constrained VBR in the encoder.
248   * The following values are currently supported:
249   *  - 0 Unconstrained VBR (default)
250   *  - 1 Maximum one frame buffering delay assuming transport with a serialization speed of the nominal bitrate
251   * This setting is irrelevant when the encoder is in CBR mode.
252   * @warning Only the MDCT mode of Opus currently heeds the constraint.
253   *  Speech mode ignores it completely, hybrid mode may fail to obey it
254   *  if the LPC layer uses more bitrate than the constraint would have
255   *  permitted.
256   * @param[in] x <tt>int</tt>:   0 (default); 1
257   * @hideinitializer */
258 #define OPUS_SET_VBR_CONSTRAINT(x) OPUS_SET_VBR_CONSTRAINT_REQUEST, __opus_check_int(x)
259 /** Gets the encoder's constrained VBR configuration @see OPUS_SET_VBR_CONSTRAINT
260   * @param[out] x <tt>int*</tt>: 0; 1
261   * @hideinitializer */
262 #define OPUS_GET_VBR_CONSTRAINT(x) OPUS_GET_VBR_CONSTRAINT_REQUEST, __opus_check_int_ptr(x)
263
264 /** Configures mono/stereo forcing in the encoder.
265   * This is useful when the caller knows that the input signal is currently a mono
266   * source embedded in a stereo stream.
267   * @param[in] x <tt>int</tt>:   OPUS_AUTO (default); 1 (forced mono); 2 (forced stereo)
268   * @hideinitializer */
269 #define OPUS_SET_FORCE_CHANNELS(x) OPUS_SET_FORCE_CHANNELS_REQUEST, __opus_check_int(x)
270 /** Gets the encoder's forced channel configuration. @see OPUS_SET_FORCE_CHANNELS
271   * @param[out] x <tt>int*</tt>: OPUS_AUTO; 0; 1
272   * @hideinitializer */
273 #define OPUS_GET_FORCE_CHANNELS(x) OPUS_GET_FORCE_CHANNELS_REQUEST, __opus_check_int_ptr(x)
274
275 /** Configures the maximum bandpass that the encoder will select automatically.
276   * Applications should normally use this instead of \a OPUS_SET_BANDWIDTH
277   * (leaving that set to the default, \c OPUS_AUTO). This allows the
278   * application to set an upper bound based on the type of input it is
279   * providing, but still gives the encoder the freedom to reduce the bandpass
280   * when the bitrate becomes too low, for better overall quality.
281   * @see OPUS_GET_MAX_BANDWIDTH
282   * The supported values are:
283   *  - OPUS_BANDWIDTH_NARROWBAND     4kHz passband
284   *  - OPUS_BANDWIDTH_MEDIUMBAND     6kHz passband
285   *  - OPUS_BANDWIDTH_WIDEBAND       8kHz passband
286   *  - OPUS_BANDWIDTH_SUPERWIDEBAND 12kHz passband
287   *  - OPUS_BANDWIDTH_FULLBAND      20kHz passband (default)
288   * @param[in] x <tt>int</tt>:   Bandwidth value
289   * @hideinitializer */
290 #define OPUS_SET_MAX_BANDWIDTH(x) OPUS_SET_MAX_BANDWIDTH_REQUEST, __opus_check_int(x)
291
292 /** Gets the encoder's configured maximum bandpass allowed. @see OPUS_SET_MAX_BANDWIDTH
293   * @param[out] x <tt>int*</tt>: Bandwidth value
294   * @hideinitializer */
295 #define OPUS_GET_MAX_BANDWIDTH(x) OPUS_GET_MAX_BANDWIDTH_REQUEST, __opus_check_int_ptr(x)
296
297 /** Sets the encoder's bandpass to a specific value.
298   * This prevents the encoder from automatically selecting the bandpass based
299   * on the available bitrate. If an application knows the bandpass of the input
300   * audio it is providing, it should normally use \a OPUS_SET_MAX_BANDWIDTH
301   * instead, which still gives the encoder the freedom to reduce the bandpass
302   * when the bitrate becomes too low, for better overall quality.
303   * @see OPUS_GET_BANDWIDTH
304   * The supported values are:
305   *  - OPUS_AUTO (default)
306   *  - OPUS_BANDWIDTH_NARROWBAND     4kHz passband
307   *  - OPUS_BANDWIDTH_MEDIUMBAND     6kHz passband
308   *  - OPUS_BANDWIDTH_WIDEBAND       8kHz passband
309   *  - OPUS_BANDWIDTH_SUPERWIDEBAND 12kHz passband
310   *  - OPUS_BANDWIDTH_FULLBAND      20kHz passband
311   * @param[in] x <tt>int</tt>:   Bandwidth value
312   * @hideinitializer */
313 #define OPUS_SET_BANDWIDTH(x) OPUS_SET_BANDWIDTH_REQUEST, __opus_check_int(x)
314
315 /** Configures the type of signal being encoded.
316   * This is a hint which helps the encoder's mode selection.
317   * The supported values are:
318   *  - OPUS_SIGNAL_AUTO (default)
319   *  - OPUS_SIGNAL_VOICE
320   *  - OPUS_SIGNAL_MUSIC
321   * @param[in] x <tt>int</tt>:   Signal type
322   * @hideinitializer */
323 #define OPUS_SET_SIGNAL(x) OPUS_SET_SIGNAL_REQUEST, __opus_check_int(x)
324 /** Gets the encoder's configured signal type. @see OPUS_SET_SIGNAL
325   *
326   * @param[out] x <tt>int*</tt>: Signal type
327   * @hideinitializer */
328 #define OPUS_GET_SIGNAL(x) OPUS_GET_SIGNAL_REQUEST, __opus_check_int_ptr(x)
329
330
331 /** Configures the encoder's intended application.
332   * The initial value is a mandatory argument to the encoder_create function.
333   * The supported values are:
334   *  - OPUS_APPLICATION_VOIP Process signal for improved speech intelligibility
335   *  - OPUS_APPLICATION_AUDIO Favor faithfulness to the original input
336   *  - OPUS_APPLICATION_RESTRICTED_LOWDELAY Configure the minimum possible coding delay
337   *
338   * @param[in] x <tt>int</tt>:     Application value
339   * @hideinitializer */
340 #define OPUS_SET_APPLICATION(x) OPUS_SET_APPLICATION_REQUEST, __opus_check_int(x)
341 /** Gets the encoder's configured application. @see OPUS_SET_APPLICATION
342   *
343   * @param[out] x <tt>int*</tt>:   Application value
344   * @hideinitializer */
345 #define OPUS_GET_APPLICATION(x) OPUS_GET_APPLICATION_REQUEST, __opus_check_int_ptr(x)
346
347 /** Gets the total samples of delay added by the entire codec.
348   * This can be queried by the encoder and then the provided number of samples can be
349   * skipped on from the start of the decoder's output to provide time aligned input
350   * and output. From the perspective of a decoding application the real data begins this many
351   * samples late.
352   *
353   * The decoder contribution to this delay is identical for all decoders, but the
354   * encoder portion of the delay may vary from implementation to implementation,
355   * version to version, or even depend on the encoder's initial configuration.
356   * Applications needing delay compensation should call this CTL rather than
357   * hard-coding a value.
358   * @param[out] x <tt>int*</tt>:   Number of lookahead samples
359   * @hideinitializer */
360 #define OPUS_GET_LOOKAHEAD(x) OPUS_GET_LOOKAHEAD_REQUEST, __opus_check_int_ptr(x)
361
362 /** Configures the encoder's use of inband forward error correction.
363   * @note This is only applicable to the LPC layer
364   *
365   * @param[in] x <tt>int</tt>:   FEC flag, 0 (disabled) is default
366   * @hideinitializer */
367 #define OPUS_SET_INBAND_FEC(x) OPUS_SET_INBAND_FEC_REQUEST, __opus_check_int(x)
368 /** Gets encoder's configured use of inband forward error correction. @see OPUS_SET_INBAND_FEC
369   *
370   * @param[out] x <tt>int*</tt>: FEC flag
371   * @hideinitializer */
372 #define OPUS_GET_INBAND_FEC(x) OPUS_GET_INBAND_FEC_REQUEST, __opus_check_int_ptr(x)
373
374 /** Configures the encoder's expected packet loss percentage.
375   * Higher values with trigger progressively more loss resistant behavior in the encoder
376   * at the expense of quality at a given bitrate in the lossless case, but greater quality
377   * under loss.
378   *
379   * @param[in] x <tt>int</tt>:   Loss percentage in the range 0-100, inclusive.
380   * @hideinitializer */
381 #define OPUS_SET_PACKET_LOSS_PERC(x) OPUS_SET_PACKET_LOSS_PERC_REQUEST, __opus_check_int(x)
382 /** Gets the encoder's configured packet loss percentage. @see OPUS_SET_PACKET_LOSS_PERC
383   *
384   * @param[out] x <tt>int*</tt>: Loss percentage in the range 0-100, inclusive.
385   * @hideinitializer */
386 #define OPUS_GET_PACKET_LOSS_PERC(x) OPUS_GET_PACKET_LOSS_PERC_REQUEST, __opus_check_int_ptr(x)
387
388 /** Configures the encoder's use of discontinuous transmission.
389   * @note This is only applicable to the LPC layer
390   *
391   * @param[in] x <tt>int</tt>:   DTX flag, 0 (disabled) is default
392   * @hideinitializer */
393 #define OPUS_SET_DTX(x) OPUS_SET_DTX_REQUEST, __opus_check_int(x)
394 /** Gets encoder's configured use of discontinuous transmission. @see OPUS_SET_DTX
395   *
396   * @param[out] x <tt>int*</tt>:  DTX flag
397   * @hideinitializer */
398 #define OPUS_GET_DTX(x) OPUS_GET_DTX_REQUEST, __opus_check_int_ptr(x)
399 /**@}*/
400
401 /** @defgroup opus_genericctls Generic CTLs
402   *
403   * These macros are used with the \c opus_decoder_ctl and
404   * \c opus_encoder_ctl calls to generate a particular
405   * request.
406   *
407   * When called on an \c OpusDecoder they apply to that
408   * particular decoder instance. When called on an
409   * \c OpusEncoder they apply to the corresponding setting
410   * on that encoder instance, if present.
411   *
412   * Some usage examples:
413   *
414   * @code
415   * int ret;
416   * opus_int32 pitch;
417   * ret = opus_decoder_ctl(dec_ctx, OPUS_GET_PITCH(&pitch));
418   * if (ret == OPUS_OK) return ret;
419   *
420   * opus_encoder_ctl(enc_ctx, OPUS_RESET_STATE);
421   * opus_decoder_ctl(dec_ctx, OPUS_RESET_STATE);
422   *
423   * opus_int32 enc_bw, dec_bw;
424   * opus_encoder_ctl(enc_ctx, OPUS_GET_BANDWIDTH(&enc_bw));
425   * opus_decoder_ctl(dec_ctx, OPUS_GET_BANDWIDTH(&dec_bw));
426   * if (enc_bw != dec_bw) {
427   *   printf("packet bandwidth mismatch!\n");
428   * }
429   * @endcode
430   *
431   * @see opus_encoder, opus_decoder_ctl, opus_encoder_ctl, opus_decoderctls, opus_encoderctls
432   * @{
433   */
434
435 /** Resets the codec state to be equivalent to a freshly initialized state.
436   * This should be called when switching streams in order to prevent
437   * the back to back decoding from giving different results from
438   * one at a time decoding.
439   * @hideinitializer */
440 #define OPUS_RESET_STATE 4028
441
442 /** Gets the final state of the codec's entropy coder.
443   * This is used for testing purposes,
444   * The encoder and decoder state should be identical after coding a payload
445   * (assuming no data corruption or software bugs)
446   *
447   * @param[out] x <tt>opus_uint32*</tt>: Entropy coder state
448   *
449   * @hideinitializer */
450 #define OPUS_GET_FINAL_RANGE(x) OPUS_GET_FINAL_RANGE_REQUEST, __opus_check_uint_ptr(x)
451
452 /** Gets the pitch of the last decoded frame, if available.
453   * This can be used for any post-processing algorithm requiring the use of pitch,
454   * e.g. time stretching/shortening. If the last frame was not voiced, or if the
455   * pitch was not coded in the frame, then zero is returned.
456   *
457   * This CTL is only implemented for decoder instances.
458   *
459   * @param[out] x <tt>opus_int32*</tt>: pitch period at 48 kHz (or 0 if not available)
460   *
461   * @hideinitializer */
462 #define OPUS_GET_PITCH(x) OPUS_GET_PITCH_REQUEST, __opus_check_int_ptr(x)
463
464 /** Gets the encoder's configured bandpass or the decoder's last bandpass. @see OPUS_SET_BANDWIDTH
465   * @param[out] x <tt>int*</tt>: Bandwidth value
466   * @hideinitializer */
467 #define OPUS_GET_BANDWIDTH(x) OPUS_GET_BANDWIDTH_REQUEST, __opus_check_int_ptr(x)
468
469 /** Configures the depth of signal being encoded.
470   * This is a hint which helps the encoder identify silence and near-silence.
471   * The supported values are between 8 and 24 (default)
472   * @param[in] x <tt>opus_int32</tt>:   Input precision
473   * @hideinitializer */
474 #define OPUS_SET_LSB_DEPTH(x) OPUS_SET_LSB_DEPTH_REQUEST, __opus_check_int(x)
475 /** Gets the encoder's configured signal depth. @see OPUS_SET_LSB_DEPTH
476   *
477   * @param[out] x <tt>opus_int32*</tt>: Input precision
478   * @hideinitializer */
479 #define OPUS_GET_LSB_DEPTH(x) OPUS_GET_LSB_DEPTH_REQUEST, __opus_check_int_ptr(x)
480 /**@}*/
481
482 /** @defgroup opus_decoderctls Decoder related CTLs
483   * @see opus_genericctls, opus_encoderctls, opus_decoder
484   * @{
485   */
486
487 /** Configures decoder gain adjustment.
488   * Scales the decoded output by a factor specified in Q8 dB units.
489   * This has a maximum range of -32768 to 32767 inclusive, and returns
490   * OPUS_BAD_ARG otherwise. The default is zero indicating no adjustment.
491   * This setting survives decoder reset.
492   *
493   * gain = pow(10, x/(20.0*256))
494   *
495   * @param[in] x <tt>opus_int32</tt>:   Amount to scale PCM signal by in Q8 dB units.
496   * @hideinitializer */
497 #define OPUS_SET_GAIN(x) OPUS_SET_GAIN_REQUEST, __opus_check_int(x)
498 /** Gets the decoder's configured gain adjustment. @see OPUS_SET_GAIN
499   *
500   * @param[out] x <tt>opus_int32*</tt>: Amount to scale PCM signal by in Q8 dB units.
501   * @hideinitializer */
502 #define OPUS_GET_GAIN(x) OPUS_GET_GAIN_REQUEST, __opus_check_int_ptr(x)
503
504 /**@}*/
505
506 /** @defgroup opus_libinfo Opus library information functions
507   * @{
508   */
509
510 /** Converts an opus error code into a human readable string.
511   *
512   * @param[in] error <tt>int</tt>: Error number
513   * @returns Error string
514   */
515 OPUS_EXPORT const char *opus_strerror(int error);
516
517 /** Gets the libopus version string.
518   *
519   * @returns Version string
520   */
521 OPUS_EXPORT const char *opus_get_version_string(void);
522 /**@}*/
523
524 #ifdef __cplusplus
525 }
526 #endif
527
528 #endif /* OPUS_DEFINES_H */