Merge master.

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

diff --git a/src/lib/audio_content.h b/src/lib/audio_content.h
index 2362786d951cc8c25eebcf23b958a5db3ccca88d..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,11 +17,15 @@
 
 */
 
+/** @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 "util.h"
+#include "audio_mapping.h"
 
 namespace cxml {
        class Node;
@@ -33,18 +37,59 @@ 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;
 };
 
+/** @class AudioContent
+ *  @brief Parent class for content which may contain audio data.
+ */
 class AudioContent : public virtual Content
 {
 public:
-       AudioContent (boost::filesystem::path);
-       AudioContent (boost::shared_ptr<const cxml::Node>);
-       AudioContent (AudioContent const &);
+       typedef int64_t Frame;
+       
+       AudioContent (boost::shared_ptr<const Film>, DCPTime);
+       AudioContent (boost::shared_ptr<const Film>, boost::filesystem::path);
+       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;
+       /** @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);
+       virtual boost::filesystem::path audio_analysis_path () const;
+
+       int resampled_audio_frame_rate () const;
+
+       boost::signals2::connection analyse_audio (boost::function<void()>);
+
+       void set_audio_gain (double);
+       void set_audio_delay (int);
+       
+       double audio_gain () const {
+               boost::mutex::scoped_lock lm (_mutex);
+               return _audio_gain;
+       }
+
+       int audio_delay () const {
+               boost::mutex::scoped_lock lm (_mutex);
+               return _audio_delay;
+       }
 
-        virtual int audio_channels () const = 0;
-        virtual ContentAudioFrame audio_length () const = 0;
-        virtual int audio_frame_rate () const = 0;
+private:
+       /** Gain to apply to audio in dB */
+       double _audio_gain;
+       /** Delay to apply to audio (positive moves audio later) in milliseconds */
+       int _audio_delay;
 };
 
 #endif