Merge master.

[dcpomatic.git] / src / lib / audio_content.h

diff --git a/src/lib/audio_content.h b/src/lib/audio_content.h
index 2c324a3a4966e0dad899c10f24f3f99115317420..336a98629bae47b103cdb0d3d88e15ced581cfaa 100644 (file)
--- 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,28 +42,34 @@ 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 (double);