Store subtitle language(s) in Film, and allow setup of those
[dcpomatic.git] / src / lib / film.h
index 649768c7a620141c0ddb6d4ed7040d2c98b4fef4..4c71c9e1618efabdf9b7ce95f850d551cb1306e7 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2018 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2020 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
 #include "isdcf_metadata.h"
 #include "frame_rate_change.h"
 #include "signaller.h"
+#include "dcp_text_track.h"
+#include <dcp/language_tag.h>
 #include <dcp/key.h>
 #include <dcp/encrypted_kdm.h>
 #include <boost/signals2.hpp>
 #include <boost/enable_shared_from_this.hpp>
+#include <boost/thread.hpp>
 #include <boost/filesystem.hpp>
+#include <boost/thread/mutex.hpp>
 #include <string>
 #include <vector>
 #include <inttypes.h>
@@ -44,23 +48,50 @@ namespace xmlpp {
        class Document;
 }
 
+namespace dcpomatic {
+       class Screen;
+}
+
 class DCPContentType;
 class Log;
 class Content;
 class Playlist;
 class AudioContent;
-class Screen;
 class AudioProcessor;
-class AudioMapping;
 class Ratio;
 class Job;
-class ScreenKDM;
+class Film;
 struct isdcf_name_test;
+struct recover_test_2d_encrypted;
+struct atmos_encrypted_passthrough_test;
+
+class InfoFileHandle
+{
+public:
+       ~InfoFileHandle ();
+
+       FILE* get () const {
+               return _handle;
+       }
+
+       boost::filesystem::path file () const {
+               return _file;
+       }
+
+private:
+       friend class Film;
+
+       InfoFileHandle (boost::mutex& mutex, boost::filesystem::path file, bool read);
+
+       boost::mutex::scoped_lock _lock;
+       FILE* _handle;
+       boost::filesystem::path _file;
+};
 
 /** @class Film
  *
- *  @brief A representation of some audio and video content, and details of
- *  how they should be presented in a DCP.
+ *  @brief A representation of some audio, video, subtitle and closed-caption content,
+ *  and details of how they should be presented in a DCP.
  *
  *  The content of a Film is held in a Playlist (created and managed by the Film).
  */
@@ -70,15 +101,16 @@ public:
        explicit Film (boost::optional<boost::filesystem::path> dir);
        ~Film ();
 
-       boost::filesystem::path info_file (DCPTimePeriod p) const;
+       boost::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;
-       boost::filesystem::path internal_video_asset_filename (DCPTimePeriod p) const;
+       boost::filesystem::path internal_video_asset_filename (dcpomatic::DCPTimePeriod p) const;
 
        boost::filesystem::path audio_analysis_path (boost::shared_ptr<const Playlist>) const;
+       boost::filesystem::path subtitle_analysis_path (boost::shared_ptr<const Content>) const;
 
        void send_dcp_to_tms ();
-       void make_dcp ();
+       void make_dcp (bool gui = false, bool check = true);
 
        /** @return Logger.
         *  It is safe to call this from any thread.
@@ -93,6 +125,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 (boost::filesystem::path path) const;
        void write_template (boost::filesystem::path path) const;
        boost::shared_ptr<xmlpp::Document> metadata (bool with_content_paths = true) const;
 
@@ -108,25 +141,28 @@ public:
 
        dcp::Size full_frame () const;
        dcp::Size frame_size () const;
+       dcp::Size active_area () const;
 
        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;
 
        /* Proxies for some Playlist methods */
 
        ContentList content () const;
-       DCPTime length () const;
+       dcpomatic::DCPTime length () const;
        int best_video_frame_rate () const;
-       FrameRateChange active_frame_rate_change (DCPTime) const;
+       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<dcp::Certificate> trusted_devices,
+               std::vector<std::string> trusted_devices,
                boost::filesystem::path cpl_file,
                dcp::LocalTime from,
                dcp::LocalTime until,
@@ -135,28 +171,11 @@ public:
                boost::optional<int> disable_forensic_marking_audio
                ) const;
 
-       std::list<ScreenKDM> make_kdms (
-               std::list<boost::shared_ptr<Screen> > screens,
-               boost::filesystem::path cpl_file,
-               boost::posix_time::ptime from,
-               boost::posix_time::ptime until,
-               dcp::Formulation formulation,
-               bool disable_forensic_marking_picture,
-               boost::optional<int> disable_forensic_marking_audio
-               ) const;
-
        int state_version () const {
                return _state_version;
        }
 
