Merge master.
[dcpomatic.git] / src / lib / film.h
index a30a630b99096ee82a68572c1378c0a7677d79d1..067588fa3f42a52d7988aa930840f6d0a7b31863 100644 (file)
 #include <boost/signals2.hpp>
 #include <boost/enable_shared_from_this.hpp>
 #include <boost/filesystem.hpp>
-#include <libdcp/key.h>
-#include <libdcp/kdm.h>
+#include <dcp/key.h>
+#include <dcp/decrypted_kdm.h>
+#include <dcp/encrypted_kdm.h>
 #include "util.h"
 #include "types.h"
-#include "dci_metadata.h"
+#include "isdcf_metadata.h"
+#include "frame_rate_change.h"
 
 class DCPContentType;
 class Log;
@@ -45,6 +47,7 @@ class Playlist;
 class AudioContent;
 class Scaler;
 class Screen;
+class isdcf_name_test;
 
 /** @class Film
  *
@@ -56,17 +59,17 @@ class Screen;
 class Film : public boost::enable_shared_from_this<Film>, public boost::noncopyable
 {
 public:
-       Film (boost::filesystem::path);
+       Film (boost::filesystem::path, bool log = true);
 
-       std::string info_dir () const;
-       std::string j2c_path (int, Eyes, bool) const;
-       std::string info_path (int, Eyes) const;
-       std::string internal_video_mxf_dir () const;
-       std::string internal_video_mxf_filename () const;
-       boost::filesystem::path audio_analysis_path (boost::shared_ptr<const AudioContent>) const;
+       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;
 
-       std::string video_mxf_filename () const;
-       std::string audio_mxf_filename () const;
+       boost::filesystem::path video_mxf_filename () const;
+       boost::filesystem::path audio_mxf_filename () const;
 
        void send_dcp_to_tms ();
        void make_dcp ();
@@ -80,13 +83,14 @@ public:
 
        int encoded_frames () const;
        
-       std::string file (std::string f) const;
-       std::string dir (std::string d) const;
+       boost::filesystem::path file (boost::filesystem::path f) const;
+       boost::filesystem::path dir (boost::filesystem::path d) const;
 
-       void read_metadata ();
+       std::list<std::string> read_metadata ();
        void write_metadata () const;
+       boost::shared_ptr<xmlpp::Document> metadata () const;
 
-       std::string dci_name (bool if_created_now) const;
+       std::string isdcf_name (bool if_created_now) const;
        std::string dcp_name (bool if_created_now = false) const;
 
        /** @return true if our state has changed since we last saved it */
@@ -94,45 +98,57 @@ public:
                return _dirty;
        }
 
-       libdcp::Size full_frame () const;
+       dcp::Size full_frame () const;
+       dcp::Size frame_size () const;
 
-       bool have_dcp () const;
+       std::vector<CPLSummary> cpls () const;
 
        boost::shared_ptr<Player> make_player () const;
        boost::shared_ptr<Playlist> playlist () const;
 
-       OutputAudioFrame audio_frame_rate () const;
-
-       OutputAudioFrame time_to_audio_frames (Time) const;
-       OutputVideoFrame time_to_video_frames (Time) const;
-       Time video_frames_to_time (OutputVideoFrame) const;
-       Time audio_frames_to_time (OutputAudioFrame) const;
+       int audio_frame_rate () const;
 
+       uint64_t required_disk_space () const;
+       bool should_be_enough_disk_space (double &, double &) const;
+       
        /* Proxies for some Playlist methods */
 
        ContentList content () const;
-
-       Time length () const;
+       DCPTime length () const;
        bool has_subtitles () const;
