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/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 , _release_territory(Config::instance()->default_territory())
178 , _version_number (1)
179 , _status (dcp::Status::FINAL)
180 , _audio_language(Config::instance()->default_audio_language())
181 , _state_version (current_state_version)
185 set_isdcf_date_today ();
187 auto metadata = Config::instance()->default_metadata();
188 if (metadata.find("chain") != metadata.end()) {
189 _chain = metadata["chain"];
191 if (metadata.find("distributor") != metadata.end()) {
192 _distributor = metadata["distributor"];
194 if (metadata.find("facility") != metadata.end()) {
195 _facility = metadata["facility"];
197 if (metadata.find("studio") != metadata.end()) {
198 _studio = metadata["studio"];
201 _playlist_change_connection = _playlist->Change.connect (bind (&Film::playlist_change, this, _1));
202 _playlist_order_changed_connection = _playlist->OrderChange.connect (bind (&Film::playlist_order_changed, this));
203 _playlist_content_change_connection = _playlist->ContentChange.connect (bind (&Film::playlist_content_change, this, _1, _2, _3, _4));
204 _playlist_length_change_connection = _playlist->LengthChange.connect (bind(&Film::playlist_length_change, this));
207 /* Make state.directory a complete path without ..s (where possible)
208 (Code swiped from Adam Bowen on stackoverflow)
209 XXX: couldn't/shouldn't this just be boost::filesystem::canonical?
212 boost::filesystem::path p (boost::filesystem::system_complete (dir.get()));
213 boost::filesystem::path result;
216 boost::system::error_code ec;
217 if (boost::filesystem::is_symlink(result, ec) || result.filename() == "..") {
220 result = result.parent_path ();
222 } else if (i != ".") {
227 set_directory (result.make_preferred ());
231 _log = make_shared<FileLog>(file("log"));
233 _log = make_shared<NullLog>();
236 _playlist->set_sequence (_sequence);
241 for (auto& i: _job_connections) {
245 for (auto& i: _audio_analysis_connections) {
251 Film::video_identifier () const
253 DCPOMATIC_ASSERT (container ());
255 string s = container()->id()
256 + "_" + resolution_to_string (_resolution)
257 + "_" + _playlist->video_identifier()
258 + "_" + raw_convert<string>(_video_frame_rate)
259 + "_" + raw_convert<string>(j2k_bandwidth());
262 /* This is insecure but hey, the key is in plaintext in metadata.xml */
263 s += "_E" + _key.hex();
285 /** @return The file to write video frame info to */
286 boost::filesystem::path
287 Film::info_file (DCPTimePeriod period) const
289 boost::filesystem::path p;
291 p /= video_identifier () + "_" + raw_convert<string> (period.from.get()) + "_" + raw_convert<string> (period.to.get());
295 boost::filesystem::path
296 Film::internal_video_asset_dir () const
298 return dir ("video");
301 boost::filesystem::path
302 Film::internal_video_asset_filename (DCPTimePeriod p) const
304 return video_identifier() + "_" + raw_convert<string> (p.from.get()) + "_" + raw_convert<string> (p.to.get()) + ".mxf";
307 boost::filesystem::path
308 Film::audio_analysis_path (shared_ptr<const Playlist> playlist) const
310 auto p = dir ("analysis");
313 for (auto i: playlist->content()) {
318 digester.add (i->digest());
319 digester.add (i->audio->mapping().digest());
320 if (playlist->content().size() != 1) {
321 /* Analyses should be considered equal regardless of gain
322 if they were made from just one piece of content. This
323 is because we can fake any gain change in a single-content
324 analysis at the plotting stage rather than having to
327 digester.add (i->audio->gain());
329 /* Likewise we only care about position if we're looking at a
330 * whole-project view.
332 digester.add (i->position().get());
333 digester.add (i->trim_start().get());
334 digester.add (i->trim_end().get());
338 if (audio_processor ()) {
339 digester.add (audio_processor()->id ());
342 digester.add (audio_channels());
344 p /= digester.get ();
349 boost::filesystem::path
350 Film::subtitle_analysis_path (shared_ptr<const Content> content) const
352 auto p = dir ("analysis");
355 digester.add (content->digest());
356 digester.add(_interop ? "1" : "0");
358 if (!content->text.empty()) {
359 auto tc = content->text.front();
360 digester.add (tc->x_scale());
361 digester.add (tc->y_scale());
362 for (auto i: tc->fonts()) {
363 digester.add (i->id());
366 digester.add (tc->effect().get());
368 digester.add (tc->line_spacing());
369 digester.add (tc->outline_width());
372 auto fc = dynamic_pointer_cast<const FFmpegContent>(content);
374 digester.add (fc->subtitle_stream()->identifier());
377 p /= digester.get ();
382 /** Start a job to send our DCP to the configured TMS */
384 Film::send_dcp_to_tms ()
386 JobManager::instance()->add(make_shared<UploadJob>(shared_from_this()));
389 shared_ptr<xmlpp::Document>
390 Film::metadata (bool with_content_paths) const
392 auto doc = make_shared<xmlpp::Document>();
393 auto root = doc->create_root_node ("Metadata");
395 root->add_child("Version")->add_child_text (raw_convert<string> (current_state_version));
396 auto last_write = root->add_child("LastWrittenBy");
397 last_write->add_child_text (dcpomatic_version);
398 last_write->set_attribute("git", dcpomatic_git_commit);
399 root->add_child("Name")->add_child_text (_name);
400 root->add_child("UseISDCFName")->add_child_text (_use_isdcf_name ? "1" : "0");
402 if (_dcp_content_type) {
403 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->isdcf_name ());
407 root->add_child("Container")->add_child_text (_container->id ());
410 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
411 root->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
412 root->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
413 root->add_child("AudioFrameRate")->add_child_text(raw_convert<string>(_audio_frame_rate));
414 root->add_child("ISDCFDate")->add_child_text (boost::gregorian::to_iso_string (_isdcf_date));
415 root->add_child("AudioChannels")->add_child_text (raw_convert<string> (_audio_channels));
416 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
417 root->add_child("Sequence")->add_child_text (_sequence ? "1" : "0");
418 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
419 root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
420 root->add_child("Key")->add_child_text (_key.hex ());
421 root->add_child("ContextID")->add_child_text (_context_id);
422 if (_audio_processor) {
423 root->add_child("AudioProcessor")->add_child_text (_audio_processor->id ());
425 root->add_child("ReelType")->add_child_text (raw_convert<string> (static_cast<int> (_reel_type)));
426 root->add_child("ReelLength")->add_child_text (raw_convert<string> (_reel_length));
427 root->add_child("ReencodeJ2K")->add_child_text (_reencode_j2k ? "1" : "0");
428 root->add_child("UserExplicitVideoFrameRate")->add_child_text(_user_explicit_video_frame_rate ? "1" : "0");
429 for (map<dcp::Marker, DCPTime>::const_iterator i = _markers.begin(); i != _markers.end(); ++i) {
430 auto m = root->add_child("Marker");
431 m->set_attribute("Type", dcp::marker_to_string(i->first));
432 m->add_child_text(raw_convert<string>(i->second.get()));
434 for (auto i: _ratings) {
435 i.as_xml (root->add_child("Rating"));
437 for (auto i: _content_versions) {
438 root->add_child("ContentVersion")->add_child_text(i);
440 root->add_child("NameLanguage")->add_child_text(_name_language.to_string());
441 if (_release_territory) {
442 root->add_child("ReleaseTerritory")->add_child_text(_release_territory->subtag());
444 if (_sign_language_video_language) {
445 root->add_child("SignLanguageVideoLanguage")->add_child_text(_sign_language_video_language->to_string());
447 root->add_child("VersionNumber")->add_child_text(raw_convert<string>(_version_number));
448 root->add_child("Status")->add_child_text(dcp::status_to_string(_status));
450 root->add_child("Chain")->add_child_text(*_chain);
453 root->add_child("Distributor")->add_child_text(*_distributor);
456 root->add_child("Facility")->add_child_text(*_facility);
459 root->add_child("Studio")->add_child_text(*_studio);
461 root->add_child("TempVersion")->add_child_text(_temp_version ? "1" : "0");
462 root->add_child("PreRelease")->add_child_text(_pre_release ? "1" : "0");
463 root->add_child("RedBand")->add_child_text(_red_band ? "1" : "0");
464 root->add_child("TwoDVersionOfThreeD")->add_child_text(_two_d_version_of_three_d ? "1" : "0");
466 root->add_child("LuminanceValue")->add_child_text(raw_convert<string>(_luminance->value()));
467 root->add_child("LuminanceUnit")->add_child_text(dcp::Luminance::unit_to_string(_luminance->unit()));
469 root->add_child("UserExplicitContainer")->add_child_text(_user_explicit_container ? "1" : "0");
470 root->add_child("UserExplicitResolution")->add_child_text(_user_explicit_resolution ? "1" : "0");
471 if (_audio_language) {
472 root->add_child("AudioLanguage")->add_child_text(_audio_language->to_string());
474 _playlist->as_xml (root->add_child ("Playlist"), with_content_paths);
480 Film::write_metadata (boost::filesystem::path path) const
482 metadata()->write_to_file_formatted(path.string());
485 /** Write state to our `metadata' file */
487 Film::write_metadata ()
489 DCPOMATIC_ASSERT (directory());
490 boost::filesystem::create_directories (directory().get());
491 metadata()->write_to_file_formatted(file(metadata_file).string());
495 /** Write a template from this film */
497 Film::write_template (boost::filesystem::path path) const
499 boost::filesystem::create_directories (path.parent_path());
500 shared_ptr<xmlpp::Document> doc = metadata (false);
501 metadata(false)->write_to_file_formatted(path.string());
504 /** Read state from our metadata file.
505 * @return Notes about things that the user should know about, or empty.
508 Film::read_metadata (optional<boost::filesystem::path> path)
511 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file (metadata_file))) {
512 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!"));
515 path = file (metadata_file);
518 if (!boost::filesystem::exists(*path)) {
519 throw FileNotFoundError(*path);
522 cxml::Document f ("Metadata");
523 f.read_file (path.get ());
525 _state_version = f.number_child<int> ("Version");
526 if (_state_version > current_state_version) {
527 throw runtime_error (_("This film was created with a newer version of DCP-o-matic, and it cannot be loaded into this version. Sorry!"));
528 } else if (_state_version < current_state_version) {
529 /* This is an older version; save a copy (if we haven't already) */
530 auto const older = path->parent_path() / String::compose("metadata.%1.xml", _state_version);
531 if (!boost::filesystem::is_regular_file(older)) {
533 boost::filesystem::copy_file(*path, older);
535 /* Never mind; at least we tried */
540 _last_written_by = f.optional_string_child("LastWrittenBy");
542 _name = f.string_child ("Name");
543 if (_state_version >= 9) {
544 _use_isdcf_name = f.bool_child ("UseISDCFName");
545 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("ISDCFDate"));
547 _use_isdcf_name = f.bool_child ("UseDCIName");
548 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
553 auto c = f.optional_string_child("DCPContentType");
555 _dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
560 auto c = f.optional_string_child("Container");
562 _container = Ratio::from_id (c.get ());
566 _resolution = string_to_resolution (f.string_child ("Resolution"));
567 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
568 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
569 _audio_frame_rate = f.optional_number_child<int>("AudioFrameRate").get_value_or(48000);
570 _encrypted = f.bool_child ("Encrypted");
571 _audio_channels = f.number_child<int> ("AudioChannels");
572 /* We used to allow odd numbers (and zero) channels, but it's just not worth
575 if (_audio_channels == 0) {
577 } else if ((_audio_channels % 2) == 1) {
581 if (f.optional_bool_child("SequenceVideo")) {
582 _sequence = f.bool_child("SequenceVideo");
584 _sequence = f.bool_child("Sequence");
587 _three_d = f.bool_child ("ThreeD");
588 _interop = f.bool_child ("Interop");
589 _key = dcp::Key (f.string_child ("Key"));
590 _context_id = f.optional_string_child("ContextID").get_value_or (dcp::make_uuid ());
592 if (f.optional_string_child ("AudioProcessor")) {
593 _audio_processor = AudioProcessor::from_id (f.string_child ("AudioProcessor"));
595 _audio_processor = 0;
598 if (_audio_processor && !Config::instance()->show_experimental_audio_processors()) {
599 auto ap = AudioProcessor::visible();
600 if (find(ap.begin(), ap.end(), _audio_processor) == ap.end()) {
601 Config::instance()->set_show_experimental_audio_processors(true);
605 _reel_type = static_cast<ReelType> (f.optional_number_child<int>("ReelType").get_value_or (static_cast<int>(ReelType::SINGLE)));
606 _reel_length = f.optional_number_child<int64_t>("ReelLength").get_value_or (2000000000);
607 _reencode_j2k = f.optional_bool_child("ReencodeJ2K").get_value_or(false);
608 _user_explicit_video_frame_rate = f.optional_bool_child("UserExplicitVideoFrameRate").get_value_or(false);
610 for (auto i: f.node_children("Marker")) {
611 _markers[dcp::marker_from_string(i->string_attribute("Type"))] = DCPTime(dcp::raw_convert<DCPTime::Type>(i->content()));
614 for (auto i: f.node_children("Rating")) {
615 _ratings.push_back (dcp::Rating(i));
618 for (auto i: f.node_children("ContentVersion")) {
619 _content_versions.push_back (i->content());
622 auto name_language = f.optional_string_child("NameLanguage");
624 _name_language = dcp::LanguageTag (*name_language);
626 auto release_territory = f.optional_string_child("ReleaseTerritory");
627 if (release_territory) {
628 _release_territory = dcp::LanguageTag::RegionSubtag (*release_territory);
631 auto sign_language_video_language = f.optional_string_child("SignLanguageVideoLanguage");
632 if (sign_language_video_language) {
633 _sign_language_video_language = dcp::LanguageTag(*sign_language_video_language);
636 _version_number = f.optional_number_child<int>("VersionNumber").get_value_or(1);
638 auto status = f.optional_string_child("Status");
640 _status = dcp::string_to_status (*status);
643 _chain = f.optional_string_child("Chain");
644 _distributor = f.optional_string_child("Distributor");
645 _facility = f.optional_string_child("Facility");
646 _studio = f.optional_string_child("Studio");
647 _temp_version = f.optional_bool_child("TempVersion").get_value_or(false);
648 _pre_release = f.optional_bool_child("PreRelease").get_value_or(false);
649 _red_band = f.optional_bool_child("RedBand").get_value_or(false);
650 _two_d_version_of_three_d = f.optional_bool_child("TwoDVersionOfThreeD").get_value_or(false);
652 auto value = f.optional_number_child<float>("LuminanceValue");
653 auto unit = f.optional_string_child("LuminanceUnit");
655 _luminance = dcp::Luminance (*value, dcp::Luminance::string_to_unit(*unit));
658 /* Disable guessing for files made in previous DCP-o-matic versions */
659 _user_explicit_container = f.optional_bool_child("UserExplicitContainer").get_value_or(true);
660 _user_explicit_resolution = f.optional_bool_child("UserExplicitResolution").get_value_or(true);
662 auto audio_language = f.optional_string_child("AudioLanguage");
663 if (audio_language) {
664 _audio_language = dcp::LanguageTag(*audio_language);
667 /* Read the old ISDCFMetadata tag from 2.14.x metadata */
668 auto isdcf = f.optional_node_child("ISDCFMetadata");
670 if (auto territory = isdcf->optional_string_child("Territory")) {
672 _release_territory = dcp::LanguageTag::RegionSubtag(*territory);
674 /* Invalid region subtag; just ignore it */
677 if (auto audio_language = isdcf->optional_string_child("AudioLanguage")) {
679 _audio_language = dcp::LanguageTag(*audio_language);
681 /* Invalid language tag; just ignore it */
684 if (auto content_version = isdcf->optional_string_child("ContentVersion")) {
685 _content_versions.push_back (*content_version);
687 if (auto rating = isdcf->optional_string_child("Rating")) {
688 _ratings.push_back (dcp::Rating("", *rating));
690 if (auto mastered_luminance = isdcf->optional_number_child<float>("MasteredLuminance")) {
691 if (*mastered_luminance > 0) {
692 _luminance = dcp::Luminance(*mastered_luminance, dcp::Luminance::Unit::FOOT_LAMBERT);
695 _studio = isdcf->optional_string_child("Studio");
696 _facility = isdcf->optional_string_child("Facility");
697 _temp_version = isdcf->optional_bool_child("TempVersion").get_value_or("false");
698 _pre_release = isdcf->optional_bool_child("PreRelease").get_value_or("false");
699 _red_band = isdcf->optional_bool_child("RedBand").get_value_or("false");
700 _two_d_version_of_three_d = isdcf->optional_bool_child("TwoDVersionOfThreeD").get_value_or("false");
701 _chain = isdcf->optional_string_child("Chain");
705 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
707 /* Write backtraces to this film's directory, until another film is loaded */
709 set_backtrace_file (file ("backtrace.txt"));
716 /** Given a directory name, return its full path within the Film's directory.
717 * @param d directory name within the Film's directory.
718 * @param create true to create the directory (and its parents) if they do not exist.
720 boost::filesystem::path
721 Film::dir (boost::filesystem::path d, bool create) const
723 DCPOMATIC_ASSERT (_directory);
725 boost::filesystem::path p;
726 p /= _directory.get();
730 boost::filesystem::create_directories (p);
736 /** Given a file or directory name, return its full path within the Film's directory.
737 * Any required parent directories will be created.
739 boost::filesystem::path
740 Film::file (boost::filesystem::path f) const
742 DCPOMATIC_ASSERT (_directory);
744 boost::filesystem::path p;
745 p /= _directory.get();
748 boost::filesystem::create_directories (p.parent_path ());
754 Film::mapped_audio_channels () const
758 if (audio_processor ()) {
759 /* Processors are mapped 1:1 to DCP outputs so we can work out mappings from there */
760 for (int i = 0; i < audio_processor()->out_channels(); ++i) {
761 mapped.push_back (i);
764 for (auto i: content()) {
766 auto c = i->audio->mapping().mapped_output_channels();
767 copy (c.begin(), c.end(), back_inserter(mapped));
779 pair<optional<dcp::LanguageTag>, vector<dcp::LanguageTag>>
780 Film::subtitle_languages () const
782 pair<optional<dcp::LanguageTag>, vector<dcp::LanguageTag>> result;
783 for (auto i: content()) {
784 for (auto j: i->text) {
785 if (j->use() && j->type() == TextType::OPEN_SUBTITLE && j->language()) {
786 if (j->language_is_additional()) {
787 result.second.push_back (j->language().get());
789 result.first = j->language().get();
793 if (i->video && i->video->burnt_subtitle_language()) {
794 result.first = i->video->burnt_subtitle_language();
798 std::sort (result.second.begin(), result.second.end());
799 auto last = std::unique (result.second.begin(), result.second.end());
800 result.second.erase (last, result.second.end());
805 /** @return a ISDCF-compliant name for a DCP of this film */
807 Film::isdcf_name (bool if_created_now) const
811 auto raw_name = name ();
813 auto to_upper = [](string s) {
814 transform(s.begin(), s.end(), s.begin(), ::toupper);
818 /* Split the raw name up into words */
819 vector<string> words;
820 split (words, raw_name, is_any_of (" _-"));
824 /* Add each word to fixed_name */
825 for (auto i: words) {
828 /* First letter is always capitalised */
829 w[0] = toupper (w[0]);
831 /* Count caps in w */
833 for (size_t j = 0; j < w.size(); ++j) {
834 if (isupper (w[j])) {
839 /* If w is all caps make the rest of it lower case, otherwise
842 if (caps == w.size ()) {
843 for (size_t j = 1; j < w.size(); ++j) {
844 w[j] = tolower (w[j]);
848 for (size_t j = 0; j < w.size(); ++j) {
853 fixed_name = fixed_name.substr(0, 14);
855 isdcf_name += fixed_name;
857 if (dcp_content_type()) {
858 isdcf_name += "_" + dcp_content_type()->isdcf_name();
859 string version = "1";
861 if (!_content_versions.empty()) {
862 auto cv = _content_versions[0];
863 if (!cv.empty() && std::all_of(cv.begin(), cv.end(), isdigit)) {
868 version = dcp::raw_convert<string>(_version_number);
870 isdcf_name += "-" + version;
874 isdcf_name += "-Temp";
878 isdcf_name += "-Pre";
882 isdcf_name += "-RedBand";
885 if (_chain && !_chain->empty()) {
886 isdcf_name += "-" + *_chain;
893 if (_two_d_version_of_three_d) {
898 auto fl = _luminance->value_in_foot_lamberts();
900 snprintf (buffer, sizeof(buffer), "%.1f", fl);
901 isdcf_name += String::compose("-%1fl", buffer);
904 if (video_frame_rate() != 24) {
905 isdcf_name += "-" + raw_convert<string>(video_frame_rate());
909 isdcf_name += "_" + container()->isdcf_name();
912 auto content_list = content();
914 /* XXX: this uses the first bit of content only */
916 /* Interior aspect ratio. The standard says we don't do this for trailers, for some strange reason */
917 if (dcp_content_type() && dcp_content_type()->libdcp_kind() != dcp::ContentKind::TRAILER) {
918 auto first_video = std::find_if(content_list.begin(), content_list.end(), [](shared_ptr<Content> c) { return static_cast<bool>(c->video); });
919 if (first_video != content_list.end()) {
920 auto first_ratio = lrintf((*first_video)->video->scaled_size(frame_size()).ratio() * 100);
921 auto container_ratio = lrintf(container()->ratio() * 100);
922 if (first_ratio != container_ratio) {
923 isdcf_name += "-" + dcp::raw_convert<string>(first_ratio);
928 auto entry_for_language = [](dcp::LanguageTag const& tag) {
929 /* Look up what we should be using for this tag in the DCNC name */
930 for (auto const& dcnc: dcp::dcnc_tags()) {
931 if (tag.to_string() == dcnc.first) {
935 /* Fallback to the language subtag, if there is one */
936 return tag.language() ? tag.language()->subtag() : "XX";
939 auto audio_language = _audio_language ? entry_for_language(*_audio_language) : "XX";
941 isdcf_name += "_" + to_upper (audio_language);
943 /* I'm not clear on the precise details of the convention for CCAP labelling;
944 for now I'm just appending -CCAP if we have any closed captions.
947 auto burnt_in = true;
949 for (auto i: content_list) {
950 for (auto j: i->text) {
951 if (j->type() == TextType::OPEN_SUBTITLE && j->use() && !j->burn()) {
953 } else if (j->type() == TextType::CLOSED_CAPTION && j->use()) {
959 auto sub_langs = subtitle_languages();
960 if (sub_langs.first && sub_langs.first->language()) {
961 auto lang = entry_for_language(*sub_langs.first);
963 transform (lang.begin(), lang.end(), lang.begin(), ::tolower);
965 lang = to_upper (lang);
968 isdcf_name += "-" + lang;
970 isdcf_name += "-CCAP";
977 if (_release_territory) {
978 auto territory = _release_territory->subtag();
979 isdcf_name += "_" + to_upper (territory);
980 if (!_ratings.empty()) {
981 auto label = _ratings[0].label;
982 boost::erase_all(label, "+");
983 boost::erase_all(label, "-");
984 isdcf_name += "-" + label;
988 /* Count mapped audio channels */
990 auto mapped = mapped_audio_channels ();
992 auto ch = audio_channel_types (mapped, audio_channels());
993 if (!ch.first && !ch.second) {
994 isdcf_name += "_MOS";
995 } else if (ch.first) {
996 isdcf_name += String::compose("_%1%2", ch.first, ch.second);
999 if (audio_channels() > static_cast<int>(dcp::Channel::HI) && find(mapped.begin(), mapped.end(), static_cast<int>(dcp::Channel::HI)) != mapped.end()) {
1000 isdcf_name += "-HI";
1002 if (audio_channels() > static_cast<int>(dcp::Channel::VI) && find(mapped.begin(), mapped.end(), static_cast<int>(dcp::Channel::VI)) != mapped.end()) {
1003 isdcf_name += "-VI";
1006 if (find_if(content_list.begin(), content_list.end(), [](shared_ptr<Content> c) { return static_cast<bool>(c->atmos); }) != content_list.end()) {
1007 isdcf_name += "-ATMOS";
1010 isdcf_name += "_" + resolution_to_string (_resolution);
1012 if (_studio && _studio->length() >= 2) {
1013 isdcf_name += "_" + to_upper (_studio->substr(0, 4));
1016 if (if_created_now) {
1017 isdcf_name += "_" + boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
1019 isdcf_name += "_" + boost::gregorian::to_iso_string (_isdcf_date);
1022 if (_facility && _facility->length() >= 3) {
1023 isdcf_name += "_" + to_upper(_facility->substr(0, 3));
1027 isdcf_name += "_IOP";
1029 isdcf_name += "_SMPTE";
1033 isdcf_name += "-3D";
1037 for (auto i: content_list) {
1038 auto dc = dynamic_pointer_cast<const DCPContent>(i);
1043 bool any_text = false;
1044 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
1045 if (dc->reference_text(static_cast<TextType>(i))) {
1049 if (dc->reference_video() || dc->reference_audio() || any_text) {
1055 isdcf_name += "_VF";
1057 isdcf_name += "_OV";
1063 /** @return name to give the DCP */
1065 Film::dcp_name (bool if_created_now) const
1068 if (use_isdcf_name()) {
1069 return careful_string_filter (isdcf_name (if_created_now));
1072 return careful_string_filter (name ());
1076 Film::set_directory (boost::filesystem::path d)
1083 Film::set_name (string n)
1085 FilmChangeSignaller ch (this, Property::NAME);
1090 Film::set_use_isdcf_name (bool u)
1092 FilmChangeSignaller ch (this, Property::USE_ISDCF_NAME);
1093 _use_isdcf_name = u;
1097 Film::set_dcp_content_type (DCPContentType const * t)
1099 FilmChangeSignaller ch (this, Property::DCP_CONTENT_TYPE);
1100 _dcp_content_type = t;
1104 /** @param explicit_user true if this is being set because of
1105 * a direct user request, false if it is being done because
1106 * DCP-o-matic is guessing the best container to use.
1109 Film::set_container (Ratio const * c, bool explicit_user)
1111 FilmChangeSignaller ch (this, Property::CONTAINER);
1114 if (explicit_user) {
1115 _user_explicit_container = true;
1120 /** @param explicit_user true if this is being set because of
1121 * a direct user request, false if it is being done because
1122 * DCP-o-matic is guessing the best resolution to use.
1125 Film::set_resolution (Resolution r, bool explicit_user)
1127 FilmChangeSignaller ch (this, Property::RESOLUTION);
1130 if (explicit_user) {
1131 _user_explicit_resolution = true;
1137 Film::set_j2k_bandwidth (int b)
1139 FilmChangeSignaller ch (this, Property::J2K_BANDWIDTH);
1143 /** @param f New frame rate.
1144 * @param user_explicit true if this comes from a direct user instruction, false if it is from
1145 * DCP-o-matic being helpful.
1148 Film::set_video_frame_rate (int f, bool user_explicit)
1150 FilmChangeSignaller ch (this, Property::VIDEO_FRAME_RATE);
1151 _video_frame_rate = f;
1152 if (user_explicit) {
1153 _user_explicit_video_frame_rate = true;
1158 Film::set_audio_channels (int c)
1160 FilmChangeSignaller ch (this, Property::AUDIO_CHANNELS);
1161 _audio_channels = c;
1165 Film::set_three_d (bool t)
1167 FilmChangeSignaller ch (this, Property::THREE_D);
1170 if (_three_d && _two_d_version_of_three_d) {
1171 set_two_d_version_of_three_d (false);
1176 Film::set_interop (bool i)
1178 FilmChangeSignaller ch (this, Property::INTEROP);
1183 Film::set_audio_processor (AudioProcessor const * processor)
1185 FilmChangeSignaller ch1 (this, Property::AUDIO_PROCESSOR);
1186 FilmChangeSignaller ch2 (this, Property::AUDIO_CHANNELS);
1187 _audio_processor = processor;
1191 Film::set_reel_type (ReelType t)
1193 FilmChangeSignaller ch (this, Property::REEL_TYPE);
1197 /** @param r Desired reel length in bytes */
1199 Film::set_reel_length (int64_t r)
1201 FilmChangeSignaller ch (this, Property::REEL_LENGTH);
1206 Film::set_reencode_j2k (bool r)
1208 FilmChangeSignaller ch (this, Property::REENCODE_J2K);
1213 Film::signal_change (ChangeType type, int p)
1215 signal_change (type, static_cast<Property>(p));
1219 Film::signal_change (ChangeType type, Property p)
1221 if (type == ChangeType::DONE) {
1224 if (p == Property::CONTENT) {
1225 if (!_user_explicit_video_frame_rate) {
1226 set_video_frame_rate (best_video_frame_rate());
1230 emit (boost::bind (boost::ref (Change), type, p));
1232 if (p == Property::VIDEO_FRAME_RATE || p == Property::SEQUENCE) {
1233 /* We want to call Playlist::maybe_sequence but this must happen after the
1234 main signal emission (since the butler will see that emission and un-suspend itself).
1236 emit (boost::bind(&Playlist::maybe_sequence, _playlist.get(), shared_from_this()));
1244 Film::set_isdcf_date_today ()
1246 _isdcf_date = boost::gregorian::day_clock::local_day ();
1250 boost::filesystem::path
1251 Film::j2c_path (int reel, Frame frame, Eyes eyes, bool tmp) const
1253 boost::filesystem::path p;
1255 p /= video_identifier ();
1258 snprintf(buffer, sizeof(buffer), "%08d_%08" PRId64, reel, frame);
1261 if (eyes == Eyes::LEFT) {
1263 } else if (eyes == Eyes::RIGHT) {
1279 cpl_summary_compare (CPLSummary const & a, CPLSummary const & b)
1281 return a.last_write_time > b.last_write_time;
1284 /** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs.
1285 * The list will be returned in reverse order of timestamp (i.e. most recent first).
1290 if (!directory ()) {
1291 return vector<CPLSummary> ();
1294 vector<CPLSummary> out;
1296 auto const dir = directory().get();
1297 for (auto i: boost::filesystem::directory_iterator(dir)) {
1299 boost::filesystem::is_directory (i) &&
1300 i.path().leaf() != "j2c" && i.path().leaf() != "video" && i.path().leaf() != "info" && i.path().leaf() != "analysis"
1304 out.push_back (CPLSummary(i));
1311 sort (out.begin(), out.end(), cpl_summary_compare);
1317 Film::set_encrypted (bool e)
1319 FilmChangeSignaller ch (this, Property::ENCRYPTED);
1324 Film::content () const
1326 return _playlist->content ();
1329 /** @param content Content to add.
1330 * @param disable_audio_analysis true to never do automatic audio analysis, even if it is enabled in configuration.
1333 Film::examine_and_add_content (shared_ptr<Content> content, bool disable_audio_analysis)
1335 if (dynamic_pointer_cast<FFmpegContent> (content) && _directory) {
1336 run_ffprobe (content->path(0), file("ffprobe.log"));
1339 auto j = make_shared<ExamineContentJob>(shared_from_this(), content);
1341 _job_connections.push_back (
1342 j->Finished.connect (bind (&Film::maybe_add_content, this, weak_ptr<Job>(j), weak_ptr<Content>(content), disable_audio_analysis))
1345 JobManager::instance()->add (j);
1349 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c, bool disable_audio_analysis)
1351 auto job = j.lock ();
1352 if (!job || !job->finished_ok ()) {
1356 auto content = c.lock ();
1361 add_content (content);
1363 if (Config::instance()->automatic_audio_analysis() && content->audio && !disable_audio_analysis) {
1364 auto playlist = make_shared<Playlist>();
1365 playlist->add (shared_from_this(), content);
1366 boost::signals2::connection c;
1367 JobManager::instance()->analyse_audio (
1368 shared_from_this(), playlist, false, c, bind (&Film::audio_analysis_finished, this)
1370 _audio_analysis_connections.push_back (c);
1375 Film::add_content (shared_ptr<Content> c)
1377 /* Add {video,subtitle} content after any existing {video,subtitle} content */
1379 c->set_position (shared_from_this(), _playlist->video_end(shared_from_this()));
1380 } else if (!c->text.empty()) {
1381 c->set_position (shared_from_this(), _playlist->text_end(shared_from_this()));
1384 if (_template_film) {
1385 /* Take settings from the first piece of content of c's type in _template */
1386 for (auto i: _template_film->content()) {
1387 c->take_settings_from (i);
1391 _playlist->add (shared_from_this(), c);
1393 maybe_set_container_and_resolution ();
1395 set_audio_channels (14);
1396 set_interop (false);
1402 Film::maybe_set_container_and_resolution ()
1404 /* Get the only piece of video content, if there is only one */
1405 shared_ptr<VideoContent> video;
1406 for (auto i: _playlist->content()) {
1417 /* This is the only piece of video content in this Film. Use it to make a guess for
1418 * DCP container size and resolution, unless the user has already explicitly set these
1421 if (!_user_explicit_container) {
1422 if (video->size().ratio() > 2.3) {
1423 set_container (Ratio::from_id("239"), false);
1425 set_container (Ratio::from_id("185"), false);
1429 if (!_user_explicit_resolution) {
1430 if (video->size_after_crop().width > 2048 || video->size_after_crop().height > 1080) {
1431 set_resolution (Resolution::FOUR_K, false);
1433 set_resolution (Resolution::TWO_K, false);
1440 Film::remove_content (shared_ptr<Content> c)
1442 _playlist->remove (c);
1443 maybe_set_container_and_resolution ();
1447 Film::move_content_earlier (shared_ptr<Content> c)
1449 _playlist->move_earlier (shared_from_this(), c);
1453 Film::move_content_later (shared_ptr<Content> c)
1455 _playlist->move_later (shared_from_this(), c);
1458 /** @return length of the film from time 0 to the last thing on the playlist,
1459 * with a minimum length of 1 second.
1462 Film::length () const
1464 return max(DCPTime::from_seconds(1), _playlist->length(shared_from_this()).ceil(video_frame_rate()));
1468 Film::best_video_frame_rate () const
1470 /* Don't default to anything above 30fps (make the user select that explicitly) */
1471 auto best = _playlist->best_video_frame_rate ();
1479 Film::active_frame_rate_change (DCPTime t) const
1481 return _playlist->active_frame_rate_change (t, video_frame_rate ());
1485 Film::playlist_content_change (ChangeType type, weak_ptr<Content> c, int p, bool frequent)
1487 if (p == ContentProperty::VIDEO_FRAME_RATE) {
1488 signal_change (type, Property::CONTENT);
1489 } else if (p == AudioContentProperty::STREAMS) {
1490 signal_change (type, Property::NAME);
1493 if (type == ChangeType::DONE) {
1494 emit (boost::bind (boost::ref (ContentChange), type, c, p, frequent));
1496 check_settings_consistency ();
1499 ContentChange (type, c, p, frequent);
1506 Film::playlist_length_change ()
1512 Film::playlist_change (ChangeType type)
1514 signal_change (type, Property::CONTENT);
1515 signal_change (type, Property::NAME);
1517 if (type == ChangeType::DONE) {
1518 check_settings_consistency ();
1524 /** Check for (and if necessary fix) impossible settings combinations, like
1525 * video set to being referenced when it can't be.
1528 Film::check_settings_consistency ()
1530 optional<int> atmos_rate;
1531 for (auto i: content()) {
1534 int rate = lrintf (i->atmos->edit_rate().as_float());
1535 if (atmos_rate && *atmos_rate != rate) {
1536 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."));
1537 } else if (!atmos_rate && rate != video_frame_rate()) {
1539 set_video_frame_rate (rate, false);
1540 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."));
1545 bool change_made = false;
1546 for (auto i: content()) {
1547 auto d = dynamic_pointer_cast<DCPContent>(i);
1553 if (d->reference_video() && !d->can_reference_video(shared_from_this(), why_not)) {
1554 d->set_reference_video(false);
1557 if (d->reference_audio() && !d->can_reference_audio(shared_from_this(), why_not)) {
1558 d->set_reference_audio(false);
1561 if (d->reference_text(TextType::OPEN_SUBTITLE) && !d->can_reference_text(shared_from_this(), TextType::OPEN_SUBTITLE, why_not)) {
1562 d->set_reference_text(TextType::OPEN_SUBTITLE, false);
1565 if (d->reference_text(TextType::CLOSED_CAPTION) && !d->can_reference_text(shared_from_this(), TextType::CLOSED_CAPTION, why_not)) {
1566 d->set_reference_text(TextType::CLOSED_CAPTION, false);
1572 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."));
1577 Film::playlist_order_changed ()
1579 /* XXX: missing PENDING */
1580 signal_change (ChangeType::DONE, Property::CONTENT_ORDER);
1585 Film::set_sequence (bool s)
1587 if (s == _sequence) {
1591 FilmChangeSignaller cc (this, Property::SEQUENCE);
1593 _playlist->set_sequence (s);
1596 /** @return Size of the largest possible image in whatever resolution we are using */
1598 Film::full_frame () const
1600 switch (_resolution) {
1601 case Resolution::TWO_K:
1602 return dcp::Size (2048, 1080);
1603 case Resolution::FOUR_K:
1604 return dcp::Size (4096, 2160);
1607 DCPOMATIC_ASSERT (false);
1608 return dcp::Size ();
1611 /** @return Size of the frame */
1613 Film::frame_size () const
1615 return fit_ratio_within (container()->ratio(), full_frame ());
1619 /** @return Area of Film::frame_size() that contains picture rather than pillar/letterboxing */
1621 Film::active_area () const
1623 auto const frame = frame_size ();
1626 for (auto i: content()) {
1628 dcp::Size s = i->video->scaled_size (frame);
1629 active.width = max(active.width, s.width);
1630 active.height = max(active.height, s.height);
1638 /* @param cpl_file CPL filename.
1639 * @param from KDM from time expressed as a local time with an offset from UTC.
1640 * @param until KDM to time expressed as a local time with an offset from UTC.
1643 Film::make_kdm(boost::filesystem::path cpl_file, dcp::LocalTime from, dcp::LocalTime until) const
1646 throw runtime_error (_("Cannot make a KDM as this project is not encrypted."));
1649 auto cpl = make_shared<dcp::CPL>(cpl_file);
1651 /* Find keys that have been added to imported, encrypted DCP content */
1652 list<dcp::DecryptedKDMKey> imported_keys;
1653 for (auto i: content()) {
1654 auto d = dynamic_pointer_cast<DCPContent> (i);
1655 if (d && d->kdm()) {
1656 dcp::DecryptedKDM kdm (d->kdm().get(), Config::instance()->decryption_chain()->key().get());
1657 auto keys = kdm.keys ();
1658 copy (keys.begin(), keys.end(), back_inserter (imported_keys));
1662 map<shared_ptr<const dcp::ReelFileAsset>, dcp::Key> keys;
1664 for (auto i: cpl->reel_file_assets()) {
1665 if (!i->encrypted()) {
1669 /* Get any imported key for this ID */
1671 for (auto j: imported_keys) {
1672 if (j.id() == i->key_id().get()) {
1673 LOG_GENERAL ("Using imported key for %1", i->key_id().get());
1680 /* No imported key; it must be an asset that we encrypted */
1681 LOG_GENERAL ("Using our own key for %1", i->key_id().get());
1686 return dcp::DecryptedKDM (
1687 cpl->id(), keys, from, until, cpl->content_title_text(), cpl->content_title_text(), dcp::LocalTime().as_string()
1692 /** @return The approximate disk space required to encode a DCP of this film with the
1693 * current settings, in bytes.
1696 Film::required_disk_space () const
1698 return _playlist->required_disk_space (shared_from_this(), j2k_bandwidth(), audio_channels(), audio_frame_rate());
1701 /** This method checks the disk that the Film is on and tries to decide whether or not
1702 * there will be enough space to make a DCP for it. If so, true is returned; if not,
1703 * false is returned and required and available are filled in with the amount of disk space
1704 * required and available respectively (in GB).
1706 * Note: the decision made by this method isn't, of course, 100% reliable.
1709 Film::should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const
1711 /* Create a test file and see if we can hard-link it */
1712 boost::filesystem::path test = internal_video_asset_dir() / "test";
1713 boost::filesystem::path test2 = internal_video_asset_dir() / "test2";
1714 can_hard_link = true;
1715 dcp::File f(test, "w");
1718 boost::system::error_code ec;
1719 boost::filesystem::create_hard_link (test, test2, ec);
1721 can_hard_link = false;
1723 boost::filesystem::remove (test);
1724 boost::filesystem::remove (test2);
1727 auto s = boost::filesystem::space (internal_video_asset_dir ());
1728 required = double (required_disk_space ()) / 1073741824.0f;
1729 if (!can_hard_link) {
1732 available = double (s.available) / 1073741824.0f;
1733 return (available - required) > 1;
1736 /** @return The names of the channels that audio contents' outputs are passed into;
1737 * this is either the DCP or a AudioProcessor.
1739 vector<NamedChannel>
1740 Film::audio_output_names () const
1742 if (audio_processor ()) {
1743 return audio_processor()->input_names ();
1746 DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
1748 vector<NamedChannel> n;
1750 for (int i = 0; i < audio_channels(); ++i) {
1751 if (Config::instance()->use_all_audio_channels() || (i != 8 && i != 9 && i != 15)) {
1752 n.push_back (NamedChannel(short_audio_channel_name(i), i));
1760 Film::repeat_content (ContentList c, int n)
1762 _playlist->repeat (shared_from_this(), c, n);
1766 Film::remove_content (ContentList c)
1768 _playlist->remove (c);
1772 Film::audio_analysis_finished ()
1778 Film::reels () const
1780 list<DCPTimePeriod> p;
1781 auto const len = length();
1783 switch (reel_type ()) {
1784 case ReelType::SINGLE:
1785 p.push_back (DCPTimePeriod (DCPTime (), len));
1787 case ReelType::BY_VIDEO_CONTENT:
1789 /* Collect all reel boundaries */
1790 list<DCPTime> split_points;
1791 split_points.push_back (DCPTime());
1792 split_points.push_back (len);
1793 for (auto c: content()) {
1795 for (auto t: c->reel_split_points(shared_from_this())) {
1796 split_points.push_back (t);
1798 split_points.push_back (c->end(shared_from_this()));
1802 split_points.sort ();
1803 split_points.unique ();
1805 /* Make them into periods, coalescing any that are less than 1 second long */
1806 optional<DCPTime> last;
1807 for (auto t: split_points) {
1808 if (last && (t - *last) >= DCPTime::from_seconds(1)) {
1809 /* Period from *last to t is long enough; use it and start a new one */
1810 p.push_back (DCPTimePeriod(*last, t));
1813 /* That was the first time, so start a new period */
1819 p.back().to = split_points.back();
1823 case ReelType::BY_LENGTH:
1826 /* Integer-divide reel length by the size of one frame to give the number of frames per reel,
1827 * making sure we don't go less than 1s long.
1829 Frame const reel_in_frames = max(_reel_length / ((j2k_bandwidth() / video_frame_rate()) / 8), static_cast<Frame>(video_frame_rate()));
1830 while (current < len) {
1831 DCPTime end = min (len, current + DCPTime::from_frames (reel_in_frames, video_frame_rate ()));
1832 p.push_back (DCPTimePeriod (current, end));
1842 /** @param period A period within the DCP
1843 * @return Name of the content which most contributes to the given period.
1846 Film::content_summary (DCPTimePeriod period) const
1848 return _playlist->content_summary (shared_from_this(), period);
1852 Film::use_template (string name)
1854 _template_film.reset (new Film (optional<boost::filesystem::path>()));
1855 _template_film->read_metadata (Config::instance()->template_read_path(name));
1856 _use_isdcf_name = _template_film->_use_isdcf_name;
1857 _dcp_content_type = _template_film->_dcp_content_type;
1858 _container = _template_film->_container;
1859 _resolution = _template_film->_resolution;
1860 _j2k_bandwidth = _template_film->_j2k_bandwidth;
1861 _video_frame_rate = _template_film->_video_frame_rate;
1862 _encrypted = _template_film->_encrypted;
1863 _audio_channels = _template_film->_audio_channels;
1864 _sequence = _template_film->_sequence;
1865 _three_d = _template_film->_three_d;
1866 _interop = _template_film->_interop;
1867 _audio_processor = _template_film->_audio_processor;
1868 _reel_type = _template_film->_reel_type;
1869 _reel_length = _template_film->_reel_length;
1872 pair<double, double>
1873 Film::speed_up_range (int dcp_frame_rate) const
1875 return _playlist->speed_up_range (dcp_frame_rate);
1879 Film::copy_from (shared_ptr<const Film> film)
1881 read_metadata (film->file (metadata_file));
1885 Film::references_dcp_video () const
1887 for (auto i: _playlist->content()) {
1888 auto d = dynamic_pointer_cast<DCPContent>(i);
1889 if (d && d->reference_video()) {
1898 Film::references_dcp_audio () const
1900 for (auto i: _playlist->content()) {
1901 auto d = dynamic_pointer_cast<DCPContent>(i);
1902 if (d && d->reference_audio()) {
1912 Film::contains_atmos_content () const
1914 for (auto i: _playlist->content()) {
1925 Film::closed_caption_tracks () const
1927 list<DCPTextTrack> tt;
1928 for (auto i: content()) {
1929 for (auto j: i->text) {
1930 /* XXX: Empty DCPTextTrack ends up being a magic value here - the "unknown" or "not specified" track */
1931 auto dtt = j->dcp_track().get_value_or(DCPTextTrack());
1932 if (j->type() == TextType::CLOSED_CAPTION && find(tt.begin(), tt.end(), dtt) == tt.end()) {
1942 Film::set_marker (dcp::Marker type, DCPTime time)
1944 FilmChangeSignaller ch (this, Property::MARKERS);
1945 _markers[type] = time;
1950 Film::unset_marker (dcp::Marker type)
1952 FilmChangeSignaller ch (this, Property::MARKERS);
1953 _markers.erase (type);
1958 Film::clear_markers ()
1960 FilmChangeSignaller ch (this, Property::MARKERS);
1966 Film::set_ratings (vector<dcp::Rating> r)
1968 FilmChangeSignaller ch (this, Property::RATINGS);
1973 Film::set_content_versions (vector<string> v)
1975 FilmChangeSignaller ch (this, Property::CONTENT_VERSIONS);
1976 _content_versions = v;
1981 Film::set_name_language (dcp::LanguageTag lang)
1983 FilmChangeSignaller ch (this, Property::NAME_LANGUAGE);
1984 _name_language = lang;
1989 Film::set_release_territory (optional<dcp::LanguageTag::RegionSubtag> region)
1991 FilmChangeSignaller ch (this, Property::RELEASE_TERRITORY);
1992 _release_territory = region;
1997 Film::set_status (dcp::Status s)
1999 FilmChangeSignaller ch (this, Property::STATUS);
2005 Film::set_version_number (int v)
2007 FilmChangeSignaller ch (this, Property::VERSION_NUMBER);
2008 _version_number = v;
2013 Film::set_chain (optional<string> c)
2015 FilmChangeSignaller ch (this, Property::CHAIN);
2021 Film::set_distributor (optional<string> d)
2023 FilmChangeSignaller ch (this, Property::DISTRIBUTOR);
2029 Film::set_luminance (optional<dcp::Luminance> l)
2031 FilmChangeSignaller ch (this, Property::LUMINANCE);
2037 Film::set_facility (optional<string> f)
2039 FilmChangeSignaller ch (this, Property::FACILITY);
2045 Film::set_studio (optional<string> s)
2047 FilmChangeSignaller ch (this, Property::STUDIO);
2053 Film::marker (dcp::Marker type) const
2055 auto i = _markers.find (type);
2056 if (i == _markers.end()) {
2062 shared_ptr<InfoFileHandle>
2063 Film::info_file_handle (DCPTimePeriod period, bool read) const
2065 return std::make_shared<InfoFileHandle>(_info_file_mutex, info_file(period), read);
2068 InfoFileHandle::InfoFileHandle (boost::mutex& mutex, boost::filesystem::path path, bool read)
2070 , _file (path, read ? "rb" : (boost::filesystem::exists(path) ? "r+b" : "wb"))
2073 throw OpenFileError (path, errno, read ? OpenFileError::READ : (boost::filesystem::exists(path) ? OpenFileError::READ_WRITE : OpenFileError::WRITE));
2078 /** Add FFOC and LFOC markers to a list if they are not already there */
2080 Film::add_ffoc_lfoc (Markers& markers) const
2082 if (markers.find(dcp::Marker::FFOC) == markers.end()) {
2083 markers[dcp::Marker::FFOC] = dcpomatic::DCPTime::from_frames(1, video_frame_rate());
2086 if (markers.find(dcp::Marker::LFOC) == markers.end()) {
2087 markers[dcp::Marker::LFOC] = length() - DCPTime::from_frames(1, video_frame_rate());
2093 Film::set_temp_version (bool t)
2095 FilmChangeSignaller ch (this, Property::TEMP_VERSION);
2101 Film::set_pre_release (bool p)
2103 FilmChangeSignaller ch (this, Property::PRE_RELEASE);
2109 Film::set_red_band (bool r)
2111 FilmChangeSignaller ch (this, Property::RED_BAND);
2117 Film::set_two_d_version_of_three_d (bool t)
2119 FilmChangeSignaller ch (this, Property::TWO_D_VERSION_OF_THREE_D);
2120 _two_d_version_of_three_d = t;
2125 Film::set_audio_language (optional<dcp::LanguageTag> language)
2127 FilmChangeSignaller ch (this, Property::AUDIO_LANGUAGE);
2128 _audio_language = language;
2133 Film::set_audio_frame_rate (int rate)
2135 FilmChangeSignaller ch (this, Property::AUDIO_FRAME_RATE);
2136 _audio_frame_rate = rate;
2141 Film::has_sign_language_video_channel () const
2143 return _audio_channels >= static_cast<int>(dcp::Channel::SIGN_LANGUAGE);
2148 Film::set_sign_language_video_language (optional<dcp::LanguageTag> lang)
2150 FilmChangeSignaller ch (this, Property::SIGN_LANGUAGE_VIDEO_LANGUAGE);
2151 _sign_language_video_language = lang;
2156 Film::set_dirty (bool dirty)
2158 auto const changed = dirty != _dirty;
2161 emit (boost::bind(boost::ref(DirtyChange), _dirty));
2166 /** @return true if the metadata was (probably) last written by a version earlier
2167 * than the given one; false if it definitely was not.
2170 Film::last_written_by_earlier_than(int major, int minor, int micro) const
2172 if (!_last_written_by) {
2176 vector<string> parts;
2177 boost::split(parts, *_last_written_by, boost::is_any_of("."));
2179 if (parts.size() != 3) {
2180 /* Not sure what's going on, so let's say it was written by an old version */
2184 if (boost::ends_with(parts[2], "pre")) {
2185 parts[2] = parts[2].substr(0, parts[2].length() - 3);
2188 int our_major = dcp::raw_convert<int>(parts[0]);
2189 int our_minor = dcp::raw_convert<int>(parts[1]);
2190 int our_micro = dcp::raw_convert<int>(parts[2]);
2192 if (our_major != major) {
2193 return our_major < major;
2196 if (our_minor != minor) {
2197 return our_minor < minor;
2200 return our_micro < micro;