Fix some warnings.
[dcpomatic.git] / src / lib / film.h
index e5840621a1f7475ad1040cbe61fe932858ce7648..8a0823094e4c0ddf7b272ee05fae332ba631cc25 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 #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;
+struct isdcf_name_test;
 
 /** @class Film
  *
@@ -67,6 +70,7 @@ public:
 
        boost::filesystem::path video_mxf_filename () const;
        boost::filesystem::path audio_mxf_filename () const;
+       boost::filesystem::path subtitle_xml_filename () const;
 
        void send_dcp_to_tms ();
        void make_dcp ();
@@ -83,11 +87,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 */
@@ -95,19 +99,15 @@ public:
                return _dirty;
        }
 
-       libdcp::Size full_frame () const;
+       dcp::Size full_frame () const;
+       dcp::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;
 
-       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;
@@ -115,26 +115,28 @@ public:
        /* Proxies for some Playlist methods */
 
        ContentList content () const;
-       Time length () const;
-       bool has_subtitles () const;
-       OutputVideoFrame best_video_frame_rate () const;
+       DCPTime length () const;
+       int best_video_frame_rate () const;
+       FrameRateChange active_frame_rate_change (DCPTime) const;
 
-       libdcp::KDM
+       dcp::EncryptedKDM
        make_kdm (
-               boost::shared_ptr<libdcp::Certificate> target,
-               boost::filesystem::path dcp,
-               boost::posix_time::ptime from,
-               boost::posix_time::ptime until
+               dcp::Certificate target,
+               boost::filesystem::path cpl_file,
+               dcp::LocalTime from,
+               dcp::LocalTime until,
+               dcp::Formulation formulation
                ) const;
        
-       std::list<libdcp::KDM> make_kdms (
+       std::list<dcp::EncryptedKDM> make_kdms (
                std::list<boost::shared_ptr<Screen> >,
-               boost::filesystem::path dcp,
-               boost::posix_time::ptime from,
-               boost::posix_time::ptime until
+               boost::filesystem::path cpl_file,
+               dcp::LocalTime from,
+               dcp::LocalTime until,
+               dcp::Formulation formulation
                ) const;
 
-       libdcp::Key key () const {
+       dcp::Key key () const {
                return _key;
        }
 
@@ -148,24 +150,25 @@ public:
        enum Property {
                NONE,
                NAME,
-               USE_DCI_NAME,
-               /** The playlist's content list has changed (i.e. content has been added, moved around or removed) */
+               USE_ISDCF_NAME,
+               /** The playlist's content list has changed (i.e. content has been added or removed) */
                CONTENT,
                DCP_CONTENT_TYPE,
                CONTAINER,
                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 */
+               /** The setting of _three_d has changed */
                THREE_D,
                SEQUENCE_VIDEO,
                INTEROP,
+               /** The setting of _burn_subtitles has changed */
+               BURN_SUBTITLES,
        };
 
 
@@ -179,8 +182,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 {
@@ -199,10 +202,6 @@ public:
                return _scaler;
        }
 
-       bool with_subtitles () const {
-               return _with_subtitles;
-       }
-
        /* signed is a reserved word */
        bool is_signed () const {
                return _signed;
@@ -216,8 +215,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 */
@@ -240,13 +239,18 @@ public:
        bool interop () const {
                return _interop;
        }
+
+       bool burn_subtitles () const {
+               return _burn_subtitles;
+       }
        
 
        /* SET */
 
        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_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>);
@@ -256,17 +260,17 @@ public:
        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);
+       void set_burn_subtitles (bool);
 
        /** Emitted when some property has of the Film has changed */
        mutable boost::signals2::signal<void (Property)> Changed;
@@ -279,6 +283,8 @@ public:
 
 private:
 
+       friend struct ::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.) */
@@ -307,18 +313,16 @@ private:
        Resolution _resolution;
        /** Scaler algorithm to use */
        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.
@@ -327,15 +331,16 @@ private:
        bool _three_d;
        bool _sequence_video;
        bool _interop;
-       libdcp::Key _key;
+       bool _burn_subtitles;
+       dcp::Key _key;
 
        int _state_version;
 
        /** true if our state has changed since we last saved it */
        mutable bool _dirty;
 
-       friend class paths_test;
-       friend class film_metadata_test;
+       friend struct paths_test;
+       friend struct film_metadata_test;
 };
 
 #endif