-       OutputVideoFrame best_video_frame_rate () const;
-
-       std::list<libdcp::KDM> make_kdms (
+       int best_video_frame_rate () const;
+       FrameRateChange active_frame_rate_change (DCPTime) const;
+
+       dcp::EncryptedKDM
+       make_kdm (
+               boost::shared_ptr<dcp::Certificate> target,
+               boost::filesystem::path cpl_file,
+               dcp::LocalTime from,
+               dcp::LocalTime until
+               ) const;
+       
+       std::list<dcp::EncryptedKDM> make_kdms (
                std::list<boost::shared_ptr<Screen> >,
-               boost::posix_time::ptime from,
-               boost::posix_time::ptime until
+               boost::filesystem::path cpl_file,
+               dcp::LocalTime from,
+               dcp::LocalTime until
                ) const;
 
-       libdcp::Key key () const {
+       dcp::Key key () const {
                return _key;
        }
 
+       int state_version () const {
+               return _state_version;
+       }
+
        /** Identifiers for the parts of our state;
            used for signalling changes.
        */
        enum Property {
                NONE,
                NAME,
-               USE_DCI_NAME,
+               USE_ISDCF_NAME,
                /** The playlist's content list has changed (i.e. content has been added, moved around or removed) */
                CONTENT,
                DCP_CONTENT_TYPE,
@@ -140,9 +156,10 @@ public:
                RESOLUTION,
                SCALER,
                WITH_SUBTITLES,
+               SIGNED,
                ENCRYPTED,
                J2K_BANDWIDTH,
-               DCI_METADATA,
+               ISDCF_METADATA,
                VIDEO_FRAME_RATE,
                AUDIO_CHANNELS,
                /** The setting of _three_d has been changed */
@@ -154,7 +171,7 @@ public:
 
        /* GET */
 
-       std::string directory () const {
+       boost::filesystem::path directory () const {
                return _directory;
        }
 
@@ -162,8 +179,8 @@ public:
                return _name;
        }
 
-       bool use_dci_name () const {
-               return _use_dci_name;
+       bool use_isdcf_name () const {
+               return _use_isdcf_name;
        }
 
        DCPContentType const * dcp_content_type () const {
@@ -186,6 +203,11 @@ public:
                return _with_subtitles;
        }
 
+       /* signed is a reserved word */
+       bool is_signed () const {
+               return _signed;
+       }
+       
        bool encrypted () const {
                return _encrypted;
        }
@@ -194,8 +216,8 @@ public:
                return _j2k_bandwidth;
        }
 
-       DCIMetadata dci_metadata () const {
-               return _dci_metadata;
+       ISDCFMetadata isdcf_metadata () const {
+               return _isdcf_metadata;
        }
 
        /** @return The frame rate of the DCP */
@@ -222,24 +244,27 @@ public:
 
        /* SET */
 
-       void set_directory (std::string);
+       void set_directory (boost::filesystem::path);
        void set_name (std::string);
-       void set_use_dci_name (bool);
+       void set_use_isdcf_name (bool);
        void examine_and_add_content (boost::shared_ptr<Content>);
        void add_content (boost::shared_ptr<Content>);
        void remove_content (boost::shared_ptr<Content>);
+       void move_content_earlier (boost::shared_ptr<Content>);
+       void move_content_later (boost::shared_ptr<Content>);
        void set_dcp_content_type (DCPContentType const *);
        void set_container (Ratio const *);
        void set_resolution (Resolution);
        void set_scaler (Scaler const *);
        void set_with_subtitles (bool);
+       void set_signed (bool);
        void set_encrypted (bool);
        void set_j2k_bandwidth (int);
-       void set_dci_metadata (DCIMetadata);
+       void set_isdcf_metadata (ISDCFMetadata);
        void set_video_frame_rate (int);
        void set_audio_channels (int);
        void set_three_d (bool);
-       void set_dci_date_today ();
+       void set_isdcf_date_today ();
        void set_sequence_video (bool);
        void set_interop (bool);
 
@@ -250,10 +275,12 @@ public:
        mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int)> ContentChanged;
 
        /** Current version number of the state file */
-       static int const state_version;
+       static int const current_state_version;
 
 private:
 
+       friend class ::isdcf_name_test;
+
        void signal_changed (Property);
        std::string video_identifier () const;
        void playlist_changed ();
@@ -268,12 +295,12 @@ private:
        /** Complete path to directory containing the film metadata;
         *  must not be relative.
         */
-       std::string _directory;
+       boost::filesystem::path _directory;
        
        /** Name for DCP-o-matic */
        std::string _name;
-       /** True if a auto-generated DCI-compliant name should be used for our DCP */
-       bool _use_dci_name;
+       /** True if a auto-generated ISDCF-compliant name should be used for our DCP */
+       bool _use_isdcf_name;
        /** The type of content that this Film represents (feature, trailer etc.) */
        DCPContentType const * _dcp_content_type;
        /** The container to put this Film in (flat, scope, etc.) */
@@ -284,15 +311,16 @@ private:
        Scaler const * _scaler;
        /** True if subtitles should be shown for this film */
        bool _with_subtitles;
+       bool _signed;
        bool _encrypted;
        /** bandwidth for J2K files in bits per second */
        int _j2k_bandwidth;
-       /** DCI naming stuff */
-       DCIMetadata _dci_metadata;
+       /** ISDCF naming stuff */
+       ISDCFMetadata _isdcf_metadata;
        /** Frames per second to run our DCP at */
        int _video_frame_rate;
-       /** The date that we should use in a DCI name */
-       boost::gregorian::date _dci_date;
+       /** The date that we should use in a ISDCF name */
+       boost::gregorian::date _isdcf_date;
        /** Number of audio channels to put in the DCP */
        int _audio_channels;
        /** If true, the DCP will be written in 3D mode; otherwise in 2D.
@@ -301,7 +329,9 @@ private:
        bool _three_d;
        bool _sequence_video;
        bool _interop;
-       libdcp::Key _key;
+       dcp::Key _key;
+
+       int _state_version;
 
        /** true if our state has changed since we last saved it */
        mutable bool _dirty;