X-Git-Url: https://main.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Ffilm.h;h=d46f5e6b7a5061e51febe67cdf7c722170263918;hp=9f473d7110b914866e21e443b2b9918eb90b44d8;hb=2d4e8c5f69cc694625ad95dcee554499605f823b;hpb=67a68bd971ebe1b35daa3f75873b4ccb53c00ba0 diff --git a/src/lib/film.h b/src/lib/film.h index 9f473d711..d46f5e6b7 100644 --- a/src/lib/film.h +++ b/src/lib/film.h @@ -1,5 +1,5 @@ /* - Copyright (C) 2012-2016 Carl Hetherington + Copyright (C) 2012-2021 Carl Hetherington This file is part of DCP-o-matic. @@ -26,64 +26,97 @@ #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 +#include "types.h" +#include "util.h" #include -#include -#include +#include +#include #include +#include +#include +#include +#include #include #include -#include 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 (boost::mutex& mutex, boost::filesystem::path file, bool read); + ~InfoFileHandle (); + + FILE* get () const { + return _handle; + } + + boost::filesystem::path file () const { + return _file; + } + +private: + friend class Film; + + 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). */ -class Film : public boost::enable_shared_from_this, public Signaller, public boost::noncopyable +class Film : public std::enable_shared_from_this, public Signaller { public: - Film (boost::optional dir); + explicit Film (boost::optional dir); ~Film (); - boost::filesystem::path info_file (DCPTimePeriod p) 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 (DCPTimePeriod p) 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 (); + 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; } @@ -93,8 +126,11 @@ public: void use_template (std::string name); std::list read_metadata (boost::optional path = boost::optional ()); void write_metadata () const; + 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 (std::shared_ptr film); std::string isdcf_name (bool if_created_now) const; std::string dcp_name (bool if_created_now = false) const; @@ -106,68 +142,75 @@ 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; /* 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 speed_up_range (int dcp_frame_rate) const; dcp::EncryptedKDM make_kdm ( dcp::Certificate recipient, - std::vector trusted_devices, + std::vector trusted_devices, boost::filesystem::path cpl_file, dcp::LocalTime from, dcp::LocalTime until, - dcp::Formulation formulation - ) 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 + 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; - - void make_audio_mapping_default ( - AudioMapping & mapping, - boost::optional filename = boost::optional () - ) 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 reels () const; std::list mapped_audio_channels () const; - std::string content_summary (DCPTimePeriod period) const; + boost::optional audio_language () const { + return _audio_language; + } + + std::pair, std::vector> subtitle_languages () const; - std::list fix_conflicting_settings (); + 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. */ - enum Property { + enum class Property { NONE, NAME, USE_ISDCF_NAME, @@ -178,11 +221,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 */ @@ -192,7 +232,24 @@ 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, + STUDIO, + TEMP_VERSION, + PRE_RELEASE, + RED_BAND, + TWO_D_VERSION_OF_THREE_D, + LUMINANCE, }; @@ -222,11 +279,6 @@ public: return _resolution; } - /* signed is a reserved word */ - bool is_signed () const { - return _signed; - } - bool encrypted () const { return _encrypted; } @@ -239,10 +291,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; @@ -276,35 +324,99 @@ 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 Markers; + + boost::optional marker (dcp::Marker type) const; + Markers markers () const { + return _markers; + } + + std::vector ratings () const { + return _ratings; + } + + std::vector content_versions () const { + return _content_versions; + } + + dcp::LanguageTag name_language () const { + return _name_language; + } + + boost::optional release_territory () const { + return _release_territory; + } + + 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; + } + /* 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); - 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); + 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 (); @@ -313,13 +425,42 @@ 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); - - /** Emitted when some property has of the Film has changed */ - mutable boost::signals2::signal Changed; + 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_versions (std::vector v); + void set_name_language (dcp::LanguageTag lang); + void set_release_territory (boost::optional region = boost::none); + 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 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)> ContentChanged; + 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; + + /** Emitted when we have something important to tell the user */ + boost::signals2::signal Message; /** Current version number of the state file */ static int const current_state_version; @@ -327,18 +468,29 @@ public: private: friend struct ::isdcf_name_test; + friend struct ::recover_test_2d_encrypted; + friend struct ::atmos_encrypted_passthrough_test; + template 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_changed (); + void playlist_change (ChangeType); void playlist_order_changed (); - void playlist_content_changed (boost::weak_ptr, int, bool frequent); - void maybe_add_content (boost::weak_ptr, boost::weak_ptr); + 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 (); + void maybe_set_container_and_resolution (); + + static std::string const metadata_file; /** 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. @@ -355,7 +507,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 @@ -364,8 +515,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 */ @@ -382,18 +531,47 @@ 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::vector _content_versions; + dcp::LanguageTag _name_language; + boost::optional _release_territory; + 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 _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; - boost::signals2::scoped_connection _playlist_changed_connection; + /** 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_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; @@ -401,4 +579,8 @@ private: friend struct film_metadata_test; }; + +typedef ChangeSignaller FilmChangeSignaller; + + #endif