Class OpusSound

java.lang.Object

io.github.kosmx.emotes.common.opus.OpusSound

public class OpusSound
extends Object

A validated mono Opus stream: its packets, and the PCM they decode to once someone asks. The packets live back to back in one array, indexed by offset(int) and length(int).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OpusSound.Builder	Lays packets back to back as they come, in the array the sound then keeps, so an encoder can write each one straight into it.
static final record	OpusSound.DecodedSound

Field Summary

Fields

Modifier and Type	Field	Description
static final int	NO_LOOP

Constructor Summary

Constructors

Constructor	Description
OpusSound(int preSkip, int endTrim, int outputGain, @Nullable Integer trackGain, @Nullable Integer loopStart, byte[] data, int[] offsets)
OpusSound(int preSkip, int endTrim, int outputGain, @Nullable Integer trackGain, @Nullable Integer loopStart, byte[] data, int[] offsets, List<String> comments)

Method Summary

Modifier and Type	Method	Description
@Nullable String	comment(String name)
byte[]	data()
CompletableFuture<OpusSound.DecodedSound>	decoded()
CompletableFuture<OpusSound.DecodedSound>	decoded(BooleanSupplier cancelled)	The cancellation predicate is also read on the decoder thread.
int	durationMs()
int	endTrim()
boolean	failed()
int	length(int index)
int	loopStart()
float	normalization()
int	offset(int index)
int	outputGain()
int	packetCount()
int	playable()
int	preSkip()
static OpusSound	read(InputStream input)	Reads without closing the stream, for sounds that come from somewhere other than a file.
static OpusSound	read(Path file)
void	write(Path file)

Methods inherited from class Object

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

Field Details

NO_LOOP

public static final int NO_LOOP

See Also:

• Constant Field Values

Constructor Details

OpusSound

public OpusSound(int preSkip,
 int endTrim,
 int outputGain,
 @Nullable
 @Nullable Integer trackGain,
 @Nullable
 @Nullable Integer loopStart,
 byte[] data,
 int[] offsets)
          throws OpusFormatException

Throws:

OpusFormatException

OpusSound

public OpusSound(int preSkip,
 int endTrim,
 int outputGain,
 @Nullable
 @Nullable Integer trackGain,
 @Nullable
 @Nullable Integer loopStart,
 byte[] data,
 int[] offsets,
 List<String> comments)
          throws OpusFormatException

Parameters:

comments - the NAME=value comments of the file the sound came from, which a packet does not carry

Throws:

OpusFormatException

Method Details

read

public static OpusSound read(Path file)
                      throws IOException

Throws:

IOException

read

public static OpusSound read(InputStream input)
                      throws IOException

Reads without closing the stream, for sounds that come from somewhere other than a file.

Throws:

IOException

write

public void write(Path file)
           throws IOException

Throws:

IOException

preSkip

public int preSkip()

outputGain

public int outputGain()

endTrim

public int endTrim()

Returns:

the padding at the end, in samples

loopStart

public int loopStart()

Returns:

where a repeat starts, in samples, or NO_LOOP

packetCount

public int packetCount()

data

public byte[] data()

offset

public int offset(int index)

length

public int length(int index)

comment

@Nullable
public @Nullable String comment(String name)

Returns:

the value of the first name comment of the file the sound came from, or null

durationMs

public int durationMs()

playable

public int playable()

Returns:

how many samples are left once both ends are trimmed

normalization

public float normalization()

Returns:

what a decode measured the track at, or zero while its PCM is not in memory

decoded

public CompletableFuture<OpusSound.DecodedSound> decoded()

Returns:

the PCM, decoded in the background if that has not happened yet or was reclaimed

decoded

public CompletableFuture<OpusSound.DecodedSound> decoded(BooleanSupplier cancelled)

The cancellation predicate is also read on the decoder thread.

failed

public boolean failed()