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 "film_property.h"
36 #include "frame_rate_change.h"
37 #include "named_channel.h"
38 #include "resolution.h"
39 #include "signaller.h"
40 #include "territory_type.h"
41 #include "transcode_job.h"
44 #include <dcp/encrypted_kdm.h>
47 #include <dcp/language_tag.h>
48 #include <dcp/rating.h>
49 #include <dcp/types.h>
50 #include <boost/filesystem.hpp>
51 #include <boost/signals2.hpp>
52 #include <boost/thread.hpp>
53 #include <boost/thread/mutex.hpp>
76 struct atmos_encrypted_passthrough_test;
77 struct isdcf_name_test;
78 struct isdcf_name_with_atmos;
79 struct isdcf_name_with_ccap;
80 struct ov_subs_in_vf_name;
81 struct recover_test_2d_encrypted;
87 InfoFileHandle (boost::mutex& mutex, boost::filesystem::path file, bool read);
96 boost::mutex::scoped_lock _lock;
103 * @brief A representation of some audio, video, subtitle and closed-caption content,
104 * and details of how they should be presented in a DCP.
106 * The content of a Film is held in a Playlist (created and managed by the Film).
108 class Film : public std::enable_shared_from_this<Film>, public Signaller
111 explicit Film (boost::optional<boost::filesystem::path> dir);
114 Film (Film const&) = delete;
115 Film& operator= (Film const&) = delete;
117 std::shared_ptr<InfoFileHandle> info_file_handle (dcpomatic::DCPTimePeriod period, bool read) const;
118 boost::filesystem::path j2c_path (int, Frame, Eyes, bool) const;
119 boost::filesystem::path internal_video_asset_dir () const;
120 boost::filesystem::path internal_video_asset_filename (dcpomatic::DCPTimePeriod p) const;
122 boost::filesystem::path audio_analysis_path (std::shared_ptr<const Playlist>) const;
123 boost::filesystem::path subtitle_analysis_path (std::shared_ptr<const Content>) const;
125 void send_dcp_to_tms ();
128 * It is safe to call this from any thread.
130 std::shared_ptr<Log> log () const {
134 boost::filesystem::path file (boost::filesystem::path f) const;
135 boost::filesystem::path dir (boost::filesystem::path d, bool create = true) const;
137 void use_template (std::string name);
138 std::list<std::string> read_metadata (boost::optional<boost::filesystem::path> path = boost::optional<boost::filesystem::path> ());
139 void write_metadata ();
140 void write_metadata (boost::filesystem::path path) const;
141 void write_template (boost::filesystem::path path) const;
142 std::shared_ptr<xmlpp::Document> metadata (bool with_content_paths = true) const;
144 void copy_from (std::shared_ptr<const Film> film);
146 std::string isdcf_name (bool if_created_now) const;
147 std::string dcp_name (bool if_created_now = false) const;
149 /** @return true if our state has changed since we last saved it */
150 bool dirty () const {
154 dcp::Size full_frame () const;
155 dcp::Size frame_size () const;
156 dcp::Size active_area () const;
158 std::vector<CPLSummary> cpls () const;
160 std::list<DCPTextTrack> closed_caption_tracks () const;
162 uint64_t required_disk_space () const;
163 bool should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const;
165 bool has_sign_language_video_channel () const;
167 /* Proxies for some Playlist methods */
169 ContentList content () const;
170 dcpomatic::DCPTime length () const;
171 int best_video_frame_rate () const;
172 FrameRateChange active_frame_rate_change (dcpomatic::DCPTime) const;
173 std::pair<double, double> speed_up_range (int dcp_frame_rate) const;
175 dcp::DecryptedKDM make_kdm(boost::filesystem::path cpl_file, dcp::LocalTime from, dcp::LocalTime until) const;
177 int state_version () const {
178 return _state_version;
181 std::vector<NamedChannel> audio_output_names () const;
183 void repeat_content (ContentList, int);
185 std::shared_ptr<const Playlist> playlist () const {
189 std::vector<dcpomatic::DCPTimePeriod> reels() const;
190 std::list<int> mapped_audio_channels () const;
192 boost::optional<dcp::LanguageTag> audio_language () const {
193 return _audio_language;
196 /** @param burnt_in If non-null, filled with true if all subtitles are burnt in, otherwise false.
197 * @return pair containing the main subtitle language, and additional languages
199 std::pair<boost::optional<dcp::LanguageTag>, std::vector<dcp::LanguageTag>> subtitle_languages(bool* burnt_in = nullptr) const;
200 /** @return all closed caption languages in the film */
201 std::vector<dcp::LanguageTag> closed_caption_languages() const;
203 std::string content_summary (dcpomatic::DCPTimePeriod period) const;
205 bool references_dcp_video () const;
206 bool references_dcp_audio () const;
207 bool contains_atmos_content () const;
209 void set_tolerant (bool t) {
213 bool tolerant () const {
217 bool last_written_by_earlier_than(int major, int minor, int micro) const;
221 boost::optional<boost::filesystem::path> directory () const {
225 std::string name () const {
229 bool use_isdcf_name () const {
230 return _use_isdcf_name;
233 DCPContentType const * dcp_content_type () const {
234 return _dcp_content_type;
237 Ratio const * container () const {
241 Resolution resolution () const {
245 bool encrypted () const {
249 dcp::Key key () const {
253 int j2k_bandwidth () const {
254 return _j2k_bandwidth;
257 /** @return The frame rate of the DCP */
258 int video_frame_rate () const {
259 return _video_frame_rate;
262 int audio_channels () const {
263 return _audio_channels;
266 bool three_d () const {
270 bool sequence () const {
274 bool interop () const {
278 bool limit_to_smpte_bv20() const {
279 return _limit_to_smpte_bv20;
282 AudioProcessor const * audio_processor () const {
283 return _audio_processor;
286 ReelType reel_type () const {
290 int64_t reel_length () const {
294 std::vector<dcpomatic::DCPTime> custom_reel_boundaries() const {
295 return _custom_reel_boundaries;
298 std::string context_id () const {
302 bool reencode_j2k () const {
303 return _reencode_j2k;
306 typedef std::map<dcp::Marker, dcpomatic::DCPTime> Markers;
308 boost::optional<dcpomatic::DCPTime> marker (dcp::Marker type) const;
309 Markers markers () const {
313 std::vector<dcp::Rating> ratings () const {
317 std::vector<std::string> content_versions () const {
318 return _content_versions;
321 dcp::LanguageTag name_language () const {
322 return _name_language;
325 TerritoryType territory_type() const {
326 return _territory_type;
329 boost::optional<dcp::LanguageTag::RegionSubtag> release_territory () const {
330 return _release_territory;
333 boost::optional<dcp::LanguageTag> sign_language_video_language () const {
334 return _sign_language_video_language;
337 int version_number () const {
338 return _version_number;
341 dcp::Status status () const {
345 boost::optional<std::string> chain () const {
349 boost::optional<std::string> distributor () const {
353 boost::optional<std::string> facility () const {
357 boost::optional<std::string> studio () const {
361 bool temp_version () const {
362 return _temp_version;
365 bool pre_release () const {
369 bool red_band () const {
373 bool two_d_version_of_three_d () const {
374 return _two_d_version_of_three_d;
377 boost::optional<dcp::Luminance> luminance () const {
381 boost::gregorian::date isdcf_date () const {
385 int audio_frame_rate () const {
386 return _audio_frame_rate;
391 void set_directory (boost::filesystem::path);
392 void set_name (std::string);
393 void set_use_isdcf_name (bool);
394 void examine_and_add_content (std::shared_ptr<Content> content, bool disable_audio_analysis = false);
395 void add_content (std::shared_ptr<Content>);
396 void remove_content (std::shared_ptr<Content>);
397 void remove_content (ContentList);
398 void move_content_earlier (std::shared_ptr<Content>);
399 void move_content_later (std::shared_ptr<Content>);
400 void set_dcp_content_type (DCPContentType const *);
401 void set_container (Ratio const *, bool user_explicit = true);
402 void set_resolution (Resolution, bool user_explicit = true);
403 void set_encrypted (bool);
404 void set_j2k_bandwidth (int);
405 void set_video_frame_rate (int rate, bool user_explicit = false);
406 void set_audio_channels (int);
407 void set_three_d (bool);
408 void set_isdcf_date_today ();
409 void set_sequence (bool);
410 void set_interop (bool);
411 void set_limit_to_smpte_bv20(bool);
412 void set_audio_processor (AudioProcessor const * processor);
413 void set_reel_type (ReelType);
414 void set_reel_length (int64_t);
415 void set_custom_reel_boundaries(std::vector<dcpomatic::DCPTime> boundaries);
416 void set_reencode_j2k (bool);
417 void set_marker (dcp::Marker type, dcpomatic::DCPTime time);
418 void unset_marker (dcp::Marker type);
419 void clear_markers ();
420 void set_ratings (std::vector<dcp::Rating> r);
421 void set_content_versions (std::vector<std::string> v);
422 void set_name_language (dcp::LanguageTag lang);
423 void set_territory_type(TerritoryType type);
424 void set_release_territory (boost::optional<dcp::LanguageTag::RegionSubtag> region = boost::none);
425 void set_sign_language_video_language (boost::optional<dcp::LanguageTag> tag);
426 void set_version_number (int v);
427 void set_status (dcp::Status s);
428 void set_chain (boost::optional<std::string> c = boost::none);
429 void set_facility (boost::optional<std::string> f = boost::none);
430 void set_studio (boost::optional<std::string> s = boost::none);
431 void set_temp_version (bool t);
432 void set_pre_release (bool p);
433 void set_red_band (bool r);
434 void set_two_d_version_of_three_d (bool t);
435 void set_distributor (boost::optional<std::string> d = boost::none);
436 void set_luminance (boost::optional<dcp::Luminance> l = boost::none);
437 void set_audio_language (boost::optional<dcp::LanguageTag> language);
438 void set_audio_frame_rate (int rate);
440 void add_ffoc_lfoc (Markers& markers) const;
442 void set_ui_state(std::string key, std::string value);
443 boost::optional<std::string> ui_state(std::string key) const;
444 void read_ui_state();
446 /** Emitted when some property has of the Film is about to change or has changed */
447 mutable boost::signals2::signal<void (ChangeType, FilmProperty)> Change;
449 /** Emitted when some property of our content has changed */
450 mutable boost::signals2::signal<void (ChangeType, std::weak_ptr<Content>, int, bool)> ContentChange;
452 /** Emitted when the film's length might have changed; this is not like a normal
453 property as its value is derived from the playlist, so it has its own signal.
455 mutable boost::signals2::signal<void ()> LengthChange;
457 boost::signals2::signal<void (bool)> DirtyChange;
459 /** Emitted when we have something important to tell the user */
460 boost::signals2::signal<void (std::string)> Message;
462 /** Current version number of the state file */
463 static int const current_state_version;
467 friend struct ::isdcf_name_test;
468 friend struct ::isdcf_name_with_atmos;
469 friend struct ::isdcf_name_with_ccap;
470 friend struct ::recover_test_2d_encrypted;
471 friend struct ::atmos_encrypted_passthrough_test;
472 friend struct ::ov_subs_in_vf_name;
473 template <class, class> friend class ChangeSignalDespatcher;
475 boost::filesystem::path info_file (dcpomatic::DCPTimePeriod p) const;
477 void signal_change (ChangeType, FilmProperty);
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 ();
488 void set_dirty (bool dirty);
489 void write_ui_state() const;
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 boost::optional<std::string> _last_written_by;
502 /** Name for DCP-o-matic */
504 /** True if a auto-generated ISDCF-compliant name should be used for our DCP */
505 bool _use_isdcf_name;
506 /** The type of content that this Film represents (feature, trailer etc.) */
507 DCPContentType const * _dcp_content_type;
508 /** The container to put this Film in (flat, scope, etc.) */
509 Ratio const * _container;
510 /** DCP resolution (2K or 4K) */
511 Resolution _resolution;
514 /** context ID used when encrypting picture assets; we keep it so that we can
515 * re-start picture MXF encodes.
517 std::string _context_id;
518 /** bandwidth for J2K files in bits per second */
520 /** Frames per second to run our DCP at */
521 int _video_frame_rate;
522 /** The date that we should use in a ISDCF name */
523 boost::gregorian::date _isdcf_date;
524 /** Number of audio channels requested for the DCP */
526 /** If true, the DCP will be written in 3D mode; otherwise in 2D.
527 This will be regardless of what content is on the playlist.
532 bool _limit_to_smpte_bv20;
533 AudioProcessor const * _audio_processor;
535 /** Desired reel length in bytes, if _reel_type == BY_LENGTH */
536 int64_t _reel_length;
537 /** Reel boundaries (excluding those at the start and end, sorted in ascending order) if _reel_type == CUSTOM */
538 std::vector<dcpomatic::DCPTime> _custom_reel_boundaries;
540 /** true if the user has ever explicitly set the video frame rate of this film */
541 bool _user_explicit_video_frame_rate;
542 bool _user_explicit_container;
543 bool _user_explicit_resolution;
544 std::map<dcp::Marker, dcpomatic::DCPTime> _markers;
545 std::vector<dcp::Rating> _ratings;
546 std::vector<std::string> _content_versions;
547 dcp::LanguageTag _name_language;
548 TerritoryType _territory_type = TerritoryType::SPECIFIC;
549 boost::optional<dcp::LanguageTag::RegionSubtag> _release_territory;
550 boost::optional<dcp::LanguageTag> _sign_language_video_language;
553 boost::optional<std::string> _chain;
554 boost::optional<std::string> _distributor;
555 boost::optional<std::string> _facility;
556 boost::optional<std::string> _studio;
557 bool _temp_version = false;
558 bool _pre_release = false;
559 bool _red_band = false;
560 bool _two_d_version_of_three_d = false;
561 boost::optional<dcp::Luminance> _luminance;
562 boost::optional<dcp::LanguageTag> _audio_language;
563 int _audio_frame_rate = 48000;
567 /** true if our state has changed since we last saved it */
569 /** film being used as a template, or 0 */
570 std::shared_ptr<Film> _template_film;
572 /** Be tolerant of errors in content (currently applies to DCP only).
577 std::map<std::string, std::string> _ui_state;
579 mutable boost::mutex _info_file_mutex;
581 boost::signals2::scoped_connection _playlist_change_connection;
582 boost::signals2::scoped_connection _playlist_order_changed_connection;
583 boost::signals2::scoped_connection _playlist_content_change_connection;
584 boost::signals2::scoped_connection _playlist_length_change_connection;
585 std::list<boost::signals2::connection> _job_connections;
586 std::list<boost::signals2::connection> _audio_analysis_connections;
588 friend struct paths_test;
589 friend struct film_metadata_test;
593 typedef ChangeSignaller<Film, FilmProperty> FilmChangeSignaller;