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