2 * Sonitus - AudioSink.java - Copyright © 2013 David Roden
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 package net.pterodactylus.sonitus.data.sink;
20 import static javax.sound.sampled.BooleanControl.Type.MUTE;
21 import static javax.sound.sampled.FloatControl.Type.VOLUME;
23 import java.io.IOException;
24 import java.io.OutputStream;
25 import java.util.Arrays;
26 import java.util.List;
27 import java.util.logging.Logger;
28 import javax.sound.sampled.AudioFormat;
29 import javax.sound.sampled.AudioSystem;
30 import javax.sound.sampled.BooleanControl;
31 import javax.sound.sampled.Control;
32 import javax.sound.sampled.DataLine;
33 import javax.sound.sampled.FloatControl;
34 import javax.sound.sampled.LineUnavailableException;
35 import javax.sound.sampled.SourceDataLine;
37 import net.pterodactylus.sonitus.data.Controller;
38 import net.pterodactylus.sonitus.data.Metadata;
39 import net.pterodactylus.sonitus.data.Sink;
40 import net.pterodactylus.sonitus.data.Source;
41 import net.pterodactylus.sonitus.data.controller.Fader;
42 import net.pterodactylus.sonitus.data.controller.Switch;
43 import net.pterodactylus.sonitus.data.event.MetadataUpdated;
44 import net.pterodactylus.sonitus.io.IntegralWriteOutputStream;
46 import com.google.common.base.Preconditions;
47 import com.google.common.eventbus.EventBus;
50 * {@link Sink} implementation that uses the JDK’s {@link AudioSystem} to play
51 * all {@link Source}s.
53 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
55 public class AudioSink implements Sink {
58 private static final Logger logger = Logger.getLogger(AudioSink.class.getName());
61 private final EventBus eventBus;
63 /** The volume fader. */
64 private final Fader volumeFader;
66 /** The “mute” switch. */
67 private final Switch muteSwitch;
69 /** The current metadata. */
70 private Metadata metadata;
72 /** The audio output. */
73 private SourceDataLine sourceDataLine;
75 /** A buffered output stream to ensure correct writing to the source data line. */
76 private OutputStream sourceDataLineOutputStream = new IntegralWriteOutputStream(new OutputStream() {
79 public void write(int b) throws IOException {
83 public void write(byte[] b) throws IOException {
84 write(b, 0, b.length);
88 public void write(byte[] b, int off, int len) throws IOException {
89 if (sourceDataLine != null) {
90 sourceDataLine.write(b, off, len);
96 * Creates a new audio sink.
101 public AudioSink(EventBus eventBus) {
102 this.eventBus = eventBus;
103 volumeFader = new Fader("Volume") {
106 protected void valueSet(Double value) {
107 /* search for preferred volume control. */
108 FloatControl volumeControl = getVolumeControl(sourceDataLine);
109 if (volumeControl == null) {
110 /* could not find volume control! */
114 volumeControl.setValue((float) (value * volumeControl.getMaximum()));
117 muteSwitch = new Switch("Mute") {
119 /** The previous value in case we have to emulate the mute control. */
120 private float previousValue;
123 protected void valueSet(Boolean value) {
124 /* search for mute control. */
125 BooleanControl muteControl = getMuteControl(sourceDataLine);
126 if (muteControl != null) {
127 muteControl.setValue(value);
131 /* could not find mute control, use volume control! */
132 FloatControl volumeControl = getVolumeControl(sourceDataLine);
133 if (volumeControl == null) {
134 /* no volume control, either? */
139 previousValue = volumeControl.getValue();
140 volumeControl.setValue(0);
142 volumeControl.setValue(previousValue);
150 // CONTROLLED METHODS
154 public String name() {
155 return "Audio Output";
159 public Metadata metadata() {
164 public List<Controller<?>> controllers() {
165 return Arrays.<Controller<?>>asList(volumeFader, muteSwitch);
173 public void open(Metadata metadata) throws IOException {
174 Preconditions.checkArgument(metadata.encoding().equalsIgnoreCase("PCM"), "source must be PCM-encoded");
175 AudioFormat audioFormat = new AudioFormat(metadata.frequency(), 16, metadata.channels(), true, false);
177 sourceDataLine = AudioSystem.getSourceDataLine(audioFormat);
178 sourceDataLine.open(audioFormat);
179 sourceDataLine.start();
180 metadataUpdated(metadata);
181 } catch (LineUnavailableException e) {
183 sourceDataLine = null;
184 throw new IOException(e);
189 public void close() {
190 sourceDataLine.stop();
191 sourceDataLine.close();
195 public void metadataUpdated(Metadata metadata) {
196 logger.info(String.format("Now playing %s.", metadata));
197 this.metadata = metadata;
198 eventBus.post(new MetadataUpdated(this, metadata));
202 public void process(byte[] buffer) throws IOException {
203 sourceDataLineOutputStream.write(buffer);
204 logger.finest(String.format("AudioSink: Wrote %d Bytes.", buffer.length));
212 * Returns the {@link FloatControl.Type.VOLUME} control.
215 * The data line to search for the control
216 * @return The control, or {@code null} if no volume control could be found
218 private static FloatControl getVolumeControl(DataLine dataLine) {
219 return getControl(dataLine, VOLUME, FloatControl.class);
223 * Returns the {@link BooleanControl.Type.MUTE} control.
226 * The data line to search for the control
227 * @return The control, or {@code null} if no mute control could be found
229 private static BooleanControl getMuteControl(DataLine dataLine) {
230 return getControl(dataLine, MUTE, BooleanControl.class);
234 * Searches the given data line for a control of the given type and returns it.
235 * If the given data line is {@code null}, {@code null} is returned.
238 * The data line to search for a control
240 * The type of the control to search
241 * @param controlClass
242 * The class of the control
244 * The class of the control
245 * @return The control, or {@code null} if no control could be found
247 private static <T> T getControl(DataLine dataLine, Control.Type controlType, Class<T> controlClass) {
248 if (dataLine == null) {
251 Control[] controls = dataLine.getControls();
252 for (Control control : controls) {
253 if (control.getType().equals(controlType)) {