-       std::string subtitle_language () const;
-
-       void make_audio_mapping_default (
-               AudioMapping & mapping,
-               boost::optional<boost::filesystem::path> filename = boost::optional<boost::filesystem::path> ()
-               ) const;
-
-       std::vector<std::string> audio_output_names () const;
+       std::vector<NamedChannel> audio_output_names () const;
 
        void repeat_content (ContentList, int);
 
@@ -164,13 +183,22 @@ public:
                return _playlist;
        }
 
-       std::list<DCPTimePeriod> reels () const;
+       std::list<dcpomatic::DCPTimePeriod> reels () const;
        std::list<int> mapped_audio_channels () const;
 
-       std::string content_summary (DCPTimePeriod period) const;
+       std::string content_summary (dcpomatic::DCPTimePeriod period) const;
 
        bool references_dcp_video () const;
        bool references_dcp_audio () const;
+       bool contains_atmos_content () const;
+
+       void set_tolerant (bool t) {
+               _tolerant = t;
+       }
+
+       bool tolerant () const {
+               return _tolerant;
+       }
 
        /** Identifiers for the parts of our state;
            used for signalling changes.
@@ -186,9 +214,7 @@ public:
                DCP_CONTENT_TYPE,
                CONTAINER,
                RESOLUTION,
-               SIGNED,
                ENCRYPTED,
-               KEY,
                J2K_BANDWIDTH,
                ISDCF_METADATA,
                VIDEO_FRAME_RATE,
@@ -200,7 +226,20 @@ public:
                AUDIO_PROCESSOR,
                REEL_TYPE,
                REEL_LENGTH,
-               UPLOAD_AFTER_MAKE_DCP
+               REENCODE_J2K,
+               MARKERS,
+               RATINGS,
+               CONTENT_VERSIONS,
+               NAME_LANGUAGE,
+               AUDIO_LANGUAGE,
+               RELEASE_TERRITORY,
+               VERSION_NUMBER,
+               STATUS,
+               CHAIN,
+               DISTRIBUTOR,
+               FACILITY,
+               LUMINANCE,
+               SUBTITLE_LANGUAGES
        };
 
 
@@ -230,11 +269,6 @@ public:
                return _resolution;
        }
 
-       /* signed is a reserved word */
-       bool is_signed () const {
-               return _signed;
-       }
-
        bool encrypted () const {
                return _encrypted;
        }
@@ -284,14 +318,68 @@ public:
                return _reel_length;
        }
 
-       bool upload_after_make_dcp () const {
-               return _upload_after_make_dcp;
-       }
-
        std::string context_id () const {
                return _context_id;
        }
 
+       bool reencode_j2k () const {
+               return _reencode_j2k;
+       }
+
+       typedef std::map<dcp::Marker, dcpomatic::DCPTime> Markers;
+
+       boost::optional<dcpomatic::DCPTime> marker (dcp::Marker type) const;
+       Markers markers () const {
+               return _markers;
+       }
+
+       std::vector<dcp::Rating> ratings () const {
+               return _ratings;
+       }
+
+       std::vector<std::string> content_versions () const {
+               return _content_versions;
+       }
+
+       dcp::LanguageTag name_language () const {
+               return _name_language;
+       }
+
+       dcp::LanguageTag audio_language () const {
+               return _audio_language;
+       }
+
+       dcp::LanguageTag::RegionSubtag release_territory () const {
+               return _release_territory;
+       }
+
+       int version_number () const {
+               return _version_number;
+       }
+
+       dcp::Status status () const {
+               return _status;
+       }
+
+       std::string chain () const {
+               return _chain;
+       }
+
+       std::string distributor () const {
+               return _distributor;
+       }
+
+       std::string facility () const {
+               return _facility;
+       }
+
+       dcp::Luminance luminance () const {
+               return _luminance;
+       }
+
+       std::vector<dcp::LanguageTag> subtitle_languages () const {
+               return _subtitle_languages;
+       }
 
        /* SET */
 
@@ -305,14 +393,12 @@ public:
        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_signed (bool);
+       void set_container (Ratio const *, bool user_explicit = true);
+       void set_resolution (Resolution, bool user_explicit = true);
        void set_encrypted (bool);
-       void set_key (dcp::Key key);
        void set_j2k_bandwidth (int);
        void set_isdcf_metadata (ISDCFMetadata);
-       void set_video_frame_rate (int);
+       void set_video_frame_rate (int rate, bool user_explicit = false);
        void set_audio_channels (int);
        void set_three_d (bool);
        void set_isdcf_date_today ();
@@ -321,7 +407,26 @@ public:
        void set_audio_processor (AudioProcessor const * processor);
        void set_reel_type (ReelType);
        void set_reel_length (int64_t);
