opus_defines.h(3) Opus opus_defines.h(3) NNAAMMEE opus_defines.h - Opus reference implementation constants. SSYYNNOOPPSSIISS #include 'opus_types.h' MMaaccrrooss #define OOPPUUSS__OOKK No error. #define OOPPUUSS__BBAADD__AARRGG One or more invalid/out of range arguments. #define OOPPUUSS__BBUUFFFFEERR__TTOOOO__SSMMAALLLL Not enough bytes allocated in the buffer. #define OOPPUUSS__IINNTTEERRNNAALL__EERRRROORR An internal error was detected. #define OOPPUUSS__IINNVVAALLIIDD__PPAACCKKEETT The compressed data passed is corrupted. #define OOPPUUSS__UUNNIIMMPPLLEEMMEENNTTEEDD Invalid/unsupported request number. #define OOPPUUSS__IINNVVAALLIIDD__SSTTAATTEE An encoder or decoder structure is invalid or already freed. #define OOPPUUSS__AALLLLOOCC__FFAAIILL Memory allocation has failed. #define OOPPUUSS__AAUUTTOO Auto/default setting. #define OOPPUUSS__BBIITTRRAATTEE__MMAAXX Maximum bitrate. #define OOPPUUSS__AAPPPPLLIICCAATTIIOONN__VVOOIIPP Best for most VoIP/videoconference applications where listening quality and intelligibility matter most. #define OOPPUUSS__AAPPPPLLIICCAATTIIOONN__AAUUDDIIOO Best for broadcast/high-fidelity application where the decoded audio should be as close as possible to the input. #define OOPPUUSS__AAPPPPLLIICCAATTIIOONN__RREESSTTRRIICCTTEEDD__LLOOWWDDEELLAAYY Only use when lowest-achievable latency is what matters most. #define OOPPUUSS__SSIIGGNNAALL__VVOOIICCEE 3001 Signal being encoded is voice. #define OOPPUUSS__SSIIGGNNAALL__MMUUSSIICC 3002 Signal being encoded is music. #define OOPPUUSS__BBAANNDDWWIIDDTTHH__NNAARRRROOWWBBAANNDD 4 kHz bandpass #define OOPPUUSS__BBAANNDDWWIIDDTTHH__MMEEDDIIUUMMBBAANNDD 6 kHz bandpass #define OOPPUUSS__BBAANNDDWWIIDDTTHH__WWIIDDEEBBAANNDD 8 kHz bandpass #define OOPPUUSS__BBAANNDDWWIIDDTTHH__SSUUPPEERRWWIIDDEEBBAANNDD 12 kHz bandpass #define OOPPUUSS__BBAANNDDWWIIDDTTHH__FFUULLLLBBAANNDD 20 kHz bandpass #define OOPPUUSS__FFRRAAMMEESSIIZZEE__AARRGG 5000 Select frame size from the argument (default) #define OOPPUUSS__FFRRAAMMEESSIIZZEE__22__55__MMSS 5001 Use 2.5 ms frames. #define OOPPUUSS__FFRRAAMMEESSIIZZEE__55__MMSS 5002 Use 5 ms frames. #define OOPPUUSS__FFRRAAMMEESSIIZZEE__1100__MMSS 5003 Use 10 ms frames. #define OOPPUUSS__FFRRAAMMEESSIIZZEE__2200__MMSS 5004 Use 20 ms frames. #define OOPPUUSS__FFRRAAMMEESSIIZZEE__4400__MMSS 5005 Use 40 ms frames. #define OOPPUUSS__FFRRAAMMEESSIIZZEE__6600__MMSS 5006 Use 60 ms frames. #define OOPPUUSS__FFRRAAMMEESSIIZZEE__8800__MMSS 5007 Use 80 ms frames. #define OOPPUUSS__FFRRAAMMEESSIIZZEE__110000__MMSS 5008 Use 100 ms frames. #define OOPPUUSS__FFRRAAMMEESSIIZZEE__112200__MMSS 5009 Use 120 ms frames. #define OOPPUUSS__SSEETT__CCOOMMPPLLEEXXIITTYY(x) Configures the encoder's computational complexity. #define OOPPUUSS__GGEETT__CCOOMMPPLLEEXXIITTYY(x) Gets the encoder's complexity configuration. #define OOPPUUSS__SSEETT__BBIITTRRAATTEE(x) Configures the bitrate in the encoder. #define OOPPUUSS__GGEETT__BBIITTRRAATTEE(x) Gets the encoder's bitrate configuration. #define OOPPUUSS__SSEETT__VVBBRR(x) Enables or disables variable bitrate (VBR) in the encoder. #define OOPPUUSS__GGEETT__VVBBRR(x) Determine if variable bitrate (VBR) is enabled in the encoder. #define OOPPUUSS__SSEETT__VVBBRR__CCOONNSSTTRRAAIINNTT(x) Enables or disables constrained VBR in the encoder. #define OOPPUUSS__GGEETT__VVBBRR__CCOONNSSTTRRAAIINNTT(x) Determine if constrained VBR is enabled in the encoder. #define OOPPUUSS__SSEETT__FFOORRCCEE__CCHHAANNNNEELLSS(x) Configures mono/stereo forcing in the encoder. #define OOPPUUSS__GGEETT__FFOORRCCEE__CCHHAANNNNEELLSS(x) Gets the encoder's forced channel configuration. #define OOPPUUSS__SSEETT__MMAAXX__BBAANNDDWWIIDDTTHH(x) Configures the maximum bandpass that the encoder will select automatically. #define OOPPUUSS__GGEETT__MMAAXX__BBAANNDDWWIIDDTTHH(x) Gets the encoder's configured maximum allowed bandpass. #define OOPPUUSS__SSEETT__BBAANNDDWWIIDDTTHH(x) Sets the encoder's bandpass to a specific value. #define OOPPUUSS__SSEETT__SSIIGGNNAALL(x) Configures the type of signal being encoded. #define OOPPUUSS__GGEETT__SSIIGGNNAALL(x) Gets the encoder's configured signal type. #define OOPPUUSS__SSEETT__AAPPPPLLIICCAATTIIOONN(x) Configures the encoder's intended application. #define OOPPUUSS__GGEETT__AAPPPPLLIICCAATTIIOONN(x) Gets the encoder's configured application. #define OOPPUUSS__GGEETT__LLOOOOKKAAHHEEAADD(x) Gets the total samples of delay added by the entire codec. #define OOPPUUSS__SSEETT__IINNBBAANNDD__FFEECC(x) Configures the encoder's use of inband forward error correction (FEC). #define OOPPUUSS__GGEETT__IINNBBAANNDD__FFEECC(x) Gets encoder's configured use of inband forward error correction. #define OOPPUUSS__SSEETT__PPAACCKKEETT__LLOOSSSS__PPEERRCC(x) Configures the encoder's expected packet loss percentage. #define OOPPUUSS__GGEETT__PPAACCKKEETT__LLOOSSSS__PPEERRCC(x) Gets the encoder's configured packet loss percentage. #define OOPPUUSS__SSEETT__DDTTXX(x) Configures the encoder's use of discontinuous transmission (DTX). #define OOPPUUSS__GGEETT__DDTTXX(x) Gets encoder's configured use of discontinuous transmission. #define OOPPUUSS__SSEETT__LLSSBB__DDEEPPTTHH(x) Configures the depth of signal being encoded. #define OOPPUUSS__GGEETT__LLSSBB__DDEEPPTTHH(x) Gets the encoder's configured signal depth. #define OOPPUUSS__SSEETT__EEXXPPEERRTT__FFRRAAMMEE__DDUURRAATTIIOONN(x) Configures the encoder's use of variable duration frames. #define OOPPUUSS__GGEETT__EEXXPPEERRTT__FFRRAAMMEE__DDUURRAATTIIOONN(x) Gets the encoder's configured use of variable duration frames. #define OOPPUUSS__SSEETT__PPRREEDDIICCTTIIOONN__DDIISSAABBLLEEDD(x) If set to 1, disables almost all use of prediction, making frames almost completely independent. #define OOPPUUSS__GGEETT__PPRREEDDIICCTTIIOONN__DDIISSAABBLLEEDD(x) Gets the encoder's configured prediction status. #define OOPPUUSS__RREESSEETT__SSTTAATTEE Resets the codec state to be equivalent to a freshly initialized state. #define OOPPUUSS__GGEETT__FFIINNAALL__RRAANNGGEE(x) Gets the final state of the codec's entropy coder. #define OOPPUUSS__GGEETT__BBAANNDDWWIIDDTTHH(x) Gets the encoder's configured bandpass or the decoder's last bandpass. #define OOPPUUSS__GGEETT__SSAAMMPPLLEE__RRAATTEE(x) Gets the sampling rate the encoder or decoder was initialized with. #define OOPPUUSS__SSEETT__PPHHAASSEE__IINNVVEERRSSIIOONN__DDIISSAABBLLEEDD(x) If set to 1, disables the use of phase inversion for intensity stereo, improving the quality of mono downmixes, but slightly reducing normal stereo quality. #define OOPPUUSS__GGEETT__PPHHAASSEE__IINNVVEERRSSIIOONN__DDIISSAABBLLEEDD(x) Gets the encoder's configured phase inversion status. #define OOPPUUSS__GGEETT__IINN__DDTTXX(x) Gets the DTX state of the encoder. #define OOPPUUSS__SSEETT__GGAAIINN(x) Configures decoder gain adjustment. #define OOPPUUSS__GGEETT__GGAAIINN(x) Gets the decoder's configured gain adjustment. #define OOPPUUSS__GGEETT__LLAASSTT__PPAACCKKEETT__DDUURRAATTIIOONN(x) Gets the duration (in samples) of the last packet successfully decoded or concealed. #define OOPPUUSS__GGEETT__PPIITTCCHH(x) Gets the pitch of the last decoded frame, if available. FFuunnccttiioonnss const char * ooppuuss__ssttrreerrrroorr (int error) Converts an opus error code into a human readable string. const char * ooppuuss__ggeett__vveerrssiioonn__ssttrriinngg (void) Gets the libopus version string. DDeettaaiilleedd DDeessccrriippttiioonn Opus reference implementation constants. AAuutthhoorr Generated automatically by Doxygen for Opus from the source code. Version 1.3.1 Wed Aug 24 2022 opus_defines.h(3)