Eliminate trailing spaces
[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 /** Not enough bytes allocated in the buffer @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 #ifndef OPUS_EXPORT
67 # if defined(WIN32)
68 #  if defined(OPUS_BUILD) && defined(DLL_EXPORT)
69 #   define OPUS_EXPORT __declspec(dllexport)
70 #  else
71 #   define OPUS_EXPORT
72 #  endif
73 # elif defined(__GNUC__) && defined(OPUS_BUILD)
74 #  define OPUS_EXPORT __attribute__ ((visibility ("default")))
75 # else
76 #  define OPUS_EXPORT
77 # endif
78 #endif
79
80 # if !defined(OPUS_GNUC_PREREQ)
81 #  if defined(__GNUC__)&&defined(__GNUC_MINOR__)
82 #   define OPUS_GNUC_PREREQ(_maj,_min) \
83  ((__GNUC__<<16)+__GNUC_MINOR__>=((_maj)<<16)+(_min))
84 #  else
85 #   define OPUS_GNUC_PREREQ(_maj,_min) 0
86 #  endif
87 # endif
88
89 #if (!defined(__STDC_VERSION__) || (__STDC_VERSION__ < 199901L) )
90 # if OPUS_GNUC_PREREQ(3,0)
91 #  define OPUS_RESTRICT __restrict__
92 # elif (defined(_MSC_VER) && _MSC_VER >= 1400)
93 #  define OPUS_RESTRICT __restrict
94 # else
95 #  define OPUS_RESTRICT
96 # endif
97 #else
98 # define OPUS_RESTRICT restrict
99 #endif
100
101 #if (!defined(__STDC_VERSION__) || (__STDC_VERSION__ < 199901L) )
102 # if OPUS_GNUC_PREREQ(2,7)
103 #  define OPUS_INLINE __inline__
104 # elif (defined(_MSC_VER))
105 #  define OPUS_INLINE __inline
106 # else
107 #  define OPUS_INLINE
108 # endif
109 #else
110 # define OPUS_INLINE inline
111 #endif
112
113 /**Warning attributes for opus functions
114   * NONNULL is not used in OPUS_BUILD to avoid the compiler optimizing out
115   * some paranoid null checks. */
116 #if defined(__GNUC__) && OPUS_GNUC_PREREQ(3, 4)
117 # define OPUS_WARN_UNUSED_RESULT __attribute__ ((__warn_unused_result__))
118 #else
119 # define OPUS_WARN_UNUSED_RESULT
120 #endif
121 #if !defined(OPUS_BUILD) && defined(__GNUC__) && OPUS_GNUC_PREREQ(3, 4)
122 # define OPUS_ARG_NONNULL(_x)  __attribute__ ((__nonnull__(_x)))
123 #else
124 # define OPUS_ARG_NONNULL(_x)
125 #endif
126
127 /** These are the actual Encoder CTL ID numbers.
128   * They should not be used directly by applications.
129   * In general, SETs should be even and GETs should be odd.*/
130 #define OPUS_SET_APPLICATION_REQUEST         4000
131 #define OPUS_GET_APPLICATION_REQUEST         4001
132 #define OPUS_SET_BITRATE_REQUEST             4002
133 #define OPUS_GET_BITRATE_REQUEST             4003
134 #define OPUS_SET_MAX_BANDWIDTH_REQUEST       4004
135 #define OPUS_GET_MAX_BANDWIDTH_REQUEST       4005
136 #define OPUS_SET_VBR_REQUEST                 4006
137 #define OPUS_GET_VBR_REQUEST                 4007
138 #define OPUS_SET_BANDWIDTH_REQUEST           4008
139 #define OPUS_GET_BANDWIDTH_REQUEST           4009
140 #define OPUS_SET_COMPLEXITY_REQUEST          4010
141 #define OPUS_GET_COMPLEXITY_REQUEST          4011
142 #define OPUS_SET_INBAND_FEC_REQUEST          4012
143 #define OPUS_GET_INBAND_FEC_REQUEST          4013
144 #define OPUS_SET_PACKET_LOSS_PERC_REQUEST    4014
145 #define OPUS_GET_PACKET_LOSS_PERC_REQUEST    4015
146 #define OPUS_SET_DTX_REQUEST                 4016
147 #define OPUS_GET_DTX_REQUEST                 4017
148 #define OPUS_SET_VBR_CONSTRAINT_REQUEST      4020
149 #define OPUS_GET_VBR_CONSTRAINT_REQUEST      4021
150 #define OPUS_SET_FORCE_CHANNELS_REQUEST      4022
151 #define OPUS_GET_FORCE_CHANNELS_REQUEST      4023
152 #define OPUS_SET_SIGNAL_REQUEST              4024
153 #define OPUS_GET_SIGNAL_REQUEST              4025
154 #define OPUS_GET_LOOKAHEAD_REQUEST           4027
155 /* #define OPUS_RESET_STATE 4028 */
156 #define OPUS_GET_SAMPLE_RATE_REQUEST         4029
157 #define OPUS_GET_FINAL_RANGE_REQUEST         4031
158 #define OPUS_GET_PITCH_REQUEST               4033
159 #define OPUS_SET_GAIN_REQUEST                4034
160 #define OPUS_GET_GAIN_REQUEST                4045 /* Should have been 4035 */
161 #define OPUS_SET_LSB_DEPTH_REQUEST           4036
162 #define OPUS_GET_LSB_DEPTH_REQUEST           4037
163 #define OPUS_GET_LAST_PACKET_DURATION_REQUEST 4039
164 #define OPUS_SET_EXPERT_FRAME_DURATION_REQUEST 4040
165 #define OPUS_GET_EXPERT_FRAME_DURATION_REQUEST 4041
166 #define OPUS_SET_PREDICTION_DISABLED_REQUEST 4042
167 #define OPUS_GET_PREDICTION_DISABLED_REQUEST 4043
168 /* Don't use 4045, it's already taken by OPUS_GET_GAIN_REQUEST */
169 #define OPUS_SET_PHASE_INVERSION_DISABLED_REQUEST 4046
170 #define OPUS_GET_PHASE_INVERSION_DISABLED_REQUEST 4047
171
172 /* Macros to trigger compilation errors when the wrong types are provided to a CTL */
173 #define __opus_check_int(x) (((void)((x) == (opus_int32)0)), (opus_int32)(x))
174 #define __opus_check_int_ptr(ptr) ((ptr) + ((ptr) - (opus_int32*)(ptr)))
175 #define __opus_check_uint_ptr(ptr) ((ptr) + ((ptr) - (opus_uint32*)(ptr)))
176 #define __opus_check_val16_ptr(ptr) ((ptr) + ((ptr) - (opus_val16*)(ptr)))
177 /** @endcond */
178
179 /** @defgroup opus_ctlvalues Pre-defined values for CTL interface
180   * @see opus_genericctls, opus_encoderctls
181   * @{
182   */
183 /* Values for the various encoder CTLs */
184 #define OPUS_AUTO                           -1000 /**<Auto/default setting @hideinitializer*/
185 #define OPUS_BITRATE_MAX                       -1 /**<Maximum bitrate @hideinitializer*/
186
187 /** Best for most VoIP/videoconference applications where listening quality and intelligibility matter most
188  * @hideinitializer */
189 #define OPUS_APPLICATION_VOIP                2048
190 /** Best for broadcast/high-fidelity application where the decoded audio should be as close as possible to the input
191  * @hideinitializer */
192 #define OPUS_APPLICATION_AUDIO               2049
193 /** Only use when lowest-achievable latency is what matters most. Voice-optimized modes cannot be used.
194  * @hideinitializer */
195 #define OPUS_APPLICATION_RESTRICTED_LOWDELAY 2051
196
197 #define OPUS_SIGNAL_VOICE                    3001 /**< Signal being encoded is voice */
198 #define OPUS_SIGNAL_MUSIC                    3002 /**< Signal being encoded is music */
199 #define OPUS_BANDWIDTH_NARROWBAND            1101 /**< 4 kHz bandpass @hideinitializer*/
200 #define OPUS_BANDWIDTH_MEDIUMBAND            1102 /**< 6 kHz bandpass @hideinitializer*/
201 #define OPUS_BANDWIDTH_WIDEBAND              1103 /**< 8 kHz bandpass @hideinitializer*/
202 #define OPUS_BANDWIDTH_SUPERWIDEBAND         1104 /**<12 kHz bandpass @hideinitializer*/
203 #define OPUS_BANDWIDTH_FULLBAND              1105 /**<20 kHz bandpass @hideinitializer*/
204
205 #define OPUS_FRAMESIZE_ARG                   5000 /**< Select frame size from the argument (default) */
206 #define OPUS_FRAMESIZE_2_5_MS                5001 /**< Use 2.5 ms frames */
207 #define OPUS_FRAMESIZE_5_MS                  5002 /**< Use 5 ms frames */
208 #define OPUS_FRAMESIZE_10_MS                 5003 /**< Use 10 ms frames */
209 #define OPUS_FRAMESIZE_20_MS                 5004 /**< Use 20 ms frames */
210 #define OPUS_FRAMESIZE_40_MS                 5005 /**< Use 40 ms frames */
211 #define OPUS_FRAMESIZE_60_MS                 5006 /**< Use 60 ms frames */
212 #define OPUS_FRAMESIZE_80_MS                 5007 /**< Use 80 ms frames */
213 #define OPUS_FRAMESIZE_100_MS                5008 /**< Use 100 ms frames */
214 #define OPUS_FRAMESIZE_120_MS                5009 /**< Use 120 ms frames */
215
216 /**@}*/
217
218
219 /** @defgroup opus_encoderctls Encoder related CTLs
220   *
221   * These are convenience macros for use with the \c opus_encode_ctl
222   * interface. They are used to generate the appropriate series of
223   * arguments for that call, passing the correct type, size and so
224   * on as expected for each particular request.
225   *
226   * Some usage examples:
227   *
228   * @code
229   * int ret;
230   * ret = opus_encoder_ctl(enc_ctx, OPUS_SET_BANDWIDTH(OPUS_AUTO));
231   * if (ret != OPUS_OK) return ret;
232   *
233   * opus_int32 rate;
234   * opus_encoder_ctl(enc_ctx, OPUS_GET_BANDWIDTH(&rate));
235   *
236   * opus_encoder_ctl(enc_ctx, OPUS_RESET_STATE);
237   * @endcode
238   *
239   * @see opus_genericctls, opus_encoder
240   * @{
241   */
242
243 /** Configures the encoder's computational complexity.
244   * The supported range is 0-10 inclusive with 10 representing the highest complexity.
245   * @see OPUS_GET_COMPLEXITY
246   * @param[in] x <tt>opus_int32</tt>: Allowed values: 0-10, inclusive.
247   *
248   * @hideinitializer */
249 #define OPUS_SET_COMPLEXITY(x) OPUS_SET_COMPLEXITY_REQUEST, __opus_check_int(x)
250 /** Gets the encoder's complexity configuration.
251   * @see OPUS_SET_COMPLEXITY
252   * @param[out] x <tt>opus_int32 *</tt>: Returns a value in the range 0-10,
253   *                                      inclusive.
254   * @hideinitializer */
255 #define OPUS_GET_COMPLEXITY(x) OPUS_GET_COMPLEXITY_REQUEST, __opus_check_int_ptr(x)
256
257 /** Configures the bitrate in the encoder.
258   * Rates from 500 to 512000 bits per second are meaningful, as well as the
259   * special values #OPUS_AUTO and #OPUS_BITRATE_MAX.
260   * The value #OPUS_BITRATE_MAX can be used to cause the codec to use as much
261   * rate as it can, which is useful for controlling the rate by adjusting the
262   * output buffer size.
263   * @see OPUS_GET_BITRATE
264   * @param[in] x <tt>opus_int32</tt>: Bitrate in bits per second. The default
265   *                                   is determined based on the number of
266   *                                   channels and the input sampling rate.
267   * @hideinitializer */
268 #define OPUS_SET_BITRATE(x) OPUS_SET_BITRATE_REQUEST, __opus_check_int(x)
269 /** Gets the encoder's bitrate configuration.
270   * @see OPUS_SET_BITRATE
271   * @param[out] x <tt>opus_int32 *</tt>: Returns the bitrate in bits per second.
272   *                                      The default is determined based on the
273   *                                      number of channels and the input
274   *                                      sampling rate.
275   * @hideinitializer */
276 #define OPUS_GET_BITRATE(x) OPUS_GET_BITRATE_REQUEST, __opus_check_int_ptr(x)
277
278 /** Enables or disables variable bitrate (VBR) in the encoder.
279   * The configured bitrate may not be met exactly because frames must
280   * be an integer number of bytes in length.
281   * @see OPUS_GET_VBR
282   * @see OPUS_SET_VBR_CONSTRAINT
283   * @param[in] x <tt>opus_int32</tt>: Allowed values:
284   * <dl>
285   * <dt>0</dt><dd>Hard CBR. For LPC/hybrid modes at very low bit-rate, this can
286   *               cause noticeable quality degradation.</dd>
287   * <dt>1</dt><dd>VBR (default). The exact type of VBR is controlled by
288   *               #OPUS_SET_VBR_CONSTRAINT.</dd>
289   * </dl>
290   * @hideinitializer */
291 #define OPUS_SET_VBR(x) OPUS_SET_VBR_REQUEST, __opus_check_int(x)
292 /** Determine if variable bitrate (VBR) is enabled in the encoder.
293   * @see OPUS_SET_VBR
294   * @see OPUS_GET_VBR_CONSTRAINT
295   * @param[out] x <tt>opus_int32 *</tt>: Returns one of the following values:
296   * <dl>
297   * <dt>0</dt><dd>Hard CBR.</dd>
298   * <dt>1</dt><dd>VBR (default). The exact type of VBR may be retrieved via
299   *               #OPUS_GET_VBR_CONSTRAINT.</dd>
300   * </dl>
301   * @hideinitializer */
302 #define OPUS_GET_VBR(x) OPUS_GET_VBR_REQUEST, __opus_check_int_ptr(x)
303
304 /** Enables or disables constrained VBR in the encoder.
305   * This setting is ignored when the encoder is in CBR mode.
306   * @warning Only the MDCT mode of Opus currently heeds the constraint.
307   *  Speech mode ignores it completely, hybrid mode may fail to obey it
308   *  if the LPC layer uses more bitrate than the constraint would have
309   *  permitted.
310   * @see OPUS_GET_VBR_CONSTRAINT
311   * @see OPUS_SET_VBR
312   * @param[in] x <tt>opus_int32</tt>: Allowed values:
313   * <dl>
314   * <dt>0</dt><dd>Unconstrained VBR.</dd>
315   * <dt>1</dt><dd>Constrained VBR (default). This creates a maximum of one
316   *               frame of buffering delay assuming a transport with a
317   *               serialization speed of the nominal bitrate.</dd>
318   * </dl>
319   * @hideinitializer */
320 #define OPUS_SET_VBR_CONSTRAINT(x) OPUS_SET_VBR_CONSTRAINT_REQUEST, __opus_check_int(x)
321 /** Determine if constrained VBR is enabled in the encoder.
322   * @see OPUS_SET_VBR_CONSTRAINT
323   * @see OPUS_GET_VBR
324   * @param[out] x <tt>opus_int32 *</tt>: Returns one of the following values:
325   * <dl>
326   * <dt>0</dt><dd>Unconstrained VBR.</dd>
327   * <dt>1</dt><dd>Constrained VBR (default).</dd>
328   * </dl>
329   * @hideinitializer */
330 #define OPUS_GET_VBR_CONSTRAINT(x) OPUS_GET_VBR_CONSTRAINT_REQUEST, __opus_check_int_ptr(x)
331
332 /** Configures mono/stereo forcing in the encoder.
333   * This can force the encoder to produce packets encoded as either mono or
334   * stereo, regardless of the format of the input audio. This is useful when
335   * the caller knows that the input signal is currently a mono source embedded
336   * in a stereo stream.
337   * @see OPUS_GET_FORCE_CHANNELS
338   * @param[in] x <tt>opus_int32</tt>: Allowed values:
339   * <dl>
340   * <dt>#OPUS_AUTO</dt><dd>Not forced (default)</dd>
341   * <dt>1</dt>         <dd>Forced mono</dd>
342   * <dt>2</dt>         <dd>Forced stereo</dd>
343   * </dl>
344   * @hideinitializer */
345 #define OPUS_SET_FORCE_CHANNELS(x) OPUS_SET_FORCE_CHANNELS_REQUEST, __opus_check_int(x)
346 /** Gets the encoder's forced channel configuration.
347   * @see OPUS_SET_FORCE_CHANNELS
348   * @param[out] x <tt>opus_int32 *</tt>:
349   * <dl>
350   * <dt>#OPUS_AUTO</dt><dd>Not forced (default)</dd>
351   * <dt>1</dt>         <dd>Forced mono</dd>
352   * <dt>2</dt>         <dd>Forced stereo</dd>
353   * </dl>
354   * @hideinitializer */
355 #define OPUS_GET_FORCE_CHANNELS(x) OPUS_GET_FORCE_CHANNELS_REQUEST, __opus_check_int_ptr(x)
356
357 /** Configures the maximum bandpass that the encoder will select automatically.
358   * Applications should normally use this instead of #OPUS_SET_BANDWIDTH
359   * (leaving that set to the default, #OPUS_AUTO). This allows the
360   * application to set an upper bound based on the type of input it is
361   * providing, but still gives the encoder the freedom to reduce the bandpass
362   * when the bitrate becomes too low, for better overall quality.
363   * @see OPUS_GET_MAX_BANDWIDTH
364   * @param[in] x <tt>opus_int32</tt>: Allowed values:
365   * <dl>
366   * <dt>OPUS_BANDWIDTH_NARROWBAND</dt>    <dd>4 kHz passband</dd>
367   * <dt>OPUS_BANDWIDTH_MEDIUMBAND</dt>    <dd>6 kHz passband</dd>
368   * <dt>OPUS_BANDWIDTH_WIDEBAND</dt>      <dd>8 kHz passband</dd>
369   * <dt>OPUS_BANDWIDTH_SUPERWIDEBAND</dt><dd>12 kHz passband</dd>
370   * <dt>OPUS_BANDWIDTH_FULLBAND</dt>     <dd>20 kHz passband (default)</dd>
371   * </dl>
372   * @hideinitializer */
373 #define OPUS_SET_MAX_BANDWIDTH(x) OPUS_SET_MAX_BANDWIDTH_REQUEST, __opus_check_int(x)
374
375 /** Gets the encoder's configured maximum allowed bandpass.
376   * @see OPUS_SET_MAX_BANDWIDTH
377   * @param[out] x <tt>opus_int32 *</tt>: Allowed values:
378   * <dl>
379   * <dt>#OPUS_BANDWIDTH_NARROWBAND</dt>    <dd>4 kHz passband</dd>
380   * <dt>#OPUS_BANDWIDTH_MEDIUMBAND</dt>    <dd>6 kHz passband</dd>
381   * <dt>#OPUS_BANDWIDTH_WIDEBAND</dt>      <dd>8 kHz passband</dd>
382   * <dt>#OPUS_BANDWIDTH_SUPERWIDEBAND</dt><dd>12 kHz passband</dd>
383   * <dt>#OPUS_BANDWIDTH_FULLBAND</dt>     <dd>20 kHz passband (default)</dd>
384   * </dl>
385   * @hideinitializer */
386 #define OPUS_GET_MAX_BANDWIDTH(x) OPUS_GET_MAX_BANDWIDTH_REQUEST, __opus_check_int_ptr(x)
387
388 /** Sets the encoder's bandpass to a specific value.
389   * This prevents the encoder from automatically selecting the bandpass based
390   * on the available bitrate. If an application knows the bandpass of the input
391   * audio it is providing, it should normally use #OPUS_SET_MAX_BANDWIDTH
392   * instead, which still gives the encoder the freedom to reduce the bandpass
393   * when the bitrate becomes too low, for better overall quality.
394   * @see OPUS_GET_BANDWIDTH
395   * @param[in] x <tt>opus_int32</tt>: Allowed values:
396   * <dl>
397   * <dt>#OPUS_AUTO</dt>                    <dd>(default)</dd>
398   * <dt>#OPUS_BANDWIDTH_NARROWBAND</dt>    <dd>4 kHz passband</dd>
399   * <dt>#OPUS_BANDWIDTH_MEDIUMBAND</dt>    <dd>6 kHz passband</dd>
400   * <dt>#OPUS_BANDWIDTH_WIDEBAND</dt>      <dd>8 kHz passband</dd>
401   * <dt>#OPUS_BANDWIDTH_SUPERWIDEBAND</dt><dd>12 kHz passband</dd>
402   * <dt>#OPUS_BANDWIDTH_FULLBAND</dt>     <dd>20 kHz passband</dd>
403   * </dl>
404   * @hideinitializer */
405 #define OPUS_SET_BANDWIDTH(x) OPUS_SET_BANDWIDTH_REQUEST, __opus_check_int(x)
406
407 /** Configures the type of signal being encoded.
408   * This is a hint which helps the encoder's mode selection.
409   * @see OPUS_GET_SIGNAL
410   * @param[in] x <tt>opus_int32</tt>: Allowed values:
411   * <dl>
412   * <dt>#OPUS_AUTO</dt>        <dd>(default)</dd>
413   * <dt>#OPUS_SIGNAL_VOICE</dt><dd>Bias thresholds towards choosing LPC or Hybrid modes.</dd>
414   * <dt>#OPUS_SIGNAL_MUSIC</dt><dd>Bias thresholds towards choosing MDCT modes.</dd>
415   * </dl>
416   * @hideinitializer */
417 #define OPUS_SET_SIGNAL(x) OPUS_SET_SIGNAL_REQUEST, __opus_check_int(x)
418 /** Gets the encoder's configured signal type.
419   * @see OPUS_SET_SIGNAL
420   * @param[out] x <tt>opus_int32 *</tt>: Returns one of the following values:
421   * <dl>
422   * <dt>#OPUS_AUTO</dt>        <dd>(default)</dd>
423   * <dt>#OPUS_SIGNAL_VOICE</dt><dd>Bias thresholds towards choosing LPC or Hybrid modes.</dd>
424   * <dt>#OPUS_SIGNAL_MUSIC</dt><dd>Bias thresholds towards choosing MDCT modes.</dd>
425   * </dl>
426   * @hideinitializer */
427 #define OPUS_GET_SIGNAL(x) OPUS_GET_SIGNAL_REQUEST, __opus_check_int_ptr(x)
428
429
430 /** Configures the encoder's intended application.
431   * The initial value is a mandatory argument to the encoder_create function.
432   * @see OPUS_GET_APPLICATION
433   * @param[in] x <tt>opus_int32</tt>: Returns one of the following values:
434   * <dl>
435   * <dt>#OPUS_APPLICATION_VOIP</dt>
436   * <dd>Process signal for improved speech intelligibility.</dd>
437   * <dt>#OPUS_APPLICATION_AUDIO</dt>
438   * <dd>Favor faithfulness to the original input.</dd>
439   * <dt>#OPUS_APPLICATION_RESTRICTED_LOWDELAY</dt>
440   * <dd>Configure the minimum possible coding delay by disabling certain modes
441   * of operation.</dd>
442   * </dl>
443   * @hideinitializer */
444 #define OPUS_SET_APPLICATION(x) OPUS_SET_APPLICATION_REQUEST, __opus_check_int(x)
445 /** Gets the encoder's configured application.
446   * @see OPUS_SET_APPLICATION
447   * @param[out] x <tt>opus_int32 *</tt>: Returns one of the following values:
448   * <dl>
449   * <dt>#OPUS_APPLICATION_VOIP</dt>
450   * <dd>Process signal for improved speech intelligibility.</dd>
451   * <dt>#OPUS_APPLICATION_AUDIO</dt>
452   * <dd>Favor faithfulness to the original input.</dd>
453   * <dt>#OPUS_APPLICATION_RESTRICTED_LOWDELAY</dt>
454   * <dd>Configure the minimum possible coding delay by disabling certain modes
455   * of operation.</dd>
456   * </dl>
457   * @hideinitializer */
458 #define OPUS_GET_APPLICATION(x) OPUS_GET_APPLICATION_REQUEST, __opus_check_int_ptr(x)
459
460 /** Gets the total samples of delay added by the entire codec.
461   * This can be queried by the encoder and then the provided number of samples can be
462   * skipped on from the start of the decoder's output to provide time aligned input
463   * and output. From the perspective of a decoding application the real data begins this many
464   * samples late.
465   *
466   * The decoder contribution to this delay is identical for all decoders, but the
467   * encoder portion of the delay may vary from implementation to implementation,
468   * version to version, or even depend on the encoder's initial configuration.
469   * Applications needing delay compensation should call this CTL rather than
470   * hard-coding a value.
471   * @param[out] x <tt>opus_int32 *</tt>:   Number of lookahead samples
472   * @hideinitializer */
473 #define OPUS_GET_LOOKAHEAD(x) OPUS_GET_LOOKAHEAD_REQUEST, __opus_check_int_ptr(x)
474
475 /** Configures the encoder's use of inband forward error correction (FEC).
476   * @note This is only applicable to the LPC layer
477   * @see OPUS_GET_INBAND_FEC
478   * @param[in] x <tt>opus_int32</tt>: Allowed values:
479   * <dl>
480   * <dt>0</dt><dd>Disable inband FEC (default).</dd>
481   * <dt>1</dt><dd>Enable inband FEC.</dd>
482   * </dl>
483   * @hideinitializer */
484 #define OPUS_SET_INBAND_FEC(x) OPUS_SET_INBAND_FEC_REQUEST, __opus_check_int(x)
485 /** Gets encoder's configured use of inband forward error correction.
486   * @see OPUS_SET_INBAND_FEC
487   * @param[out] x <tt>opus_int32 *</tt>: Returns one of the following values:
488   * <dl>
489   * <dt>0</dt><dd>Inband FEC disabled (default).</dd>
490   * <dt>1</dt><dd>Inband FEC enabled.</dd>
491   * </dl>
492   * @hideinitializer */
493 #define OPUS_GET_INBAND_FEC(x) OPUS_GET_INBAND_FEC_REQUEST, __opus_check_int_ptr(x)
494
495 /** Configures the encoder's expected packet loss percentage.
496   * Higher values trigger progressively more loss resistant behavior in the encoder
497   * at the expense of quality at a given bitrate in the absence of packet loss, but
498   * greater quality under loss.
499   * @see OPUS_GET_PACKET_LOSS_PERC
500   * @param[in] x <tt>opus_int32</tt>:   Loss percentage in the range 0-100, inclusive (default: 0).
501   * @hideinitializer */
502 #define OPUS_SET_PACKET_LOSS_PERC(x) OPUS_SET_PACKET_LOSS_PERC_REQUEST, __opus_check_int(x)
503 /** Gets the encoder's configured packet loss percentage.
504   * @see OPUS_SET_PACKET_LOSS_PERC
505   * @param[out] x <tt>opus_int32 *</tt>: Returns the configured loss percentage
506   *                                      in the range 0-100, inclusive (default: 0).
507   * @hideinitializer */
508 #define OPUS_GET_PACKET_LOSS_PERC(x) OPUS_GET_PACKET_LOSS_PERC_REQUEST, __opus_check_int_ptr(x)
509
510 /** Configures the encoder's use of discontinuous transmission (DTX).
511   * @note This is only applicable to the LPC layer
512   * @see OPUS_GET_DTX
513   * @param[in] x <tt>opus_int32</tt>: Allowed values:
514   * <dl>
515   * <dt>0</dt><dd>Disable DTX (default).</dd>
516   * <dt>1</dt><dd>Enabled DTX.</dd>
517   * </dl>
518   * @hideinitializer */
519 #define OPUS_SET_DTX(x) OPUS_SET_DTX_REQUEST, __opus_check_int(x)
520 /** Gets encoder's configured use of discontinuous transmission.
521   * @see OPUS_SET_DTX
522   * @param[out] x <tt>opus_int32 *</tt>: Returns one of the following values:
523   * <dl>
524   * <dt>0</dt><dd>DTX disabled (default).</dd>
525   * <dt>1</dt><dd>DTX enabled.</dd>
526   * </dl>
527   * @hideinitializer */
528 #define OPUS_GET_DTX(x) OPUS_GET_DTX_REQUEST, __opus_check_int_ptr(x)
529 /** Configures the depth of signal being encoded.
530   *
531   * This is a hint which helps the encoder identify silence and near-silence.
532   * It represents the number of significant bits of linear intensity below
533   * which the signal contains ignorable quantization or other noise.
534   *
535   * For example, OPUS_SET_LSB_DEPTH(14) would be an appropriate setting
536   * for G.711 u-law input. OPUS_SET_LSB_DEPTH(16) would be appropriate
537   * for 16-bit linear pcm input with opus_encode_float().
538   *
539   * When using opus_encode() instead of opus_encode_float(), or when libopus
540   * is compiled for fixed-point, the encoder uses the minimum of the value
541   * set here and the value 16.
542   *
543   * @see OPUS_GET_LSB_DEPTH
544   * @param[in] x <tt>opus_int32</tt>: Input precision in bits, between 8 and 24
545   *                                   (default: 24).
546   * @hideinitializer */
547 #define OPUS_SET_LSB_DEPTH(x) OPUS_SET_LSB_DEPTH_REQUEST, __opus_check_int(x)
548 /** Gets the encoder's configured signal depth.
549   * @see OPUS_SET_LSB_DEPTH
550   * @param[out] x <tt>opus_int32 *</tt>: Input precision in bits, between 8 and
551   *                                      24 (default: 24).
552   * @hideinitializer */
553 #define OPUS_GET_LSB_DEPTH(x) OPUS_GET_LSB_DEPTH_REQUEST, __opus_check_int_ptr(x)
554
555 /** Configures the encoder's use of variable duration frames.
556   * When variable duration is enabled, the encoder is free to use a shorter frame
557   * size than the one requested in the opus_encode*() call.
558   * It is then the user's responsibility
559   * to verify how much audio was encoded by checking the ToC byte of the encoded
560   * packet. The part of the audio that was not encoded needs to be resent to the
561   * encoder for the next call. Do not use this option unless you <b>really</b>
562   * know what you are doing.
563   * @see OPUS_GET_EXPERT_FRAME_DURATION
564   * @param[in] x <tt>opus_int32</tt>: Allowed values:
565   * <dl>
566   * <dt>OPUS_FRAMESIZE_ARG</dt><dd>Select frame size from the argument (default).</dd>
567   * <dt>OPUS_FRAMESIZE_2_5_MS</dt><dd>Use 2.5 ms frames.</dd>
568   * <dt>OPUS_FRAMESIZE_5_MS</dt><dd>Use 5 ms frames.</dd>
569   * <dt>OPUS_FRAMESIZE_10_MS</dt><dd>Use 10 ms frames.</dd>
570   * <dt>OPUS_FRAMESIZE_20_MS</dt><dd>Use 20 ms frames.</dd>
571   * <dt>OPUS_FRAMESIZE_40_MS</dt><dd>Use 40 ms frames.</dd>
572   * <dt>OPUS_FRAMESIZE_60_MS</dt><dd>Use 60 ms frames.</dd>
573   * <dt>OPUS_FRAMESIZE_80_MS</dt><dd>Use 80 ms frames.</dd>
574   * <dt>OPUS_FRAMESIZE_100_MS</dt><dd>Use 100 ms frames.</dd>
575   * <dt>OPUS_FRAMESIZE_120_MS</dt><dd>Use 120 ms frames.</dd>
576   * <dt>OPUS_FRAMESIZE_VARIABLE</dt><dd>Optimize the frame size dynamically.</dd>
577   * </dl>
578   * @hideinitializer */
579 #define OPUS_SET_EXPERT_FRAME_DURATION(x) OPUS_SET_EXPERT_FRAME_DURATION_REQUEST, __opus_check_int(x)
580 /** Gets the encoder's configured use of variable duration frames.
581   * @see OPUS_SET_EXPERT_FRAME_DURATION
582   * @param[out] x <tt>opus_int32 *</tt>: Returns one of the following values:
583   * <dl>
584   * <dt>OPUS_FRAMESIZE_ARG</dt><dd>Select frame size from the argument (default).</dd>
585   * <dt>OPUS_FRAMESIZE_2_5_MS</dt><dd>Use 2.5 ms frames.</dd>
586   * <dt>OPUS_FRAMESIZE_5_MS</dt><dd>Use 5 ms frames.</dd>
587   * <dt>OPUS_FRAMESIZE_10_MS</dt><dd>Use 10 ms frames.</dd>
588   * <dt>OPUS_FRAMESIZE_20_MS</dt><dd>Use 20 ms frames.</dd>
589   * <dt>OPUS_FRAMESIZE_40_MS</dt><dd>Use 40 ms frames.</dd>
590   * <dt>OPUS_FRAMESIZE_60_MS</dt><dd>Use 60 ms frames.</dd>
591   * <dt>OPUS_FRAMESIZE_80_MS</dt><dd>Use 80 ms frames.</dd>
592   * <dt>OPUS_FRAMESIZE_100_MS</dt><dd>Use 100 ms frames.</dd>
593   * <dt>OPUS_FRAMESIZE_120_MS</dt><dd>Use 120 ms frames.</dd>
594   * <dt>OPUS_FRAMESIZE_VARIABLE</dt><dd>Optimize the frame size dynamically.</dd>
595   * </dl>
596   * @hideinitializer */
597 #define OPUS_GET_EXPERT_FRAME_DURATION(x) OPUS_GET_EXPERT_FRAME_DURATION_REQUEST, __opus_check_int_ptr(x)
598
599 /** If set to 1, disables almost all use of prediction, making frames almost
600   * completely independent. This reduces quality.
601   * @see OPUS_GET_PREDICTION_DISABLED
602   * @param[in] x <tt>opus_int32</tt>: Allowed values:
603   * <dl>
604   * <dt>0</dt><dd>Enable prediction (default).</dd>
605   * <dt>1</dt><dd>Disable prediction.</dd>
606   * </dl>
607   * @hideinitializer */
608 #define OPUS_SET_PREDICTION_DISABLED(x) OPUS_SET_PREDICTION_DISABLED_REQUEST, __opus_check_int(x)
609 /** Gets the encoder's configured prediction status.
610   * @see OPUS_SET_PREDICTION_DISABLED
611   * @param[out] x <tt>opus_int32 *</tt>: Returns one of the following values:
612   * <dl>
613   * <dt>0</dt><dd>Prediction enabled (default).</dd>
614   * <dt>1</dt><dd>Prediction disabled.</dd>
615   * </dl>
616   * @hideinitializer */
617 #define OPUS_GET_PREDICTION_DISABLED(x) OPUS_GET_PREDICTION_DISABLED_REQUEST, __opus_check_int_ptr(x)
618
619 /**@}*/
620
621 /** @defgroup opus_genericctls Generic CTLs
622   *
623   * These macros are used with the \c opus_decoder_ctl and
624   * \c opus_encoder_ctl calls to generate a particular
625   * request.
626   *
627   * When called on an \c OpusDecoder they apply to that
628   * particular decoder instance. When called on an
629   * \c OpusEncoder they apply to the corresponding setting
630   * on that encoder instance, if present.
631   *
632   * Some usage examples:
633   *
634   * @code
635   * int ret;
636   * opus_int32 pitch;
637   * ret = opus_decoder_ctl(dec_ctx, OPUS_GET_PITCH(&pitch));
638   * if (ret == OPUS_OK) return ret;
639   *
640   * opus_encoder_ctl(enc_ctx, OPUS_RESET_STATE);
641   * opus_decoder_ctl(dec_ctx, OPUS_RESET_STATE);
642   *
643   * opus_int32 enc_bw, dec_bw;
644   * opus_encoder_ctl(enc_ctx, OPUS_GET_BANDWIDTH(&enc_bw));
645   * opus_decoder_ctl(dec_ctx, OPUS_GET_BANDWIDTH(&dec_bw));
646   * if (enc_bw != dec_bw) {
647   *   printf("packet bandwidth mismatch!\n");
648   * }
649   * @endcode
650   *
651   * @see opus_encoder, opus_decoder_ctl, opus_encoder_ctl, opus_decoderctls, opus_encoderctls
652   * @{
653   */
654
655 /** Resets the codec state to be equivalent to a freshly initialized state.
656   * This should be called when switching streams in order to prevent
657   * the back to back decoding from giving different results from
658   * one at a time decoding.
659   * @hideinitializer */
660 #define OPUS_RESET_STATE 4028
661
662 /** Gets the final state of the codec's entropy coder.
663   * This is used for testing purposes,
664   * The encoder and decoder state should be identical after coding a payload
665   * (assuming no data corruption or software bugs)
666   *
667   * @param[out] x <tt>opus_uint32 *</tt>: Entropy coder state
668   *
669   * @hideinitializer */
670 #define OPUS_GET_FINAL_RANGE(x) OPUS_GET_FINAL_RANGE_REQUEST, __opus_check_uint_ptr(x)
671
672 /** Gets the encoder's configured bandpass or the decoder's last bandpass.
673   * @see OPUS_SET_BANDWIDTH
674   * @param[out] x <tt>opus_int32 *</tt>: Returns one of the following values:
675   * <dl>
676   * <dt>#OPUS_AUTO</dt>                    <dd>(default)</dd>
677   * <dt>#OPUS_BANDWIDTH_NARROWBAND</dt>    <dd>4 kHz passband</dd>
678   * <dt>#OPUS_BANDWIDTH_MEDIUMBAND</dt>    <dd>6 kHz passband</dd>
679   * <dt>#OPUS_BANDWIDTH_WIDEBAND</dt>      <dd>8 kHz passband</dd>
680   * <dt>#OPUS_BANDWIDTH_SUPERWIDEBAND</dt><dd>12 kHz passband</dd>
681   * <dt>#OPUS_BANDWIDTH_FULLBAND</dt>     <dd>20 kHz passband</dd>
682   * </dl>
683   * @hideinitializer */
684 #define OPUS_GET_BANDWIDTH(x) OPUS_GET_BANDWIDTH_REQUEST, __opus_check_int_ptr(x)
685
686 /** Gets the sampling rate the encoder or decoder was initialized with.
687   * This simply returns the <code>Fs</code> value passed to opus_encoder_init()
688   * or opus_decoder_init().
689   * @param[out] x <tt>opus_int32 *</tt>: Sampling rate of encoder or decoder.
690   * @hideinitializer
691   */
692 #define OPUS_GET_SAMPLE_RATE(x) OPUS_GET_SAMPLE_RATE_REQUEST, __opus_check_int_ptr(x)
693
694 /** If set to 1, disables the use of phase inversion for intensity stereo,
695   * improving the quality of mono downmixes, but slightly reducing normal
696   * stereo quality. Disabling phase inversion in the decoder does not comply
697   * with RFC 6716, although it does not cause any interoperability issue and
698   * is expected to become part of the Opus standard once RFC 6716 is updated
699   * by draft-ietf-codec-opus-update.
700   * @see OPUS_GET_PHASE_INVERSION_DISABLED
701   * @param[in] x <tt>opus_int32</tt>: Allowed values:
702   * <dl>
703   * <dt>0</dt><dd>Enable phase inversion (default).</dd>
704   * <dt>1</dt><dd>Disable phase inversion.</dd>
705   * </dl>
706   * @hideinitializer */
707 #define OPUS_SET_PHASE_INVERSION_DISABLED(x) OPUS_SET_PHASE_INVERSION_DISABLED_REQUEST, __opus_check_int(x)
708 /** Gets the encoder's configured phase inversion status.
709   * @see OPUS_SET_PHASE_INVERSION_DISABLED
710   * @param[out] x <tt>opus_int32 *</tt>: Returns one of the following values:
711   * <dl>
712   * <dt>0</dt><dd>Stereo phase inversion enabled (default).</dd>
713   * <dt>1</dt><dd>Stereo phase inversion disabled.</dd>
714   * </dl>
715   * @hideinitializer */
716 #define OPUS_GET_PHASE_INVERSION_DISABLED(x) OPUS_GET_PHASE_INVERSION_DISABLED_REQUEST, __opus_check_int_ptr(x)
717
718 /**@}*/
719
720 /** @defgroup opus_decoderctls Decoder related CTLs
721   * @see opus_genericctls, opus_encoderctls, opus_decoder
722   * @{
723   */
724
725 /** Configures decoder gain adjustment.
726   * Scales the decoded output by a factor specified in Q8 dB units.
727   * This has a maximum range of -32768 to 32767 inclusive, and returns
728   * OPUS_BAD_ARG otherwise. The default is zero indicating no adjustment.
729   * This setting survives decoder reset.
730   *
731   * gain = pow(10, x/(20.0*256))
732   *
733   * @param[in] x <tt>opus_int32</tt>:   Amount to scale PCM signal by in Q8 dB units.
734   * @hideinitializer */
735 #define OPUS_SET_GAIN(x) OPUS_SET_GAIN_REQUEST, __opus_check_int(x)
736 /** Gets the decoder's configured gain adjustment. @see OPUS_SET_GAIN
737   *
738   * @param[out] x <tt>opus_int32 *</tt>: Amount to scale PCM signal by in Q8 dB units.
739   * @hideinitializer */
740 #define OPUS_GET_GAIN(x) OPUS_GET_GAIN_REQUEST, __opus_check_int_ptr(x)
741
742 /** Gets the duration (in samples) of the last packet successfully decoded or concealed.
743   * @param[out] x <tt>opus_int32 *</tt>: Number of samples (at current sampling rate).
744   * @hideinitializer */
745 #define OPUS_GET_LAST_PACKET_DURATION(x) OPUS_GET_LAST_PACKET_DURATION_REQUEST, __opus_check_int_ptr(x)
746
747 /** Gets the pitch of the last decoded frame, if available.
748   * This can be used for any post-processing algorithm requiring the use of pitch,
749   * e.g. time stretching/shortening. If the last frame was not voiced, or if the
750   * pitch was not coded in the frame, then zero is returned.
751   *
752   * This CTL is only implemented for decoder instances.
753   *
754   * @param[out] x <tt>opus_int32 *</tt>: pitch period at 48 kHz (or 0 if not available)
755   *
756   * @hideinitializer */
757 #define OPUS_GET_PITCH(x) OPUS_GET_PITCH_REQUEST, __opus_check_int_ptr(x)
758
759 /**@}*/
760
761 /** @defgroup opus_libinfo Opus library information functions
762   * @{
763   */
764
765 /** Converts an opus error code into a human readable string.
766   *
767   * @param[in] error <tt>int</tt>: Error number
768   * @returns Error string
769   */
770 OPUS_EXPORT const char *opus_strerror(int error);
771
772 /** Gets the libopus version string.
773   *
774   * Applications may look for the substring "-fixed" in the version string to
775   * determine whether they have a fixed-point or floating-point build at
776   * runtime.
777   *
778   * @returns Version string
779   */
780 OPUS_EXPORT const char *opus_get_version_string(void);
781 /**@}*/
782
783 #ifdef __cplusplus
784 }
785 #endif
786
787 #endif /* OPUS_DEFINES_H */