Basic template support (#485).

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

diff --git a/src/lib/film.h b/src/lib/film.h
index a33c0238ec956666e85b039d0f91fd1765c54416..5fa35b0653d67b46d1bd9845eb86d33b61ad8b19 100644 (file)
--- a/src/lib/film.h
+++ b/src/lib/film.h
@@ -1,19 +1,20 @@
 /*
-    Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-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/>.
 
 */
 
@@ -67,7 +68,7 @@ struct isdcf_name_test;
 class Film : public boost::enable_shared_from_this<Film>, public Signaller, public boost::noncopyable
 {
 public:
-       Film (boost::filesystem::path, bool log = true);
+       Film (boost::optional<boost::filesystem::path> dir);
        ~Film ();
 
        boost::filesystem::path info_file (DCPTimePeriod p) const;
@@ -90,9 +91,11 @@ public:
        boost::filesystem::path file (boost::filesystem::path f) const;
        boost::filesystem::path dir (boost::filesystem::path d) const;
 
-       std::list<std::string> read_metadata ();
+       void use_template (std::string name);
+       std::list<std::string> read_metadata (boost::optional<boost::filesystem::path> path = boost::optional<boost::filesystem::path> ());
        void write_metadata () const;
-       boost::shared_ptr<xmlpp::Document> metadata () const;
+       void write_template (boost::filesystem::path path) const;
+       boost::shared_ptr<xmlpp::Document> metadata (bool with_content_paths = true) const;
 
        std::string isdcf_name (bool if_created_now) const;
        std::string dcp_name (bool if_created_now = false) const;
@@ -119,8 +122,7 @@ public:
        int best_video_frame_rate () const;
        FrameRateChange active_frame_rate_change (DCPTime) const;
 
-       dcp::EncryptedKDM
-       make_kdm (
+       dcp::EncryptedKDM make_kdm (
                dcp::Certificate recipient,
                std::vector<dcp::Certificate> trusted_devices,
                boost::filesystem::path cpl_file,
@@ -132,8 +134,8 @@ public:
        std::list<ScreenKDM> make_kdms (
                std::list<boost::shared_ptr<Screen> >,
                boost::filesystem::path cpl_file,
-               dcp::LocalTime from,
-               dcp::LocalTime until,
+               boost::posix_time::ptime from,
+               boost::posix_time::ptime until,
                dcp::Formulation formulation
                ) const;
 
@@ -143,7 +145,11 @@ public:
 
        std::string subtitle_language () const;
 
-       void make_audio_mapping_default (AudioMapping & mapping) const;
+       void make_audio_mapping_default (
+               AudioMapping & mapping,
+               boost::optional<boost::filesystem::path> filename = boost::optional<boost::filesystem::path> ()
+               ) const;
+
        std::vector<std::string> audio_output_names () const;
 
        void repeat_content (ContentList, int);
@@ -153,6 +159,14 @@ public:
        }
 
        std::list<DCPTimePeriod> reels () const;
+       std::list<int> mapped_audio_channels () const;
+
+       /** @param A period within the DCP
+        *  @return Name of the content which most contributes to the given period.
+        */
+       std::string content_summary (DCPTimePeriod period) const;
+
+       std::list<std::string> fix_conflicting_settings ();
 
        /** Identifiers for the parts of our state;
            used for signalling changes.
@@ -177,7 +191,7 @@ public:
                AUDIO_CHANNELS,
                /** The setting of _three_d has changed */
                THREE_D,
-               SEQUENCE_VIDEO,
+               SEQUENCE,
                INTEROP,
                AUDIO_PROCESSOR,
                REEL_TYPE,
@@ -188,7 +202,7 @@ public:
 
        /* GET */
 
-       boost::filesystem::path directory () const {
+       boost::optional<boost::filesystem::path> directory () const {
                return _directory;
        }
 
@@ -246,8 +260,8 @@ public:
                return _three_d;
        }
 
-       bool sequence_video () const {
-               return _sequence_video;
+       bool sequence () const {
+               return _sequence;
        }
 
        bool interop () const {
@@ -294,7 +308,7 @@ public:
        void set_audio_channels (int);
        void set_three_d (bool);
        void set_isdcf_date_today ();
-       void set_sequence_video (bool);
+       void set_sequence (bool);
        void set_interop (bool);
        void set_audio_processor (AudioProcessor const * processor);
        void set_reel_type (ReelType);
@@ -329,7 +343,7 @@ private:
        /** Complete path to directory containing the film metadata;
         *  must not be relative.
         */
-       boost::filesystem::path _directory;
+       boost::optional<boost::filesystem::path> _directory;
 
        /** Name for DCP-o-matic */
        std::string _name;
@@ -358,7 +372,7 @@ private:
            This will be regardless of what content is on the playlist.
        */
        bool _three_d;
-       bool _sequence_video;
+       bool _sequence;
        bool _interop;
        AudioProcessor const * _audio_processor;
        ReelType _reel_type;
@@ -370,6 +384,8 @@ private:
 
        /** true if our state has changed since we last saved it */
        mutable bool _dirty;
+       /** film being used as a template, or 0 */
+       boost::shared_ptr<Film> _template_film;
 
        boost::signals2::scoped_connection _playlist_changed_connection;
        boost::signals2::scoped_connection _playlist_order_changed_connection;