2 * Sonitus - AudioProcessingFilter.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.filter;
20 import java.io.IOException;
21 import java.io.OutputStream;
23 import net.pterodactylus.sonitus.data.Filter;
24 import net.pterodactylus.sonitus.io.ProcessingOutputStream;
26 import com.google.common.eventbus.EventBus;
29 * {@link Filter} implementation that can process audio samples internally.
31 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
33 public abstract class AudioProcessingFilter extends DummyFilter {
36 * Creates a new audio processing filter with the given name.
41 * The name of the filter
43 protected AudioProcessingFilter(EventBus eventBus, String name) {
44 super(eventBus, name);
48 // DUMMYFILTER METHODS
52 protected OutputStream createOutputStream() throws IOException {
53 OutputStream originalOutputStream = super.createOutputStream();
54 ProcessingOutputStream processingOutputStream = new ProcessingOutputStream(originalOutputStream, metadata().channels()) {
57 protected int[] processSamples(int[] samples) {
58 return AudioProcessingFilter.this.processSamples(samples);
61 return processingOutputStream;
69 * Called to process the given of channels for a single sample.
72 * The channel values of the sample
73 * @return The processed channel values
75 protected abstract int[] processSamples(int[] samples);