net.tomp2p.opuswrapper

Interface Opus

All Superinterfaces:

com.sun.jna.Library

public interface Opus
extends com.sun.jna.Library

JNA Wrapper for library opus
This file was autogenerated by JNAerator,
a tool written by Olivier Chafik that uses a few opensource projects..
For help, please visit NativeLibs4Java , Rococoa, or JNA.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Opus.OpusCustomDecoder
static class	Opus.OpusCustomEncoder
static class	Opus.OpusCustomMode
static class	Opus.OpusDecoder
static class	Opus.OpusEncoder
static class	Opus.OpusMSDecoder
static class	Opus.OpusMSEncoder
static class	Opus.OpusRepacketizer

Nested classes/interfaces inherited from interface com.sun.jna.Library

com.sun.jna.Library.Handler

Field Summary

Fields

Modifier and Type	Field and Description
static Opus	INSTANCE
static String	JNA_LIBRARY_NAME
static com.sun.jna.NativeLibrary	JNA_NATIVE_LIB
static int	OPUS_ALLOC_FAIL native declaration : /tmp/opus_defines.h
static int	OPUS_APPLICATION_AUDIO native declaration : /tmp/opus_defines.h
static int	OPUS_APPLICATION_RESTRICTED_LOWDELAY native declaration : /tmp/opus_defines.h
static int	OPUS_APPLICATION_VOIP native declaration : /tmp/opus_defines.h
static int	OPUS_AUTO native declaration : /tmp/opus_defines.h
static int	OPUS_BAD_ARG native declaration : /tmp/opus_defines.h
static int	OPUS_BANDWIDTH_FULLBAND native declaration : /tmp/opus_defines.h
static int	OPUS_BANDWIDTH_MEDIUMBAND native declaration : /tmp/opus_defines.h
static int	OPUS_BANDWIDTH_NARROWBAND native declaration : /tmp/opus_defines.h
static int	OPUS_BANDWIDTH_SUPERWIDEBAND native declaration : /tmp/opus_defines.h
static int	OPUS_BANDWIDTH_WIDEBAND native declaration : /tmp/opus_defines.h
static int	OPUS_BITRATE_MAX native declaration : /tmp/opus_defines.h
static int	OPUS_BUFFER_TOO_SMALL native declaration : /tmp/opus_defines.h
static int	OPUS_FRAMESIZE_10_MS native declaration : /tmp/opus_defines.h
static int	OPUS_FRAMESIZE_2_5_MS native declaration : /tmp/opus_defines.h
static int	OPUS_FRAMESIZE_20_MS native declaration : /tmp/opus_defines.h
static int	OPUS_FRAMESIZE_40_MS native declaration : /tmp/opus_defines.h
static int	OPUS_FRAMESIZE_5_MS native declaration : /tmp/opus_defines.h
static int	OPUS_FRAMESIZE_60_MS native declaration : /tmp/opus_defines.h
static int	OPUS_FRAMESIZE_ARG native declaration : /tmp/opus_defines.h
static int	OPUS_GET_APPLICATION_REQUEST native declaration : /tmp/opus_defines.h
static int	OPUS_GET_BANDWIDTH_REQUEST native declaration : /tmp/opus_defines.h
static int	OPUS_GET_BITRATE_REQUEST native declaration : /tmp/opus_defines.h
static int	OPUS_GET_COMPLEXITY_REQUEST native declaration : /tmp/opus_defines.h
static int	OPUS_GET_DTX_REQUEST native declaration : /tmp/opus_defines.h
static int	OPUS_GET_EXPERT_FRAME_DURATION_REQUEST native declaration : /tmp/opus_defines.h
static int	OPUS_GET_FINAL_RANGE_REQUEST native declaration : /tmp/opus_defines.h
static int	OPUS_GET_FORCE_CHANNELS_REQUEST native declaration : /tmp/opus_defines.h
static int	OPUS_GET_GAIN_REQUEST native declaration : /tmp/opus_defines.h
static int	OPUS_GET_INBAND_FEC_REQUEST native declaration : /tmp/opus_defines.h
static int	OPUS_GET_LAST_PACKET_DURATION_REQUEST native declaration : /tmp/opus_defines.h
static int	OPUS_GET_LOOKAHEAD_REQUEST native declaration : /tmp/opus_defines.h
static int	OPUS_GET_LSB_DEPTH_REQUEST native declaration : /tmp/opus_defines.h
static int	OPUS_GET_MAX_BANDWIDTH_REQUEST native declaration : /tmp/opus_defines.h
static int	OPUS_GET_PACKET_LOSS_PERC_REQUEST native declaration : /tmp/opus_defines.h
static int	OPUS_GET_PITCH_REQUEST native declaration : /tmp/opus_defines.h
static int	OPUS_GET_PREDICTION_DISABLED_REQUEST native declaration : /tmp/opus_defines.h
static int	OPUS_GET_SAMPLE_RATE_REQUEST native declaration : /tmp/opus_defines.h
static int	OPUS_GET_SIGNAL_REQUEST native declaration : /tmp/opus_defines.h
static int	OPUS_GET_VBR_CONSTRAINT_REQUEST native declaration : /tmp/opus_defines.h
static int	OPUS_GET_VBR_REQUEST native declaration : /tmp/opus_defines.h
static int	OPUS_INTERNAL_ERROR native declaration : /tmp/opus_defines.h
static int	OPUS_INVALID_PACKET native declaration : /tmp/opus_defines.h
static int	OPUS_INVALID_STATE native declaration : /tmp/opus_defines.h
static int	OPUS_MULTISTREAM_GET_DECODER_STATE_REQUEST native declaration : /tmp/opus_multistream.h
static int	OPUS_MULTISTREAM_GET_ENCODER_STATE_REQUEST native declaration : /tmp/opus_multistream.h
static int	OPUS_OK native declaration : /tmp/opus_defines.h
static int	OPUS_RESET_STATE native declaration : /tmp/opus_defines.h
static int	OPUS_SET_APPLICATION_REQUEST native declaration : /tmp/opus_defines.h
static int	OPUS_SET_BANDWIDTH_REQUEST native declaration : /tmp/opus_defines.h
static int	OPUS_SET_BITRATE_REQUEST native declaration : /tmp/opus_defines.h
static int	OPUS_SET_COMPLEXITY_REQUEST native declaration : /tmp/opus_defines.h
static int	OPUS_SET_DTX_REQUEST native declaration : /tmp/opus_defines.h
static int	OPUS_SET_EXPERT_FRAME_DURATION_REQUEST native declaration : /tmp/opus_defines.h
static int	OPUS_SET_FORCE_CHANNELS_REQUEST native declaration : /tmp/opus_defines.h
static int	OPUS_SET_GAIN_REQUEST native declaration : /tmp/opus_defines.h
static int	OPUS_SET_INBAND_FEC_REQUEST native declaration : /tmp/opus_defines.h
static int	OPUS_SET_LSB_DEPTH_REQUEST native declaration : /tmp/opus_defines.h
static int	OPUS_SET_MAX_BANDWIDTH_REQUEST native declaration : /tmp/opus_defines.h
static int	OPUS_SET_PACKET_LOSS_PERC_REQUEST native declaration : /tmp/opus_defines.h
static int	OPUS_SET_PREDICTION_DISABLED_REQUEST native declaration : /tmp/opus_defines.h
static int	OPUS_SET_SIGNAL_REQUEST native declaration : /tmp/opus_defines.h
static int	OPUS_SET_VBR_CONSTRAINT_REQUEST native declaration : /tmp/opus_defines.h
static int	OPUS_SET_VBR_REQUEST native declaration : /tmp/opus_defines.h
static int	OPUS_SIGNAL_MUSIC native declaration : /tmp/opus_defines.h
static int	OPUS_SIGNAL_VOICE native declaration : /tmp/opus_defines.h
static int	OPUS_UNIMPLEMENTED native declaration : /tmp/opus_defines.h

Fields inherited from interface com.sun.jna.Library

OPTION_ALLOW_OBJECTS, OPTION_CALLING_CONVENTION, OPTION_CLASSLOADER, OPTION_FUNCTION_MAPPER, OPTION_INVOCATION_MAPPER, OPTION_OPEN_FLAGS, OPTION_STRING_ENCODING, OPTION_STRUCTURE_ALIGNMENT, OPTION_TYPE_MAPPER

Method Summary

Methods

