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