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