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