Unsafe version of: projection_ambisonics_encoder_create

Unsafe version of: projection_ambisonics_encoder_init

Unsafe version of: projection_decode

Parameters

len:int

number of bytes in payload

Unsafe version of: projection_decode_float

Parameters

len:int

number of bytes in payload

Unsafe version of: projection_decoder_create

Parameters

demixing_matrix_size:int

the size in bytes if the demixing matrix

Unsafe version of: projection_decoder_init

Parameters

demixing_matrix_size:int

the size in bytes if the demixing matrix

Unsafe version of: projection_encode

Parameters

max_data_bytes:int

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 SET_BITRATE_REQUEST to control the bitrate.

Unsafe version of: projection_encode_float

Parameters

max_data_bytes:int

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 SET_BITRATE_REQUEST to control the bitrate.

Allocates and initializes a projection encoder state.

Call projection_encoder_destroy to release this object when finished.

Parameters

Fs:int

sampling rate of the input signal (in Hz). One of:

8000

12000

16000

24000

48000

channels:int

number of channels in the input signal. This must be at most 255. It may be greater than the number of coded channels (streams + coupled_streams).

mapping_family:int

the mapping family to use for selecting the appropriate projection

streams:IntBuffer

the total number of streams that will be encoded from the input

coupled_streams:IntBuffer

number of coupled (2 channel) streams to encode that will be encoded from the input

application:int

the target encoder application

error:IntBuffer

returns OK on success, or a negative error code on failure

Annotations

@NativeType:OpusProjectionEncoder *

Gets the size of an OpusProjectionEncoder structure.

Parameters

channels:int

the total number of input channels to encode. This must be no more than 255.

mapping_family:int

the mapping family to use for selecting the appropriate projection

Returns:int

the size in bytes on success, or a negative error code

Annotations

@NativeType:opus_int32

Initialize a previously allocated projection encoder state.

The memory pointed to by st must be at least the size returned by projection_ambisonics_encoder_get_size. This is intended for applications which use their own allocator instead of malloc.

To reset a previously initialized state, use the RESET_STATE CTL.

Parameters

st:long

projection encoder state to initialize

Fs:int

sampling rate of the input signal (in Hz). One of:

8000

12000

16000

24000

48000

channels:int

number of channels in the input signal. This must be at most 255. It may be greater than the number of coded channels (streams + coupled_streams).

streams:IntBuffer

the total number of streams that will be encoded from the input

coupled_streams:IntBuffer

number of coupled (2 channel) streams to encode that will be encoded from the input. Additionally, the total number of encoded channels (streams + coupled_streams) must be no more than the number of input channels.

application:int

the target encoder application

Returns:int

OK on success, or a negative error code on failure

Decode a projection Opus packet.

Parameters

st:long

projection decoder state

data:ByteBuffer

input payload (Use a NULL pointer to indicate packet loss)

pcm:ShortBuffer

output signal, with interleaved samples. This must contain room for frame_size*channels samples.

frame_size:int

number of samples per channel of available space in 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.

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:int

number of decoded samples on success or a negative error code on failure

Decode a projection Opus packet with floating point output.

Parameters

st:long

projection decoder state

data:ByteBuffer

input payload. Use a NULL pointer to indicate packet loss

pcm:FloatBuffer

output signal, with interleaved samples. (This must contain room for frame_size*channels samples.)

frame_size:int

number of samples per channel of available space in 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.

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:int

number of decoded samples on success or a negative error code on failure

Allocates and initializes a projection decoder state.

Call projection_decoder_destroy to release this object when finished.

Parameters

Fs:int

sampling rate of input signal (Hz). One of:

8000

12000

16000

24000

48000

channels:int

number of channels to output

streams:int

the total number of streams coded in the input. This must be no more than 255.

coupled_streams:int

number streams to decode as coupled (2 channel) streams. This must be no larger than the total number of streams. Additionally, The total number of coded channels (streams + coupled_streams) must be no more than 255.

demixing_matrix:ByteBuffer

demixing matrix that maps from coded channels to output channels

error:IntBuffer

returns OK on success, or a negative error code on failure

Annotations

@NativeType:OpusProjectionDecoder *

Performs a CTL function on a projection Opus decoder.

Parameters

st:long

projection decoder state

request:int

CTL request

Performs a CTL function on a projection Opus decoder.

Parameters

st:long

projection decoder state

request:Opus.CTLRequest

CTL request

Frees an OpusProjectionDecoder allocated by projection_decoder_create.

Parameters

st:long

projection decoder state to be freed

Gets the size of an OpusProjectionDecoder structure.

Parameters

channels:int

the total number of output channels. This must be no more than 255.

streams:int

the total number of streams coded in the input

coupled_streams:int

number streams to decode as coupled (2 channel) streams. This must be no larger than the total number of streams. Additionally, The total number of coded channels (streams + coupled_streams) must be no more than 255.

Returns:int

the size in bytes on success, or a negative error code on failure

Annotations

@NativeType:opus_int32

Initialize a previously allocated projection decoder state object.

The memory pointed to by st must be at least the size returned by projection_decoder_get_size. This is intended for applications which use their own allocator instead of malloc.

To reset a previously initialized state, use the RESET_STATE CTL.

Parameters

st:long

projection decoder state to initialize

Fs:int

sampling rate of input signal (Hz). One of:

8000

12000

16000

24000

48000

channels:int

number of channels to output. This mustbe at most 255. It may be different from the number of coded channels (stream + coupled_streams).

streams:int

the total number of streams coded in the input. This must be no more than 255.

coupled_streams:int

number streams to decode as coupled (2 channel) streams. This must be no larger than the total number of streams. Additionally, The total number of coded channels (streams + coupled_streams) must be no more than 255.

demixing_matrix:ByteBuffer

demixing matrix that maps from coded channels to output channels

Returns:int

OK on success, or a negative error code on failure

Encodes a projection Opus frame.

Parameters

st:long

projection encoder state

pcm:ShortBuffer

the input signal as interleaved samples. This must contain frame_size*channels samples.

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.

data:ByteBuffer

output payload. This must contain storage for at max_data_bytes.

Returns:int

the length of the encoded packet (in bytes) on success or a negative error code on failure

Encodes a projection Opus frame from floating point input.

Parameters

st:long

projection encoder state

pcm:FloatBuffer

the input signal as interleaved samples 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. This must contain frame_size*channels samples.

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.

data:ByteBuffer

output payload. This must contain storage for at max_data_bytes.

Returns:int

the length of the encoded packet (in bytes) on success or a negative error code on failure

Performs a CTL function on an projection Opus encoder.

Parameters

st:long

projection encoder state

request:int

CTL request

Performs a CTL function on an projection Opus encoder.

Parameters

st:long

projection encoder state

request:Opus.CTLRequest

CTL request

Frees an OpusProjectionEncoder allocated by projection_ambisonics_encoder_create.

Parameters

st:long

projection encoder state to be freed

Copies the demixing matrix to the supplied pointer location.

Parameters

matrix:ByteBuffer

returns the demixing matrix to the supplied pointer location.

Gets the gain (in dB. S7.8-format) of the demixing matrix from the encoder.

Returns:Opus.CTLRequest

the gain (in dB. S7.8-format) of the demixing matrix.

Gets the size in bytes of the demixing matrix from the encoder.

Returns:Opus.CTLRequest

the size in bytes of the demixing matrix.