Add button to force re-encode of J2K content.
[dcpomatic.git] / src / lib / film.h
index 3d1c02c93a7db30b95ecd3140a7919b46aabffa6..d251c7fcc3e6ddef4e70e729285b96323d8bd5e0 100644 (file)
@@ -1,19 +1,20 @@
 /*
-    Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2018 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/>.
 
 */
 
@@ -29,7 +30,8 @@
 #include "types.h"
 #include "isdcf_metadata.h"
 #include "frame_rate_change.h"
-#include "ratio.h"
+#include "signaller.h"
+#include "dcp_text_track.h"
 #include <dcp/key.h>
 #include <dcp/encrypted_kdm.h>
 #include <boost/signals2.hpp>
 #include <vector>
 #include <inttypes.h>
 
+namespace xmlpp {
+       class Document;
+}
+
 class DCPContentType;
 class Log;
 class Content;
-class Player;
 class Playlist;
 class AudioContent;
 class Screen;
+class AudioProcessor;
+class AudioMapping;
+class Ratio;
+class Job;
+class ScreenKDM;
 struct isdcf_name_test;
 
 /** @class Film
@@ -55,22 +65,18 @@ struct isdcf_name_test;
  *
  *  The content of a Film is held in a Playlist (created and managed by the Film).
  */
-class Film : public boost::enable_shared_from_this<Film>, public boost::noncopyable
+class Film : public boost::enable_shared_from_this<Film>, public Signaller, public boost::noncopyable
 {
 public:
-       Film (boost::filesystem::path, bool log = true);
+       explicit Film (boost::optional<boost::filesystem::path> dir);
        ~Film ();
 
-       boost::filesystem::path info_dir () const;
-       boost::filesystem::path j2c_path (int, Eyes, bool) const;
-       boost::filesystem::path info_path (int, Eyes) const;
-       boost::filesystem::path internal_video_mxf_dir () const;
-       boost::filesystem::path internal_video_mxf_filename () const;
-       boost::filesystem::path audio_analysis_dir () const;
+       boost::filesystem::path info_file (DCPTimePeriod p) const;
+       boost::filesystem::path j2c_path (int, Frame, Eyes, bool) const;
+       boost::filesystem::path internal_video_asset_dir () const;
+       boost::filesystem::path internal_video_asset_filename (DCPTimePeriod p) const;
 
-       boost::filesystem::path video_mxf_filename () const;
-       boost::filesystem::path audio_mxf_filename () const;
-       boost::filesystem::path subtitle_xml_filename () const;
+       boost::filesystem::path audio_analysis_path (boost::shared_ptr<const Playlist>) const;
 
        void send_dcp_to_tms ();
        void make_dcp ();
@@ -82,14 +88,17 @@ public:
                return _log;
        }
 
-       int encoded_frames () const;
-       
        boost::filesystem::path file (boost::filesystem::path f) const;
-       boost::filesystem::path dir (boost::filesystem::path d) const;
+       boost::filesystem::path dir (boost::filesystem::path d, bool create = true) 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_metadata (boost::filesystem::path path) const;
+       void write_template (boost::filesystem::path path) const;
+       boost::shared_ptr<xmlpp::Document> metadata (bool with_content_paths = true) const;
+
+       void copy_from (boost::shared_ptr<const Film> film);
 
        std::string isdcf_name (bool if_created_now) const;
        std::string dcp_name (bool if_created_now = false) const;
@@ -104,48 +113,69 @@ public:
 
        std::vector<CPLSummary> cpls () const;
 
-       boost::shared_ptr<Player> make_player () const;
-       boost::shared_ptr<Playlist> playlist () const;
-
        int audio_frame_rate () const;
 
+       std::list<DCPTextTrack> closed_caption_tracks () const;
+
        uint64_t required_disk_space () const;
-       bool should_be_enough_disk_space (double &, double &) const;
-       
+       bool should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const;
+
        /* Proxies for some Playlist methods */
 
        ContentList content () const;
        DCPTime length () const;
        int best_video_frame_rate () const;
        FrameRateChange active_frame_rate_change (DCPTime) const;
