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

diff --git a/src/lib/audio_processor.h b/src/lib/audio_processor.h
index 9b332e7fe..9e34689cb 100644
--- a/src/lib/audio_processor.h
+++ b/src/lib/audio_processor.h
@@ -1,5 +1,5 @@
 /*
-    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
     it under the terms of the GNU General Public License as published by
@@ -17,28 +17,47 @@
 
 */
 
+/** @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 ();