Rearrange checking (and re-examining) content.
[dcpomatic.git] / src / lib / film.h
index 6cce07c17f3fa23bcb047f660582e02b553e7efa..78a66e17f24d9903e65afcde30a259681bf2a77b 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2019 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
 #ifndef DCPOMATIC_FILM_H
 #define DCPOMATIC_FILM_H
 
-#include "util.h"
-#include "types.h"
-#include "isdcf_metadata.h"
+#include "change_signaller.h"
+#include "dcp_text_track.h"
 #include "frame_rate_change.h"
 #include "signaller.h"
-#include "dcp_text_track.h"
-#include <dcp/key.h>
+#include "transcode_job.h"
+#include "types.h"
+#include "util.h"
 #include <dcp/encrypted_kdm.h>
+#include <dcp/key.h>
+#include <dcp/language_tag.h>
+#include <boost/filesystem.hpp>
 #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 <inttypes.h>
 #include <string>
 #include <vector>
-#include <inttypes.h>
 
 namespace xmlpp {
        class Document;
@@ -57,16 +58,17 @@ class Content;
 class Playlist;
 class AudioContent;
 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 (boost::mutex& mutex, boost::filesystem::path file, bool read);
        ~InfoFileHandle ();
 
        FILE* get () const {
@@ -80,8 +82,6 @@ public:
 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;
@@ -94,27 +94,30 @@ private:
  *
  *  The content of a Film is held in a Playlist (created and managed by the Film).
  */
-class Film : public boost::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 ();
 
-       boost::shared_ptr<InfoFileHandle> info_file_handle (dcpomatic::DCPTimePeriod period, bool read) const;
+       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;
        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;
+       boost::filesystem::path audio_analysis_path (std::shared_ptr<const Playlist>) const;
+       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);
+       void make_dcp (TranscodeJob::ChangedBehaviour behaviour);
 
        /** @return Logger.
         *  It is safe to call this from any thread.
         */
-       boost::shared_ptr<Log> log () const {
+       std::shared_ptr<Log> log () const {
                return _log;
        }
 
@@ -126,9 +129,9 @@ public:
        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;
+       std::shared_ptr<xmlpp::Document> metadata (bool with_content_paths = true) const;
 
-       void copy_from (boost::shared_ptr<const Film> film);
+       void copy_from (std::shared_ptr<const Film> film);
 
        std::string isdcf_name (bool if_created_now) const;
        std::string dcp_name (bool if_created_now = false) const;
@@ -140,6 +143,7 @@ public:
 
        dcp::Size full_frame () const;
        dcp::Size frame_size () const;
+       dcp::Size active_area () const;
 
        std::vector<CPLSummary> cpls () const;
 
@@ -150,6 +154,8 @@ public:
        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;
@@ -169,37 +175,33 @@ public:
                boost::optional<int> disable_forensic_marking_audio
                ) const;
 
-       std::list<boost::shared_ptr<ScreenKDM> > make_kdms (
-               std::list<boost::shared_ptr<dcpomatic::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;
-
-       std::vector<std::string> audio_output_names () const;
+       std::vector<NamedChannel> audio_output_names () const;
 
        void repeat_content (ContentList, int);
 
-       boost::shared_ptr<const Playlist> playlist () const {
+       std::shared_ptr<const Playlist> playlist () const {
                return _playlist;
        }
 
        std::list<dcpomatic::DCPTimePeriod> reels () const;
        std::list<int> mapped_audio_channels () 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;
 
        bool references_dcp_video () const;
        bool references_dcp_audio () const;
+       bool contains_atmos_content () const;
 
        void set_tolerant (bool t) {
                _tolerant = t;
@@ -212,7 +214,7 @@ public:
        /** Identifiers for the parts of our state;
            used for signalling changes.
        */
-       enum Property {
+       enum class Property {
                NONE,
                NAME,
                USE_ISDCF_NAME,
@@ -223,11 +225,8 @@ public:
                DCP_CONTENT_TYPE,
                CONTAINER,
                RESOLUTION,
-               SIGNED,
                ENCRYPTED,
-               KEY,
                J2K_BANDWIDTH,
-               ISDCF_METADATA,
                VIDEO_FRAME_RATE,
                AUDIO_CHANNELS,
                /** The setting of _three_d has changed */
@@ -237,11 +236,25 @@ public:
                AUDIO_PROCESSOR,
                REEL_TYPE,
                REEL_LENGTH,
-               UPLOAD_AFTER_MAKE_DCP,
                REENCODE_J2K,
                MARKERS,
                RATINGS,
-               CONTENT_VERSION
+               CONTENT_VERSIONS,
+               NAME_LANGUAGE,
+               AUDIO_LANGUAGE,
+               RELEASE_TERRITORY,
+               SIGN_LANGUAGE_VIDEO_LANGUAGE,
+               VERSION_NUMBER,
+               STATUS,
+               CHAIN,
+               DISTRIBUTOR,
+               FACILITY,
+               STUDIO,
+               TEMP_VERSION,
+               PRE_RELEASE,
+               RED_BAND,
+               TWO_D_VERSION_OF_THREE_D,
+               LUMINANCE,
        };
 
 
@@ -271,11 +284,6 @@ public:
                return _resolution;
        }
 
-       /* signed is a reserved word */
-       bool is_signed () const {
-               return _signed;
-       }
-
        bool encrypted () const {
                return _encrypted;
        }
@@ -288,10 +296,6 @@ public:
                return _j2k_bandwidth;
        }
 
-       ISDCFMetadata isdcf_metadata () const {
-               return _isdcf_metadata;
-       }
-
        /** @return The frame rate of the DCP */
        int video_frame_rate () const {
                return _video_frame_rate;
@@ -325,10 +329,6 @@ public:
                return _reel_length;
        }
 
-       bool upload_after_make_dcp () const {
-               return _upload_after_make_dcp;
-       }
-
        std::string context_id () const {
                return _context_id;
        }
@@ -337,8 +337,10 @@ public:
                return _reencode_j2k;
        }
 
+       typedef std::map<dcp::Marker, dcpomatic::DCPTime> Markers;
+
        boost::optional<dcpomatic::DCPTime> marker (dcp::Marker type) const;
-       std::map<dcp::Marker, dcpomatic::DCPTime> markers () const {
+       Markers markers () const {
                return _markers;
        }
 
@@ -346,29 +348,83 @@ public:
                return _ratings;
        }
 
-       std::string content_version () const {
-               return _content_version;
+       std::vector<std::string> content_versions () const {
+               return _content_versions;
        }
 
+       dcp::LanguageTag name_language () const {
+               return _name_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;
+       }
+
+       dcp::Status status () const {
+               return _status;
+       }
+
+       boost::optional<std::string> chain () const {
+               return _chain;
+       }
+
+       boost::optional<std::string> distributor () const {
+               return _distributor;
+       }
+
+       boost::optional<std::string> facility () const {
+               return _facility;
+       }
+
+       boost::optional<std::string> studio () const {
+               return _studio;
+       }
+
+       bool temp_version () const {
+               return _temp_version;
+       }
+
+       bool pre_release () const {
+               return _pre_release;
+       }
+
+       bool red_band () const {
+               return _red_band;
+       }
+
+       bool two_d_version_of_three_d () const {
+               return _two_d_version_of_three_d;
+       }
+
+       boost::optional<dcp::Luminance> luminance () const {
+               return _luminance;
+       }
+
+
        /* SET */
 
        void set_directory (boost::filesystem::path);
        void set_name (std::string);
        void set_use_isdcf_name (bool);
-       void examine_and_add_content (boost::shared_ptr<Content> content, bool disable_audio_analysis = false);
-       void add_content (boost::shared_ptr<Content>);
-       void remove_content (boost::shared_ptr<Content>);
+       void examine_and_add_content (std::shared_ptr<Content> content, bool disable_audio_analysis = false);
+       void add_content (std::shared_ptr<Content>);
+       void remove_content (std::shared_ptr<Content>);
        void remove_content (ContentList);
-       void move_content_earlier (boost::shared_ptr<Content>);
-       void move_content_later (boost::shared_ptr<Content>);
+       void move_content_earlier (std::shared_ptr<Content>);
+       void move_content_later (std::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 rate, bool user_explicit = false);
        void set_audio_channels (int);
        void set_three_d (bool);
@@ -378,19 +434,35 @@ 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_version (std::string v);
+       void set_content_versions (std::vector<std::string> v);
+       void set_name_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);
+       void set_facility (boost::optional<std::string> f = boost::none);
+       void set_studio (boost::optional<std::string> s = boost::none);
+       void set_temp_version (bool t);
+       void set_pre_release (bool p);
+       void set_red_band (bool r);
+       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 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;
 
        /** Emitted when some property of our content has changed */
-       mutable boost::signals2::signal<void (ChangeType, boost::weak_ptr<Content>, int, bool)> ContentChange;
+       mutable boost::signals2::signal<void (ChangeType, std::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.
@@ -406,7 +478,9 @@ public:
 private:
 
        friend struct ::isdcf_name_test;
-       template <typename> friend class ChangeSignaller;
+       friend struct ::recover_test_2d_encrypted;
+       friend struct ::atmos_encrypted_passthrough_test;
+       template <class, class> friend class ChangeSignaller;
 
        boost::filesystem::path info_file (dcpomatic::DCPTimePeriod p) const;
 
@@ -415,17 +489,16 @@ private:
        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_content_change (ChangeType type, std::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 maybe_add_content (std::weak_ptr<Job>, std::weak_ptr<Content>, bool disable_audio_analysis);
        void audio_analysis_finished ();
        void check_settings_consistency ();
-
-       static std::string const metadata_file;
+       void maybe_set_container_and_resolution ();
 
        /** Log to write to */
-       boost::shared_ptr<Log> _log;
-       boost::shared_ptr<Playlist> _playlist;
+       std::shared_ptr<Log> _log;
+       std::shared_ptr<Playlist> _playlist;
 
        /** Complete path to directory containing the film metadata;
         *  must not be relative.
@@ -442,7 +515,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
@@ -451,8 +523,6 @@ private:
        std::string _context_id;
        /** bandwidth for J2K files in bits per second */
        int _j2k_bandwidth;
-       /** 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 ISDCF name */
@@ -469,20 +539,36 @@ 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::string _content_version;
+       std::vector<std::string> _content_versions;
+       dcp::LanguageTag _name_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;
+       boost::optional<std::string> _distributor;
+       boost::optional<std::string> _facility;
+       boost::optional<std::string> _studio;
+       bool _temp_version = false;
+       bool _pre_release = false;
+       bool _red_band = false;
+       bool _two_d_version_of_three_d = false;
+       boost::optional<dcp::Luminance> _luminance;
+       boost::optional<dcp::LanguageTag> _audio_language;
 
        int _state_version;
 
        /** true if our state has changed since we last saved it */
        mutable bool _dirty;
        /** film being used as a template, or 0 */
-       boost::shared_ptr<Film> _template_film;
+       std::shared_ptr<Film> _template_film;
 
        /** Be tolerant of errors in content (currently applies to DCP only).
            Not saved as state.
@@ -502,4 +588,8 @@ private:
        friend struct film_metadata_test;
 };
 
+
+typedef ChangeSignaller<Film, Film::Property> FilmChangeSignaller;
+
+
 #endif