|
GlueGen v2.6.0-rc-20250712
GlueGen, Native Binding Generator for Java (public API).
|
Specifies the linear audio PCM format. More...
Public Member Functions | |
| AudioFormat (final int sampleRate, final int sampleSize, final int channelCount, final boolean signed, final boolean fixedP, final boolean planar, final boolean littleEndian) | |
| final int | getDurationsByteSize (final float duration) |
Returns the byte size of the given duration in seconds according to sampleSize, channelCount and sampleRate. More... | |
| final float | getBytesDuration (final int byteCount) |
Returns the duration in seconds of the given byte count according to sampleSize, channelCount and sampleRate. More... | |
| final float | getSamplesDuration (final int sampleCount) |
Returns the duration in seconds of the given sample count per frame and channel according to the sampleRate, i.e. More... | |
| final int | getFrameCount (final float duration, final float frameDuration) |
| Returns the rounded frame count of the given duration and frame duration, both in seconds. More... | |
| final int | getSamplesByteCount (final int sampleCount) |
Returns the byte size of given sample count according to the sampleSize, i.e. More... | |
| final int | getBytesSampleCount (final int byteCount) |
Returns the sample count of given byte count according to the sampleSize, i.e. More... | |
| String | toString () |
Public Attributes | |
| final int | sampleRate |
| Sample rate in Hz (1/s, e.g. More... | |
| final int | sampleSize |
| Sample size in bits, e.g. More... | |
| final int | channelCount |
| Number of channels, e.g. More... | |
| final boolean | signed |
| Signed PCM values if true, otherwise unsigned values. More... | |
| final boolean | fixedP |
| Fixed or floating point values. More... | |
| final boolean | planar |
| Planar or packed samples. More... | |
| final boolean | littleEndian |
| Little-endian byte order if true, otherwise big endian byte order. More... | |
Specifies the linear audio PCM format.
Definition at line 33 of file AudioFormat.java.
| com.jogamp.common.av.AudioFormat.AudioFormat | ( | final int | sampleRate, |
| final int | sampleSize, | ||
| final int | channelCount, | ||
| final boolean signed | , | ||
| final boolean | fixedP, | ||
| final boolean | planar, | ||
| final boolean | littleEndian | ||
| ) |
| sampleRate | sample rate in Hz (1/s), e.g. 44100 Hz |
| sampleSize | sample size in bits, e.g. 16 bits |
| channelCount | number of channels, e.g. 2 channels for stereo |
| signed | true if signed PCM values, false for unsigned values |
| fixedP | true for fixed point values, false for unsigned floating point values with a sampleSize of 32 (float) or 64 (double) |
| planar | true for planar data package (each channel in own data buffer), false for packed data channels interleaved in one buffer. |
| littleEndian | true for little-endian byte order, false for big endian byte order |
Definition at line 43 of file AudioFormat.java.
| final float com.jogamp.common.av.AudioFormat.getBytesDuration | ( | final int | byteCount | ) |
Returns the duration in seconds of the given byte count according to sampleSize, channelCount and sampleRate.
final float bytesPerSample = sampleSize/8; return byteCount / ( channelCount * bytesPerSample * sampleRate )
<p<blockquote>
Byte Count -> Time
| byteCount | size in bytes |
Definition at line 110 of file AudioFormat.java.
| final int com.jogamp.common.av.AudioFormat.getBytesSampleCount | ( | final int | byteCount | ) |
Returns the sample count of given byte count according to the sampleSize, i.e.
:
( byteCount * 8 ) / sampleSize
<p<blockquote>
Note: If byteCount covers all channels and you request the sample size per channel, you need to divide the result by sampleCount by channelCount.
Byte Count -> Sample Count
| byteCount | number of bytes |
Definition at line 185 of file AudioFormat.java.
| final int com.jogamp.common.av.AudioFormat.getDurationsByteSize | ( | final float | duration | ) |
Returns the byte size of the given duration in seconds according to sampleSize, channelCount and sampleRate.
final float bytesPerSample = sampleSize/8; return Math.round( duration * channelCount * bytesPerSample * sampleRate );
<p<blockquote>
Time -> Byte Count
| duration | duration in seconds |
Definition at line 93 of file AudioFormat.java.
| final int com.jogamp.common.av.AudioFormat.getFrameCount | ( | final float | duration, |
| final float | frameDuration | ||
| ) |
Returns the rounded frame count of the given duration and frame duration, both in seconds.
Math.max(1, Math.round( duration / frameDuration ))
<p<blockquote>
Note: frameDuration can be derived by sample count per frame and channel via getSamplesDuration(int) or by byte count via getBytesDuration(int).
Frame Time -> Frame Count
| duration | duration in seconds |
| frameDuration | duration per frame in seconds, i.e. 1/frame_rate |
Definition at line 147 of file AudioFormat.java.
| final int com.jogamp.common.av.AudioFormat.getSamplesByteCount | ( | final int | sampleCount | ) |
Returns the byte size of given sample count according to the sampleSize, i.e.
:
sampleCount * ( sampleSize / 8 )
<p<blockquote>
Note: To retrieve the byte size for all channels, you need to pre-multiply sampleCount with channelCount.
Sample Count -> Byte Count
| sampleCount | sample count |
Definition at line 166 of file AudioFormat.java.
| final float com.jogamp.common.av.AudioFormat.getSamplesDuration | ( | final int | sampleCount | ) |
Returns the duration in seconds of the given sample count per frame and channel according to the sampleRate, i.e.
(float)sampleCount / sampleRate
<p<blockquote>
Sample Count -> Time
| sampleCount | sample count per frame and channel |
Definition at line 126 of file AudioFormat.java.
| String com.jogamp.common.av.AudioFormat.toString | ( | ) |
Definition at line 190 of file AudioFormat.java.
| final int com.jogamp.common.av.AudioFormat.channelCount |
| final boolean com.jogamp.common.av.AudioFormat.fixedP |
Fixed or floating point values.
Floating point 'float' has sampleSize 32, 'double' has sampleSize 64.
Definition at line 70 of file AudioFormat.java.
| final boolean com.jogamp.common.av.AudioFormat.littleEndian |
Little-endian byte order if true, otherwise big endian byte order.
Definition at line 74 of file AudioFormat.java.
| final boolean com.jogamp.common.av.AudioFormat.planar |
Planar or packed samples.
If planar, each channel has their own data buffer. If packed, channel data is interleaved in one buffer.
Definition at line 72 of file AudioFormat.java.
| final int com.jogamp.common.av.AudioFormat.sampleRate |
| final int com.jogamp.common.av.AudioFormat.sampleSize |
| final boolean com.jogamp.common.av.AudioFormat.signed |
Signed PCM values if true, otherwise unsigned values.
Definition at line 68 of file AudioFormat.java.