X-Git-Url: https://main.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Ffilm.h;h=b0f1a86855e9d91100fcbb4e0266650dbcb521f3;hp=f776a3f72da22a440b8360128405f6384f523cab;hb=e519feaca11005d330e7b8403b948d4ad9cc3ae8;hpb=a4c19a34244aeaf183c25878933b570fc5c0ee34 diff --git a/src/lib/film.h b/src/lib/film.h index f776a3f72..4c71c9e16 100644 --- a/src/lib/film.h +++ b/src/lib/film.h @@ -1,19 +1,20 @@ /* - Copyright (C) 2012 Carl Hetherington + Copyright (C) 2012-2020 Carl Hetherington - This program is free software; you can redistribute it and/or modify + This file is part of DCP-o-matic. + + DCP-o-matic is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. - This program is distributed in the hope that it will be useful, + DCP-o-matic is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + along with DCP-o-matic. If not, see . */ @@ -25,51 +26,91 @@ #ifndef DCPOMATIC_FILM_H #define DCPOMATIC_FILM_H -#include -#include -#include +#include "util.h" +#include "types.h" +#include "isdcf_metadata.h" +#include "frame_rate_change.h" +#include "signaller.h" +#include "dcp_text_track.h" +#include +#include +#include #include #include +#include #include -#include -#include -#include "util.h" -#include "types.h" -#include "dci_metadata.h" +#include +#include +#include +#include + +namespace xmlpp { + class Document; +} + +namespace dcpomatic { + class Screen; +} class DCPContentType; class Log; class Content; -class Player; class Playlist; class AudioContent; -class Scaler; -class Screen; +class AudioProcessor; +class Ratio; +class Job; +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). */ -class Film : public boost::enable_shared_from_this, public boost::noncopyable +class Film : public boost::enable_shared_from_this, public Signaller, public boost::noncopyable { public: - Film (boost::filesystem::path, bool log = true); + explicit Film (boost::optional dir); + ~Film (); - boost::filesystem::path info_dir () const; - boost::filesystem::path j2c_path (int, Eyes, bool) const; - boost::filesystem::path info_path (int, Eyes) const; - boost::filesystem::path internal_video_mxf_dir () const; - boost::filesystem::path internal_video_mxf_filename () const; - boost::filesystem::path audio_analysis_path (boost::shared_ptr) const; + boost::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 video_mxf_filename () const; - boost::filesystem::path audio_mxf_filename () const; + boost::filesystem::path audio_analysis_path (boost::shared_ptr) const; + boost::filesystem::path subtitle_analysis_path (boost::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. @@ -78,16 +119,19 @@ public: return _log; } - int encoded_frames () const; - boost::filesystem::path file (boost::filesystem::path f) const; - boost::filesystem::path dir (boost::filesystem::path d) const; + boost::filesystem::path dir (boost::filesystem::path d, bool create = true) const; - void read_metadata (); + void use_template (std::string name); + std::list read_metadata (boost::optional path = boost::optional ()); void write_metadata () const; - boost::shared_ptr 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::string dci_name (bool if_created_now) const; + void copy_from (boost::shared_ptr film); + + std::string isdcf_name (bool if_created_now) const; std::string dcp_name (bool if_created_now = false) const; /** @return true if our state has changed since we last saved it */ @@ -96,78 +140,112 @@ public: } dcp::Size full_frame () const; + dcp::Size frame_size () const; + dcp::Size active_area () const; - std::list dcps () const; - - boost::shared_ptr make_player () const; - boost::shared_ptr playlist () 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 &, double &) 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; - bool has_subtitles () const; + dcpomatic::DCPTime length () const; int best_video_frame_rate () const; - FrameRateChange active_frame_rate_change (DCPTime) const; - - dcp::KDM - make_kdm ( - boost::shared_ptr target, - boost::filesystem::path dcp, - boost::posix_time::ptime from, - boost::posix_time::ptime until + 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, + boost::filesystem::path cpl_file, + dcp::LocalTime from, + dcp::LocalTime until, + dcp::Formulation formulation, + bool disable_forensic_marking_picture, + boost::optional disable_forensic_marking_audio ) const; - - std::list make_kdms ( - std::list >, - boost::filesystem::path dcp, - boost::posix_time::ptime from, - boost::posix_time::ptime until - ) const; - - dcp::Key key () const { - return _key; - } int state_version () const { return _state_version; } + std::vector audio_output_names () const; + + void repeat_content (ContentList, int); + + boost::shared_ptr playlist () const { + return _playlist; + } + + std::list reels () const; + std::list mapped_audio_channels () 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. */ enum Property { NONE, NAME, - USE_DCI_NAME, - /** The playlist's content list has changed (i.e. content has been added, moved around or removed) */ + USE_ISDCF_NAME, + /** The playlist's content list has changed (i.e. content has been added or removed) */ CONTENT, + /** The order of content in the playlist has changed */ + CONTENT_ORDER, DCP_CONTENT_TYPE, CONTAINER, RESOLUTION, - SCALER, - WITH_SUBTITLES, - SIGNED, ENCRYPTED, J2K_BANDWIDTH, - DCI_METADATA, + ISDCF_METADATA, VIDEO_FRAME_RATE, AUDIO_CHANNELS, - /** The setting of _three_d has been changed */ + /** The setting of _three_d has changed */ THREE_D, - SEQUENCE_VIDEO, + SEQUENCE, INTEROP, + AUDIO_PROCESSOR, + REEL_TYPE, + REEL_LENGTH, + REENCODE_J2K, + MARKERS, + RATINGS, + CONTENT_VERSIONS, + NAME_LANGUAGE, + AUDIO_LANGUAGE, + RELEASE_TERRITORY, + VERSION_NUMBER, + STATUS, + CHAIN, + DISTRIBUTOR, + FACILITY, + LUMINANCE, + SUBTITLE_LANGUAGES }; /* GET */ - boost::filesystem::path directory () const { + boost::optional directory () const { return _directory; } @@ -175,8 +253,8 @@ public: return _name; } - bool use_dci_name () const { - return _use_dci_name; + bool use_isdcf_name () const { + return _use_isdcf_name; } DCPContentType const * dcp_content_type () const { @@ -191,29 +269,20 @@ public: return _resolution; } - Scaler const * scaler () const { - return _scaler; - } - - bool with_subtitles () const { - return _with_subtitles; - } - - /* signed is a reserved word */ - bool is_signed () const { - return _signed; - } - bool encrypted () const { return _encrypted; } + dcp::Key key () const { + return _key; + } + int j2k_bandwidth () const { return _j2k_bandwidth; } - DCIMetadata dci_metadata () const { - return _dci_metadata; + ISDCFMetadata isdcf_metadata () const { + return _isdcf_metadata; } /** @return The frame rate of the DCP */ @@ -229,58 +298,175 @@ public: return _three_d; } - bool sequence_video () const { - return _sequence_video; + bool sequence () const { + return _sequence; } bool interop () const { return _interop; } - + + AudioProcessor const * audio_processor () const { + return _audio_processor; + } + + ReelType reel_type () const { + return _reel_type; + } + + int64_t reel_length () const { + return _reel_length; + } + + 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; + } + + 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 subtitle_languages () const { + return _subtitle_languages; + } /* SET */ void set_directory (boost::filesystem::path); void set_name (std::string); - void set_use_dci_name (bool); - void examine_and_add_content (boost::shared_ptr); + 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 remove_content (ContentList); void move_content_earlier (boost::shared_ptr); void move_content_later (boost::shared_ptr); void set_dcp_content_type (DCPContentType const *); - void set_container (Ratio const *); - void set_resolution (Resolution); - void set_scaler (Scaler const *); - void set_with_subtitles (bool); - 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_j2k_bandwidth (int); - void set_dci_metadata (DCIMetadata); - void set_video_frame_rate (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); - void set_dci_date_today (); - void set_sequence_video (bool); + void set_isdcf_date_today (); + void set_sequence (bool); void set_interop (bool); - - /** Emitted when some property has of the Film has changed */ - mutable boost::signals2::signal Changed; + void set_audio_processor (AudioProcessor const * processor); + void set_reel_type (ReelType); + void set_reel_length (int64_t); + 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_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 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 Change; /** Emitted when some property of our content has changed */ - mutable boost::signals2::signal, int)> 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; private: - void signal_changed (Property); + friend struct ::isdcf_name_test; + 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; + + void signal_change (ChangeType, Property); + void signal_change (ChangeType, int); std::string video_identifier () const; - void playlist_changed (); - void playlist_content_changed (boost::weak_ptr, int); - std::string filename_safe_name () const; - void maybe_add_content (boost::weak_ptr, boost::weak_ptr); + void playlist_change (ChangeType); + void playlist_order_changed (); + void playlist_content_change (ChangeType type, boost::weak_ptr, int, bool frequent); + void playlist_length_change (); + void maybe_add_content (boost::weak_ptr, boost::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; @@ -289,49 +475,86 @@ private: /** Complete path to directory containing the film metadata; * must not be relative. */ - boost::filesystem::path _directory; - + boost::optional _directory; + /** Name for DCP-o-matic */ std::string _name; - /** True if a auto-generated DCI-compliant name should be used for our DCP */ - bool _use_dci_name; + /** True if a auto-generated ISDCF-compliant name should be used for our DCP */ + bool _use_isdcf_name; /** The type of content that this Film represents (feature, trailer etc.) */ DCPContentType const * _dcp_content_type; /** The container to put this Film in (flat, scope, etc.) */ Ratio const * _container; /** DCP resolution (2K or 4K) */ Resolution _resolution; - /** Scaler algorithm to use */ - Scaler const * _scaler; - /** True if subtitles should be shown for this film */ - bool _with_subtitles; - bool _signed; bool _encrypted; + dcp::Key _key; + /** context ID used when encrypting picture assets; we keep it so that we can + * re-start picture MXF encodes. + */ + std::string _context_id; /** bandwidth for J2K files in bits per second */ int _j2k_bandwidth; - /** DCI naming stuff */ - DCIMetadata _dci_metadata; + /** 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 DCI name */ - boost::gregorian::date _dci_date; - /** Number of audio channels to put in the DCP */ + /** The date that we should use in a ISDCF name */ + boost::gregorian::date _isdcf_date; + /** Number of audio channels requested for the DCP */ int _audio_channels; /** If true, the DCP will be written in 3D mode; otherwise in 2D. This will be regardless of what content is on the playlist. */ bool _three_d; - bool _sequence_video; + bool _sequence; bool _interop; - dcp::Key _key; + AudioProcessor const * _audio_processor; + ReelType _reel_type; + /** Desired reel length in bytes, if _reel_type == REELTYPE_BY_LENGTH */ + int64_t _reel_length; + 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; + 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 _subtitle_languages; 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; + + /** 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 _job_connections; + std::list _audio_analysis_connections; - friend class paths_test; - friend class film_metadata_test; + friend struct paths_test; + friend struct film_metadata_test; }; #endif