FunctionsAndGlobals class
Properties
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(Invocation invocation)
→ dynamic
-
Invoked when a nonexistent method or property is accessed.
inherited
-
opus_projection_ambisonics_encoder_create(int Fs, int channels, int mapping_family, Pointer<Int32> streams, Pointer<Int32> coupled_streams, int application, Pointer<Int32> error)
→ Pointer<OpusProjectionEncoder>
-
Allocates and initializes a projection encoder state.
Call opus_projection_encoder_destroy() to release
this object when finished.
@param Fs opus_int32: Sampling rate of the input signal (in Hz).
This must be one of 8000, 12000, 16000,
24000, or 48000.
@param 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).
@param mapping_family int: The mapping family to use for selecting
the appropriate projection.
@paramout streams int *: The total number of streams that will
be encoded from the input.
@paramout coupled_streams int *: Number of coupled (2 channel)
streams that will be encoded from the input.
@param application int: The target encoder application.
This must be one of the following:
-
opus_projection_ambisonics_encoder_get_size(int channels, int mapping_family)
→ int
-
Gets the size of an OpusProjectionEncoder structure.
@param channels int: The total number of input channels to encode.
This must be no more than 255.
@param mapping_family int: The mapping family to use for selecting
the appropriate projection.
@returns The size in bytes on success, or a negative error code
(see @ref opus_errorcodes) on error.
-
opus_projection_ambisonics_encoder_init(Pointer<OpusProjectionEncoder> st, int Fs, int channels, int mapping_family, Pointer<Int32> streams, Pointer<Int32> coupled_streams, int application)
→ int
-
Initialize a previously allocated projection encoder state.
The memory pointed to by a st must be at least the size returned by
opus_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 #OPUS_RESET_STATE CTL.
@see opus_projection_ambisonics_encoder_create
@see opus_projection_ambisonics_encoder_get_size
@param st OpusProjectionEncoder*: Projection encoder state to initialize.
@param Fs opus_int32: Sampling rate of the input signal (in Hz).
This must be one of 8000, 12000, 16000,
24000, or 48000.
@param 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).
@param streams int: The total number of streams to encode from the
input.
This must be no more than the number of channels.
@param coupled_streams int: Number of coupled (2 channel) streams
to encode.
This must be no larger than the total
number of streams.
Additionally, The total number of
encoded channels (streams +
coupled_streams) must be no
more than the number of input channels.
@param application int: The target encoder application.
This must be one of the following:
-
opus_projection_decode(Pointer<OpusProjectionDecoder> st, Pointer<Uint8> data, int len, Pointer<Int16> pcm, int frame_size, int decode_fec)
→ int
-
Decode a projection Opus packet.
@param st OpusProjectionDecoder*: Projection decoder state.
@param
in data const unsigned char*: Input payload.
Use a NULL
pointer to indicate packet
loss.
@param len opus_int32: Number of bytes in payload.
@paramout pcm opus_int16*: Output signal, with interleaved
samples.
This must contain room for
frame_size*channels
samples.
@param frame_size int: The number of samples per channel of
available space in a pcm.
If this is less than the maximum packet duration
(120 ms; 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.
@param 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 samples decoded on success or a negative error code
(see @ref opus_errorcodes) on failure.
-
opus_projection_decode_float(Pointer<OpusProjectionDecoder> st, Pointer<Uint8> data, int len, Pointer<Float> pcm, int frame_size, int decode_fec)
→ int
-
Decode a projection Opus packet with floating point output.
@param st OpusProjectionDecoder*: Projection decoder state.
@param
in data const unsigned char*: Input payload.
Use a NULL
pointer to indicate packet
loss.
@param len opus_int32: Number of bytes in payload.
@paramout pcm opus_int16*: Output signal, with interleaved
samples.
This must contain room for
frame_size*channels
samples.
@param frame_size int: The number of samples per channel of
available space in a pcm.
If this is less than the maximum packet duration
(120 ms; 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.
@param 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 samples decoded on success or a negative error code
(see @ref opus_errorcodes) on failure.
-
opus_projection_decoder_create(int Fs, int channels, int streams, int coupled_streams, Pointer<Uint8> demixing_matrix, int demixing_matrix_size, Pointer<Int32> error)
→ Pointer<OpusProjectionDecoder>
-
Allocates and initializes a projection decoder state.
Call opus_projection_decoder_destroy() to release
this object when finished.
@param Fs opus_int32: Sampling rate to decode at (in Hz).
This must be one of 8000, 12000, 16000,
24000, or 48000.
@param channels int: Number of channels to output.
This must be at most 255.
It may be different from the number of coded
channels (
streams +
coupled_streams).
@param streams int: The total number of streams coded in the
input.
This must be no more than 255.
@param coupled_streams int: Number of 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.
@paramin demixing_matrix const unsigned chardemixing_matrix_size: Demixing matrix
that mapping from coded channels to output channels,
as described in @ref opus_projection and
@ref opus_projection_ctls.
@param demixing_matrix_size opus_int32: The size in bytes of the
demixing matrix, as
described in @ref
opus_projection_ctls.
@paramout error int *: Returns #OPUS_OK on success, or an error
code (see @ref opus_errorcodes) on
failure.
-
opus_projection_decoder_destroy(Pointer<OpusProjectionDecoder> st)
→ void
-
Frees an
OpusProjectionDecoder allocated by
opus_projection_decoder_create().
@param st OpusProjectionDecoder: Projection decoder state to be freed.
-
opus_projection_decoder_get_size(int channels, int streams, int coupled_streams)
→ int
-
Gets the size of an
OpusProjectionDecoder structure.
@param channels int: The total number of output channels.
This must be no more than 255.
@param streams int: The total number of streams coded in the
input.
This must be no more than 255.
@param 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 The size in bytes on success, or a negative error code
(see @ref opus_errorcodes) on error.
-
opus_projection_decoder_init(Pointer<OpusProjectionDecoder> st, int Fs, int channels, int streams, int coupled_streams, Pointer<Uint8> demixing_matrix, int demixing_matrix_size)
→ int
-
Intialize a previously allocated projection decoder state object.
The memory pointed to by a st must be at least the size returned by
opus_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 #OPUS_RESET_STATE CTL.
@see opus_projection_decoder_create
@see opus_projection_deocder_get_size
@param st OpusProjectionDecoder*: Projection encoder state to initialize.
@param Fs opus_int32: Sampling rate to decode at (in Hz).
This must be one of 8000, 12000, 16000,
24000, or 48000.
@param channels int: Number of channels to output.
This must be at most 255.
It may be different from the number of coded
channels (
streams +
coupled_streams).
@param streams int: The total number of streams coded in the
input.
This must be no more than 255.
@param coupled_streams int: Number of 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.
@paramin demixing_matrix const unsigned chardemixing_matrix_size: Demixing matrix
that mapping from coded channels to output channels,
as described in @ref opus_projection and
@ref opus_projection_ctls.
@param demixing_matrix_size opus_int32: The size in bytes of the
demixing matrix, as
described in @ref
opus_projection_ctls.
@returns #OPUS_OK on success, or an error code (see @ref opus_errorcodes)
on failure.
-
opus_projection_encode(Pointer<OpusProjectionEncoder> st, Pointer<Int16> pcm, int frame_size, Pointer<Uint8> data, int max_data_bytes)
→ int
-
Encodes a projection Opus frame.
@param st OpusProjectionEncoder*: Projection encoder state.
@param
in pcm const opus_int16*: The input signal as interleaved
samples.
This must contain
frame_sizechannels
samples.
@param 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.
@paramout data unsigned char: Output payload.
This must contain storage for at
least a max_data_bytes.
@param 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.
-
opus_projection_encode_float(Pointer<OpusProjectionEncoder> st, Pointer<Float> pcm, int frame_size, Pointer<Uint8> data, int max_data_bytes)
→ int
-
Encodes a projection Opus frame from floating point input.
@param st OpusProjectionEncoder*: Projection encoder state.
@param
in pcm const float*: 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_sizechannels
samples.
@param 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.
@paramout data unsigned char: Output payload.
This must contain storage for at
least a max_data_bytes.
@param 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.
-
opus_projection_encoder_destroy(Pointer<OpusProjectionEncoder> st)
→ void
-
Frees an
OpusProjectionEncoder allocated by
opus_projection_ambisonics_encoder_create().
@param st OpusProjectionEncoder*: Projection encoder state to be freed.
-
toString()
→ String
-
A string representation of this object.
inherited