Modifier and Type	Method and Description
int	opus_custom_decode_float(com.sun.jna.ptr.PointerByReference st, byte[] data, int len, FloatBuffer pcm, int frame_size) Decode an opus custom frame with floating point output
int	opus_custom_decode_float(com.sun.jna.ptr.PointerByReference st, com.sun.jna.Pointer data, int len, com.sun.jna.ptr.FloatByReference pcm, int frame_size) Decode an opus custom frame with floating point output
int	opus_custom_decode(com.sun.jna.ptr.PointerByReference st, byte[] data, int len, ShortBuffer pcm, int frame_size) Decode an opus custom frame
int	opus_custom_decode(com.sun.jna.ptr.PointerByReference st, com.sun.jna.Pointer data, int len, com.sun.jna.ptr.ShortByReference pcm, int frame_size) Decode an opus custom frame
com.sun.jna.ptr.PointerByReference	opus_custom_decoder_create(com.sun.jna.ptr.PointerByReference mode, int channels, IntBuffer error) Creates a new decoder state.
com.sun.jna.ptr.PointerByReference	opus_custom_decoder_create(com.sun.jna.ptr.PointerByReference mode, int channels, com.sun.jna.ptr.IntByReference error) Creates a new decoder state.
int	opus_custom_decoder_ctl(com.sun.jna.ptr.PointerByReference st, int request, Object... varargs) Perform a CTL function on an Opus custom decoder. * Generally the request and subsequent arguments are generated by a convenience macro.
void	opus_custom_decoder_destroy(com.sun.jna.ptr.PointerByReference st) Destroys a an decoder state.
int	opus_custom_decoder_get_size(com.sun.jna.ptr.PointerByReference mode, int channels) Gets the size of an OpusCustomDecoder structure.
int	opus_custom_decoder_init(com.sun.jna.ptr.PointerByReference st, com.sun.jna.ptr.PointerByReference mode, int channels) Initializes a previously allocated decoder state The memory pointed to by st must be the size returned by opus_custom_decoder_get_size. This is intended for applications which use their own allocator instead of malloc.
int	opus_custom_encode_float(com.sun.jna.ptr.PointerByReference st, float[] pcm, int frame_size, ByteBuffer compressed, int maxCompressedBytes) Encodes a frame of audio.
int	opus_custom_encode_float(com.sun.jna.ptr.PointerByReference st, com.sun.jna.ptr.FloatByReference pcm, int frame_size, com.sun.jna.Pointer compressed, int maxCompressedBytes) Encodes a frame of audio.
int	opus_custom_encode(com.sun.jna.ptr.PointerByReference st, ShortBuffer pcm, int frame_size, ByteBuffer compressed, int maxCompressedBytes) Encodes a frame of audio.
int	opus_custom_encode(com.sun.jna.ptr.PointerByReference st, com.sun.jna.ptr.ShortByReference pcm, int frame_size, com.sun.jna.Pointer compressed, int maxCompressedBytes) Encodes a frame of audio.
com.sun.jna.ptr.PointerByReference	opus_custom_encoder_create(com.sun.jna.ptr.PointerByReference mode, int channels, IntBuffer error) Creates a new encoder state.
com.sun.jna.ptr.PointerByReference	opus_custom_encoder_create(com.sun.jna.ptr.PointerByReference mode, int channels, com.sun.jna.ptr.IntByReference error) Creates a new encoder state.
int	opus_custom_encoder_ctl(com.sun.jna.ptr.PointerByReference st, int request, Object... varargs) Perform a CTL function on an Opus custom encoder. * Generally the request and subsequent arguments are generated by a convenience macro.
void	opus_custom_encoder_destroy(com.sun.jna.ptr.PointerByReference st) Destroys a an encoder state.
int	opus_custom_encoder_get_size(com.sun.jna.ptr.PointerByReference mode, int channels) Gets the size of an OpusCustomEncoder structure.
com.sun.jna.ptr.PointerByReference	opus_custom_mode_create(int Fs, int frame_size, IntBuffer error) Creates a new mode struct.
void	opus_custom_mode_destroy(com.sun.jna.ptr.PointerByReference mode) Destroys a mode struct.
int	opus_decode_float(com.sun.jna.ptr.PointerByReference st, byte[] data, int len, FloatBuffer pcm, int frame_size, int decode_fec) Decode an Opus packet with floating point output.
int	opus_decode_float(com.sun.jna.ptr.PointerByReference st, com.sun.jna.Pointer data, int len, com.sun.jna.ptr.FloatByReference pcm, int frame_size, int decode_fec) Decode an Opus packet with floating point output.
int	opus_decode(com.sun.jna.ptr.PointerByReference st, byte[] data, int len, ShortBuffer pcm, int frame_size, int decode_fec) Decode an Opus packet.
int	opus_decode(com.sun.jna.ptr.PointerByReference st, com.sun.jna.Pointer data, int len, com.sun.jna.ptr.ShortByReference pcm, int frame_size, int decode_fec) Decode an Opus packet.
com.sun.jna.ptr.PointerByReference	opus_decoder_create(int Fs, int channels, IntBuffer error) Allocates and initializes a decoder state.
int	opus_decoder_ctl(com.sun.jna.ptr.PointerByReference st, int request, Object... varargs) Perform a CTL function on an Opus decoder. * Generally the request and subsequent arguments are generated by a convenience macro.
void	opus_decoder_destroy(com.sun.jna.ptr.PointerByReference st) Frees an OpusDecoder allocated by opus_decoder_create().
int	opus_decoder_get_nb_samples(com.sun.jna.ptr.PointerByReference dec, byte[] packet, int len) Gets the number of samples of an Opus packet.
int	opus_decoder_get_nb_samples(com.sun.jna.ptr.PointerByReference dec, com.sun.jna.Pointer packet, int len) Gets the number of samples of an Opus packet.
int	opus_decoder_get_size(int channels) Gets the size of an OpusDecoder structure.
int	opus_decoder_init(com.sun.jna.ptr.PointerByReference st, int Fs, int channels) 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.
int	opus_encode_float(com.sun.jna.ptr.PointerByReference st, float[] pcm, int frame_size, ByteBuffer data, int max_data_bytes) Encodes an Opus frame from floating point input.
int	opus_encode_float(com.sun.jna.ptr.PointerByReference st, com.sun.jna.ptr.FloatByReference pcm, int frame_size, com.sun.jna.Pointer data, int max_data_bytes) Encodes an Opus frame from floating point input.
int	opus_encode(com.sun.jna.ptr.PointerByReference st, ShortBuffer pcm, int frame_size, ByteBuffer data, int max_data_bytes) Encodes an Opus frame.
int	opus_encode(com.sun.jna.ptr.PointerByReference st, com.sun.jna.ptr.ShortByReference pcm, int frame_size, com.sun.jna.Pointer data, int max_data_bytes) Encodes an Opus frame.
com.sun.jna.ptr.PointerByReference	opus_encoder_create(int Fs, int channels, int application, IntBuffer error) 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.
int	opus_encoder_ctl(com.sun.jna.ptr.PointerByReference st, int request, Object... varargs) Perform a CTL function on an Opus encoder. * Generally the request and subsequent arguments are generated by a convenience macro.
void	opus_encoder_destroy(com.sun.jna.ptr.PointerByReference st) Frees an OpusEncoder allocated by opus_encoder_create().
int	opus_encoder_get_size(int channels) Gets the size of an OpusEncoder structure.
int	opus_encoder_init(com.sun.jna.ptr.PointerByReference st, int Fs, int channels, int application) 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.
String	opus_get_version_string() Gets the libopus version string. * @returns Version string Original signature : char* opus_get_version_string() native declaration : /tmp/opus_defines.h:718
int	opus_multistream_decode_float(com.sun.jna.ptr.PointerByReference st, byte[] data, int len, FloatBuffer pcm, int frame_size, int decode_fec) Decode a multistream Opus packet with floating point output.
int	opus_multistream_decode_float(com.sun.jna.ptr.PointerByReference st, com.sun.jna.Pointer data, int len, com.sun.jna.ptr.FloatByReference pcm, int frame_size, int decode_fec) Decode a multistream Opus packet with floating point output.
int	opus_multistream_decode(com.sun.jna.ptr.PointerByReference st, byte[] data, int len, ShortBuffer pcm, int frame_size, int decode_fec) Decode a multistream Opus packet.
int	opus_multistream_decode(com.sun.jna.ptr.PointerByReference st, com.sun.jna.Pointer data, int len, com.sun.jna.ptr.ShortByReference pcm, int frame_size, int decode_fec) Decode a multistream Opus packet.
com.sun.jna.ptr.PointerByReference	opus_multistream_decoder_create(int Fs, int channels, int streams, int coupled_streams, byte[] mapping, IntBuffer error) Allocates and initializes a multistream decoder state. Call opus_multistream_decoder_destroy() to release this object when finished.
int	opus_multistream_decoder_ctl(com.sun.jna.ptr.PointerByReference st, int request, Object... varargs) Perform a CTL function on a multistream Opus decoder. * Generally the request and subsequent arguments are generated by a convenience macro.
void	opus_multistream_decoder_destroy(com.sun.jna.ptr.PointerByReference st) Frees an OpusMSDecoder allocated by opus_multistream_decoder_create().
int	opus_multistream_decoder_get_size(int streams, int coupled_streams) Gets the size of an OpusMSDecoder structure.
int	opus_multistream_decoder_init(com.sun.jna.ptr.PointerByReference st, int Fs, int channels, int streams, int coupled_streams, byte[] mapping) Intialize a previously allocated decoder state object. The memory pointed to by \a st must be at least the size returned by opus_multistream_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.
int	opus_multistream_decoder_init(com.sun.jna.ptr.PointerByReference st, int Fs, int channels, int streams, int coupled_streams, com.sun.jna.Pointer mapping) Intialize a previously allocated decoder state object. The memory pointed to by \a st must be at least the size returned by opus_multistream_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.
int	opus_multistream_encode_float(com.sun.jna.ptr.PointerByReference st, float[] pcm, int frame_size, ByteBuffer data, int max_data_bytes) Encodes a multistream Opus frame from floating point input.
int	opus_multistream_encode_float(com.sun.jna.ptr.PointerByReference st, com.sun.jna.ptr.FloatByReference pcm, int frame_size, com.sun.jna.Pointer data, int max_data_bytes) Encodes a multistream Opus frame from floating point input.
int	opus_multistream_encode(com.sun.jna.ptr.PointerByReference st, ShortBuffer pcm, int frame_size, ByteBuffer data, int max_data_bytes) Encodes a multistream Opus frame.
int	opus_multistream_encode(com.sun.jna.ptr.PointerByReference st, com.sun.jna.ptr.ShortByReference pcm, int frame_size, com.sun.jna.Pointer data, int max_data_bytes) Encodes a multistream Opus frame.
com.sun.jna.ptr.PointerByReference	opus_multistream_encoder_create(int Fs, int channels, int streams, int coupled_streams, byte[] mapping, int application, IntBuffer error) Allocates and initializes a multistream encoder state. Call opus_multistream_encoder_destroy() to release this object when finished.
int	opus_multistream_encoder_ctl(com.sun.jna.ptr.PointerByReference st, int request, Object... varargs) Perform a CTL function on a multistream Opus encoder. * Generally the request and subsequent arguments are generated by a convenience macro.
void	opus_multistream_encoder_destroy(com.sun.jna.ptr.PointerByReference st) Frees an OpusMSEncoder allocated by opus_multistream_encoder_create().
int	opus_multistream_encoder_get_size(int streams, int coupled_streams) Gets the size of an OpusMSEncoder structure.
int	opus_multistream_encoder_init(com.sun.jna.ptr.PointerByReference st, int Fs, int channels, int streams, int coupled_streams, byte[] mapping, int application) Initialize a previously allocated multistream encoder state. The memory pointed to by \a st must be at least the size returned by opus_multistream_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.
int	opus_multistream_encoder_init(com.sun.jna.ptr.PointerByReference st, int Fs, int channels, int streams, int coupled_streams, com.sun.jna.Pointer mapping, int application) Initialize a previously allocated multistream encoder state. The memory pointed to by \a st must be at least the size returned by opus_multistream_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.
int	opus_multistream_packet_pad(ByteBuffer data, int len, int new_len, int nb_streams) Pads a given Opus multi-stream packet to a larger size (possibly changing the TOC sequence).
int	opus_multistream_packet_unpad(ByteBuffer data, int len, int nb_streams) Remove all padding from a given Opus multi-stream packet and rewrite the TOC sequence to minimize space usage.
com.sun.jna.ptr.PointerByReference	opus_multistream_surround_encoder_create(int Fs, int channels, int mapping_family, IntBuffer streams, IntBuffer coupled_streams, ByteBuffer mapping, int application, IntBuffer error) Original signature : OpusMSEncoder* opus_multistream_surround_encoder_create(opus_int32, int, int, int*, int*, unsigned char*, int, int*) native declaration : /tmp/opus_multistream.h:266
int	opus_multistream_surround_encoder_get_size(int channels, int mapping_family) Original signature : opus_int32 opus_multistream_surround_encoder_get_size(int, int) native declaration : /tmp/opus_multistream.h:207
int	opus_multistream_surround_encoder_init(com.sun.jna.ptr.PointerByReference st, int Fs, int channels, int mapping_family, IntBuffer streams, IntBuffer coupled_streams, ByteBuffer mapping, int application) Original signature : int opus_multistream_surround_encoder_init(OpusMSEncoder*, opus_int32, int, int, int*, int*, unsigned char*, int) native declaration : /tmp/opus_multistream.h:335
int	opus_multistream_surround_encoder_init(com.sun.jna.ptr.PointerByReference st, int Fs, int channels, int mapping_family, com.sun.jna.ptr.IntByReference streams, com.sun.jna.ptr.IntByReference coupled_streams, com.sun.jna.Pointer mapping, int application) Original signature : int opus_multistream_surround_encoder_init(OpusMSEncoder*, opus_int32, int, int, int*, int*, unsigned char*, int) native declaration : /tmp/opus_multistream.h:335
int	opus_packet_get_bandwidth(byte[] data) Gets the bandwidth of an Opus packet.
int	opus_packet_get_nb_channels(byte[] data) Gets the number of channels from an Opus packet.
int	opus_packet_get_nb_frames(byte[] packet, int len) Gets the number of frames in an Opus packet.
int	opus_packet_get_nb_samples(byte[] packet, int len, int Fs) Gets the number of samples of an Opus packet.
int	opus_packet_get_samples_per_frame(byte[] data, int Fs) Gets the number of samples per frame from an Opus packet.
int	opus_packet_pad(ByteBuffer data, int len, int new_len) Pads a given Opus packet to a larger size (possibly changing the TOC sequence).
int	opus_packet_parse(byte[] data, int len, ByteBuffer out_toc, byte[] frames, ShortBuffer size, IntBuffer payload_offset) 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.
int	opus_packet_unpad(ByteBuffer data, int len) Remove all padding from a given Opus packet and rewrite the TOC sequence to minimize space usage.
void	opus_pcm_soft_clip(FloatBuffer pcm, int frame_size, int channels, FloatBuffer softclip_mem) Applies soft-clipping to bring a float signal within the [-1,1] range.
int	opus_repacketizer_cat(com.sun.jna.ptr.PointerByReference rp, byte[] data, int len) 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.
int	opus_repacketizer_cat(com.sun.jna.ptr.PointerByReference rp, com.sun.jna.Pointer data, int len) 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.
com.sun.jna.ptr.PointerByReference	opus_repacketizer_create() Allocates memory and initializes the new repacketizer with opus_repacketizer_init(). Original signature : OpusRepacketizer* opus_repacketizer_create() native declaration : /tmp/opus.h:743
void	opus_repacketizer_destroy(com.sun.jna.ptr.PointerByReference rp) Frees an OpusRepacketizer allocated by opus_repacketizer_create().
int	opus_repacketizer_get_nb_frames(com.sun.jna.ptr.PointerByReference rp) 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().
int	opus_repacketizer_get_size() Gets the size of an OpusRepacketizer structure.
com.sun.jna.ptr.PointerByReference	opus_repacketizer_init(com.sun.jna.ptr.PointerByReference rp) (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().
int	opus_repacketizer_out_range(com.sun.jna.ptr.PointerByReference rp, int begin, int end, ByteBuffer data, int maxlen) Construct a new packet from data previously submitted to the repacketizer state via opus_repacketizer_cat().
int	opus_repacketizer_out_range(com.sun.jna.ptr.PointerByReference rp, int begin, int end, com.sun.jna.Pointer data, int maxlen) Construct a new packet from data previously submitted to the repacketizer state via opus_repacketizer_cat().
int	opus_repacketizer_out(com.sun.jna.ptr.PointerByReference rp, ByteBuffer data, int maxlen) 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
int	opus_repacketizer_out(com.sun.jna.ptr.PointerByReference rp, com.sun.jna.Pointer data, int maxlen) 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
String	opus_strerror(int error) Converts an opus error code into a human readable string. * @param[in] error int: Error number

Field Detail

JNA_LIBRARY_NAME

static final String JNA_LIBRARY_NAME

See Also:

Constant Field Values

JNA_NATIVE_LIB

static final com.sun.jna.NativeLibrary JNA_NATIVE_LIB

INSTANCE

static final Opus INSTANCE

OPUS_GET_LSB_DEPTH_REQUEST

static final int OPUS_GET_LSB_DEPTH_REQUEST

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_GET_APPLICATION_REQUEST

static final int OPUS_GET_APPLICATION_REQUEST

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_GET_FORCE_CHANNELS_REQUEST

static final int OPUS_GET_FORCE_CHANNELS_REQUEST

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_GET_VBR_REQUEST

static final int OPUS_GET_VBR_REQUEST

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_GET_BANDWIDTH_REQUEST

static final int OPUS_GET_BANDWIDTH_REQUEST

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_SET_BITRATE_REQUEST

static final int OPUS_SET_BITRATE_REQUEST

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_SET_BANDWIDTH_REQUEST

static final int OPUS_SET_BANDWIDTH_REQUEST

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_SIGNAL_MUSIC

static final int OPUS_SIGNAL_MUSIC

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_RESET_STATE

static final int OPUS_RESET_STATE

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_FRAMESIZE_2_5_MS

static final int OPUS_FRAMESIZE_2_5_MS

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_GET_COMPLEXITY_REQUEST

static final int OPUS_GET_COMPLEXITY_REQUEST

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_FRAMESIZE_40_MS

static final int OPUS_FRAMESIZE_40_MS

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_SET_PACKET_LOSS_PERC_REQUEST

static final int OPUS_SET_PACKET_LOSS_PERC_REQUEST

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_GET_VBR_CONSTRAINT_REQUEST

static final int OPUS_GET_VBR_CONSTRAINT_REQUEST

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_SET_INBAND_FEC_REQUEST

static final int OPUS_SET_INBAND_FEC_REQUEST

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_APPLICATION_RESTRICTED_LOWDELAY

static final int OPUS_APPLICATION_RESTRICTED_LOWDELAY

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_BANDWIDTH_FULLBAND

static final int OPUS_BANDWIDTH_FULLBAND

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_SET_VBR_REQUEST

static final int OPUS_SET_VBR_REQUEST

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_BANDWIDTH_SUPERWIDEBAND

static final int OPUS_BANDWIDTH_SUPERWIDEBAND

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_SET_FORCE_CHANNELS_REQUEST

static final int OPUS_SET_FORCE_CHANNELS_REQUEST

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_APPLICATION_VOIP

static final int OPUS_APPLICATION_VOIP

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_SIGNAL_VOICE

static final int OPUS_SIGNAL_VOICE

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_GET_FINAL_RANGE_REQUEST

static final int OPUS_GET_FINAL_RANGE_REQUEST

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_BUFFER_TOO_SMALL

static final int OPUS_BUFFER_TOO_SMALL

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_SET_COMPLEXITY_REQUEST

static final int OPUS_SET_COMPLEXITY_REQUEST

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_FRAMESIZE_ARG

static final int OPUS_FRAMESIZE_ARG

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_GET_LOOKAHEAD_REQUEST

static final int OPUS_GET_LOOKAHEAD_REQUEST

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_GET_INBAND_FEC_REQUEST

static final int OPUS_GET_INBAND_FEC_REQUEST

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_BITRATE_MAX

static final int OPUS_BITRATE_MAX

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_FRAMESIZE_5_MS

static final int OPUS_FRAMESIZE_5_MS

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_BAD_ARG

static final int OPUS_BAD_ARG

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_GET_PITCH_REQUEST

static final int OPUS_GET_PITCH_REQUEST

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_SET_SIGNAL_REQUEST

static final int OPUS_SET_SIGNAL_REQUEST

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_FRAMESIZE_20_MS

static final int OPUS_FRAMESIZE_20_MS

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_APPLICATION_AUDIO

static final int OPUS_APPLICATION_AUDIO

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_GET_DTX_REQUEST

static final int OPUS_GET_DTX_REQUEST

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_FRAMESIZE_10_MS

static final int OPUS_FRAMESIZE_10_MS

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_SET_LSB_DEPTH_REQUEST

static final int OPUS_SET_LSB_DEPTH_REQUEST

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_UNIMPLEMENTED

static final int OPUS_UNIMPLEMENTED

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_GET_PACKET_LOSS_PERC_REQUEST

static final int OPUS_GET_PACKET_LOSS_PERC_REQUEST

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_INVALID_STATE

static final int OPUS_INVALID_STATE

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_SET_EXPERT_FRAME_DURATION_REQUEST

static final int OPUS_SET_EXPERT_FRAME_DURATION_REQUEST

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_FRAMESIZE_60_MS

static final int OPUS_FRAMESIZE_60_MS

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_GET_BITRATE_REQUEST

static final int OPUS_GET_BITRATE_REQUEST

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_INTERNAL_ERROR

static final int OPUS_INTERNAL_ERROR

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_SET_MAX_BANDWIDTH_REQUEST

static final int OPUS_SET_MAX_BANDWIDTH_REQUEST

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_SET_VBR_CONSTRAINT_REQUEST

static final int OPUS_SET_VBR_CONSTRAINT_REQUEST

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_GET_MAX_BANDWIDTH_REQUEST

static final int OPUS_GET_MAX_BANDWIDTH_REQUEST

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_BANDWIDTH_NARROWBAND

static final int OPUS_BANDWIDTH_NARROWBAND

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_SET_GAIN_REQUEST

static final int OPUS_SET_GAIN_REQUEST

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_SET_PREDICTION_DISABLED_REQUEST

static final int OPUS_SET_PREDICTION_DISABLED_REQUEST

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_SET_APPLICATION_REQUEST

static final int OPUS_SET_APPLICATION_REQUEST

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_SET_DTX_REQUEST

static final int OPUS_SET_DTX_REQUEST

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_BANDWIDTH_MEDIUMBAND

static final int OPUS_BANDWIDTH_MEDIUMBAND

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_GET_SAMPLE_RATE_REQUEST

static final int OPUS_GET_SAMPLE_RATE_REQUEST

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_GET_EXPERT_FRAME_DURATION_REQUEST

static final int OPUS_GET_EXPERT_FRAME_DURATION_REQUEST

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_AUTO

static final int OPUS_AUTO

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_GET_SIGNAL_REQUEST

static final int OPUS_GET_SIGNAL_REQUEST

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_GET_LAST_PACKET_DURATION_REQUEST

static final int OPUS_GET_LAST_PACKET_DURATION_REQUEST

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_GET_PREDICTION_DISABLED_REQUEST

static final int OPUS_GET_PREDICTION_DISABLED_REQUEST

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_GET_GAIN_REQUEST

static final int OPUS_GET_GAIN_REQUEST

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_BANDWIDTH_WIDEBAND

static final int OPUS_BANDWIDTH_WIDEBAND

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_INVALID_PACKET

static final int OPUS_INVALID_PACKET

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_ALLOC_FAIL

static final int OPUS_ALLOC_FAIL

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_OK

static final int OPUS_OK

native declaration : /tmp/opus_defines.h

See Also:

Constant Field Values

OPUS_MULTISTREAM_GET_DECODER_STATE_REQUEST

static final int OPUS_MULTISTREAM_GET_DECODER_STATE_REQUEST

native declaration : /tmp/opus_multistream.h

See Also:

Constant Field Values

OPUS_MULTISTREAM_GET_ENCODER_STATE_REQUEST

static final int OPUS_MULTISTREAM_GET_ENCODER_STATE_REQUEST

native declaration : /tmp/opus_multistream.h

See Also:

Constant Field Values

Method Detail

opus_encoder_get_size

int opus_encoder_get_size(int channels)

Gets the size of an OpusEncoder structure.

opus_encoder_create

com.sun.jna.ptr.PointerByReference opus_encoder_create(int Fs,
                                                     int channels,
                                                     int application,
                                                     IntBuffer error)

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).

