X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Ffilm.h;h=e48f2658ef8c647c3b7adbb994f0b980964de54c;hb=4c1b4d803fd1e14aaf1eb51a420025186513bae4;hp=a2e0c8b60e6be2a198bd788365664879876491cc;hpb=cac7313566d2524f28449bad56bda3f03af3c3a4;p=dcpomatic.git diff --git a/src/lib/film.h b/src/lib/film.h index a2e0c8b60..e48f2658e 100644 --- a/src/lib/film.h +++ b/src/lib/film.h @@ -18,23 +18,36 @@ */ + /** @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 "change_signaller.h" #include "dcp_text_track.h" +#include "dcpomatic_time.h" +#include "film_property.h" #include "frame_rate_change.h" +#include "named_channel.h" +#include "remembered_asset.h" +#include "resolution.h" #include "signaller.h" +#include "territory_type.h" +#include "transcode_job.h" #include "types.h" #include "util.h" #include +#include #include #include +#include +#include #include #include #include @@ -43,6 +56,7 @@ #include #include + namespace xmlpp { class Document; } @@ -51,30 +65,29 @@ namespace dcpomatic { class Screen; } +class AudioContent; +class AudioProcessor; +class Content; class DCPContentType; +class Film; +class Job; class Log; -class Content; class Playlist; -class AudioContent; -class AudioProcessor; class Ratio; -class Job; -class Film; +struct atmos_encrypted_passthrough_test; struct isdcf_name_test; +struct isdcf_name_with_atmos; +struct isdcf_name_with_ccap; +struct ov_subs_in_vf_name; 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 { + dcp::File& get () { return _file; } @@ -82,10 +95,10 @@ private: friend class Film; boost::mutex::scoped_lock _lock; - FILE* _handle; - boost::filesystem::path _file; + dcp::File _file; }; + /** @class Film * * @brief A representation of some audio, video, subtitle and closed-caption content, @@ -104,14 +117,12 @@ public: 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 (std::shared_ptr) const; boost::filesystem::path subtitle_analysis_path (std::shared_ptr) const; + boost::filesystem::path assets_path() 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. @@ -125,7 +136,7 @@ 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; std::shared_ptr metadata (bool with_content_paths = true) const; @@ -146,12 +157,12 @@ public: 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 should_be_enough_disk_space(double& required, double& available) const; + + bool has_sign_language_video_channel () const; /* Proxies for some Playlist methods */ @@ -161,16 +172,7 @@ public: 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; + dcp::DecryptedKDM make_kdm(boost::filesystem::path cpl_file, dcp::LocalTime from, dcp::LocalTime until) const; int state_version () const { return _state_version; @@ -184,15 +186,19 @@ public: return _playlist; } - std::list reels () const; + std::vector 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; + /** @param burnt_in If non-null, filled with true if all subtitles are burnt in, otherwise false. + * @return pair containing the main subtitle language, and additional languages + */ + std::pair, std::vector> subtitle_languages(bool* burnt_in = nullptr) const; + /** @return all closed caption languages in the film */ + std::vector closed_caption_languages() const; std::string content_summary (dcpomatic::DCPTimePeriod period) const; @@ -208,51 +214,7 @@ public: return _tolerant; } - /** Identifiers for the parts of our state; - used for signalling changes. - */ - enum class Property { - NONE, - NAME, - 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, - ENCRYPTED, - J2K_BANDWIDTH, - VIDEO_FRAME_RATE, - AUDIO_CHANNELS, - /** The setting of _three_d has changed */ - THREE_D, - 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, - STUDIO, - TEMP_VERSION, - PRE_RELEASE, - RED_BAND, - TWO_D_VERSION_OF_THREE_D, - LUMINANCE, - }; - + bool last_written_by_earlier_than(int major, int minor, int micro) const; /* GET */ @@ -313,6 +275,10 @@ public: return _interop; } + bool limit_to_smpte_bv20() const { + return _limit_to_smpte_bv20; + } + AudioProcessor const * audio_processor () const { return _audio_processor; } @@ -325,6 +291,10 @@ public: return _reel_length; } + std::vector custom_reel_boundaries() const { + return _custom_reel_boundaries; + } + std::string context_id () const { return _context_id; } @@ -352,10 +322,18 @@ public: return _name_language; } + TerritoryType territory_type() const { + return _territory_type; + } + 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; } @@ -400,6 +378,13 @@ public: return _luminance; } + boost::gregorian::date isdcf_date () const { + return _isdcf_date; + } + + int audio_frame_rate () const { + return _audio_frame_rate; + } /* SET */ @@ -423,9 +408,11 @@ public: void set_isdcf_date_today (); void set_sequence (bool); void set_interop (bool); + void set_limit_to_smpte_bv20(bool); void set_audio_processor (AudioProcessor const * processor); void set_reel_type (ReelType); void set_reel_length (int64_t); + void set_custom_reel_boundaries(std::vector boundaries); void set_reencode_j2k (bool); void set_marker (dcp::Marker type, dcpomatic::DCPTime time); void unset_marker (dcp::Marker type); @@ -433,7 +420,9 @@ public: void set_ratings (std::vector r); void set_content_versions (std::vector v); void set_name_language (dcp::LanguageTag lang); + void set_territory_type(TerritoryType type); 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); @@ -446,11 +435,20 @@ public: 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; + void set_ui_state(std::string key, std::string value); + boost::optional ui_state(std::string key) const; + void read_ui_state(); + + std::vector read_remembered_assets() const; + void write_remembered_assets(std::vector const& assets) const; + std::string video_identifier() const; + /** Emitted when some property has of the Film is about to change or has changed */ - mutable boost::signals2::signal Change; + mutable boost::signals2::signal Change; /** Emitted when some property of our content has changed */ mutable boost::signals2::signal, int, bool)> ContentChange; @@ -460,6 +458,8 @@ public: */ mutable boost::signals2::signal LengthChange; + boost::signals2::signal DirtyChange; + /** Emitted when we have something important to tell the user */ boost::signals2::signal Message; @@ -469,15 +469,17 @@ public: private: friend struct ::isdcf_name_test; + friend struct ::isdcf_name_with_atmos; + friend struct ::isdcf_name_with_ccap; friend struct ::recover_test_2d_encrypted; friend struct ::atmos_encrypted_passthrough_test; - template friend class ChangeSignaller; + friend struct ::ov_subs_in_vf_name; + template friend class ChangeSignalDespatcher; boost::filesystem::path info_file (dcpomatic::DCPTimePeriod p) const; - void signal_change (ChangeType, Property); + void signal_change (ChangeType, FilmProperty); void signal_change (ChangeType, int); - std::string video_identifier () const; void playlist_change (ChangeType); void playlist_order_changed (); void playlist_content_change (ChangeType type, std::weak_ptr, int, bool frequent); @@ -486,8 +488,8 @@ private: void audio_analysis_finished (); void check_settings_consistency (); void maybe_set_container_and_resolution (); - - static std::string const metadata_file; + void set_dirty (bool dirty); + void write_ui_state() const; /** Log to write to */ std::shared_ptr _log; @@ -498,6 +500,8 @@ private: */ 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 */ @@ -528,10 +532,13 @@ private: bool _three_d; bool _sequence; bool _interop; + bool _limit_to_smpte_bv20; AudioProcessor const * _audio_processor; ReelType _reel_type; - /** Desired reel length in bytes, if _reel_type == REELTYPE_BY_LENGTH */ + /** Desired reel length in bytes, if _reel_type == BY_LENGTH */ int64_t _reel_length; + /** Reel boundaries (excluding those at the start and end, sorted in ascending order) if _reel_type == CUSTOM */ + std::vector _custom_reel_boundaries; bool _reencode_j2k; /** true if the user has ever explicitly set the video frame rate of this film */ bool _user_explicit_video_frame_rate; @@ -541,7 +548,9 @@ private: std::vector _ratings; std::vector _content_versions; dcp::LanguageTag _name_language; + TerritoryType _territory_type = TerritoryType::SPECIFIC; boost::optional _release_territory; + boost::optional _sign_language_video_language; int _version_number; dcp::Status _status; boost::optional _chain; @@ -554,6 +563,7 @@ private: bool _two_d_version_of_three_d = false; boost::optional _luminance; boost::optional _audio_language; + int _audio_frame_rate = 48000; int _state_version; @@ -567,6 +577,8 @@ private: */ bool _tolerant; + std::map _ui_state; + mutable boost::mutex _info_file_mutex; boost::signals2::scoped_connection _playlist_change_connection; @@ -581,7 +593,7 @@ private: }; -typedef ChangeSignaller FilmChangeSignaller; +typedef ChangeSignaller FilmChangeSignaller; #endif