Documentation updates for the CTLs.
[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 /**< 4 kHz bandpass @hideinitializer*/
175 #define OPUS_BANDWIDTH_MEDIUMBAND            1102 /**< 6 kHz bandpass @hideinitializer*/
176 #define OPUS_BANDWIDTH_WIDEBAND              1103 /**< 8 kHz bandpass @hideinitializer*/
177 #define OPUS_BANDWIDTH_SUPERWIDEBAND         1104 /**<12 kHz bandpass @hideinitializer*/
178 #define OPUS_BANDWIDTH_FULLBAND              1105 /**<20 kHz 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   * opus_int32 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   * @see OPUS_GET_COMPLEXITY
210   * @param[in] x <tt>opus_int32</tt>: Allowed values: 0-10, inclusive
211   *                                   (default: 10).
212   * @hideinitializer */
213 #define OPUS_SET_COMPLEXITY(x) OPUS_SET_COMPLEXITY_REQUEST, __opus_check_int(x)
214 /** Gets the encoder's complexity configuration.
215   * @see OPUS_SET_COMPLEXITY
216   * @param[out] x <tt>opus_int32 *</tt>: Returns a value in the range 0-10,
217   *                                      inclusive (default: 10).
218   * @hideinitializer */
219 #define OPUS_GET_COMPLEXITY(x) OPUS_GET_COMPLEXITY_REQUEST, __opus_check_int_ptr(x)
220
221 /** Configures the bitrate in the encoder.
222   * Rates from 500 to 512000 bits per second are meaningful, as well as the
223   * special values #OPUS_BITRATE_AUTO and #OPUS_BITRATE_MAX.
224   * The value #OPUS_BITRATE_MAX can be used to cause the codec to use as much
225   * rate as it can, which is useful for controlling the rate by adjusting the
226   * output buffer size.
227   * @see OPUS_GET_BITRATE
228   * @param[in] x <tt>opus_int32</tt>: Bitrate in bits per second. The default
229   *                                   is determined based on the number of
230   *                                   channels and the input sampling rate.
231   * @hideinitializer */
232 #define OPUS_SET_BITRATE(x) OPUS_SET_BITRATE_REQUEST, __opus_check_int(x)
233 /** Gets the encoder's bitrate configuration.
234   * @see OPUS_SET_BITRATE
235   * @param[out] x <tt>opus_int32 *</tt>: Returns the bitrate in bits per second.
236   *                                      The default is determined based on the
237   *                                      number of channels and the input
238   *                                      sampling rate.
239   * @hideinitializer */
240 #define OPUS_GET_BITRATE(x) OPUS_GET_BITRATE_REQUEST, __opus_check_int_ptr(x)
241
242 /** Enables or disables variable bitrate (VBR) in the encoder.
243   * The configured bitrate may not be met exactly because frames must
244   * be an integer number of bytes in length.
245   * @warning Only the MDCT mode of Opus can provide hard CBR behavior.
246   * @see OPUS_GET_VBR
247   * @see OPUS_SET_VBR_CONSTRAINT
248   * @param[in] x <tt>opus_int32</tt>: Allowed values:
249   * <dl>
250   * <dt>0</dt><dd>Hard CBR. In the MDCT mode all packets will be the same size.
251   *               In other modes, they will be as close as possible to that
252   *               size.</dd>
253   * <dt>1</dt><dd>VBR (default). The exact type of VBR is controlled by
254   *               #OPUS_SET_VBR_CONSTRAINT.</dd>
255   * </dl>
256   * @hideinitializer */
257 #define OPUS_SET_VBR(x) OPUS_SET_VBR_REQUEST, __opus_check_int(x)
258 /** Determine if variable bitrate (VBR) is enabled in the encoder.
259   * @see OPUS_SET_VBR
260   * @see OPUS_GET_VBR_CONSTRAINT
261   * @param[out] x <tt>opus_int32 *</tt>: Returns one of the following values:
262   * <dl>
263   * <dt>0</dt><dd>Hard CBR.</dd>
264   * <dt>1</dt><dd>VBR (default). The exact type of VBR may be retrieved via
265   *               #OPUS_GET_VBR_CONSTRAINT.</dd>
266   * </dl>
267   * @hideinitializer */
268 #define OPUS_GET_VBR(x) OPUS_GET_VBR_REQUEST, __opus_check_int_ptr(x)
269
270 /** Enables or disables constrained VBR in the encoder.
271   * This setting is ignored when the encoder is in CBR mode.
272   * @warning Only the MDCT mode of Opus currently heeds the constraint.
273   *  Speech mode ignores it completely, hybrid mode may fail to obey it
274   *  if the LPC layer uses more bitrate than the constraint would have
275   *  permitted.
276   * @see OPUS_GET_VBR_CONSTRAINT
277   * @see OPUS_SET_VBR
278   * @param[in] x <tt>opus_int32</tt>: Allowed values:
279   * <dl>
280   * <dt>0</dt><dd>Unconstrained VBR.</dd>
281   * <dt>1</dt><dd>Constrained VBR (default). This creates a maximum of one
282   *               frame of buffering delay assuming a transport with a
283   *               serialization speed of the nominal bitrate.</dd>
284   * </dl>
285   * @hideinitializer */
286 #define OPUS_SET_VBR_CONSTRAINT(x) OPUS_SET_VBR_CONSTRAINT_REQUEST, __opus_check_int(x)
287 /** Determine if constrained VBR is enabled in the encoder.
288   * @see OPUS_SET_VBR_CONSTRAINT
289   * @see OPUS_GET_VBR
290   * @param[out] x <tt>opus_int32 *</tt>: Returns one of the following values:
291   * <dl>
292   * <dt>0</dt><dd>Unconstrained VBR.</dd>
293   * <dt>1</dt><dd>Constrained VBR (default).</dd>
294   * </dl>
295   * @hideinitializer */
296 #define OPUS_GET_VBR_CONSTRAINT(x) OPUS_GET_VBR_CONSTRAINT_REQUEST, __opus_check_int_ptr(x)
297
298 /** Configures mono/stereo forcing in the encoder.
299   * This can force the encoder to produce packets encoded as either mono or
300   * stereo, regardless of the format of the input audio. This is useful when
301   * the caller knows that the input signal is currently a mono source embedded
302   * in a stereo stream.
303   * @see OPUS_GET_FORCE_CHANNELS
304   * @param[in] x <tt>opus_int32</tt>: Allowed values:
305   * <dl>
306   * <dt>#OPUS_AUTO</dt><dd>Not forced (default)</dd>
307   * <dt>1</dt>         <dd>Forced mono</dd>
308   * <dt>2</dt>         <dd>Forced stereo</dd>
309   * </dl>
310   * @hideinitializer */
311 #define OPUS_SET_FORCE_CHANNELS(x) OPUS_SET_FORCE_CHANNELS_REQUEST, __opus_check_int(x)
312 /** Gets the encoder's forced channel configuration.
313   * @see OPUS_SET_FORCE_CHANNELS
314   * @param[out] x <tt>opus_int32 *</tt>:
315   * <dl>
316   * <dt>#OPUS_AUTO</dt><dd>Not forced (default)</dd>
317   * <dt>1</dt>         <dd>Forced mono</dd>
318   * <dt>2</dt>         <dd>Forced stereo</dd>
319   * </dl>
320   * @hideinitializer */
321 #define OPUS_GET_FORCE_CHANNELS(x) OPUS_GET_FORCE_CHANNELS_REQUEST, __opus_check_int_ptr(x)
322
323 /** Configures the maximum bandpass that the encoder will select automatically.
324   * Applications should normally use this instead of #OPUS_SET_BANDWIDTH
325   * (leaving that set to the default, #OPUS_AUTO). This allows the
326   * application to set an upper bound based on the type of input it is
327   * providing, but still gives the encoder the freedom to reduce the bandpass
328   * when the bitrate becomes too low, for better overall quality.
329   * @see OPUS_GET_MAX_BANDWIDTH
330   * @param[in] x <tt>opus_int32</tt>: Allowed values:
331   * <dl>
332   * <dt>OPUS_BANDWIDTH_NARROWBAND</dt>    <dd>4 kHz passband</dd>
333   * <dt>OPUS_BANDWIDTH_MEDIUMBAND</dt>    <dd>6 kHz passband</dd>
334   * <dt>OPUS_BANDWIDTH_WIDEBAND</dt>      <dd>8 kHz passband</dd>
335   * <dt>OPUS_BANDWIDTH_SUPERWIDEBAND</dt><dd>12 kHz passband</dd>
336   * <dt>OPUS_BANDWIDTH_FULLBAND</dt>     <dd>20 kHz passband (default)</dd>
337   * </dl>
338   * @hideinitializer */
339 #define OPUS_SET_MAX_BANDWIDTH(x) OPUS_SET_MAX_BANDWIDTH_REQUEST, __opus_check_int(x)
340
341 /** Gets the encoder's configured maximum allowed bandpass.
342   * @see OPUS_SET_MAX_BANDWIDTH
343   * @param[out] x <tt>opus_int32 *</tt>: Allowed values:
344   * <dl>
345   * <dt>#OPUS_BANDWIDTH_NARROWBAND</dt>    <dd>4 kHz passband</dd>
346   * <dt>#OPUS_BANDWIDTH_MEDIUMBAND</dt>    <dd>6 kHz passband</dd>
347   * <dt>#OPUS_BANDWIDTH_WIDEBAND</dt>      <dd>8 kHz passband</dd>
348   * <dt>#OPUS_BANDWIDTH_SUPERWIDEBAND</dt><dd>12 kHz passband</dd>
349   * <dt>#OPUS_BANDWIDTH_FULLBAND</dt>     <dd>20 kHz passband (default)</dd>
350   * </dl>
351   * @hideinitializer */
352 #define OPUS_GET_MAX_BANDWIDTH(x) OPUS_GET_MAX_BANDWIDTH_REQUEST, __opus_check_int_ptr(x)
353
354 /** Sets the encoder's bandpass to a specific value.
355   * This prevents the encoder from automatically selecting the bandpass based
356   * on the available bitrate. If an application knows the bandpass of the input
357   * audio it is providing, it should normally use #OPUS_SET_MAX_BANDWIDTH
358   * instead, which still gives the encoder the freedom to reduce the bandpass
359   * when the bitrate becomes too low, for better overall quality.
360   * @see OPUS_GET_BANDWIDTH
361   * @param[in] x <tt>opus_int32</tt>: Allowed values:
362   * <dl>
363   * <dt>#OPUS_AUTO</dt>                    <dd>(default)</dd>
364   * <dt>#OPUS_BANDWIDTH_NARROWBAND</dt>    <dd>4 kHz passband</dd>
365   * <dt>#OPUS_BANDWIDTH_MEDIUMBAND</dt>    <dd>6 kHz passband</dd>
366   * <dt>#OPUS_BANDWIDTH_WIDEBAND</dt>      <dd>8 kHz passband</dd>
367   * <dt>#OPUS_BANDWIDTH_SUPERWIDEBAND</dt><dd>12 kHz passband</dd>
368   * <dt>#OPUS_BANDWIDTH_FULLBAND</dt>     <dd>20 kHz passband</dd>
369   * </dl>
370   * @hideinitializer */
371 #define OPUS_SET_BANDWIDTH(x) OPUS_SET_BANDWIDTH_REQUEST, __opus_check_int(x)
372
373 /** Configures the type of signal being encoded.
374   * This is a hint which helps the encoder's mode selection.
375   * @see OPUS_GET_SIGNAL
376   * @param[in] x <tt>opus_int32</tt>: Allowed values:
377   * <dl>
378   * <dt>#OPUS_AUTO</dt>        <dd>(default)</dd>
379   * <dt>#OPUS_SIGNAL_VOICE</dt><dd>Bias thresholds towards choosing LPC or Hybrid modes.</dd>
380   * <dt>#OPUS_SIGNAL_MUSIC</dt><dd>Bias thresholds towards choosing MDCT modes.</dd>
381   * </dl>
382   * @hideinitializer */
383 #define OPUS_SET_SIGNAL(x) OPUS_SET_SIGNAL_REQUEST, __opus_check_int(x)
384 /** Gets the encoder's configured signal type.
385   * @see OPUS_SET_SIGNAL
386   * @param[out] x <tt>opus_int32 *</tt>: Returns one of the following values:
387   * <dl>
388   * <dt>#OPUS_AUTO</dt>        <dd>(default)</dd>
389   * <dt>#OPUS_SIGNAL_VOICE</dt><dd>Bias thresholds towards choosing LPC or Hybrid modes.</dd>
390   * <dt>#OPUS_SIGNAL_MUSIC</dt><dd>Bias thresholds towards choosing MDCT modes.</dd>
391   * </dl>
392   * @hideinitializer */
393 #define OPUS_GET_SIGNAL(x) OPUS_GET_SIGNAL_REQUEST, __opus_check_int_ptr(x)
394
395
396 /** Configures the encoder's intended application.
397   * The initial value is a mandatory argument to the encoder_create function.
398   * @see OPUS_GET_APPLICATION
399   * @param[in] x <tt>opus_int32</tt>: Returns one of the following values:
400   * <dl>
401   * <dt>#OPUS_APPLICATION_VOIP</dt>
402   * <dd>Process signal for improved speech intelligibility.</dd>
403   * <dt>#OPUS_APPLICATION_AUDIO</dt>
404   * <dd>Favor faithfulness to the original input.</dd>
405   * <dt>#OPUS_APPLICATION_RESTRICTED_LOWDELAY</dt>
406   * <dd>Configure the minimum possible coding delay by disabling certain modes
407   * of operation.</dd>
408   * </dl>
409   * @hideinitializer */
410 #define OPUS_SET_APPLICATION(x) OPUS_SET_APPLICATION_REQUEST, __opus_check_int(x)
411 /** Gets the encoder's configured application.
412   * @see OPUS_SET_APPLICATION
413   * @param[out] x <tt>opus_int32 *</tt>: Returns one of the following values:
414   * <dl>
415   * <dt>#OPUS_APPLICATION_VOIP</dt>
416   * <dd>Process signal for improved speech intelligibility.</dd>
417   * <dt>#OPUS_APPLICATION_AUDIO</dt>
418   * <dd>Favor faithfulness to the original input.</dd>
419   * <dt>#OPUS_APPLICATION_RESTRICTED_LOWDELAY</dt>
420   * <dd>Configure the minimum possible coding delay by disabling certain modes
421   * of operation.</dd>
422   * </dl>
423   * @hideinitializer */
424 #define OPUS_GET_APPLICATION(x) OPUS_GET_APPLICATION_REQUEST, __opus_check_int_ptr(x)
425
426 /** Gets the total samples of delay added by the entire codec.
427   * This can be queried by the encoder and then the provided number of samples can be
428   * skipped on from the start of the decoder's output to provide time aligned input
429   * and output. From the perspective of a decoding application the real data begins this many
430   * samples late.
431   *
432   * The decoder contribution to this delay is identical for all decoders, but the
433   * encoder portion of the delay may vary from implementation to implementation,
434   * version to version, or even depend on the encoder's initial configuration.
435   * Applications needing delay compensation should call this CTL rather than
436   * hard-coding a value.
437   * @param[out] x <tt>opus_int32 *</tt>:   Number of lookahead samples
438   * @hideinitializer */
439 #define OPUS_GET_LOOKAHEAD(x) OPUS_GET_LOOKAHEAD_REQUEST, __opus_check_int_ptr(x)
440
441 /** Configures the encoder's use of inband forward error correction (FEC).
442   * @note This is only applicable to the LPC layer
443   * @see OPUS_GET_INBAND_FEC
444   * @param[in] x <tt>opus_int32</tt>: Allowed values:
445   * <dl>
446   * <dt>0</dt><dd>Disable inband FEC (default).</dd>
447   * <dt>1</dt><dd>Enable inband FEC.</dd>
448   * </dl>
449   * @hideinitializer */
450 #define OPUS_SET_INBAND_FEC(x) OPUS_SET_INBAND_FEC_REQUEST, __opus_check_int(x)
451 /** Gets encoder's configured use of inband forward error correction.
452   * @see OPUS_SET_INBAND_FEC
453   * @param[out] x <tt>opus_int32 *</tt>: Returns one of the following values:
454   * <dl>
455   * <dt>0</dt><dd>Inband FEC disabled (default).</dd>
456   * <dt>1</dt><dd>Inband FEC enabled.</dd>
457   * </dl>
458   * @hideinitializer */
459 #define OPUS_GET_INBAND_FEC(x) OPUS_GET_INBAND_FEC_REQUEST, __opus_check_int_ptr(x)
460
461 /** Configures the encoder's expected packet loss percentage.
462   * Higher values with trigger progressively more loss resistant behavior in the encoder
463   * at the expense of quality at a given bitrate in the lossless case, but greater quality
464   * under loss.
465   * @see OPUS_GET_PACKET_LOSS_PERC
466   * @param[in] x <tt>opus_int32</tt>:   Loss percentage in the range 0-100, inclusive (default: 0).
467   * @hideinitializer */
468 #define OPUS_SET_PACKET_LOSS_PERC(x) OPUS_SET_PACKET_LOSS_PERC_REQUEST, __opus_check_int(x)
469 /** Gets the encoder's configured packet loss percentage.
470   * @see OPUS_SET_PACKET_LOSS_PERC
471   * @param[out] x <tt>opus_int32 *</tt>: Returns the configured loss percentage
472   *                                      in the range 0-100, inclusive (default: 0).
473   * @hideinitializer */
474 #define OPUS_GET_PACKET_LOSS_PERC(x) OPUS_GET_PACKET_LOSS_PERC_REQUEST, __opus_check_int_ptr(x)
475
476 /** Configures the encoder's use of discontinuous transmission (DTX).
477   * @note This is only applicable to the LPC layer
478   * @see OPUS_GET_DTX
479   * @param[in] x <tt>opus_int32</tt>: Allowed values:
480   * <dl>
481   * <dt>0</dt><dd>Disable DTX (default).</dd>
482   * <dt>1</dt><dd>Enabled DTX.</dd>
483   * </dl>
484   * @hideinitializer */
485 #define OPUS_SET_DTX(x) OPUS_SET_DTX_REQUEST, __opus_check_int(x)
486 /** Gets encoder's configured use of discontinuous transmission.
487   * @see OPUS_SET_DTX
488   * @param[out] x <tt>opus_int32 *</tt>: Returns one of the following values:
489   * <dl>
490   * <dt>0</dt><dd>DTX disabled (default).</dd>
491   * <dt>1</dt><dd>DTX enabled.</dd>
492   * </dl>
493   * @hideinitializer */
494 #define OPUS_GET_DTX(x) OPUS_GET_DTX_REQUEST, __opus_check_int_ptr(x)
495 /**@}*/
496
497 /** @defgroup opus_genericctls Generic CTLs
498   *
499   * These macros are used with the \c opus_decoder_ctl and
500   * \c opus_encoder_ctl calls to generate a particular
501   * request.
502   *
503   * When called on an \c OpusDecoder they apply to that
504   * particular decoder instance. When called on an
505   * \c OpusEncoder they apply to the corresponding setting
506   * on that encoder instance, if present.
507   *
508   * Some usage examples:
509   *
510   * @code
511   * int ret;
512   * opus_int32 pitch;
513   * ret = opus_decoder_ctl(dec_ctx, OPUS_GET_PITCH(&pitch));
514   * if (ret == OPUS_OK) return ret;
515   *
516   * opus_encoder_ctl(enc_ctx, OPUS_RESET_STATE);
517   * opus_decoder_ctl(dec_ctx, OPUS_RESET_STATE);
518   *
519   * opus_int32 enc_bw, dec_bw;
520   * opus_encoder_ctl(enc_ctx, OPUS_GET_BANDWIDTH(&enc_bw));
521   * opus_decoder_ctl(dec_ctx, OPUS_GET_BANDWIDTH(&dec_bw));
522   * if (enc_bw != dec_bw) {
523   *   printf("packet bandwidth mismatch!\n");
524   * }
525   * @endcode
526   *
527   * @see opus_encoder, opus_decoder_ctl, opus_encoder_ctl, opus_decoderctls, opus_encoderctls
528   * @{
529   */
530
531 /** Resets the codec state to be equivalent to a freshly initialized state.
532   * This should be called when switching streams in order to prevent
533   * the back to back decoding from giving different results from
534   * one at a time decoding.
535   * @hideinitializer */
536 #define OPUS_RESET_STATE 4028
537
538 /** Gets the final state of the codec's entropy coder.
539   * This is used for testing purposes,
540   * The encoder and decoder state should be identical after coding a payload
541   * (assuming no data corruption or software bugs)
542   *
543   * @param[out] x <tt>opus_uint32 *</tt>: Entropy coder state
544   *
545   * @hideinitializer */
546 #define OPUS_GET_FINAL_RANGE(x) OPUS_GET_FINAL_RANGE_REQUEST, __opus_check_uint_ptr(x)
547
548 /** Gets the pitch of the last decoded frame, if available.
549   * This can be used for any post-processing algorithm requiring the use of pitch,
550   * e.g. time stretching/shortening. If the last frame was not voiced, or if the
551   * pitch was not coded in the frame, then zero is returned.
552   *
553   * This CTL is only implemented for decoder instances.
554   *
555   * @param[out] x <tt>opus_int32 *</tt>: pitch period at 48 kHz (or 0 if not available)
556   *
557   * @hideinitializer */
558 #define OPUS_GET_PITCH(x) OPUS_GET_PITCH_REQUEST, __opus_check_int_ptr(x)
559
560 /** Gets the encoder's configured bandpass or the decoder's last bandpass.
561   * @see OPUS_SET_BANDWIDTH
562   * @param[out] x <tt>opus_int32 *</tt>: Returns one of the following values:
563   * <dl>
564   * <dt>#OPUS_AUTO</dt>                    <dd>(default)</dd>
565   * <dt>#OPUS_BANDWIDTH_NARROWBAND</dt>    <dd>4 kHz passband</dd>
566   * <dt>#OPUS_BANDWIDTH_MEDIUMBAND</dt>    <dd>6 kHz passband</dd>
567   * <dt>#OPUS_BANDWIDTH_WIDEBAND</dt>      <dd>8 kHz passband</dd>
568   * <dt>#OPUS_BANDWIDTH_SUPERWIDEBAND</dt><dd>12 kHz passband</dd>
569   * <dt>#OPUS_BANDWIDTH_FULLBAND</dt>     <dd>20 kHz passband</dd>
570   * </dl>
571   * @hideinitializer */
572 #define OPUS_GET_BANDWIDTH(x) OPUS_GET_BANDWIDTH_REQUEST, __opus_check_int_ptr(x)
573
574 /** Configures the depth of signal being encoded.
575   * This is a hint which helps the encoder identify silence and near-silence.
576   * @see OPUS_GET_LSB_DEPTH
577   * @param[in] x <tt>opus_int32</tt>: Input precision in bits, between 8 and 24
578   *                                   (default: 24).
579   * @hideinitializer */
580 #define OPUS_SET_LSB_DEPTH(x) OPUS_SET_LSB_DEPTH_REQUEST, __opus_check_int(x)
581 /** Gets the encoder's configured signal depth.
582   * @see OPUS_SET_LSB_DEPTH
583   * @param[out] x <tt>opus_int32 *</tt>: Input precision in bits, between 8 and
584   *                                      24 (default: 24).
585   * @hideinitializer */
586 #define OPUS_GET_LSB_DEPTH(x) OPUS_GET_LSB_DEPTH_REQUEST, __opus_check_int_ptr(x)
587 /**@}*/
588
589 /** @defgroup opus_decoderctls Decoder related CTLs
590   * @see opus_genericctls, opus_encoderctls, opus_decoder
591   * @{
592   */
593
594 /** Configures decoder gain adjustment.
595   * Scales the decoded output by a factor specified in Q8 dB units.
596   * This has a maximum range of -32768 to 32767 inclusive, and returns
597   * OPUS_BAD_ARG otherwise. The default is zero indicating no adjustment.
598   * This setting survives decoder reset.
599   *
600   * gain = pow(10, x/(20.0*256))
601   *
602   * @param[in] x <tt>opus_int32</tt>:   Amount to scale PCM signal by in Q8 dB units.
603   * @hideinitializer */
604 #define OPUS_SET_GAIN(x) OPUS_SET_GAIN_REQUEST, __opus_check_int(x)
605 /** Gets the decoder's configured gain adjustment. @see OPUS_SET_GAIN
606   *
607   * @param[out] x <tt>opus_int32 *</tt>: Amount to scale PCM signal by in Q8 dB units.
608   * @hideinitializer */
609 #define OPUS_GET_GAIN(x) OPUS_GET_GAIN_REQUEST, __opus_check_int_ptr(x)
610
611 /**@}*/
612
613 /** @defgroup opus_libinfo Opus library information functions
614   * @{
615   */
616
617 /** Converts an opus error code into a human readable string.
618   *
619   * @param[in] error <tt>int</tt>: Error number
620   * @returns Error string
621   */
622 OPUS_EXPORT const char *opus_strerror(int error);
623
624 /** Gets the libopus version string.
625   *
626   * @returns Version string
627   */
628 OPUS_EXPORT const char *opus_get_version_string(void);
629 /**@}*/
630
631 #ifdef __cplusplus
632 }
633 #endif
634
635 #endif /* OPUS_DEFINES_H */