Parameters:

[in] - Fs opus_int32: Sampling rate of input signal (Hz)
This must be one of 8000, 12000, 16000,
24000, or 48000.

[in] - channels int: Number of channels (1 or 2) in input signal

[in] - application int: Coding mode (@ref OPUS_APPLICATION_VOIP/@ref OPUS_APPLICATION_AUDIO/@ref OPUS_APPLICATION_RESTRICTED_LOWDELAY)

[out] - error int*: @ref opus_errorcodes

opus_encoder_init

int opus_encoder_init(com.sun.jna.ptr.PointerByReference st,
                    int Fs,
                    int channels,
                    int application)

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.

Parameters:

[in] - st OpusEncoder*: Encoder state

[in] - Fs opus_int32: Sampling rate of input signal (Hz)
This must be one of 8000, 12000, 16000,
24000, or 48000.

[in] - channels int: Number of channels (1 or 2) in input signal

[in] - application int: Coding mode (OPUS_APPLICATION_VOIP/OPUS_APPLICATION_AUDIO/OPUS_APPLICATION_RESTRICTED_LOWDELAY)

See Also:

opus_encoder_create(),opus_encoder_get_size()
To reset a previously initialized state, use the #OPUS_RESET_STATE CTL.


opus_encode

int opus_encode(com.sun.jna.ptr.PointerByReference st,
              ShortBuffer pcm,
              int frame_size,
              ByteBuffer data,
              int max_data_bytes)

