Allow signals to be blocked and resumed, and so make sure that a set
[dcpomatic.git] / src / lib / film.h
index 5fc56acfb0613570bc29b1067181703cc03b5319..958c388b3a7a8d21c3f679dfa8ce006c6791e707 100644 (file)
 
 */
 
+
 /** @file  src/film.h
  *  @brief A representation of some audio and video content, and details of
  *  how they should be presented in a DCP.
  */
 
+
 #ifndef DCPOMATIC_FILM_H
 #define DCPOMATIC_FILM_H
 
+
 #include "change_signaller.h"
 #include "dcp_text_track.h"
+#include "dcpomatic_time.h"
 #include "frame_rate_change.h"
+#include "named_channel.h"
+#include "resolution.h"
 #include "signaller.h"
+#include "transcode_job.h"
 #include "types.h"
 #include "util.h"
 #include <dcp/encrypted_kdm.h>
+#include <dcp/file.h>
 #include <dcp/key.h>
 #include <dcp/language_tag.h>
+#include <dcp/rating.h>
 #include <boost/filesystem.hpp>
 #include <boost/signals2.hpp>
 #include <boost/thread.hpp>
@@ -43,6 +52,7 @@
 #include <string>
 #include <vector>
 
+
 namespace xmlpp {
        class Document;
 }
@@ -61,20 +71,17 @@ class Ratio;
 class Job;
 class Film;
 struct isdcf_name_test;
+struct isdcf_name_with_atmos;
 struct recover_test_2d_encrypted;
 struct atmos_encrypted_passthrough_test;
 
+
 class InfoFileHandle
 {
 public:
        InfoFileHandle (boost::mutex& mutex, boost::filesystem::path file, bool read);
-       ~InfoFileHandle ();
-
-       FILE* get () const {
-               return _handle;
-       }
 
-       boost::filesystem::path file () const {
+       dcp::File& get () {
                return _file;
        }
 
@@ -82,10 +89,10 @@ private:
        friend class Film;
 
        boost::mutex::scoped_lock _lock;
-       FILE* _handle;
-       boost::filesystem::path _file;
+       dcp::File _file;
 };
 
+
 /** @class Film
  *
  *  @brief A representation of some audio, video, subtitle and closed-caption content,
@@ -93,12 +100,15 @@ private:
  *
  *  The content of a Film is held in a Playlist (created and managed by the Film).
  */
-class Film : public std::enable_shared_from_this<Film>, public Signaller, public boost::noncopyable
+class Film : public std::enable_shared_from_this<Film>, public Signaller
 {
 public:
        explicit Film (boost::optional<boost::filesystem::path> dir);
        ~Film ();
 
+       Film (Film const&) = delete;
+       Film& operator= (Film const&) = delete;
+
        std::shared_ptr<InfoFileHandle> info_file_handle (dcpomatic::DCPTimePeriod period, bool read) const;
        boost::filesystem::path j2c_path (int, Frame, Eyes, bool) const;
        boost::filesystem::path internal_video_asset_dir () const;
@@ -108,7 +118,6 @@ public:
        boost::filesystem::path subtitle_analysis_path (std::shared_ptr<const Content>) const;
 
        void send_dcp_to_tms ();
-       void make_dcp (bool gui = false, bool check = true);
 
        /** @return Logger.
         *  It is safe to call this from any thread.
@@ -122,7 +131,7 @@ public:
 
        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;
+       void write_metadata ();
        void write_metadata (boost::filesystem::path path) const;
        void write_template (boost::filesystem::path path) const;
        std::shared_ptr<xmlpp::Document> metadata (bool with_content_paths = true) const;
@@ -143,13 +152,13 @@ public:
 
        std::vector<CPLSummary> cpls () 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& required, double& available, bool& can_hard_link) const;
 
+       bool has_sign_language_video_channel () const;
+
        /* Proxies for some Playlist methods */
 
        ContentList content () const;
@@ -158,16 +167,7 @@ public:
        FrameRateChange active_frame_rate_change (dcpomatic::DCPTime) const;
        std::pair<double, double> speed_up_range (int dcp_frame_rate) const;
 
-       dcp::EncryptedKDM make_kdm (
-               dcp::Certificate recipient,
-               std::vector<std::string> trusted_devices,
-               boost::filesystem::path cpl_file,
-               dcp::LocalTime from,
-               dcp::LocalTime until,
-               dcp::Formulation formulation,
-               bool disable_forensic_marking_picture,
-               boost::optional<int> disable_forensic_marking_audio
-               ) const;
+       dcp::DecryptedKDM make_kdm(boost::filesystem::path cpl_file, dcp::LocalTime from, dcp::LocalTime until) const;
 
        int state_version () const {
                return _state_version;
@@ -183,7 +183,12 @@ public:
 
        std::list<dcpomatic::DCPTimePeriod> reels () const;
        std::list<int> mapped_audio_channels () const;
-       std::vector<dcp::LanguageTag> audio_languages () const;
+
+       boost::optional<dcp::LanguageTag> audio_language () const {
+               return _audio_language;
+       }
+
+       /** @return pair containing the main subtitle language, and additional languages */
        std::pair<boost::optional<dcp::LanguageTag>, std::vector<dcp::LanguageTag>> subtitle_languages () const;
 
        std::string content_summary (dcpomatic::DCPTimePeriod period) const;
@@ -200,9 +205,9 @@ public:
                return _tolerant;
        }
 
-       /** Identifiers for the parts of our state;
-           used for signalling changes.
-       */
+       bool last_written_by_earlier_than(int major, int minor, int micro) const;
+
+       /** Identifiers for the parts of our state; used for signalling changes */
        enum class Property {
                NONE,
                NAME,
@@ -217,11 +222,13 @@ public:
                ENCRYPTED,
                J2K_BANDWIDTH,
                VIDEO_FRAME_RATE,
+               AUDIO_FRAME_RATE,
                AUDIO_CHANNELS,
                /** The setting of _three_d has changed */
                THREE_D,
                SEQUENCE,
                INTEROP,
+               LIMIT_TO_SMPTE_BV20,
                AUDIO_PROCESSOR,
                REEL_TYPE,
                REEL_LENGTH,
@@ -232,6 +239,7 @@ public:
                NAME_LANGUAGE,
                AUDIO_LANGUAGE,
                RELEASE_TERRITORY,
+               SIGN_LANGUAGE_VIDEO_LANGUAGE,
                VERSION_NUMBER,
                STATUS,
                CHAIN,
@@ -305,6 +313,10 @@ public:
                return _interop;
        }
 
+       bool limit_to_smpte_bv20() const {
+               return _limit_to_smpte_bv20;
+       }
+
        AudioProcessor const * audio_processor () const {
                return _audio_processor;
        }
@@ -344,14 +356,14 @@ public:
                return _name_language;
        }
 
-       dcp::LanguageTag audio_language () const {
-               return _audio_language;
-       }
-
        boost::optional<dcp::LanguageTag::RegionSubtag> release_territory () const {
                return _release_territory;
        }
 
+       boost::optional<dcp::LanguageTag> sign_language_video_language () const {
+               return _sign_language_video_language;
+       }
+
        int version_number () const {
                return _version_number;
        }
@@ -396,6 +408,14 @@ public:
                return _luminance;
        }
 
