Hand-apply bbfb370d7de28ec1e8f307865cc6253bb5d4366e from master; quicker digest calcu...
[dcpomatic.git] / src / lib / film.h
index 067588fa3f42a52d7988aa930840f6d0a7b31863..2de06515965d785c0e5e4ccb5e6ef1a50a6914bb 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2015 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
 #ifndef DCPOMATIC_FILM_H
 #define DCPOMATIC_FILM_H
 
-#include <string>
-#include <vector>
-#include <inttypes.h>
-#include <boost/signals2.hpp>
-#include <boost/enable_shared_from_this.hpp>
-#include <boost/filesystem.hpp>
-#include <dcp/key.h>
-#include <dcp/decrypted_kdm.h>
-#include <dcp/encrypted_kdm.h>
 #include "util.h"
 #include "types.h"
 #include "isdcf_metadata.h"
 #include "frame_rate_change.h"
+#include "ratio.h"
+#include <dcp/key.h>
+#include <dcp/encrypted_kdm.h>
+#include <boost/signals2.hpp>
+#include <boost/enable_shared_from_this.hpp>
+#include <boost/filesystem.hpp>
+#include <string>
+#include <vector>
+#include <inttypes.h>
 
 class DCPContentType;
 class Log;
@@ -47,7 +47,7 @@ class Playlist;
 class AudioContent;
 class Scaler;
 class Screen;
-class isdcf_name_test;
+struct isdcf_name_test;
 
 /** @class Film
  *
@@ -70,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 ();
@@ -115,23 +116,24 @@ public:
 
        ContentList content () const;
        DCPTime length () const;
-       bool has_subtitles () const;
        int best_video_frame_rate () const;
        FrameRateChange active_frame_rate_change (DCPTime) const;
 
        dcp::EncryptedKDM
        make_kdm (
-               boost::shared_ptr<dcp::Certificate> target,
+               dcp::Certificate target,
                boost::filesystem::path cpl_file,
                dcp::LocalTime from,
-               dcp::LocalTime until
+               dcp::LocalTime until,
+               dcp::Formulation formulation
                ) const;
        
        std::list<dcp::EncryptedKDM> make_kdms (
                std::list<boost::shared_ptr<Screen> >,
                boost::filesystem::path cpl_file,
                dcp::LocalTime from,
-               dcp::LocalTime until
+               dcp::LocalTime until,
+               dcp::Formulation formulation
                ) const;
 
        dcp::Key key () const {
@@ -142,6 +144,8 @@ public:
                return _state_version;
        }
 
+       std::string subtitle_language () const;
+
        /** Identifiers for the parts of our state;
            used for signalling changes.
        */
@@ -149,23 +153,24 @@ public:
                NONE,
                NAME,
                USE_ISDCF_NAME,
-               /** The playlist's content list has changed (i.e. content has been added, moved around or removed) */
+               /** 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,
                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,
        };
 
 
@@ -199,10 +204,6 @@ public:
                return _scaler;
        }
 
-       bool with_subtitles () const {
-               return _with_subtitles;
-       }
-
        /* signed is a reserved word */
        bool is_signed () const {
                return _signed;
@@ -240,6 +241,10 @@ public:
        bool interop () const {
                return _interop;
        }
+
+       bool burn_subtitles () const {
+               return _burn_subtitles;
+       }
        
 
        /* SET */
@@ -247,6 +252,7 @@ public:
        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>);
@@ -256,7 +262,6 @@ 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);
@@ -267,6 +272,7 @@ public:
        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,7 +285,7 @@ public:
 
 private:
 
-       friend class ::isdcf_name_test;
+       friend struct ::isdcf_name_test;
 
        void signal_changed (Property);
        std::string video_identifier () const;
@@ -309,8 +315,6 @@ 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 */
@@ -329,6 +333,7 @@ private:
        bool _three_d;
        bool _sequence_video;
        bool _interop;
+       bool _burn_subtitles;
        dcp::Key _key;
 
        int _state_version;
@@ -336,8 +341,8 @@ private:
        /** 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