1/*
2 * Copyright (c) 1999, 2017, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package com.sun.media.sound;
27
28import javax.sound.sampled.AudioFormat;
29import javax.sound.sampled.AudioInputStream;
30import javax.sound.sampled.AudioSystem;
31
32/**
33 * Common conversions etc.
34 *
35 * @author Kara Kytle
36 * @author Florian Bomers
37 */
38public final class Toolkit {
39
40    /**
41     * Suppresses default constructor, ensuring non-instantiability.
42     */
43    private Toolkit() {
44    }
45
46    /**
47     * Converts bytes from signed to unsigned.
48     */
49    static void getUnsigned8(byte[] b, int off, int len) {
50        for (int i = off; i < (off+len); i++) {
51            b[i] += 128;
52        }
53    }
54
55    /**
56     * Swaps bytes.
57     * @throws ArrayIndexOutOfBoundsException if len is not a multiple of 2.
58     */
59    static void getByteSwapped(byte[] b, int off, int len) {
60
61        byte tempByte;
62        for (int i = off; i < (off+len); i+=2) {
63
64            tempByte = b[i];
65            b[i] = b[i+1];
66            b[i+1] = tempByte;
67        }
68    }
69
70    /**
71     * Linear to DB scale conversion.
72     */
73    static float linearToDB(float linear) {
74
75        float dB = (float) (Math.log(((linear==0.0)?0.0001:linear))/Math.log(10.0) * 20.0);
76        return dB;
77    }
78
79    /**
80     * DB to linear scale conversion.
81     */
82    static float dBToLinear(float dB) {
83
84        float linear = (float) Math.pow(10.0, dB/20.0);
85        return linear;
86    }
87
88    /*
89     * returns bytes aligned to a multiple of blocksize
90     * the return value will be in the range of (bytes-blocksize+1) ... bytes
91     */
92    static long align(long bytes, int blockSize) {
93        // prevent null pointers
94        if (blockSize <= 1) {
95            return bytes;
96        }
97        return bytes - (bytes % blockSize);
98    }
99
100    static int align(int bytes, int blockSize) {
101        // prevent null pointers
102        if (blockSize <= 1) {
103            return bytes;
104        }
105        return bytes - (bytes % blockSize);
106    }
107
108    /*
109     * gets the number of bytes needed to play the specified number of milliseconds
110     */
111    static long millis2bytes(AudioFormat format, long millis) {
112        long result = (long) (millis * format.getFrameRate() / 1000.0f * format.getFrameSize());
113        return align(result, format.getFrameSize());
114    }
115
116    /*
117     * gets the time in milliseconds for the given number of bytes
118     */
119    static long bytes2millis(AudioFormat format, long bytes) {
120        return (long) (bytes / format.getFrameRate() * 1000.0f / format.getFrameSize());
121    }
122
123    /*
124     * gets the number of bytes needed to play the specified number of microseconds
125     */
126    static long micros2bytes(AudioFormat format, long micros) {
127        long result = (long) (micros * format.getFrameRate() / 1000000.0f * format.getFrameSize());
128        return align(result, format.getFrameSize());
129    }
130
131    /*
132     * gets the time in microseconds for the given number of bytes
133     */
134    static long bytes2micros(AudioFormat format, long bytes) {
135        return (long) (bytes / format.getFrameRate() * 1000000.0f / format.getFrameSize());
136    }
137
138    /*
139     * gets the number of frames needed to play the specified number of microseconds
140     */
141    static long micros2frames(AudioFormat format, long micros) {
142        return (long) (micros * format.getFrameRate() / 1000000.0f);
143    }
144
145    /*
146     * gets the time in microseconds for the given number of frames
147     */
148    static long frames2micros(AudioFormat format, long frames) {
149        return (long) (((double) frames) / format.getFrameRate() * 1000000.0d);
150    }
151
152    /**
153     * Throws an exception if the buffer size does not represent an integral
154     * number of sample frames.
155     */
156    static void validateBuffer(final int frameSize, final int bufferSize) {
157        if (bufferSize % frameSize == 0) {
158            return;
159        }
160        throw new IllegalArgumentException(String.format(
161                "Buffer size (%d) does not represent an integral number of "
162                        + "sample frames (%d)", bufferSize, frameSize));
163    }
164
165
166    static void isFullySpecifiedAudioFormat(AudioFormat format) {
167        if (!format.getEncoding().equals(AudioFormat.Encoding.PCM_SIGNED)
168            && !format.getEncoding().equals(AudioFormat.Encoding.PCM_UNSIGNED)
169            && !format.getEncoding().equals(AudioFormat.Encoding.ULAW)
170            && !format.getEncoding().equals(AudioFormat.Encoding.ALAW)) {
171            // we don't know how to verify possibly non-linear encodings
172            return;
173        }
174        if (format.getFrameRate() <= 0) {
175            throw new IllegalArgumentException("invalid frame rate: "
176                                               +((format.getFrameRate()==-1)?
177                                                 "NOT_SPECIFIED":String.valueOf(format.getFrameRate())));
178        }
179        if (format.getSampleRate() <= 0) {
180            throw new IllegalArgumentException("invalid sample rate: "
181                                               +((format.getSampleRate()==-1)?
182                                                 "NOT_SPECIFIED":String.valueOf(format.getSampleRate())));
183        }
184        if (format.getSampleSizeInBits() <= 0) {
185            throw new IllegalArgumentException("invalid sample size in bits: "
186                                               +((format.getSampleSizeInBits()==-1)?
187                                                 "NOT_SPECIFIED":String.valueOf(format.getSampleSizeInBits())));
188        }
189        if (format.getFrameSize() <= 0) {
190            throw new IllegalArgumentException("invalid frame size: "
191                                               +((format.getFrameSize()==-1)?
192                                                 "NOT_SPECIFIED":String.valueOf(format.getFrameSize())));
193        }
194        if (format.getChannels() <= 0) {
195            throw new IllegalArgumentException("invalid number of channels: "
196                                               +((format.getChannels()==-1)?
197                                                 "NOT_SPECIFIED":String.valueOf(format.getChannels())));
198        }
199    }
200
201    static boolean isFullySpecifiedPCMFormat(AudioFormat format) {
202        if (!format.getEncoding().equals(AudioFormat.Encoding.PCM_SIGNED)
203            && !format.getEncoding().equals(AudioFormat.Encoding.PCM_UNSIGNED)) {
204            return false;
205        }
206        if ((format.getFrameRate() <= 0)
207            || (format.getSampleRate() <= 0)
208            || (format.getSampleSizeInBits() <= 0)
209            || (format.getFrameSize() <= 0)
210            || (format.getChannels() <= 0)) {
211            return false;
212        }
213        return true;
214    }
215
216    public static AudioInputStream getPCMConvertedAudioInputStream(AudioInputStream ais) {
217        // we can't open the device for non-PCM playback, so we have
218        // convert any other encodings to PCM here (at least we try!)
219        AudioFormat af = ais.getFormat();
220
221        if( (!af.getEncoding().equals(AudioFormat.Encoding.PCM_SIGNED)) &&
222            (!af.getEncoding().equals(AudioFormat.Encoding.PCM_UNSIGNED))) {
223
224            try {
225                AudioFormat newFormat =
226                    new AudioFormat( AudioFormat.Encoding.PCM_SIGNED,
227                                     af.getSampleRate(),
228                                     16,
229                                     af.getChannels(),
230                                     af.getChannels() * 2,
231                                     af.getSampleRate(),
232                                     Platform.isBigEndian());
233                ais = AudioSystem.getAudioInputStream(newFormat, ais);
234            } catch (Exception e) {
235                if (Printer.err) e.printStackTrace();
236                ais = null;
237            }
238        }
239
240        return ais;
241    }
242}
243