1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
/**
* Copyright 2013-2023 JogAmp Community. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are
* permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this list of
* conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice, this list
* of conditions and the following disclaimer in the documentation and/or other materials
* provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are those of the
* authors and should not be interpreted as representing official policies, either expressed
* or implied, of JogAmp Community.
*/
package com.jogamp.common.av;
/**
* Specifies the linear audio PCM format.
*/
public class AudioFormat {
/**
* @param sampleRate sample rate in Hz (1/s), e.g. 44100 Hz
* @param sampleSize sample size in bits, e.g. 16 bits
* @param channelCount number of channels, e.g. 2 channels for stereo
* @param signed true if signed PCM values, false for unsigned values
* @param fixedP true for fixed point values, false for unsigned floating point values with a sampleSize of 32 (float) or 64 (double)
* @param planar true for planar data package (each channel in own data buffer), false for packed data channels interleaved in one buffer.
* @param littleEndian true for little-endian byte order, false for big endian byte order
*/
public AudioFormat(final int sampleRate, final int sampleSize, final int channelCount, final boolean signed, final boolean fixedP, final boolean planar, final boolean littleEndian) {
this.sampleRate = sampleRate;
this.sampleSize = sampleSize;
this.channelCount = channelCount;
this.signed = signed;
this.fixedP = fixedP;
this.planar = planar;
this.littleEndian = littleEndian;
if( !fixedP ) {
if( sampleSize != 32 && sampleSize != 64 ) {
throw new IllegalArgumentException("Floating point: sampleSize "+sampleSize+" bits");
}
if( !signed ) {
throw new IllegalArgumentException("Floating point: unsigned");
}
}
}
/** Sample rate in Hz (1/s, e.g. 44100 Hz. */
public final int sampleRate;
/** Sample size in bits, e.g. 16 bits. */
public final int sampleSize;
/** Number of channels, e.g. 2 channels for stereo. */
public final int channelCount;
/** Signed PCM values if true, otherwise unsigned values. */
public final boolean signed;
/** Fixed or floating point values. Floating point 'float' has {@link #sampleSize} 32, 'double' has {@link #sampleSize} 64. */
public final boolean fixedP;
/** Planar or packed samples. If planar, each channel has their own data buffer. If packed, channel data is interleaved in one buffer. */
public final boolean planar;
/** Little-endian byte order if true, otherwise big endian byte order. */
public final boolean littleEndian;
//
// Time <-> Bytes
//
/**
* Returns the byte size of the given duration in seconds
* according to {@link #sampleSize}, {@link #channelCount} and {@link #sampleRate}.
* <pre>
* final float bytesPerSample = sampleSize/8;
* return Math.round( duration * channelCount * bytesPerSample * sampleRate );
* </pre>
* <p>
* Time -> Byte Count
* </p>
* @param duration duration in seconds
*/
public final int getDurationsByteSize(final float duration) {
final float bytesPerSample = sampleSize >>> 3; // /8
return Math.round( duration * channelCount * bytesPerSample * sampleRate );
}
/**
* Returns the duration in seconds of the given byte count
* according to {@link #sampleSize}, {@link #channelCount} and {@link #sampleRate}.
* <pre>
* final float bytesPerSample = sampleSize/8;
* return byteCount / ( channelCount * bytesPerSample * sampleRate )
* </pre>
* <p>
* Byte Count -> Time
* </p>
* @param byteCount size in bytes
*/
public final float getBytesDuration(final int byteCount) {
final float bytesPerSample = sampleSize >>> 3; // /8
return byteCount / ( channelCount * bytesPerSample * sampleRate );
}
/**
* Returns the duration in seconds of the given sample count per frame and channel
* according to the {@link #sampleRate}, i.e.
* <pre>
* (float)sampleCount / sampleRate
* </pre>
* <p>
* Sample Count -> Time
* </p>
* @param sampleCount sample count per frame and channel
*/
public final float getSamplesDuration(final int sampleCount) {
return (float)sampleCount / sampleRate;
}
/**
* Returns the rounded frame count of the given duration and frame duration, both in seconds.
* <pre>
* Math.max(1, Math.round( duration / frameDuration ))
* </pre>
* <p>
* Note: <code>frameDuration</code> can be derived by <i>sample count per frame and channel</i>
* via {@link #getSamplesDuration(int)} or by <i>byte count</i> via {@link #getBytesDuration(int)}.
* </p>
* <p>
* Frame Time -> Frame Count
* </p>
* @param duration duration in seconds
* @param frameDuration duration per frame in seconds, i.e. 1/frame_rate
* @see #getSamplesDuration(int)
* @see #getBytesDuration(int)
*/
public final int getFrameCount(final float duration, final float frameDuration) {
return Math.max(1, Math.round( duration / frameDuration ));
}
/**
* Returns the byte size of given sample count
* according to the {@link #sampleSize}, i.e.:
* <pre>
* sampleCount * ( sampleSize / 8 )
* </pre>
* <p>
* Note: To retrieve the byte size for all channels,
* you need to pre-multiply <code>sampleCount</code> with {@link #channelCount}.
* </p>
* <p>
* Sample Count -> Byte Count
* </p>
* @param sampleCount sample count
*/
public final int getSamplesByteCount(final int sampleCount) {
return sampleCount * ( sampleSize >>> 3 );
}
/**
* Returns the sample count of given byte count
* according to the {@link #sampleSize}, i.e.:
* <pre>
* ( byteCount * 8 ) / sampleSize
* </pre>
* <p>
* Note: If <code>byteCount</code> covers all channels and you request the sample size per channel,
* you need to divide the result by <code>sampleCount</code> by {@link #channelCount}.
* </p>
* <p>
* Byte Count -> Sample Count
* </p>
* @param byteCount number of bytes
*/
public final int getBytesSampleCount(final int byteCount) {
return ( byteCount << 3 ) / sampleSize;
}
@Override
public String toString() {
return "AudioFormat[sampleRate "+sampleRate+", sampleSize "+sampleSize+", channelCount "+channelCount+
", signed "+signed+", fixedP "+fixedP+", "+(planar?"planar":"packed")+", "+(littleEndian?"little":"big")+"-endian]"; }
}
|
