X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Faudio_content.h;h=336a98629bae47b103cdb0d3d88e15ced581cfaa;hb=4e411ea97b4dab8a5fa282d1d4cf7971ef1e24ad;hp=2a1216d86f81bd63596ef63c21b862a0a6747904;hpb=82926443230084739cb673a83b2ab1f9d733a07b;p=dcpomatic.git

diff --git a/src/lib/audio_content.h b/src/lib/audio_content.h
index 2a1216d86..336a98629 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
 
@@ -38,34 +42,40 @@ public:
 	static int const AUDIO_MAPPING;
 };
 
+/** @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>, Time);
+	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 AudioContent::Frame audio_length () const = 0;
-	virtual int content_audio_frame_rate () const = 0;
+	/** @return the length of the audio in the content */
+	virtual ContentTime audio_length () 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 output_audio_frame_rate () const;
-	
+	int resampled_audio_frame_rate () const;
+
 	boost::signals2::connection analyse_audio (boost::function<void()>);
 
-	void set_audio_gain (float);
+	void set_audio_gain (double);
 	void set_audio_delay (int);
 	
-	float audio_gain () const {
+	double audio_gain () const {
 		boost::mutex::scoped_lock lm (_mutex);
 		return _audio_gain;
 	}
@@ -77,7 +87,7 @@ public:
 
 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;
 };