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