+       boost::gregorian::date isdcf_date () const {
+               return _isdcf_date;
+       }
+
+       int audio_frame_rate () const {
+               return _audio_frame_rate;
+       }
+
        /* SET */
 
        void set_directory (boost::filesystem::path);
@@ -418,6 +438,7 @@ public:
        void set_isdcf_date_today ();
        void set_sequence (bool);
        void set_interop (bool);
+       void set_limit_to_smpte_bv20(bool);
        void set_audio_processor (AudioProcessor const * processor);
        void set_reel_type (ReelType);
        void set_reel_length (int64_t);
@@ -428,8 +449,8 @@ public:
        void set_ratings (std::vector<dcp::Rating> r);
        void set_content_versions (std::vector<std::string> v);
        void set_name_language (dcp::LanguageTag lang);
-       void set_audio_language (dcp::LanguageTag lang);
        void set_release_territory (boost::optional<dcp::LanguageTag::RegionSubtag> region = boost::none);
+       void set_sign_language_video_language (boost::optional<dcp::LanguageTag> tag);
        void set_version_number (int v);
        void set_status (dcp::Status s);
        void set_chain (boost::optional<std::string> c = boost::none);
@@ -441,6 +462,8 @@ public:
        void set_two_d_version_of_three_d (bool t);
        void set_distributor (boost::optional<std::string> d = boost::none);
        void set_luminance (boost::optional<dcp::Luminance> l = boost::none);
+       void set_audio_language (boost::optional<dcp::LanguageTag> language);
+       void set_audio_frame_rate (int rate);
 
        void add_ffoc_lfoc (Markers& markers) const;
 
@@ -455,6 +478,8 @@ public:
        */
        mutable boost::signals2::signal<void ()> LengthChange;
 
+       boost::signals2::signal<void (bool)> DirtyChange;
+
        /** Emitted when we have something important to tell the user */
        boost::signals2::signal<void (std::string)> Message;
 
@@ -464,9 +489,10 @@ public:
 private:
 
        friend struct ::isdcf_name_test;
+       friend struct ::isdcf_name_with_atmos;
        friend struct ::recover_test_2d_encrypted;
        friend struct ::atmos_encrypted_passthrough_test;
-       template <class, class> friend class ChangeSignaller;
+       template <class, class> friend class ChangeSignalDespatcher;
 
        boost::filesystem::path info_file (dcpomatic::DCPTimePeriod p) const;
 
@@ -481,8 +507,7 @@ private:
        void audio_analysis_finished ();
        void check_settings_consistency ();
        void maybe_set_container_and_resolution ();
-
-       static std::string const metadata_file;
+       void set_dirty (bool dirty);
 
        /** Log to write to */
        std::shared_ptr<Log> _log;
@@ -493,6 +518,8 @@ private:
         */
        boost::optional<boost::filesystem::path> _directory;
 
+       boost::optional<std::string> _last_written_by;
+
        /** Name for DCP-o-matic */
        std::string _name;
        /** True if a auto-generated ISDCF-compliant name should be used for our DCP */
@@ -523,6 +550,7 @@ private:
        bool _three_d;
        bool _sequence;
        bool _interop;
+       bool _limit_to_smpte_bv20;
        AudioProcessor const * _audio_processor;
        ReelType _reel_type;
        /** Desired reel length in bytes, if _reel_type == REELTYPE_BY_LENGTH */
@@ -536,8 +564,8 @@ private:
        std::vector<dcp::Rating> _ratings;
        std::vector<std::string> _content_versions;
        dcp::LanguageTag _name_language;
-       dcp::LanguageTag _audio_language;
        boost::optional<dcp::LanguageTag::RegionSubtag> _release_territory;
+       boost::optional<dcp::LanguageTag> _sign_language_video_language;
        int _version_number;
        dcp::Status _status;
        boost::optional<std::string> _chain;
@@ -549,6 +577,8 @@ private:
        bool _red_band = false;
        bool _two_d_version_of_three_d = false;
        boost::optional<dcp::Luminance> _luminance;
+       boost::optional<dcp::LanguageTag> _audio_language;
+       int _audio_frame_rate = 48000;
 
        int _state_version;