Use the same ContextID whenever encrypting the picture asset for a project;
[dcpomatic.git] / src / lib / film.h
index 4ad905758b2dca65dc5333f0103990304913b0c5..2b700b00752834cc48e803d61404932a8f7e9783 100644 (file)
@@ -1,19 +1,20 @@
 /*
     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,
@@ -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,9 +159,15 @@ 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.
        */
@@ -190,7 +202,7 @@ public:
 
        /* GET */
 
-       boost::filesystem::path directory () const {
+       boost::optional<boost::filesystem::path> directory () const {
                return _directory;
        }
 
@@ -272,12 +284,16 @@ public:
                return _upload_after_make_dcp;
        }
 
+       std::string context_id () const {
+               return _context_id;
+       }
+
+
        /* SET */
 
        void set_directory (boost::filesystem::path);
        void set_name (std::string);
        void set_use_isdcf_name (bool);
-       void examine_content (boost::shared_ptr<Content>);
        void examine_and_add_content (boost::shared_ptr<Content>);
        void add_content (boost::shared_ptr<Content>);
        void remove_content (boost::shared_ptr<Content>);
@@ -331,7 +347,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;
@@ -346,6 +362,10 @@ private:
        bool _signed;
        bool _encrypted;
        dcp::Key _key;
+       /** context ID used when encrypting picture assets; we keep it so that we can
+        *  re-start picture MXF encodes.
+        */
+       std::string _context_id;
        /** bandwidth for J2K files in bits per second */
        int _j2k_bandwidth;
        /** ISDCF naming stuff */
@@ -372,6 +392,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;