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