Rename Subtitle -> Text

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

diff --git a/src/lib/content.h b/src/lib/content.h
index 0ce9d39c146a781d3b5f54d7755e67c33e3c9d9c..63d03fd713121cdf3fadebe17390158e32fa9284 100644 (file)
--- a/src/lib/content.h
+++ b/src/lib/content.h
@@ -1,19 +1,20 @@
 /*
-    Copyright (C) 2013-2015 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
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
@@ -27,7 +28,6 @@
 #include "types.h"
 #include "signaller.h"
 #include "dcpomatic_time.h"
-#include "raw_convert.h"
 #include "user_property.h"
 #include <libcxml/cxml.h>
 #include <boost/filesystem.hpp>
@@ -54,6 +54,7 @@ public:
        static int const LENGTH;
        static int const TRIM_START;
        static int const TRIM_END;
+       static int const VIDEO_FRAME_RATE;
 };
 
 /** @class Content
@@ -62,7 +63,7 @@ public:
 class Content : public boost::enable_shared_from_this<Content>, public Signaller, public boost::noncopyable
 {
 public:
-       Content (boost::shared_ptr<const Film>);
+       explicit Content (boost::shared_ptr<const Film>);
        Content (boost::shared_ptr<const Film>, DCPTime);
        Content (boost::shared_ptr<const Film>, boost::filesystem::path);
        Content (boost::shared_ptr<const Film>, cxml::ConstNodePtr);
@@ -75,6 +76,8 @@ public:
         */
        virtual void examine (boost::shared_ptr<Job> job);
 
+       virtual void take_settings_from (boost::shared_ptr<const Content> c);
+
        /** @return Quick one-line summary of the content, as will be presented in the
         *  film editor.
         */
@@ -85,7 +88,7 @@ public:
         */
        virtual std::string technical_summary () const;
 
-       virtual void as_xml (xmlpp::Node *) const;
+       virtual void as_xml (xmlpp::Node *, bool with_paths) const;
        virtual DCPTime full_length () const = 0;
        virtual std::string identifier () const;
        /** @return points at which to split this content when
@@ -96,6 +99,7 @@ public:
        boost::shared_ptr<Content> clone () const;
 
        void set_path (boost::filesystem::path);
+       void set_paths (std::vector<boost::filesystem::path> paths);
 
        std::string path_summary () const;
 
@@ -118,7 +122,7 @@ public:
 
        /** @return Digest of the content's file(s).  Note: this is
         *  not a complete MD5-or-whatever hash, but a sort of poor
-        *  man's version (see comments in ::examine).
+        *  man's version (see comments in examine()).
         */
        std::string digest () const {
                boost::mutex::scoped_lock lm (_mutex);
@@ -156,6 +160,16 @@ public:
 
        DCPTime length_after_trim () const;
 
+       boost::optional<double> video_frame_rate () const {
+               boost::mutex::scoped_lock lm (_mutex);
+               return _video_frame_rate;
+       }
+
+       void set_video_frame_rate (double r);
+       void unset_video_frame_rate ();
+
+       double active_video_frame_rate () const;
+
        void set_change_signals_frequent (bool f) {
                _change_signals_frequent = f;
        }
@@ -167,12 +181,14 @@ public:
        boost::signals2::signal<void (boost::weak_ptr<Content>, int, bool)> Changed;
 
        boost::shared_ptr<VideoContent> video;
+       boost::shared_ptr<AudioContent> audio;
+       boost::shared_ptr<TextContent> subtitle;
 
        void signal_changed (int);
 
 protected:
 
-       virtual void add_properties (std::list<UserProperty> &) const {}
+       virtual void add_properties (std::list<UserProperty> &) const;
 
        boost::weak_ptr<const Film> _film;
 
@@ -185,10 +201,20 @@ protected:
        std::vector<boost::filesystem::path> _paths;
 
 private:
+       friend struct ffmpeg_pts_offset_test;
+       friend struct best_dcp_frame_rate_test_single;
+       friend struct best_dcp_frame_rate_test_double;
+       friend struct audio_sampling_rate_test;
+
        std::string _digest;
        DCPTime _position;
        ContentTime _trim_start;
        ContentTime _trim_end;
+       /** The video frame rate that this content is or was prepared to be used with,
+        *  or empty if the effective rate of this content should be dictated by something
+        *  else (either some video happening at the same time, or the rate of the DCP).
+        */
+       boost::optional<double> _video_frame_rate;
        bool _change_signals_frequent;
 };