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, public boost::noncopyable
99 explicit Film (boost::optional<boost::filesystem::path> dir);
102 std::shared_ptr<InfoFileHandle> info_file_handle (dcpomatic::DCPTimePeriod period, bool read) const;
103 boost::filesystem::path j2c_path (int, Frame, Eyes, bool) const;
104 boost::filesystem::path internal_video_asset_dir () const;
105 boost::filesystem::path internal_video_asset_filename (dcpomatic::DCPTimePeriod p) const;
107 boost::filesystem::path audio_analysis_path (std::shared_ptr<const Playlist>) const;
108 boost::filesystem::path subtitle_analysis_path (std::shared_ptr<const Content>) const;
110 void send_dcp_to_tms ();
111 void make_dcp (bool gui = false, bool check = true);
114 * It is safe to call this from any thread.
116 std::shared_ptr<Log> log () const {
120 boost::filesystem::path file (boost::filesystem::path f) const;
121 boost::filesystem::path dir (boost::filesystem::path d, bool create = true) const;
123 void use_template (std::string name);
124 std::list<std::string> read_metadata (boost::optional<boost::filesystem::path> path = boost::optional<boost::filesystem::path> ());
125 void write_metadata () const;
126 void write_metadata (boost::filesystem::path path) const;
127 void write_template (boost::filesystem::path path) const;
128 std::shared_ptr<xmlpp::Document> metadata (bool with_content_paths = true) const;
130 void copy_from (std::shared_ptr<const Film> film);
132 std::string isdcf_name (bool if_created_now) const;
133 std::string dcp_name (bool if_created_now = false) const;
135 /** @return true if our state has changed since we last saved it */
136 bool dirty () const {
140 dcp::Size full_frame () const;
141 dcp::Size frame_size () const;
142 dcp::Size active_area () const;
144 std::vector<CPLSummary> cpls () const;
146 int audio_frame_rate () const;
148 std::list<DCPTextTrack> closed_caption_tracks () const;
150 uint64_t required_disk_space () const;
151 bool should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const;
153 /* Proxies for some Playlist methods */
155 ContentList content () const;
156 dcpomatic::DCPTime length () const;
157 int best_video_frame_rate () const;
158 FrameRateChange active_frame_rate_change (dcpomatic::DCPTime) const;
159 std::pair<double, double> speed_up_range (int dcp_frame_rate) const;
161 dcp::EncryptedKDM make_kdm (
162 dcp::Certificate recipient,
163 std::vector<std::string> trusted_devices,
164 boost::filesystem::path cpl_file,
166 dcp::LocalTime until,
167 dcp::Formulation formulation,
168 bool disable_forensic_marking_picture,
169 boost::optional<int> disable_forensic_marking_audio
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;
186 std::vector<dcp::LanguageTag> audio_languages () const;
187 std::pair<boost::optional<dcp::LanguageTag>, std::vector<dcp::LanguageTag>> subtitle_languages () const;
189 std::string content_summary (dcpomatic::DCPTimePeriod period) const;
191 bool references_dcp_video () const;
192 bool references_dcp_audio () const;
193 bool contains_atmos_content () const;
195 void set_tolerant (bool t) {
199 bool tolerant () const {
203 /** Identifiers for the parts of our state;
204 used for signalling changes.
206 enum class Property {
210 /** The playlist's content list has changed (i.e. content has been added or removed) */
212 /** The order of content in the playlist has changed */
221 /** The setting of _three_d has changed */
244 TWO_D_VERSION_OF_THREE_D,
251 boost::optional<boost::filesystem::path> directory () const {
255 std::string name () const {
259 bool use_isdcf_name () const {
260 return _use_isdcf_name;
263 DCPContentType const * dcp_content_type () const {
264 return _dcp_content_type;
267 Ratio const * container () const {
271 Resolution resolution () const {
275 bool encrypted () const {
279 dcp::Key key () const {
283 int j2k_bandwidth () const {
284 return _j2k_bandwidth;
287 /** @return The frame rate of the DCP */
288 int video_frame_rate () const {
289 return _video_frame_rate;
292 int audio_channels () const {
293 return _audio_channels;
296 bool three_d () const {
300 bool sequence () const {
304 bool interop () const {
308 AudioProcessor const * audio_processor () const {
309 return _audio_processor;
312 ReelType reel_type () const {
316 int64_t reel_length () const {
320 std::string context_id () const {
324 bool reencode_j2k () const {
325 return _reencode_j2k;
328 typedef std::map<dcp::Marker, dcpomatic::DCPTime> Markers;
330 boost::optional<dcpomatic::DCPTime> marker (dcp::Marker type) const;
331 Markers markers () const {
335 std::vector<dcp::Rating> ratings () const {
339 std::vector<std::string> content_versions () const {
340 return _content_versions;
343 dcp::LanguageTag name_language () const {
344 return _name_language;
347 boost::optional<dcp::LanguageTag::RegionSubtag> release_territory () const {
348 return _release_territory;
351 int version_number () const {
352 return _version_number;
355 dcp::Status status () const {
359 boost::optional<std::string> chain () const {
363 boost::optional<std::string> distributor () const {
367 boost::optional<std::string> facility () const {
371 boost::optional<std::string> studio () const {
375 bool temp_version () const {
376 return _temp_version;
379 bool pre_release () const {
383 bool red_band () const {
387 bool two_d_version_of_three_d () const {
388 return _two_d_version_of_three_d;
391 boost::optional<dcp::Luminance> luminance () const {
397 void set_directory (boost::filesystem::path);
398 void set_name (std::string);
399 void set_use_isdcf_name (bool);
400 void examine_and_add_content (std::shared_ptr<Content> content, bool disable_audio_analysis = false);
401 void add_content (std::shared_ptr<Content>);
402 void remove_content (std::shared_ptr<Content>);
403 void remove_content (ContentList);
404 void move_content_earlier (std::shared_ptr<Content>);
405 void move_content_later (std::shared_ptr<Content>);
406 void set_dcp_content_type (DCPContentType const *);
407 void set_container (Ratio const *, bool user_explicit = true);
408 void set_resolution (Resolution, bool user_explicit = true);
409 void set_encrypted (bool);
410 void set_j2k_bandwidth (int);
411 void set_video_frame_rate (int rate, bool user_explicit = false);
412 void set_audio_channels (int);
413 void set_three_d (bool);
414 void set_isdcf_date_today ();
415 void set_sequence (bool);
416 void set_interop (bool);
417 void set_audio_processor (AudioProcessor const * processor);
418 void set_reel_type (ReelType);
419 void set_reel_length (int64_t);
420 void set_reencode_j2k (bool);
421 void set_marker (dcp::Marker type, dcpomatic::DCPTime time);
422 void unset_marker (dcp::Marker type);
423 void clear_markers ();
424 void set_ratings (std::vector<dcp::Rating> r);
425 void set_content_versions (std::vector<std::string> v);
426 void set_name_language (dcp::LanguageTag lang);
427 void set_release_territory (boost::optional<dcp::LanguageTag::RegionSubtag> region = boost::none);
428 void set_version_number (int v);
429 void set_status (dcp::Status s);
430 void set_chain (boost::optional<std::string> c = boost::none);
431 void set_facility (boost::optional<std::string> f = boost::none);
432 void set_studio (boost::optional<std::string> s = boost::none);
433 void set_temp_version (bool t);
434 void set_pre_release (bool p);
435 void set_red_band (bool r);
436 void set_two_d_version_of_three_d (bool t);
437 void set_distributor (boost::optional<std::string> d = boost::none);
438 void set_luminance (boost::optional<dcp::Luminance> l = boost::none);
440 void add_ffoc_lfoc (Markers& markers) const;
442 /** Emitted when some property has of the Film is about to change or has changed */
443 mutable boost::signals2::signal<void (ChangeType, Property)> Change;
445 /** Emitted when some property of our content has changed */
446 mutable boost::signals2::signal<void (ChangeType, std::weak_ptr<Content>, int, bool)> ContentChange;
448 /** Emitted when the film's length might have changed; this is not like a normal
449 property as its value is derived from the playlist, so it has its own signal.
451 mutable boost::signals2::signal<void ()> LengthChange;
453 /** Emitted when we have something important to tell the user */
454 boost::signals2::signal<void (std::string)> Message;
456 /** Current version number of the state file */
457 static int const current_state_version;
461 friend struct ::isdcf_name_test;
462 friend struct ::recover_test_2d_encrypted;
463 friend struct ::atmos_encrypted_passthrough_test;
464 template <class, class> friend class ChangeSignaller;
466 boost::filesystem::path info_file (dcpomatic::DCPTimePeriod p) const;
468 void signal_change (ChangeType, Property);
469 void signal_change (ChangeType, int);
470 std::string video_identifier () const;
471 void playlist_change (ChangeType);
472 void playlist_order_changed ();
473 void playlist_content_change (ChangeType type, std::weak_ptr<Content>, int, bool frequent);
474 void playlist_length_change ();
475 void maybe_add_content (std::weak_ptr<Job>, std::weak_ptr<Content>, bool disable_audio_analysis);
476 void audio_analysis_finished ();
477 void check_settings_consistency ();
478 void maybe_set_container_and_resolution ();
480 static std::string const metadata_file;
482 /** Log to write to */
483 std::shared_ptr<Log> _log;
484 std::shared_ptr<Playlist> _playlist;
486 /** Complete path to directory containing the film metadata;
487 * must not be relative.
489 boost::optional<boost::filesystem::path> _directory;
491 /** Name for DCP-o-matic */
493 /** True if a auto-generated ISDCF-compliant name should be used for our DCP */
494 bool _use_isdcf_name;
495 /** The type of content that this Film represents (feature, trailer etc.) */
496 DCPContentType const * _dcp_content_type;
497 /** The container to put this Film in (flat, scope, etc.) */
498 Ratio const * _container;
499 /** DCP resolution (2K or 4K) */
500 Resolution _resolution;
503 /** context ID used when encrypting picture assets; we keep it so that we can
504 * re-start picture MXF encodes.
506 std::string _context_id;
507 /** bandwidth for J2K files in bits per second */
509 /** Frames per second to run our DCP at */
510 int _video_frame_rate;
511 /** The date that we should use in a ISDCF name */
512 boost::gregorian::date _isdcf_date;
513 /** Number of audio channels requested for the DCP */
515 /** If true, the DCP will be written in 3D mode; otherwise in 2D.
516 This will be regardless of what content is on the playlist.
521 AudioProcessor const * _audio_processor;
523 /** Desired reel length in bytes, if _reel_type == REELTYPE_BY_LENGTH */
524 int64_t _reel_length;
526 /** true if the user has ever explicitly set the video frame rate of this film */
527 bool _user_explicit_video_frame_rate;
528 bool _user_explicit_container;
529 bool _user_explicit_resolution;
530 std::map<dcp::Marker, dcpomatic::DCPTime> _markers;
531 std::vector<dcp::Rating> _ratings;
532 std::vector<std::string> _content_versions;
533 dcp::LanguageTag _name_language;
534 boost::optional<dcp::LanguageTag::RegionSubtag> _release_territory;
537 boost::optional<std::string> _chain;
538 boost::optional<std::string> _distributor;
539 boost::optional<std::string> _facility;
540 boost::optional<std::string> _studio;
541 bool _temp_version = false;
542 bool _pre_release = false;
543 bool _red_band = false;
544 bool _two_d_version_of_three_d = false;
545 boost::optional<dcp::Luminance> _luminance;
549 /** true if our state has changed since we last saved it */
551 /** film being used as a template, or 0 */
552 std::shared_ptr<Film> _template_film;
554 /** Be tolerant of errors in content (currently applies to DCP only).
559 mutable boost::mutex _info_file_mutex;
561 boost::signals2::scoped_connection _playlist_change_connection;
562 boost::signals2::scoped_connection _playlist_order_changed_connection;
563 boost::signals2::scoped_connection _playlist_content_change_connection;
564 boost::signals2::scoped_connection _playlist_length_change_connection;
565 std::list<boost::signals2::connection> _job_connections;
566 std::list<boost::signals2::connection> _audio_analysis_connections;
568 friend struct paths_test;
569 friend struct film_metadata_test;
573 typedef ChangeSignaller<Film, Film::Property> FilmChangeSignaller;