Support ISDCF naming convention version 9.

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

diff --git a/src/lib/film.h b/src/lib/film.h
index 7e65ecb16346107efe63da496176f5cf2f014adf..96ea930ccd10a493e7c24099ebc487a77cdb8991 100644 (file)
--- a/src/lib/film.h
+++ b/src/lib/film.h
@@ -35,7 +35,8 @@
 #include <libdcp/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 +46,7 @@ class Playlist;
 class AudioContent;
 class Scaler;
 class Screen;
+class isdcf_name_test;
 
 /** @class Film
  *
@@ -63,7 +65,7 @@ public:
        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_path (boost::shared_ptr<const AudioContent>) const;
+       boost::filesystem::path audio_analysis_dir () const;
 
        boost::filesystem::path video_mxf_filename () const;
        boost::filesystem::path audio_mxf_filename () const;
@@ -83,11 +85,11 @@ public:
        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 */
@@ -96,8 +98,9 @@ public:
        }
 
        libdcp::Size full_frame () const;
+       libdcp::Size frame_size () const;
 
-       std::list<boost::filesystem::path> dcps () const;
+       std::vector<CPLSummary> cpls () const;
 
        boost::shared_ptr<Player> make_player () const;
        boost::shared_ptr<Playlist> playlist () const;
@@ -118,18 +121,19 @@ public:
        Time length () const;
        bool has_subtitles () const;
        OutputVideoFrame best_video_frame_rate () const;
+       FrameRateChange active_frame_rate_change (Time) const;
 
        libdcp::KDM
        make_kdm (
                boost::shared_ptr<libdcp::Certificate> target,
-               boost::filesystem::path dcp,
+               boost::filesystem::path cpl_file,
                boost::posix_time::ptime from,
                boost::posix_time::ptime until
                ) const;
        
        std::list<libdcp::KDM> make_kdms (
                std::list<boost::shared_ptr<Screen> >,
-               boost::filesystem::path dcp,
+               boost::filesystem::path cpl_file,
                boost::posix_time::ptime from,
                boost::posix_time::ptime until
                ) const;
@@ -148,7 +152,7 @@ public:
        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,
@@ -159,7 +163,7 @@ public:
                SIGNED,
                ENCRYPTED,
                J2K_BANDWIDTH,
-               DCI_METADATA,
+               ISDCF_METADATA,
                VIDEO_FRAME_RATE,
                AUDIO_CHANNELS,
                /** The setting of _three_d has been changed */
@@ -179,8 +183,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 {
@@ -216,8 +220,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 */
@@ -246,7 +250,7 @@ public:
 
        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>);
@@ -260,11 +264,11 @@ public:
        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);
 
@@ -279,6 +283,8 @@ public:
 
 private:
 
+       friend class ::isdcf_name_test;
+
        void signal_changed (Property);
        std::string video_identifier () const;
        void playlist_changed ();
@@ -297,8 +303,8 @@ private:
        
        /** 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.) */
@@ -313,12 +319,12 @@ private:
        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.