Include tidying src/lib/a-j*.h

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

diff --git a/src/lib/audio_content.h b/src/lib/audio_content.h
index 2c324a3a4966e0dad899c10f24f3f99115317420..82c95a513a3ca475d7d3312551fed1255000aeba 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-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,54 +17,54 @@
 
 */
 
+/** @file  src/lib/audio_content.h
+ *  @brief AudioContent and AudioContentProperty classes.
+ */
+
 #ifndef DCPOMATIC_AUDIO_CONTENT_H
 #define DCPOMATIC_AUDIO_CONTENT_H
 
 #include "content.h"
+#include "audio_stream.h"
 #include "audio_mapping.h"
 
-namespace cxml {
-       class Node;
-}
-
+/** @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_STREAMS;
        static int const AUDIO_GAIN;
        static int const AUDIO_DELAY;
-       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>);
+       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;
 
-       virtual int audio_channels () const = 0;
-       virtual AudioContent::Frame audio_length () const = 0;
-       virtual int content_audio_frame_rate () const = 0;
-       virtual AudioMapping audio_mapping () const = 0;
-       virtual void set_audio_mapping (AudioMapping) = 0;
-       virtual boost::filesystem::path audio_analysis_path () const;
+       virtual std::vector<AudioStreamPtr> audio_streams () const = 0;
 
-       int output_audio_frame_rate () const;
-       
-       boost::signals2::connection analyse_audio (boost::function<void()>);
+       AudioMapping audio_mapping () const;
+       void set_audio_mapping (AudioMapping);
+       int resampled_audio_frame_rate () const;
+       bool has_rate_above_48k () const;
+       std::vector<std::string> audio_channel_names () const;
 
        void set_audio_gain (double);
        void set_audio_delay (int);
-       
+
        double audio_gain () const {
                boost::mutex::scoped_lock lm (_mutex);
                return _audio_gain;
@@ -75,6 +75,8 @@ public:
                return _audio_delay;
        }
 
+       std::string processing_description () const;
+
 private:
        /** Gain to apply to audio in dB */
        double _audio_gain;