This repository has been archived by the owner on May 7, 2020. It is now read-only.
/
AudioFormat.java
440 lines (394 loc) · 14.3 KB
/
AudioFormat.java
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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
/**
* Copyright (c) 2014,2019 Contributors to the Eclipse Foundation
*
* See the NOTICE file(s) distributed with this work for additional
* information regarding copyright ownership.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.eclipse.smarthome.core.audio;
import java.util.Set;
/**
* An audio format definition
*
* @author Harald Kuhn - Initial API
* @author Kelly Davis - Modified to match discussion in #584
* @author Kai Kreuzer - Moved class, included constants, added toString
*/
public class AudioFormat {
// generic mp3 format without any further constraints
public static final AudioFormat MP3 = new AudioFormat(AudioFormat.CONTAINER_NONE, AudioFormat.CODEC_MP3, null, null,
null, null);
// generic wav format without any further constraints
public static final AudioFormat WAV = new AudioFormat(AudioFormat.CONTAINER_WAVE, AudioFormat.CODEC_PCM_SIGNED,
null, null, null, null);
// generic OGG format without any further constraints
public static final AudioFormat OGG = new AudioFormat(AudioFormat.CONTAINER_OGG, AudioFormat.CODEC_VORBIS, null,
null, null, null);
// generic AAC format without any further constraints
public static final AudioFormat AAC = new AudioFormat(AudioFormat.CONTAINER_NONE, AudioFormat.CODEC_AAC, null, null,
null, null);
/**
* {@link AudioCodec} encoded data without any container header or footer,
* e.g. MP3 is a non-container format
*/
public static final String CONTAINER_NONE = "NONE";
/**
* Microsofts wave container format
*
* @see <a href="http://bit.ly/1TUW93t">WAV Format</a>
* @see <a href="http://bit.ly/1oRMKOt">Supported codecs</a>
* @see <a href="http://bit.ly/1TUWSlk">RIFF container format</a>
*/
public static final String CONTAINER_WAVE = "WAVE";
/**
* OGG container format
*
* @see <a href="http://bit.ly/1oRMWNE">OGG</a>
*/
public static final String CONTAINER_OGG = "OGG";
/**
* PCM Signed
*
* @see <a href="http://wiki.multimedia.cx/?title=PCM#PCM_Types">PCM Types</a>
*/
public static final String CODEC_PCM_SIGNED = "PCM_SIGNED";
/**
* PCM Unsigned
*
* @see <a href="http://wiki.multimedia.cx/?title=PCM#PCM_Types">PCM Types</a>
*/
public static final String CODEC_PCM_UNSIGNED = "PCM_UNSIGNED";
/**
* PCM A-law
*
* @see <a href="http://wiki.multimedia.cx/?title=PCM#PCM_Types">PCM Types</a>
*/
public static final String CODEC_PCM_ALAW = "ALAW";
/**
* PCM u-law
*
* @see <a href="http://wiki.multimedia.cx/?title=PCM#PCM_Types">PCM Types</a>
*/
public static final String CODEC_PCM_ULAW = "ULAW";
/**
* MP3 Codec
*
* @see <a href="http://wiki.multimedia.cx/index.php?title=MP3">MP3 Codec</a>
*/
public static final String CODEC_MP3 = "MP3";
/**
* Vorbis Codec
*
* @see <a href="http://xiph.org/vorbis/doc/">Vorbis</a>
*/
public static final String CODEC_VORBIS = "VORBIS";
/**
* AAC Codec
*/
public static final String CODEC_AAC = "AAC";
/**
* Codec
*/
private final String codec;
/**
* Container
*/
private final String container;
/**
* Big endian or little endian
*/
private final Boolean bigEndian;
/**
* Bit depth
*
* @see <a href="http://bit.ly/1OTydad">Bit Depth</a>
*/
private final Integer bitDepth;
/**
* Bit rate
*
* @see <a href="http://bit.ly/1OTy5rk">Bit Rate</a>
*/
private final Integer bitRate;
/**
* Sample frequency
*/
private final Long frequency;
/**
* Constructs an instance with the specified properties.
*
* Note that any properties that are null indicate that
* the corresponding AudioFormat allows any value for
* the property.
*
* Concretely this implies that if, for example, one
* passed null for the value of frequency, this would
* mean the created AudioFormat allowed for any valid
* frequency.
*
* @param container The container for the audio
* @param codec The audio codec
* @param bigEndian If the audo data is big endian
* @param bitDepth The bit depth of the audo data
* @param bitRate The bit rate of the audio
* @param frequency The frequency at which the audio was sampled
*/
public AudioFormat(String container, String codec, Boolean bigEndian, Integer bitDepth, Integer bitRate,
Long frequency) {
this.container = container;
this.codec = codec;
this.bigEndian = bigEndian;
this.bitDepth = bitDepth;
this.bitRate = bitRate;
this.frequency = frequency;
}
/**
* Gets codec
*
* @return The codec
*/
public String getCodec() {
return codec;
}
/**
* Gets container
*
* @return The container
*/
public String getContainer() {
return container;
}
/**
* Is big endian?
*
* @return If format is big endian
*/
public Boolean isBigEndian() {
return bigEndian;
}
/**
* Gets bit depth
*
* @see <a href="http://bit.ly/1OTydad">Bit Depth</a>
* @return Bit depth
*/
public Integer getBitDepth() {
return bitDepth;
}
/**
* Gets bit rate
*
* @see <a href="http://bit.ly/1OTy5rk">Bit Rate</a>
* @return Bit rate
*/
public Integer getBitRate() {
return bitRate;
}
/**
* Gets frequency
*
* @return The frequency
*/
public Long getFrequency() {
return frequency;
}
/**
* Determines if the passed AudioFormat is compatible with this AudioFormat.
*
* This AudioFormat is compatible with the passed AudioFormat if both have
* the same value for all non-null members of this instance.
*/
public boolean isCompatible(AudioFormat audioFormat) {
if (audioFormat == null) {
return false;
}
if ((null != getContainer()) && (!getContainer().equals(audioFormat.getContainer()))) {
return false;
}
if ((null != getCodec()) && (!getCodec().equals(audioFormat.getCodec()))) {
return false;
}
if ((null != isBigEndian()) && (!isBigEndian().equals(audioFormat.isBigEndian()))) {
return false;
}
if ((null != getBitDepth()) && (!getBitDepth().equals(audioFormat.getBitDepth()))) {
return false;
}
if ((null != getBitRate()) && (!getBitRate().equals(audioFormat.getBitRate()))) {
return false;
}
if ((null != getFrequency()) && (!getFrequency().equals(audioFormat.getFrequency()))) {
return false;
}
return true;
}
/**
* Determines the best match between a list of audio formats supported by a source and a sink.
*
* @param inputs the supported audio formats of an audio source
* @param outputs the supported audio formats of an audio sink
* @return the best matching format or null, if source and sink are incompatible
*/
public static AudioFormat getBestMatch(Set<AudioFormat> inputs, Set<AudioFormat> outputs) {
AudioFormat preferredFormat = getPreferredFormat(inputs);
if (preferredFormat != null) {
for (AudioFormat output : outputs) {
if (output.isCompatible(preferredFormat)) {
return preferredFormat;
} else {
for (AudioFormat input : inputs) {
if (output.isCompatible(input)) {
return input;
}
}
}
}
}
return null;
}
/**
* Gets the first concrete AudioFormat in the passed set or a preferred one
* based on 16bit, 16KHz, big endian default
*
* @param audioFormats The AudioFormats from which to choose
* @return The preferred AudioFormat or null if none could be determined. A passed concrete format is preferred
* adding default values to an abstract AudioFormat in the passed set.
*/
public static AudioFormat getPreferredFormat(Set<AudioFormat> audioFormats) {
// Return the first concrete AudioFormat found
for (AudioFormat currentAudioFormat : audioFormats) {
// Check if currentAudioFormat is abstract
if (null == currentAudioFormat.getCodec()) {
continue;
}
if (null == currentAudioFormat.getContainer()) {
continue;
}
if (null == currentAudioFormat.isBigEndian()) {
continue;
}
if (null == currentAudioFormat.getBitDepth()) {
continue;
}
if (null == currentAudioFormat.getBitRate()) {
continue;
}
if (null == currentAudioFormat.getFrequency()) {
continue;
}
// Prefer WAVE container
if (!currentAudioFormat.getContainer().equals("WAVE")) {
continue;
}
// As currentAudioFormat is concrete, use it
return currentAudioFormat;
}
// There's no concrete AudioFormat so we must create one
for (AudioFormat currentAudioFormat : audioFormats) {
// Define AudioFormat to return
AudioFormat format = currentAudioFormat;
// Not all Codecs and containers can be supported
if (null == format.getCodec()) {
continue;
}
if (null == format.getContainer()) {
continue;
}
// Prefer WAVE container
if (!format.getContainer().equals(AudioFormat.CONTAINER_WAVE)) {
continue;
}
// If required set BigEndian, BitDepth, BitRate, and Frequency to default values
if (null == format.isBigEndian()) {
format = new AudioFormat(format.getContainer(), format.getCodec(), new Boolean(true),
format.getBitDepth(), format.getBitRate(), format.getFrequency());
}
if (null == format.getBitDepth() || null == format.getBitRate() || null == format.getFrequency()) {
// Define default values
int defaultBitDepth = 16;
long defaultFrequency = 16384;
// Obtain current values
Integer bitRate = format.getBitRate();
Long frequency = format.getFrequency();
Integer bitDepth = format.getBitDepth();
// These values must be interdependent (bitRate = bitDepth * frequency)
if (null == bitRate) {
if (null == bitDepth) {
bitDepth = new Integer(defaultBitDepth);
}
if (null == frequency) {
frequency = new Long(defaultFrequency);
}
bitRate = new Integer(bitDepth.intValue() * frequency.intValue());
} else if (null == bitDepth) {
if (null == frequency) {
frequency = new Long(defaultFrequency);
}
bitDepth = new Integer(bitRate.intValue() / frequency.intValue());
} else if (null == frequency) {
frequency = new Long(bitRate.longValue() / bitDepth.longValue());
}
format = new AudioFormat(format.getContainer(), format.getCodec(), format.isBigEndian(), bitDepth,
bitRate, frequency);
}
// Return preferred AudioFormat
return format;
}
// Return null indicating failure
return null;
}
@Override
public boolean equals(Object obj) {
if (obj instanceof AudioFormat) {
AudioFormat format = (AudioFormat) obj;
if (!(null == getCodec() ? null == format.getCodec() : getCodec().equals(format.getCodec()))) {
return false;
}
if (!(null == getContainer() ? null == format.getContainer()
: getContainer().equals(format.getContainer()))) {
return false;
}
if (!(null == isBigEndian() ? null == format.isBigEndian() : isBigEndian().equals(format.isBigEndian()))) {
return false;
}
if (!(null == getBitDepth() ? null == format.getBitDepth() : getBitDepth().equals(format.getBitDepth()))) {
return false;
}
if (!(null == getBitRate() ? null == format.getBitRate() : getBitRate().equals(format.getBitRate()))) {
return false;
}
if (!(null == getFrequency() ? null == format.getFrequency()
: getFrequency().equals(format.getFrequency()))) {
return false;
}
return true;
}
return super.equals(obj);
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + ((bigEndian == null) ? 0 : bigEndian.hashCode());
result = prime * result + ((bitDepth == null) ? 0 : bitDepth.hashCode());
result = prime * result + ((bitRate == null) ? 0 : bitRate.hashCode());
result = prime * result + ((codec == null) ? 0 : codec.hashCode());
result = prime * result + ((container == null) ? 0 : container.hashCode());
result = prime * result + ((frequency == null) ? 0 : frequency.hashCode());
return result;
}
@Override
public String toString() {
return "AudioFormat [" + (codec != null ? "codec=" + codec + ", " : "")
+ (container != null ? "container=" + container + ", " : "")
+ (bigEndian != null ? "bigEndian=" + bigEndian + ", " : "")
+ (bitDepth != null ? "bitDepth=" + bitDepth + ", " : "")
+ (bitRate != null ? "bitRate=" + bitRate + ", " : "")
+ (frequency != null ? "frequency=" + frequency : "") + "]";
}
}