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, video and subtitle content, and details of
24 * how they should be presented in a DCP.
28 #include "atmos_content.h"
29 #include "audio_content.h"
30 #include "audio_processor.h"
31 #include "change_signaller.h"
33 #include "compose.hpp"
35 #include "constants.h"
37 #include "dcp_content.h"
38 #include "dcp_content_type.h"
39 #include "dcp_encoder.h"
40 #include "dcpomatic_log.h"
42 #include "environment_info.h"
43 #include "examine_content_job.h"
44 #include "exceptions.h"
45 #include "ffmpeg_content.h"
46 #include "ffmpeg_subtitle_stream.h"
51 #include "job_manager.h"
52 #include "kdm_with_metadata.h"
57 #include "text_content.h"
58 #include "transcode_job.h"
59 #include "upload_job.h"
60 #include "video_content.h"
62 #include <libcxml/cxml.h>
63 #include <dcp/certificate_chain.h>
65 #include <dcp/decrypted_kdm.h>
66 #include <dcp/filesystem.h>
67 #include <dcp/local_time.h>
68 #include <dcp/raw_convert.h>
69 #include <dcp/reel_asset.h>
70 #include <dcp/reel_file_asset.h>
72 #include <libxml++/libxml++.h>
73 #include <boost/algorithm/string.hpp>
74 #include <boost/filesystem.hpp>
75 #include <boost/regex.hpp>
87 using std::back_inserter;
90 using std::dynamic_pointer_cast;
95 using std::make_shared;
100 using std::runtime_error;
103 using std::shared_ptr;
107 using boost::optional;
108 using boost::is_any_of;
109 #if BOOST_VERSION >= 106100
110 using namespace boost::placeholders;
112 using dcp::raw_convert;
113 using namespace dcpomatic;
116 static constexpr char metadata_file[] = "metadata.xml";
117 static constexpr char ui_state_file[] = "ui.xml";
121 * AudioMapping XML changed.
123 * Subtitle offset changed to subtitle y offset, and subtitle x offset added.
125 * Use <Scale> tag in <VideoContent> rather than <Ratio>.
129 * Subtitle X and Y scale.
131 * Bumped to 32 for 2.0 branch; some times are expressed in Times rather
135 * Changed <Period> to <Subtitle> in FFmpegSubtitleStream
137 * Content only contains audio/subtitle-related tags if those things
140 * VideoFrameType in VideoContent is a string rather than an integer.
142 * EffectColour rather than OutlineColour in Subtitle.
144 * TextContent can be in a Caption tag, and some of the tag names
145 * have had Subtitle prefixes or suffixes removed.
147 * VideoContent scale expressed just as "guess" or "custom"
149 int const Film::current_state_version = 38;
152 /** Construct a Film object in a given directory.
154 * @param dir Film directory.
157 Film::Film (optional<boost::filesystem::path> dir)
158 : _playlist (new Playlist)
159 , _use_isdcf_name (Config::instance()->use_isdcf_name_by_default())
160 , _dcp_content_type (Config::instance()->default_dcp_content_type ())
161 , _container(Ratio::from_id("185"))
162 , _resolution (Resolution::TWO_K)
164 , _context_id (dcp::make_uuid ())
165 , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
166 , _video_frame_rate (24)
167 , _audio_channels (Config::instance()->default_dcp_audio_channels ())
170 , _interop (Config::instance()->default_interop ())
171 , _limit_to_smpte_bv20(false)
172 , _audio_processor (0)
173 , _reel_type (ReelType::SINGLE)
174 , _reel_length (2000000000)
175 , _reencode_j2k (false)
176 , _user_explicit_video_frame_rate (false)
177 , _user_explicit_container (false)
178 , _user_explicit_resolution (false)
179 , _name_language (dcp::LanguageTag("en-US"))
180 , _release_territory(Config::instance()->default_territory())
181 , _version_number (1)
182 , _status (dcp::Status::FINAL)
183 , _audio_language(Config::instance()->default_audio_language())
184 , _state_version (current_state_version)
188 set_isdcf_date_today ();
190 auto metadata = Config::instance()->default_metadata();
191 if (metadata.find("chain") != metadata.end()) {
192 _chain = metadata["chain"];
194 if (metadata.find("distributor") != metadata.end()) {
195 _distributor = metadata["distributor"];
197 if (metadata.find("facility") != metadata.end()) {
198 _facility = metadata["facility"];
200 if (metadata.find("studio") != metadata.end()) {
201 _studio = metadata["studio"];
204 _playlist_change_connection = _playlist->Change.connect (bind (&Film::playlist_change, this, _1));
205 _playlist_order_changed_connection = _playlist->OrderChange.connect (bind (&Film::playlist_order_changed, this));
206 _playlist_content_change_connection = _playlist->ContentChange.connect (bind (&Film::playlist_content_change, this, _1, _2, _3, _4));
207 _playlist_length_change_connection = _playlist->LengthChange.connect (bind(&Film::playlist_length_change, this));
210 set_directory(dcp::filesystem::weakly_canonical(*dir));
214 _log = make_shared<FileLog>(file("log"));
216 _log = make_shared<NullLog>();
219 _playlist->set_sequence (_sequence);
224 for (auto& i: _job_connections) {
228 for (auto& i: _audio_analysis_connections) {
234 Film::video_identifier () const
236 DCPOMATIC_ASSERT (container ());
238 string s = container()->id()
239 + "_" + resolution_to_string (_resolution)
240 + "_" + _playlist->video_identifier()
241 + "_" + raw_convert<string>(_video_frame_rate)
242 + "_" + raw_convert<string>(j2k_bandwidth());
245 /* This is insecure but hey, the key is in plaintext in metadata.xml */
246 s += "_E" + _key.hex();
255 if (_limit_to_smpte_bv20) {
273 /** @return The file to write video frame info to */
274 boost::filesystem::path
275 Film::info_file (DCPTimePeriod period) const
277 boost::filesystem::path p;
279 p /= video_identifier () + "_" + raw_convert<string> (period.from.get()) + "_" + raw_convert<string> (period.to.get());
283 boost::filesystem::path
284 Film::internal_video_asset_dir () const
286 return dir ("video");
289 boost::filesystem::path
290 Film::internal_video_asset_filename (DCPTimePeriod p) const
292 return video_identifier() + "_" + raw_convert<string> (p.from.get()) + "_" + raw_convert<string> (p.to.get()) + ".mxf";
295 boost::filesystem::path
296 Film::audio_analysis_path (shared_ptr<const Playlist> playlist) const
298 auto p = dir ("analysis");
301 for (auto content: playlist->content()) {
302 if (!content->audio) {
306 digester.add(content->digest());
307 digester.add(content->audio->mapping().digest());
308 if (playlist->content().size() != 1) {
309 /* Analyses should be considered equal regardless of gain
310 if they were made from just one piece of content. This
311 is because we can fake any gain change in a single-content
312 analysis at the plotting stage rather than having to
315 digester.add(content->audio->gain());
317 /* Likewise we only care about position if we're looking at a
318 * whole-project view.
320 digester.add(content->position().get());
321 digester.add(content->trim_start().get());
322 digester.add(content->trim_end().get());
326 if (audio_processor ()) {
327 digester.add (audio_processor()->id ());
330 digester.add (audio_channels());
332 p /= digester.get ();
337 boost::filesystem::path
338 Film::subtitle_analysis_path (shared_ptr<const Content> content) const
340 auto p = dir ("analysis");
343 digester.add (content->digest());
344 digester.add(_interop ? "1" : "0");
346 if (!content->text.empty()) {
347 auto tc = content->text.front();
348 digester.add (tc->x_scale());
349 digester.add (tc->y_scale());
350 for (auto i: tc->fonts()) {
351 digester.add (i->id());
354 digester.add (tc->effect().get());
356 digester.add (tc->line_spacing());
357 digester.add (tc->outline_width());
360 auto fc = dynamic_pointer_cast<const FFmpegContent>(content);
362 digester.add (fc->subtitle_stream()->identifier());
365 p /= digester.get ();
370 /** Start a job to send our DCP to the configured TMS */
372 Film::send_dcp_to_tms ()
374 JobManager::instance()->add(make_shared<UploadJob>(shared_from_this()));
377 shared_ptr<xmlpp::Document>
378 Film::metadata (bool with_content_paths) const
380 auto doc = make_shared<xmlpp::Document>();
381 auto root = doc->create_root_node ("Metadata");
383 root->add_child("Version")->add_child_text (raw_convert<string> (current_state_version));
384 auto last_write = root->add_child("LastWrittenBy");
385 last_write->add_child_text (dcpomatic_version);
386 last_write->set_attribute("git", dcpomatic_git_commit);
387 root->add_child("Name")->add_child_text (_name);
388 root->add_child("UseISDCFName")->add_child_text (_use_isdcf_name ? "1" : "0");
390 if (_dcp_content_type) {
391 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->isdcf_name ());
395 root->add_child("Container")->add_child_text (_container->id ());
398 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
399 root->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
400 root->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
401 root->add_child("AudioFrameRate")->add_child_text(raw_convert<string>(_audio_frame_rate));
402 root->add_child("ISDCFDate")->add_child_text (boost::gregorian::to_iso_string (_isdcf_date));
403 root->add_child("AudioChannels")->add_child_text (raw_convert<string> (_audio_channels));
404 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
405 root->add_child("Sequence")->add_child_text (_sequence ? "1" : "0");
406 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
407 root->add_child("LimitToSMPTEBv20")->add_child_text(_limit_to_smpte_bv20 ? "1" : "0");
408 root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
409 root->add_child("Key")->add_child_text (_key.hex ());
410 root->add_child("ContextID")->add_child_text (_context_id);
411 if (_audio_processor) {
412 root->add_child("AudioProcessor")->add_child_text (_audio_processor->id ());
414 root->add_child("ReelType")->add_child_text (raw_convert<string> (static_cast<int> (_reel_type)));
415 root->add_child("ReelLength")->add_child_text (raw_convert<string> (_reel_length));
416 for (auto boundary: _custom_reel_boundaries) {
417 root->add_child("CustomReelBoundary")->add_child_text(raw_convert<string>(boundary.get()));
419 root->add_child("ReencodeJ2K")->add_child_text (_reencode_j2k ? "1" : "0");
420 root->add_child("UserExplicitVideoFrameRate")->add_child_text(_user_explicit_video_frame_rate ? "1" : "0");
421 for (auto const& marker: _markers) {
422 auto m = root->add_child("Marker");
423 m->set_attribute("type", dcp::marker_to_string(marker.first));
424 m->add_child_text(raw_convert<string>(marker.second.get()));
426 for (auto i: _ratings) {
427 i.as_xml (root->add_child("Rating"));
429 for (auto i: _content_versions) {
430 root->add_child("ContentVersion")->add_child_text(i);
432 root->add_child("NameLanguage")->add_child_text(_name_language.to_string());
433 root->add_child("TerritoryType")->add_child_text(territory_type_to_string(_territory_type));
434 if (_release_territory) {
435 root->add_child("ReleaseTerritory")->add_child_text(_release_territory->subtag());
437 if (_sign_language_video_language) {
438 root->add_child("SignLanguageVideoLanguage")->add_child_text(_sign_language_video_language->to_string());
440 root->add_child("VersionNumber")->add_child_text(raw_convert<string>(_version_number));
441 root->add_child("Status")->add_child_text(dcp::status_to_string(_status));
443 root->add_child("Chain")->add_child_text(*_chain);
446 root->add_child("Distributor")->add_child_text(*_distributor);
449 root->add_child("Facility")->add_child_text(*_facility);
452 root->add_child("Studio")->add_child_text(*_studio);
454 root->add_child("TempVersion")->add_child_text(_temp_version ? "1" : "0");
455 root->add_child("PreRelease")->add_child_text(_pre_release ? "1" : "0");
456 root->add_child("RedBand")->add_child_text(_red_band ? "1" : "0");
457 root->add_child("TwoDVersionOfThreeD")->add_child_text(_two_d_version_of_three_d ? "1" : "0");
459 root->add_child("LuminanceValue")->add_child_text(raw_convert<string>(_luminance->value()));
460 root->add_child("LuminanceUnit")->add_child_text(dcp::Luminance::unit_to_string(_luminance->unit()));
462 root->add_child("UserExplicitContainer")->add_child_text(_user_explicit_container ? "1" : "0");
463 root->add_child("UserExplicitResolution")->add_child_text(_user_explicit_resolution ? "1" : "0");
464 if (_audio_language) {
465 root->add_child("AudioLanguage")->add_child_text(_audio_language->to_string());
467 _playlist->as_xml (root->add_child ("Playlist"), with_content_paths);
473 Film::write_metadata (boost::filesystem::path path) const
475 metadata()->write_to_file_formatted(path.string());
478 /** Write state to our `metadata' file */
480 Film::write_metadata ()
482 DCPOMATIC_ASSERT (directory());
483 dcp::filesystem::create_directories(directory().get());
484 auto const filename = file(metadata_file);
486 metadata()->write_to_file_formatted(filename.string());
487 } catch (xmlpp::exception& e) {
488 throw FileError(String::compose("Could not write metadata file (%1)", e.what()), filename);
493 /** Write a template from this film */
495 Film::write_template (boost::filesystem::path path) const
497 dcp::filesystem::create_directories(path.parent_path());
498 shared_ptr<xmlpp::Document> doc = metadata (false);
499 metadata(false)->write_to_file_formatted(path.string());
502 /** Read state from our metadata file.
503 * @return Notes about things that the user should know about, or empty.
506 Film::read_metadata (optional<boost::filesystem::path> path)
509 if (dcp::filesystem::exists(file("metadata")) && !dcp::filesystem::exists(file(metadata_file))) {
510 throw runtime_error (_("This film was created with an older version of DCP-o-matic, and unfortunately it cannot be loaded into this version. You will need to create a new Film, re-add your content and set it up again. Sorry!"));
513 path = file (metadata_file);
516 if (!dcp::filesystem::exists(*path)) {
517 throw FileNotFoundError(*path);
520 cxml::Document f ("Metadata");
521 f.read_file(dcp::filesystem::fix_long_path(path.get()));
523 _state_version = f.number_child<int> ("Version");
524 if (_state_version > current_state_version) {
525 throw runtime_error (_("This film was created with a newer version of DCP-o-matic, and it cannot be loaded into this version. Sorry!"));
526 } else if (_state_version < current_state_version) {
527 /* This is an older version; save a copy (if we haven't already) */
528 auto const older = path->parent_path() / String::compose("metadata.%1.xml", _state_version);
529 if (!dcp::filesystem::is_regular_file(older)) {
531 dcp::filesystem::copy_file(*path, older);
533 /* Never mind; at least we tried */
538 _last_written_by = f.optional_string_child("LastWrittenBy");
540 _name = f.string_child ("Name");
541 if (_state_version >= 9) {
542 _use_isdcf_name = f.bool_child ("UseISDCFName");
543 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("ISDCFDate"));
545 _use_isdcf_name = f.bool_child ("UseDCIName");
546 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
551 auto c = f.optional_string_child("DCPContentType");
553 _dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
558 auto c = f.optional_string_child("Container");
560 _container = Ratio::from_id (c.get ());
564 _resolution = string_to_resolution (f.string_child ("Resolution"));
565 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
566 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
567 _audio_frame_rate = f.optional_number_child<int>("AudioFrameRate").get_value_or(48000);
568 _encrypted = f.bool_child ("Encrypted");
569 _audio_channels = f.number_child<int> ("AudioChannels");
570 /* We used to allow odd numbers (and zero) channels, but it's just not worth
573 if (_audio_channels == 0) {
575 } else if ((_audio_channels % 2) == 1) {
579 if (f.optional_bool_child("SequenceVideo")) {
580 _sequence = f.bool_child("SequenceVideo");
582 _sequence = f.bool_child("Sequence");
585 _three_d = f.bool_child ("ThreeD");
586 _interop = f.bool_child ("Interop");
587 _limit_to_smpte_bv20 = f.optional_bool_child("LimitToSMPTEBv20").get_value_or(false);
588 _key = dcp::Key (f.string_child ("Key"));
589 _context_id = f.optional_string_child("ContextID").get_value_or (dcp::make_uuid ());
591 if (f.optional_string_child ("AudioProcessor")) {
592 _audio_processor = AudioProcessor::from_id (f.string_child ("AudioProcessor"));
594 _audio_processor = 0;
597 if (_audio_processor && !Config::instance()->show_experimental_audio_processors()) {
598 auto ap = AudioProcessor::visible();
599 if (find(ap.begin(), ap.end(), _audio_processor) == ap.end()) {
600 Config::instance()->set_show_experimental_audio_processors(true);
604 _reel_type = static_cast<ReelType> (f.optional_number_child<int>("ReelType").get_value_or (static_cast<int>(ReelType::SINGLE)));
605 _reel_length = f.optional_number_child<int64_t>("ReelLength").get_value_or (2000000000);
606 for (auto boundary: f.node_children("CustomReelBoundary")) {
607 _custom_reel_boundaries.push_back(DCPTime(raw_convert<int64_t>(boundary->content())));
609 _reencode_j2k = f.optional_bool_child("ReencodeJ2K").get_value_or(false);
610 _user_explicit_video_frame_rate = f.optional_bool_child("UserExplicitVideoFrameRate").get_value_or(false);
612 for (auto i: f.node_children("Marker")) {
613 auto type = i->optional_string_attribute("Type");
615 type = i->string_attribute("type");
617 _markers[dcp::marker_from_string(*type)] = DCPTime(dcp::raw_convert<DCPTime::Type>(i->content()));
620 for (auto i: f.node_children("Rating")) {
621 _ratings.push_back (dcp::Rating(i));
624 for (auto i: f.node_children("ContentVersion")) {
625 _content_versions.push_back (i->content());
628 auto name_language = f.optional_string_child("NameLanguage");
630 _name_language = dcp::LanguageTag (*name_language);
632 auto territory_type = f.optional_string_child("TerritoryType");
633 if (territory_type) {
634 _territory_type = string_to_territory_type(*territory_type);
636 auto release_territory = f.optional_string_child("ReleaseTerritory");
637 if (release_territory) {
638 _release_territory = dcp::LanguageTag::RegionSubtag (*release_territory);
641 auto sign_language_video_language = f.optional_string_child("SignLanguageVideoLanguage");
642 if (sign_language_video_language) {
643 _sign_language_video_language = dcp::LanguageTag(*sign_language_video_language);
646 _version_number = f.optional_number_child<int>("VersionNumber").get_value_or(1);
648 auto status = f.optional_string_child("Status");
650 _status = dcp::string_to_status (*status);
653 _chain = f.optional_string_child("Chain");
654 _distributor = f.optional_string_child("Distributor");
655 _facility = f.optional_string_child("Facility");
656 _studio = f.optional_string_child("Studio");
657 _temp_version = f.optional_bool_child("TempVersion").get_value_or(false);
658 _pre_release = f.optional_bool_child("PreRelease").get_value_or(false);
659 _red_band = f.optional_bool_child("RedBand").get_value_or(false);
660 _two_d_version_of_three_d = f.optional_bool_child("TwoDVersionOfThreeD").get_value_or(false);
662 auto value = f.optional_number_child<float>("LuminanceValue");
663 auto unit = f.optional_string_child("LuminanceUnit");
665 _luminance = dcp::Luminance (*value, dcp::Luminance::string_to_unit(*unit));
668 /* Disable guessing for files made in previous DCP-o-matic versions */
669 _user_explicit_container = f.optional_bool_child("UserExplicitContainer").get_value_or(true);
670 _user_explicit_resolution = f.optional_bool_child("UserExplicitResolution").get_value_or(true);
672 auto audio_language = f.optional_string_child("AudioLanguage");
673 if (audio_language) {
674 _audio_language = dcp::LanguageTag(*audio_language);
677 /* Read the old ISDCFMetadata tag from 2.14.x metadata */
678 auto isdcf = f.optional_node_child("ISDCFMetadata");
680 if (auto territory = isdcf->optional_string_child("Territory")) {
682 _release_territory = dcp::LanguageTag::RegionSubtag(*territory);
684 /* Invalid region subtag; just ignore it */
687 if (auto audio_language = isdcf->optional_string_child("AudioLanguage")) {
689 _audio_language = dcp::LanguageTag(*audio_language);
691 /* Invalid language tag; just ignore it */
694 if (auto content_version = isdcf->optional_string_child("ContentVersion")) {
695 _content_versions.push_back (*content_version);
697 if (auto rating = isdcf->optional_string_child("Rating")) {
698 _ratings.push_back (dcp::Rating("", *rating));
700 if (auto mastered_luminance = isdcf->optional_number_child<float>("MasteredLuminance")) {
701 if (*mastered_luminance > 0) {
702 _luminance = dcp::Luminance(*mastered_luminance, dcp::Luminance::Unit::FOOT_LAMBERT);
705 _studio = isdcf->optional_string_child("Studio");
706 _facility = isdcf->optional_string_child("Facility");
707 _temp_version = isdcf->optional_bool_child("TempVersion").get_value_or(false);
708 _pre_release = isdcf->optional_bool_child("PreRelease").get_value_or(false);
709 _red_band = isdcf->optional_bool_child("RedBand").get_value_or(false);
710 _two_d_version_of_three_d = isdcf->optional_bool_child("TwoDVersionOfThreeD").get_value_or(false);
711 _chain = isdcf->optional_string_child("Chain");
715 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
717 /* Write backtraces to this film's directory, until another film is loaded */
719 set_backtrace_file (file ("backtrace.txt"));
726 /** Given a directory name, return its full path within the Film's directory.
727 * @param d directory name within the Film's directory.
728 * @param create true to create the directory (and its parents) if they do not exist.
730 boost::filesystem::path
731 Film::dir (boost::filesystem::path d, bool create) const
733 DCPOMATIC_ASSERT (_directory);
735 boost::filesystem::path p;
736 p /= _directory.get();
740 dcp::filesystem::create_directories(p);
746 /** Given a file or directory name, return its full path within the Film's directory.
747 * Any required parent directories will be created.
749 boost::filesystem::path
750 Film::file (boost::filesystem::path f) const
752 DCPOMATIC_ASSERT (_directory);
754 boost::filesystem::path p;
755 p /= _directory.get();
758 dcp::filesystem::create_directories(p.parent_path());
764 Film::mapped_audio_channels () const
768 if (audio_processor ()) {
769 /* Processors are mapped 1:1 to DCP outputs so we can work out mappings from there */
770 for (int i = 0; i < audio_processor()->out_channels(); ++i) {
771 mapped.push_back (i);
774 for (auto i: content()) {
776 auto c = i->audio->mapping().mapped_output_channels();
777 copy (c.begin(), c.end(), back_inserter(mapped));
789 pair<optional<dcp::LanguageTag>, vector<dcp::LanguageTag>>
790 Film::subtitle_languages(bool* burnt_in) const
796 pair<optional<dcp::LanguageTag>, vector<dcp::LanguageTag>> result;
797 for (auto i: content()) {
798 auto dcp = dynamic_pointer_cast<DCPContent>(i);
799 for (auto const& text: i->text) {
800 auto const use = text->use() || (dcp && dcp->reference_text(TextType::OPEN_SUBTITLE));
801 if (use && text->type() == TextType::OPEN_SUBTITLE) {
802 if (!text->burn() && burnt_in) {
805 if (text->language()) {
806 if (text->language_is_additional()) {
807 result.second.push_back(text->language().get());
809 result.first = text->language().get();
814 if (i->video && i->video->burnt_subtitle_language()) {
815 result.first = i->video->burnt_subtitle_language();
819 std::sort (result.second.begin(), result.second.end());
820 auto last = std::unique (result.second.begin(), result.second.end());
821 result.second.erase (last, result.second.end());
826 vector<dcp::LanguageTag>
827 Film::closed_caption_languages() const
829 vector<dcp::LanguageTag> result;
830 for (auto i: content()) {
831 for (auto text: i->text) {
832 if (text->use() && text->type() == TextType::CLOSED_CAPTION && text->dcp_track() && text->dcp_track()->language) {
833 result.push_back(*text->dcp_track()->language);
842 /** @return a ISDCF-compliant name for a DCP of this film */
844 Film::isdcf_name (bool if_created_now) const
848 auto raw_name = name ();
850 auto to_upper = [](string s) {
851 transform(s.begin(), s.end(), s.begin(), ::toupper);
855 /* Split the raw name up into words */
856 vector<string> words;
857 split (words, raw_name, is_any_of (" _-"));
861 /* Add each word to fixed_name */
862 for (auto i: words) {
865 /* First letter is always capitalised */
866 w[0] = toupper (w[0]);
868 /* Count caps in w */
870 for (size_t j = 0; j < w.size(); ++j) {
871 if (isupper (w[j])) {
876 /* If w is all caps make the rest of it lower case, otherwise
879 if (caps == w.size ()) {
880 for (size_t j = 1; j < w.size(); ++j) {
881 w[j] = tolower (w[j]);
885 for (size_t j = 0; j < w.size(); ++j) {
890 fixed_name = fixed_name.substr(0, Config::instance()->isdcf_name_part_length());
892 isdcf_name += fixed_name;
894 if (dcp_content_type()) {
895 isdcf_name += "_" + dcp_content_type()->isdcf_name();
896 string version = "1";
898 if (!_content_versions.empty()) {
899 auto cv = _content_versions[0];
900 if (!cv.empty() && std::all_of(cv.begin(), cv.end(), isdigit)) {
905 version = dcp::raw_convert<string>(_version_number);
907 isdcf_name += "-" + version;
911 isdcf_name += "-Temp";
915 isdcf_name += "-Pre";
919 isdcf_name += "-RedBand";
922 if (_chain && !_chain->empty()) {
923 isdcf_name += "-" + *_chain;
930 if (_two_d_version_of_three_d) {
935 auto fl = _luminance->value_in_foot_lamberts();
937 snprintf (buffer, sizeof(buffer), "%.1f", fl);
938 isdcf_name += String::compose("-%1fl", buffer);
941 if (video_frame_rate() != 24) {
942 isdcf_name += "-" + raw_convert<string>(video_frame_rate());
946 isdcf_name += "_" + container()->isdcf_name();
949 auto content_list = content();
951 /* XXX: this uses the first bit of content only */
953 /* Interior aspect ratio. The standard says we don't do this for trailers, for some strange reason */
954 if (dcp_content_type() && dcp_content_type()->libdcp_kind() != dcp::ContentKind::TRAILER) {
955 auto first_video = std::find_if(content_list.begin(), content_list.end(), [](shared_ptr<Content> c) { return static_cast<bool>(c->video); });
956 if (first_video != content_list.end()) {
957 if (auto scaled_size = (*first_video)->video->scaled_size(frame_size())) {
958 auto first_ratio = lrintf(scaled_size->ratio() * 100);
959 auto container_ratio = lrintf(container()->ratio() * 100);
960 if (first_ratio != container_ratio) {
961 isdcf_name += "-" + dcp::raw_convert<string>(first_ratio);
967 auto entry_for_language = [](dcp::LanguageTag const& tag) {
968 /* Look up what we should be using for this tag in the DCNC name */
969 for (auto const& dcnc: dcp::dcnc_tags()) {
970 if (tag.to_string() == dcnc.first) {
974 /* Fallback to the language subtag, if there is one */
975 return tag.language() ? tag.language()->subtag() : "XX";
978 auto audio_language = _audio_language ? entry_for_language(*_audio_language) : "XX";
980 isdcf_name += "_" + to_upper (audio_language);
983 auto sub_langs = subtitle_languages(&burnt_in);
984 auto ccap_langs = closed_caption_languages();
985 if (sub_langs.first && sub_langs.first->language()) {
986 auto lang = entry_for_language(*sub_langs.first);
988 transform (lang.begin(), lang.end(), lang.begin(), ::tolower);
990 lang = to_upper (lang);
993 isdcf_name += "-" + lang;
994 } else if (!ccap_langs.empty()) {
995 isdcf_name += "-" + to_upper(entry_for_language(ccap_langs[0])) + "-CCAP";
1001 if (_territory_type == TerritoryType::INTERNATIONAL_TEXTED) {
1002 isdcf_name += "_INT-TD";
1003 } else if (_territory_type == TerritoryType::INTERNATIONAL_TEXTLESS) {
1004 isdcf_name += "_INT-TL";
1005 } else if (_release_territory) {
1006 auto territory = _release_territory->subtag();
1007 isdcf_name += "_" + to_upper (territory);
1008 if (!_ratings.empty()) {
1009 auto label = _ratings[0].label;
1010 boost::erase_all(label, "+");
1011 boost::erase_all(label, "-");
1012 isdcf_name += "-" + label;
1016 /* Count mapped audio channels */
1018 auto mapped = mapped_audio_channels ();
1020 auto ch = audio_channel_types (mapped, audio_channels());
1021 if (!ch.first && !ch.second) {
1022 isdcf_name += "_MOS";
1023 } else if (ch.first) {
1024 isdcf_name += String::compose("_%1%2", ch.first, ch.second);
1027 if (audio_channels() > static_cast<int>(dcp::Channel::HI) && find(mapped.begin(), mapped.end(), static_cast<int>(dcp::Channel::HI)) != mapped.end()) {
1028 isdcf_name += "-HI";
1030 if (audio_channels() > static_cast<int>(dcp::Channel::VI) && find(mapped.begin(), mapped.end(), static_cast<int>(dcp::Channel::VI)) != mapped.end()) {
1031 isdcf_name += "-VI";
1034 if (find_if(content_list.begin(), content_list.end(), [](shared_ptr<Content> c) { return static_cast<bool>(c->atmos); }) != content_list.end()) {
1035 isdcf_name += "-IAB";
1038 isdcf_name += "_" + resolution_to_string (_resolution);
1040 if (_studio && _studio->length() >= 2) {
1041 isdcf_name += "_" + to_upper (_studio->substr(0, 4));
1044 if (if_created_now) {
1045 isdcf_name += "_" + boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
1047 isdcf_name += "_" + boost::gregorian::to_iso_string (_isdcf_date);
1050 if (_facility && _facility->length() >= 3) {
1051 isdcf_name += "_" + to_upper(_facility->substr(0, 3));
1055 isdcf_name += "_IOP";
1057 isdcf_name += "_SMPTE";
1061 isdcf_name += "-3D";
1065 for (auto content: content_list) {
1066 auto dcp = dynamic_pointer_cast<const DCPContent>(content);
1071 bool any_text = false;
1072 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
1073 if (dcp->reference_text(static_cast<TextType>(i))) {
1077 if (dcp->reference_video() || dcp->reference_audio() || any_text) {
1083 isdcf_name += "_VF";
1085 isdcf_name += "_OV";
1091 /** @return name to give the DCP */
1093 Film::dcp_name (bool if_created_now) const
1096 if (use_isdcf_name()) {
1097 return careful_string_filter (isdcf_name (if_created_now));
1100 return careful_string_filter (name ());
1104 Film::set_directory (boost::filesystem::path d)
1111 Film::set_name (string n)
1113 FilmChangeSignaller ch(this, FilmProperty::NAME);
1118 Film::set_use_isdcf_name (bool u)
1120 FilmChangeSignaller ch(this, FilmProperty::USE_ISDCF_NAME);
1121 _use_isdcf_name = u;
1125 Film::set_dcp_content_type (DCPContentType const * t)
1127 FilmChangeSignaller ch(this, FilmProperty::DCP_CONTENT_TYPE);
1128 _dcp_content_type = t;
1132 /** @param explicit_user true if this is being set because of
1133 * a direct user request, false if it is being done because
1134 * DCP-o-matic is guessing the best container to use.
1137 Film::set_container (Ratio const * c, bool explicit_user)
1139 FilmChangeSignaller ch(this, FilmProperty::CONTAINER);
1142 if (explicit_user) {
1143 _user_explicit_container = true;
1148 /** @param explicit_user true if this is being set because of
1149 * a direct user request, false if it is being done because
1150 * DCP-o-matic is guessing the best resolution to use.
1153 Film::set_resolution (Resolution r, bool explicit_user)
1155 FilmChangeSignaller ch(this, FilmProperty::RESOLUTION);
1158 if (explicit_user) {
1159 _user_explicit_resolution = true;
1165 Film::set_j2k_bandwidth (int b)
1167 FilmChangeSignaller ch(this, FilmProperty::J2K_BANDWIDTH);
1171 /** @param f New frame rate.
1172 * @param user_explicit true if this comes from a direct user instruction, false if it is from
1173 * DCP-o-matic being helpful.
1176 Film::set_video_frame_rate (int f, bool user_explicit)
1178 FilmChangeSignaller ch(this, FilmProperty::VIDEO_FRAME_RATE);
1179 _video_frame_rate = f;
1180 if (user_explicit) {
1181 _user_explicit_video_frame_rate = true;
1186 Film::set_audio_channels (int c)
1188 FilmChangeSignaller ch(this, FilmProperty::AUDIO_CHANNELS);
1189 _audio_channels = c;
1193 Film::set_three_d (bool t)
1195 FilmChangeSignaller ch(this, FilmProperty::THREE_D);
1198 if (_three_d && _two_d_version_of_three_d) {
1199 set_two_d_version_of_three_d (false);
1204 Film::set_interop (bool i)
1206 FilmChangeSignaller ch(this, FilmProperty::INTEROP);
1212 Film::set_limit_to_smpte_bv20(bool limit)
1214 FilmChangeSignaller ch(this, FilmProperty::LIMIT_TO_SMPTE_BV20);
1215 _limit_to_smpte_bv20 = limit;
1220 Film::set_audio_processor (AudioProcessor const * processor)
1222 FilmChangeSignaller ch1(this, FilmProperty::AUDIO_PROCESSOR);
1223 FilmChangeSignaller ch2(this, FilmProperty::AUDIO_CHANNELS);
1224 _audio_processor = processor;
1228 Film::set_reel_type (ReelType t)
1230 FilmChangeSignaller ch(this, FilmProperty::REEL_TYPE);
1234 /** @param r Desired reel length in bytes */
1236 Film::set_reel_length (int64_t r)
1238 FilmChangeSignaller ch(this, FilmProperty::REEL_LENGTH);
1244 Film::set_custom_reel_boundaries(vector<DCPTime> boundaries)
1246 FilmChangeSignaller ch(this, FilmProperty::CUSTOM_REEL_BOUNDARIES);
1247 std::sort(boundaries.begin(), boundaries.end());
1248 _custom_reel_boundaries = std::move(boundaries);
1253 Film::set_reencode_j2k (bool r)
1255 FilmChangeSignaller ch(this, FilmProperty::REENCODE_J2K);
1260 Film::signal_change (ChangeType type, int p)
1262 signal_change(type, static_cast<FilmProperty>(p));
1266 Film::signal_change(ChangeType type, FilmProperty p)
1268 if (type == ChangeType::DONE) {
1271 if (p == FilmProperty::CONTENT) {
1272 if (!_user_explicit_video_frame_rate) {
1273 set_video_frame_rate (best_video_frame_rate());
1277 emit (boost::bind (boost::ref (Change), type, p));
1279 if (p == FilmProperty::VIDEO_FRAME_RATE || p == FilmProperty::SEQUENCE) {
1280 /* We want to call Playlist::maybe_sequence but this must happen after the
1281 main signal emission (since the butler will see that emission and un-suspend itself).
1283 emit (boost::bind(&Playlist::maybe_sequence, _playlist.get(), shared_from_this()));
1291 Film::set_isdcf_date_today ()
1293 _isdcf_date = boost::gregorian::day_clock::local_day ();
1297 boost::filesystem::path
1298 Film::j2c_path (int reel, Frame frame, Eyes eyes, bool tmp) const
1300 boost::filesystem::path p;
1302 p /= video_identifier ();
1305 snprintf(buffer, sizeof(buffer), "%08d_%08" PRId64, reel, frame);
1308 if (eyes == Eyes::LEFT) {
1310 } else if (eyes == Eyes::RIGHT) {
1325 /** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs.
1326 * The list will be returned in reverse order of timestamp (i.e. most recent first).
1331 if (!directory ()) {
1335 vector<CPLSummary> out;
1337 auto const dir = directory().get();
1338 for (auto const& item: dcp::filesystem::directory_iterator(dir)) {
1340 dcp::filesystem::is_directory(item) &&
1341 item.path().filename() != "j2c" && item.path().filename() != "video" && item.path().filename() != "info" && item.path().filename() != "analysis"
1345 out.push_back(CPLSummary(item));
1352 sort(out.begin(), out.end(), [](CPLSummary const& a, CPLSummary const& b) {
1353 return a.last_write_time > b.last_write_time;
1360 Film::set_encrypted (bool e)
1362 FilmChangeSignaller ch(this, FilmProperty::ENCRYPTED);
1367 Film::content () const
1369 return _playlist->content ();
1372 /** @param content Content to add.
1373 * @param disable_audio_analysis true to never do automatic audio analysis, even if it is enabled in configuration.
1376 Film::examine_and_add_content (shared_ptr<Content> content, bool disable_audio_analysis)
1378 if (dynamic_pointer_cast<FFmpegContent> (content) && _directory) {
1379 run_ffprobe (content->path(0), file("ffprobe.log"));
1382 auto j = make_shared<ExamineContentJob>(shared_from_this(), content);
1384 _job_connections.push_back (
1385 j->Finished.connect (bind (&Film::maybe_add_content, this, weak_ptr<Job>(j), weak_ptr<Content>(content), disable_audio_analysis))
1388 JobManager::instance()->add (j);
1392 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c, bool disable_audio_analysis)
1394 auto job = j.lock ();
1395 if (!job || !job->finished_ok ()) {
1399 auto content = c.lock ();
1404 add_content (content);
1406 if (Config::instance()->automatic_audio_analysis() && content->audio && !disable_audio_analysis) {
1407 auto playlist = make_shared<Playlist>();
1408 playlist->add (shared_from_this(), content);
1409 boost::signals2::connection c;
1410 JobManager::instance()->analyse_audio (
1411 shared_from_this(), playlist, false, c, bind (&Film::audio_analysis_finished, this)
1413 _audio_analysis_connections.push_back (c);
1418 Film::add_content (shared_ptr<Content> c)
1420 /* Add {video,subtitle} content after any existing {video,subtitle} content */
1422 c->set_position (shared_from_this(), _playlist->video_end(shared_from_this()));
1423 } else if (!c->text.empty()) {
1424 c->set_position (shared_from_this(), _playlist->text_end(shared_from_this()));
1427 if (_template_film) {
1428 /* Take settings from the first piece of content of c's type in _template */
1429 for (auto i: _template_film->content()) {
1430 c->take_settings_from (i);
1434 _playlist->add (shared_from_this(), c);
1436 maybe_set_container_and_resolution ();
1438 if (_audio_channels < 14) {
1439 set_audio_channels(14);
1441 set_interop (false);
1447 Film::maybe_set_container_and_resolution ()
1449 /* Get the only piece of video content, if there is only one */
1450 shared_ptr<VideoContent> video;
1451 for (auto content: _playlist->content()) {
1452 if (content->video) {
1454 video = content->video;
1461 if (video && video->size()) {
1462 /* This is the only piece of video content in this Film. Use it to make a guess for
1463 * DCP container size and resolution, unless the user has already explicitly set these
1466 if (!_user_explicit_container) {
1467 if (video->size()->ratio() > 2.3) {
1468 set_container (Ratio::from_id("239"), false);
1470 set_container (Ratio::from_id("185"), false);
1474 if (!_user_explicit_resolution) {
1475 if (video->size_after_crop()->width > 2048 || video->size_after_crop()->height > 1080) {
1476 set_resolution (Resolution::FOUR_K, false);
1478 set_resolution (Resolution::TWO_K, false);
1485 Film::remove_content (shared_ptr<Content> c)
1487 _playlist->remove (c);
1488 maybe_set_container_and_resolution ();
1492 Film::move_content_earlier (shared_ptr<Content> c)
1494 _playlist->move_earlier (shared_from_this(), c);
1498 Film::move_content_later (shared_ptr<Content> c)
1500 _playlist->move_later (shared_from_this(), c);
1503 /** @return length of the film from time 0 to the last thing on the playlist,
1504 * with a minimum length of 1 second.
1507 Film::length () const
1509 return max(DCPTime::from_seconds(1), _playlist->length(shared_from_this()).ceil(video_frame_rate()));
1513 Film::best_video_frame_rate () const
1515 /* Don't default to anything above 30fps (make the user select that explicitly) */
1516 auto best = _playlist->best_video_frame_rate ();
1524 Film::active_frame_rate_change (DCPTime t) const
1526 return _playlist->active_frame_rate_change (t, video_frame_rate ());
1530 Film::playlist_content_change (ChangeType type, weak_ptr<Content> c, int p, bool frequent)
1532 if (p == ContentProperty::VIDEO_FRAME_RATE) {
1533 signal_change(type, FilmProperty::CONTENT);
1534 } else if (p == AudioContentProperty::STREAMS) {
1535 signal_change(type, FilmProperty::NAME);
1538 if (type == ChangeType::DONE) {
1539 emit (boost::bind (boost::ref (ContentChange), type, c, p, frequent));
1541 check_settings_consistency ();
1544 ContentChange (type, c, p, frequent);
1551 Film::playlist_length_change ()
1557 Film::playlist_change (ChangeType type)
1559 signal_change(type, FilmProperty::CONTENT);
1560 signal_change(type, FilmProperty::NAME);
1562 if (type == ChangeType::DONE) {
1563 check_settings_consistency ();
1569 /** Check for (and if necessary fix) impossible settings combinations, like
1570 * video set to being referenced when it can't be.
1573 Film::check_settings_consistency ()
1575 optional<int> atmos_rate;
1576 for (auto i: content()) {
1579 int rate = lrintf (i->atmos->edit_rate().as_float());
1580 if (atmos_rate && *atmos_rate != rate) {
1581 Message (_("You have more than one piece of Atmos content, and they do not have the same frame rate. You must remove some Atmos content."));
1582 } else if (!atmos_rate && rate != video_frame_rate()) {
1584 set_video_frame_rate (rate, false);
1585 Message (_("DCP-o-matic had to change your settings so that the film's frame rate is the same as that of your Atmos content."));
1590 bool change_made = false;
1591 for (auto i: content()) {
1592 auto d = dynamic_pointer_cast<DCPContent>(i);
1598 if (d->reference_video() && !d->can_reference_video(shared_from_this(), why_not)) {
1599 d->set_reference_video(false);
1602 if (d->reference_audio() && !d->can_reference_audio(shared_from_this(), why_not)) {
1603 d->set_reference_audio(false);
1606 if (d->reference_text(TextType::OPEN_SUBTITLE) && !d->can_reference_text(shared_from_this(), TextType::OPEN_SUBTITLE, why_not)) {
1607 d->set_reference_text(TextType::OPEN_SUBTITLE, false);
1610 if (d->reference_text(TextType::CLOSED_CAPTION) && !d->can_reference_text(shared_from_this(), TextType::CLOSED_CAPTION, why_not)) {
1611 d->set_reference_text(TextType::CLOSED_CAPTION, false);
1617 Message (_("DCP-o-matic had to change your settings for referring to DCPs as OV. Please review those settings to make sure they are what you want."));
1620 if (reel_type() == ReelType::CUSTOM) {
1621 auto boundaries = custom_reel_boundaries();
1622 auto too_late = std::find_if(boundaries.begin(), boundaries.end(), [this](dcpomatic::DCPTime const& time) {
1623 return time >= length();
1626 if (too_late != boundaries.end()) {
1627 if (std::distance(too_late, boundaries.end()) > 1) {
1628 Message(_("DCP-o-matic had to remove some of your custom reel boundaries as they no longer lie within the film."));
1630 Message(_("DCP-o-matic had to remove one of your custom reel boundaries as it no longer lies within the film."));
1632 boundaries.erase(too_late, boundaries.end());
1633 set_custom_reel_boundaries(boundaries);
1639 Film::playlist_order_changed ()
1641 /* XXX: missing PENDING */
1642 signal_change(ChangeType::DONE, FilmProperty::CONTENT_ORDER);
1647 Film::set_sequence (bool s)
1649 if (s == _sequence) {
1653 FilmChangeSignaller cc(this, FilmProperty::SEQUENCE);
1655 _playlist->set_sequence (s);
1658 /** @return Size of the largest possible image in whatever resolution we are using */
1660 Film::full_frame () const
1662 switch (_resolution) {
1663 case Resolution::TWO_K:
1664 return dcp::Size (2048, 1080);
1665 case Resolution::FOUR_K:
1666 return dcp::Size (4096, 2160);
1669 DCPOMATIC_ASSERT (false);
1670 return dcp::Size ();
1673 /** @return Size of the frame */
1675 Film::frame_size () const
1677 return fit_ratio_within (container()->ratio(), full_frame ());
1681 /** @return Area of Film::frame_size() that contains picture rather than pillar/letterboxing */
1683 Film::active_area () const
1685 auto const frame = frame_size ();
1688 for (auto i: content()) {
1690 if (auto s = i->video->scaled_size(frame)) {
1691 active.width = max(active.width, s->width);
1692 active.height = max(active.height, s->height);
1701 /* @param cpl_file CPL filename.
1702 * @param from KDM from time expressed as a local time with an offset from UTC.
1703 * @param until KDM to time expressed as a local time with an offset from UTC.
1706 Film::make_kdm(boost::filesystem::path cpl_file, dcp::LocalTime from, dcp::LocalTime until) const
1709 throw runtime_error (_("Cannot make a KDM as this project is not encrypted."));
1712 auto cpl = make_shared<dcp::CPL>(cpl_file);
1714 /* Find keys that have been added to imported, encrypted DCP content */
1715 list<dcp::DecryptedKDMKey> imported_keys;
1716 for (auto i: content()) {
1717 auto d = dynamic_pointer_cast<DCPContent> (i);
1718 if (d && d->kdm()) {
1719 dcp::DecryptedKDM kdm (d->kdm().get(), Config::instance()->decryption_chain()->key().get());
1720 auto keys = kdm.keys ();
1721 copy (keys.begin(), keys.end(), back_inserter (imported_keys));
1725 map<shared_ptr<const dcp::ReelFileAsset>, dcp::Key> keys;
1727 for (auto asset: cpl->reel_file_assets()) {
1728 if (!asset->encrypted()) {
1732 /* Get any imported key for this ID */
1734 for (auto const& k: imported_keys) {
1735 if (k.id() == asset->key_id().get()) {
1736 LOG_GENERAL("Using imported key for %1", asset->key_id().get());
1737 keys[asset] = k.key();
1743 /* No imported key; it must be an asset that we encrypted */
1744 LOG_GENERAL("Using our own key for %1", asset->key_id().get());
1745 keys[asset] = key();
1749 return dcp::DecryptedKDM (
1750 cpl->id(), keys, from, until, cpl->content_title_text(), cpl->content_title_text(), dcp::LocalTime().as_string()
1755 /** @return The approximate disk space required to encode a DCP of this film with the
1756 * current settings, in bytes.
1759 Film::required_disk_space () const
1761 return _playlist->required_disk_space (shared_from_this(), j2k_bandwidth(), audio_channels(), audio_frame_rate());
1764 /** This method checks the disk that the Film is on and tries to decide whether or not
1765 * there will be enough space to make a DCP for it. If so, true is returned; if not,
1766 * false is returned and required and available are filled in with the amount of disk space
1767 * required and available respectively (in GB).
1769 * Note: the decision made by this method isn't, of course, 100% reliable.
1772 Film::should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const
1774 /* Create a test file and see if we can hard-link it */
1775 boost::filesystem::path test = internal_video_asset_dir() / "test";
1776 boost::filesystem::path test2 = internal_video_asset_dir() / "test2";
1777 can_hard_link = true;
1778 dcp::File f(test, "w");
1781 boost::system::error_code ec;
1782 dcp::filesystem::create_hard_link(test, test2, ec);
1784 can_hard_link = false;
1786 dcp::filesystem::remove(test);
1787 dcp::filesystem::remove(test2);
1790 auto s = dcp::filesystem::space(internal_video_asset_dir());
1791 required = double (required_disk_space ()) / 1073741824.0f;
1792 if (!can_hard_link) {
1795 available = double (s.available) / 1073741824.0f;
1796 return (available - required) > 1;
1799 /** @return The names of the channels that audio contents' outputs are passed into;
1800 * this is either the DCP or a AudioProcessor.
1802 vector<NamedChannel>
1803 Film::audio_output_names () const
1805 if (audio_processor ()) {
1806 return audio_processor()->input_names ();
1809 DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
1811 vector<NamedChannel> n;
1813 for (int i = 0; i < audio_channels(); ++i) {
1814 if (Config::instance()->use_all_audio_channels() || (i != 8 && i != 9 && i != 15)) {
1815 n.push_back (NamedChannel(short_audio_channel_name(i), i));
1823 Film::repeat_content (ContentList c, int n)
1825 _playlist->repeat (shared_from_this(), c, n);
1829 Film::remove_content (ContentList c)
1831 _playlist->remove (c);
1835 Film::audio_analysis_finished ()
1841 vector<DCPTimePeriod>
1842 Film::reels () const
1844 vector<DCPTimePeriod> periods;
1845 auto const len = length();
1847 switch (reel_type ()) {
1848 case ReelType::SINGLE:
1849 periods.emplace_back(DCPTime(), len);
1851 case ReelType::BY_VIDEO_CONTENT:
1853 /* Collect all reel boundaries */
1854 list<DCPTime> split_points;
1855 split_points.push_back (DCPTime());
1856 split_points.push_back (len);
1857 for (auto c: content()) {
1859 for (auto t: c->reel_split_points(shared_from_this())) {
1860 split_points.push_back (t);
1862 split_points.push_back (c->end(shared_from_this()));
1866 split_points.sort ();
1867 split_points.unique ();
1869 /* Make them into periods, coalescing any that are less than 1 second long */
1870 optional<DCPTime> last;
1871 for (auto t: split_points) {
1872 if (last && (t - *last) >= DCPTime::from_seconds(1)) {
1873 /* Period from *last to t is long enough; use it and start a new one */
1874 periods.emplace_back(*last, t);
1877 /* That was the first time, so start a new period */
1882 if (!periods.empty()) {
1883 periods.back().to = split_points.back();
1887 case ReelType::BY_LENGTH:
1890 /* Integer-divide reel length by the size of one frame to give the number of frames per reel,
1891 * making sure we don't go less than 1s long.
1893 Frame const reel_in_frames = max(_reel_length / ((j2k_bandwidth() / video_frame_rate()) / 8), static_cast<Frame>(video_frame_rate()));
1894 while (current < len) {
1895 DCPTime end = min (len, current + DCPTime::from_frames (reel_in_frames, video_frame_rate ()));
1896 periods.emplace_back(current, end);
1901 case ReelType::CUSTOM:
1903 DCPTimePeriod current;
1904 for (auto boundary: _custom_reel_boundaries) {
1905 current.to = boundary;
1906 periods.push_back(current);
1907 current.from = boundary;
1910 periods.push_back(current);
1919 /** @param period A period within the DCP
1920 * @return Name of the content which most contributes to the given period.
1923 Film::content_summary (DCPTimePeriod period) const
1925 return _playlist->content_summary (shared_from_this(), period);
1929 Film::use_template (string name)
1931 _template_film.reset (new Film (optional<boost::filesystem::path>()));
1932 _template_film->read_metadata (Config::instance()->template_read_path(name));
1933 _use_isdcf_name = _template_film->_use_isdcf_name;
1934 _dcp_content_type = _template_film->_dcp_content_type;
1935 _container = _template_film->_container;
1936 _resolution = _template_film->_resolution;
1937 _j2k_bandwidth = _template_film->_j2k_bandwidth;
1938 _video_frame_rate = _template_film->_video_frame_rate;
1939 _encrypted = _template_film->_encrypted;
1940 _audio_channels = _template_film->_audio_channels;
1941 _sequence = _template_film->_sequence;
1942 _three_d = _template_film->_three_d;
1943 _interop = _template_film->_interop;
1944 _audio_processor = _template_film->_audio_processor;
1945 _reel_type = _template_film->_reel_type;
1946 _reel_length = _template_film->_reel_length;
1949 pair<double, double>
1950 Film::speed_up_range (int dcp_frame_rate) const
1952 return _playlist->speed_up_range (dcp_frame_rate);
1956 Film::copy_from (shared_ptr<const Film> film)
1958 read_metadata (film->file (metadata_file));
1962 Film::references_dcp_video () const
1964 for (auto i: _playlist->content()) {
1965 auto d = dynamic_pointer_cast<DCPContent>(i);
1966 if (d && d->reference_video()) {
1975 Film::references_dcp_audio () const
1977 for (auto i: _playlist->content()) {
1978 auto d = dynamic_pointer_cast<DCPContent>(i);
1979 if (d && d->reference_audio()) {
1989 Film::contains_atmos_content () const
1991 auto const content = _playlist->content();
1992 return std::find_if(content.begin(), content.end(), [](shared_ptr<const Content> content) {
1993 return static_cast<bool>(content->atmos);
1994 }) != content.end();
1999 Film::closed_caption_tracks () const
2001 list<DCPTextTrack> tt;
2002 for (auto i: content()) {
2003 for (auto text: i->text) {
2004 /* XXX: Empty DCPTextTrack ends up being a magic value here - the "unknown" or "not specified" track */
2005 auto dtt = text->dcp_track().get_value_or(DCPTextTrack());
2006 if (text->type() == TextType::CLOSED_CAPTION && find(tt.begin(), tt.end(), dtt) == tt.end()) {
2016 Film::set_marker (dcp::Marker type, DCPTime time)
2018 FilmChangeSignaller ch(this, FilmProperty::MARKERS);
2019 _markers[type] = time;
2024 Film::unset_marker (dcp::Marker type)
2026 FilmChangeSignaller ch(this, FilmProperty::MARKERS);
2027 _markers.erase (type);
2032 Film::clear_markers ()
2034 FilmChangeSignaller ch(this, FilmProperty::MARKERS);
2040 Film::set_ratings (vector<dcp::Rating> r)
2042 FilmChangeSignaller ch(this, FilmProperty::RATINGS);
2047 Film::set_content_versions (vector<string> v)
2049 FilmChangeSignaller ch(this, FilmProperty::CONTENT_VERSIONS);
2050 _content_versions = v;
2055 Film::set_name_language (dcp::LanguageTag lang)
2057 FilmChangeSignaller ch(this, FilmProperty::NAME_LANGUAGE);
2058 _name_language = lang;
2063 Film::set_release_territory (optional<dcp::LanguageTag::RegionSubtag> region)
2065 FilmChangeSignaller ch(this, FilmProperty::RELEASE_TERRITORY);
2066 _release_territory = region;
2071 Film::set_status (dcp::Status s)
2073 FilmChangeSignaller ch(this, FilmProperty::STATUS);
2079 Film::set_version_number (int v)
2081 FilmChangeSignaller ch(this, FilmProperty::VERSION_NUMBER);
2082 _version_number = v;
2087 Film::set_chain (optional<string> c)
2089 FilmChangeSignaller ch(this, FilmProperty::CHAIN);
2095 Film::set_distributor (optional<string> d)
2097 FilmChangeSignaller ch(this, FilmProperty::DISTRIBUTOR);
2103 Film::set_luminance (optional<dcp::Luminance> l)
2105 FilmChangeSignaller ch(this, FilmProperty::LUMINANCE);
2111 Film::set_facility (optional<string> f)
2113 FilmChangeSignaller ch(this, FilmProperty::FACILITY);
2119 Film::set_studio (optional<string> s)
2121 FilmChangeSignaller ch(this, FilmProperty::STUDIO);
2127 Film::marker (dcp::Marker type) const
2129 auto i = _markers.find (type);
2130 if (i == _markers.end()) {
2136 shared_ptr<InfoFileHandle>
2137 Film::info_file_handle (DCPTimePeriod period, bool read) const
2139 return std::make_shared<InfoFileHandle>(_info_file_mutex, info_file(period), read);
2142 InfoFileHandle::InfoFileHandle (boost::mutex& mutex, boost::filesystem::path path, bool read)
2144 , _file(path, read ? "rb" : (dcp::filesystem::exists(path) ? "r+b" : "wb"))
2147 throw OpenFileError(path, errno, read ? OpenFileError::READ : (dcp::filesystem::exists(path) ? OpenFileError::READ_WRITE : OpenFileError::WRITE));
2152 /** Add FFOC and LFOC markers to a list if they are not already there */
2154 Film::add_ffoc_lfoc (Markers& markers) const
2156 if (markers.find(dcp::Marker::FFOC) == markers.end()) {
2157 markers[dcp::Marker::FFOC] = dcpomatic::DCPTime::from_frames(1, video_frame_rate());
2160 if (markers.find(dcp::Marker::LFOC) == markers.end()) {
2161 markers[dcp::Marker::LFOC] = length() - DCPTime::from_frames(1, video_frame_rate());
2167 Film::set_temp_version (bool t)
2169 FilmChangeSignaller ch(this, FilmProperty::TEMP_VERSION);
2175 Film::set_pre_release (bool p)
2177 FilmChangeSignaller ch(this, FilmProperty::PRE_RELEASE);
2183 Film::set_red_band (bool r)
2185 FilmChangeSignaller ch(this, FilmProperty::RED_BAND);
2191 Film::set_two_d_version_of_three_d (bool t)
2193 FilmChangeSignaller ch(this, FilmProperty::TWO_D_VERSION_OF_THREE_D);
2194 _two_d_version_of_three_d = t;
2199 Film::set_audio_language (optional<dcp::LanguageTag> language)
2201 FilmChangeSignaller ch(this, FilmProperty::AUDIO_LANGUAGE);
2202 _audio_language = language;
2207 Film::set_audio_frame_rate (int rate)
2209 FilmChangeSignaller ch(this, FilmProperty::AUDIO_FRAME_RATE);
2210 _audio_frame_rate = rate;
2215 Film::has_sign_language_video_channel () const
2217 return _audio_channels >= static_cast<int>(dcp::Channel::SIGN_LANGUAGE);
2222 Film::set_sign_language_video_language (optional<dcp::LanguageTag> lang)
2224 FilmChangeSignaller ch(this, FilmProperty::SIGN_LANGUAGE_VIDEO_LANGUAGE);
2225 _sign_language_video_language = lang;
2230 Film::set_dirty (bool dirty)
2232 auto const changed = dirty != _dirty;
2235 emit (boost::bind(boost::ref(DirtyChange), _dirty));
2240 /** @return true if the metadata was (probably) last written by a version earlier
2241 * than the given one; false if it definitely was not.
2244 Film::last_written_by_earlier_than(int major, int minor, int micro) const
2246 if (!_last_written_by) {
2250 vector<string> parts;
2251 boost::split(parts, *_last_written_by, boost::is_any_of("."));
2253 if (parts.size() != 3) {
2254 /* Not sure what's going on, so let's say it was written by an old version */
2258 if (boost::ends_with(parts[2], "pre")) {
2259 parts[2] = parts[2].substr(0, parts[2].length() - 3);
2262 int our_major = dcp::raw_convert<int>(parts[0]);
2263 int our_minor = dcp::raw_convert<int>(parts[1]);
2264 int our_micro = dcp::raw_convert<int>(parts[2]);
2266 if (our_major != major) {
2267 return our_major < major;
2270 if (our_minor != minor) {
2271 return our_minor < minor;
2274 return our_micro < micro;
2279 Film::set_territory_type(TerritoryType type)
2281 FilmChangeSignaller ch(this, FilmProperty::TERRITORY_TYPE);
2282 _territory_type = type;
2287 Film::set_ui_state(string key, string value)
2289 _ui_state[key] = value;
2294 boost::optional<std::string>
2295 Film::ui_state(string key) const
2297 auto iter = _ui_state.find(key);
2298 if (iter == _ui_state.end()) {
2302 return iter->second;
2307 Film::write_ui_state() const
2309 auto doc = make_shared<xmlpp::Document>();
2310 auto root = doc->create_root_node("UI");
2312 for (auto state: _ui_state) {
2313 root->add_child(state.first)->add_child_text(state.second);
2317 doc->write_to_file_formatted(dcp::filesystem::fix_long_path(file(ui_state_file)).string());
2323 Film::read_ui_state()
2326 cxml::Document xml("UI");
2327 xml.read_file(dcp::filesystem::fix_long_path(file(ui_state_file)));
2328 for (auto node: xml.node_children()) {
2329 if (!node->is_text()) {
2330 _ui_state[node->name()] = node->content();