Functions
The following functions are available globally.
-
Undocumented
Declaration
Objective-C
_Bool TPCircularBufferInit(TPCircularBuffer *buffer, int32_t length)
Swift
func TPCircularBufferInit(_ buffer: UnsafeMutablePointer<TPCircularBuffer>!, _ length: Int32) -> Bool
-
Undocumented
Declaration
Objective-C
void TPCircularBufferCleanup(TPCircularBuffer *buffer)
Swift
func TPCircularBufferCleanup(_ buffer: UnsafeMutablePointer<TPCircularBuffer>!)
-
Undocumented
Declaration
Objective-C
void TPCircularBufferClear(TPCircularBuffer *buffer)
Swift
func TPCircularBufferClear(_ buffer: UnsafeMutablePointer<TPCircularBuffer>!)
-
Undocumented
Declaration
Objective-C
static inline void *TPCircularBufferTail(TPCircularBuffer *buffer, int32_t *availableBytes)
Swift
func TPCircularBufferTail(_ buffer: UnsafeMutablePointer<TPCircularBuffer>!, _ availableBytes: UnsafeMutablePointer<Int32>!) -> UnsafeMutableRawPointer!
-
Undocumented
Declaration
Objective-C
static inline void TPCircularBufferConsume(TPCircularBuffer *buffer, int32_t amount)
Swift
func TPCircularBufferConsume(_ buffer: UnsafeMutablePointer<TPCircularBuffer>!, _ amount: Int32)
-
Undocumented
Declaration
Objective-C
static inline void TPCircularBufferConsumeNoBarrier(TPCircularBuffer *buffer, int32_t amount)
Swift
func TPCircularBufferConsumeNoBarrier(_ buffer: UnsafeMutablePointer<TPCircularBuffer>!, _ amount: Int32)
-
Undocumented
Declaration
Objective-C
static inline void *TPCircularBufferHead(TPCircularBuffer *buffer, int32_t *availableBytes)
Swift
func TPCircularBufferHead(_ buffer: UnsafeMutablePointer<TPCircularBuffer>!, _ availableBytes: UnsafeMutablePointer<Int32>!) -> UnsafeMutableRawPointer!
-
Undocumented
Declaration
Objective-C
static inline void TPCircularBufferProduce(TPCircularBuffer *buffer, int amount)
Swift
func TPCircularBufferProduce(_ buffer: UnsafeMutablePointer<TPCircularBuffer>!, _ amount: Int32)
-
Undocumented
Declaration
Objective-C
static inline void TPCircularBufferProduceNoBarrier(TPCircularBuffer *buffer, int amount)
Swift
func TPCircularBufferProduceNoBarrier(_ buffer: UnsafeMutablePointer<TPCircularBuffer>!, _ amount: Int32)
-
Undocumented
Declaration
Objective-C
static inline _Bool TPCircularBufferProduceBytes(TPCircularBuffer *buffer, const void *src, int32_t len)
Swift
func TPCircularBufferProduceBytes(_ buffer: UnsafeMutablePointer<TPCircularBuffer>!, _ src: UnsafeRawPointer!, _ len: Int32) -> Bool
-
Undocumented
Declaration
Objective-C
id TyphoonConfig(NSString *configKey)
Swift
func TyphoonConfig(_ configKey: String!) -> Any!
-
Undocumented
Declaration
Objective-C
NSString *TyphoonTypeStringFor(id classOrProtocol)
Swift
func TyphoonTypeStringFor(_ classOrProtocol: Any!) -> String!
-
Undocumented
Declaration
Objective-C
Class TyphoonClassFromString(NSString *className)
Swift
func TyphoonClassFromString(_ className: String!) -> AnyClass!
-
Undocumented
Declaration
Objective-C
BOOL IsClass(id classOrProtocol)
Swift
func IsClass(_ classOrProtocol: Any!) -> Bool
-
Undocumented
Declaration
Objective-C
BOOL IsProtocol(id classOrProtocol)
Swift
func IsProtocol(_ classOrProtocol: Any!) -> Bool
-
Gets the size of an
OpusEncoder
structure.- @param[in] channels int: Number of channels.
- This must be 1 or 2.
- @returns The size in bytes.
Declaration
Objective-C
int opus_encoder_get_size(int channels)
Swift
func opus_encoder_get_size(_ channels: Int32) -> Int32
-
Allocates and initializes an encoder state.
- There are three coding modes: *
- @ref OPUS_APPLICATION_VOIP gives best quality at a given bitrate for voice
- signals. It enhances the input signal by high-pass filtering and
- emphasizing formants and harmonics. Optionally it includes in-band
- forward error correction to protect against packet loss. Use this
- mode for typical VoIP applications. Because of the enhancement,
- even at high bitrates the output may sound different from the input. *
- @ref OPUS_APPLICATION_AUDIO gives best quality at a given bitrate for most
- non-voice signals like music. Use this mode for music and mixed
- (music/voice) content, broadcast, and applications requiring less
- than 15 ms of coding delay. *
- @ref OPUS_APPLICATION_RESTRICTED_LOWDELAY configures low-delay mode that
- disables the speech-optimized mode in exchange for slightly reduced delay.
- This mode can only be set on an newly initialized or freshly reset encoder
- because it changes the codec delay. *
- This is useful when the caller knows that the speech-optimized modes will not be needed (use with caution).
- - parameter: [in] Fs opus_int32: Sampling rate of input signal (Hz)
- This must be one of 8000, 12000, 16000,
- 24000, or 48000.
- - parameter: [in] channels int: Number of channels (1 or 2) in input signal
- - parameter: [in] application int: Coding mode (@ref OPUS_APPLICATION_VOIP/@ref OPUS_APPLICATION_AUDIO/@ref OPUS_APPLICATION_RESTRICTED_LOWDELAY)
- - parameter: [out] error int*: @ref opus_errorcodes
- - note: Regardless of the sampling rate and number channels selected, the Opus encoder
- can switch to a lower audio bandwidth or number of channels if the bitrate
- selected is too low. This also means that it is safe to always use 48 kHz stereo input
- and let the encoder optimize the encoding.
Declaration
Objective-C
OpusEncoder *opus_encoder_create(opus_int32 Fs, int channels, int application, int *error)
Swift
func opus_encoder_create(_ Fs: opus_int32, _ channels: Int32, _ application: Int32, _ error: UnsafeMutablePointer<Int32>!) -> OpaquePointer!
-
Initializes a previously allocated encoder state
- The memory pointed to by st must be at least the size returned by opus_encoder_get_size().
- This is intended for applications which use their own allocator instead of malloc.
- - see: opus_encoder_create(),opus_encoder_get_size()
- To reset a previously initialized state, use the #OPUS_RESET_STATE CTL.
- - parameter: [in] st OpusEncoder*: Encoder state
- - parameter: [in] Fs opus_int32: Sampling rate of input signal (Hz)
- This must be one of 8000, 12000, 16000,
- 24000, or 48000.
- - parameter: [in] channels int: Number of channels (1 or 2) in input signal
- - parameter: [in] application int: Coding mode (OPUS_APPLICATION_VOIP/OPUS_APPLICATION_AUDIO/OPUS_APPLICATION_RESTRICTED_LOWDELAY)
- @retval #OPUS_OK Success or @ref opus_errorcodes
Declaration
Objective-C
int opus_encoder_init(OpusEncoder *st, opus_int32 Fs, int channels, int application)
Swift
func opus_encoder_init(_ st: OpaquePointer, _ Fs: opus_int32, _ channels: Int32, _ application: Int32) -> Int32
-
Encodes an Opus frame.
- - parameter: [in] st OpusEncoder*: Encoder state
- - parameter: [in] pcm opus_int16*: Input signal (interleaved if 2 channels). length is frame_size*channels*sizeof(opus_int16)
- - parameter: [in] frame_size int: Number of samples per channel in the
- input signal.
- This must be an Opus frame size for
- the encoder’s sampling rate.
- For example, at 48 kHz the permitted
- values are 120, 240, 480, 960, 1920,
- and 2880.
- Passing in a duration of less than
- 10 ms (480 samples at 48 kHz) will
- prevent the encoder from using the LPC
- or hybrid modes.
- - parameter: [out] data unsigned char*: Output payload.
- This must contain storage for at
- least \a max_data_bytes.
- - parameter: [in] max_data_bytes opus_int32: Size of the allocated
- memory for the output
- payload. This may be
- used to impose an upper limit on
- the instant bitrate, but should
- not be used as the only bitrate
- control. Use #OPUS_SET_BITRATE to
- control the bitrate.
- @returns The length of the encoded packet (in bytes) on success or a
- negative error code (see @ref opus_errorcodes) on failure.
Declaration
Objective-C
opus_int32 opus_encode(OpusEncoder *st, const opus_int16 *pcm, int frame_size, unsigned char *data, opus_int32 max_data_bytes)
Swift
func opus_encode(_ st: OpaquePointer, _ pcm: UnsafePointer<opus_int16>, _ frame_size: Int32, _ data: UnsafeMutablePointer<UInt8>, _ max_data_bytes: opus_int32) -> opus_int32
-
Encodes an Opus frame from floating point input.
- - parameter: [in] st OpusEncoder*: Encoder state
- - parameter: [in] pcm float*: Input in float format (interleaved if 2 channels), with a normal range of +/-1.0.
- Samples with a range beyond +/-1.0 are supported but will
- be clipped by decoders using the integer API and should
- only be used if it is known that the far end supports
- extended dynamic range.
- length is frame_size*channels*sizeof(float)
- - parameter: [in] frame_size int: Number of samples per channel in the
- input signal.
- This must be an Opus frame size for
- the encoder’s sampling rate.
- For example, at 48 kHz the permitted
- values are 120, 240, 480, 960, 1920,
- and 2880.
- Passing in a duration of less than
- 10 ms (480 samples at 48 kHz) will
- prevent the encoder from using the LPC
- or hybrid modes.
- - parameter: [out] data unsigned char*: Output payload.
- This must contain storage for at
- least \a max_data_bytes.
- - parameter: [in] max_data_bytes opus_int32: Size of the allocated
- memory for the output
- payload. This may be
- used to impose an upper limit on
- the instant bitrate, but should
- not be used as the only bitrate
- control. Use #OPUS_SET_BITRATE to
- control the bitrate.
- @returns The length of the encoded packet (in bytes) on success or a
- negative error code (see @ref opus_errorcodes) on failure.
Declaration
Objective-C
opus_int32 opus_encode_float(OpusEncoder *st, const float *pcm, int frame_size, unsigned char *data, opus_int32 max_data_bytes)
Swift
func opus_encode_float(_ st: OpaquePointer, _ pcm: UnsafePointer<Float>, _ frame_size: Int32, _ data: UnsafeMutablePointer<UInt8>, _ max_data_bytes: opus_int32) -> opus_int32
-
Frees an
OpusEncoder
allocated by opus_encoder_create().- @param[in] st OpusEncoder*: State to be freed.
Declaration
Objective-C
void opus_encoder_destroy(OpusEncoder *st)
Swift
func opus_encoder_destroy(_ st: OpaquePointer!)
-
Perform a CTL function on an Opus encoder. *
- Generally the request and subsequent arguments are generated
- by a convenience macro.
- - parameter: st OpusEncoder*: Encoder state.
- - parameter: request This and all remaining parameters should be replaced by one
- of the convenience macros in @ref opus_genericctls or
- @ref opus_encoderctls.
- - see: opus_genericctls
- - see: opus_encoderctls
Declaration
Objective-C
int opus_encoder_ctl(OpusEncoder *st, int request, ...)
-
Gets the size of an
OpusDecoder
structure.- - parameter: [in] channels int: Number of channels.
- This must be 1 or 2.
- @returns The size in bytes.
Declaration
Objective-C
int opus_decoder_get_size(int channels)
Swift
func opus_decoder_get_size(_ channels: Int32) -> Int32
-
Allocates and initializes a decoder state.
- - parameter: [in] Fs opus_int32: Sample rate to decode at (Hz).
- This must be one of 8000, 12000, 16000,
- 24000, or 48000.
- - parameter: [in] channels int: Number of channels (1 or 2) to decode
- - parameter: [out] error int*: #OPUS_OK Success or @ref opus_errorcodes *
- Internally Opus stores data at 48000 Hz, so that should be the default
- value for Fs. However, the decoder can efficiently decode to buffers
- at 8, 12, 16, and 24 kHz so if for some reason the caller cannot use
- data at the full sample rate, or knows the compressed data doesn’t
- use the full frequency range, it can request decoding at a reduced
- rate. Likewise, the decoder is capable of filling in either mono or
- interleaved stereo pcm buffers, at the caller’s request.
Declaration
Objective-C
OpusDecoder *opus_decoder_create(opus_int32 Fs, int channels, int *error)
Swift
func opus_decoder_create(_ Fs: opus_int32, _ channels: Int32, _ error: UnsafeMutablePointer<Int32>!) -> OpaquePointer!
-
Initializes a previously allocated decoder state.
- The state must be at least the size returned by opus_decoder_get_size().
- This is intended for applications which use their own allocator instead of malloc. - see: opus_decoder_create,opus_decoder_get_size
- To reset a previously initialized state, use the #OPUS_RESET_STATE CTL.
- - parameter: [in] st OpusDecoder*: Decoder state.
- - parameter: [in] Fs opus_int32: Sampling rate to decode to (Hz).
- This must be one of 8000, 12000, 16000,
- 24000, or 48000.
- - parameter: [in] channels int: Number of channels (1 or 2) to decode
- @retval #OPUS_OK Success or @ref opus_errorcodes
Declaration
Objective-C
int opus_decoder_init(OpusDecoder *st, opus_int32 Fs, int channels)
Swift
func opus_decoder_init(_ st: OpaquePointer, _ Fs: opus_int32, _ channels: Int32) -> Int32
-
Decode an Opus packet.
- - parameter: [in] st OpusDecoder*: Decoder state
- - parameter: [in] data char*: Input payload. Use a NULL pointer to indicate packet loss
- - parameter: [in] len opus_int32: Number of bytes in payload*
- - parameter: [out] pcm opus_int16*: Output signal (interleaved if 2 channels). length
- is frame_size*channels*sizeof(opus_int16)
- - parameter: [in] frame_size Number of samples per channel of available space in \a pcm.
- If this is less than the maximum packet duration (120ms; 5760 for 48kHz), this function will
- not be capable of decoding some packets. In the case of PLC (data==NULL) or FEC (decode_fec=1),
- then frame_size needs to be exactly the duration of audio that is missing, otherwise the
- decoder will not be in the optimal state to decode the next incoming packet. For the PLC and
- FEC cases, frame_size must be a multiple of 2.5 ms.
- - parameter: [in] decode_fec int: Flag (0 or 1) to request that any in-band forward error correction data be
- decoded. If no such data is available, the frame is decoded as if it were lost.
- @returns Number of decoded samples or @ref opus_errorcodes
Declaration
Objective-C
int opus_decode(OpusDecoder *st, const unsigned char *data, opus_int32 len, opus_int16 *pcm, int frame_size, int decode_fec)
Swift
func opus_decode(_ st: OpaquePointer, _ data: UnsafePointer<UInt8>!, _ len: opus_int32, _ pcm: UnsafeMutablePointer<opus_int16>, _ frame_size: Int32, _ decode_fec: Int32) -> Int32
-
Decode an Opus packet with floating point output.
- - parameter: [in] st OpusDecoder*: Decoder state
- - parameter: [in] data char*: Input payload. Use a NULL pointer to indicate packet loss
- - parameter: [in] len opus_int32: Number of bytes in payload
- - parameter: [out] pcm float*: Output signal (interleaved if 2 channels). length
- is frame_size*channels*sizeof(float)
- - parameter: [in] frame_size Number of samples per channel of available space in \a pcm.
- If this is less than the maximum packet duration (120ms; 5760 for 48kHz), this function will
- not be capable of decoding some packets. In the case of PLC (data==NULL) or FEC (decode_fec=1),
- then frame_size needs to be exactly the duration of audio that is missing, otherwise the
- decoder will not be in the optimal state to decode the next incoming packet. For the PLC and
- FEC cases, frame_size must be a multiple of 2.5 ms.
- - parameter: [in] decode_fec int: Flag (0 or 1) to request that any in-band forward error correction data be
- decoded. If no such data is available the frame is decoded as if it were lost.
- @returns Number of decoded samples or @ref opus_errorcodes
Declaration
Objective-C
int opus_decode_float(OpusDecoder *st, const unsigned char *data, opus_int32 len, float *pcm, int frame_size, int decode_fec)
Swift
func opus_decode_float(_ st: OpaquePointer, _ data: UnsafePointer<UInt8>!, _ len: opus_int32, _ pcm: UnsafeMutablePointer<Float>, _ frame_size: Int32, _ decode_fec: Int32) -> Int32
-
Perform a CTL function on an Opus decoder. *
- Generally the request and subsequent arguments are generated
- by a convenience macro.
- - parameter: st OpusDecoder*: Decoder state.
- - parameter: request This and all remaining parameters should be replaced by one
- of the convenience macros in @ref opus_genericctls or
- @ref opus_decoderctls.
- - see: opus_genericctls
- - see: opus_decoderctls
Declaration
Objective-C
int opus_decoder_ctl(OpusDecoder *st, int request, ...)
-
Frees an
OpusDecoder
allocated by opus_decoder_create().- @param[in] st OpusDecoder*: State to be freed.
Declaration
Objective-C
void opus_decoder_destroy(OpusDecoder *st)
Swift
func opus_decoder_destroy(_ st: OpaquePointer!)
-
Parse an opus packet into one or more frames.
- Opus_decode will perform this operation internally so most applications do
- not need to use this function.
- This function does not copy the frames, the returned pointers are pointers into
- the input packet.
- - parameter: [in] data char*: Opus packet to be parsed
- - parameter: [in] len opus_int32: size of data
- - parameter: [out] out_toc char*: TOC pointer
- - parameter: [out] frames char*[48] encapsulated frames
- - parameter: [out] size opus_int16[48] sizes of the encapsulated frames
- - parameter: [out] payload_offset int*: returns the position of the payload within the packet (in bytes)
- @returns number of frames
Declaration
Objective-C
int opus_packet_parse(const unsigned char *data, opus_int32 len, unsigned char *out_toc, const unsigned char *frames[48], opus_int16 size[48], int *payload_offset)
Swift
func opus_packet_parse(_ data: UnsafePointer<UInt8>, _ len: opus_int32, _ out_toc: UnsafeMutablePointer<UInt8>!, _ frames: UnsafeMutablePointer<UnsafePointer<UInt8>?>, _ size: UnsafeMutablePointer<opus_int16>!, _ payload_offset: UnsafeMutablePointer<Int32>!) -> Int32
-
Gets the bandwidth of an Opus packet.
- - parameter: [in] data char*: Opus packet
- @retval OPUS_BANDWIDTH_NARROWBAND Narrowband (4kHz bandpass)
- @retval OPUS_BANDWIDTH_MEDIUMBAND Mediumband (6kHz bandpass)
- @retval OPUS_BANDWIDTH_WIDEBAND Wideband (8kHz bandpass)
- @retval OPUS_BANDWIDTH_SUPERWIDEBAND Superwideband (12kHz bandpass)
- @retval OPUS_BANDWIDTH_FULLBAND Fullband (20kHz bandpass)
- @retval OPUS_INVALID_PACKET The compressed data passed is corrupted or of an unsupported type
Declaration
Objective-C
int opus_packet_get_bandwidth(const unsigned char *data)
Swift
func opus_packet_get_bandwidth(_ data: UnsafePointer<UInt8>) -> Int32
-
Gets the number of samples per frame from an Opus packet.
- - parameter: [in] data char*: Opus packet.
- This must contain at least one byte of
- data.
- - parameter: [in] Fs opus_int32: Sampling rate in Hz.
- This must be a multiple of 400, or
- inaccurate results will be returned.
- @returns Number of samples per frame.
Declaration
Objective-C
int opus_packet_get_samples_per_frame(const unsigned char *data, opus_int32 Fs)
Swift
func opus_packet_get_samples_per_frame(_ data: UnsafePointer<UInt8>, _ Fs: opus_int32) -> Int32
-
Gets the number of channels from an Opus packet.
- - parameter: [in] data char*: Opus packet
- @returns Number of channels
- @retval OPUS_INVALID_PACKET The compressed data passed is corrupted or of an unsupported type
Declaration
Objective-C
int opus_packet_get_nb_channels(const unsigned char *data)
Swift
func opus_packet_get_nb_channels(_ data: UnsafePointer<UInt8>) -> Int32
-
Gets the number of frames in an Opus packet.
- - parameter: [in] packet char*: Opus packet
- - parameter: [in] len opus_int32: Length of packet
- @returns Number of frames
- @retval OPUS_BAD_ARG Insufficient data was passed to the function
- @retval OPUS_INVALID_PACKET The compressed data passed is corrupted or of an unsupported type
Declaration
Objective-C
int opus_packet_get_nb_frames(const unsigned char packet[], opus_int32 len)
Swift
func opus_packet_get_nb_frames(_ packet: UnsafePointer<UInt8>, _ len: opus_int32) -> Int32
-
Gets the number of samples of an Opus packet.
- - parameter: [in] packet char*: Opus packet
- - parameter: [in] len opus_int32: Length of packet
- - parameter: [in] Fs opus_int32: Sampling rate in Hz.
- This must be a multiple of 400, or
- inaccurate results will be returned.
- @returns Number of samples
- @retval OPUS_BAD_ARG Insufficient data was passed to the function
- @retval OPUS_INVALID_PACKET The compressed data passed is corrupted or of an unsupported type
Declaration
Objective-C
int opus_packet_get_nb_samples(const unsigned char packet[], opus_int32 len, opus_int32 Fs)
Swift
func opus_packet_get_nb_samples(_ packet: UnsafePointer<UInt8>, _ len: opus_int32, _ Fs: opus_int32) -> Int32
-
Gets the number of samples of an Opus packet.
- - parameter: [in] dec OpusDecoder*: Decoder state
- - parameter: [in] packet char*: Opus packet
- - parameter: [in] len opus_int32: Length of packet
- @returns Number of samples
- @retval OPUS_BAD_ARG Insufficient data was passed to the function
- @retval OPUS_INVALID_PACKET The compressed data passed is corrupted or of an unsupported type
Declaration
Objective-C
int opus_decoder_get_nb_samples(const OpusDecoder *dec, const unsigned char packet[], opus_int32 len)
Swift
func opus_decoder_get_nb_samples(_ dec: OpaquePointer, _ packet: UnsafePointer<UInt8>, _ len: opus_int32) -> Int32
-
Applies soft-clipping to bring a float signal within the [-1,1] range. If
- the signal is already in that range, nothing is done. If there are values
- outside of [-1,1], then the signal is clipped as smoothly as possible to
- both fit in the range and avoid creating excessive distortion in the
- process.
- - parameter: [in,out] pcm float*: Input PCM and modified PCM
- - parameter: [in] frame_size int Number of samples per channel to process
- - parameter: [in] channels int: Number of channels
- - parameter: [in,out] softclip_mem float*: State memory for the soft clipping process (one float per channel, initialized to zero)
Declaration
Objective-C
void opus_pcm_soft_clip(float *pcm, int frame_size, int channels, float *softclip_mem)
Swift
func opus_pcm_soft_clip(_ pcm: UnsafeMutablePointer<Float>!, _ frame_size: Int32, _ channels: Int32, _ softclip_mem: UnsafeMutablePointer<Float>!)
-
Gets the size of an
OpusRepacketizer
structure.- @returns The size in bytes.
Declaration
Objective-C
int opus_repacketizer_get_size(void)
Swift
func opus_repacketizer_get_size() -> Int32
-
(Re)initializes a previously allocated repacketizer state.
- The state must be at least the size returned by opus_repacketizer_get_size().
- This can be used for applications which use their own allocator instead of
- malloc().
- It must also be called to reset the queue of packets waiting to be
- repacketized, which is necessary if the maximum packet duration of 120 ms
- is reached or if you wish to submit packets with a different Opus
- configuration (coding mode, audio bandwidth, frame size, or channel count).
- Failure to do so will prevent a new packet from being added with
- opus_repacketizer_cat().
- - see: opus_repacketizer_create
- - see: opus_repacketizer_get_size
- - see: opus_repacketizer_cat
- - parameter: rp OpusRepacketizer*: The repacketizer state to
- (re)initialize.
- @returns A pointer to the same repacketizer state that was passed in.
Declaration
Objective-C
OpusRepacketizer *opus_repacketizer_init(OpusRepacketizer *rp)
Swift
func opus_repacketizer_init(_ rp: OpaquePointer) -> OpaquePointer!
-
Allocates memory and initializes the new repacketizer with
- opus_repacketizer_init().
Declaration
Objective-C
OpusRepacketizer *opus_repacketizer_create(void)
Swift
func opus_repacketizer_create() -> OpaquePointer!
-
Frees an
OpusRepacketizer
allocated by- opus_repacketizer_create().
- @param[in] rp OpusRepacketizer*: State to be freed.
Declaration
Objective-C
void opus_repacketizer_destroy(OpusRepacketizer *rp)
Swift
func opus_repacketizer_destroy(_ rp: OpaquePointer!)
-
Add a packet to the current repacketizer state.
- This packet must match the configuration of any packets already submitted
- for repacketization since the last call to opus_repacketizer_init().
- This means that it must have the same coding mode, audio bandwidth, frame
- size, and channel count.
- This can be checked in advance by examining the top 6 bits of the first
- byte of the packet, and ensuring they match the top 6 bits of the first
- byte of any previously submitted packet.
- The total duration of audio in the repacketizer state also must not exceed
- 120 ms, the maximum duration of a single packet, after adding this packet. *
- The contents of the current repacketizer state can be extracted into new
- packets using opus_repacketizer_out() or opus_repacketizer_out_range(). *
- In order to add a packet with a different configuration or to add more
- audio beyond 120 ms, you must clear the repacketizer state by calling
- opus_repacketizer_init().
- If a packet is too large to add to the current repacketizer state, no part
- of it is added, even if it contains multiple frames, some of which might
- fit.
- If you wish to be able to add parts of such packets, you should first use
- another repacketizer to split the packet into pieces and add them
- individually.
- - see: opus_repacketizer_out_range
- - see: opus_repacketizer_out
- - see: opus_repacketizer_init
- - parameter: rp OpusRepacketizer*: The repacketizer state to which to
- add the packet.
- @param[in] data const unsigned char*: The packet data.
- The application must ensure
- this pointer remains valid
- until the next call to
- opus_repacketizer_init() or
- opus_repacketizer_destroy().
- - parameter: len opus_int32: The number of bytes in the packet data.
- @returns An error code indicating whether or not the operation succeeded.
- @retval #OPUS_OK The packet’s contents have been added to the repacketizer
- state.
- @retval #OPUS_INVALID_PACKET The packet did not have a valid TOC sequence,
- the packet’s TOC sequence was not compatible
- with previously submitted packets (because
- the coding mode, audio bandwidth, frame size,
- or channel count did not match), or adding
- this packet would increase the total amount of
- audio stored in the repacketizer state to more
- than 120 ms.
Declaration
Objective-C
int opus_repacketizer_cat(OpusRepacketizer *rp, const unsigned char *data, opus_int32 len)
Swift
func opus_repacketizer_cat(_ rp: OpaquePointer, _ data: UnsafePointer<UInt8>, _ len: opus_int32) -> Int32
-
Construct a new packet from data previously submitted to the repacketizer
- state via opus_repacketizer_cat().
- - parameter: rp OpusRepacketizer*: The repacketizer state from which to
- construct the new packet.
- - parameter: begin int: The index of the first frame in the current
- repacketizer state to include in the output.
- - parameter: end int: One past the index of the last frame in the
- current repacketizer state to include in the
- output.
- @param[out] data const unsigned char*: The buffer in which to
- store the output packet.
- - parameter: maxlen opus_int32: The maximum number of bytes to store in
- the output buffer. In order to guarantee
- success, this should be at least
1276
for a single frame,- or for multiple frames,
1277*(end-begin)
.- However,
1*(end-begin)
plus - the size of all packet data submitted to
- the repacketizer since the last call to
- opus_repacketizer_init() or
- opus_repacketizer_create() is also
- sufficient, and possibly much smaller.
- @returns The total size of the output packet on success, or an error code
- on failure.
- @retval #OPUS_BAD_ARG
[begin,end)
was an invalid range of - frames (begin < 0, begin >= end, or end >
- opus_repacketizer_get_nb_frames()).
- @retval #OPUS_BUFFER_TOO_SMALL \a maxlen was insufficient to contain the
- complete output packet.
Declaration
Objective-C
opus_int32 opus_repacketizer_out_range(OpusRepacketizer *rp, int begin, int end, unsigned char *data, opus_int32 maxlen)
Swift
func opus_repacketizer_out_range(_ rp: OpaquePointer, _ begin: Int32, _ end: Int32, _ data: UnsafeMutablePointer<UInt8>, _ maxlen: opus_int32) -> opus_int32
-
Return the total number of frames contained in packet data submitted to
- the repacketizer state so far via opus_repacketizer_cat() since the last
- call to opus_repacketizer_init() or opus_repacketizer_create().
- This defines the valid range of packets that can be extracted with
- opus_repacketizer_out_range() or opus_repacketizer_out().
- - parameter: rp OpusRepacketizer*: The repacketizer state containing the
- frames.
- @returns The total number of frames contained in the packet data submitted
- to the repacketizer state.
Declaration
Objective-C
int opus_repacketizer_get_nb_frames(OpusRepacketizer *rp)
Swift
func opus_repacketizer_get_nb_frames(_ rp: OpaquePointer) -> Int32
-
Construct a new packet from data previously submitted to the repacketizer
- state via opus_repacketizer_cat().
- This is a convenience routine that returns all the data submitted so far
- in a single packet.
- It is equivalent to calling
- “`
- opus_repacketizer_out_range(rp, 0, opus_repacketizer_get_nb_frames(rp),
- data, maxlen)
- ”`
- - parameter: rp OpusRepacketizer*: The repacketizer state from which to
- construct the new packet.
- @param[out] data const unsigned char*: The buffer in which to
- store the output packet.
- - parameter: maxlen opus_int32: The maximum number of bytes to store in
- the output buffer. In order to guarantee
- success, this should be at least
1277*opus_repacketizer_get_nb_frames(rp)
.- However,
1*opus_repacketizer_get_nb_frames(rp)
- plus the size of all packet data
- submitted to the repacketizer since the
- last call to opus_repacketizer_init() or
- opus_repacketizer_create() is also
- sufficient, and possibly much smaller.
- @returns The total size of the output packet on success, or an error code
- on failure.
- @retval #OPUS_BUFFER_TOO_SMALL \a maxlen was insufficient to contain the
- complete output packet.
Declaration
Objective-C
opus_int32 opus_repacketizer_out(OpusRepacketizer *rp, unsigned char *data, opus_int32 maxlen)
Swift
func opus_repacketizer_out(_ rp: OpaquePointer, _ data: UnsafeMutablePointer<UInt8>!, _ maxlen: opus_int32) -> opus_int32
-
Pads a given Opus packet to a larger size (possibly changing the TOC sequence).
- @param[in,out] data const unsigned char*: The buffer containing the
- packet to pad.
- - parameter: len opus_int32: The size of the packet.
- This must be at least 1.
- - parameter: new_len opus_int32: The desired size of the packet after padding.
- This must be at least as large as len.
- @returns an error code
- @retval #OPUS_OK \a on success.
- @retval #OPUS_BAD_ARG \a len was less than 1 or new_len was less than len.
- @retval #OPUS_INVALID_PACKET \a data did not contain a valid Opus packet.
Declaration
Objective-C
int opus_packet_pad(unsigned char *data, opus_int32 len, opus_int32 new_len)
Swift
func opus_packet_pad(_ data: UnsafeMutablePointer<UInt8>!, _ len: opus_int32, _ new_len: opus_int32) -> Int32
-
Remove all padding from a given Opus packet and rewrite the TOC sequence to
- minimize space usage.
- @param[in,out] data const unsigned char*: The buffer containing the
- packet to strip.
- - parameter: len opus_int32: The size of the packet.
- This must be at least 1.
- @returns The new size of the output packet on success, or an error code
- on failure.
- @retval #OPUS_BAD_ARG \a len was less than 1.
- @retval #OPUS_INVALID_PACKET \a data did not contain a valid Opus packet.
Declaration
Objective-C
opus_int32 opus_packet_unpad(unsigned char *data, opus_int32 len)
Swift
func opus_packet_unpad(_ data: UnsafeMutablePointer<UInt8>!, _ len: opus_int32) -> opus_int32
-
Pads a given Opus multi-stream packet to a larger size (possibly changing the TOC sequence).
- @param[in,out] data const unsigned char*: The buffer containing the
- packet to pad.
- - parameter: len opus_int32: The size of the packet.
- This must be at least 1.
- - parameter: new_len opus_int32: The desired size of the packet after padding.
- This must be at least 1.
- - parameter: nb_streams opus_int32: The number of streams (not channels) in the packet.
- This must be at least as large as len.
- @returns an error code
- @retval #OPUS_OK \a on success.
- @retval #OPUS_BAD_ARG \a len was less than 1.
- @retval #OPUS_INVALID_PACKET \a data did not contain a valid Opus packet.
Declaration
Objective-C
int opus_multistream_packet_pad(unsigned char *data, opus_int32 len, opus_int32 new_len, int nb_streams)
Swift
func opus_multistream_packet_pad(_ data: UnsafeMutablePointer<UInt8>!, _ len: opus_int32, _ new_len: opus_int32, _ nb_streams: Int32) -> Int32
-
Remove all padding from a given Opus multi-stream packet and rewrite the TOC sequence to
- minimize space usage.
- @param[in,out] data const unsigned char*: The buffer containing the
- packet to strip.
- - parameter: len opus_int32: The size of the packet.
- This must be at least 1.
- - parameter: nb_streams opus_int32: The number of streams (not channels) in the packet.
- This must be at least 1.
- @returns The new size of the output packet on success, or an error code
- on failure.
- @retval #OPUS_BAD_ARG \a len was less than 1 or new_len was less than len.
- @retval #OPUS_INVALID_PACKET \a data did not contain a valid Opus packet.
Declaration
Objective-C
opus_int32 opus_multistream_packet_unpad(unsigned char *data, opus_int32 len, int nb_streams)
Swift
func opus_multistream_packet_unpad(_ data: UnsafeMutablePointer<UInt8>!, _ len: opus_int32, _ nb_streams: Int32) -> opus_int32
-
Converts an opus error code into a human readable string. *
- @param[in] error int: Error number
- @returns Error string
Declaration
Objective-C
const char *opus_strerror(int error)
Swift
func opus_strerror(_ error: Int32) -> UnsafePointer<CChar>!
-
Gets the libopus version string. *
- @returns Version string
Declaration
Objective-C
const char *opus_get_version_string(void)
Swift
func opus_get_version_string() -> UnsafePointer<CChar>!