io.github.jaredmdobson.concentus

Class OpusRepacketizer

java.lang.Object

io.github.jaredmdobson.concentus.OpusRepacketizer

public class OpusRepacketizer
extends Object

OpusRepacketizer class.

Version:

$Id: $Id

Constructor Summary

Constructors

Constructor and Description
OpusRepacketizer() Allocates memory and initializes the new repacketizer with opus_repacketizer_init().

Method Summary

Modifier and Type	Method and Description
int	addPacket(byte[] data, int data_offset, int len) opus_repacketizer_cat.
int	createPacket(byte[] data, int data_offset, int maxlen) Construct a new packet from data previously submitted to the repacketizer state via opus_repacketizer_cat().
int	createPacket(int begin, int end, byte[] data, int data_offset, int maxlen) Construct a new packet from data previously submitted to the repacketizer state via opus_repacketizer_cat().
int	getNumFrames() 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().
static int	padMultistreamPacket(byte[] data, int data_offset, int len, int new_len, int nb_streams) Pads a given Opus multi-stream packet to a larger size (possibly changing the TOC sequence).
static int	padPacket(byte[] data, int data_offset, int len, int new_len) Pads a given Opus packet to a larger size (possibly changing the TOC sequence).
void	Reset() (Re)initializes a previously allocated repacketizer state.
static int	unpadMultistreamPacket(byte[] data, int data_offset, int len, int nb_streams) Remove all padding from a given Opus multi-stream packet and rewrite the TOC sequence to minimize space usage.
static int	unpadPacket(byte[] data, int data_offset, int len) Remove all padding from a given Opus packet and rewrite the TOC sequence to minimize space usage.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OpusRepacketizer

public OpusRepacketizer()

Allocates memory and initializes the new repacketizer with opus_repacketizer_init().

Method Detail

Reset

public void Reset()

(Re)initializes a previously allocated repacketizer state. The state must be at least the size returned by opus_repacketizer_get_size(). This can be used for applications which use their own allocator instead of malloc(). It must also be called to reset the queue of packets waiting to be repacketized, which is necessary if the maximum packet duration of 120 ms is reached or if you wish to submit packets with a different Opus configuration (coding mode, audio bandwidth, frame size, or channel count). Failure to do so will prevent a new packet from being added with opus_repacketizer_cat(). see: opus_repacketizer_create see: opus_repacketizer_get_size see: opus_repacketizer_cat

addPacket

public int addPacket(byte[] data,
                     int data_offset,
                     int len)

opus_repacketizer_cat. Add a packet to the current repacketizer state. This packet must match the configuration of any packets already submitted for repacketization since the last call to opus_repacketizer_init(). This means that it must have the same coding mode, audio bandwidth, frame size, and channel count. This can be checked in advance by examining the top 6 bits of the first byte of the packet, and ensuring they match the top 6 bits of the first byte of any previously submitted packet. The total duration of audio in the repacketizer state also must not exceed 120 ms, the maximum duration of a single packet, after adding this packet. The contents of the current repacketizer state can be extracted into new packets using opus_repacketizer_out() or opus_repacketizer_out_range(). In order to add a packet with a different configuration or to add more audio beyond 120 ms, you must clear the repacketizer state by calling opus_repacketizer_init(). If a packet is too large to add to the current repacketizer state, no part of it is added, even if it contains multiple frames, some of which might fit. If you wish to be able to add parts of such packets, you should first use another repacketizer to split the packet into pieces and add them individually. see: opus_repacketizer_out_range see: opus_repacketizer_out see: opus_repacketizer_init

Parameters:

data - : The packet data. The application must ensure this pointer remains valid until the next call to opus_repacketizer_init() or opus_repacketizer_destroy().

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

data_offset - a int

Returns:

An error code indicating whether or not the operation succeeded. OR #OPUS_OK The packet's contents have been added to the repacketizer state. OR #OPUS_INVALID_PACKET The packet did not have a valid TOC sequence, the packet's TOC sequence was not compatible with previously submitted packets (because the coding mode, audio bandwidth, frame size, or channel count did not match), or adding this packet would increase the total amount of audio stored in the repacketizer state to more than 120 ms.

getNumFrames

public int getNumFrames()

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

Returns:

The total number of frames contained in the packet data submitted to the repacketizer state.

createPacket

public int createPacket(int begin,
                        int end,
                        byte[] data,
                        int data_offset,
                        int maxlen)

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

Parameters:

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.

data - an array of byte objects

data_offset - a int

Returns:

The total size of the output packet on success, or an error code on failure.

createPacket

public int createPacket(byte[] data,
                        int data_offset,
                        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:

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.

data - an array of byte objects

data_offset - a int

Returns:

The total size of the output packet on success, or an error code on failure.

padPacket

public static int padPacket(byte[] data,
                            int data_offset,
                            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.

data - an array of byte objects

data_offset - a int

Returns:

an error code OR #OPUS_OK \a on success. OR #OPUS_BAD_ARG \a len was less than 1 or new_len was less than len.

unpadPacket

public static int unpadPacket(byte[] data,
                              int data_offset,
                              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.

data - an array of byte objects

data_offset - a int

Returns:

The new size of the output packet on success, or an error code on failure.

padMultistreamPacket

public static int padMultistreamPacket(byte[] data,
                                       int data_offset,
                                       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.

data - an array of byte objects

data_offset - a int

Returns:

an error code OR #OPUS_OK \a on success. OR #OPUS_BAD_ARG \a len was less than 1. OR #OPUS_INVALID_PACKET \a data did not contain a valid Opus packet.

unpadMultistreamPacket

public static int unpadMultistreamPacket(byte[] data,
                                         int data_offset,
                                         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.

data - an array of byte objects

data_offset - a int

Returns:

The new size of the output packet on success, or an error code on failure.