-       void set_upload_after_make_dcp (bool);
+       void set_reencode_j2k (bool);
+       void set_marker (dcp::Marker type, dcpomatic::DCPTime time);
+       void unset_marker (dcp::Marker type);
+       void clear_markers ();
+       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 (dcp::LanguageTag::RegionSubtag region);
+       void set_version_number (int v);
+       void set_status (dcp::Status s);
+       void set_chain (std::string c);
+       void set_facility (std::string f);
+       void set_distributor (std::string d);
+       void set_luminance (dcp::Luminance l);
+       void set_subtitle_language (dcp::LanguageTag language);
+       void unset_subtitle_language ();
+       void set_subtitle_languages (std::vector<dcp::LanguageTag> languages);
+
+       void add_ffoc_lfoc (Markers& markers) const;
 
        /** Emitted when some property has of the Film is about to change or has changed */
        mutable boost::signals2::signal<void (ChangeType, Property)> Change;
@@ -329,20 +434,37 @@ public:
        /** Emitted when some property of our content has changed */
        mutable boost::signals2::signal<void (ChangeType, boost::weak_ptr<Content>, int, bool)> ContentChange;
 
+       /** Emitted when the film's length might have changed; this is not like a normal
+           property as its value is derived from the playlist, so it has its own signal.
+       */
+       mutable boost::signals2::signal<void ()> LengthChange;
+
+       /** Emitted when we have something important to tell the user */
+       boost::signals2::signal<void (std::string)> Message;
+
        /** Current version number of the state file */
        static int const current_state_version;
 
 private:
 
        friend struct ::isdcf_name_test;
+       friend struct ::recover_test_2d_encrypted;
+       friend struct ::atmos_encrypted_passthrough_test;
+       template <typename> friend class ChangeSignaller;
 
-       void signal_changed (Property);
+       boost::filesystem::path info_file (dcpomatic::DCPTimePeriod p) const;
+
+       void signal_change (ChangeType, Property);
+       void signal_change (ChangeType, int);
        std::string video_identifier () const;
        void playlist_change (ChangeType);
        void playlist_order_changed ();
        void playlist_content_change (ChangeType type, boost::weak_ptr<Content>, int, bool frequent);
+       void playlist_length_change ();
        void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>, bool disable_audio_analysis);
        void audio_analysis_finished ();
+       void check_settings_consistency ();
+       void maybe_set_container_and_resolution ();
 
        static std::string const metadata_file;
 
@@ -365,7 +487,6 @@ private:
        Ratio const * _container;
        /** DCP resolution (2K or 4K) */
        Resolution _resolution;
-       bool _signed;
        bool _encrypted;
        dcp::Key _key;
        /** context ID used when encrypting picture assets; we keep it so that we can
@@ -392,7 +513,24 @@ private:
        ReelType _reel_type;
        /** Desired reel length in bytes, if _reel_type == REELTYPE_BY_LENGTH */
        int64_t _reel_length;
-       bool _upload_after_make_dcp;
+       bool _reencode_j2k;
+       /** true if the user has ever explicitly set the video frame rate of this film */
+       bool _user_explicit_video_frame_rate;
+       bool _user_explicit_container;
+       bool _user_explicit_resolution;
+       std::map<dcp::Marker, dcpomatic::DCPTime> _markers;
+       std::vector<dcp::Rating> _ratings;
+       std::vector<std::string> _content_versions;
+       dcp::LanguageTag _name_language;
+       dcp::LanguageTag _audio_language;
+       dcp::LanguageTag::RegionSubtag _release_territory;
+       int _version_number;
+       dcp::Status _status;
+       std::string _chain;
+       std::string _distributor;
+       std::string _facility;
+       dcp::Luminance _luminance;
+       std::vector<dcp::LanguageTag> _subtitle_languages;
 
        int _state_version;
 
@@ -401,9 +539,17 @@ private:
        /** film being used as a template, or 0 */
        boost::shared_ptr<Film> _template_film;
 
+       /** Be tolerant of errors in content (currently applies to DCP only).
+           Not saved as state.
+       */
+       bool _tolerant;
+
+       mutable boost::mutex _info_file_mutex;
+
        boost::signals2::scoped_connection _playlist_change_connection;
        boost::signals2::scoped_connection _playlist_order_changed_connection;
        boost::signals2::scoped_connection _playlist_content_change_connection;
+       boost::signals2::scoped_connection _playlist_length_change_connection;
        std::list<boost::signals2::connection> _job_connections;
        std::list<boost::signals2::connection> _audio_analysis_connections;