opus_defines.h 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692
  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. - Redistributions of source code must retain the above copyright
  8. notice, this list of conditions and the following disclaimer.
  9. - Redistributions in binary form must reproduce the above copyright
  10. notice, this list of conditions and the following disclaimer in the
  11. documentation and/or other materials provided with the distribution.
  12. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  13. ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  14. LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  15. A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
  16. OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  17. EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  18. PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  19. PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  20. LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  21. NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  22. SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  23. */
  24. /**
  25. * @file opus_defines.h
  26. * @brief Opus reference implementation constants
  27. */
  28. #ifndef OPUS_DEFINES_H
  29. #define OPUS_DEFINES_H
  30. #include "opus_types.h"
  31. #ifdef __cplusplus
  32. extern "C" {
  33. #endif
  34. /** @defgroup opus_errorcodes Error codes
  35. * @{
  36. */
  37. /** No error @hideinitializer*/
  38. #define OPUS_OK 0
  39. /** One or more invalid/out of range arguments @hideinitializer*/
  40. #define OPUS_BAD_ARG -1
  41. /** The mode struct passed is invalid @hideinitializer*/
  42. #define OPUS_BUFFER_TOO_SMALL -2
  43. /** An internal error was detected @hideinitializer*/
  44. #define OPUS_INTERNAL_ERROR -3
  45. /** The compressed data passed is corrupted @hideinitializer*/
  46. #define OPUS_INVALID_PACKET -4
  47. /** Invalid/unsupported request number @hideinitializer*/
  48. #define OPUS_UNIMPLEMENTED -5
  49. /** An encoder or decoder structure is invalid or already freed @hideinitializer*/
  50. #define OPUS_INVALID_STATE -6
  51. /** Memory allocation has failed @hideinitializer*/
  52. #define OPUS_ALLOC_FAIL -7
  53. /**@}*/
  54. /** @cond OPUS_INTERNAL_DOC */
  55. /**Export control for opus functions */
  56. #ifndef OPUS_EXPORT
  57. # if defined(__GNUC__) && defined(OPUS_BUILD)
  58. # define OPUS_EXPORT __attribute__ ((visibility ("default")))
  59. # elif defined(WIN32) && !defined(__MINGW32__)
  60. # ifdef OPUS_BUILD
  61. # define OPUS_EXPORT __declspec(dllexport)
  62. # else
  63. # define OPUS_EXPORT
  64. # endif
  65. # else
  66. # define OPUS_EXPORT
  67. # endif
  68. #endif
  69. # if !defined(OPUS_GNUC_PREREQ)
  70. # if defined(__GNUC__)&&defined(__GNUC_MINOR__)
  71. # define OPUS_GNUC_PREREQ(_maj,_min) \
  72. ((__GNUC__<<16)+__GNUC_MINOR__>=((_maj)<<16)+(_min))
  73. # else
  74. # define OPUS_GNUC_PREREQ(_maj,_min) 0
  75. # endif
  76. # endif
  77. #if (!defined(__STDC_VERSION__) || (__STDC_VERSION__ < 199901L) )
  78. # if OPUS_GNUC_PREREQ(3,0)
  79. # define OPUS_RESTRICT __restrict__
  80. # elif (defined(_MSC_VER) && _MSC_VER >= 1400)
  81. # define OPUS_RESTRICT __restrict
  82. # else
  83. # define OPUS_RESTRICT
  84. # endif
  85. #else
  86. # define OPUS_RESTRICT restrict
  87. #endif
  88. /**Warning attributes for opus functions
  89. * NONNULL is not used in OPUS_BUILD to avoid the compiler optimizing out
  90. * some paranoid null checks. */
  91. #if defined(__GNUC__) && OPUS_GNUC_PREREQ(3, 4)
  92. # define OPUS_WARN_UNUSED_RESULT __attribute__ ((__warn_unused_result__))
  93. #else
  94. # define OPUS_WARN_UNUSED_RESULT
  95. #endif
  96. #if !defined(OPUS_BUILD) && defined(__GNUC__) && OPUS_GNUC_PREREQ(3, 4)
  97. # define OPUS_ARG_NONNULL(_x) __attribute__ ((__nonnull__(_x)))
  98. #else
  99. # define OPUS_ARG_NONNULL(_x)
  100. #endif
  101. /** These are the actual Encoder CTL ID numbers.
  102. * They should not be used directly by applications.
  103. * In general, SETs should be even and GETs should be odd.*/
  104. #define OPUS_SET_APPLICATION_REQUEST 4000
  105. #define OPUS_GET_APPLICATION_REQUEST 4001
  106. #define OPUS_SET_BITRATE_REQUEST 4002
  107. #define OPUS_GET_BITRATE_REQUEST 4003
  108. #define OPUS_SET_MAX_BANDWIDTH_REQUEST 4004
  109. #define OPUS_GET_MAX_BANDWIDTH_REQUEST 4005
  110. #define OPUS_SET_VBR_REQUEST 4006
  111. #define OPUS_GET_VBR_REQUEST 4007
  112. #define OPUS_SET_BANDWIDTH_REQUEST 4008
  113. #define OPUS_GET_BANDWIDTH_REQUEST 4009
  114. #define OPUS_SET_COMPLEXITY_REQUEST 4010
  115. #define OPUS_GET_COMPLEXITY_REQUEST 4011
  116. #define OPUS_SET_INBAND_FEC_REQUEST 4012
  117. #define OPUS_GET_INBAND_FEC_REQUEST 4013
  118. #define OPUS_SET_PACKET_LOSS_PERC_REQUEST 4014
  119. #define OPUS_GET_PACKET_LOSS_PERC_REQUEST 4015
  120. #define OPUS_SET_DTX_REQUEST 4016
  121. #define OPUS_GET_DTX_REQUEST 4017
  122. #define OPUS_SET_VBR_CONSTRAINT_REQUEST 4020
  123. #define OPUS_GET_VBR_CONSTRAINT_REQUEST 4021
  124. #define OPUS_SET_FORCE_CHANNELS_REQUEST 4022
  125. #define OPUS_GET_FORCE_CHANNELS_REQUEST 4023
  126. #define OPUS_SET_SIGNAL_REQUEST 4024
  127. #define OPUS_GET_SIGNAL_REQUEST 4025
  128. #define OPUS_GET_LOOKAHEAD_REQUEST 4027
  129. /* #define OPUS_RESET_STATE 4028 */
  130. #define OPUS_GET_SAMPLE_RATE_REQUEST 4029
  131. #define OPUS_GET_FINAL_RANGE_REQUEST 4031
  132. #define OPUS_GET_PITCH_REQUEST 4033
  133. #define OPUS_SET_GAIN_REQUEST 4034
  134. #define OPUS_GET_GAIN_REQUEST 4045 /* Should have been 4035 */
  135. #define OPUS_SET_LSB_DEPTH_REQUEST 4036
  136. #define OPUS_GET_LSB_DEPTH_REQUEST 4037
  137. #define OPUS_GET_LAST_PACKET_DURATION_REQUEST 4039
  138. #define OPUS_SET_EXPERT_FRAME_DURATION_REQUEST 4040
  139. #define OPUS_GET_EXPERT_FRAME_DURATION_REQUEST 4041
  140. /* Don't use 4045, it's already taken by OPUS_GET_GAIN_REQUEST */
  141. /* Macros to trigger compilation errors when the wrong types are provided to a CTL */
  142. #define __opus_check_int(x) (((void)((x) == (opus_int32)0)), (opus_int32)(x))
  143. #define __opus_check_int_ptr(ptr) ((ptr) + ((ptr) - (opus_int32*)(ptr)))
  144. #define __opus_check_uint_ptr(ptr) ((ptr) + ((ptr) - (opus_uint32*)(ptr)))
  145. /** @endcond */
  146. /** @defgroup opus_ctlvalues Pre-defined values for CTL interface
  147. * @see opus_genericctls, opus_encoderctls
  148. * @{
  149. */
  150. /* Values for the various encoder CTLs */
  151. #define OPUS_AUTO -1000 /**<Auto/default setting @hideinitializer*/
  152. #define OPUS_BITRATE_MAX -1 /**<Maximum bitrate @hideinitializer*/
  153. /** Best for most VoIP/videoconference applications where listening quality and intelligibility matter most
  154. * @hideinitializer */
  155. #define OPUS_APPLICATION_VOIP 2048
  156. /** Best for broadcast/high-fidelity application where the decoded audio should be as close as possible to the input
  157. * @hideinitializer */
  158. #define OPUS_APPLICATION_AUDIO 2049
  159. /** Only use when lowest-achievable latency is what matters most. Voice-optimized modes cannot be used.
  160. * @hideinitializer */
  161. #define OPUS_APPLICATION_RESTRICTED_LOWDELAY 2051
  162. #define OPUS_SIGNAL_VOICE 3001 /**< Signal being encoded is voice */
  163. #define OPUS_SIGNAL_MUSIC 3002 /**< Signal being encoded is music */
  164. #define OPUS_BANDWIDTH_NARROWBAND 1101 /**< 4 kHz bandpass @hideinitializer*/
  165. #define OPUS_BANDWIDTH_MEDIUMBAND 1102 /**< 6 kHz bandpass @hideinitializer*/
  166. #define OPUS_BANDWIDTH_WIDEBAND 1103 /**< 8 kHz bandpass @hideinitializer*/
  167. #define OPUS_BANDWIDTH_SUPERWIDEBAND 1104 /**<12 kHz bandpass @hideinitializer*/
  168. #define OPUS_BANDWIDTH_FULLBAND 1105 /**<20 kHz bandpass @hideinitializer*/
  169. #define OPUS_FRAMESIZE_ARG 5000 /**< Select frame size from the argument (default) */
  170. #define OPUS_FRAMESIZE_2_5_MS 5001 /**< Use 2.5 ms frames */
  171. #define OPUS_FRAMESIZE_5_MS 5002 /**< Use 5 ms frames */
  172. #define OPUS_FRAMESIZE_10_MS 5003 /**< Use 10 ms frames */
  173. #define OPUS_FRAMESIZE_20_MS 5004 /**< Use 20 ms frames */
  174. #define OPUS_FRAMESIZE_40_MS 5005 /**< Use 40 ms frames */
  175. #define OPUS_FRAMESIZE_60_MS 5006 /**< Use 60 ms frames */
  176. #define OPUS_FRAMESIZE_VARIABLE 5010 /**< Optimize the frame size dynamically */
  177. /**@}*/
  178. /** @defgroup opus_encoderctls Encoder related CTLs
  179. *
  180. * These are convenience macros for use with the \c opus_encode_ctl
  181. * interface. They are used to generate the appropriate series of
  182. * arguments for that call, passing the correct type, size and so
  183. * on as expected for each particular request.
  184. *
  185. * Some usage examples:
  186. *
  187. * @code
  188. * int ret;
  189. * ret = opus_encoder_ctl(enc_ctx, OPUS_SET_BANDWIDTH(OPUS_AUTO));
  190. * if (ret != OPUS_OK) return ret;
  191. *
  192. * opus_int32 rate;
  193. * opus_encoder_ctl(enc_ctx, OPUS_GET_BANDWIDTH(&rate));
  194. *
  195. * opus_encoder_ctl(enc_ctx, OPUS_RESET_STATE);
  196. * @endcode
  197. *
  198. * @see opus_genericctls, opus_encoder
  199. * @{
  200. */
  201. /** Configures the encoder's computational complexity.
  202. * The supported range is 0-10 inclusive with 10 representing the highest complexity.
  203. * @see OPUS_GET_COMPLEXITY
  204. * @param[in] x <tt>opus_int32</tt>: Allowed values: 0-10, inclusive.
  205. *
  206. * @hideinitializer */
  207. #define OPUS_SET_COMPLEXITY(x) OPUS_SET_COMPLEXITY_REQUEST, __opus_check_int(x)
  208. /** Gets the encoder's complexity configuration.
  209. * @see OPUS_SET_COMPLEXITY
  210. * @param[out] x <tt>opus_int32 *</tt>: Returns a value in the range 0-10,
  211. * inclusive.
  212. * @hideinitializer */
  213. #define OPUS_GET_COMPLEXITY(x) OPUS_GET_COMPLEXITY_REQUEST, __opus_check_int_ptr(x)
  214. /** Configures the bitrate in the encoder.
  215. * Rates from 500 to 512000 bits per second are meaningful, as well as the
  216. * special values #OPUS_AUTO and #OPUS_BITRATE_MAX.
  217. * The value #OPUS_BITRATE_MAX can be used to cause the codec to use as much
  218. * rate as it can, which is useful for controlling the rate by adjusting the
  219. * output buffer size.
  220. * @see OPUS_GET_BITRATE
  221. * @param[in] x <tt>opus_int32</tt>: Bitrate in bits per second. The default
  222. * is determined based on the number of
  223. * channels and the input sampling rate.
  224. * @hideinitializer */
  225. #define OPUS_SET_BITRATE(x) OPUS_SET_BITRATE_REQUEST, __opus_check_int(x)
  226. /** Gets the encoder's bitrate configuration.
  227. * @see OPUS_SET_BITRATE
  228. * @param[out] x <tt>opus_int32 *</tt>: Returns the bitrate in bits per second.
  229. * The default is determined based on the
  230. * number of channels and the input
  231. * sampling rate.
  232. * @hideinitializer */
  233. #define OPUS_GET_BITRATE(x) OPUS_GET_BITRATE_REQUEST, __opus_check_int_ptr(x)
  234. /** Enables or disables variable bitrate (VBR) in the encoder.
  235. * The configured bitrate may not be met exactly because frames must
  236. * be an integer number of bytes in length.
  237. * @warning Only the MDCT mode of Opus can provide hard CBR behavior.
  238. * @see OPUS_GET_VBR
  239. * @see OPUS_SET_VBR_CONSTRAINT
  240. * @param[in] x <tt>opus_int32</tt>: Allowed values:
  241. * <dl>
  242. * <dt>0</dt><dd>Hard CBR. For LPC/hybrid modes at very low bit-rate, this can
  243. * cause noticeable quality degradation.</dd>
  244. * <dt>1</dt><dd>VBR (default). The exact type of VBR is controlled by
  245. * #OPUS_SET_VBR_CONSTRAINT.</dd>
  246. * </dl>
  247. * @hideinitializer */
  248. #define OPUS_SET_VBR(x) OPUS_SET_VBR_REQUEST, __opus_check_int(x)
  249. /** Determine if variable bitrate (VBR) is enabled in the encoder.
  250. * @see OPUS_SET_VBR
  251. * @see OPUS_GET_VBR_CONSTRAINT
  252. * @param[out] x <tt>opus_int32 *</tt>: Returns one of the following values:
  253. * <dl>
  254. * <dt>0</dt><dd>Hard CBR.</dd>
  255. * <dt>1</dt><dd>VBR (default). The exact type of VBR may be retrieved via
  256. * #OPUS_GET_VBR_CONSTRAINT.</dd>
  257. * </dl>
  258. * @hideinitializer */
  259. #define OPUS_GET_VBR(x) OPUS_GET_VBR_REQUEST, __opus_check_int_ptr(x)
  260. /** Enables or disables constrained VBR in the encoder.
  261. * This setting is ignored when the encoder is in CBR mode.
  262. * @warning Only the MDCT mode of Opus currently heeds the constraint.
  263. * Speech mode ignores it completely, hybrid mode may fail to obey it
  264. * if the LPC layer uses more bitrate than the constraint would have
  265. * permitted.
  266. * @see OPUS_GET_VBR_CONSTRAINT
  267. * @see OPUS_SET_VBR
  268. * @param[in] x <tt>opus_int32</tt>: Allowed values:
  269. * <dl>
  270. * <dt>0</dt><dd>Unconstrained VBR.</dd>
  271. * <dt>1</dt><dd>Constrained VBR (default). This creates a maximum of one
  272. * frame of buffering delay assuming a transport with a
  273. * serialization speed of the nominal bitrate.</dd>
  274. * </dl>
  275. * @hideinitializer */
  276. #define OPUS_SET_VBR_CONSTRAINT(x) OPUS_SET_VBR_CONSTRAINT_REQUEST, __opus_check_int(x)
  277. /** Determine if constrained VBR is enabled in the encoder.
  278. * @see OPUS_SET_VBR_CONSTRAINT
  279. * @see OPUS_GET_VBR
  280. * @param[out] x <tt>opus_int32 *</tt>: Returns one of the following values:
  281. * <dl>
  282. * <dt>0</dt><dd>Unconstrained VBR.</dd>
  283. * <dt>1</dt><dd>Constrained VBR (default).</dd>
  284. * </dl>
  285. * @hideinitializer */
  286. #define OPUS_GET_VBR_CONSTRAINT(x) OPUS_GET_VBR_CONSTRAINT_REQUEST, __opus_check_int_ptr(x)
  287. /** Configures mono/stereo forcing in the encoder.
  288. * This can force the encoder to produce packets encoded as either mono or
  289. * stereo, regardless of the format of the input audio. This is useful when
  290. * the caller knows that the input signal is currently a mono source embedded
  291. * in a stereo stream.
  292. * @see OPUS_GET_FORCE_CHANNELS
  293. * @param[in] x <tt>opus_int32</tt>: Allowed values:
  294. * <dl>
  295. * <dt>#OPUS_AUTO</dt><dd>Not forced (default)</dd>
  296. * <dt>1</dt> <dd>Forced mono</dd>
  297. * <dt>2</dt> <dd>Forced stereo</dd>
  298. * </dl>
  299. * @hideinitializer */
  300. #define OPUS_SET_FORCE_CHANNELS(x) OPUS_SET_FORCE_CHANNELS_REQUEST, __opus_check_int(x)
  301. /** Gets the encoder's forced channel configuration.
  302. * @see OPUS_SET_FORCE_CHANNELS
  303. * @param[out] x <tt>opus_int32 *</tt>:
  304. * <dl>
  305. * <dt>#OPUS_AUTO</dt><dd>Not forced (default)</dd>
  306. * <dt>1</dt> <dd>Forced mono</dd>
  307. * <dt>2</dt> <dd>Forced stereo</dd>
  308. * </dl>
  309. * @hideinitializer */
  310. #define OPUS_GET_FORCE_CHANNELS(x) OPUS_GET_FORCE_CHANNELS_REQUEST, __opus_check_int_ptr(x)
  311. /** Configures the maximum bandpass that the encoder will select automatically.
  312. * Applications should normally use this instead of #OPUS_SET_BANDWIDTH
  313. * (leaving that set to the default, #OPUS_AUTO). This allows the
  314. * application to set an upper bound based on the type of input it is
  315. * providing, but still gives the encoder the freedom to reduce the bandpass
  316. * when the bitrate becomes too low, for better overall quality.
  317. * @see OPUS_GET_MAX_BANDWIDTH
  318. * @param[in] x <tt>opus_int32</tt>: Allowed values:
  319. * <dl>
  320. * <dt>OPUS_BANDWIDTH_NARROWBAND</dt> <dd>4 kHz passband</dd>
  321. * <dt>OPUS_BANDWIDTH_MEDIUMBAND</dt> <dd>6 kHz passband</dd>
  322. * <dt>OPUS_BANDWIDTH_WIDEBAND</dt> <dd>8 kHz passband</dd>
  323. * <dt>OPUS_BANDWIDTH_SUPERWIDEBAND</dt><dd>12 kHz passband</dd>
  324. * <dt>OPUS_BANDWIDTH_FULLBAND</dt> <dd>20 kHz passband (default)</dd>
  325. * </dl>
  326. * @hideinitializer */
  327. #define OPUS_SET_MAX_BANDWIDTH(x) OPUS_SET_MAX_BANDWIDTH_REQUEST, __opus_check_int(x)
  328. /** Gets the encoder's configured maximum allowed bandpass.
  329. * @see OPUS_SET_MAX_BANDWIDTH
  330. * @param[out] 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_GET_MAX_BANDWIDTH(x) OPUS_GET_MAX_BANDWIDTH_REQUEST, __opus_check_int_ptr(x)
  340. /** Sets the encoder's bandpass to a specific value.
  341. * This prevents the encoder from automatically selecting the bandpass based
  342. * on the available bitrate. If an application knows the bandpass of the input
  343. * audio it is providing, it should normally use #OPUS_SET_MAX_BANDWIDTH
  344. * instead, which still gives the encoder the freedom to reduce the bandpass
  345. * when the bitrate becomes too low, for better overall quality.
  346. * @see OPUS_GET_BANDWIDTH
  347. * @param[in] x <tt>opus_int32</tt>: Allowed values:
  348. * <dl>
  349. * <dt>#OPUS_AUTO</dt> <dd>(default)</dd>
  350. * <dt>#OPUS_BANDWIDTH_NARROWBAND</dt> <dd>4 kHz passband</dd>
  351. * <dt>#OPUS_BANDWIDTH_MEDIUMBAND</dt> <dd>6 kHz passband</dd>
  352. * <dt>#OPUS_BANDWIDTH_WIDEBAND</dt> <dd>8 kHz passband</dd>
  353. * <dt>#OPUS_BANDWIDTH_SUPERWIDEBAND</dt><dd>12 kHz passband</dd>
  354. * <dt>#OPUS_BANDWIDTH_FULLBAND</dt> <dd>20 kHz passband</dd>
  355. * </dl>
  356. * @hideinitializer */
  357. #define OPUS_SET_BANDWIDTH(x) OPUS_SET_BANDWIDTH_REQUEST, __opus_check_int(x)
  358. /** Configures the type of signal being encoded.
  359. * This is a hint which helps the encoder's mode selection.
  360. * @see OPUS_GET_SIGNAL
  361. * @param[in] x <tt>opus_int32</tt>: Allowed values:
  362. * <dl>
  363. * <dt>#OPUS_AUTO</dt> <dd>(default)</dd>
  364. * <dt>#OPUS_SIGNAL_VOICE</dt><dd>Bias thresholds towards choosing LPC or Hybrid modes.</dd>
  365. * <dt>#OPUS_SIGNAL_MUSIC</dt><dd>Bias thresholds towards choosing MDCT modes.</dd>
  366. * </dl>
  367. * @hideinitializer */
  368. #define OPUS_SET_SIGNAL(x) OPUS_SET_SIGNAL_REQUEST, __opus_check_int(x)
  369. /** Gets the encoder's configured signal type.
  370. * @see OPUS_SET_SIGNAL
  371. * @param[out] x <tt>opus_int32 *</tt>: Returns one of the following values:
  372. * <dl>
  373. * <dt>#OPUS_AUTO</dt> <dd>(default)</dd>
  374. * <dt>#OPUS_SIGNAL_VOICE</dt><dd>Bias thresholds towards choosing LPC or Hybrid modes.</dd>
  375. * <dt>#OPUS_SIGNAL_MUSIC</dt><dd>Bias thresholds towards choosing MDCT modes.</dd>
  376. * </dl>
  377. * @hideinitializer */
  378. #define OPUS_GET_SIGNAL(x) OPUS_GET_SIGNAL_REQUEST, __opus_check_int_ptr(x)
  379. /** Configures the encoder's intended application.
  380. * The initial value is a mandatory argument to the encoder_create function.
  381. * @see OPUS_GET_APPLICATION
  382. * @param[in] x <tt>opus_int32</tt>: Returns one of the following values:
  383. * <dl>
  384. * <dt>#OPUS_APPLICATION_VOIP</dt>
  385. * <dd>Process signal for improved speech intelligibility.</dd>
  386. * <dt>#OPUS_APPLICATION_AUDIO</dt>
  387. * <dd>Favor faithfulness to the original input.</dd>
  388. * <dt>#OPUS_APPLICATION_RESTRICTED_LOWDELAY</dt>
  389. * <dd>Configure the minimum possible coding delay by disabling certain modes
  390. * of operation.</dd>
  391. * </dl>
  392. * @hideinitializer */
  393. #define OPUS_SET_APPLICATION(x) OPUS_SET_APPLICATION_REQUEST, __opus_check_int(x)
  394. /** Gets the encoder's configured application.
  395. * @see OPUS_SET_APPLICATION
  396. * @param[out] x <tt>opus_int32 *</tt>: Returns one of the following values:
  397. * <dl>
  398. * <dt>#OPUS_APPLICATION_VOIP</dt>
  399. * <dd>Process signal for improved speech intelligibility.</dd>
  400. * <dt>#OPUS_APPLICATION_AUDIO</dt>
  401. * <dd>Favor faithfulness to the original input.</dd>
  402. * <dt>#OPUS_APPLICATION_RESTRICTED_LOWDELAY</dt>
  403. * <dd>Configure the minimum possible coding delay by disabling certain modes
  404. * of operation.</dd>
  405. * </dl>
  406. * @hideinitializer */
  407. #define OPUS_GET_APPLICATION(x) OPUS_GET_APPLICATION_REQUEST, __opus_check_int_ptr(x)
  408. /** Gets the sampling rate the encoder or decoder was initialized with.
  409. * This simply returns the <code>Fs</code> value passed to opus_encoder_init()
  410. * or opus_decoder_init().
  411. * @param[out] x <tt>opus_int32 *</tt>: Sampling rate of encoder or decoder.
  412. * @hideinitializer
  413. */
  414. #define OPUS_GET_SAMPLE_RATE(x) OPUS_GET_SAMPLE_RATE_REQUEST, __opus_check_int_ptr(x)
  415. /** Gets the total samples of delay added by the entire codec.
  416. * This can be queried by the encoder and then the provided number of samples can be
  417. * skipped on from the start of the decoder's output to provide time aligned input
  418. * and output. From the perspective of a decoding application the real data begins this many
  419. * samples late.
  420. *
  421. * The decoder contribution to this delay is identical for all decoders, but the
  422. * encoder portion of the delay may vary from implementation to implementation,
  423. * version to version, or even depend on the encoder's initial configuration.
  424. * Applications needing delay compensation should call this CTL rather than
  425. * hard-coding a value.
  426. * @param[out] x <tt>opus_int32 *</tt>: Number of lookahead samples
  427. * @hideinitializer */
  428. #define OPUS_GET_LOOKAHEAD(x) OPUS_GET_LOOKAHEAD_REQUEST, __opus_check_int_ptr(x)
  429. /** Configures the encoder's use of inband forward error correction (FEC).
  430. * @note This is only applicable to the LPC layer
  431. * @see OPUS_GET_INBAND_FEC
  432. * @param[in] x <tt>opus_int32</tt>: Allowed values:
  433. * <dl>
  434. * <dt>0</dt><dd>Disable inband FEC (default).</dd>
  435. * <dt>1</dt><dd>Enable inband FEC.</dd>
  436. * </dl>
  437. * @hideinitializer */
  438. #define OPUS_SET_INBAND_FEC(x) OPUS_SET_INBAND_FEC_REQUEST, __opus_check_int(x)
  439. /** Gets encoder's configured use of inband forward error correction.
  440. * @see OPUS_SET_INBAND_FEC
  441. * @param[out] x <tt>opus_int32 *</tt>: Returns one of the following values:
  442. * <dl>
  443. * <dt>0</dt><dd>Inband FEC disabled (default).</dd>
  444. * <dt>1</dt><dd>Inband FEC enabled.</dd>
  445. * </dl>
  446. * @hideinitializer */
  447. #define OPUS_GET_INBAND_FEC(x) OPUS_GET_INBAND_FEC_REQUEST, __opus_check_int_ptr(x)
  448. /** Configures the encoder's expected packet loss percentage.
  449. * Higher values with trigger progressively more loss resistant behavior in the encoder
  450. * at the expense of quality at a given bitrate in the lossless case, but greater quality
  451. * under loss.
  452. * @see OPUS_GET_PACKET_LOSS_PERC
  453. * @param[in] x <tt>opus_int32</tt>: Loss percentage in the range 0-100, inclusive (default: 0).
  454. * @hideinitializer */
  455. #define OPUS_SET_PACKET_LOSS_PERC(x) OPUS_SET_PACKET_LOSS_PERC_REQUEST, __opus_check_int(x)
  456. /** Gets the encoder's configured packet loss percentage.
  457. * @see OPUS_SET_PACKET_LOSS_PERC
  458. * @param[out] x <tt>opus_int32 *</tt>: Returns the configured loss percentage
  459. * in the range 0-100, inclusive (default: 0).
  460. * @hideinitializer */
  461. #define OPUS_GET_PACKET_LOSS_PERC(x) OPUS_GET_PACKET_LOSS_PERC_REQUEST, __opus_check_int_ptr(x)
  462. /** Configures the encoder's use of discontinuous transmission (DTX).
  463. * @note This is only applicable to the LPC layer
  464. * @see OPUS_GET_DTX
  465. * @param[in] x <tt>opus_int32</tt>: Allowed values:
  466. * <dl>
  467. * <dt>0</dt><dd>Disable DTX (default).</dd>
  468. * <dt>1</dt><dd>Enabled DTX.</dd>
  469. * </dl>
  470. * @hideinitializer */
  471. #define OPUS_SET_DTX(x) OPUS_SET_DTX_REQUEST, __opus_check_int(x)
  472. /** Gets encoder's configured use of discontinuous transmission.
  473. * @see OPUS_SET_DTX
  474. * @param[out] x <tt>opus_int32 *</tt>: Returns one of the following values:
  475. * <dl>
  476. * <dt>0</dt><dd>DTX disabled (default).</dd>
  477. * <dt>1</dt><dd>DTX enabled.</dd>
  478. * </dl>
  479. * @hideinitializer */
  480. #define OPUS_GET_DTX(x) OPUS_GET_DTX_REQUEST, __opus_check_int_ptr(x)
  481. /** Configures the depth of signal being encoded.
  482. * This is a hint which helps the encoder identify silence and near-silence.
  483. * @see OPUS_GET_LSB_DEPTH
  484. * @param[in] x <tt>opus_int32</tt>: Input precision in bits, between 8 and 24
  485. * (default: 24).
  486. * @hideinitializer */
  487. #define OPUS_SET_LSB_DEPTH(x) OPUS_SET_LSB_DEPTH_REQUEST, __opus_check_int(x)
  488. /** Gets the encoder's configured signal depth.
  489. * @see OPUS_SET_LSB_DEPTH
  490. * @param[out] x <tt>opus_int32 *</tt>: Input precision in bits, between 8 and
  491. * 24 (default: 24).
  492. * @hideinitializer */
  493. #define OPUS_GET_LSB_DEPTH(x) OPUS_GET_LSB_DEPTH_REQUEST, __opus_check_int_ptr(x)
  494. /** Gets the duration (in samples) of the last packet successfully decoded or concealed.
  495. * @param[out] x <tt>opus_int32 *</tt>: Number of samples (at current sampling rate).
  496. * @hideinitializer */
  497. #define OPUS_GET_LAST_PACKET_DURATION(x) OPUS_GET_LAST_PACKET_DURATION_REQUEST, __opus_check_int_ptr(x)
  498. /** Configures the encoder's use of variable duration frames.
  499. * When enabled, the encoder is free to use a shorter frame size than the one
  500. * requested in the opus_encode*() call. It is then the user's responsibility
  501. * to verify how much audio was encoded by checking the ToC byte of the encoded
  502. * packet. The part of the audio that was not encoded needs to be resent to the
  503. * encoder for the next call. Do not use this option unless you <b>really</b>
  504. * know what you are doing.
  505. * @see OPUS_GET_EXPERT_VARIABLE_DURATION
  506. * @param[in] x <tt>opus_int32</tt>: Allowed values:
  507. * <dl>
  508. * <dt>0</dt><dd>Disable variable duration (default).</dd>
  509. * <dt>1</dt><dd>Enable variable duration.</dd>
  510. * </dl>
  511. * @hideinitializer */
  512. #define OPUS_SET_EXPERT_FRAME_DURATION(x) OPUS_SET_EXPERT_FRAME_DURATION_REQUEST, __opus_check_int(x)
  513. /** Gets the encoder's configured use of variable duration frames.
  514. * @see OPUS_SET_EXPERT_VARIABLE_DURATION
  515. * @param[out] x <tt>opus_int32 *</tt>: Returns one of the following values:
  516. * <dl>
  517. * <dt>0</dt><dd>variable duration disabled (default).</dd>
  518. * <dt>1</dt><dd>variable duration enabled.</dd>
  519. * </dl>
  520. * @hideinitializer */
  521. #define OPUS_GET_EXPERT_FRAME_DURATION(x) OPUS_GET_EXPERT_FRAME_DURATION_REQUEST, __opus_check_int_ptr(x)
  522. /**@}*/
  523. /** @defgroup opus_genericctls Generic CTLs
  524. *
  525. * These macros are used with the \c opus_decoder_ctl and
  526. * \c opus_encoder_ctl calls to generate a particular
  527. * request.
  528. *
  529. * When called on an \c OpusDecoder they apply to that
  530. * particular decoder instance. When called on an
  531. * \c OpusEncoder they apply to the corresponding setting
  532. * on that encoder instance, if present.
  533. *
  534. * Some usage examples:
  535. *
  536. * @code
  537. * int ret;
  538. * opus_int32 pitch;
  539. * ret = opus_decoder_ctl(dec_ctx, OPUS_GET_PITCH(&pitch));
  540. * if (ret == OPUS_OK) return ret;
  541. *
  542. * opus_encoder_ctl(enc_ctx, OPUS_RESET_STATE);
  543. * opus_decoder_ctl(dec_ctx, OPUS_RESET_STATE);
  544. *
  545. * opus_int32 enc_bw, dec_bw;
  546. * opus_encoder_ctl(enc_ctx, OPUS_GET_BANDWIDTH(&enc_bw));
  547. * opus_decoder_ctl(dec_ctx, OPUS_GET_BANDWIDTH(&dec_bw));
  548. * if (enc_bw != dec_bw) {
  549. * printf("packet bandwidth mismatch!\n");
  550. * }
  551. * @endcode
  552. *
  553. * @see opus_encoder, opus_decoder_ctl, opus_encoder_ctl, opus_decoderctls, opus_encoderctls
  554. * @{
  555. */
  556. /** Resets the codec state to be equivalent to a freshly initialized state.
  557. * This should be called when switching streams in order to prevent
  558. * the back to back decoding from giving different results from
  559. * one at a time decoding.
  560. * @hideinitializer */
  561. #define OPUS_RESET_STATE 4028
  562. /** Gets the final state of the codec's entropy coder.
  563. * This is used for testing purposes,
  564. * The encoder and decoder state should be identical after coding a payload
  565. * (assuming no data corruption or software bugs)
  566. *
  567. * @param[out] x <tt>opus_uint32 *</tt>: Entropy coder state
  568. *
  569. * @hideinitializer */
  570. #define OPUS_GET_FINAL_RANGE(x) OPUS_GET_FINAL_RANGE_REQUEST, __opus_check_uint_ptr(x)
  571. /** Gets the pitch of the last decoded frame, if available.
  572. * This can be used for any post-processing algorithm requiring the use of pitch,
  573. * e.g. time stretching/shortening. If the last frame was not voiced, or if the
  574. * pitch was not coded in the frame, then zero is returned.
  575. *
  576. * This CTL is only implemented for decoder instances.
  577. *
  578. * @param[out] x <tt>opus_int32 *</tt>: pitch period at 48 kHz (or 0 if not available)
  579. *
  580. * @hideinitializer */
  581. #define OPUS_GET_PITCH(x) OPUS_GET_PITCH_REQUEST, __opus_check_int_ptr(x)
  582. /** Gets the encoder's configured bandpass or the decoder's last bandpass.
  583. * @see OPUS_SET_BANDWIDTH
  584. * @param[out] x <tt>opus_int32 *</tt>: Returns one of the following values:
  585. * <dl>
  586. * <dt>#OPUS_AUTO</dt> <dd>(default)</dd>
  587. * <dt>#OPUS_BANDWIDTH_NARROWBAND</dt> <dd>4 kHz passband</dd>
  588. * <dt>#OPUS_BANDWIDTH_MEDIUMBAND</dt> <dd>6 kHz passband</dd>
  589. * <dt>#OPUS_BANDWIDTH_WIDEBAND</dt> <dd>8 kHz passband</dd>
  590. * <dt>#OPUS_BANDWIDTH_SUPERWIDEBAND</dt><dd>12 kHz passband</dd>
  591. * <dt>#OPUS_BANDWIDTH_FULLBAND</dt> <dd>20 kHz passband</dd>
  592. * </dl>
  593. * @hideinitializer */
  594. #define OPUS_GET_BANDWIDTH(x) OPUS_GET_BANDWIDTH_REQUEST, __opus_check_int_ptr(x)
  595. /**@}*/
  596. /** @defgroup opus_decoderctls Decoder related CTLs
  597. * @see opus_genericctls, opus_encoderctls, opus_decoder
  598. * @{
  599. */
  600. /** Configures decoder gain adjustment.
  601. * Scales the decoded output by a factor specified in Q8 dB units.
  602. * This has a maximum range of -32768 to 32767 inclusive, and returns
  603. * OPUS_BAD_ARG otherwise. The default is zero indicating no adjustment.
  604. * This setting survives decoder reset.
  605. *
  606. * gain = pow(10, x/(20.0*256))
  607. *
  608. * @param[in] x <tt>opus_int32</tt>: Amount to scale PCM signal by in Q8 dB units.
  609. * @hideinitializer */
  610. #define OPUS_SET_GAIN(x) OPUS_SET_GAIN_REQUEST, __opus_check_int(x)
  611. /** Gets the decoder's configured gain adjustment. @see OPUS_SET_GAIN
  612. *
  613. * @param[out] x <tt>opus_int32 *</tt>: Amount to scale PCM signal by in Q8 dB units.
  614. * @hideinitializer */
  615. #define OPUS_GET_GAIN(x) OPUS_GET_GAIN_REQUEST, __opus_check_int_ptr(x)
  616. /**@}*/
  617. /** @defgroup opus_libinfo Opus library information functions
  618. * @{
  619. */
  620. /** Converts an opus error code into a human readable string.
  621. *
  622. * @param[in] error <tt>int</tt>: Error number
  623. * @returns Error string
  624. */
  625. OPUS_EXPORT const char *opus_strerror(int error);
  626. /** Gets the libopus version string.
  627. *
  628. * @returns Version string
  629. */
  630. OPUS_EXPORT const char *opus_get_version_string(void);
  631. /**@}*/
  632. #ifdef __cplusplus
  633. }
  634. #endif
  635. #endif /* OPUS_DEFINES_H */