src/lib/audio_processor.h

   1 /*
   2     Copyright (C) 2014-2015 Carl Hetherington <cth@carlh.net>
   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 2 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, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 /** @file  src/lib/audio_processor.h
  21  *  @brief AudioProcessor class.
  22  */
  23
  24 #ifndef DCPOMATIC_AUDIO_PROCESSOR_H
  25 #define DCPOMATIC_AUDIO_PROCESSOR_H
  26
  27 #include "channel_count.h"
  28 #include <boost/shared_ptr.hpp>
  29 #include <list>
  30 #include <string>
  31 #include <vector>
  32
  33 class AudioBuffers;
  34 class AudioMapping;
  35
  36 /** @class AudioProcessor
  37  *  @brief A parent class for processors of audio data.
  38  *
  39  *  These are used to process data before it goes into the DCP, for things like
  40  *  stereo -> 5.1 upmixing.
  41  */
  42 class AudioProcessor
  43 {
  44 public:
  45         virtual ~AudioProcessor () {}
  46
  47         /** @return User-visible (translated) name */
  48         virtual std::string name () const = 0;
  49         /** @return An internal identifier */
  50         virtual std::string id () const = 0;
  51         /** @return Number of input channels */
  52         virtual ChannelCount in_channels () const = 0;
  53         /** @return Number of output channels */
  54         virtual int out_channels () const = 0;
  55         /** @return A clone of this AudioProcessor for operation at the specified sampling rate */
  56         virtual boost::shared_ptr<AudioProcessor> clone (int sampling_rate) const = 0;
  57         /** Process some data, returning the processed result */
  58         virtual boost::shared_ptr<AudioBuffers> run (boost::shared_ptr<const AudioBuffers>) = 0;
  59         virtual void flush () {}
  60         /** Make the supplied audio mapping into a sensible default for this processor */
  61         virtual void make_audio_mapping_default (AudioMapping& mapping) const = 0;
  62         /** @return the user-visible (translated) names of each of our inputs, in order */
  63         virtual std::vector<std::string> input_names () const = 0;
  64
  65         static std::list<AudioProcessor const *> all ();
  66         static void setup_audio_processors ();
  67         static AudioProcessor const * from_id (std::string);
  68
  69 private:
  70         static std::list<AudioProcessor const *> _all;
  71 };
  72
  73 #endif