Encodes an Opus frame.

Parameters:

[in] - st OpusEncoder*: Encoder state

[in] - pcm opus_int16*: Input signal (interleaved if 2 channels). length is frame_size*channels*sizeof(opus_int16)

[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.

[out] - data unsigned char*: Output payload.
This must contain storage for at
least \a max_data_bytes.

[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.

opus_encode

int opus_encode(com.sun.jna.ptr.PointerByReference st,
              com.sun.jna.ptr.ShortByReference pcm,
              int frame_size,
              com.sun.jna.Pointer data,
              int max_data_bytes)

Encodes an Opus frame.

Parameters:

[in] - st OpusEncoder*: Encoder state

[in] - pcm opus_int16*: Input signal (interleaved if 2 channels). length is frame_size*channels*sizeof(opus_int16)

[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.

[out] - data unsigned char*: Output payload.
This must contain storage for at
least \a max_data_bytes.

[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.

opus_encode_float

int opus_encode_float(com.sun.jna.ptr.PointerByReference st,
                    float[] pcm,
                    int frame_size,
                    ByteBuffer data,
                    int max_data_bytes)

Encodes an Opus frame from floating point input.

Parameters:

[in] - st OpusEncoder*: Encoder state

[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)

[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.

[out] - data unsigned char*: Output payload.
This must contain storage for at
least \a max_data_bytes.

[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.

opus_encode_float

int opus_encode_float(com.sun.jna.ptr.PointerByReference st,
                    com.sun.jna.ptr.FloatByReference pcm,
                    int frame_size,
                    com.sun.jna.Pointer data,
                    int max_data_bytes)

Encodes an Opus frame from floating point input.

Parameters:

[in] - st OpusEncoder*: Encoder state

[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)

[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.

[out] - data unsigned char*: Output payload.
This must contain storage for at
least \a max_data_bytes.

[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.

opus_encoder_destroy

void opus_encoder_destroy(com.sun.jna.ptr.PointerByReference st)

Frees an OpusEncoder allocated by opus_encoder_create().

opus_encoder_ctl

int opus_encoder_ctl(com.sun.jna.ptr.PointerByReference st,
                   int request,
                   Object... varargs)

Perform a CTL function on an Opus encoder.
* Generally the request and subsequent arguments are generated
by a convenience macro.

Parameters:

st - OpusEncoder*: Encoder state.

request - This and all remaining parameters should be replaced by one
of the convenience macros in @ref opus_genericctls or

See Also:

opus_genericctls
, Original signature : int opus_encoder_ctl(OpusEncoder*, int, null)
native declaration : /tmp/opus.h:291

opus_decoder_get_size

int opus_decoder_get_size(int channels)

Gets the size of an OpusDecoder structure.

Parameters:

[in] - channels int: Number of channels.
This must be 1 or 2.

opus_decoder_create

com.sun.jna.ptr.PointerByReference opus_decoder_create(int Fs,
                                                     int channels,
                                                     IntBuffer error)

Allocates and initializes a decoder state.

Parameters:

[in] - Fs opus_int32: Sample rate to decode at (Hz).
This must be one of 8000, 12000, 16000,
24000, or 48000.

[in] - channels int: Number of channels (1 or 2) to decode

[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.
Original signature : OpusDecoder* opus_decoder_create(opus_int32, int, int*)
native declaration : /tmp/opus.h:386

opus_decoder_init

int opus_decoder_init(com.sun.jna.ptr.PointerByReference st,
                    int Fs,
                    int channels)

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.

Parameters:

[in] - st OpusDecoder*: Decoder state.

[in] - Fs opus_int32: Sampling rate to decode to (Hz).
This must be one of 8000, 12000, 16000,
24000, or 48000.

[in] - channels int: Number of channels (1 or 2) to decode

opus_decode

int opus_decode(com.sun.jna.ptr.PointerByReference st,
              byte[] data,
              int len,
              ShortBuffer pcm,
              int frame_size,
              int decode_fec)

Decode an Opus packet.

Parameters:

[in] - st OpusDecoder*: Decoder state

[in] - data char*: Input payload. Use a NULL pointer to indicate packet loss

[in] - len opus_int32: Number of bytes in payload*

[out] - pcm opus_int16*: Output signal (interleaved if 2 channels). length
is frame_size*channels*sizeof(opus_int16)

[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.

[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.

opus_decode

int opus_decode(com.sun.jna.ptr.PointerByReference st,
              com.sun.jna.Pointer data,
              int len,
              com.sun.jna.ptr.ShortByReference pcm,
              int frame_size,
              int decode_fec)

Decode an Opus packet.

Parameters:

[in] - st OpusDecoder*: Decoder state

[in] - data char*: Input payload. Use a NULL pointer to indicate packet loss

[in] - len opus_int32: Number of bytes in payload*

[out] - pcm opus_int16*: Output signal (interleaved if 2 channels). length
is frame_size*channels*sizeof(opus_int16)

[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.

[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.

opus_decode_float

int opus_decode_float(com.sun.jna.ptr.PointerByReference st,
                    byte[] data,
                    int len,
                    FloatBuffer pcm,
                    int frame_size,
                    int decode_fec)

Decode an Opus packet with floating point output.

Parameters:

[in] - st OpusDecoder*: Decoder state

[in] - data char*: Input payload. Use a NULL pointer to indicate packet loss

[in] - len opus_int32: Number of bytes in payload

[out] - pcm float*: Output signal (interleaved if 2 channels). length
is frame_size*channels*sizeof(float)

[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.

[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.

opus_decode_float

int opus_decode_float(com.sun.jna.ptr.PointerByReference st,
                    com.sun.jna.Pointer data,
                    int len,
                    com.sun.jna.ptr.FloatByReference pcm,
                    int frame_size,
                    int decode_fec)

Decode an Opus packet with floating point output.

Parameters:

[in] - st OpusDecoder*: Decoder state

[in] - data char*: Input payload. Use a NULL pointer to indicate packet loss

[in] - len opus_int32: Number of bytes in payload

[out] - pcm float*: Output signal (interleaved if 2 channels). length
is frame_size*channels*sizeof(float)

[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.

[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.

opus_decoder_ctl

int opus_decoder_ctl(com.sun.jna.ptr.PointerByReference st,
                   int request,
                   Object... varargs)

Perform a CTL function on an Opus decoder.
* Generally the request and subsequent arguments are generated
by a convenience macro.

Parameters:

st - OpusDecoder*: Decoder state.

request - This and all remaining parameters should be replaced by one
of the convenience macros in @ref opus_genericctls or

See Also:

opus_genericctls
, Original signature : int opus_decoder_ctl(OpusDecoder*, int, null)
native declaration : /tmp/opus.h:470

opus_decoder_destroy

void opus_decoder_destroy(com.sun.jna.ptr.PointerByReference st)

Frees an OpusDecoder allocated by opus_decoder_create().

opus_packet_parse

int opus_packet_parse(byte[] data,
                    int len,
                    ByteBuffer out_toc,
                    byte[] frames,
                    ShortBuffer size,
                    IntBuffer payload_offset)

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.

Parameters:

[in] - data char*: Opus packet to be parsed

[in] - len opus_int32: size of data

[out] - out_toc char*: TOC pointer

[out] - frames char*[48] encapsulated frames

[out] - size opus_int16[48] sizes of the encapsulated frames

[out] - payload_offset int*: returns the position of the payload within the packet (in bytes)

opus_packet_get_bandwidth

int opus_packet_get_bandwidth(byte[] data)

Gets the bandwidth of an Opus packet.

Parameters:

[in] - data char*: Opus packet

opus_packet_get_samples_per_frame

int opus_packet_get_samples_per_frame(byte[] data,
                                    int Fs)

Gets the number of samples per frame from an Opus packet.

Parameters:

[in] - data char*: Opus packet.
This must contain at least one byte of
data.

[in] - Fs opus_int32: Sampling rate in Hz.
This must be a multiple of 400, or
inaccurate results will be returned.

opus_packet_get_nb_channels

int opus_packet_get_nb_channels(byte[] data)

Gets the number of channels from an Opus packet.

Parameters:

[in] - data char*: Opus packet

opus_packet_get_nb_frames

int opus_packet_get_nb_frames(byte[] packet,
                            int len)

Gets the number of frames in an Opus packet.

Parameters:

[in] - packet char*: Opus packet

[in] - len opus_int32: Length of packet

opus_packet_get_nb_samples

int opus_packet_get_nb_samples(byte[] packet,
                             int len,
                             int Fs)

Gets the number of samples of an Opus packet.

Parameters:

[in] - packet char*: Opus packet

[in] - len opus_int32: Length of packet

[in] - Fs opus_int32: Sampling rate in Hz.
This must be a multiple of 400, or
inaccurate results will be returned.

opus_decoder_get_nb_samples

int opus_decoder_get_nb_samples(com.sun.jna.ptr.PointerByReference dec,
                              byte[] packet,
                              int len)

Gets the number of samples of an Opus packet.

Parameters:

[in] - dec OpusDecoder*: Decoder state

[in] - packet char*: Opus packet

[in] - len opus_int32: Length of packet

opus_decoder_get_nb_samples

int opus_decoder_get_nb_samples(com.sun.jna.ptr.PointerByReference dec,
                              com.sun.jna.Pointer packet,
                              int len)

Gets the number of samples of an Opus packet.

Parameters:

[in] - dec OpusDecoder*: Decoder state

[in] - packet char*: Opus packet

[in] - len opus_int32: Length of packet

opus_pcm_soft_clip

void opus_pcm_soft_clip(FloatBuffer pcm,
                      int frame_size,
                      int channels,
                      FloatBuffer softclip_mem)

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.

Parameters:

[in,out] - pcm float*: Input PCM and modified PCM

[in] - frame_size int Number of samples per channel to process

[in] - channels int: Number of channels

[in,out] - softclip_mem float*: State memory for the soft clipping process (one float per channel, initialized to zero)
Original signature : void opus_pcm_soft_clip(float*, int, int, float*)
native declaration : /tmp/opus.h:569

opus_repacketizer_get_size

int opus_repacketizer_get_size()

Gets the size of an OpusRepacketizer structure.

opus_repacketizer_init

com.sun.jna.ptr.PointerByReference opus_repacketizer_init(com.sun.jna.ptr.PointerByReference rp)

(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().

Parameters:

rp - OpusRepacketizer*: The repacketizer state to
(re)initialize.

See Also:

opus_repacketizer_create
, opus_repacketizer_get_size
, opus_repacketizer_cat


opus_repacketizer_create

com.sun.jna.ptr.PointerByReference opus_repacketizer_create()

Allocates memory and initializes the new repacketizer with
opus_repacketizer_init().
Original signature : OpusRepacketizer* opus_repacketizer_create()
native declaration : /tmp/opus.h:743

opus_repacketizer_destroy

void opus_repacketizer_destroy(com.sun.jna.ptr.PointerByReference rp)

Frees an OpusRepacketizer allocated by
opus_repacketizer_create().

opus_repacketizer_cat

int opus_repacketizer_cat(com.sun.jna.ptr.PointerByReference rp,
                        byte[] data,
                        int len)

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.

Parameters:

rp - OpusRepacketizer*: The repacketizer state to which to
add the packet.

len - opus_int32: The number of bytes in the packet data.

See Also:

opus_repacketizer_out_range
, opus_repacketizer_out
, opus_repacketizer_init


opus_repacketizer_cat

int opus_repacketizer_cat(com.sun.jna.ptr.PointerByReference rp,
                        com.sun.jna.Pointer data,
                        int len)

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.

Parameters:

rp - OpusRepacketizer*: The repacketizer state to which to
add the packet.

len - opus_int32: The number of bytes in the packet data.

See Also:

opus_repacketizer_out_range
, opus_repacketizer_out
, opus_repacketizer_init


opus_repacketizer_out_range

int opus_repacketizer_out_range(com.sun.jna.ptr.PointerByReference rp,
                              int begin,
                              int end,
                              ByteBuffer data,
                              int maxlen)

Construct a new packet from data previously submitted to the repacketizer
state via opus_repacketizer_cat().

Parameters:

rp - OpusRepacketizer*: The repacketizer state from which to
construct the new packet.

begin - int: The index of the first frame in the current
repacketizer state to include in the output.

end - int: One past the index of the last frame in the
current repacketizer state to include in the
output.

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.

opus_repacketizer_out_range

int opus_repacketizer_out_range(com.sun.jna.ptr.PointerByReference rp,
                              int begin,
                              int end,
                              com.sun.jna.Pointer data,
                              int maxlen)

Construct a new packet from data previously submitted to the repacketizer
state via opus_repacketizer_cat().

Parameters:

rp - OpusRepacketizer*: The repacketizer state from which to
construct the new packet.

begin - int: The index of the first frame in the current
repacketizer state to include in the output.

end - int: One past the index of the last frame in the
current repacketizer state to include in the
output.

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.

opus_repacketizer_get_nb_frames

int opus_repacketizer_get_nb_frames(com.sun.jna.ptr.PointerByReference rp)

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().

Parameters:

rp - OpusRepacketizer*: The repacketizer state containing the
frames.

opus_repacketizer_out

int opus_repacketizer_out(com.sun.jna.ptr.PointerByReference rp,
                        ByteBuffer data,
                        int maxlen)

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

Parameters:

rp - OpusRepacketizer*: The repacketizer state from which to
construct the new packet.

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.

opus_repacketizer_out

int opus_repacketizer_out(com.sun.jna.ptr.PointerByReference rp,
                        com.sun.jna.Pointer data,
                        int maxlen)

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

Parameters:

rp - OpusRepacketizer*: The repacketizer state from which to
construct the new packet.

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.

opus_packet_pad

int opus_packet_pad(ByteBuffer data,
                  int len,
                  int new_len)

Pads a given Opus packet to a larger size (possibly changing the TOC sequence).

Parameters:

len - opus_int32: The size of the packet.
This must be at least 1.

new_len - opus_int32: The desired size of the packet after padding.
This must be at least as large as len.

opus_packet_unpad

int opus_packet_unpad(ByteBuffer data,
                    int len)

Remove all padding from a given Opus packet and rewrite the TOC sequence to
minimize space usage.

Parameters:

len - opus_int32: The size of the packet.
This must be at least 1.

opus_multistream_packet_pad

int opus_multistream_packet_pad(ByteBuffer data,
                              int len,
                              int new_len,
                              int nb_streams)

Pads a given Opus multi-stream packet to a larger size (possibly changing the TOC sequence).

Parameters:

len - opus_int32: The size of the packet.
This must be at least 1.

new_len - opus_int32: The desired size of the packet after padding.
This must be at least 1.

nb_streams - opus_int32: The number of streams (not channels) in the packet.
This must be at least as large as len.

opus_multistream_packet_unpad

int opus_multistream_packet_unpad(ByteBuffer data,
                                int len,
                                int nb_streams)

Remove all padding from a given Opus multi-stream packet and rewrite the TOC sequence to
minimize space usage.

Parameters:

len - opus_int32: The size of the packet.
This must be at least 1.

nb_streams - opus_int32: The number of streams (not channels) in the packet.
This must be at least 1.

opus_strerror

String opus_strerror(int error)

Converts an opus error code into a human readable string.
* @param[in] error int: Error number

opus_get_version_string

String opus_get_version_string()

Gets the libopus version string.
* @returns Version string
Original signature : char* opus_get_version_string()
native declaration : /tmp/opus_defines.h:718

opus_multistream_encoder_get_size

int opus_multistream_encoder_get_size(int streams,
                                    int coupled_streams)

Gets the size of an OpusMSEncoder structure.

Parameters:

streams - int: The total number of streams to encode from the
input.
This must be no more than 255.

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 255.

opus_multistream_surround_encoder_get_size

int opus_multistream_surround_encoder_get_size(int channels,
                                             int mapping_family)

Original signature : opus_int32 opus_multistream_surround_encoder_get_size(int, int)
native declaration : /tmp/opus_multistream.h:207

opus_multistream_encoder_create

com.sun.jna.ptr.PointerByReference opus_multistream_encoder_create(int Fs,
                                                                 int channels,
                                                                 int streams,
                                                                 int coupled_streams,
                                                                 byte[] mapping,
                                                                 int application,
                                                                 IntBuffer error)

Allocates and initializes a multistream encoder state.
Call opus_multistream_encoder_destroy() to release
this object when finished.

Parameters:

Fs - opus_int32: Sampling rate of the input signal (in Hz).
This must be one of 8000, 12000, 16000,
24000, or 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 - int: The total number of streams to encode from the
input.
This must be no more than the number of channels.

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.

application - int: The target encoder application.
This must be one of the following:

#OPUS_APPLICATION_VOIP

Process signal for improved speech intelligibility.

#OPUS_APPLICATION_AUDIO

Favor faithfulness to the original input.

#OPUS_APPLICATION_RESTRICTED_LOWDELAY

Configure the minimum possible coding delay by disabling certain modes
of operation.

opus_multistream_surround_encoder_create

com.sun.jna.ptr.PointerByReference opus_multistream_surround_encoder_create(int Fs,
                                                                          int channels,
                                                                          int mapping_family,
                                                                          IntBuffer streams,
                                                                          IntBuffer coupled_streams,
                                                                          ByteBuffer mapping,
                                                                          int application,
                                                                          IntBuffer error)

Original signature : OpusMSEncoder* opus_multistream_surround_encoder_create(opus_int32, int, int, int*, int*, unsigned char*, int, int*)
native declaration : /tmp/opus_multistream.h:266

opus_multistream_encoder_init

int opus_multistream_encoder_init(com.sun.jna.ptr.PointerByReference st,
                                int Fs,
                                int channels,
                                int streams,
                                int coupled_streams,
                                byte[] mapping,
                                int application)

Initialize a previously allocated multistream encoder state.
The memory pointed to by \a st must be at least the size returned by
opus_multistream_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.

Parameters:

st - OpusMSEncoder*: Multistream encoder state to initialize.

Fs - opus_int32: Sampling rate of the input signal (in Hz).
This must be one of 8000, 12000, 16000,
24000, or 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 - int: The total number of streams to encode from the
input.
This must be no more than the number of channels.

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.

application - int: The target encoder application.
This must be one of the following:

#OPUS_APPLICATION_VOIP

Process signal for improved speech intelligibility.

#OPUS_APPLICATION_AUDIO

Favor faithfulness to the original input.

#OPUS_APPLICATION_RESTRICTED_LOWDELAY

Configure the minimum possible coding delay by disabling certain modes
of operation.

See Also:

opus_multistream_encoder_create
, opus_multistream_encoder_get_size


opus_multistream_encoder_init

int opus_multistream_encoder_init(com.sun.jna.ptr.PointerByReference st,
                                int Fs,
                                int channels,
                                int streams,
                                int coupled_streams,
                                com.sun.jna.Pointer mapping,
                                int application)

Initialize a previously allocated multistream encoder state.
The memory pointed to by \a st must be at least the size returned by
opus_multistream_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.

Parameters:

st - OpusMSEncoder*: Multistream encoder state to initialize.

Fs - opus_int32: Sampling rate of the input signal (in Hz).
This must be one of 8000, 12000, 16000,
24000, or 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 - int: The total number of streams to encode from the
input.
This must be no more than the number of channels.

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.

application - int: The target encoder application.
This must be one of the following:

#OPUS_APPLICATION_VOIP

Process signal for improved speech intelligibility.

#OPUS_APPLICATION_AUDIO

Favor faithfulness to the original input.

#OPUS_APPLICATION_RESTRICTED_LOWDELAY

Configure the minimum possible coding delay by disabling certain modes
of operation.

See Also:

opus_multistream_encoder_create
, opus_multistream_encoder_get_size


opus_multistream_surround_encoder_init

int opus_multistream_surround_encoder_init(com.sun.jna.ptr.PointerByReference st,
                                         int Fs,
                                         int channels,
                                         int mapping_family,
                                         IntBuffer streams,
                                         IntBuffer coupled_streams,
                                         ByteBuffer mapping,
                                         int application)

Original signature : int opus_multistream_surround_encoder_init(OpusMSEncoder*, opus_int32, int, int, int*, int*, unsigned char*, int)
native declaration : /tmp/opus_multistream.h:335

opus_multistream_surround_encoder_init

int opus_multistream_surround_encoder_init(com.sun.jna.ptr.PointerByReference st,
                                         int Fs,
                                         int channels,
                                         int mapping_family,
                                         com.sun.jna.ptr.IntByReference streams,
                                         com.sun.jna.ptr.IntByReference coupled_streams,
                                         com.sun.jna.Pointer mapping,
                                         int application)

Original signature : int opus_multistream_surround_encoder_init(OpusMSEncoder*, opus_int32, int, int, int*, int*, unsigned char*, int)
native declaration : /tmp/opus_multistream.h:335

opus_multistream_encode

int opus_multistream_encode(com.sun.jna.ptr.PointerByReference st,
                          ShortBuffer pcm,
                          int frame_size,
                          ByteBuffer data,
                          int max_data_bytes)

Encodes a multistream Opus frame.

Parameters:

st - OpusMSEncoder*: Multistream encoder state.

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.

[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.

opus_multistream_encode

int opus_multistream_encode(com.sun.jna.ptr.PointerByReference st,
                          com.sun.jna.ptr.ShortByReference pcm,
                          int frame_size,
                          com.sun.jna.Pointer data,
                          int max_data_bytes)

Encodes a multistream Opus frame.

Parameters:

st - OpusMSEncoder*: Multistream encoder state.

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.

[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.

opus_multistream_encode_float

int opus_multistream_encode_float(com.sun.jna.ptr.PointerByReference st,
                                float[] pcm,
                                int frame_size,
                                ByteBuffer data,
                                int max_data_bytes)

Encodes a multistream Opus frame from floating point input.

Parameters:

st - OpusMSEncoder*: Multistream encoder state.

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.

[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.

opus_multistream_encode_float

int opus_multistream_encode_float(com.sun.jna.ptr.PointerByReference st,
                                com.sun.jna.ptr.FloatByReference pcm,
                                int frame_size,
                                com.sun.jna.Pointer data,
                                int max_data_bytes)

Encodes a multistream Opus frame from floating point input.

Parameters:

st - OpusMSEncoder*: Multistream encoder state.

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.

[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.

opus_multistream_encoder_destroy

void opus_multistream_encoder_destroy(com.sun.jna.ptr.PointerByReference st)

Frees an OpusMSEncoder allocated by
opus_multistream_encoder_create().

Parameters:

st - OpusMSEncoder*: Multistream encoder state to be freed.
Original signature : void opus_multistream_encoder_destroy(OpusMSEncoder*)
native declaration : /tmp/opus_multistream.h:433

opus_multistream_encoder_ctl

int opus_multistream_encoder_ctl(com.sun.jna.ptr.PointerByReference st,
                               int request,
                               Object... varargs)

Perform a CTL function on a multistream Opus encoder.
* Generally the request and subsequent arguments are generated by a
convenience macro.

Parameters:

st - OpusMSEncoder*: Multistream encoder state.

request - This and all remaining parameters should be replaced by one
of the convenience macros in @ref opus_genericctls,

See Also:

opus_genericctls
, opus_encoderctls
, Original signature : int opus_multistream_encoder_ctl(OpusMSEncoder*, int, null)
native declaration : /tmp/opus_multistream.h:447

opus_multistream_decoder_get_size

int opus_multistream_decoder_get_size(int streams,
                                    int coupled_streams)

Gets the size of an OpusMSDecoder structure.

Parameters:

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.

opus_multistream_decoder_create

com.sun.jna.ptr.PointerByReference opus_multistream_decoder_create(int Fs,
                                                                 int channels,
                                                                 int streams,
                                                                 int coupled_streams,
                                                                 byte[] mapping,
                                                                 IntBuffer error)

Allocates and initializes a multistream decoder state.
Call opus_multistream_decoder_destroy() to release
this object when finished.

Parameters:

Fs - opus_int32: Sampling rate to decode at (in Hz).
This must be one of 8000, 12000, 16000,
24000, or 48000.

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).

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

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.

opus_multistream_decoder_init

int opus_multistream_decoder_init(com.sun.jna.ptr.PointerByReference st,
                                int Fs,
                                int channels,
                                int streams,
                                int coupled_streams,
                                byte[] mapping)

Intialize a previously allocated decoder state object.
The memory pointed to by \a st must be at least the size returned by
opus_multistream_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.

Parameters:

st - OpusMSEncoder*: Multistream encoder state to initialize.

Fs - opus_int32: Sampling rate to decode at (in Hz).
This must be one of 8000, 12000, 16000,
24000, or 48000.

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).

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

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.

See Also:

opus_multistream_decoder_create
, opus_multistream_deocder_get_size


opus_multistream_decoder_init

int opus_multistream_decoder_init(com.sun.jna.ptr.PointerByReference st,
                                int Fs,
                                int channels,
                                int streams,
                                int coupled_streams,
                                com.sun.jna.Pointer mapping)

Intialize a previously allocated decoder state object.
The memory pointed to by \a st must be at least the size returned by
opus_multistream_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.

Parameters:

st - OpusMSEncoder*: Multistream encoder state to initialize.

Fs - opus_int32: Sampling rate to decode at (in Hz).
This must be one of 8000, 12000, 16000,
24000, or 48000.

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).

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

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.

See Also:

opus_multistream_decoder_create
, opus_multistream_deocder_get_size


opus_multistream_decode

int opus_multistream_decode(com.sun.jna.ptr.PointerByReference st,
                          byte[] data,
                          int len,
                          ShortBuffer pcm,
                          int frame_size,
                          int decode_fec)

Decode a multistream Opus packet.

Parameters:

st - OpusMSDecoder*: Multistream decoder state.

len - opus_int32: Number of bytes in payload.

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.

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.

opus_multistream_decode

int opus_multistream_decode(com.sun.jna.ptr.PointerByReference st,
                          com.sun.jna.Pointer data,
                          int len,
                          com.sun.jna.ptr.ShortByReference pcm,
                          int frame_size,
                          int decode_fec)

Decode a multistream Opus packet.

Parameters:

st - OpusMSDecoder*: Multistream decoder state.

len - opus_int32: Number of bytes in payload.

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.

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.

opus_multistream_decode_float

int opus_multistream_decode_float(com.sun.jna.ptr.PointerByReference st,
                                byte[] data,
                                int len,
                                FloatBuffer pcm,
                                int frame_size,
                                int decode_fec)

Decode a multistream Opus packet with floating point output.

Parameters:

st - OpusMSDecoder*: Multistream decoder state.

len - opus_int32: Number of bytes in payload.

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.

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.

opus_multistream_decode_float

int opus_multistream_decode_float(com.sun.jna.ptr.PointerByReference st,
                                com.sun.jna.Pointer data,
                                int len,
                                com.sun.jna.ptr.FloatByReference pcm,
                                int frame_size,
                                int decode_fec)

Decode a multistream Opus packet with floating point output.

Parameters:

st - OpusMSDecoder*: Multistream decoder state.

len - opus_int32: Number of bytes in payload.

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.

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.

opus_multistream_decoder_ctl

int opus_multistream_decoder_ctl(com.sun.jna.ptr.PointerByReference st,
                               int request,
                               Object... varargs)

Perform a CTL function on a multistream Opus decoder.
* Generally the request and subsequent arguments are generated by a
convenience macro.

Parameters:

st - OpusMSDecoder*: Multistream decoder state.

request - This and all remaining parameters should be replaced by one
of the convenience macros in @ref opus_genericctls,

See Also:

opus_genericctls
, opus_decoderctls
, Original signature : int opus_multistream_decoder_ctl(OpusMSDecoder*, int, null)
native declaration : /tmp/opus_multistream.h:643

opus_multistream_decoder_destroy

void opus_multistream_decoder_destroy(com.sun.jna.ptr.PointerByReference st)

Frees an OpusMSDecoder allocated by
opus_multistream_decoder_create().

Parameters:

st - OpusMSDecoder: Multistream decoder state to be freed.
Original signature : void opus_multistream_decoder_destroy(OpusMSDecoder*)
native declaration : /tmp/opus_multistream.h:649

opus_custom_mode_create

com.sun.jna.ptr.PointerByReference opus_custom_mode_create(int Fs,
                                                         int frame_size,
                                                         IntBuffer error)

Creates a new mode struct. This will be passed to an encoder or
decoder. The mode MUST NOT BE DESTROYED until the encoders and
decoders that use it are destroyed as well.

Parameters:

[in] - Fs int: Sampling rate (8000 to 96000 Hz)

[in] - frame_size int: Number of samples (per channel) to encode in each
packet (64 - 1024, prime factorization must contain zero or more 2s, 3s, or 5s and no other primes)

[out] - error int*: Returned error code (if NULL, no error will be returned)

Returns:

A newly created mode
Original signature : OpusCustomMode* opus_custom_mode_create(opus_int32, int, int*)
native declaration : /tmp/opus_custom.h:120

opus_custom_mode_destroy

void opus_custom_mode_destroy(com.sun.jna.ptr.PointerByReference mode)

Destroys a mode struct. Only call this after all encoders and
decoders using this mode are destroyed as well.

Parameters:

[in] - mode OpusCustomMode*: Mode to be freed.
Original signature : void opus_custom_mode_destroy(OpusCustomMode*)
native declaration : /tmp/opus_custom.h:126

opus_custom_encoder_get_size

int opus_custom_encoder_get_size(com.sun.jna.ptr.PointerByReference mode,
                               int channels)

Gets the size of an OpusCustomEncoder structure.

Parameters:

[in] - mode OpusCustomMode *: Mode configuration

[in] - channels int: Number of channels

opus_custom_encoder_create

com.sun.jna.ptr.PointerByReference opus_custom_encoder_create(com.sun.jna.ptr.PointerByReference mode,
                                                            int channels,
                                                            IntBuffer error)

Creates a new encoder state. Each stream needs its own encoder
state (can't be shared across simultaneous streams).

Parameters:

[in] - mode OpusCustomMode*: Contains all the information about the characteristics of
the stream (must be the same characteristics as used for the
decoder)

[in] - channels int: Number of channels

[out] - error int*: Returns an error code

Returns:

Newly created encoder state.
Original signature : OpusCustomEncoder* opus_custom_encoder_create(const OpusCustomMode*, int, int*)
native declaration : /tmp/opus_custom.h:173

opus_custom_encoder_create

com.sun.jna.ptr.PointerByReference opus_custom_encoder_create(com.sun.jna.ptr.PointerByReference mode,
                                                            int channels,
                                                            com.sun.jna.ptr.IntByReference error)

Creates a new encoder state. Each stream needs its own encoder
state (can't be shared across simultaneous streams).

Parameters:

[in] - mode OpusCustomMode*: Contains all the information about the characteristics of
the stream (must be the same characteristics as used for the
decoder)

[in] - channels int: Number of channels

[out] - error int*: Returns an error code

Returns:

Newly created encoder state.
Original signature : OpusCustomEncoder* opus_custom_encoder_create(const OpusCustomMode*, int, int*)
native declaration : /tmp/opus_custom.h:173

opus_custom_encoder_destroy

void opus_custom_encoder_destroy(com.sun.jna.ptr.PointerByReference st)

Destroys a an encoder state.

opus_custom_encode_float

int opus_custom_encode_float(com.sun.jna.ptr.PointerByReference st,
                           float[] pcm,
                           int frame_size,
                           ByteBuffer compressed,
                           int maxCompressedBytes)

Encodes a frame of audio.

Parameters:

[in] - st OpusCustomEncoder*: Encoder state

[in] - pcm float*: PCM audio in float format, 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. There must be exactly
frame_size samples per channel.

[in] - frame_size int: Number of samples per frame of input signal

[out] - compressed char *: The compressed data is written here. This may not alias pcm and must be at least maxCompressedBytes long.

[in] - maxCompressedBytes int: Maximum number of bytes to use for compressing the frame
(can change from one frame to another)

Returns:

Number of bytes written to "compressed".
If negative, an error has occurred (see error codes). It is IMPORTANT that
the length returned be somehow transmitted to the decoder. Otherwise, no
decoding is possible.
Original signature : int opus_custom_encode_float(OpusCustomEncoder*, const float*, int, unsigned char*, int)
native declaration : /tmp/opus_custom.h:202

opus_custom_encode_float

int opus_custom_encode_float(com.sun.jna.ptr.PointerByReference st,
                           com.sun.jna.ptr.FloatByReference pcm,
                           int frame_size,
                           com.sun.jna.Pointer compressed,
                           int maxCompressedBytes)

Encodes a frame of audio.

Parameters:

[in] - st OpusCustomEncoder*: Encoder state

[in] - pcm float*: PCM audio in float format, 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. There must be exactly
frame_size samples per channel.

[in] - frame_size int: Number of samples per frame of input signal

[out] - compressed char *: The compressed data is written here. This may not alias pcm and must be at least maxCompressedBytes long.

[in] - maxCompressedBytes int: Maximum number of bytes to use for compressing the frame
(can change from one frame to another)

Returns:

Number of bytes written to "compressed".
If negative, an error has occurred (see error codes). It is IMPORTANT that
the length returned be somehow transmitted to the decoder. Otherwise, no
decoding is possible.
Original signature : int opus_custom_encode_float(OpusCustomEncoder*, const float*, int, unsigned char*, int)
native declaration : /tmp/opus_custom.h:202

opus_custom_encode

int opus_custom_encode(com.sun.jna.ptr.PointerByReference st,
                     ShortBuffer pcm,
                     int frame_size,
                     ByteBuffer compressed,
                     int maxCompressedBytes)

Encodes a frame of audio.

Parameters:

[in] - st OpusCustomEncoder*: Encoder state

[in] - pcm opus_int16*: PCM audio in signed 16-bit format (native endian).
There must be exactly frame_size samples per channel.

[in] - frame_size int: Number of samples per frame of input signal

[out] - compressed char *: The compressed data is written here. This may not alias pcm and must be at least maxCompressedBytes long.

[in] - maxCompressedBytes int: Maximum number of bytes to use for compressing the frame
(can change from one frame to another)

Returns:

Number of bytes written to "compressed".
If negative, an error has occurred (see error codes). It is IMPORTANT that
the length returned be somehow transmitted to the decoder. Otherwise, no
decoding is possible.
Original signature : int opus_custom_encode(OpusCustomEncoder*, const opus_int16*, int, unsigned char*, int)
native declaration : /tmp/opus_custom.h:223

opus_custom_encode

int opus_custom_encode(com.sun.jna.ptr.PointerByReference st,
                     com.sun.jna.ptr.ShortByReference pcm,
                     int frame_size,
                     com.sun.jna.Pointer compressed,
                     int maxCompressedBytes)

Encodes a frame of audio.

Parameters:

[in] - st OpusCustomEncoder*: Encoder state

[in] - pcm opus_int16*: PCM audio in signed 16-bit format (native endian).
There must be exactly frame_size samples per channel.

[in] - frame_size int: Number of samples per frame of input signal

[out] - compressed char *: The compressed data is written here. This may not alias pcm and must be at least maxCompressedBytes long.

[in] - maxCompressedBytes int: Maximum number of bytes to use for compressing the frame
(can change from one frame to another)

Returns:

Number of bytes written to "compressed".
If negative, an error has occurred (see error codes). It is IMPORTANT that
the length returned be somehow transmitted to the decoder. Otherwise, no
decoding is possible.
Original signature : int opus_custom_encode(OpusCustomEncoder*, const opus_int16*, int, unsigned char*, int)
native declaration : /tmp/opus_custom.h:223

opus_custom_encoder_ctl

int opus_custom_encoder_ctl(com.sun.jna.ptr.PointerByReference st,
                          int request,
                          Object... varargs)

Perform a CTL function on an Opus custom encoder.
* Generally the request and subsequent arguments are generated
by a convenience macro.

See Also:

Original signature : int opus_custom_encoder_ctl(OpusCustomEncoder*, int, null)
native declaration : /tmp/opus_custom.h:237

opus_custom_decoder_get_size

int opus_custom_decoder_get_size(com.sun.jna.ptr.PointerByReference mode,
                               int channels)

Gets the size of an OpusCustomDecoder structure.

Parameters:

[in] - mode OpusCustomMode *: Mode configuration

[in] - channels int: Number of channels

opus_custom_decoder_init

int opus_custom_decoder_init(com.sun.jna.ptr.PointerByReference st,
                           com.sun.jna.ptr.PointerByReference mode,
                           int channels)

Initializes a previously allocated decoder state
The memory pointed to by st must be the size returned by opus_custom_decoder_get_size.
This is intended for applications which use their own allocator instead of malloc.

Parameters:

[in] - st OpusCustomDecoder*: Decoder state

[in] - mode OpusCustomMode *: Contains all the information about the characteristics of
the stream (must be the same characteristics as used for the
encoder)

[in] - channels int: Number of channels

Returns:

OPUS_OK Success or @ref opus_errorcodes
Original signature : int opus_custom_decoder_init(OpusCustomDecoder*, const OpusCustomMode*, int)
native declaration : /tmp/opus_custom.h:265

See Also:

opus_custom_decoder_create(),opus_custom_decoder_get_size()
To reset a previously initialized state use the OPUS_RESET_STATE CTL.


opus_custom_decoder_create

com.sun.jna.ptr.PointerByReference opus_custom_decoder_create(com.sun.jna.ptr.PointerByReference mode,
                                                            int channels,
                                                            IntBuffer error)

Creates a new decoder state. Each stream needs its own decoder state (can't
be shared across simultaneous streams).

Parameters:

[in] - mode OpusCustomMode: Contains all the information about the characteristics of the
stream (must be the same characteristics as used for the encoder)

[in] - channels int: Number of channels

[out] - error int*: Returns an error code

Returns:

Newly created decoder state.
Original signature : OpusCustomDecoder* opus_custom_decoder_create(const OpusCustomMode*, int, int*)
native declaration : /tmp/opus_custom.h:282

opus_custom_decoder_create

com.sun.jna.ptr.PointerByReference opus_custom_decoder_create(com.sun.jna.ptr.PointerByReference mode,
                                                            int channels,
                                                            com.sun.jna.ptr.IntByReference error)

Creates a new decoder state. Each stream needs its own decoder state (can't
be shared across simultaneous streams).

Parameters:

[in] - mode OpusCustomMode: Contains all the information about the characteristics of the
stream (must be the same characteristics as used for the encoder)

[in] - channels int: Number of channels

[out] - error int*: Returns an error code

Returns:

Newly created decoder state.
Original signature : OpusCustomDecoder* opus_custom_decoder_create(const OpusCustomMode*, int, int*)
native declaration : /tmp/opus_custom.h:282

opus_custom_decoder_destroy

void opus_custom_decoder_destroy(com.sun.jna.ptr.PointerByReference st)

Destroys a an decoder state.

opus_custom_decode_float

int opus_custom_decode_float(com.sun.jna.ptr.PointerByReference st,
                           byte[] data,
                           int len,
                           FloatBuffer pcm,
                           int frame_size)

Decode an opus custom frame with floating point output

Parameters:

[in] - st OpusCustomDecoder*: Decoder state

[in] - data char*: Input payload. Use a NULL pointer to indicate packet loss

[in] - len int: Number of bytes in payload

[out] - pcm float*: Output signal (interleaved if 2 channels). length
is frame_size*channels*sizeof(float)

[in] - frame_size Number of samples per channel of available space in *pcm.

opus_custom_decode_float

int opus_custom_decode_float(com.sun.jna.ptr.PointerByReference st,
                           com.sun.jna.Pointer data,
                           int len,
                           com.sun.jna.ptr.FloatByReference pcm,
                           int frame_size)

Decode an opus custom frame with floating point output

Parameters:

[in] - st OpusCustomDecoder*: Decoder state

[in] - data char*: Input payload. Use a NULL pointer to indicate packet loss

[in] - len int: Number of bytes in payload

[out] - pcm float*: Output signal (interleaved if 2 channels). length
is frame_size*channels*sizeof(float)

[in] - frame_size Number of samples per channel of available space in *pcm.

opus_custom_decode

int opus_custom_decode(com.sun.jna.ptr.PointerByReference st,
                     byte[] data,
                     int len,
                     ShortBuffer pcm,
                     int frame_size)

Decode an opus custom frame

Parameters:

[in] - st OpusCustomDecoder*: Decoder state

[in] - data char*: Input payload. Use a NULL pointer to indicate packet loss

[in] - len int: Number of bytes in payload

[out] - pcm opus_int16*: Output signal (interleaved if 2 channels). length
is frame_size*channels*sizeof(opus_int16)

[in] - frame_size Number of samples per channel of available space in *pcm.

opus_custom_decode

int opus_custom_decode(com.sun.jna.ptr.PointerByReference st,
                     com.sun.jna.Pointer data,
                     int len,
                     com.sun.jna.ptr.ShortByReference pcm,
                     int frame_size)

Decode an opus custom frame

Parameters:

[in] - st OpusCustomDecoder*: Decoder state

[in] - data char*: Input payload. Use a NULL pointer to indicate packet loss

[in] - len int: Number of bytes in payload

[out] - pcm opus_int16*: Output signal (interleaved if 2 channels). length
is frame_size*channels*sizeof(opus_int16)

[in] - frame_size Number of samples per channel of available space in *pcm.

opus_custom_decoder_ctl

int opus_custom_decoder_ctl(com.sun.jna.ptr.PointerByReference st,
                          int request,
                          Object... varargs)

Perform a CTL function on an Opus custom decoder.
* Generally the request and subsequent arguments are generated
by a convenience macro.

See Also:

Original signature : int opus_custom_decoder_ctl(OpusCustomDecoder*, int, null)
native declaration : /tmp/opus_custom.h:333