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/>.
23 * @brief A representation of some audio and video content, and details of
24 * how they should be presented in a DCP.
28 #ifndef DCPOMATIC_FILM_H
29 #define DCPOMATIC_FILM_H
32 #include "change_signaller.h"
33 #include "dcp_text_track.h"
34 #include "dcpomatic_time.h"
35 #include "frame_rate_change.h"
36 #include "named_channel.h"
37 #include "resolution.h"
38 #include "signaller.h"
39 #include "transcode_job.h"
42 #include <dcp/encrypted_kdm.h>
45 #include <dcp/language_tag.h>
46 #include <dcp/rating.h>
47 #include <boost/filesystem.hpp>
48 #include <boost/signals2.hpp>
49 #include <boost/thread.hpp>
50 #include <boost/thread/mutex.hpp>
73 struct isdcf_name_test;
74 struct isdcf_name_with_atmos;
75 struct recover_test_2d_encrypted;
76 struct atmos_encrypted_passthrough_test;
82 InfoFileHandle (boost::mutex& mutex, boost::filesystem::path file, bool read);
91 boost::mutex::scoped_lock _lock;
98 * @brief A representation of some audio, video, subtitle and closed-caption content,
99 * and details of how they should be presented in a DCP.
101 * The content of a Film is held in a Playlist (created and managed by the Film).
103 class Film : public std::enable_shared_from_this<Film>, public Signaller
106 explicit Film (boost::optional<boost::filesystem::path> dir);
109 Film (Film const&) = delete;
110 Film& operator= (Film const&) = delete;
112 std::shared_ptr<InfoFileHandle> info_file_handle (dcpomatic::DCPTimePeriod period, bool read) const;
113 boost::filesystem::path j2c_path (int, Frame, Eyes, bool) const;
114 boost::filesystem::path internal_video_asset_dir () const;
115 boost::filesystem::path internal_video_asset_filename (dcpomatic::DCPTimePeriod p) const;
117 boost::filesystem::path audio_analysis_path (std::shared_ptr<const Playlist>) const;
118 boost::filesystem::path subtitle_analysis_path (std::shared_ptr<const Content>) const;
120 void send_dcp_to_tms ();
123 * It is safe to call this from any thread.
125 std::shared_ptr<Log> log () const {
129 boost::filesystem::path file (boost::filesystem::path f) const;
130 boost::filesystem::path dir (boost::filesystem::path d, bool create = true) const;
132 void use_template (std::string name);
133 std::list<std::string> read_metadata (boost::optional<boost::filesystem::path> path = boost::optional<boost::filesystem::path> ());
134 void write_metadata ();
135 void write_metadata (boost::filesystem::path path) const;
136 void write_template (boost::filesystem::path path) const;
137 std::shared_ptr<xmlpp::Document> metadata (bool with_content_paths = true) const;
139 void copy_from (std::shared_ptr<const Film> film);
141 std::string isdcf_name (bool if_created_now) const;
142 std::string dcp_name (bool if_created_now = false) const;
144 /** @return true if our state has changed since we last saved it */
145 bool dirty () const {
149 dcp::Size full_frame () const;
150 dcp::Size frame_size () const;
151 dcp::Size active_area () const;
153 std::vector<CPLSummary> cpls () const;
155 std::list<DCPTextTrack> closed_caption_tracks () const;
157 uint64_t required_disk_space () const;
158 bool should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const;
160 bool has_sign_language_video_channel () const;
162 /* Proxies for some Playlist methods */
164 ContentList content () const;
165 dcpomatic::DCPTime length () const;
166 int best_video_frame_rate () const;
167 FrameRateChange active_frame_rate_change (dcpomatic::DCPTime) const;
168 std::pair<double, double> speed_up_range (int dcp_frame_rate) const;
170 dcp::DecryptedKDM make_kdm(boost::filesystem::path cpl_file, dcp::LocalTime from, dcp::LocalTime until) const;
172 int state_version () const {
173 return _state_version;
176 std::vector<NamedChannel> audio_output_names () const;
178 void repeat_content (ContentList, int);
180 std::shared_ptr<const Playlist> playlist () const {
184 std::list<dcpomatic::DCPTimePeriod> reels () const;
185 std::list<int> mapped_audio_channels () const;
187 boost::optional<dcp::LanguageTag> audio_language () const {
188 return _audio_language;
191 /** @return pair containing the main subtitle language, and additional languages */
192 std::pair<boost::optional<dcp::LanguageTag>, std::vector<dcp::LanguageTag>> subtitle_languages () const;
194 std::string content_summary (dcpomatic::DCPTimePeriod period) const;
196 bool references_dcp_video () const;
197 bool references_dcp_audio () const;
198 bool contains_atmos_content () const;
200 void set_tolerant (bool t) {
204 bool tolerant () const {
208 bool last_written_by_earlier_than(int major, int minor, int micro) const;
210 /** Identifiers for the parts of our state; used for signalling changes */
211 enum class Property {
215 /** The playlist's content list has changed (i.e. content has been added or removed) */
217 /** The order of content in the playlist has changed */
227 /** The setting of _three_d has changed */
241 SIGN_LANGUAGE_VIDEO_LANGUAGE,
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 boost::optional<dcp::LanguageTag> sign_language_video_language () const {
359 return _sign_language_video_language;
362 int version_number () const {
363 return _version_number;
366 dcp::Status status () const {
370 boost::optional<std::string> chain () const {
374 boost::optional<std::string> distributor () const {
378 boost::optional<std::string> facility () const {
382 boost::optional<std::string> studio () const {
386 bool temp_version () const {
387 return _temp_version;
390 bool pre_release () const {
394 bool red_band () const {
398 bool two_d_version_of_three_d () const {
399 return _two_d_version_of_three_d;
402 boost::optional<dcp::Luminance> luminance () const {
406 boost::gregorian::date isdcf_date () const {
410 int audio_frame_rate () const {
411 return _audio_frame_rate;
416 void set_directory (boost::filesystem::path);
417 void set_name (std::string);
418 void set_use_isdcf_name (bool);
419 void examine_and_add_content (std::shared_ptr<Content> content, bool disable_audio_analysis = false);
420 void add_content (std::shared_ptr<Content>);
421 void remove_content (std::shared_ptr<Content>);
422 void remove_content (ContentList);
423 void move_content_earlier (std::shared_ptr<Content>);
424 void move_content_later (std::shared_ptr<Content>);
425 void set_dcp_content_type (DCPContentType const *);
426 void set_container (Ratio const *, bool user_explicit = true);
427 void set_resolution (Resolution, bool user_explicit = true);
428 void set_encrypted (bool);
429 void set_j2k_bandwidth (int);
430 void set_video_frame_rate (int rate, bool user_explicit = false);
431 void set_audio_channels (int);
432 void set_three_d (bool);
433 void set_isdcf_date_today ();
434 void set_sequence (bool);
435 void set_interop (bool);
436 void set_audio_processor (AudioProcessor const * processor);
437 void set_reel_type (ReelType);
438 void set_reel_length (int64_t);
439 void set_reencode_j2k (bool);
440 void set_marker (dcp::Marker type, dcpomatic::DCPTime time);
441 void unset_marker (dcp::Marker type);
442 void clear_markers ();
443 void set_ratings (std::vector<dcp::Rating> r);
444 void set_content_versions (std::vector<std::string> v);
445 void set_name_language (dcp::LanguageTag lang);
446 void set_release_territory (boost::optional<dcp::LanguageTag::RegionSubtag> region = boost::none);
447 void set_sign_language_video_language (boost::optional<dcp::LanguageTag> tag);
448 void set_version_number (int v);
449 void set_status (dcp::Status s);
450 void set_chain (boost::optional<std::string> c = boost::none);
451 void set_facility (boost::optional<std::string> f = boost::none);
452 void set_studio (boost::optional<std::string> s = boost::none);
453 void set_temp_version (bool t);
454 void set_pre_release (bool p);
455 void set_red_band (bool r);
456 void set_two_d_version_of_three_d (bool t);
457 void set_distributor (boost::optional<std::string> d = boost::none);
458 void set_luminance (boost::optional<dcp::Luminance> l = boost::none);
459 void set_audio_language (boost::optional<dcp::LanguageTag> language);
460 void set_audio_frame_rate (int rate);
462 void add_ffoc_lfoc (Markers& markers) const;
464 /** Emitted when some property has of the Film is about to change or has changed */
465 mutable boost::signals2::signal<void (ChangeType, Property)> Change;
467 /** Emitted when some property of our content has changed */
468 mutable boost::signals2::signal<void (ChangeType, std::weak_ptr<Content>, int, bool)> ContentChange;
470 /** Emitted when the film's length might have changed; this is not like a normal
471 property as its value is derived from the playlist, so it has its own signal.
473 mutable boost::signals2::signal<void ()> LengthChange;
475 boost::signals2::signal<void (bool)> DirtyChange;
477 /** Emitted when we have something important to tell the user */
478 boost::signals2::signal<void (std::string)> Message;
480 /** Current version number of the state file */
481 static int const current_state_version;
485 friend struct ::isdcf_name_test;
486 friend struct ::isdcf_name_with_atmos;
487 friend struct ::recover_test_2d_encrypted;
488 friend struct ::atmos_encrypted_passthrough_test;
489 template <class, class> friend class ChangeSignaller;
491 boost::filesystem::path info_file (dcpomatic::DCPTimePeriod p) const;
493 void signal_change (ChangeType, Property);
494 void signal_change (ChangeType, int);
495 std::string video_identifier () const;
496 void playlist_change (ChangeType);
497 void playlist_order_changed ();
498 void playlist_content_change (ChangeType type, std::weak_ptr<Content>, int, bool frequent);
499 void playlist_length_change ();
500 void maybe_add_content (std::weak_ptr<Job>, std::weak_ptr<Content>, bool disable_audio_analysis);
501 void audio_analysis_finished ();
502 void check_settings_consistency ();
503 void maybe_set_container_and_resolution ();
504 void set_dirty (bool dirty);
506 /** Log to write to */
507 std::shared_ptr<Log> _log;
508 std::shared_ptr<Playlist> _playlist;
510 /** Complete path to directory containing the film metadata;
511 * must not be relative.
513 boost::optional<boost::filesystem::path> _directory;
515 boost::optional<std::string> _last_written_by;
517 /** Name for DCP-o-matic */
519 /** True if a auto-generated ISDCF-compliant name should be used for our DCP */
520 bool _use_isdcf_name;
521 /** The type of content that this Film represents (feature, trailer etc.) */
522 DCPContentType const * _dcp_content_type;
523 /** The container to put this Film in (flat, scope, etc.) */
524 Ratio const * _container;
525 /** DCP resolution (2K or 4K) */
526 Resolution _resolution;
529 /** context ID used when encrypting picture assets; we keep it so that we can
530 * re-start picture MXF encodes.
532 std::string _context_id;
533 /** bandwidth for J2K files in bits per second */
535 /** Frames per second to run our DCP at */
536 int _video_frame_rate;
537 /** The date that we should use in a ISDCF name */
538 boost::gregorian::date _isdcf_date;
539 /** Number of audio channels requested for the DCP */
541 /** If true, the DCP will be written in 3D mode; otherwise in 2D.
542 This will be regardless of what content is on the playlist.
547 AudioProcessor const * _audio_processor;
549 /** Desired reel length in bytes, if _reel_type == REELTYPE_BY_LENGTH */
550 int64_t _reel_length;
552 /** true if the user has ever explicitly set the video frame rate of this film */
553 bool _user_explicit_video_frame_rate;
554 bool _user_explicit_container;
555 bool _user_explicit_resolution;
556 std::map<dcp::Marker, dcpomatic::DCPTime> _markers;
557 std::vector<dcp::Rating> _ratings;
558 std::vector<std::string> _content_versions;
559 dcp::LanguageTag _name_language;
560 boost::optional<dcp::LanguageTag::RegionSubtag> _release_territory;
561 boost::optional<dcp::LanguageTag> _sign_language_video_language;
564 boost::optional<std::string> _chain;
565 boost::optional<std::string> _distributor;
566 boost::optional<std::string> _facility;
567 boost::optional<std::string> _studio;
568 bool _temp_version = false;
569 bool _pre_release = false;
570 bool _red_band = false;
571 bool _two_d_version_of_three_d = false;
572 boost::optional<dcp::Luminance> _luminance;
573 boost::optional<dcp::LanguageTag> _audio_language;
574 int _audio_frame_rate = 48000;
578 /** true if our state has changed since we last saved it */
580 /** film being used as a template, or 0 */
581 std::shared_ptr<Film> _template_film;
583 /** Be tolerant of errors in content (currently applies to DCP only).
588 mutable boost::mutex _info_file_mutex;
590 boost::signals2::scoped_connection _playlist_change_connection;
591 boost::signals2::scoped_connection _playlist_order_changed_connection;
592 boost::signals2::scoped_connection _playlist_content_change_connection;
593 boost::signals2::scoped_connection _playlist_length_change_connection;
594 std::list<boost::signals2::connection> _job_connections;
595 std::list<boost::signals2::connection> _audio_analysis_connections;
597 friend struct paths_test;
598 friend struct film_metadata_test;
602 typedef ChangeSignaller<Film, Film::Property> FilmChangeSignaller;