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"
36 #include "dcp_content.h"
37 #include "dcp_content_type.h"
38 #include "dcp_encoder.h"
39 #include "dcpomatic_log.h"
41 #include "environment_info.h"
42 #include "examine_content_job.h"
43 #include "exceptions.h"
44 #include "ffmpeg_content.h"
45 #include "ffmpeg_subtitle_stream.h"
50 #include "job_manager.h"
51 #include "kdm_with_metadata.h"
56 #include "text_content.h"
57 #include "transcode_job.h"
58 #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/local_time.h>
67 #include <dcp/raw_convert.h>
68 #include <dcp/reel_asset.h>
69 #include <dcp/reel_file_asset.h>
71 #include <libxml++/libxml++.h>
72 #include <boost/algorithm/string.hpp>
73 #include <boost/filesystem.hpp>
74 #include <boost/regex.hpp>
86 using std::back_inserter;
89 using std::dynamic_pointer_cast;
94 using std::make_shared;
99 using std::runtime_error;
102 using std::shared_ptr;
106 using boost::optional;
107 using boost::is_any_of;
108 #if BOOST_VERSION >= 106100
109 using namespace boost::placeholders;
111 using dcp::raw_convert;
112 using namespace dcpomatic;
115 static constexpr char metadata_file[] = "metadata.xml";
119 * AudioMapping XML changed.
121 * Subtitle offset changed to subtitle y offset, and subtitle x offset added.
123 * Use <Scale> tag in <VideoContent> rather than <Ratio>.
127 * Subtitle X and Y scale.
129 * Bumped to 32 for 2.0 branch; some times are expressed in Times rather
133 * Changed <Period> to <Subtitle> in FFmpegSubtitleStream
135 * Content only contains audio/subtitle-related tags if those things
138 * VideoFrameType in VideoContent is a string rather than an integer.
140 * EffectColour rather than OutlineColour in Subtitle.
142 * TextContent can be in a Caption tag, and some of the tag names
143 * have had Subtitle prefixes or suffixes removed.
145 * VideoContent scale expressed just as "guess" or "custom"
147 int const Film::current_state_version = 38;
150 /** Construct a Film object in a given directory.
152 * @param dir Film directory.
155 Film::Film (optional<boost::filesystem::path> dir)
156 : _playlist (new Playlist)
157 , _use_isdcf_name (Config::instance()->use_isdcf_name_by_default())
158 , _dcp_content_type (Config::instance()->default_dcp_content_type ())
159 , _container(Ratio::from_id("185"))
160 , _resolution (Resolution::TWO_K)
162 , _context_id (dcp::make_uuid ())
163 , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
164 , _video_frame_rate (24)
165 , _audio_channels (Config::instance()->default_dcp_audio_channels ())
168 , _interop (Config::instance()->default_interop ())
169 , _audio_processor (0)
170 , _reel_type (ReelType::SINGLE)
171 , _reel_length (2000000000)
172 , _reencode_j2k (false)
173 , _user_explicit_video_frame_rate (false)
174 , _user_explicit_container (false)
175 , _user_explicit_resolution (false)
176 , _name_language (dcp::LanguageTag("en-US"))
177 , _version_number (1)
178 , _status (dcp::Status::FINAL)
179 , _audio_language(Config::instance()->default_audio_language())
180 , _state_version (current_state_version)
184 set_isdcf_date_today ();
186 auto metadata = Config::instance()->default_metadata();
187 if (metadata.find("chain") != metadata.end()) {
188 _chain = metadata["chain"];
190 if (metadata.find("distributor") != metadata.end()) {
191 _distributor = metadata["distributor"];
193 if (metadata.find("facility") != metadata.end()) {
194 _facility = metadata["facility"];
196 if (metadata.find("studio") != metadata.end()) {
197 _studio = metadata["studio"];
200 _playlist_change_connection = _playlist->Change.connect (bind (&Film::playlist_change, this, _1));
201 _playlist_order_changed_connection = _playlist->OrderChange.connect (bind (&Film::playlist_order_changed, this));
202 _playlist_content_change_connection = _playlist->ContentChange.connect (bind (&Film::playlist_content_change, this, _1, _2, _3, _4));
203 _playlist_length_change_connection = _playlist->LengthChange.connect (bind(&Film::playlist_length_change, this));
206 /* Make state.directory a complete path without ..s (where possible)
207 (Code swiped from Adam Bowen on stackoverflow)
208 XXX: couldn't/shouldn't this just be boost::filesystem::canonical?
211 boost::filesystem::path p (boost::filesystem::system_complete (dir.get()));
212 boost::filesystem::path result;
215 boost::system::error_code ec;
216 if (boost::filesystem::is_symlink(result, ec) || result.filename() == "..") {
219 result = result.parent_path ();
221 } else if (i != ".") {
226 set_directory (result.make_preferred ());
230 _log = make_shared<FileLog>(file("log"));
232 _log = make_shared<NullLog>();
235 _playlist->set_sequence (_sequence);
240 for (auto& i: _job_connections) {
244 for (auto& i: _audio_analysis_connections) {
250 Film::video_identifier () const
252 DCPOMATIC_ASSERT (container ());
254 string s = container()->id()
255 + "_" + resolution_to_string (_resolution)
256 + "_" + _playlist->video_identifier()
257 + "_" + raw_convert<string>(_video_frame_rate)
258 + "_" + raw_convert<string>(j2k_bandwidth());
261 /* This is insecure but hey, the key is in plaintext in metadata.xml */
262 s += "_E" + _key.hex();
284 /** @return The file to write video frame info to */
285 boost::filesystem::path
286 Film::info_file (DCPTimePeriod period) const
288 boost::filesystem::path p;
290 p /= video_identifier () + "_" + raw_convert<string> (period.from.get()) + "_" + raw_convert<string> (period.to.get());
294 boost::filesystem::path
295 Film::internal_video_asset_dir () const
297 return dir ("video");
300 boost::filesystem::path
301 Film::internal_video_asset_filename (DCPTimePeriod p) const
303 return video_identifier() + "_" + raw_convert<string> (p.from.get()) + "_" + raw_convert<string> (p.to.get()) + ".mxf";
306 boost::filesystem::path
307 Film::audio_analysis_path (shared_ptr<const Playlist> playlist) const
309 auto p = dir ("analysis");
312 for (auto i: playlist->content()) {
317 digester.add (i->digest());
318 digester.add (i->audio->mapping().digest());
319 if (playlist->content().size() != 1) {
320 /* Analyses should be considered equal regardless of gain
321 if they were made from just one piece of content. This
322 is because we can fake any gain change in a single-content
323 analysis at the plotting stage rather than having to
326 digester.add (i->audio->gain());
328 /* Likewise we only care about position if we're looking at a
329 * whole-project view.
331 digester.add (i->position().get());
332 digester.add (i->trim_start().get());
333 digester.add (i->trim_end().get());
337 if (audio_processor ()) {
338 digester.add (audio_processor()->id ());
341 digester.add (audio_channels());
343 p /= digester.get ();
348 boost::filesystem::path
349 Film::subtitle_analysis_path (shared_ptr<const Content> content) const
351 auto p = dir ("analysis");
354 digester.add (content->digest());
356 if (!content->text.empty()) {
357 auto tc = content->text.front();
358 digester.add (tc->x_scale());
359 digester.add (tc->y_scale());
360 for (auto i: tc->fonts()) {
361 digester.add (i->id());
364 digester.add (tc->effect().get());
366 digester.add (tc->line_spacing());
367 digester.add (tc->outline_width());
370 auto fc = dynamic_pointer_cast<const FFmpegContent>(content);
372 digester.add (fc->subtitle_stream()->identifier());
375 p /= digester.get ();
380 /** Start a job to send our DCP to the configured TMS */
382 Film::send_dcp_to_tms ()
384 JobManager::instance()->add(make_shared<UploadJob>(shared_from_this()));
387 shared_ptr<xmlpp::Document>
388 Film::metadata (bool with_content_paths) const
390 auto doc = make_shared<xmlpp::Document>();
391 auto root = doc->create_root_node ("Metadata");
393 root->add_child("Version")->add_child_text (raw_convert<string> (current_state_version));
394 auto last_write = root->add_child("LastWrittenBy");
395 last_write->add_child_text (dcpomatic_version);
396 last_write->set_attribute("git", dcpomatic_git_commit);
397 root->add_child("Name")->add_child_text (_name);
398 root->add_child("UseISDCFName")->add_child_text (_use_isdcf_name ? "1" : "0");
400 if (_dcp_content_type) {
401 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->isdcf_name ());
405 root->add_child("Container")->add_child_text (_container->id ());
408 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
409 root->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
410 root->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
411 root->add_child("AudioFrameRate")->add_child_text(raw_convert<string>(_audio_frame_rate));
412 root->add_child("ISDCFDate")->add_child_text (boost::gregorian::to_iso_string (_isdcf_date));
413 root->add_child("AudioChannels")->add_child_text (raw_convert<string> (_audio_channels));
414 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
415 root->add_child("Sequence")->add_child_text (_sequence ? "1" : "0");
416 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
417 root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
418 root->add_child("Key")->add_child_text (_key.hex ());
419 root->add_child("ContextID")->add_child_text (_context_id);
420 if (_audio_processor) {
421 root->add_child("AudioProcessor")->add_child_text (_audio_processor->id ());
423 root->add_child("ReelType")->add_child_text (raw_convert<string> (static_cast<int> (_reel_type)));
424 root->add_child("ReelLength")->add_child_text (raw_convert<string> (_reel_length));
425 root->add_child("ReencodeJ2K")->add_child_text (_reencode_j2k ? "1" : "0");
426 root->add_child("UserExplicitVideoFrameRate")->add_child_text(_user_explicit_video_frame_rate ? "1" : "0");
427 for (map<dcp::Marker, DCPTime>::const_iterator i = _markers.begin(); i != _markers.end(); ++i) {
428 auto m = root->add_child("Marker");
429 m->set_attribute("Type", dcp::marker_to_string(i->first));
430 m->add_child_text(raw_convert<string>(i->second.get()));
432 for (auto i: _ratings) {
433 i.as_xml (root->add_child("Rating"));
435 for (auto i: _content_versions) {
436 root->add_child("ContentVersion")->add_child_text(i);
438 root->add_child("NameLanguage")->add_child_text(_name_language.to_string());
439 if (_release_territory) {
440 root->add_child("ReleaseTerritory")->add_child_text(_release_territory->subtag());
442 if (_sign_language_video_language) {
443 root->add_child("SignLanguageVideoLanguage")->add_child_text(_sign_language_video_language->to_string());
445 root->add_child("VersionNumber")->add_child_text(raw_convert<string>(_version_number));
446 root->add_child("Status")->add_child_text(dcp::status_to_string(_status));
448 root->add_child("Chain")->add_child_text(*_chain);
451 root->add_child("Distributor")->add_child_text(*_distributor);
454 root->add_child("Facility")->add_child_text(*_facility);
457 root->add_child("Studio")->add_child_text(*_studio);
459 root->add_child("TempVersion")->add_child_text(_temp_version ? "1" : "0");
460 root->add_child("PreRelease")->add_child_text(_pre_release ? "1" : "0");
461 root->add_child("RedBand")->add_child_text(_red_band ? "1" : "0");
462 root->add_child("TwoDVersionOfThreeD")->add_child_text(_two_d_version_of_three_d ? "1" : "0");
464 root->add_child("LuminanceValue")->add_child_text(raw_convert<string>(_luminance->value()));
465 root->add_child("LuminanceUnit")->add_child_text(dcp::Luminance::unit_to_string(_luminance->unit()));
467 root->add_child("UserExplicitContainer")->add_child_text(_user_explicit_container ? "1" : "0");
468 root->add_child("UserExplicitResolution")->add_child_text(_user_explicit_resolution ? "1" : "0");
469 if (_audio_language) {
470 root->add_child("AudioLanguage")->add_child_text(_audio_language->to_string());
472 _playlist->as_xml (root->add_child ("Playlist"), with_content_paths);
478 Film::write_metadata (boost::filesystem::path path) const
480 metadata()->write_to_file_formatted(path.string());
483 /** Write state to our `metadata' file */
485 Film::write_metadata ()
487 DCPOMATIC_ASSERT (directory());
488 boost::filesystem::create_directories (directory().get());
489 metadata()->write_to_file_formatted(file(metadata_file).string());
493 /** Write a template from this film */
495 Film::write_template (boost::filesystem::path path) const
497 boost::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 (boost::filesystem::exists (file ("metadata")) && !boost::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 (!boost::filesystem::exists(*path)) {
517 throw FileNotFoundError(*path);
520 cxml::Document f ("Metadata");
521 f.read_file (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 (!boost::filesystem::is_regular_file(older)) {
531 boost::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 _key = dcp::Key (f.string_child ("Key"));
588 _context_id = f.optional_string_child("ContextID").get_value_or (dcp::make_uuid ());
590 if (f.optional_string_child ("AudioProcessor")) {
591 _audio_processor = AudioProcessor::from_id (f.string_child ("AudioProcessor"));
593 _audio_processor = 0;
596 if (_audio_processor && !Config::instance()->show_experimental_audio_processors()) {
597 auto ap = AudioProcessor::visible();
598 if (find(ap.begin(), ap.end(), _audio_processor) == ap.end()) {
599 Config::instance()->set_show_experimental_audio_processors(true);
603 _reel_type = static_cast<ReelType> (f.optional_number_child<int>("ReelType").get_value_or (static_cast<int>(ReelType::SINGLE)));
604 _reel_length = f.optional_number_child<int64_t>("ReelLength").get_value_or (2000000000);
605 _reencode_j2k = f.optional_bool_child("ReencodeJ2K").get_value_or(false);
606 _user_explicit_video_frame_rate = f.optional_bool_child("UserExplicitVideoFrameRate").get_value_or(false);
608 for (auto i: f.node_children("Marker")) {
609 _markers[dcp::marker_from_string(i->string_attribute("Type"))] = DCPTime(dcp::raw_convert<DCPTime::Type>(i->content()));
612 for (auto i: f.node_children("Rating")) {
613 _ratings.push_back (dcp::Rating(i));
616 for (auto i: f.node_children("ContentVersion")) {
617 _content_versions.push_back (i->content());
620 auto name_language = f.optional_string_child("NameLanguage");
622 _name_language = dcp::LanguageTag (*name_language);
624 auto release_territory = f.optional_string_child("ReleaseTerritory");
625 if (release_territory) {
626 _release_territory = dcp::LanguageTag::RegionSubtag (*release_territory);
629 auto sign_language_video_language = f.optional_string_child("SignLanguageVideoLanguage");
630 if (sign_language_video_language) {
631 _sign_language_video_language = dcp::LanguageTag(*sign_language_video_language);
634 _version_number = f.optional_number_child<int>("VersionNumber").get_value_or(0);
636 auto status = f.optional_string_child("Status");
638 _status = dcp::string_to_status (*status);
641 _chain = f.optional_string_child("Chain");
642 _distributor = f.optional_string_child("Distributor");
643 _facility = f.optional_string_child("Facility");
644 _studio = f.optional_string_child("Studio");
645 _temp_version = f.optional_bool_child("TempVersion").get_value_or(false);
646 _pre_release = f.optional_bool_child("PreRelease").get_value_or(false);
647 _red_band = f.optional_bool_child("RedBand").get_value_or(false);
648 _two_d_version_of_three_d = f.optional_bool_child("TwoDVersionOfThreeD").get_value_or(false);
650 auto value = f.optional_number_child<float>("LuminanceValue");
651 auto unit = f.optional_string_child("LuminanceUnit");
653 _luminance = dcp::Luminance (*value, dcp::Luminance::string_to_unit(*unit));
656 /* Disable guessing for files made in previous DCP-o-matic versions */
657 _user_explicit_container = f.optional_bool_child("UserExplicitContainer").get_value_or(true);
658 _user_explicit_resolution = f.optional_bool_child("UserExplicitResolution").get_value_or(true);
660 auto audio_language = f.optional_string_child("AudioLanguage");
661 if (audio_language) {
662 _audio_language = dcp::LanguageTag(*audio_language);
665 /* Read the old ISDCFMetadata tag from 2.14.x metadata */
666 auto isdcf = f.optional_node_child("ISDCFMetadata");
668 if (auto territory = isdcf->optional_string_child("Territory")) {
670 _release_territory = dcp::LanguageTag::RegionSubtag(*territory);
672 /* Invalid region subtag; just ignore it */
675 if (auto audio_language = isdcf->optional_string_child("AudioLanguage")) {
677 _audio_language = dcp::LanguageTag(*audio_language);
679 /* Invalid language tag; just ignore it */
682 if (auto content_version = isdcf->optional_string_child("ContentVersion")) {
683 _content_versions.push_back (*content_version);
685 if (auto rating = isdcf->optional_string_child("Rating")) {
686 _ratings.push_back (dcp::Rating("", *rating));
688 if (auto mastered_luminance = isdcf->optional_number_child<float>("MasteredLuminance")) {
689 if (*mastered_luminance > 0) {
690 _luminance = dcp::Luminance(*mastered_luminance, dcp::Luminance::Unit::FOOT_LAMBERT);
693 _studio = isdcf->optional_string_child("Studio");
694 _facility = isdcf->optional_string_child("Facility");
695 _temp_version = isdcf->optional_bool_child("TempVersion").get_value_or("false");
696 _pre_release = isdcf->optional_bool_child("PreRelease").get_value_or("false");
697 _red_band = isdcf->optional_bool_child("RedBand").get_value_or("false");
698 _two_d_version_of_three_d = isdcf->optional_bool_child("TwoDVersionOfThreeD").get_value_or("false");
699 _chain = isdcf->optional_string_child("Chain");
703 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
705 /* Write backtraces to this film's directory, until another film is loaded */
707 set_backtrace_file (file ("backtrace.txt"));
714 /** Given a directory name, return its full path within the Film's directory.
715 * @param d directory name within the Film's directory.
716 * @param create true to create the directory (and its parents) if they do not exist.
718 boost::filesystem::path
719 Film::dir (boost::filesystem::path d, bool create) const
721 DCPOMATIC_ASSERT (_directory);
723 boost::filesystem::path p;
724 p /= _directory.get();
728 boost::filesystem::create_directories (p);
734 /** Given a file or directory name, return its full path within the Film's directory.
735 * Any required parent directories will be created.
737 boost::filesystem::path
738 Film::file (boost::filesystem::path f) const
740 DCPOMATIC_ASSERT (_directory);
742 boost::filesystem::path p;
743 p /= _directory.get();
746 boost::filesystem::create_directories (p.parent_path ());
752 Film::mapped_audio_channels () const
756 if (audio_processor ()) {
757 /* Processors are mapped 1:1 to DCP outputs so we can work out mappings from there */
758 for (int i = 0; i < audio_processor()->out_channels(); ++i) {
759 mapped.push_back (i);
762 for (auto i: content()) {
764 auto c = i->audio->mapping().mapped_output_channels();
765 copy (c.begin(), c.end(), back_inserter(mapped));
777 pair<optional<dcp::LanguageTag>, vector<dcp::LanguageTag>>
778 Film::subtitle_languages () const
780 pair<optional<dcp::LanguageTag>, vector<dcp::LanguageTag>> result;
781 for (auto i: content()) {
782 for (auto j: i->text) {
783 if (j->use() && j->type() == TextType::OPEN_SUBTITLE && j->language()) {
784 if (j->language_is_additional()) {
785 result.second.push_back (j->language().get());
787 result.first = j->language().get();
791 if (i->video && i->video->burnt_subtitle_language()) {
792 result.first = i->video->burnt_subtitle_language();
796 std::sort (result.second.begin(), result.second.end());
797 auto last = std::unique (result.second.begin(), result.second.end());
798 result.second.erase (last, result.second.end());
803 /** @return a ISDCF-compliant name for a DCP of this film */
805 Film::isdcf_name (bool if_created_now) const
809 auto raw_name = name ();
811 /* Split the raw name up into words */
812 vector<string> words;
813 split (words, raw_name, is_any_of (" _-"));
817 /* Add each word to fixed_name */
818 for (auto i: words) {
821 /* First letter is always capitalised */
822 w[0] = toupper (w[0]);
824 /* Count caps in w */
826 for (size_t j = 0; j < w.size(); ++j) {
827 if (isupper (w[j])) {
832 /* If w is all caps make the rest of it lower case, otherwise
835 if (caps == w.size ()) {
836 for (size_t j = 1; j < w.size(); ++j) {
837 w[j] = tolower (w[j]);
841 for (size_t j = 0; j < w.size(); ++j) {
846 fixed_name = fixed_name.substr(0, 14);
848 isdcf_name += fixed_name;
850 if (dcp_content_type()) {
851 isdcf_name += "_" + dcp_content_type()->isdcf_name();
852 string version = "1";
854 if (!_content_versions.empty()) {
855 auto cv = _content_versions[0];
856 if (!cv.empty() && std::all_of(cv.begin(), cv.end(), isdigit)) {
861 version = dcp::raw_convert<string>(_version_number);
863 isdcf_name += "-" + version;
867 isdcf_name += "-Temp";
871 isdcf_name += "-Pre";
875 isdcf_name += "-RedBand";
878 if (_chain && !_chain->empty()) {
879 isdcf_name += "-" + *_chain;
886 if (_two_d_version_of_three_d) {
891 auto fl = _luminance->value_in_foot_lamberts();
893 snprintf (buffer, sizeof(buffer), "%.1f", fl);
894 isdcf_name += String::compose("-%1fl", buffer);
897 if (video_frame_rate() != 24) {
898 isdcf_name += "-" + raw_convert<string>(video_frame_rate());
902 isdcf_name += "_" + container()->isdcf_name();
905 /* XXX: this uses the first bit of content only */
907 /* Interior aspect ratio. The standard says we don't do this for trailers, for some strange reason */
908 if (dcp_content_type() && dcp_content_type()->libdcp_kind() != dcp::ContentKind::TRAILER) {
910 auto first_video = std::find_if(cl.begin(), cl.end(), [](shared_ptr<Content> c) { return static_cast<bool>(c->video); });
911 if (first_video != cl.end()) {
912 auto first_ratio = lrintf((*first_video)->video->scaled_size(frame_size()).ratio() * 100);
913 auto container_ratio = lrintf(container()->ratio() * 100);
914 if (first_ratio != container_ratio) {
915 isdcf_name += "-" + dcp::raw_convert<string>(first_ratio);
920 auto entry_for_language = [](dcp::LanguageTag const& tag) {
921 /* Look up what we should be using for this tag in the DCNC name */
922 for (auto const& dcnc: dcp::dcnc_tags()) {
923 if (tag.to_string() == dcnc.first) {
927 /* Fallback to the language subtag, if there is one */
928 return tag.language() ? tag.language()->subtag() : "XX";
931 auto audio_language = _audio_language ? entry_for_language(*_audio_language) : "XX";
933 isdcf_name += "_" + to_upper (audio_language);
935 /* I'm not clear on the precise details of the convention for CCAP labelling;
936 for now I'm just appending -CCAP if we have any closed captions.
939 auto burnt_in = true;
941 for (auto i: content()) {
942 for (auto j: i->text) {
943 if (j->type() == TextType::OPEN_SUBTITLE && j->use() && !j->burn()) {
945 } else if (j->type() == TextType::CLOSED_CAPTION && j->use()) {
951 auto sub_langs = subtitle_languages();
952 if (sub_langs.first && sub_langs.first->language()) {
953 auto lang = entry_for_language(*sub_langs.first);
955 transform (lang.begin(), lang.end(), lang.begin(), ::tolower);
957 lang = to_upper (lang);
960 isdcf_name += "-" + lang;
962 isdcf_name += "-CCAP";
969 if (_release_territory) {
970 auto territory = _release_territory->subtag();
971 isdcf_name += "_" + to_upper (territory);
972 if (_ratings.empty ()) {
975 auto label = _ratings[0].label;
976 boost::erase_all(label, "+");
977 boost::erase_all(label, "-");
978 isdcf_name += "-" + label;
982 /* Count mapped audio channels */
984 auto mapped = mapped_audio_channels ();
986 auto ch = audio_channel_types (mapped, audio_channels());
987 if (!ch.first && !ch.second) {
988 isdcf_name += "_MOS";
989 } else if (ch.first) {
990 isdcf_name += String::compose("_%1%2", ch.first, ch.second);
993 if (audio_channels() > static_cast<int>(dcp::Channel::HI) && find(mapped.begin(), mapped.end(), static_cast<int>(dcp::Channel::HI)) != mapped.end()) {
996 if (audio_channels() > static_cast<int>(dcp::Channel::VI) && find(mapped.begin(), mapped.end(), static_cast<int>(dcp::Channel::VI)) != mapped.end()) {
1000 isdcf_name += "_" + resolution_to_string (_resolution);
1002 if (_studio && _studio->length() >= 2) {
1003 isdcf_name += "_" + to_upper (_studio->substr(0, 4));
1006 if (if_created_now) {
1007 isdcf_name += "_" + boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
1009 isdcf_name += "_" + boost::gregorian::to_iso_string (_isdcf_date);
1012 if (_facility && _facility->length() >= 3) {
1013 isdcf_name += "_" + to_upper(_facility->substr(0, 3));
1017 isdcf_name += "_IOP";
1019 isdcf_name += "_SMPTE";
1023 isdcf_name += "-3D";
1027 for (auto i: content()) {
1028 auto dc = dynamic_pointer_cast<const DCPContent>(i);
1033 bool any_text = false;
1034 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
1035 if (dc->reference_text(static_cast<TextType>(i))) {
1039 if (dc->reference_video() || dc->reference_audio() || any_text) {
1045 isdcf_name += "_VF";
1047 isdcf_name += "_OV";
1053 /** @return name to give the DCP */
1055 Film::dcp_name (bool if_created_now) const
1058 if (use_isdcf_name()) {
1059 return careful_string_filter (isdcf_name (if_created_now));
1062 return careful_string_filter (name ());
1066 Film::set_directory (boost::filesystem::path d)
1073 Film::set_name (string n)
1075 FilmChangeSignaller ch (this, Property::NAME);
1080 Film::set_use_isdcf_name (bool u)
1082 FilmChangeSignaller ch (this, Property::USE_ISDCF_NAME);
1083 _use_isdcf_name = u;
1087 Film::set_dcp_content_type (DCPContentType const * t)
1089 FilmChangeSignaller ch (this, Property::DCP_CONTENT_TYPE);
1090 _dcp_content_type = t;
1094 /** @param explicit_user true if this is being set because of
1095 * a direct user request, false if it is being done because
1096 * DCP-o-matic is guessing the best container to use.
1099 Film::set_container (Ratio const * c, bool explicit_user)
1101 FilmChangeSignaller ch (this, Property::CONTAINER);
1104 if (explicit_user) {
1105 _user_explicit_container = true;
1110 /** @param explicit_user true if this is being set because of
1111 * a direct user request, false if it is being done because
1112 * DCP-o-matic is guessing the best resolution to use.
1115 Film::set_resolution (Resolution r, bool explicit_user)
1117 FilmChangeSignaller ch (this, Property::RESOLUTION);
1120 if (explicit_user) {
1121 _user_explicit_resolution = true;
1127 Film::set_j2k_bandwidth (int b)
1129 FilmChangeSignaller ch (this, Property::J2K_BANDWIDTH);
1133 /** @param f New frame rate.
1134 * @param user_explicit true if this comes from a direct user instruction, false if it is from
1135 * DCP-o-matic being helpful.
1138 Film::set_video_frame_rate (int f, bool user_explicit)
1140 FilmChangeSignaller ch (this, Property::VIDEO_FRAME_RATE);
1141 _video_frame_rate = f;
1142 if (user_explicit) {
1143 _user_explicit_video_frame_rate = true;
1148 Film::set_audio_channels (int c)
1150 FilmChangeSignaller ch (this, Property::AUDIO_CHANNELS);
1151 _audio_channels = c;
1155 Film::set_three_d (bool t)
1157 FilmChangeSignaller ch (this, Property::THREE_D);
1160 if (_three_d && _two_d_version_of_three_d) {
1161 set_two_d_version_of_three_d (false);
1166 Film::set_interop (bool i)
1168 FilmChangeSignaller ch (this, Property::INTEROP);
1173 Film::set_audio_processor (AudioProcessor const * processor)
1175 FilmChangeSignaller ch1 (this, Property::AUDIO_PROCESSOR);
1176 FilmChangeSignaller ch2 (this, Property::AUDIO_CHANNELS);
1177 _audio_processor = processor;
1181 Film::set_reel_type (ReelType t)
1183 FilmChangeSignaller ch (this, Property::REEL_TYPE);
1187 /** @param r Desired reel length in bytes */
1189 Film::set_reel_length (int64_t r)
1191 FilmChangeSignaller ch (this, Property::REEL_LENGTH);
1196 Film::set_reencode_j2k (bool r)
1198 FilmChangeSignaller ch (this, Property::REENCODE_J2K);
1203 Film::signal_change (ChangeType type, int p)
1205 signal_change (type, static_cast<Property>(p));
1209 Film::signal_change (ChangeType type, Property p)
1211 if (type == ChangeType::DONE) {
1214 if (p == Property::CONTENT) {
1215 if (!_user_explicit_video_frame_rate) {
1216 set_video_frame_rate (best_video_frame_rate());
1220 emit (boost::bind (boost::ref (Change), type, p));
1222 if (p == Property::VIDEO_FRAME_RATE || p == Property::SEQUENCE) {
1223 /* We want to call Playlist::maybe_sequence but this must happen after the
1224 main signal emission (since the butler will see that emission and un-suspend itself).
1226 emit (boost::bind(&Playlist::maybe_sequence, _playlist.get(), shared_from_this()));
1234 Film::set_isdcf_date_today ()
1236 _isdcf_date = boost::gregorian::day_clock::local_day ();
1240 boost::filesystem::path
1241 Film::j2c_path (int reel, Frame frame, Eyes eyes, bool tmp) const
1243 boost::filesystem::path p;
1245 p /= video_identifier ();
1248 snprintf(buffer, sizeof(buffer), "%08d_%08" PRId64, reel, frame);
1251 if (eyes == Eyes::LEFT) {
1253 } else if (eyes == Eyes::RIGHT) {
1269 cpl_summary_compare (CPLSummary const & a, CPLSummary const & b)
1271 return a.last_write_time > b.last_write_time;
1274 /** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs.
1275 * The list will be returned in reverse order of timestamp (i.e. most recent first).
1280 if (!directory ()) {
1281 return vector<CPLSummary> ();
1284 vector<CPLSummary> out;
1286 auto const dir = directory().get();
1287 for (auto i: boost::filesystem::directory_iterator(dir)) {
1289 boost::filesystem::is_directory (i) &&
1290 i.path().leaf() != "j2c" && i.path().leaf() != "video" && i.path().leaf() != "info" && i.path().leaf() != "analysis"
1294 out.push_back (CPLSummary(i));
1301 sort (out.begin(), out.end(), cpl_summary_compare);
1307 Film::set_encrypted (bool e)
1309 FilmChangeSignaller ch (this, Property::ENCRYPTED);
1314 Film::content () const
1316 return _playlist->content ();
1319 /** @param content Content to add.
1320 * @param disable_audio_analysis true to never do automatic audio analysis, even if it is enabled in configuration.
1323 Film::examine_and_add_content (shared_ptr<Content> content, bool disable_audio_analysis)
1325 if (dynamic_pointer_cast<FFmpegContent> (content) && _directory) {
1326 run_ffprobe (content->path(0), file("ffprobe.log"));
1329 auto j = make_shared<ExamineContentJob>(shared_from_this(), content);
1331 _job_connections.push_back (
1332 j->Finished.connect (bind (&Film::maybe_add_content, this, weak_ptr<Job>(j), weak_ptr<Content>(content), disable_audio_analysis))
1335 JobManager::instance()->add (j);
1339 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c, bool disable_audio_analysis)
1341 auto job = j.lock ();
1342 if (!job || !job->finished_ok ()) {
1346 auto content = c.lock ();
1351 add_content (content);
1353 if (Config::instance()->automatic_audio_analysis() && content->audio && !disable_audio_analysis) {
1354 auto playlist = make_shared<Playlist>();
1355 playlist->add (shared_from_this(), content);
1356 boost::signals2::connection c;
1357 JobManager::instance()->analyse_audio (
1358 shared_from_this(), playlist, false, c, bind (&Film::audio_analysis_finished, this)
1360 _audio_analysis_connections.push_back (c);
1365 Film::add_content (shared_ptr<Content> c)
1367 /* Add {video,subtitle} content after any existing {video,subtitle} content */
1369 c->set_position (shared_from_this(), _playlist->video_end(shared_from_this()));
1370 } else if (!c->text.empty()) {
1371 c->set_position (shared_from_this(), _playlist->text_end(shared_from_this()));
1374 if (_template_film) {
1375 /* Take settings from the first piece of content of c's type in _template */
1376 for (auto i: _template_film->content()) {
1377 c->take_settings_from (i);
1381 _playlist->add (shared_from_this(), c);
1383 maybe_set_container_and_resolution ();
1385 set_audio_channels (14);
1386 set_interop (false);
1392 Film::maybe_set_container_and_resolution ()
1394 /* Get the only piece of video content, if there is only one */
1395 shared_ptr<VideoContent> video;
1396 for (auto i: _playlist->content()) {
1407 /* This is the only piece of video content in this Film. Use it to make a guess for
1408 * DCP container size and resolution, unless the user has already explicitly set these
1411 if (!_user_explicit_container) {
1412 if (video->size().ratio() > 2.3) {
1413 set_container (Ratio::from_id("239"), false);
1415 set_container (Ratio::from_id("185"), false);
1419 if (!_user_explicit_resolution) {
1420 if (video->size_after_crop().width > 2048 || video->size_after_crop().height > 1080) {
1421 set_resolution (Resolution::FOUR_K, false);
1423 set_resolution (Resolution::TWO_K, false);
1430 Film::remove_content (shared_ptr<Content> c)
1432 _playlist->remove (c);
1433 maybe_set_container_and_resolution ();
1437 Film::move_content_earlier (shared_ptr<Content> c)
1439 _playlist->move_earlier (shared_from_this(), c);
1443 Film::move_content_later (shared_ptr<Content> c)
1445 _playlist->move_later (shared_from_this(), c);
1448 /** @return length of the film from time 0 to the last thing on the playlist,
1449 * with a minimum length of 1 second.
1452 Film::length () const
1454 return max(DCPTime::from_seconds(1), _playlist->length(shared_from_this()).ceil(video_frame_rate()));
1458 Film::best_video_frame_rate () const
1460 /* Don't default to anything above 30fps (make the user select that explicitly) */
1461 auto best = _playlist->best_video_frame_rate ();
1469 Film::active_frame_rate_change (DCPTime t) const
1471 return _playlist->active_frame_rate_change (t, video_frame_rate ());
1475 Film::playlist_content_change (ChangeType type, weak_ptr<Content> c, int p, bool frequent)
1477 if (p == ContentProperty::VIDEO_FRAME_RATE) {
1478 signal_change (type, Property::CONTENT);
1479 } else if (p == AudioContentProperty::STREAMS) {
1480 signal_change (type, Property::NAME);
1483 if (type == ChangeType::DONE) {
1484 emit (boost::bind (boost::ref (ContentChange), type, c, p, frequent));
1486 check_settings_consistency ();
1489 ContentChange (type, c, p, frequent);
1496 Film::playlist_length_change ()
1502 Film::playlist_change (ChangeType type)
1504 signal_change (type, Property::CONTENT);
1505 signal_change (type, Property::NAME);
1507 if (type == ChangeType::DONE) {
1508 check_settings_consistency ();
1514 /** Check for (and if necessary fix) impossible settings combinations, like
1515 * video set to being referenced when it can't be.
1518 Film::check_settings_consistency ()
1520 optional<int> atmos_rate;
1521 for (auto i: content()) {
1524 int rate = lrintf (i->atmos->edit_rate().as_float());
1525 if (atmos_rate && *atmos_rate != rate) {
1526 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."));
1527 } else if (!atmos_rate && rate != video_frame_rate()) {
1529 set_video_frame_rate (rate, false);
1530 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."));
1535 bool change_made = false;
1536 for (auto i: content()) {
1537 auto d = dynamic_pointer_cast<DCPContent>(i);
1543 if (d->reference_video() && !d->can_reference_video(shared_from_this(), why_not)) {
1544 d->set_reference_video(false);
1547 if (d->reference_audio() && !d->can_reference_audio(shared_from_this(), why_not)) {
1548 d->set_reference_audio(false);
1551 if (d->reference_text(TextType::OPEN_SUBTITLE) && !d->can_reference_text(shared_from_this(), TextType::OPEN_SUBTITLE, why_not)) {
1552 d->set_reference_text(TextType::OPEN_SUBTITLE, false);
1555 if (d->reference_text(TextType::CLOSED_CAPTION) && !d->can_reference_text(shared_from_this(), TextType::CLOSED_CAPTION, why_not)) {
1556 d->set_reference_text(TextType::CLOSED_CAPTION, false);
1562 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."));
1567 Film::playlist_order_changed ()
1569 /* XXX: missing PENDING */
1570 signal_change (ChangeType::DONE, Property::CONTENT_ORDER);
1575 Film::set_sequence (bool s)
1577 if (s == _sequence) {
1581 FilmChangeSignaller cc (this, Property::SEQUENCE);
1583 _playlist->set_sequence (s);
1586 /** @return Size of the largest possible image in whatever resolution we are using */
1588 Film::full_frame () const
1590 switch (_resolution) {
1591 case Resolution::TWO_K:
1592 return dcp::Size (2048, 1080);
1593 case Resolution::FOUR_K:
1594 return dcp::Size (4096, 2160);
1597 DCPOMATIC_ASSERT (false);
1598 return dcp::Size ();
1601 /** @return Size of the frame */
1603 Film::frame_size () const
1605 return fit_ratio_within (container()->ratio(), full_frame ());
1609 /** @return Area of Film::frame_size() that contains picture rather than pillar/letterboxing */
1611 Film::active_area () const
1613 auto const frame = frame_size ();
1616 for (auto i: content()) {
1618 dcp::Size s = i->video->scaled_size (frame);
1619 active.width = max(active.width, s.width);
1620 active.height = max(active.height, s.height);
1628 /** @param recipient KDM recipient certificate.
1629 * @param trusted_devices Certificate thumbprints of other trusted devices (can be empty).
1630 * @param cpl_file CPL filename.
1631 * @param from KDM from time expressed as a local time with an offset from UTC.
1632 * @param until KDM to time expressed as a local time with an offset from UTC.
1633 * @param formulation KDM formulation to use.
1634 * @param disable_forensic_marking_picture true to disable forensic marking of picture.
1635 * @param disable_forensic_marking_audio if not set, don't disable forensic marking of audio. If set to 0,
1636 * disable all forensic marking; if set above 0, disable forensic marking above that channel.
1640 dcp::Certificate recipient,
1641 vector<string> trusted_devices,
1642 boost::filesystem::path cpl_file,
1643 dcp::LocalTime from,
1644 dcp::LocalTime until,
1645 dcp::Formulation formulation,
1646 bool disable_forensic_marking_picture,
1647 optional<int> disable_forensic_marking_audio
1651 throw runtime_error (_("Cannot make a KDM as this project is not encrypted."));
1654 auto cpl = make_shared<dcp::CPL>(cpl_file);
1655 auto signer = Config::instance()->signer_chain();
1656 if (!signer->valid ()) {
1657 throw InvalidSignerError ();
1660 /* Find keys that have been added to imported, encrypted DCP content */
1661 list<dcp::DecryptedKDMKey> imported_keys;
1662 for (auto i: content()) {
1663 auto d = dynamic_pointer_cast<DCPContent> (i);
1664 if (d && d->kdm()) {
1665 dcp::DecryptedKDM kdm (d->kdm().get(), Config::instance()->decryption_chain()->key().get());
1666 auto keys = kdm.keys ();
1667 copy (keys.begin(), keys.end(), back_inserter (imported_keys));
1671 map<shared_ptr<const dcp::ReelFileAsset>, dcp::Key> keys;
1673 for (auto i: cpl->reel_file_assets()) {
1674 if (!i->encrypted()) {
1678 /* Get any imported key for this ID */
1680 for (auto j: imported_keys) {
1681 if (j.id() == i->key_id().get()) {
1682 LOG_GENERAL ("Using imported key for %1", i->key_id().get());
1689 /* No imported key; it must be an asset that we encrypted */
1690 LOG_GENERAL ("Using our own key for %1", i->key_id().get());
1695 return dcp::DecryptedKDM (
1696 cpl->id(), keys, from, until, cpl->content_title_text(), cpl->content_title_text(), dcp::LocalTime().as_string()
1697 ).encrypt (signer, recipient, trusted_devices, formulation, disable_forensic_marking_picture, disable_forensic_marking_audio);
1701 /** @return The approximate disk space required to encode a DCP of this film with the
1702 * current settings, in bytes.
1705 Film::required_disk_space () const
1707 return _playlist->required_disk_space (shared_from_this(), j2k_bandwidth(), audio_channels(), audio_frame_rate());
1710 /** This method checks the disk that the Film is on and tries to decide whether or not
1711 * there will be enough space to make a DCP for it. If so, true is returned; if not,
1712 * false is returned and required and available are filled in with the amount of disk space
1713 * required and available respectively (in GB).
1715 * Note: the decision made by this method isn't, of course, 100% reliable.
1718 Film::should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const
1720 /* Create a test file and see if we can hard-link it */
1721 boost::filesystem::path test = internal_video_asset_dir() / "test";
1722 boost::filesystem::path test2 = internal_video_asset_dir() / "test2";
1723 can_hard_link = true;
1724 dcp::File f(test, "w");
1727 boost::system::error_code ec;
1728 boost::filesystem::create_hard_link (test, test2, ec);
1730 can_hard_link = false;
1732 boost::filesystem::remove (test);
1733 boost::filesystem::remove (test2);
1736 auto s = boost::filesystem::space (internal_video_asset_dir ());
1737 required = double (required_disk_space ()) / 1073741824.0f;
1738 if (!can_hard_link) {
1741 available = double (s.available) / 1073741824.0f;
1742 return (available - required) > 1;
1745 /** @return The names of the channels that audio contents' outputs are passed into;
1746 * this is either the DCP or a AudioProcessor.
1748 vector<NamedChannel>
1749 Film::audio_output_names () const
1751 if (audio_processor ()) {
1752 return audio_processor()->input_names ();
1755 DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
1757 vector<NamedChannel> n;
1759 for (int i = 0; i < audio_channels(); ++i) {
1760 if (Config::instance()->use_all_audio_channels() || (i != 8 && i != 9 && i != 15)) {
1761 n.push_back (NamedChannel(short_audio_channel_name(i), i));
1769 Film::repeat_content (ContentList c, int n)
1771 _playlist->repeat (shared_from_this(), c, n);
1775 Film::remove_content (ContentList c)
1777 _playlist->remove (c);
1781 Film::audio_analysis_finished ()
1787 Film::reels () const
1789 list<DCPTimePeriod> p;
1790 auto const len = length();
1792 switch (reel_type ()) {
1793 case ReelType::SINGLE:
1794 p.push_back (DCPTimePeriod (DCPTime (), len));
1796 case ReelType::BY_VIDEO_CONTENT:
1798 /* Collect all reel boundaries */
1799 list<DCPTime> split_points;
1800 split_points.push_back (DCPTime());
1801 split_points.push_back (len);
1802 for (auto c: content()) {
1804 for (auto t: c->reel_split_points(shared_from_this())) {
1805 split_points.push_back (t);
1807 split_points.push_back (c->end(shared_from_this()));
1811 split_points.sort ();
1812 split_points.unique ();
1814 /* Make them into periods, coalescing any that are less than 1 second long */
1815 optional<DCPTime> last;
1816 for (auto t: split_points) {
1817 if (last && (t - *last) >= DCPTime::from_seconds(1)) {
1818 /* Period from *last to t is long enough; use it and start a new one */
1819 p.push_back (DCPTimePeriod(*last, t));
1822 /* That was the first time, so start a new period */
1828 p.back().to = split_points.back();
1832 case ReelType::BY_LENGTH:
1835 /* Integer-divide reel length by the size of one frame to give the number of frames per reel,
1836 * making sure we don't go less than 1s long.
1838 Frame const reel_in_frames = max(_reel_length / ((j2k_bandwidth() / video_frame_rate()) / 8), static_cast<Frame>(video_frame_rate()));
1839 while (current < len) {
1840 DCPTime end = min (len, current + DCPTime::from_frames (reel_in_frames, video_frame_rate ()));
1841 p.push_back (DCPTimePeriod (current, end));
1851 /** @param period A period within the DCP
1852 * @return Name of the content which most contributes to the given period.
1855 Film::content_summary (DCPTimePeriod period) const
1857 return _playlist->content_summary (shared_from_this(), period);
1861 Film::use_template (string name)
1863 _template_film.reset (new Film (optional<boost::filesystem::path>()));
1864 _template_film->read_metadata (Config::instance()->template_read_path(name));
1865 _use_isdcf_name = _template_film->_use_isdcf_name;
1866 _dcp_content_type = _template_film->_dcp_content_type;
1867 _container = _template_film->_container;
1868 _resolution = _template_film->_resolution;
1869 _j2k_bandwidth = _template_film->_j2k_bandwidth;
1870 _video_frame_rate = _template_film->_video_frame_rate;
1871 _encrypted = _template_film->_encrypted;
1872 _audio_channels = _template_film->_audio_channels;
1873 _sequence = _template_film->_sequence;
1874 _three_d = _template_film->_three_d;
1875 _interop = _template_film->_interop;
1876 _audio_processor = _template_film->_audio_processor;
1877 _reel_type = _template_film->_reel_type;
1878 _reel_length = _template_film->_reel_length;
1881 pair<double, double>
1882 Film::speed_up_range (int dcp_frame_rate) const
1884 return _playlist->speed_up_range (dcp_frame_rate);
1888 Film::copy_from (shared_ptr<const Film> film)
1890 read_metadata (film->file (metadata_file));
1894 Film::references_dcp_video () const
1896 for (auto i: _playlist->content()) {
1897 auto d = dynamic_pointer_cast<DCPContent>(i);
1898 if (d && d->reference_video()) {
1907 Film::references_dcp_audio () const
1909 for (auto i: _playlist->content()) {
1910 auto d = dynamic_pointer_cast<DCPContent>(i);
1911 if (d && d->reference_audio()) {
1921 Film::contains_atmos_content () const
1923 for (auto i: _playlist->content()) {
1934 Film::closed_caption_tracks () const
1936 list<DCPTextTrack> tt;
1937 for (auto i: content()) {
1938 for (auto j: i->text) {
1939 /* XXX: Empty DCPTextTrack ends up being a magic value here - the "unknown" or "not specified" track */
1940 auto dtt = j->dcp_track().get_value_or(DCPTextTrack());
1941 if (j->type() == TextType::CLOSED_CAPTION && find(tt.begin(), tt.end(), dtt) == tt.end()) {
1951 Film::set_marker (dcp::Marker type, DCPTime time)
1953 FilmChangeSignaller ch (this, Property::MARKERS);
1954 _markers[type] = time;
1959 Film::unset_marker (dcp::Marker type)
1961 FilmChangeSignaller ch (this, Property::MARKERS);
1962 _markers.erase (type);
1967 Film::clear_markers ()
1969 FilmChangeSignaller ch (this, Property::MARKERS);
1975 Film::set_ratings (vector<dcp::Rating> r)
1977 FilmChangeSignaller ch (this, Property::RATINGS);
1982 Film::set_content_versions (vector<string> v)
1984 FilmChangeSignaller ch (this, Property::CONTENT_VERSIONS);
1985 _content_versions = v;
1990 Film::set_name_language (dcp::LanguageTag lang)
1992 FilmChangeSignaller ch (this, Property::NAME_LANGUAGE);
1993 _name_language = lang;
1998 Film::set_release_territory (optional<dcp::LanguageTag::RegionSubtag> region)
2000 FilmChangeSignaller ch (this, Property::RELEASE_TERRITORY);
2001 _release_territory = region;
2006 Film::set_status (dcp::Status s)
2008 FilmChangeSignaller ch (this, Property::STATUS);
2014 Film::set_version_number (int v)
2016 FilmChangeSignaller ch (this, Property::VERSION_NUMBER);
2017 _version_number = v;
2022 Film::set_chain (optional<string> c)
2024 FilmChangeSignaller ch (this, Property::CHAIN);
2030 Film::set_distributor (optional<string> d)
2032 FilmChangeSignaller ch (this, Property::DISTRIBUTOR);
2038 Film::set_luminance (optional<dcp::Luminance> l)
2040 FilmChangeSignaller ch (this, Property::LUMINANCE);
2046 Film::set_facility (optional<string> f)
2048 FilmChangeSignaller ch (this, Property::FACILITY);
2054 Film::set_studio (optional<string> s)
2056 FilmChangeSignaller ch (this, Property::STUDIO);
2062 Film::marker (dcp::Marker type) const
2064 auto i = _markers.find (type);
2065 if (i == _markers.end()) {
2071 shared_ptr<InfoFileHandle>
2072 Film::info_file_handle (DCPTimePeriod period, bool read) const
2074 return std::make_shared<InfoFileHandle>(_info_file_mutex, info_file(period), read);
2077 InfoFileHandle::InfoFileHandle (boost::mutex& mutex, boost::filesystem::path path, bool read)
2079 , _file (path, read ? "rb" : (boost::filesystem::exists(path) ? "r+b" : "wb"))
2082 throw OpenFileError (path, errno, read ? OpenFileError::READ : (boost::filesystem::exists(path) ? OpenFileError::READ_WRITE : OpenFileError::WRITE));
2087 /** Add FFOC and LFOC markers to a list if they are not already there */
2089 Film::add_ffoc_lfoc (Markers& markers) const
2091 if (markers.find(dcp::Marker::FFOC) == markers.end()) {
2092 markers[dcp::Marker::FFOC] = dcpomatic::DCPTime::from_frames(1, video_frame_rate());
2095 if (markers.find(dcp::Marker::LFOC) == markers.end()) {
2096 markers[dcp::Marker::LFOC] = length() - DCPTime::from_frames(1, video_frame_rate());
2102 Film::set_temp_version (bool t)
2104 FilmChangeSignaller ch (this, Property::TEMP_VERSION);
2110 Film::set_pre_release (bool p)
2112 FilmChangeSignaller ch (this, Property::PRE_RELEASE);
2118 Film::set_red_band (bool r)
2120 FilmChangeSignaller ch (this, Property::RED_BAND);
2126 Film::set_two_d_version_of_three_d (bool t)
2128 FilmChangeSignaller ch (this, Property::TWO_D_VERSION_OF_THREE_D);
2129 _two_d_version_of_three_d = t;
2134 Film::set_audio_language (optional<dcp::LanguageTag> language)
2136 FilmChangeSignaller ch (this, Property::AUDIO_LANGUAGE);
2137 _audio_language = language;
2142 Film::set_audio_frame_rate (int rate)
2144 FilmChangeSignaller ch (this, Property::AUDIO_FRAME_RATE);
2145 _audio_frame_rate = rate;
2150 Film::has_sign_language_video_channel () const
2152 return _audio_channels >= static_cast<int>(dcp::Channel::SIGN_LANGUAGE);
2157 Film::set_sign_language_video_language (optional<dcp::LanguageTag> lang)
2159 FilmChangeSignaller ch (this, Property::SIGN_LANGUAGE_VIDEO_LANGUAGE);
2160 _sign_language_video_language = lang;
2165 Film::set_dirty (bool dirty)
2167 auto const changed = dirty != _dirty;
2170 emit (boost::bind(boost::ref(DirtyChange), _dirty));
2175 /** @return true if the metadata was (probably) last written by a version earlier
2176 * than the given one; false if it definitely was not.
2179 Film::last_written_by_earlier_than(int major, int minor, int micro) const
2181 if (!_last_written_by) {
2185 vector<string> parts;
2186 boost::split(parts, *_last_written_by, boost::is_any_of("."));
2188 if (parts.size() != 3) {
2189 /* Not sure what's going on, so let's say it was written by an old version */
2193 if (boost::ends_with(parts[2], "pre")) {
2194 parts[2] = parts[2].substr(0, parts[2].length() - 3);
2197 int our_major = dcp::raw_convert<int>(parts[0]);
2198 int our_minor = dcp::raw_convert<int>(parts[1]);
2199 int our_micro = dcp::raw_convert<int>(parts[2]);
2201 if (our_major != major) {
2202 return our_major < major;
2205 if (our_minor != minor) {
2206 return our_minor < minor;
2209 return our_micro < micro;