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";
120 * AudioMapping XML changed.
122 * Subtitle offset changed to subtitle y offset, and subtitle x offset added.
124 * Use <Scale> tag in <VideoContent> rather than <Ratio>.
128 * Subtitle X and Y scale.
130 * Bumped to 32 for 2.0 branch; some times are expressed in Times rather
134 * Changed <Period> to <Subtitle> in FFmpegSubtitleStream
136 * Content only contains audio/subtitle-related tags if those things
139 * VideoFrameType in VideoContent is a string rather than an integer.
141 * EffectColour rather than OutlineColour in Subtitle.
143 * TextContent can be in a Caption tag, and some of the tag names
144 * have had Subtitle prefixes or suffixes removed.
146 * VideoContent scale expressed just as "guess" or "custom"
148 int const Film::current_state_version = 38;
151 /** Construct a Film object in a given directory.
153 * @param dir Film directory.
156 Film::Film (optional<boost::filesystem::path> dir)
157 : _playlist (new Playlist)
158 , _use_isdcf_name (Config::instance()->use_isdcf_name_by_default())
159 , _dcp_content_type (Config::instance()->default_dcp_content_type ())
160 , _container(Ratio::from_id("185"))
161 , _resolution (Resolution::TWO_K)
163 , _context_id (dcp::make_uuid ())
164 , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
165 , _video_frame_rate (24)
166 , _audio_channels (Config::instance()->default_dcp_audio_channels ())
169 , _interop (Config::instance()->default_interop ())
170 , _limit_to_smpte_bv20(false)
171 , _audio_processor (0)
172 , _reel_type (ReelType::SINGLE)
173 , _reel_length (2000000000)
174 , _reencode_j2k (false)
175 , _user_explicit_video_frame_rate (false)
176 , _user_explicit_container (false)
177 , _user_explicit_resolution (false)
178 , _name_language (dcp::LanguageTag("en-US"))
179 , _release_territory(Config::instance()->default_territory())
180 , _version_number (1)
181 , _status (dcp::Status::FINAL)
182 , _audio_language(Config::instance()->default_audio_language())
183 , _state_version (current_state_version)
187 set_isdcf_date_today ();
189 auto metadata = Config::instance()->default_metadata();
190 if (metadata.find("chain") != metadata.end()) {
191 _chain = metadata["chain"];
193 if (metadata.find("distributor") != metadata.end()) {
194 _distributor = metadata["distributor"];
196 if (metadata.find("facility") != metadata.end()) {
197 _facility = metadata["facility"];
199 if (metadata.find("studio") != metadata.end()) {
200 _studio = metadata["studio"];
203 _playlist_change_connection = _playlist->Change.connect (bind (&Film::playlist_change, this, _1));
204 _playlist_order_changed_connection = _playlist->OrderChange.connect (bind (&Film::playlist_order_changed, this));
205 _playlist_content_change_connection = _playlist->ContentChange.connect (bind (&Film::playlist_content_change, this, _1, _2, _3, _4));
206 _playlist_length_change_connection = _playlist->LengthChange.connect (bind(&Film::playlist_length_change, this));
209 set_directory(dcp::filesystem::weakly_canonical(*dir));
213 _log = make_shared<FileLog>(file("log"));
215 _log = make_shared<NullLog>();
218 _playlist->set_sequence (_sequence);
223 for (auto& i: _job_connections) {
227 for (auto& i: _audio_analysis_connections) {
233 Film::video_identifier () const
235 DCPOMATIC_ASSERT (container ());
237 string s = container()->id()
238 + "_" + resolution_to_string (_resolution)
239 + "_" + _playlist->video_identifier()
240 + "_" + raw_convert<string>(_video_frame_rate)
241 + "_" + raw_convert<string>(j2k_bandwidth());
244 /* This is insecure but hey, the key is in plaintext in metadata.xml */
245 s += "_E" + _key.hex();
254 if (_limit_to_smpte_bv20) {
272 /** @return The file to write video frame info to */
273 boost::filesystem::path
274 Film::info_file (DCPTimePeriod period) const
276 boost::filesystem::path p;
278 p /= video_identifier () + "_" + raw_convert<string> (period.from.get()) + "_" + raw_convert<string> (period.to.get());
282 boost::filesystem::path
283 Film::internal_video_asset_dir () const
285 return dir ("video");
288 boost::filesystem::path
289 Film::internal_video_asset_filename (DCPTimePeriod p) const
291 return video_identifier() + "_" + raw_convert<string> (p.from.get()) + "_" + raw_convert<string> (p.to.get()) + ".mxf";
294 boost::filesystem::path
295 Film::audio_analysis_path (shared_ptr<const Playlist> playlist) const
297 auto p = dir ("analysis");
300 for (auto content: playlist->content()) {
301 if (!content->audio) {
305 digester.add(content->digest());
306 digester.add(content->audio->mapping().digest());
307 if (playlist->content().size() != 1) {
308 /* Analyses should be considered equal regardless of gain
309 if they were made from just one piece of content. This
310 is because we can fake any gain change in a single-content
311 analysis at the plotting stage rather than having to
314 digester.add(content->audio->gain());
316 /* Likewise we only care about position if we're looking at a
317 * whole-project view.
319 digester.add(content->position().get());
320 digester.add(content->trim_start().get());
321 digester.add(content->trim_end().get());
325 if (audio_processor ()) {
326 digester.add (audio_processor()->id ());
329 digester.add (audio_channels());
331 p /= digester.get ();
336 boost::filesystem::path
337 Film::subtitle_analysis_path (shared_ptr<const Content> content) const
339 auto p = dir ("analysis");
342 digester.add (content->digest());
343 digester.add(_interop ? "1" : "0");
345 if (!content->text.empty()) {
346 auto tc = content->text.front();
347 digester.add (tc->x_scale());
348 digester.add (tc->y_scale());
349 for (auto i: tc->fonts()) {
350 digester.add (i->id());
353 digester.add (tc->effect().get());
355 digester.add (tc->line_spacing());
356 digester.add (tc->outline_width());
359 auto fc = dynamic_pointer_cast<const FFmpegContent>(content);
361 digester.add (fc->subtitle_stream()->identifier());
364 p /= digester.get ();
369 /** Start a job to send our DCP to the configured TMS */
371 Film::send_dcp_to_tms ()
373 JobManager::instance()->add(make_shared<UploadJob>(shared_from_this()));
376 shared_ptr<xmlpp::Document>
377 Film::metadata (bool with_content_paths) const
379 auto doc = make_shared<xmlpp::Document>();
380 auto root = doc->create_root_node ("Metadata");
382 root->add_child("Version")->add_child_text (raw_convert<string> (current_state_version));
383 auto last_write = root->add_child("LastWrittenBy");
384 last_write->add_child_text (dcpomatic_version);
385 last_write->set_attribute("git", dcpomatic_git_commit);
386 root->add_child("Name")->add_child_text (_name);
387 root->add_child("UseISDCFName")->add_child_text (_use_isdcf_name ? "1" : "0");
389 if (_dcp_content_type) {
390 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->isdcf_name ());
394 root->add_child("Container")->add_child_text (_container->id ());
397 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
398 root->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
399 root->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
400 root->add_child("AudioFrameRate")->add_child_text(raw_convert<string>(_audio_frame_rate));
401 root->add_child("ISDCFDate")->add_child_text (boost::gregorian::to_iso_string (_isdcf_date));
402 root->add_child("AudioChannels")->add_child_text (raw_convert<string> (_audio_channels));
403 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
404 root->add_child("Sequence")->add_child_text (_sequence ? "1" : "0");
405 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
406 root->add_child("LimitToSMPTEBv20")->add_child_text(_limit_to_smpte_bv20 ? "1" : "0");
407 root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
408 root->add_child("Key")->add_child_text (_key.hex ());
409 root->add_child("ContextID")->add_child_text (_context_id);
410 if (_audio_processor) {
411 root->add_child("AudioProcessor")->add_child_text (_audio_processor->id ());
413 root->add_child("ReelType")->add_child_text (raw_convert<string> (static_cast<int> (_reel_type)));
414 root->add_child("ReelLength")->add_child_text (raw_convert<string> (_reel_length));
415 root->add_child("ReencodeJ2K")->add_child_text (_reencode_j2k ? "1" : "0");
416 root->add_child("UserExplicitVideoFrameRate")->add_child_text(_user_explicit_video_frame_rate ? "1" : "0");
417 for (auto const& marker: _markers) {
418 auto m = root->add_child("Marker");
419 m->set_attribute("Type", dcp::marker_to_string(marker.first));
420 m->add_child_text(raw_convert<string>(marker.second.get()));
422 for (auto i: _ratings) {
423 i.as_xml (root->add_child("Rating"));
425 for (auto i: _content_versions) {
426 root->add_child("ContentVersion")->add_child_text(i);
428 root->add_child("NameLanguage")->add_child_text(_name_language.to_string());
429 root->add_child("TerritoryType")->add_child_text(territory_type_to_string(_territory_type));
430 if (_release_territory) {
431 root->add_child("ReleaseTerritory")->add_child_text(_release_territory->subtag());
433 if (_sign_language_video_language) {
434 root->add_child("SignLanguageVideoLanguage")->add_child_text(_sign_language_video_language->to_string());
436 root->add_child("VersionNumber")->add_child_text(raw_convert<string>(_version_number));
437 root->add_child("Status")->add_child_text(dcp::status_to_string(_status));
439 root->add_child("Chain")->add_child_text(*_chain);
442 root->add_child("Distributor")->add_child_text(*_distributor);
445 root->add_child("Facility")->add_child_text(*_facility);
448 root->add_child("Studio")->add_child_text(*_studio);
450 root->add_child("TempVersion")->add_child_text(_temp_version ? "1" : "0");
451 root->add_child("PreRelease")->add_child_text(_pre_release ? "1" : "0");
452 root->add_child("RedBand")->add_child_text(_red_band ? "1" : "0");
453 root->add_child("TwoDVersionOfThreeD")->add_child_text(_two_d_version_of_three_d ? "1" : "0");
455 root->add_child("LuminanceValue")->add_child_text(raw_convert<string>(_luminance->value()));
456 root->add_child("LuminanceUnit")->add_child_text(dcp::Luminance::unit_to_string(_luminance->unit()));
458 root->add_child("UserExplicitContainer")->add_child_text(_user_explicit_container ? "1" : "0");
459 root->add_child("UserExplicitResolution")->add_child_text(_user_explicit_resolution ? "1" : "0");
460 if (_audio_language) {
461 root->add_child("AudioLanguage")->add_child_text(_audio_language->to_string());
463 _playlist->as_xml (root->add_child ("Playlist"), with_content_paths);
469 Film::write_metadata (boost::filesystem::path path) const
471 metadata()->write_to_file_formatted(path.string());
474 /** Write state to our `metadata' file */
476 Film::write_metadata ()
478 DCPOMATIC_ASSERT (directory());
479 dcp::filesystem::create_directories(directory().get());
480 auto const filename = file(metadata_file);
482 metadata()->write_to_file_formatted(filename.string());
483 } catch (xmlpp::exception& e) {
484 throw FileError(String::compose("Could not write metadata file (%1)", e.what()), filename);
489 /** Write a template from this film */
491 Film::write_template (boost::filesystem::path path) const
493 dcp::filesystem::create_directories(path.parent_path());
494 shared_ptr<xmlpp::Document> doc = metadata (false);
495 metadata(false)->write_to_file_formatted(path.string());
498 /** Read state from our metadata file.
499 * @return Notes about things that the user should know about, or empty.
502 Film::read_metadata (optional<boost::filesystem::path> path)
505 if (dcp::filesystem::exists(file("metadata")) && !dcp::filesystem::exists(file(metadata_file))) {
506 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!"));
509 path = file (metadata_file);
512 if (!dcp::filesystem::exists(*path)) {
513 throw FileNotFoundError(*path);
516 cxml::Document f ("Metadata");
517 f.read_file(dcp::filesystem::fix_long_path(path.get()));
519 _state_version = f.number_child<int> ("Version");
520 if (_state_version > current_state_version) {
521 throw runtime_error (_("This film was created with a newer version of DCP-o-matic, and it cannot be loaded into this version. Sorry!"));
522 } else if (_state_version < current_state_version) {
523 /* This is an older version; save a copy (if we haven't already) */
524 auto const older = path->parent_path() / String::compose("metadata.%1.xml", _state_version);
525 if (!dcp::filesystem::is_regular_file(older)) {
527 dcp::filesystem::copy_file(*path, older);
529 /* Never mind; at least we tried */
534 _last_written_by = f.optional_string_child("LastWrittenBy");
536 _name = f.string_child ("Name");
537 if (_state_version >= 9) {
538 _use_isdcf_name = f.bool_child ("UseISDCFName");
539 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("ISDCFDate"));
541 _use_isdcf_name = f.bool_child ("UseDCIName");
542 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
547 auto c = f.optional_string_child("DCPContentType");
549 _dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
554 auto c = f.optional_string_child("Container");
556 _container = Ratio::from_id (c.get ());
560 _resolution = string_to_resolution (f.string_child ("Resolution"));
561 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
562 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
563 _audio_frame_rate = f.optional_number_child<int>("AudioFrameRate").get_value_or(48000);
564 _encrypted = f.bool_child ("Encrypted");
565 _audio_channels = f.number_child<int> ("AudioChannels");
566 /* We used to allow odd numbers (and zero) channels, but it's just not worth
569 if (_audio_channels == 0) {
571 } else if ((_audio_channels % 2) == 1) {
575 if (f.optional_bool_child("SequenceVideo")) {
576 _sequence = f.bool_child("SequenceVideo");
578 _sequence = f.bool_child("Sequence");
581 _three_d = f.bool_child ("ThreeD");
582 _interop = f.bool_child ("Interop");
583 _limit_to_smpte_bv20 = f.optional_bool_child("LimitToSMPTEBv20").get_value_or(false);
584 _key = dcp::Key (f.string_child ("Key"));
585 _context_id = f.optional_string_child("ContextID").get_value_or (dcp::make_uuid ());
587 if (f.optional_string_child ("AudioProcessor")) {
588 _audio_processor = AudioProcessor::from_id (f.string_child ("AudioProcessor"));
590 _audio_processor = 0;
593 if (_audio_processor && !Config::instance()->show_experimental_audio_processors()) {
594 auto ap = AudioProcessor::visible();
595 if (find(ap.begin(), ap.end(), _audio_processor) == ap.end()) {
596 Config::instance()->set_show_experimental_audio_processors(true);
600 _reel_type = static_cast<ReelType> (f.optional_number_child<int>("ReelType").get_value_or (static_cast<int>(ReelType::SINGLE)));
601 _reel_length = f.optional_number_child<int64_t>("ReelLength").get_value_or (2000000000);
602 _reencode_j2k = f.optional_bool_child("ReencodeJ2K").get_value_or(false);
603 _user_explicit_video_frame_rate = f.optional_bool_child("UserExplicitVideoFrameRate").get_value_or(false);
605 for (auto i: f.node_children("Marker")) {
606 _markers[dcp::marker_from_string(i->string_attribute("Type"))] = DCPTime(dcp::raw_convert<DCPTime::Type>(i->content()));
609 for (auto i: f.node_children("Rating")) {
610 _ratings.push_back (dcp::Rating(i));
613 for (auto i: f.node_children("ContentVersion")) {
614 _content_versions.push_back (i->content());
617 auto name_language = f.optional_string_child("NameLanguage");
619 _name_language = dcp::LanguageTag (*name_language);
621 auto territory_type = f.optional_string_child("TerritoryType");
622 if (territory_type) {
623 _territory_type = string_to_territory_type(*territory_type);
625 auto release_territory = f.optional_string_child("ReleaseTerritory");
626 if (release_territory) {
627 _release_territory = dcp::LanguageTag::RegionSubtag (*release_territory);
630 auto sign_language_video_language = f.optional_string_child("SignLanguageVideoLanguage");
631 if (sign_language_video_language) {
632 _sign_language_video_language = dcp::LanguageTag(*sign_language_video_language);
635 _version_number = f.optional_number_child<int>("VersionNumber").get_value_or(1);
637 auto status = f.optional_string_child("Status");
639 _status = dcp::string_to_status (*status);
642 _chain = f.optional_string_child("Chain");
643 _distributor = f.optional_string_child("Distributor");
644 _facility = f.optional_string_child("Facility");
645 _studio = f.optional_string_child("Studio");
646 _temp_version = f.optional_bool_child("TempVersion").get_value_or(false);
647 _pre_release = f.optional_bool_child("PreRelease").get_value_or(false);
648 _red_band = f.optional_bool_child("RedBand").get_value_or(false);
649 _two_d_version_of_three_d = f.optional_bool_child("TwoDVersionOfThreeD").get_value_or(false);
651 auto value = f.optional_number_child<float>("LuminanceValue");
652 auto unit = f.optional_string_child("LuminanceUnit");
654 _luminance = dcp::Luminance (*value, dcp::Luminance::string_to_unit(*unit));
657 /* Disable guessing for files made in previous DCP-o-matic versions */
658 _user_explicit_container = f.optional_bool_child("UserExplicitContainer").get_value_or(true);
659 _user_explicit_resolution = f.optional_bool_child("UserExplicitResolution").get_value_or(true);
661 auto audio_language = f.optional_string_child("AudioLanguage");
662 if (audio_language) {
663 _audio_language = dcp::LanguageTag(*audio_language);
666 /* Read the old ISDCFMetadata tag from 2.14.x metadata */
667 auto isdcf = f.optional_node_child("ISDCFMetadata");
669 if (auto territory = isdcf->optional_string_child("Territory")) {
671 _release_territory = dcp::LanguageTag::RegionSubtag(*territory);
673 /* Invalid region subtag; just ignore it */
676 if (auto audio_language = isdcf->optional_string_child("AudioLanguage")) {
678 _audio_language = dcp::LanguageTag(*audio_language);
680 /* Invalid language tag; just ignore it */
683 if (auto content_version = isdcf->optional_string_child("ContentVersion")) {
684 _content_versions.push_back (*content_version);
686 if (auto rating = isdcf->optional_string_child("Rating")) {
687 _ratings.push_back (dcp::Rating("", *rating));
689 if (auto mastered_luminance = isdcf->optional_number_child<float>("MasteredLuminance")) {
690 if (*mastered_luminance > 0) {
691 _luminance = dcp::Luminance(*mastered_luminance, dcp::Luminance::Unit::FOOT_LAMBERT);
694 _studio = isdcf->optional_string_child("Studio");
695 _facility = isdcf->optional_string_child("Facility");
696 _temp_version = isdcf->optional_bool_child("TempVersion").get_value_or(false);
697 _pre_release = isdcf->optional_bool_child("PreRelease").get_value_or(false);
698 _red_band = isdcf->optional_bool_child("RedBand").get_value_or(false);
699 _two_d_version_of_three_d = isdcf->optional_bool_child("TwoDVersionOfThreeD").get_value_or(false);
700 _chain = isdcf->optional_string_child("Chain");
704 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
706 /* Write backtraces to this film's directory, until another film is loaded */
708 set_backtrace_file (file ("backtrace.txt"));
715 /** Given a directory name, return its full path within the Film's directory.
716 * @param d directory name within the Film's directory.
717 * @param create true to create the directory (and its parents) if they do not exist.
719 boost::filesystem::path
720 Film::dir (boost::filesystem::path d, bool create) const
722 DCPOMATIC_ASSERT (_directory);
724 boost::filesystem::path p;
725 p /= _directory.get();
729 dcp::filesystem::create_directories(p);
735 /** Given a file or directory name, return its full path within the Film's directory.
736 * Any required parent directories will be created.
738 boost::filesystem::path
739 Film::file (boost::filesystem::path f) const
741 DCPOMATIC_ASSERT (_directory);
743 boost::filesystem::path p;
744 p /= _directory.get();
747 dcp::filesystem::create_directories(p.parent_path());
753 Film::mapped_audio_channels () const
757 if (audio_processor ()) {
758 /* Processors are mapped 1:1 to DCP outputs so we can work out mappings from there */
759 for (int i = 0; i < audio_processor()->out_channels(); ++i) {
760 mapped.push_back (i);
763 for (auto i: content()) {
765 auto c = i->audio->mapping().mapped_output_channels();
766 copy (c.begin(), c.end(), back_inserter(mapped));
778 pair<optional<dcp::LanguageTag>, vector<dcp::LanguageTag>>
779 Film::subtitle_languages(bool* burnt_in) const
785 pair<optional<dcp::LanguageTag>, vector<dcp::LanguageTag>> result;
786 for (auto i: content()) {
787 auto dcp = dynamic_pointer_cast<DCPContent>(i);
788 for (auto const& text: i->text) {
789 auto const use = text->use() || (dcp && dcp->reference_text(TextType::OPEN_SUBTITLE));
790 if (use && text->type() == TextType::OPEN_SUBTITLE) {
791 if (!text->burn() && burnt_in) {
794 if (text->language()) {
795 if (text->language_is_additional()) {
796 result.second.push_back(text->language().get());
798 result.first = text->language().get();
803 if (i->video && i->video->burnt_subtitle_language()) {
804 result.first = i->video->burnt_subtitle_language();
808 std::sort (result.second.begin(), result.second.end());
809 auto last = std::unique (result.second.begin(), result.second.end());
810 result.second.erase (last, result.second.end());
815 vector<dcp::LanguageTag>
816 Film::closed_caption_languages() const
818 vector<dcp::LanguageTag> result;
819 for (auto i: content()) {
820 for (auto text: i->text) {
821 if (text->use() && text->type() == TextType::CLOSED_CAPTION && text->dcp_track() && text->dcp_track()->language) {
822 result.push_back(*text->dcp_track()->language);
831 /** @return a ISDCF-compliant name for a DCP of this film */
833 Film::isdcf_name (bool if_created_now) const
837 auto raw_name = name ();
839 auto to_upper = [](string s) {
840 transform(s.begin(), s.end(), s.begin(), ::toupper);
844 /* Split the raw name up into words */
845 vector<string> words;
846 split (words, raw_name, is_any_of (" _-"));
850 /* Add each word to fixed_name */
851 for (auto i: words) {
854 /* First letter is always capitalised */
855 w[0] = toupper (w[0]);
857 /* Count caps in w */
859 for (size_t j = 0; j < w.size(); ++j) {
860 if (isupper (w[j])) {
865 /* If w is all caps make the rest of it lower case, otherwise
868 if (caps == w.size ()) {
869 for (size_t j = 1; j < w.size(); ++j) {
870 w[j] = tolower (w[j]);
874 for (size_t j = 0; j < w.size(); ++j) {
879 fixed_name = fixed_name.substr(0, Config::instance()->isdcf_name_part_length());
881 isdcf_name += fixed_name;
883 if (dcp_content_type()) {
884 isdcf_name += "_" + dcp_content_type()->isdcf_name();
885 string version = "1";
887 if (!_content_versions.empty()) {
888 auto cv = _content_versions[0];
889 if (!cv.empty() && std::all_of(cv.begin(), cv.end(), isdigit)) {
894 version = dcp::raw_convert<string>(_version_number);
896 isdcf_name += "-" + version;
900 isdcf_name += "-Temp";
904 isdcf_name += "-Pre";
908 isdcf_name += "-RedBand";
911 if (_chain && !_chain->empty()) {
912 isdcf_name += "-" + *_chain;
919 if (_two_d_version_of_three_d) {
924 auto fl = _luminance->value_in_foot_lamberts();
926 snprintf (buffer, sizeof(buffer), "%.1f", fl);
927 isdcf_name += String::compose("-%1fl", buffer);
930 if (video_frame_rate() != 24) {
931 isdcf_name += "-" + raw_convert<string>(video_frame_rate());
935 isdcf_name += "_" + container()->isdcf_name();
938 auto content_list = content();
940 /* XXX: this uses the first bit of content only */
942 /* Interior aspect ratio. The standard says we don't do this for trailers, for some strange reason */
943 if (dcp_content_type() && dcp_content_type()->libdcp_kind() != dcp::ContentKind::TRAILER) {
944 auto first_video = std::find_if(content_list.begin(), content_list.end(), [](shared_ptr<Content> c) { return static_cast<bool>(c->video); });
945 if (first_video != content_list.end()) {
946 auto first_ratio = lrintf((*first_video)->video->scaled_size(frame_size()).ratio() * 100);
947 auto container_ratio = lrintf(container()->ratio() * 100);
948 if (first_ratio != container_ratio) {
949 isdcf_name += "-" + dcp::raw_convert<string>(first_ratio);
954 auto entry_for_language = [](dcp::LanguageTag const& tag) {
955 /* Look up what we should be using for this tag in the DCNC name */
956 for (auto const& dcnc: dcp::dcnc_tags()) {
957 if (tag.to_string() == dcnc.first) {
961 /* Fallback to the language subtag, if there is one */
962 return tag.language() ? tag.language()->subtag() : "XX";
965 auto audio_language = _audio_language ? entry_for_language(*_audio_language) : "XX";
967 isdcf_name += "_" + to_upper (audio_language);
970 auto sub_langs = subtitle_languages(&burnt_in);
971 auto ccap_langs = closed_caption_languages();
972 if (sub_langs.first && sub_langs.first->language()) {
973 auto lang = entry_for_language(*sub_langs.first);
975 transform (lang.begin(), lang.end(), lang.begin(), ::tolower);
977 lang = to_upper (lang);
980 isdcf_name += "-" + lang;
981 } else if (!ccap_langs.empty()) {
982 isdcf_name += "-" + to_upper(entry_for_language(ccap_langs[0])) + "-CCAP";
988 if (_territory_type == TerritoryType::INTERNATIONAL_TEXTED) {
989 isdcf_name += "_INT-TD";
990 } else if (_territory_type == TerritoryType::INTERNATIONAL_TEXTLESS) {
991 isdcf_name += "_INT-TL";
992 } else if (_release_territory) {
993 auto territory = _release_territory->subtag();
994 isdcf_name += "_" + to_upper (territory);
995 if (!_ratings.empty()) {
996 auto label = _ratings[0].label;
997 boost::erase_all(label, "+");
998 boost::erase_all(label, "-");
999 isdcf_name += "-" + label;
1003 /* Count mapped audio channels */
1005 auto mapped = mapped_audio_channels ();
1007 auto ch = audio_channel_types (mapped, audio_channels());
1008 if (!ch.first && !ch.second) {
1009 isdcf_name += "_MOS";
1010 } else if (ch.first) {
1011 isdcf_name += String::compose("_%1%2", ch.first, ch.second);
1014 if (audio_channels() > static_cast<int>(dcp::Channel::HI) && find(mapped.begin(), mapped.end(), static_cast<int>(dcp::Channel::HI)) != mapped.end()) {
1015 isdcf_name += "-HI";
1017 if (audio_channels() > static_cast<int>(dcp::Channel::VI) && find(mapped.begin(), mapped.end(), static_cast<int>(dcp::Channel::VI)) != mapped.end()) {
1018 isdcf_name += "-VI";
1021 if (find_if(content_list.begin(), content_list.end(), [](shared_ptr<Content> c) { return static_cast<bool>(c->atmos); }) != content_list.end()) {
1022 isdcf_name += "-IAB";
1025 isdcf_name += "_" + resolution_to_string (_resolution);
1027 if (_studio && _studio->length() >= 2) {
1028 isdcf_name += "_" + to_upper (_studio->substr(0, 4));
1031 if (if_created_now) {
1032 isdcf_name += "_" + boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
1034 isdcf_name += "_" + boost::gregorian::to_iso_string (_isdcf_date);
1037 if (_facility && _facility->length() >= 3) {
1038 isdcf_name += "_" + to_upper(_facility->substr(0, 3));
1042 isdcf_name += "_IOP";
1044 isdcf_name += "_SMPTE";
1048 isdcf_name += "-3D";
1052 for (auto content: content_list) {
1053 auto dcp = dynamic_pointer_cast<const DCPContent>(content);
1058 bool any_text = false;
1059 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
1060 if (dcp->reference_text(static_cast<TextType>(i))) {
1064 if (dcp->reference_video() || dcp->reference_audio() || any_text) {
1070 isdcf_name += "_VF";
1072 isdcf_name += "_OV";
1078 /** @return name to give the DCP */
1080 Film::dcp_name (bool if_created_now) const
1083 if (use_isdcf_name()) {
1084 return careful_string_filter (isdcf_name (if_created_now));
1087 return careful_string_filter (name ());
1091 Film::set_directory (boost::filesystem::path d)
1098 Film::set_name (string n)
1100 FilmChangeSignaller ch(this, FilmProperty::NAME);
1105 Film::set_use_isdcf_name (bool u)
1107 FilmChangeSignaller ch(this, FilmProperty::USE_ISDCF_NAME);
1108 _use_isdcf_name = u;
1112 Film::set_dcp_content_type (DCPContentType const * t)
1114 FilmChangeSignaller ch(this, FilmProperty::DCP_CONTENT_TYPE);
1115 _dcp_content_type = t;
1119 /** @param explicit_user true if this is being set because of
1120 * a direct user request, false if it is being done because
1121 * DCP-o-matic is guessing the best container to use.
1124 Film::set_container (Ratio const * c, bool explicit_user)
1126 FilmChangeSignaller ch(this, FilmProperty::CONTAINER);
1129 if (explicit_user) {
1130 _user_explicit_container = true;
1135 /** @param explicit_user true if this is being set because of
1136 * a direct user request, false if it is being done because
1137 * DCP-o-matic is guessing the best resolution to use.
1140 Film::set_resolution (Resolution r, bool explicit_user)
1142 FilmChangeSignaller ch(this, FilmProperty::RESOLUTION);
1145 if (explicit_user) {
1146 _user_explicit_resolution = true;
1152 Film::set_j2k_bandwidth (int b)
1154 FilmChangeSignaller ch(this, FilmProperty::J2K_BANDWIDTH);
1158 /** @param f New frame rate.
1159 * @param user_explicit true if this comes from a direct user instruction, false if it is from
1160 * DCP-o-matic being helpful.
1163 Film::set_video_frame_rate (int f, bool user_explicit)
1165 FilmChangeSignaller ch(this, FilmProperty::VIDEO_FRAME_RATE);
1166 _video_frame_rate = f;
1167 if (user_explicit) {
1168 _user_explicit_video_frame_rate = true;
1173 Film::set_audio_channels (int c)
1175 FilmChangeSignaller ch(this, FilmProperty::AUDIO_CHANNELS);
1176 _audio_channels = c;
1180 Film::set_three_d (bool t)
1182 FilmChangeSignaller ch(this, FilmProperty::THREE_D);
1185 if (_three_d && _two_d_version_of_three_d) {
1186 set_two_d_version_of_three_d (false);
1191 Film::set_interop (bool i)
1193 FilmChangeSignaller ch(this, FilmProperty::INTEROP);
1199 Film::set_limit_to_smpte_bv20(bool limit)
1201 FilmChangeSignaller ch(this, FilmProperty::LIMIT_TO_SMPTE_BV20);
1202 _limit_to_smpte_bv20 = limit;
1207 Film::set_audio_processor (AudioProcessor const * processor)
1209 FilmChangeSignaller ch1(this, FilmProperty::AUDIO_PROCESSOR);
1210 FilmChangeSignaller ch2(this, FilmProperty::AUDIO_CHANNELS);
1211 _audio_processor = processor;
1215 Film::set_reel_type (ReelType t)
1217 FilmChangeSignaller ch(this, FilmProperty::REEL_TYPE);
1221 /** @param r Desired reel length in bytes */
1223 Film::set_reel_length (int64_t r)
1225 FilmChangeSignaller ch(this, FilmProperty::REEL_LENGTH);
1230 Film::set_reencode_j2k (bool r)
1232 FilmChangeSignaller ch(this, FilmProperty::REENCODE_J2K);
1237 Film::signal_change (ChangeType type, int p)
1239 signal_change(type, static_cast<FilmProperty>(p));
1243 Film::signal_change(ChangeType type, FilmProperty p)
1245 if (type == ChangeType::DONE) {
1248 if (p == FilmProperty::CONTENT) {
1249 if (!_user_explicit_video_frame_rate) {
1250 set_video_frame_rate (best_video_frame_rate());
1254 emit (boost::bind (boost::ref (Change), type, p));
1256 if (p == FilmProperty::VIDEO_FRAME_RATE || p == FilmProperty::SEQUENCE) {
1257 /* We want to call Playlist::maybe_sequence but this must happen after the
1258 main signal emission (since the butler will see that emission and un-suspend itself).
1260 emit (boost::bind(&Playlist::maybe_sequence, _playlist.get(), shared_from_this()));
1268 Film::set_isdcf_date_today ()
1270 _isdcf_date = boost::gregorian::day_clock::local_day ();
1274 boost::filesystem::path
1275 Film::j2c_path (int reel, Frame frame, Eyes eyes, bool tmp) const
1277 boost::filesystem::path p;
1279 p /= video_identifier ();
1282 snprintf(buffer, sizeof(buffer), "%08d_%08" PRId64, reel, frame);
1285 if (eyes == Eyes::LEFT) {
1287 } else if (eyes == Eyes::RIGHT) {
1302 /** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs.
1303 * The list will be returned in reverse order of timestamp (i.e. most recent first).
1308 if (!directory ()) {
1312 vector<CPLSummary> out;
1314 auto const dir = directory().get();
1315 for (auto const& item: dcp::filesystem::directory_iterator(dir)) {
1317 dcp::filesystem::is_directory(item) &&
1318 item.path().filename() != "j2c" && item.path().filename() != "video" && item.path().filename() != "info" && item.path().filename() != "analysis"
1322 out.push_back(CPLSummary(item));
1329 sort(out.begin(), out.end(), [](CPLSummary const& a, CPLSummary const& b) {
1330 return a.last_write_time > b.last_write_time;
1337 Film::set_encrypted (bool e)
1339 FilmChangeSignaller ch(this, FilmProperty::ENCRYPTED);
1344 Film::content () const
1346 return _playlist->content ();
1349 /** @param content Content to add.
1350 * @param disable_audio_analysis true to never do automatic audio analysis, even if it is enabled in configuration.
1353 Film::examine_and_add_content (shared_ptr<Content> content, bool disable_audio_analysis)
1355 if (dynamic_pointer_cast<FFmpegContent> (content) && _directory) {
1356 run_ffprobe (content->path(0), file("ffprobe.log"));
1359 auto j = make_shared<ExamineContentJob>(shared_from_this(), content);
1361 _job_connections.push_back (
1362 j->Finished.connect (bind (&Film::maybe_add_content, this, weak_ptr<Job>(j), weak_ptr<Content>(content), disable_audio_analysis))
1365 JobManager::instance()->add (j);
1369 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c, bool disable_audio_analysis)
1371 auto job = j.lock ();
1372 if (!job || !job->finished_ok ()) {
1376 auto content = c.lock ();
1381 add_content (content);
1383 if (Config::instance()->automatic_audio_analysis() && content->audio && !disable_audio_analysis) {
1384 auto playlist = make_shared<Playlist>();
1385 playlist->add (shared_from_this(), content);
1386 boost::signals2::connection c;
1387 JobManager::instance()->analyse_audio (
1388 shared_from_this(), playlist, false, c, bind (&Film::audio_analysis_finished, this)
1390 _audio_analysis_connections.push_back (c);
1395 Film::add_content (shared_ptr<Content> c)
1397 /* Add {video,subtitle} content after any existing {video,subtitle} content */
1399 c->set_position (shared_from_this(), _playlist->video_end(shared_from_this()));
1400 } else if (!c->text.empty()) {
1401 c->set_position (shared_from_this(), _playlist->text_end(shared_from_this()));
1404 if (_template_film) {
1405 /* Take settings from the first piece of content of c's type in _template */
1406 for (auto i: _template_film->content()) {
1407 c->take_settings_from (i);
1411 _playlist->add (shared_from_this(), c);
1413 maybe_set_container_and_resolution ();
1415 if (_audio_channels < 14) {
1416 set_audio_channels(14);
1418 set_interop (false);
1424 Film::maybe_set_container_and_resolution ()
1426 /* Get the only piece of video content, if there is only one */
1427 shared_ptr<VideoContent> video;
1428 for (auto content: _playlist->content()) {
1429 if (content->video) {
1431 video = content->video;
1439 /* This is the only piece of video content in this Film. Use it to make a guess for
1440 * DCP container size and resolution, unless the user has already explicitly set these
1443 if (!_user_explicit_container) {
1444 if (video->size().ratio() > 2.3) {
1445 set_container (Ratio::from_id("239"), false);
1447 set_container (Ratio::from_id("185"), false);
1451 if (!_user_explicit_resolution) {
1452 if (video->size_after_crop().width > 2048 || video->size_after_crop().height > 1080) {
1453 set_resolution (Resolution::FOUR_K, false);
1455 set_resolution (Resolution::TWO_K, false);
1462 Film::remove_content (shared_ptr<Content> c)
1464 _playlist->remove (c);
1465 maybe_set_container_and_resolution ();
1469 Film::move_content_earlier (shared_ptr<Content> c)
1471 _playlist->move_earlier (shared_from_this(), c);
1475 Film::move_content_later (shared_ptr<Content> c)
1477 _playlist->move_later (shared_from_this(), c);
1480 /** @return length of the film from time 0 to the last thing on the playlist,
1481 * with a minimum length of 1 second.
1484 Film::length () const
1486 return max(DCPTime::from_seconds(1), _playlist->length(shared_from_this()).ceil(video_frame_rate()));
1490 Film::best_video_frame_rate () const
1492 /* Don't default to anything above 30fps (make the user select that explicitly) */
1493 auto best = _playlist->best_video_frame_rate ();
1501 Film::active_frame_rate_change (DCPTime t) const
1503 return _playlist->active_frame_rate_change (t, video_frame_rate ());
1507 Film::playlist_content_change (ChangeType type, weak_ptr<Content> c, int p, bool frequent)
1509 if (p == ContentProperty::VIDEO_FRAME_RATE) {
1510 signal_change(type, FilmProperty::CONTENT);
1511 } else if (p == AudioContentProperty::STREAMS) {
1512 signal_change(type, FilmProperty::NAME);
1515 if (type == ChangeType::DONE) {
1516 emit (boost::bind (boost::ref (ContentChange), type, c, p, frequent));
1518 check_settings_consistency ();
1521 ContentChange (type, c, p, frequent);
1528 Film::playlist_length_change ()
1534 Film::playlist_change (ChangeType type)
1536 signal_change(type, FilmProperty::CONTENT);
1537 signal_change(type, FilmProperty::NAME);
1539 if (type == ChangeType::DONE) {
1540 check_settings_consistency ();
1546 /** Check for (and if necessary fix) impossible settings combinations, like
1547 * video set to being referenced when it can't be.
1550 Film::check_settings_consistency ()
1552 optional<int> atmos_rate;
1553 for (auto i: content()) {
1556 int rate = lrintf (i->atmos->edit_rate().as_float());
1557 if (atmos_rate && *atmos_rate != rate) {
1558 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."));
1559 } else if (!atmos_rate && rate != video_frame_rate()) {
1561 set_video_frame_rate (rate, false);
1562 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."));
1567 bool change_made = false;
1568 for (auto i: content()) {
1569 auto d = dynamic_pointer_cast<DCPContent>(i);
1575 if (d->reference_video() && !d->can_reference_video(shared_from_this(), why_not)) {
1576 d->set_reference_video(false);
1579 if (d->reference_audio() && !d->can_reference_audio(shared_from_this(), why_not)) {
1580 d->set_reference_audio(false);
1583 if (d->reference_text(TextType::OPEN_SUBTITLE) && !d->can_reference_text(shared_from_this(), TextType::OPEN_SUBTITLE, why_not)) {
1584 d->set_reference_text(TextType::OPEN_SUBTITLE, false);
1587 if (d->reference_text(TextType::CLOSED_CAPTION) && !d->can_reference_text(shared_from_this(), TextType::CLOSED_CAPTION, why_not)) {
1588 d->set_reference_text(TextType::CLOSED_CAPTION, false);
1594 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."));
1599 Film::playlist_order_changed ()
1601 /* XXX: missing PENDING */
1602 signal_change(ChangeType::DONE, FilmProperty::CONTENT_ORDER);
1607 Film::set_sequence (bool s)
1609 if (s == _sequence) {
1613 FilmChangeSignaller cc(this, FilmProperty::SEQUENCE);
1615 _playlist->set_sequence (s);
1618 /** @return Size of the largest possible image in whatever resolution we are using */
1620 Film::full_frame () const
1622 switch (_resolution) {
1623 case Resolution::TWO_K:
1624 return dcp::Size (2048, 1080);
1625 case Resolution::FOUR_K:
1626 return dcp::Size (4096, 2160);
1629 DCPOMATIC_ASSERT (false);
1630 return dcp::Size ();
1633 /** @return Size of the frame */
1635 Film::frame_size () const
1637 return fit_ratio_within (container()->ratio(), full_frame ());
1641 /** @return Area of Film::frame_size() that contains picture rather than pillar/letterboxing */
1643 Film::active_area () const
1645 auto const frame = frame_size ();
1648 for (auto i: content()) {
1650 dcp::Size s = i->video->scaled_size (frame);
1651 active.width = max(active.width, s.width);
1652 active.height = max(active.height, s.height);
1660 /* @param cpl_file CPL filename.
1661 * @param from KDM from time expressed as a local time with an offset from UTC.
1662 * @param until KDM to time expressed as a local time with an offset from UTC.
1665 Film::make_kdm(boost::filesystem::path cpl_file, dcp::LocalTime from, dcp::LocalTime until) const
1668 throw runtime_error (_("Cannot make a KDM as this project is not encrypted."));
1671 auto cpl = make_shared<dcp::CPL>(cpl_file);
1673 /* Find keys that have been added to imported, encrypted DCP content */
1674 list<dcp::DecryptedKDMKey> imported_keys;
1675 for (auto i: content()) {
1676 auto d = dynamic_pointer_cast<DCPContent> (i);
1677 if (d && d->kdm()) {
1678 dcp::DecryptedKDM kdm (d->kdm().get(), Config::instance()->decryption_chain()->key().get());
1679 auto keys = kdm.keys ();
1680 copy (keys.begin(), keys.end(), back_inserter (imported_keys));
1684 map<shared_ptr<const dcp::ReelFileAsset>, dcp::Key> keys;
1686 for (auto asset: cpl->reel_file_assets()) {
1687 if (!asset->encrypted()) {
1691 /* Get any imported key for this ID */
1693 for (auto const& k: imported_keys) {
1694 if (k.id() == asset->key_id().get()) {
1695 LOG_GENERAL("Using imported key for %1", asset->key_id().get());
1696 keys[asset] = k.key();
1702 /* No imported key; it must be an asset that we encrypted */
1703 LOG_GENERAL("Using our own key for %1", asset->key_id().get());
1704 keys[asset] = key();
1708 return dcp::DecryptedKDM (
1709 cpl->id(), keys, from, until, cpl->content_title_text(), cpl->content_title_text(), dcp::LocalTime().as_string()
1714 /** @return The approximate disk space required to encode a DCP of this film with the
1715 * current settings, in bytes.
1718 Film::required_disk_space () const
1720 return _playlist->required_disk_space (shared_from_this(), j2k_bandwidth(), audio_channels(), audio_frame_rate());
1723 /** This method checks the disk that the Film is on and tries to decide whether or not
1724 * there will be enough space to make a DCP for it. If so, true is returned; if not,
1725 * false is returned and required and available are filled in with the amount of disk space
1726 * required and available respectively (in GB).
1728 * Note: the decision made by this method isn't, of course, 100% reliable.
1731 Film::should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const
1733 /* Create a test file and see if we can hard-link it */
1734 boost::filesystem::path test = internal_video_asset_dir() / "test";
1735 boost::filesystem::path test2 = internal_video_asset_dir() / "test2";
1736 can_hard_link = true;
1737 dcp::File f(test, "w");
1740 boost::system::error_code ec;
1741 dcp::filesystem::create_hard_link(test, test2, ec);
1743 can_hard_link = false;
1745 dcp::filesystem::remove(test);
1746 dcp::filesystem::remove(test2);
1749 auto s = dcp::filesystem::space(internal_video_asset_dir());
1750 required = double (required_disk_space ()) / 1073741824.0f;
1751 if (!can_hard_link) {
1754 available = double (s.available) / 1073741824.0f;
1755 return (available - required) > 1;
1758 /** @return The names of the channels that audio contents' outputs are passed into;
1759 * this is either the DCP or a AudioProcessor.
1761 vector<NamedChannel>
1762 Film::audio_output_names () const
1764 if (audio_processor ()) {
1765 return audio_processor()->input_names ();
1768 DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
1770 vector<NamedChannel> n;
1772 for (int i = 0; i < audio_channels(); ++i) {
1773 if (Config::instance()->use_all_audio_channels() || (i != 8 && i != 9 && i != 15)) {
1774 n.push_back (NamedChannel(short_audio_channel_name(i), i));
1782 Film::repeat_content (ContentList c, int n)
1784 _playlist->repeat (shared_from_this(), c, n);
1788 Film::remove_content (ContentList c)
1790 _playlist->remove (c);
1794 Film::audio_analysis_finished ()
1800 Film::reels () const
1802 list<DCPTimePeriod> p;
1803 auto const len = length();
1805 switch (reel_type ()) {
1806 case ReelType::SINGLE:
1807 p.push_back (DCPTimePeriod (DCPTime (), len));
1809 case ReelType::BY_VIDEO_CONTENT:
1811 /* Collect all reel boundaries */
1812 list<DCPTime> split_points;
1813 split_points.push_back (DCPTime());
1814 split_points.push_back (len);
1815 for (auto c: content()) {
1817 for (auto t: c->reel_split_points(shared_from_this())) {
1818 split_points.push_back (t);
1820 split_points.push_back (c->end(shared_from_this()));
1824 split_points.sort ();
1825 split_points.unique ();
1827 /* Make them into periods, coalescing any that are less than 1 second long */
1828 optional<DCPTime> last;
1829 for (auto t: split_points) {
1830 if (last && (t - *last) >= DCPTime::from_seconds(1)) {
1831 /* Period from *last to t is long enough; use it and start a new one */
1832 p.push_back (DCPTimePeriod(*last, t));
1835 /* That was the first time, so start a new period */
1841 p.back().to = split_points.back();
1845 case ReelType::BY_LENGTH:
1848 /* Integer-divide reel length by the size of one frame to give the number of frames per reel,
1849 * making sure we don't go less than 1s long.
1851 Frame const reel_in_frames = max(_reel_length / ((j2k_bandwidth() / video_frame_rate()) / 8), static_cast<Frame>(video_frame_rate()));
1852 while (current < len) {
1853 DCPTime end = min (len, current + DCPTime::from_frames (reel_in_frames, video_frame_rate ()));
1854 p.push_back (DCPTimePeriod (current, end));
1864 /** @param period A period within the DCP
1865 * @return Name of the content which most contributes to the given period.
1868 Film::content_summary (DCPTimePeriod period) const
1870 return _playlist->content_summary (shared_from_this(), period);
1874 Film::use_template (string name)
1876 _template_film.reset (new Film (optional<boost::filesystem::path>()));
1877 _template_film->read_metadata (Config::instance()->template_read_path(name));
1878 _use_isdcf_name = _template_film->_use_isdcf_name;
1879 _dcp_content_type = _template_film->_dcp_content_type;
1880 _container = _template_film->_container;
1881 _resolution = _template_film->_resolution;
1882 _j2k_bandwidth = _template_film->_j2k_bandwidth;
1883 _video_frame_rate = _template_film->_video_frame_rate;
1884 _encrypted = _template_film->_encrypted;
1885 _audio_channels = _template_film->_audio_channels;
1886 _sequence = _template_film->_sequence;
1887 _three_d = _template_film->_three_d;
1888 _interop = _template_film->_interop;
1889 _audio_processor = _template_film->_audio_processor;
1890 _reel_type = _template_film->_reel_type;
1891 _reel_length = _template_film->_reel_length;
1894 pair<double, double>
1895 Film::speed_up_range (int dcp_frame_rate) const
1897 return _playlist->speed_up_range (dcp_frame_rate);
1901 Film::copy_from (shared_ptr<const Film> film)
1903 read_metadata (film->file (metadata_file));
1907 Film::references_dcp_video () const
1909 for (auto i: _playlist->content()) {
1910 auto d = dynamic_pointer_cast<DCPContent>(i);
1911 if (d && d->reference_video()) {
1920 Film::references_dcp_audio () const
1922 for (auto i: _playlist->content()) {
1923 auto d = dynamic_pointer_cast<DCPContent>(i);
1924 if (d && d->reference_audio()) {
1934 Film::contains_atmos_content () const
1936 auto const content = _playlist->content();
1937 return std::find_if(content.begin(), content.end(), [](shared_ptr<const Content> content) {
1938 return static_cast<bool>(content->atmos);
1939 }) != content.end();
1944 Film::closed_caption_tracks () const
1946 list<DCPTextTrack> tt;
1947 for (auto i: content()) {
1948 for (auto text: i->text) {
1949 /* XXX: Empty DCPTextTrack ends up being a magic value here - the "unknown" or "not specified" track */
1950 auto dtt = text->dcp_track().get_value_or(DCPTextTrack());
1951 if (text->type() == TextType::CLOSED_CAPTION && find(tt.begin(), tt.end(), dtt) == tt.end()) {
1961 Film::set_marker (dcp::Marker type, DCPTime time)
1963 FilmChangeSignaller ch(this, FilmProperty::MARKERS);
1964 _markers[type] = time;
1969 Film::unset_marker (dcp::Marker type)
1971 FilmChangeSignaller ch(this, FilmProperty::MARKERS);
1972 _markers.erase (type);
1977 Film::clear_markers ()
1979 FilmChangeSignaller ch(this, FilmProperty::MARKERS);
1985 Film::set_ratings (vector<dcp::Rating> r)
1987 FilmChangeSignaller ch(this, FilmProperty::RATINGS);
1992 Film::set_content_versions (vector<string> v)
1994 FilmChangeSignaller ch(this, FilmProperty::CONTENT_VERSIONS);
1995 _content_versions = v;
2000 Film::set_name_language (dcp::LanguageTag lang)
2002 FilmChangeSignaller ch(this, FilmProperty::NAME_LANGUAGE);
2003 _name_language = lang;
2008 Film::set_release_territory (optional<dcp::LanguageTag::RegionSubtag> region)
2010 FilmChangeSignaller ch(this, FilmProperty::RELEASE_TERRITORY);
2011 _release_territory = region;
2016 Film::set_status (dcp::Status s)
2018 FilmChangeSignaller ch(this, FilmProperty::STATUS);
2024 Film::set_version_number (int v)
2026 FilmChangeSignaller ch(this, FilmProperty::VERSION_NUMBER);
2027 _version_number = v;
2032 Film::set_chain (optional<string> c)
2034 FilmChangeSignaller ch(this, FilmProperty::CHAIN);
2040 Film::set_distributor (optional<string> d)
2042 FilmChangeSignaller ch(this, FilmProperty::DISTRIBUTOR);
2048 Film::set_luminance (optional<dcp::Luminance> l)
2050 FilmChangeSignaller ch(this, FilmProperty::LUMINANCE);
2056 Film::set_facility (optional<string> f)
2058 FilmChangeSignaller ch(this, FilmProperty::FACILITY);
2064 Film::set_studio (optional<string> s)
2066 FilmChangeSignaller ch(this, FilmProperty::STUDIO);
2072 Film::marker (dcp::Marker type) const
2074 auto i = _markers.find (type);
2075 if (i == _markers.end()) {
2081 shared_ptr<InfoFileHandle>
2082 Film::info_file_handle (DCPTimePeriod period, bool read) const
2084 return std::make_shared<InfoFileHandle>(_info_file_mutex, info_file(period), read);
2087 InfoFileHandle::InfoFileHandle (boost::mutex& mutex, boost::filesystem::path path, bool read)
2089 , _file(path, read ? "rb" : (dcp::filesystem::exists(path) ? "r+b" : "wb"))
2092 throw OpenFileError(path, errno, read ? OpenFileError::READ : (dcp::filesystem::exists(path) ? OpenFileError::READ_WRITE : OpenFileError::WRITE));
2097 /** Add FFOC and LFOC markers to a list if they are not already there */
2099 Film::add_ffoc_lfoc (Markers& markers) const
2101 if (markers.find(dcp::Marker::FFOC) == markers.end()) {
2102 markers[dcp::Marker::FFOC] = dcpomatic::DCPTime::from_frames(1, video_frame_rate());
2105 if (markers.find(dcp::Marker::LFOC) == markers.end()) {
2106 markers[dcp::Marker::LFOC] = length() - DCPTime::from_frames(1, video_frame_rate());
2112 Film::set_temp_version (bool t)
2114 FilmChangeSignaller ch(this, FilmProperty::TEMP_VERSION);
2120 Film::set_pre_release (bool p)
2122 FilmChangeSignaller ch(this, FilmProperty::PRE_RELEASE);
2128 Film::set_red_band (bool r)
2130 FilmChangeSignaller ch(this, FilmProperty::RED_BAND);
2136 Film::set_two_d_version_of_three_d (bool t)
2138 FilmChangeSignaller ch(this, FilmProperty::TWO_D_VERSION_OF_THREE_D);
2139 _two_d_version_of_three_d = t;
2144 Film::set_audio_language (optional<dcp::LanguageTag> language)
2146 FilmChangeSignaller ch(this, FilmProperty::AUDIO_LANGUAGE);
2147 _audio_language = language;
2152 Film::set_audio_frame_rate (int rate)
2154 FilmChangeSignaller ch(this, FilmProperty::AUDIO_FRAME_RATE);
2155 _audio_frame_rate = rate;
2160 Film::has_sign_language_video_channel () const
2162 return _audio_channels >= static_cast<int>(dcp::Channel::SIGN_LANGUAGE);
2167 Film::set_sign_language_video_language (optional<dcp::LanguageTag> lang)
2169 FilmChangeSignaller ch(this, FilmProperty::SIGN_LANGUAGE_VIDEO_LANGUAGE);
2170 _sign_language_video_language = lang;
2175 Film::set_dirty (bool dirty)
2177 auto const changed = dirty != _dirty;
2180 emit (boost::bind(boost::ref(DirtyChange), _dirty));
2185 /** @return true if the metadata was (probably) last written by a version earlier
2186 * than the given one; false if it definitely was not.
2189 Film::last_written_by_earlier_than(int major, int minor, int micro) const
2191 if (!_last_written_by) {
2195 vector<string> parts;
2196 boost::split(parts, *_last_written_by, boost::is_any_of("."));
2198 if (parts.size() != 3) {
2199 /* Not sure what's going on, so let's say it was written by an old version */
2203 if (boost::ends_with(parts[2], "pre")) {
2204 parts[2] = parts[2].substr(0, parts[2].length() - 3);
2207 int our_major = dcp::raw_convert<int>(parts[0]);
2208 int our_minor = dcp::raw_convert<int>(parts[1]);
2209 int our_micro = dcp::raw_convert<int>(parts[2]);
2211 if (our_major != major) {
2212 return our_major < major;
2215 if (our_minor != minor) {
2216 return our_minor < minor;
2219 return our_micro < micro;
2224 Film::set_territory_type(TerritoryType type)
2226 FilmChangeSignaller ch(this, FilmProperty::TERRITORY_TYPE);
2227 _territory_type = type;