X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Faudio_content.h;h=85728922ac98661c90af0496c56915259008c421;hb=661de111c0dbc968ecb004eca5b26f8400b136f1;hp=cecc8f13d65c1a0875a0dca0f0b2e383a37eb20c;hpb=854f2e5bbb7ffb9758b823af87034033033f3cb8;p=dcpomatic.git

diff --git a/src/lib/audio_content.h b/src/lib/audio_content.h
index cecc8f13d..85728922a 100644
--- a/src/lib/audio_content.h
+++ b/src/lib/audio_content.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2014 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,6 +17,10 @@
 
 */
 
+/** @file  src/lib/audio_content.h
+ *  @brief AudioContent and AudioContentProperty classes.
+ */
+
 #ifndef DCPOMATIC_AUDIO_CONTENT_H
 #define DCPOMATIC_AUDIO_CONTENT_H
 
@@ -27,44 +31,55 @@ namespace cxml {
 	class Node;
 }
 
+class AudioProcessor;
+
+/** @class AudioContentProperty
+ *  @brief Names for properties of AudioContent.
+ */
 class AudioContentProperty
 {
 public:
 	static int const AUDIO_CHANNELS;
-	static int const AUDIO_LENGTH;
 	static int const AUDIO_FRAME_RATE;
 	static int const AUDIO_GAIN;
 	static int const AUDIO_DELAY;
 	static int const AUDIO_MAPPING;
+	static int const AUDIO_PROCESSOR;
 };
 
+/** @class AudioContent
+ *  @brief Parent class for content which may contain audio data.
+ */
 class AudioContent : public virtual Content
 {
 public:
-	typedef int64_t Frame;
-	
+	AudioContent (boost::shared_ptr<const Film>);
 	AudioContent (boost::shared_ptr<const Film>, DCPTime);
 	AudioContent (boost::shared_ptr<const Film>, boost::filesystem::path);
-	AudioContent (boost::shared_ptr<const Film>, boost::shared_ptr<const cxml::Node>);
+	AudioContent (boost::shared_ptr<const Film>, cxml::ConstNodePtr);
 	AudioContent (boost::shared_ptr<const Film>, std::vector<boost::shared_ptr<Content> >);
 
 	void as_xml (xmlpp::Node *) const;
 	std::string technical_summary () const;
 
+	/** @return number of audio channels in the content */
 	virtual int audio_channels () const = 0;
-	virtual ContentTime audio_length () const = 0;
-	virtual int content_audio_frame_rate () const = 0;
-	virtual int output_audio_frame_rate () const = 0;
+	/** @return the frame rate of the content */
+	virtual int audio_frame_rate () const = 0;
 	virtual AudioMapping audio_mapping () const = 0;
-	virtual void set_audio_mapping (AudioMapping) = 0;
+	virtual void set_audio_mapping (AudioMapping);
 	virtual boost::filesystem::path audio_analysis_path () const;
 
+	int resampled_audio_frame_rate () const;
+	int processed_audio_channels () const;
+
 	boost::signals2::connection analyse_audio (boost::function<void()>);
 
-	void set_audio_gain (float);
+	void set_audio_gain (double);
 	void set_audio_delay (int);
+	void set_audio_processor (AudioProcessor const *);
 	
-	float audio_gain () const {
+	double audio_gain () const {
 		boost::mutex::scoped_lock lm (_mutex);
 		return _audio_gain;
 	}
@@ -74,11 +89,19 @@ public:
 		return _audio_delay;
 	}
 
+	AudioProcessor const * audio_processor () const {
+		boost::mutex::scoped_lock lm (_mutex);
+		return _audio_processor;
+	}
+
+	std::string processing_description () const;
+	
 private:
 	/** Gain to apply to audio in dB */
-	float _audio_gain;
+	double _audio_gain;
 	/** Delay to apply to audio (positive moves audio later) in milliseconds */
 	int _audio_delay;
+	AudioProcessor const * _audio_processor;
 };
 
 #endif