Allow changes to colours of FFmpeg subtitles (#795).

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

diff --git a/src/lib/audio_content.h b/src/lib/audio_content.h
index 36c36992ea79fe9439e50366f3f26ddded6d248f..33c52aa73688d54b042c97adce84b96da4f074f9 100644 (file)
--- a/src/lib/audio_content.h
+++ b/src/lib/audio_content.h
@@ -1,7 +1,5 @@
-/* -*- c-basic-offset: 8; default-tab-width: 8; -*- */
-
 /*
-    Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2016 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
@@ -19,36 +17,75 @@
 
 */
 
+/** @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;
 };
 
+/** @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 &);
+       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>, 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 std::vector<AudioStreamPtr> audio_streams () const = 0;
+
+       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;
+       }
+
+       int audio_delay () const {
+               boost::mutex::scoped_lock lm (_mutex);
+               return _audio_delay;
+       }
+
+       std::string processing_description () const;
+
+protected:
+
+       void add_properties (std::list<UserProperty> &) const;
 
-        virtual int audio_channels () const = 0;
-        virtual ContentAudioFrame audio_length () const = 0;
-        virtual int content_audio_frame_rate () const = 0;
-       virtual int output_audio_frame_rate (boost::shared_ptr<const Film>) 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