io.humble.video

Class AudioFormat

java.lang.Object

io.humble.ferry.RefCounted

io.humble.video.AudioFormat

public class AudioFormat
extends RefCounted

A class that defines metadata about audio formats.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AudioFormat.Type The format we use to represent audio.

Method Summary

Modifier and Type	Method and Description
AudioFormat	copyReference() Create a new AudioFormat object that is actually referring to the exact same underlying native object.
boolean	equals(Object obj) Compares two values, returning true if the underlying objects in native code are the same object.
static AudioFormat.Type	getAlternateSampleFormat(AudioFormat.Type sample_fmt, boolean planar) Return the planar<->packed alternative form of the given sample format, or SAMPLE_FMT_NONE on error.
static int	getBufferSizeNeeded(int numSamples, int numChannels, AudioFormat.Type format) Get the size of a buffer in bytes that would be required to hold the number of samples of audio in the given format and with the given number of channels.
static int	getBytesPerSample(AudioFormat.Type sample_fmt) Return number of bytes per sample.
static int	getDataPlaneSizeNeeded(int numSamples, int numChannels, AudioFormat.Type format) Get the size of a plane of audio bytes that would be required to hold the number of samples of audio in the given format and with the given number of channels.
static AudioFormat.Type	getFormat(String name) Return a sample format corresponding to name, or SAMPLE_FMT_NONE on error.
static String	getName(AudioFormat.Type format) Return the name of format, or NULL if format is not recognized.
static AudioFormat.Type	getPackedSampleFormat(AudioFormat.Type sample_fmt) Get the packed alternative form of the given sample format. If the passed sample_fmt is already in packed format, the format returned is the same as the input.
static AudioFormat.Type	getPlanarSampleFormat(AudioFormat.Type sample_fmt) Get the planar alternative form of the given sample format. If the passed sample_fmt is already in planar format, the format returned is the same as the input.
int	hashCode() Get a hashable value for this object.
static boolean	isPlanar(AudioFormat.Type sample_fmt) Check if the sample format is planar.

Methods inherited from class io.humble.ferry.RefCounted

delete, getCurrentRefCount

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

copyReference

public AudioFormat copyReference()

Create a new AudioFormat object that is actually referring to the exact same underlying native object.

Overrides:

copyReference in class RefCounted

Returns:

the new Java object.

equals

public boolean equals(Object obj)

Compares two values, returning true if the underlying objects in native code are the same object. That means you can have two different Java objects, but when you do a comparison, you'll find out they are the EXACT same object.

Overrides:

equals in class Object

Returns:

True if the underlying native object is the same. False otherwise.

hashCode

public int hashCode()

Get a hashable value for this object.

Overrides:

hashCode in class Object

Returns:

the hashable value.

getName

public static String getName(AudioFormat.Type format)

Return the name of format, or NULL if format is not
recognized.

getFormat

public static AudioFormat.Type getFormat(String name)

Return a sample format corresponding to name, or SAMPLE_FMT_NONE
on error.

getAlternateSampleFormat

public static AudioFormat.Type getAlternateSampleFormat(AudioFormat.Type sample_fmt,
                                                        boolean planar)

Return the planar<->packed alternative form of the given sample format, or
SAMPLE_FMT_NONE on error. If the passed sample_fmt is already in the
requested planar/packed format, the format returned is the same as the
input.

getPackedSampleFormat

public static AudioFormat.Type getPackedSampleFormat(AudioFormat.Type sample_fmt)

Get the packed alternative form of the given sample format.

If the passed sample_fmt is already in packed format, the format returned is
the same as the input.

Returns:

the packed alternative form of the given sample format or
AV_SAMPLE_FMT_NONE on error.

getPlanarSampleFormat

public static AudioFormat.Type getPlanarSampleFormat(AudioFormat.Type sample_fmt)

Get the planar alternative form of the given sample format.

If the passed sample_fmt is already in planar format, the format returned is
the same as the input.

Returns:

the planar alternative form of the given sample format or
SAMPLE_FMT_NONE on error.

getBytesPerSample

public static int getBytesPerSample(AudioFormat.Type sample_fmt)

Return number of bytes per sample.

Parameters:

sample_fmt - the sample format

Returns:

number of bytes per sample or zero if unknown for the given
sample format

isPlanar

public static boolean isPlanar(AudioFormat.Type sample_fmt)

Check if the sample format is planar.

Parameters:

sample_fmt - the sample format to inspect

Returns:

1 if the sample format is planar, 0 if it is interleaved

getBufferSizeNeeded

public static int getBufferSizeNeeded(int numSamples,
                                      int numChannels,
                                      AudioFormat.Type format)

Get the size of a buffer in bytes that would be required to hold the
number of samples of audio in the given format and with the given number of channels.

getDataPlaneSizeNeeded

public static int getDataPlaneSizeNeeded(int numSamples,
                                         int numChannels,
                                         AudioFormat.Type format)

Get the size of a plane of audio bytes that would be required to hold the
number of samples of audio in the given format and with the given number of channels.

If format is packed, then this method returns the same number as #getBufferSizeNeeded(int, int, Type).