src/main/java/net/pterodactylus/sonitus/data/filter/AudioProcessingFilter.java

   1 /*
   2  * Sonitus - AudioProcessingFilter.java - Copyright © 2013 David Roden
   3  *
   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.
   8  *
   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.
  13  *
  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/>.
  16  */
  17
  18 package net.pterodactylus.sonitus.data.filter;
  19
  20 import java.io.IOException;
  21 import java.io.OutputStream;
  22
  23 import net.pterodactylus.sonitus.data.Filter;
  24 import net.pterodactylus.sonitus.io.ProcessingOutputStream;
  25
  26 /**
  27  * {@link Filter} implementation that can process audio samples internally.
  28  *
  29  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  30  */
  31 public abstract class AudioProcessingFilter extends DummyFilter {
  32
  33         /**
  34          * Creates a new audio processing filter with the given name.
  35          *
  36          * @param name
  37          *              The name of the filter
  38          */
  39         protected AudioProcessingFilter(String name) {
  40                 super(name);
  41         }
  42
  43         //
  44         // DUMMYFILTER METHODS
  45         //
  46
  47         @Override
  48         protected OutputStream createOutputStream() throws IOException {
  49                 OutputStream originalOutputStream = super.createOutputStream();
  50                 ProcessingOutputStream processingOutputStream = new ProcessingOutputStream(originalOutputStream, metadata().channels()) {
  51
  52                         @Override
  53                         protected int[] processSamples(int[] samples) {
  54                                 return AudioProcessingFilter.this.processSamples(samples);
  55                         }
  56                 };
  57                 return processingOutputStream;
  58         }
  59
  60         //
  61         // SUBCLASS METHODS
  62         //
  63
  64         /**
  65          * Called to process the given of channels for a single sample.
  66          *
  67          * @param samples
  68          *              The channel values of the sample
  69          * @return The processed channel values
  70          */
  71         protected abstract int[] processSamples(int[] samples);
  72
  73 }