+       std::pair<double, double> speed_up_range (int dcp_frame_rate) const;
 
-       dcp::EncryptedKDM
-       make_kdm (
-               dcp::Certificate target,
+       dcp::EncryptedKDM make_kdm (
+               dcp::Certificate recipient,
+               std::vector<dcp::Certificate> trusted_devices,
                boost::filesystem::path cpl_file,
                dcp::LocalTime from,
                dcp::LocalTime until,
-               dcp::Formulation formulation
+               dcp::Formulation formulation,
+               bool disable_forensic_marking_picture,
+               boost::optional<int> disable_forensic_marking_audio
                ) const;
-       
-       std::list<dcp::EncryptedKDM> make_kdms (
-               std::list<boost::shared_ptr<Screen> >,
+
+       std::list<ScreenKDM> make_kdms (
+               std::list<boost::shared_ptr<Screen> > screens,
                boost::filesystem::path cpl_file,
-               dcp::LocalTime from,
-               dcp::LocalTime until,
-               dcp::Formulation formulation
+               boost::posix_time::ptime from,
+               boost::posix_time::ptime until,
+               dcp::Formulation formulation,
+               bool disable_forensic_marking_picture,
+               boost::optional<int> disable_forensic_marking_audio
                ) const;
 
-       dcp::Key key () const {
-               return _key;
-       }
-
        int state_version () const {
                return _state_version;
        }
 
        std::string subtitle_language () 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);
+
+       boost::shared_ptr<const Playlist> playlist () const {
+               return _playlist;
+       }
+
+       std::list<DCPTimePeriod> reels () const;
+       std::list<int> mapped_audio_channels () const;
+
+       std::string content_summary (DCPTimePeriod period) const;
+
+       bool references_dcp_video () const;
+       bool references_dcp_audio () const;
+
        /** Identifiers for the parts of our state;
            used for signalling changes.
        */
@@ -155,27 +185,33 @@ public:
                USE_ISDCF_NAME,
                /** The playlist's content list has changed (i.e. content has been added or removed) */
                CONTENT,
+               /** The order of content in the playlist has changed */
+               CONTENT_ORDER,
                DCP_CONTENT_TYPE,
                CONTAINER,
                RESOLUTION,
                SIGNED,
                ENCRYPTED,
+               KEY,
                J2K_BANDWIDTH,
                ISDCF_METADATA,
                VIDEO_FRAME_RATE,
                AUDIO_CHANNELS,
                /** The setting of _three_d has changed */
                THREE_D,
-               SEQUENCE_VIDEO,
+               SEQUENCE,
                INTEROP,
-               /** The setting of _burn_subtitles has changed */
-               BURN_SUBTITLES,
+               AUDIO_PROCESSOR,
+               REEL_TYPE,
+               REEL_LENGTH,
+               UPLOAD_AFTER_MAKE_DCP,
+               REENCODE_J2K
        };
 
 
        /* GET */
 
-       boost::filesystem::path directory () const {
+       boost::optional<boost::filesystem::path> directory () const {
                return _directory;
        }
 
@@ -203,11 +239,15 @@ public:
        bool is_signed () const {
                return _signed;
        }
-       
+
        bool encrypted () const {
                return _encrypted;
        }
 
+       dcp::Key key () const {
+               return _key;
+       }
+
        int j2k_bandwidth () const {
                return _j2k_bandwidth;
        }
@@ -229,28 +269,48 @@ public:
                return _three_d;
        }
 
