2 * Sonitus - Pipeline.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;
20 import java.io.IOException;
21 import java.util.Collection;
22 import java.util.Iterator;
23 import java.util.List;
24 import java.util.concurrent.Callable;
25 import java.util.concurrent.ExecutionException;
26 import java.util.concurrent.ExecutorService;
27 import java.util.concurrent.Executors;
28 import java.util.concurrent.Future;
29 import java.util.concurrent.atomic.AtomicBoolean;
30 import java.util.logging.Logger;
32 import com.google.common.base.Function;
33 import com.google.common.base.Optional;
34 import com.google.common.base.Preconditions;
35 import com.google.common.collect.ArrayListMultimap;
36 import com.google.common.collect.FluentIterable;
37 import com.google.common.collect.ImmutableList;
38 import com.google.common.collect.ImmutableMultimap;
39 import com.google.common.collect.Lists;
40 import com.google.common.collect.Multimap;
41 import com.google.common.util.concurrent.MoreExecutors;
44 * A pipeline is responsible for streaming audio data from a {@link Source} to
45 * an arbitrary number of connected {@link Filter}s and {@link Sink}s.
47 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
49 public class Pipeline implements Iterable<ControlledComponent> {
52 private static final Logger logger = Logger.getLogger(Pipeline.class.getName());
54 /** The source of the audio stream. */
55 private final Source source;
57 /** The sinks for each source. */
58 private final Multimap<Source, Sink> sinks;
60 /** All started connections. */
61 private final List<Connection> connections = Lists.newArrayList();
64 * Creates a new pipeline.
67 * The source of the audio stream
69 * The sinks for each source
71 private Pipeline(Source source, Multimap<Source, Sink> sinks) {
72 this.source = Preconditions.checkNotNull(source, "source must not be null");
73 this.sinks = Preconditions.checkNotNull(sinks, "sinks must not be null");
74 for (ControlledComponent component : Lists.reverse(components())) {
75 logger.finest(String.format("Adding Listener to %s.", component));
76 component.addMetadataListener(new MetadataListener() {
78 public void metadataUpdated(ControlledComponent component, Metadata metadata) {
79 if (!(component instanceof Source)) {
82 for (ControlledComponent controlledComponent : sinks((Source) component)) {
83 logger.fine(String.format("Updating Metadata from %s to %s.", component, controlledComponent));
84 controlledComponent.metadataUpdated(metadata);
96 * Expose this pipeline’s source.
98 * @return This pipeline’s source
100 public Source source() {
105 * Returns all {@link Sink}s (or {@link Filter}s, really) that are connected to
109 * The source to get the sinks for
110 * @return The sinks connected to the given source, or an empty list if the
111 * source does not exist in this pipeline
113 public Collection<Sink> sinks(Source source) {
114 return sinks.get(source);
118 * Returns the traffic counters of the given controlled component.
120 * @param controlledComponent
121 * The controlled component to get the traffic counters for
122 * @return The traffic counters for the given controlled component
124 public TrafficCounter trafficCounter(ControlledComponent controlledComponent) {
127 for (Connection connection : connections) {
128 /* the connection where the source matches knows the output. */
129 if (connection.source.equals(controlledComponent)) {
130 output = connection.counter();
131 } else if (connection.sinks.contains(controlledComponent)) {
132 input = connection.counter();
135 return new TrafficCounter(input, output);
143 * Starts the pipeline.
145 * @throws IOException
146 * if any of the sinks can not be opened
147 * @throws IllegalStateException
148 * if the pipeline is already running
150 public void start() throws IOException, IllegalStateException {
151 if (!connections.isEmpty()) {
152 throw new IllegalStateException("Pipeline is already running!");
154 List<Source> sources = Lists.newArrayList();
156 /* collect all source->sink pairs. */
157 while (!sources.isEmpty()) {
158 Source source = sources.remove(0);
159 Collection<Sink> sinks = this.sinks.get(source);
160 connections.add(new Connection(source, sinks));
161 for (Sink sink : sinks) {
162 sink.open(source.metadata());
163 if (sink instanceof Filter) {
164 sources.add((Source) sink);
168 for (Connection connection : connections) {
169 logger.info(String.format("Starting Connection from %s to %s.", connection.source, connection.sinks));
170 new Thread(connection).start();
175 if (!connections.isEmpty()) {
176 /* pipeline is not running. */
179 for (Connection connection : connections) {
189 public Iterator<ControlledComponent> iterator() {
190 return components().iterator();
198 * Returns all components of this pipeline, listed breadth-first, starting with
201 * @return All components of this pipeline
203 public List<ControlledComponent> components() {
204 ImmutableList.Builder<ControlledComponent> components = ImmutableList.builder();
205 List<ControlledComponent> currentComponents = Lists.newArrayList();
206 components.add(source);
207 currentComponents.add(source);
208 while (!currentComponents.isEmpty()) {
209 Collection<Sink> sinks = this.sinks((Source) currentComponents.remove(0));
210 for (Sink sink : sinks) {
211 components.add(sink);
212 if (sink instanceof Source) {
213 currentComponents.add(sink);
217 return components.build();
225 * Returns a new pipeline builder.
228 * The source at which to start
229 * @return A builder for a new pipeline
231 public static Builder builder(Source source) {
232 return new Builder(source);
236 * A builder for a {@link Pipeline}.
238 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
240 public static class Builder {
242 /** The source of the pipeline. */
243 private final Source source;
245 /** The sinks to which each source streams. */
246 private Multimap<Source, Sink> nextSinks = ArrayListMultimap.create();
248 /** The last added source. */
249 private Source lastSource;
252 * Creates a new builder.
255 * The source that starts the pipeline
257 private Builder(Source source) {
258 this.source = source;
263 * Adds a {@link Sink} (or {@link Filter} as a recipient for the last added
268 * @return This builder
269 * @throws IllegalStateException
270 * if the last added {@link Sink} was not also a {@link Source}
272 public Builder to(Sink sink) {
273 Preconditions.checkState(lastSource != null, "last added Sink was not a Source");
274 nextSinks.put(lastSource, sink);
275 lastSource = (sink instanceof Filter) ? (Source) sink : null;
280 * Locates the given source and sets it as the last added node so that the
281 * next invocation of {@link #to(Sink)} can “fork” the pipeline.
284 * The source to locate
285 * @return This builder
286 * @throws IllegalStateException
287 * if the given source was not previously added as a sink
289 public Builder find(Source source) {
290 Preconditions.checkState(nextSinks.containsValue(source));
296 * Builds the pipeline.
298 * @return The created pipeline
300 public Pipeline build() {
301 return new Pipeline(source, ImmutableMultimap.copyOf(nextSinks));
307 * A connection is responsible for streaming audio from one {@link Source} to
308 * an arbitrary number of {@link Sink}s it is connected to. A connection is
309 * started by creating a {@link Thread} wrapping it and starting said thread.
311 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
313 public class Connection implements Runnable {
316 private final Source source;
319 private final Collection<Sink> sinks;
321 /** Whether the feeder was stopped. */
322 private final AtomicBoolean stopped = new AtomicBoolean(false);
324 /** The executor service. */
325 private final ExecutorService executorService;
327 /** The number of copied bytes. */
328 private long counter;
331 * Creates a new connection.
334 * The source of the stream
336 * The sinks to which to stream
338 public Connection(Source source, Collection<Sink> sinks) {
339 this.source = source;
341 if (sinks.size() == 1) {
342 executorService = MoreExecutors.sameThreadExecutor();
344 executorService = Executors.newCachedThreadPool();
353 * Returns the number of bytes that this connection has received from its
354 * source during its lifetime.
356 * @return The number of processed input bytes
358 public long counter() {
366 /** Stops this connection. */
377 Metadata firstMetadata = null;
378 while (!stopped.get()) {
382 logger.finest(String.format("Getting %d bytes from %s...", 4096, source));
383 buffer = source.get(4096);
384 logger.finest(String.format("Got %d bytes from %s.", buffer.length, source));
385 } catch (IOException ioe1) {
386 throw new IOException(String.format("I/O error while reading from %s.", source), ioe1);
388 List<Future<Void>> futures = executorService.invokeAll(FluentIterable.from(sinks).transform(new Function<Sink, Callable<Void>>() {
391 public Callable<Void> apply(final Sink sink) {
392 return new Callable<Void>() {
395 public Void call() throws Exception {
397 logger.finest(String.format("Sending %d bytes to %s.", buffer.length, sink));
398 sink.process(buffer);
399 logger.finest(String.format("Sent %d bytes to %s.", buffer.length, sink));
400 } catch (IOException ioe1) {
401 throw new IOException(String.format("I/O error while writing to %s", sink), ioe1);
408 /* check all threads for exceptions. */
409 for (Future<Void> future : futures) {
412 counter += buffer.length;
413 } catch (IOException e) {
417 } catch (InterruptedException e) {
421 } catch (ExecutionException e) {
432 * Container for input and output counters.
434 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
436 public static class TrafficCounter {
438 /** The number of input bytes. */
439 private final long input;
441 /** The number of output bytes. */
442 private final long output;
445 * Creates a new traffic counter.
448 * The number of input bytes (may be {@code -1} to signify non-available
451 * The number of output bytes (may be {@code -1} to signify non-available
454 public TrafficCounter(long input, long output) {
456 this.output = output;
464 * Returns the number of input bytes.
466 * @return The number of input bytes, or {@link Optional#absent()} if the
467 * component can not receive input
469 public Optional<Long> input() {
470 return (input == -1) ? Optional.<Long>absent() : Optional.of(input);
474 * Returns the number of output bytes.
476 * @return The number of output bytes, or {@link Optional#absent()} if the
477 * component can not send output
479 public Optional<Long> output() {
480 return (output == -1) ? Optional.<Long>absent() : Optional.of(output);