X-Git-Url: https://main.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Faudio_processor.h;h=e10df254cbd18fc7c2a09d73796502f5ebb2fb16;hp=9b332e7fec50c955d7bc62a6bb27a49d0a440b34;hb=f0c10e92b849566e458bc323f8783a6fe83e52d2;hpb=e80e6a8567dd107f5ea3b708975cb5fd92112a57

diff --git a/src/lib/audio_processor.h b/src/lib/audio_processor.h
index 9b332e7fe..e10df254c 100644
--- a/src/lib/audio_processor.h
+++ b/src/lib/audio_processor.h
@@ -1,44 +1,64 @@
 /*
-    Copyright (C) 2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2014-2015 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
+/** @file  src/lib/audio_processor.h
+ *  @brief AudioProcessor class.
+ */
+
 #ifndef DCPOMATIC_AUDIO_PROCESSOR_H
 #define DCPOMATIC_AUDIO_PROCESSOR_H
 
+#include <boost/shared_ptr.hpp>
 #include <list>
 #include <string>
-#include <boost/shared_ptr.hpp>
-#include "channel_count.h"
+#include <vector>
 
 class AudioBuffers;
+class AudioMapping;
 
+/** @class AudioProcessor
+ *  @brief A parent class for processors of audio data.
+ *
+ *  These are used to process data before it goes into the DCP, for things like
+ *  stereo -> 5.1 upmixing.
+ */
 class AudioProcessor
 {
 public:
 	virtual ~AudioProcessor () {}
 
+	/** @return User-visible (translated) name */
 	virtual std::string name () const = 0;
+	/** @return An internal identifier */
 	virtual std::string id () const = 0;
-	virtual ChannelCount in_channels () const = 0;
-	virtual int out_channels (int) const = 0;
+	/** @return Number of output channels */
+	virtual int out_channels () const = 0;
+	/** @return A clone of this AudioProcessor for operation at the specified sampling rate */
 	virtual boost::shared_ptr<AudioProcessor> clone (int sampling_rate) const = 0;
-	virtual boost::shared_ptr<AudioBuffers> run (boost::shared_ptr<const AudioBuffers>) = 0;
+	/** Process some data, returning the processed result truncated or padded to `channels' */
+	virtual boost::shared_ptr<AudioBuffers> run (boost::shared_ptr<const AudioBuffers>, int channels) = 0;
 	virtual void flush () {}
+	/** Make the supplied audio mapping into a sensible default for this processor */
+	virtual void make_audio_mapping_default (AudioMapping& mapping) const = 0;
+	/** @return the user-visible (translated) names of each of our inputs, in order */
+	virtual std::vector<std::string> input_names () const = 0;
 
 	static std::list<AudioProcessor const *> all ();
 	static void setup_audio_processors ();