2 Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
22 * @brief A representation of some audio and video content, and details of
23 * how they should be presented in a DCP.
26 #ifndef DCPOMATIC_FILM_H
27 #define DCPOMATIC_FILM_H
29 #include "change_signaller.h"
30 #include "dcp_text_track.h"
31 #include "frame_rate_change.h"
32 #include "signaller.h"
35 #include <dcp/encrypted_kdm.h>
37 #include <dcp/language_tag.h>
38 #include <boost/filesystem.hpp>
39 #include <boost/signals2.hpp>
40 #include <boost/thread.hpp>
41 #include <boost/thread/mutex.hpp>
63 struct isdcf_name_test;
64 struct recover_test_2d_encrypted;
65 struct atmos_encrypted_passthrough_test;
70 InfoFileHandle (boost::mutex& mutex, boost::filesystem::path file, bool read);
77 boost::filesystem::path file () const {
84 boost::mutex::scoped_lock _lock;
86 boost::filesystem::path _file;
91 * @brief A representation of some audio, video, subtitle and closed-caption content,
92 * and details of how they should be presented in a DCP.
94 * The content of a Film is held in a Playlist (created and managed by the Film).
96 class Film : public std::enable_shared_from_this<Film>, public Signaller
99 explicit Film (boost::optional<boost::filesystem::path> dir);
102 Film (Film const&) = delete;
103 Film& operator= (Film const&) = delete;
105 std::shared_ptr<InfoFileHandle> info_file_handle (dcpomatic::DCPTimePeriod period, bool read) const;
106 boost::filesystem::path j2c_path (int, Frame, Eyes, bool) const;
107 boost::filesystem::path internal_video_asset_dir () const;
108 boost::filesystem::path internal_video_asset_filename (dcpomatic::DCPTimePeriod p) const;
110 boost::filesystem::path audio_analysis_path (std::shared_ptr<const Playlist>) const;
111 boost::filesystem::path subtitle_analysis_path (std::shared_ptr<const Content>) const;
113 void send_dcp_to_tms ();
114 void make_dcp (bool gui = false, bool check = true);
117 * It is safe to call this from any thread.
119 std::shared_ptr<Log> log () const {
123 boost::filesystem::path file (boost::filesystem::path f) const;
124 boost::filesystem::path dir (boost::filesystem::path d, bool create = true) const;
126 void use_template (std::string name);
127 std::list<std::string> read_metadata (boost::optional<boost::filesystem::path> path = boost::optional<boost::filesystem::path> ());
128 void write_metadata () const;
129 void write_metadata (boost::filesystem::path path) const;
130 void write_template (boost::filesystem::path path) const;
131 std::shared_ptr<xmlpp::Document> metadata (bool with_content_paths = true) const;
133 void copy_from (std::shared_ptr<const Film> film);
135 std::string isdcf_name (bool if_created_now) const;
136 std::string dcp_name (bool if_created_now = false) const;
138 /** @return true if our state has changed since we last saved it */
139 bool dirty () const {
143 dcp::Size full_frame () const;
144 dcp::Size frame_size () const;
145 dcp::Size active_area () const;
147 std::vector<CPLSummary> cpls () const;
149 int audio_frame_rate () const;
151 std::list<DCPTextTrack> closed_caption_tracks () const;
153 uint64_t required_disk_space () const;
154 bool should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const;
156 /* Proxies for some Playlist methods */
158 ContentList content () const;
159 dcpomatic::DCPTime length () const;
160 int best_video_frame_rate () const;
161 FrameRateChange active_frame_rate_change (dcpomatic::DCPTime) const;
162 std::pair<double, double> speed_up_range (int dcp_frame_rate) const;
164 dcp::EncryptedKDM make_kdm (
165 dcp::Certificate recipient,
166 std::vector<std::string> trusted_devices,
167 boost::filesystem::path cpl_file,
169 dcp::LocalTime until,
170 dcp::Formulation formulation,
171 bool disable_forensic_marking_picture,
172 boost::optional<int> disable_forensic_marking_audio
175 int state_version () const {
176 return _state_version;
179 std::vector<NamedChannel> audio_output_names () const;
181 void repeat_content (ContentList, int);
183 std::shared_ptr<const Playlist> playlist () const {
187 std::list<dcpomatic::DCPTimePeriod> reels () const;
188 std::list<int> mapped_audio_channels () const;
190 boost::optional<dcp::LanguageTag> audio_language () const {
191 return _audio_language;
194 std::pair<boost::optional<dcp::LanguageTag>, std::vector<dcp::LanguageTag>> subtitle_languages () const;
196 std::string content_summary (dcpomatic::DCPTimePeriod period) const;
198 bool references_dcp_video () const;
199 bool references_dcp_audio () const;
200 bool contains_atmos_content () const;
202 void set_tolerant (bool t) {
206 bool tolerant () const {
210 /** Identifiers for the parts of our state;
211 used for signalling changes.
213 enum class Property {
217 /** The playlist's content list has changed (i.e. content has been added or removed) */
219 /** The order of content in the playlist has changed */
228 /** The setting of _three_d has changed */
251 TWO_D_VERSION_OF_THREE_D,
258 boost::optional<boost::filesystem::path> directory () const {
262 std::string name () const {
266 bool use_isdcf_name () const {
267 return _use_isdcf_name;
270 DCPContentType const * dcp_content_type () const {
271 return _dcp_content_type;
274 Ratio const * container () const {
278 Resolution resolution () const {
282 bool encrypted () const {
286 dcp::Key key () const {
290 int j2k_bandwidth () const {
291 return _j2k_bandwidth;
294 /** @return The frame rate of the DCP */
295 int video_frame_rate () const {
296 return _video_frame_rate;
299 int audio_channels () const {
300 return _audio_channels;
303 bool three_d () const {
307 bool sequence () const {
311 bool interop () const {
315 AudioProcessor const * audio_processor () const {
316 return _audio_processor;
319 ReelType reel_type () const {
323 int64_t reel_length () const {
327 std::string context_id () const {
331 bool reencode_j2k () const {
332 return _reencode_j2k;
335 typedef std::map<dcp::Marker, dcpomatic::DCPTime> Markers;
337 boost::optional<dcpomatic::DCPTime> marker (dcp::Marker type) const;
338 Markers markers () const {
342 std::vector<dcp::Rating> ratings () const {
346 std::vector<std::string> content_versions () const {
347 return _content_versions;
350 dcp::LanguageTag name_language () const {
351 return _name_language;
354 boost::optional<dcp::LanguageTag::RegionSubtag> release_territory () const {
355 return _release_territory;
358 int version_number () const {
359 return _version_number;
362 dcp::Status status () const {
366 boost::optional<std::string> chain () const {
370 boost::optional<std::string> distributor () const {
374 boost::optional<std::string> facility () const {
378 boost::optional<std::string> studio () const {
382 bool temp_version () const {
383 return _temp_version;
386 bool pre_release () const {
390 bool red_band () const {
394 bool two_d_version_of_three_d () const {
395 return _two_d_version_of_three_d;
398 boost::optional<dcp::Luminance> luminance () const {
405 void set_directory (boost::filesystem::path);
406 void set_name (std::string);
407 void set_use_isdcf_name (bool);
408 void examine_and_add_content (std::shared_ptr<Content> content, bool disable_audio_analysis = false);
409 void add_content (std::shared_ptr<Content>);
410 void remove_content (std::shared_ptr<Content>);
411 void remove_content (ContentList);
412 void move_content_earlier (std::shared_ptr<Content>);
413 void move_content_later (std::shared_ptr<Content>);
414 void set_dcp_content_type (DCPContentType const *);
415 void set_container (Ratio const *, bool user_explicit = true);
416 void set_resolution (Resolution, bool user_explicit = true);
417 void set_encrypted (bool);
418 void set_j2k_bandwidth (int);
419 void set_video_frame_rate (int rate, bool user_explicit = false);
420 void set_audio_channels (int);
421 void set_three_d (bool);
422 void set_isdcf_date_today ();
423 void set_sequence (bool);
424 void set_interop (bool);
425 void set_audio_processor (AudioProcessor const * processor);
426 void set_reel_type (ReelType);
427 void set_reel_length (int64_t);
428 void set_reencode_j2k (bool);
429 void set_marker (dcp::Marker type, dcpomatic::DCPTime time);
430 void unset_marker (dcp::Marker type);
431 void clear_markers ();
432 void set_ratings (std::vector<dcp::Rating> r);
433 void set_content_versions (std::vector<std::string> v);
434 void set_name_language (dcp::LanguageTag lang);
435 void set_release_territory (boost::optional<dcp::LanguageTag::RegionSubtag> region = boost::none);
436 void set_version_number (int v);
437 void set_status (dcp::Status s);
438 void set_chain (boost::optional<std::string> c = boost::none);
439 void set_facility (boost::optional<std::string> f = boost::none);
440 void set_studio (boost::optional<std::string> s = boost::none);
441 void set_temp_version (bool t);
442 void set_pre_release (bool p);
443 void set_red_band (bool r);
444 void set_two_d_version_of_three_d (bool t);
445 void set_distributor (boost::optional<std::string> d = boost::none);
446 void set_luminance (boost::optional<dcp::Luminance> l = boost::none);
447 void set_audio_language (boost::optional<dcp::LanguageTag> language);
449 void add_ffoc_lfoc (Markers& markers) const;
451 /** Emitted when some property has of the Film is about to change or has changed */
452 mutable boost::signals2::signal<void (ChangeType, Property)> Change;
454 /** Emitted when some property of our content has changed */
455 mutable boost::signals2::signal<void (ChangeType, std::weak_ptr<Content>, int, bool)> ContentChange;
457 /** Emitted when the film's length might have changed; this is not like a normal
458 property as its value is derived from the playlist, so it has its own signal.
460 mutable boost::signals2::signal<void ()> LengthChange;
462 /** Emitted when we have something important to tell the user */
463 boost::signals2::signal<void (std::string)> Message;
465 /** Current version number of the state file */
466 static int const current_state_version;
470 friend struct ::isdcf_name_test;
471 friend struct ::recover_test_2d_encrypted;
472 friend struct ::atmos_encrypted_passthrough_test;
473 template <class, class> friend class ChangeSignaller;
475 boost::filesystem::path info_file (dcpomatic::DCPTimePeriod p) const;
477 void signal_change (ChangeType, Property);
478 void signal_change (ChangeType, int);
479 std::string video_identifier () const;
480 void playlist_change (ChangeType);
481 void playlist_order_changed ();
482 void playlist_content_change (ChangeType type, std::weak_ptr<Content>, int, bool frequent);
483 void playlist_length_change ();
484 void maybe_add_content (std::weak_ptr<Job>, std::weak_ptr<Content>, bool disable_audio_analysis);
485 void audio_analysis_finished ();
486 void check_settings_consistency ();
487 void maybe_set_container_and_resolution ();
489 static std::string const metadata_file;
491 /** Log to write to */
492 std::shared_ptr<Log> _log;
493 std::shared_ptr<Playlist> _playlist;
495 /** Complete path to directory containing the film metadata;
496 * must not be relative.
498 boost::optional<boost::filesystem::path> _directory;
500 /** Name for DCP-o-matic */
502 /** True if a auto-generated ISDCF-compliant name should be used for our DCP */
503 bool _use_isdcf_name;
504 /** The type of content that this Film represents (feature, trailer etc.) */
505 DCPContentType const * _dcp_content_type;
506 /** The container to put this Film in (flat, scope, etc.) */
507 Ratio const * _container;
508 /** DCP resolution (2K or 4K) */
509 Resolution _resolution;
512 /** context ID used when encrypting picture assets; we keep it so that we can
513 * re-start picture MXF encodes.
515 std::string _context_id;
516 /** bandwidth for J2K files in bits per second */
518 /** Frames per second to run our DCP at */
519 int _video_frame_rate;
520 /** The date that we should use in a ISDCF name */
521 boost::gregorian::date _isdcf_date;
522 /** Number of audio channels requested for the DCP */
524 /** If true, the DCP will be written in 3D mode; otherwise in 2D.
525 This will be regardless of what content is on the playlist.
530 AudioProcessor const * _audio_processor;
532 /** Desired reel length in bytes, if _reel_type == REELTYPE_BY_LENGTH */
533 int64_t _reel_length;
535 /** true if the user has ever explicitly set the video frame rate of this film */
536 bool _user_explicit_video_frame_rate;
537 bool _user_explicit_container;
538 bool _user_explicit_resolution;
539 std::map<dcp::Marker, dcpomatic::DCPTime> _markers;
540 std::vector<dcp::Rating> _ratings;
541 std::vector<std::string> _content_versions;
542 dcp::LanguageTag _name_language;
543 boost::optional<dcp::LanguageTag::RegionSubtag> _release_territory;
546 boost::optional<std::string> _chain;
547 boost::optional<std::string> _distributor;
548 boost::optional<std::string> _facility;
549 boost::optional<std::string> _studio;
550 bool _temp_version = false;
551 bool _pre_release = false;
552 bool _red_band = false;
553 bool _two_d_version_of_three_d = false;
554 boost::optional<dcp::Luminance> _luminance;
555 boost::optional<dcp::LanguageTag> _audio_language;
559 /** true if our state has changed since we last saved it */
561 /** film being used as a template, or 0 */
562 std::shared_ptr<Film> _template_film;
564 /** Be tolerant of errors in content (currently applies to DCP only).
569 mutable boost::mutex _info_file_mutex;
571 boost::signals2::scoped_connection _playlist_change_connection;
572 boost::signals2::scoped_connection _playlist_order_changed_connection;
573 boost::signals2::scoped_connection _playlist_content_change_connection;
574 boost::signals2::scoped_connection _playlist_length_change_connection;
575 std::list<boost::signals2::connection> _job_connections;
576 std::list<boost::signals2::connection> _audio_analysis_connections;
578 friend struct paths_test;
579 friend struct film_metadata_test;
583 typedef ChangeSignaller<Film, Film::Property> FilmChangeSignaller;