-       bool sequence_video () const {
-               return _sequence_video;
+       bool sequence () const {
+               return _sequence;
        }
 
        bool interop () const {
                return _interop;
        }
 
-       bool burn_subtitles () const {
-               return _burn_subtitles;
+       AudioProcessor const * audio_processor () const {
+               return _audio_processor;
+       }
+
+       ReelType reel_type () const {
+               return _reel_type;
+       }
+
+       int64_t reel_length () const {
+               return _reel_length;
+       }
+
+       bool upload_after_make_dcp () const {
+               return _upload_after_make_dcp;
        }
-       
+
+       std::string context_id () const {
+               return _context_id;
+       }
+
+       bool reencode_j2k () const {
+               return _reencode_j2k;
+       }
+
 
        /* 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 examine_and_add_content (boost::shared_ptr<Content> content, bool disable_audio_analysis = false);
        void add_content (boost::shared_ptr<Content>);
        void remove_content (boost::shared_ptr<Content>);
+       void remove_content (ContentList);
        void move_content_earlier (boost::shared_ptr<Content>);
        void move_content_later (boost::shared_ptr<Content>);
        void set_dcp_content_type (DCPContentType const *);
@@ -258,21 +318,26 @@ public:
        void set_resolution (Resolution);
        void set_signed (bool);
        void set_encrypted (bool);
+       void set_key (dcp::Key key);
        void set_j2k_bandwidth (int);
        void set_isdcf_metadata (ISDCFMetadata);
        void set_video_frame_rate (int);
        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_burn_subtitles (bool);
+       void set_audio_processor (AudioProcessor const * processor);
+       void set_reel_type (ReelType);
+       void set_reel_length (int64_t);
+       void set_upload_after_make_dcp (bool);
+       void set_reencode_j2k (bool);
 
-       /** Emitted when some property has of the Film has changed */
-       mutable boost::signals2::signal<void (Property)> Changed;
+       /** Emitted when some property has of the Film is about to change or has changed */
+       mutable boost::signals2::signal<void (ChangeType, Property)> Change;
 
        /** Emitted when some property of our content has changed */
-       mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int)> ContentChanged;
+       mutable boost::signals2::signal<void (ChangeType, boost::weak_ptr<Content>, int, bool)> ContentChange;
 
        /** Current version number of the state file */
        static int const current_state_version;
@@ -280,13 +345,18 @@ public:
 private:
 
        friend struct ::isdcf_name_test;
+       template <typename> friend class ChangeSignaller;
 
-       void signal_changed (Property);
+       void signal_change (ChangeType, Property);
+       void signal_change (ChangeType, int);
        std::string video_identifier () const;
-       void playlist_changed ();
-       void playlist_content_changed (boost::weak_ptr<Content>, int);
-       std::string filename_safe_name () const;
-       void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>);
+       void playlist_change (ChangeType);
+       void playlist_order_changed ();
+       void playlist_content_change (ChangeType type, boost::weak_ptr<Content>, int, bool frequent);
+       void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>, bool disable_audio_analysis);
+       void audio_analysis_finished ();
+
+       static std::string const metadata_file;
 
        /** Log to write to */
        boost::shared_ptr<Log> _log;
@@ -295,8 +365,8 @@ 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;
        /** True if a auto-generated ISDCF-compliant name should be used for our DCP */
@@ -309,6 +379,11 @@ private:
        Resolution _resolution;
        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 */
@@ -317,25 +392,33 @@ private:
        int _video_frame_rate;
        /** The date that we should use in a ISDCF name */
        boost::gregorian::date _isdcf_date;
-       /** Number of audio channels to put in the DCP */
+       /** Number of audio channels requested for the DCP */
        int _audio_channels;
        /** If true, the DCP will be written in 3D mode; otherwise in 2D.
            This will be regardless of what content is on the playlist.
        */
        bool _three_d;
-       bool _sequence_video;
+       bool _sequence;
        bool _interop;
-       bool _burn_subtitles;
-       dcp::Key _key;
+       AudioProcessor const * _audio_processor;
+       ReelType _reel_type;
+       /** Desired reel length in bytes, if _reel_type == REELTYPE_BY_LENGTH */
+       int64_t _reel_length;
+       bool _upload_after_make_dcp;
+       bool _reencode_j2k;
 
        int _state_version;
 
        /** 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_content_changed_connection;
+       boost::signals2::scoped_connection _playlist_change_connection;
+       boost::signals2::scoped_connection _playlist_order_changed_connection;
+       boost::signals2::scoped_connection _playlist_content_change_connection;
        std::list<boost::signals2::connection> _job_connections;
+       std::list<boost::signals2::connection> _audio_analysis_connections;
 
        friend struct paths_test;
        friend struct film_metadata_test;