X-Git-Url: https://git.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Ffilm.h;h=babc14a295c2d75cba261cf56c1dd2120ccdb03a;hp=68f8b5334a4f1ec9c6eaff5288d56aecae415d54;hb=cc279961a2a9ffea67ed21378fef44c2e1bcb202;hpb=3dfe3b92df03eee932f3c92336197559c11a5913 diff --git a/src/lib/film.h b/src/lib/film.h index 68f8b5334..babc14a29 100644 --- a/src/lib/film.h +++ b/src/lib/film.h @@ -1,5 +1,5 @@ /* - Copyright (C) 2012-2019 Carl Hetherington + Copyright (C) 2012-2021 Carl Hetherington This file is part of DCP-o-matic. @@ -18,30 +18,40 @@ */ + /** @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 "util.h" -#include "types.h" -#include "isdcf_metadata.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 "dcp_text_track.h" -#include +#include "transcode_job.h" +#include "types.h" +#include "util.h" #include +#include +#include +#include +#include +#include #include -#include #include -#include #include +#include #include #include -#include + namespace xmlpp { class Document; @@ -57,63 +67,62 @@ class Content; class Playlist; class AudioContent; class AudioProcessor; -class AudioMapping; class Ratio; class Job; -class ScreenKDM; 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 (); - - FILE* get () const { - return _handle; - } + InfoFileHandle (boost::mutex& mutex, boost::filesystem::path file, bool read); - boost::filesystem::path file () const { + dcp::File& get () { 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; + dcp::File _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). */ -class Film : public boost::enable_shared_from_this, public Signaller, public boost::noncopyable +class Film : public std::enable_shared_from_this, public Signaller { public: explicit Film (boost::optional dir); ~Film (); - boost::shared_ptr info_file_handle (dcpomatic::DCPTimePeriod period, bool read) const; + Film (Film const&) = delete; + Film& operator= (Film const&) = delete; + + std::shared_ptr 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; + boost::filesystem::path audio_analysis_path (std::shared_ptr) const; + boost::filesystem::path subtitle_analysis_path (std::shared_ptr) 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. */ - boost::shared_ptr log () const { + std::shared_ptr log () const { return _log; } @@ -122,12 +131,12 @@ public: void use_template (std::string name); std::list read_metadata (boost::optional path = boost::optional ()); - void write_metadata () const; + void write_metadata (); void write_metadata (boost::filesystem::path path) const; void write_template (boost::filesystem::path path) const; - boost::shared_ptr metadata (bool with_content_paths = true) const; + std::shared_ptr metadata (bool with_content_paths = true) const; - void copy_from (boost::shared_ptr film); + void copy_from (std::shared_ptr film); std::string isdcf_name (bool if_created_now) const; std::string dcp_name (bool if_created_now = false) const; @@ -139,16 +148,17 @@ public: dcp::Size full_frame () const; dcp::Size frame_size () const; + dcp::Size active_area () const; std::vector cpls () const; - int audio_frame_rate () const; - std::list 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; @@ -168,37 +178,33 @@ public: boost::optional disable_forensic_marking_audio ) const; - std::list > make_kdms ( - std::list > 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 disable_forensic_marking_audio - ) const; - int state_version () const { return _state_version; } - std::string subtitle_language () const; - - std::vector audio_output_names () const; + std::vector audio_output_names () const; void repeat_content (ContentList, int); - boost::shared_ptr playlist () const { + std::shared_ptr playlist () const { return _playlist; } std::list reels () const; std::list mapped_audio_channels () const; + boost::optional audio_language () const { + return _audio_language; + } + + /** @return pair containing the main subtitle language, and additional languages */ + std::pair, std::vector> 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; @@ -208,10 +214,12 @@ public: return _tolerant; } + 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 Property { + enum class Property { NONE, NAME, USE_ISDCF_NAME, @@ -222,12 +230,10 @@ public: DCP_CONTENT_TYPE, CONTAINER, RESOLUTION, - SIGNED, ENCRYPTED, - KEY, J2K_BANDWIDTH, - ISDCF_METADATA, VIDEO_FRAME_RATE, + AUDIO_FRAME_RATE, AUDIO_CHANNELS, /** The setting of _three_d has changed */ THREE_D, @@ -236,11 +242,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, }; @@ -270,11 +290,6 @@ public: return _resolution; } - /* signed is a reserved word */ - bool is_signed () const { - return _signed; - } - bool encrypted () const { return _encrypted; } @@ -287,10 +302,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; @@ -324,10 +335,6 @@ public: return _reel_length; } - bool upload_after_make_dcp () const { - return _upload_after_make_dcp; - } - std::string context_id () const { return _context_id; } @@ -336,8 +343,10 @@ public: return _reencode_j2k; } + typedef std::map Markers; + boost::optional marker (dcp::Marker type) const; - std::map markers () const { + Markers markers () const { return _markers; } @@ -345,8 +354,72 @@ public: return _ratings; } - std::string content_version () const { - return _content_version; + std::vector content_versions () const { + return _content_versions; + } + + dcp::LanguageTag name_language () const { + return _name_language; + } + + boost::optional release_territory () const { + return _release_territory; + } + + boost::optional 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 chain () const { + return _chain; + } + + boost::optional distributor () const { + return _distributor; + } + + boost::optional facility () const { + return _facility; + } + + boost::optional 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 luminance () const { + return _luminance; + } + + boost::gregorian::date isdcf_date () const { + return _isdcf_date; + } + + int audio_frame_rate () const { + return _audio_frame_rate; } /* SET */ @@ -354,20 +427,17 @@ public: 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, bool disable_audio_analysis = false); - void add_content (boost::shared_ptr); - void remove_content (boost::shared_ptr); + void examine_and_add_content (std::shared_ptr content, bool disable_audio_analysis = false); + void add_content (std::shared_ptr); + void remove_content (std::shared_ptr); void remove_content (ContentList); - void move_content_earlier (boost::shared_ptr); - void move_content_later (boost::shared_ptr); + void move_content_earlier (std::shared_ptr); + void move_content_later (std::shared_ptr); 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); @@ -377,18 +447,43 @@ 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 r); - void set_content_version (std::string v); + void set_content_versions (std::vector v); + void set_name_language (dcp::LanguageTag lang); + void set_release_territory (boost::optional region = boost::none); + void set_sign_language_video_language (boost::optional tag); + void set_version_number (int v); + void set_status (dcp::Status s); + void set_chain (boost::optional c = boost::none); + void set_facility (boost::optional f = boost::none); + void set_studio (boost::optional 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 d = boost::none); + void set_luminance (boost::optional l = boost::none); + void set_audio_language (boost::optional language); + void set_audio_frame_rate (int rate); + + 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 Change; /** Emitted when some property of our content has changed */ - mutable boost::signals2::signal, int, bool)> ContentChange; + mutable boost::signals2::signal, 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 LengthChange; + + boost::signals2::signal DirtyChange; /** Emitted when we have something important to tell the user */ boost::signals2::signal Message; @@ -399,7 +494,10 @@ public: private: friend struct ::isdcf_name_test; - template friend class ChangeSignaller; + friend struct ::isdcf_name_with_atmos; + friend struct ::recover_test_2d_encrypted; + friend struct ::atmos_encrypted_passthrough_test; + template friend class ChangeSignaller; boost::filesystem::path info_file (dcpomatic::DCPTimePeriod p) const; @@ -408,22 +506,25 @@ private: std::string video_identifier () const; void playlist_change (ChangeType); void playlist_order_changed (); - void playlist_content_change (ChangeType type, boost::weak_ptr, int, bool frequent); - void maybe_add_content (boost::weak_ptr, boost::weak_ptr, bool disable_audio_analysis); + void playlist_content_change (ChangeType type, std::weak_ptr, int, bool frequent); + void playlist_length_change (); + void maybe_add_content (std::weak_ptr, std::weak_ptr, bool disable_audio_analysis); void audio_analysis_finished (); void check_settings_consistency (); - - static std::string const metadata_file; + void maybe_set_container_and_resolution (); + void set_dirty (bool dirty); /** Log to write to */ - boost::shared_ptr _log; - boost::shared_ptr _playlist; + std::shared_ptr _log; + std::shared_ptr _playlist; /** Complete path to directory containing the film metadata; * must not be relative. */ boost::optional _directory; + boost::optional _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 */ @@ -434,7 +535,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 @@ -443,8 +543,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 */ @@ -461,20 +559,37 @@ 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 _markers; std::vector _ratings; - std::string _content_version; + std::vector _content_versions; + dcp::LanguageTag _name_language; + boost::optional _release_territory; + boost::optional _sign_language_video_language; + int _version_number; + dcp::Status _status; + boost::optional _chain; + boost::optional _distributor; + boost::optional _facility; + boost::optional _studio; + bool _temp_version = false; + bool _pre_release = false; + bool _red_band = false; + bool _two_d_version_of_three_d = false; + boost::optional _luminance; + boost::optional _audio_language; + int _audio_frame_rate = 48000; 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 _template_film; + std::shared_ptr _template_film; /** Be tolerant of errors in content (currently applies to DCP only). Not saved as state. @@ -486,6 +601,7 @@ private: 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 _job_connections; std::list _audio_analysis_connections; @@ -493,4 +609,8 @@ private: friend struct film_metadata_test; }; + +typedef ChangeSignaller FilmChangeSignaller; + + #endif