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/>.
22 * @brief A representation of some audio, video and subtitle content, and details of
23 * how they should be presented in a DCP.
26 #include "atmos_content.h"
30 #include "job_manager.h"
31 #include "dcp_encoder.h"
32 #include "transcode_job.h"
33 #include "upload_job.h"
36 #include "dcpomatic_log.h"
37 #include "exceptions.h"
38 #include "examine_content_job.h"
41 #include "dcp_content_type.h"
44 #include "environment_info.h"
45 #include "audio_processor.h"
47 #include "compose.hpp"
49 #include "audio_content.h"
50 #include "video_content.h"
51 #include "text_content.h"
52 #include "ffmpeg_content.h"
53 #include "dcp_content.h"
54 #include "kdm_with_metadata.h"
56 #include "change_signaller.h"
57 #include "check_content_change_job.h"
58 #include "ffmpeg_subtitle_stream.h"
60 #include <libcxml/cxml.h>
62 #include <dcp/certificate_chain.h>
64 #include <dcp/local_time.h>
65 #include <dcp/decrypted_kdm.h>
66 #include <dcp/raw_convert.h>
67 #include <dcp/reel_file_asset.h>
68 #include <dcp/reel_asset.h>
69 #include <libxml++/libxml++.h>
70 #include <boost/filesystem.hpp>
71 #include <boost/algorithm/string.hpp>
72 #include <boost/regex.hpp>
93 using std::runtime_error;
95 using std::back_inserter;
99 using std::shared_ptr;
101 using std::make_shared;
102 using std::dynamic_pointer_cast;
103 using boost::optional;
104 using boost::is_any_of;
105 #if BOOST_VERSION >= 106100
106 using namespace boost::placeholders;
108 using dcp::raw_convert;
109 using namespace dcpomatic;
111 string const Film::metadata_file = "metadata.xml";
114 * AudioMapping XML changed.
116 * Subtitle offset changed to subtitle y offset, and subtitle x offset added.
118 * Use <Scale> tag in <VideoContent> rather than <Ratio>.
122 * Subtitle X and Y scale.
124 * Bumped to 32 for 2.0 branch; some times are expressed in Times rather
128 * Changed <Period> to <Subtitle> in FFmpegSubtitleStream
130 * Content only contains audio/subtitle-related tags if those things
133 * VideoFrameType in VideoContent is a string rather than an integer.
135 * EffectColour rather than OutlineColour in Subtitle.
137 * TextContent can be in a Caption tag, and some of the tag names
138 * have had Subtitle prefixes or suffixes removed.
140 * VideoContent scale expressed just as "guess" or "custom"
142 int const Film::current_state_version = 38;
144 /** Construct a Film object in a given directory.
146 * @param dir Film directory.
149 Film::Film (optional<boost::filesystem::path> dir)
150 : _playlist (new Playlist)
151 , _use_isdcf_name (true)
152 , _dcp_content_type (Config::instance()->default_dcp_content_type ())
153 , _container (Config::instance()->default_container ())
154 , _resolution (Resolution::TWO_K)
156 , _context_id (dcp::make_uuid ())
157 , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
158 , _video_frame_rate (24)
159 , _audio_channels (Config::instance()->default_dcp_audio_channels ())
162 , _interop (Config::instance()->default_interop ())
163 , _audio_processor (0)
164 , _reel_type (ReelType::SINGLE)
165 , _reel_length (2000000000)
166 , _reencode_j2k (false)
167 , _user_explicit_video_frame_rate (false)
168 , _user_explicit_container (false)
169 , _user_explicit_resolution (false)
170 , _name_language (dcp::LanguageTag("en-US"))
171 , _version_number (1)
172 , _status (dcp::Status::FINAL)
173 , _state_version (current_state_version)
177 set_isdcf_date_today ();
179 auto metadata = Config::instance()->default_metadata();
180 if (metadata.find("chain") != metadata.end()) {
181 _chain = metadata["chain"];
183 if (metadata.find("distributor") != metadata.end()) {
184 _distributor = metadata["distributor"];
186 if (metadata.find("facility") != metadata.end()) {
187 _facility = metadata["facility"];
189 if (metadata.find("studio") != metadata.end()) {
190 _studio = metadata["studio"];
193 _playlist_change_connection = _playlist->Change.connect (bind (&Film::playlist_change, this, _1));
194 _playlist_order_changed_connection = _playlist->OrderChange.connect (bind (&Film::playlist_order_changed, this));
195 _playlist_content_change_connection = _playlist->ContentChange.connect (bind (&Film::playlist_content_change, this, _1, _2, _3, _4));
196 _playlist_length_change_connection = _playlist->LengthChange.connect (bind(&Film::playlist_length_change, this));
199 /* Make state.directory a complete path without ..s (where possible)
200 (Code swiped from Adam Bowen on stackoverflow)
201 XXX: couldn't/shouldn't this just be boost::filesystem::canonical?
204 boost::filesystem::path p (boost::filesystem::system_complete (dir.get()));
205 boost::filesystem::path result;
208 boost::system::error_code ec;
209 if (boost::filesystem::is_symlink(result, ec) || result.filename() == "..") {
212 result = result.parent_path ();
214 } else if (i != ".") {
219 set_directory (result.make_preferred ());
223 _log = make_shared<FileLog>(file("log"));
225 _log = make_shared<NullLog>();
228 _playlist->set_sequence (_sequence);
233 for (auto& i: _job_connections) {
237 for (auto& i: _audio_analysis_connections) {
243 Film::video_identifier () const
245 DCPOMATIC_ASSERT (container ());
247 string s = container()->id()
248 + "_" + resolution_to_string (_resolution)
249 + "_" + _playlist->video_identifier()
250 + "_" + raw_convert<string>(_video_frame_rate)
251 + "_" + raw_convert<string>(j2k_bandwidth());
254 /* This is insecure but hey, the key is in plaintext in metadata.xml */
255 s += "_E" + _key.hex();
273 /** @return The file to write video frame info to */
274 boost::filesystem::path
275 Film::info_file (DCPTimePeriod period) const
277 boost::filesystem::path p;
279 p /= video_identifier () + "_" + raw_convert<string> (period.from.get()) + "_" + raw_convert<string> (period.to.get());
283 boost::filesystem::path
284 Film::internal_video_asset_dir () const
286 return dir ("video");
289 boost::filesystem::path
290 Film::internal_video_asset_filename (DCPTimePeriod p) const
292 return video_identifier() + "_" + raw_convert<string> (p.from.get()) + "_" + raw_convert<string> (p.to.get()) + ".mxf";
295 boost::filesystem::path
296 Film::audio_analysis_path (shared_ptr<const Playlist> playlist) const
298 auto p = dir ("analysis");
301 for (auto i: playlist->content()) {
306 digester.add (i->digest());
307 digester.add (i->audio->mapping().digest());
308 if (playlist->content().size() != 1) {
309 /* Analyses should be considered equal regardless of gain
310 if they were made from just one piece of content. This
311 is because we can fake any gain change in a single-content
312 analysis at the plotting stage rather than having to
315 digester.add (i->audio->gain());
317 /* Likewise we only care about position if we're looking at a
318 * whole-project view.
320 digester.add (i->position().get());
321 digester.add (i->trim_start().get());
322 digester.add (i->trim_end().get());
326 if (audio_processor ()) {
327 digester.add (audio_processor()->id ());
330 digester.add (audio_channels());
332 p /= digester.get ();
337 boost::filesystem::path
338 Film::subtitle_analysis_path (shared_ptr<const Content> content) const
340 auto p = dir ("analysis");
343 digester.add (content->digest());
345 if (!content->text.empty()) {
346 auto tc = content->text.front();
347 digester.add (tc->x_scale());
348 digester.add (tc->y_scale());
349 for (auto i: tc->fonts()) {
350 digester.add (i->id());
353 digester.add (tc->effect().get());
355 digester.add (tc->line_spacing());
356 digester.add (tc->outline_width());
359 auto fc = dynamic_pointer_cast<const FFmpegContent>(content);
361 digester.add (fc->subtitle_stream()->identifier());
364 p /= digester.get ();
369 /** Add suitable Jobs to the JobManager to create a DCP for this Film.
370 * @param gui true if this is being called from a GUI tool.
371 * @param check true to check the content in the project for changes before making the DCP.
374 Film::make_dcp (bool gui, bool check)
376 if (dcp_name().find ("/") != string::npos) {
377 throw BadSettingError (_("name"), _("Cannot contain slashes"));
380 if (container() == nullptr) {
381 throw MissingSettingError (_("container"));
384 if (content().empty()) {
385 throw runtime_error (_("You must add some content to the DCP before creating it"));
388 if (length() == DCPTime()) {
389 throw runtime_error (_("The DCP is empty, perhaps because all the content has zero length."));
392 if (dcp_content_type() == nullptr) {
393 throw MissingSettingError (_("content type"));
396 if (name().empty()) {
400 for (auto i: content ()) {
401 if (!i->paths_valid()) {
402 throw runtime_error (_("some of your content is missing"));
404 auto dcp = dynamic_pointer_cast<const DCPContent>(i);
405 if (dcp && dcp->needs_kdm()) {
406 throw runtime_error (_("Some of your content needs a KDM"));
408 if (dcp && dcp->needs_assets()) {
409 throw runtime_error (_("Some of your content needs an OV"));
413 set_isdcf_date_today ();
415 for (auto i: environment_info ()) {
419 for (auto i: content ()) {
420 LOG_GENERAL ("Content: %1", i->technical_summary());
422 LOG_GENERAL ("DCP video rate %1 fps", video_frame_rate());
423 if (Config::instance()->only_servers_encode ()) {
424 LOG_GENERAL_NC ("0 threads: ONLY SERVERS SET TO ENCODE");
426 LOG_GENERAL ("%1 threads", Config::instance()->master_encoding_threads());
428 LOG_GENERAL ("J2K bandwidth %1", j2k_bandwidth());
430 auto tj = make_shared<TranscodeJob>(shared_from_this());
431 tj->set_encoder (make_shared<DCPEncoder>(shared_from_this(), tj));
433 auto cc = make_shared<CheckContentChangeJob>(shared_from_this(), tj, gui);
434 JobManager::instance()->add (cc);
436 JobManager::instance()->add (tj);
440 /** Start a job to send our DCP to the configured TMS */
442 Film::send_dcp_to_tms ()
444 JobManager::instance()->add(make_shared<UploadJob>(shared_from_this()));
447 shared_ptr<xmlpp::Document>
448 Film::metadata (bool with_content_paths) const
450 auto doc = make_shared<xmlpp::Document>();
451 auto root = doc->create_root_node ("Metadata");
453 root->add_child("Version")->add_child_text (raw_convert<string> (current_state_version));
454 root->add_child("Name")->add_child_text (_name);
455 root->add_child("UseISDCFName")->add_child_text (_use_isdcf_name ? "1" : "0");
457 if (_dcp_content_type) {
458 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->isdcf_name ());
462 root->add_child("Container")->add_child_text (_container->id ());
465 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
466 root->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
467 root->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
468 root->add_child("ISDCFDate")->add_child_text (boost::gregorian::to_iso_string (_isdcf_date));
469 root->add_child("AudioChannels")->add_child_text (raw_convert<string> (_audio_channels));
470 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
471 root->add_child("Sequence")->add_child_text (_sequence ? "1" : "0");
472 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
473 root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
474 root->add_child("Key")->add_child_text (_key.hex ());
475 root->add_child("ContextID")->add_child_text (_context_id);
476 if (_audio_processor) {
477 root->add_child("AudioProcessor")->add_child_text (_audio_processor->id ());
479 root->add_child("ReelType")->add_child_text (raw_convert<string> (static_cast<int> (_reel_type)));
480 root->add_child("ReelLength")->add_child_text (raw_convert<string> (_reel_length));
481 root->add_child("ReencodeJ2K")->add_child_text (_reencode_j2k ? "1" : "0");
482 root->add_child("UserExplicitVideoFrameRate")->add_child_text(_user_explicit_video_frame_rate ? "1" : "0");
483 for (map<dcp::Marker, DCPTime>::const_iterator i = _markers.begin(); i != _markers.end(); ++i) {
484 auto m = root->add_child("Marker");
485 m->set_attribute("Type", dcp::marker_to_string(i->first));
486 m->add_child_text(raw_convert<string>(i->second.get()));
488 for (auto i: _ratings) {
489 i.as_xml (root->add_child("Rating"));
491 for (auto i: _content_versions) {
492 root->add_child("ContentVersion")->add_child_text(i);
494 root->add_child("NameLanguage")->add_child_text(_name_language.to_string());
495 if (_release_territory) {
496 root->add_child("ReleaseTerritory")->add_child_text(_release_territory->subtag());
498 if (_sign_language_video_language) {
499 root->add_child("SignLanguageVideoLanguage")->add_child_text(_sign_language_video_language->to_string());
501 root->add_child("VersionNumber")->add_child_text(raw_convert<string>(_version_number));
502 root->add_child("Status")->add_child_text(dcp::status_to_string(_status));
504 root->add_child("Chain")->add_child_text(*_chain);
507 root->add_child("Distributor")->add_child_text(*_distributor);
510 root->add_child("Facility")->add_child_text(*_facility);
513 root->add_child("Studio")->add_child_text(*_studio);
515 root->add_child("TempVersion")->add_child_text(_temp_version ? "1" : "0");
516 root->add_child("PreRelease")->add_child_text(_pre_release ? "1" : "0");
517 root->add_child("RedBand")->add_child_text(_red_band ? "1" : "0");
518 root->add_child("TwoDVersionOfThreeD")->add_child_text(_two_d_version_of_three_d ? "1" : "0");
520 root->add_child("LuminanceValue")->add_child_text(raw_convert<string>(_luminance->value()));
521 root->add_child("LuminanceUnit")->add_child_text(dcp::Luminance::unit_to_string(_luminance->unit()));
523 root->add_child("UserExplicitContainer")->add_child_text(_user_explicit_container ? "1" : "0");
524 root->add_child("UserExplicitResolution")->add_child_text(_user_explicit_resolution ? "1" : "0");
525 if (_audio_language) {
526 root->add_child("AudioLanguage")->add_child_text(_audio_language->to_string());
528 _playlist->as_xml (root->add_child ("Playlist"), with_content_paths);
534 Film::write_metadata (boost::filesystem::path path) const
536 metadata()->write_to_file_formatted(path.string());
539 /** Write state to our `metadata' file */
541 Film::write_metadata () const
543 DCPOMATIC_ASSERT (directory());
544 boost::filesystem::create_directories (directory().get());
545 metadata()->write_to_file_formatted(file(metadata_file).string());
549 /** Write a template from this film */
551 Film::write_template (boost::filesystem::path path) const
553 boost::filesystem::create_directories (path.parent_path());
554 shared_ptr<xmlpp::Document> doc = metadata (false);
555 metadata(false)->write_to_file_formatted(path.string());
558 /** Read state from our metadata file.
559 * @return Notes about things that the user should know about, or empty.
562 Film::read_metadata (optional<boost::filesystem::path> path)
565 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file (metadata_file))) {
566 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!"));
569 path = file (metadata_file);
572 if (!boost::filesystem::exists(*path)) {
573 throw FileNotFoundError(*path);
576 cxml::Document f ("Metadata");
577 f.read_file (path.get ());
579 _state_version = f.number_child<int> ("Version");
580 if (_state_version > current_state_version) {
581 throw runtime_error (_("This film was created with a newer version of DCP-o-matic, and it cannot be loaded into this version. Sorry!"));
582 } else if (_state_version < current_state_version) {
583 /* This is an older version; save a copy (if we haven't already) */
584 auto const older = path->parent_path() / String::compose("metadata.%1.xml", _state_version);
585 if (!boost::filesystem::is_regular_file(older)) {
587 boost::filesystem::copy_file(*path, older);
589 /* Never mind; at least we tried */
594 _name = f.string_child ("Name");
595 if (_state_version >= 9) {
596 _use_isdcf_name = f.bool_child ("UseISDCFName");
597 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("ISDCFDate"));
599 _use_isdcf_name = f.bool_child ("UseDCIName");
600 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
605 auto c = f.optional_string_child("DCPContentType");
607 _dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
612 auto c = f.optional_string_child("Container");
614 _container = Ratio::from_id (c.get ());
618 _resolution = string_to_resolution (f.string_child ("Resolution"));
619 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
620 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
621 _encrypted = f.bool_child ("Encrypted");
622 _audio_channels = f.number_child<int> ("AudioChannels");
623 /* We used to allow odd numbers (and zero) channels, but it's just not worth
626 if (_audio_channels == 0) {
628 } else if ((_audio_channels % 2) == 1) {
632 if (f.optional_bool_child("SequenceVideo")) {
633 _sequence = f.bool_child("SequenceVideo");
635 _sequence = f.bool_child("Sequence");
638 _three_d = f.bool_child ("ThreeD");
639 _interop = f.bool_child ("Interop");
640 _key = dcp::Key (f.string_child ("Key"));
641 _context_id = f.optional_string_child("ContextID").get_value_or (dcp::make_uuid ());
643 if (f.optional_string_child ("AudioProcessor")) {
644 _audio_processor = AudioProcessor::from_id (f.string_child ("AudioProcessor"));
646 _audio_processor = 0;
649 if (_audio_processor && !Config::instance()->show_experimental_audio_processors()) {
650 auto ap = AudioProcessor::visible();
651 if (find(ap.begin(), ap.end(), _audio_processor) == ap.end()) {
652 Config::instance()->set_show_experimental_audio_processors(true);
656 _reel_type = static_cast<ReelType> (f.optional_number_child<int>("ReelType").get_value_or (static_cast<int>(ReelType::SINGLE)));
657 _reel_length = f.optional_number_child<int64_t>("ReelLength").get_value_or (2000000000);
658 _reencode_j2k = f.optional_bool_child("ReencodeJ2K").get_value_or(false);
659 _user_explicit_video_frame_rate = f.optional_bool_child("UserExplicitVideoFrameRate").get_value_or(false);
661 for (auto i: f.node_children("Marker")) {
662 _markers[dcp::marker_from_string(i->string_attribute("Type"))] = DCPTime(dcp::raw_convert<DCPTime::Type>(i->content()));
665 for (auto i: f.node_children("Rating")) {
666 _ratings.push_back (dcp::Rating(i));
669 for (auto i: f.node_children("ContentVersion")) {
670 _content_versions.push_back (i->content());
673 auto name_language = f.optional_string_child("NameLanguage");
675 _name_language = dcp::LanguageTag (*name_language);
677 auto release_territory = f.optional_string_child("ReleaseTerritory");
678 if (release_territory) {
679 _release_territory = dcp::LanguageTag::RegionSubtag (*release_territory);
682 auto sign_language_video_language = f.optional_string_child("SignLanguageVideoLanguage");
683 if (sign_language_video_language) {
684 _sign_language_video_language = dcp::LanguageTag(*sign_language_video_language);
687 _version_number = f.optional_number_child<int>("VersionNumber").get_value_or(0);
689 auto status = f.optional_string_child("Status");
691 _status = dcp::string_to_status (*status);
694 _chain = f.optional_string_child("Chain");
695 _distributor = f.optional_string_child("Distributor");
696 _facility = f.optional_string_child("Facility");
697 _studio = f.optional_string_child("Studio");
698 _temp_version = f.optional_bool_child("TempVersion").get_value_or(false);
699 _pre_release = f.optional_bool_child("PreRelease").get_value_or(false);
700 _red_band = f.optional_bool_child("RedBand").get_value_or(false);
701 _two_d_version_of_three_d = f.optional_bool_child("TwoDVersionOfThreeD").get_value_or(false);
703 auto value = f.optional_number_child<float>("LuminanceValue");
704 auto unit = f.optional_string_child("LuminanceUnit");
706 _luminance = dcp::Luminance (*value, dcp::Luminance::string_to_unit(*unit));
709 /* Disable guessing for files made in previous DCP-o-matic versions */
710 _user_explicit_container = f.optional_bool_child("UserExplicitContainer").get_value_or(true);
711 _user_explicit_resolution = f.optional_bool_child("UserExplicitResolution").get_value_or(true);
713 auto audio_language = f.optional_string_child("AudioLanguage");
714 if (audio_language) {
715 _audio_language = dcp::LanguageTag(*audio_language);
719 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
721 /* Write backtraces to this film's directory, until another film is loaded */
723 set_backtrace_file (file ("backtrace.txt"));
730 /** Given a directory name, return its full path within the Film's directory.
731 * @param d directory name within the Film's directory.
732 * @param create true to create the directory (and its parents) if they do not exist.
734 boost::filesystem::path
735 Film::dir (boost::filesystem::path d, bool create) const
737 DCPOMATIC_ASSERT (_directory);
739 boost::filesystem::path p;
740 p /= _directory.get();
744 boost::filesystem::create_directories (p);
750 /** Given a file or directory name, return its full path within the Film's directory.
751 * Any required parent directories will be created.
753 boost::filesystem::path
754 Film::file (boost::filesystem::path f) const
756 DCPOMATIC_ASSERT (_directory);
758 boost::filesystem::path p;
759 p /= _directory.get();
762 boost::filesystem::create_directories (p.parent_path ());
768 Film::mapped_audio_channels () const
772 if (audio_processor ()) {
773 /* Processors are mapped 1:1 to DCP outputs so we can work out mappings from there */
774 for (int i = 0; i < audio_processor()->out_channels(); ++i) {
775 mapped.push_back (i);
778 for (auto i: content()) {
780 auto c = i->audio->mapping().mapped_output_channels();
781 copy (c.begin(), c.end(), back_inserter(mapped));
793 pair<optional<dcp::LanguageTag>, vector<dcp::LanguageTag>>
794 Film::subtitle_languages () const
796 pair<optional<dcp::LanguageTag>, vector<dcp::LanguageTag>> result;
797 for (auto i: content()) {
798 for (auto j: i->text) {
799 if (j->use() && j->type() == TextType::OPEN_SUBTITLE && j->language()) {
800 if (j->language_is_additional()) {
801 result.second.push_back (j->language().get());
803 result.first = j->language().get();
807 if (i->video && i->video->burnt_subtitle_language()) {
808 result.first = i->video->burnt_subtitle_language();
812 std::sort (result.second.begin(), result.second.end());
813 auto last = std::unique (result.second.begin(), result.second.end());
814 result.second.erase (last, result.second.end());
819 /** @return a ISDCF-compliant name for a DCP of this film */
821 Film::isdcf_name (bool if_created_now) const
825 auto raw_name = name ();
827 /* Split the raw name up into words */
828 vector<string> words;
829 split (words, raw_name, is_any_of (" _-"));
833 /* Add each word to fixed_name */
834 for (auto i: words) {
837 /* First letter is always capitalised */
838 w[0] = toupper (w[0]);
840 /* Count caps in w */
842 for (size_t j = 0; j < w.size(); ++j) {
843 if (isupper (w[j])) {
848 /* If w is all caps make the rest of it lower case, otherwise
851 if (caps == w.size ()) {
852 for (size_t j = 1; j < w.size(); ++j) {
853 w[j] = tolower (w[j]);
857 for (size_t j = 0; j < w.size(); ++j) {
862 if (fixed_name.length() > 14) {
863 fixed_name = fixed_name.substr (0, 14);
868 if (dcp_content_type()) {
869 d += "_" + dcp_content_type()->isdcf_name();
870 string version = "1";
872 if (!_content_versions.empty()) {
873 auto cv = _content_versions[0];
874 if (!cv.empty() && std::all_of(cv.begin(), cv.end(), isdigit)) {
879 version = dcp::raw_convert<string>(_version_number);
896 if (_chain && !_chain->empty()) {
904 if (_two_d_version_of_three_d) {
909 auto fl = _luminance->value_in_foot_lamberts();
911 snprintf (buffer, sizeof(buffer), "%.1f", fl);
912 d += String::compose("-%1fl", buffer);
915 if (video_frame_rate() != 24) {
916 d += "-" + raw_convert<string>(video_frame_rate());
920 d += "_" + container()->isdcf_name();
923 /* XXX: this uses the first bit of content only */
925 /* Interior aspect ratio. The standard says we don't do this for trailers, for some strange reason */
926 if (dcp_content_type() && dcp_content_type()->libdcp_kind() != dcp::ContentKind::TRAILER) {
928 auto first_video = std::find_if(cl.begin(), cl.end(), [](shared_ptr<Content> c) { return static_cast<bool>(c->video); });
929 if (first_video != cl.end()) {
930 auto first_ratio = lrintf((*first_video)->video->scaled_size(frame_size()).ratio() * 100);
931 auto container_ratio = lrintf(container()->ratio() * 100);
932 if (first_ratio != container_ratio) {
933 d += "-" + dcp::raw_convert<string>(first_ratio);
938 auto audio_language = (_audio_language && _audio_language->language()) ? _audio_language->language()->subtag() : "XX";
940 d += "_" + to_upper (audio_language);
942 /* I'm not clear on the precise details of the convention for CCAP labelling;
943 for now I'm just appending -CCAP if we have any closed captions.
946 auto burnt_in = true;
948 for (auto i: content()) {
949 for (auto j: i->text) {
950 if (j->type() == TextType::OPEN_SUBTITLE && j->use() && !j->burn()) {
952 } else if (j->type() == TextType::CLOSED_CAPTION && j->use()) {
958 auto sub_langs = subtitle_languages();
959 if (sub_langs.first && sub_langs.first->language()) {
960 auto lang = sub_langs.first->language()->subtag();
962 transform (lang.begin(), lang.end(), lang.begin(), ::tolower);
964 lang = to_upper (lang);
976 if (_release_territory) {
977 auto territory = _release_territory->subtag();
978 d += "_" + to_upper (territory);
979 if (_ratings.empty ()) {
982 d += "-" + _ratings[0].label;
986 /* Count mapped audio channels */
988 auto mapped = mapped_audio_channels ();
990 auto ch = audio_channel_types (mapped, audio_channels());
991 if (!ch.first && !ch.second) {
993 } else if (ch.first) {
994 d += String::compose("_%1%2", ch.first, ch.second);
997 if (audio_channels() > static_cast<int>(dcp::Channel::HI) && find(mapped.begin(), mapped.end(), static_cast<int>(dcp::Channel::HI)) != mapped.end()) {
1000 if (audio_channels() > static_cast<int>(dcp::Channel::VI) && find(mapped.begin(), mapped.end(), static_cast<int>(dcp::Channel::VI)) != mapped.end()) {
1004 d += "_" + resolution_to_string (_resolution);
1006 if (_studio && _studio->length() >= 2) {
1007 d += "_" + to_upper (_studio->substr(0, 4));
1010 if (if_created_now) {
1011 d += "_" + boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
1013 d += "_" + boost::gregorian::to_iso_string (_isdcf_date);
1016 if (_facility && _facility->length() >= 3) {
1017 d += "_" + to_upper(_facility->substr(0, 3));
1031 for (auto i: content()) {
1032 auto dc = dynamic_pointer_cast<const DCPContent>(i);
1037 bool any_text = false;
1038 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
1039 if (dc->reference_text(static_cast<TextType>(i))) {
1043 if (dc->reference_video() || dc->reference_audio() || any_text) {
1057 /** @return name to give the DCP */
1059 Film::dcp_name (bool if_created_now) const
1062 if (use_isdcf_name()) {
1063 return careful_string_filter (isdcf_name (if_created_now));
1066 return careful_string_filter (name ());
1070 Film::set_directory (boost::filesystem::path d)
1077 Film::set_name (string n)
1079 FilmChangeSignaller ch (this, Property::NAME);
1084 Film::set_use_isdcf_name (bool u)
1086 FilmChangeSignaller ch (this, Property::USE_ISDCF_NAME);
1087 _use_isdcf_name = u;
1091 Film::set_dcp_content_type (DCPContentType const * t)
1093 FilmChangeSignaller ch (this, Property::DCP_CONTENT_TYPE);
1094 _dcp_content_type = t;
1098 /** @param explicit_user true if this is being set because of
1099 * a direct user request, false if it is being done because
1100 * DCP-o-matic is guessing the best container to use.
1103 Film::set_container (Ratio const * c, bool explicit_user)
1105 FilmChangeSignaller ch (this, Property::CONTAINER);
1108 if (explicit_user) {
1109 _user_explicit_container = true;
1114 /** @param explicit_user true if this is being set because of
1115 * a direct user request, false if it is being done because
1116 * DCP-o-matic is guessing the best resolution to use.
1119 Film::set_resolution (Resolution r, bool explicit_user)
1121 FilmChangeSignaller ch (this, Property::RESOLUTION);
1124 if (explicit_user) {
1125 _user_explicit_resolution = true;
1131 Film::set_j2k_bandwidth (int b)
1133 FilmChangeSignaller ch (this, Property::J2K_BANDWIDTH);
1137 /** @param f New frame rate.
1138 * @param user_explicit true if this comes from a direct user instruction, false if it is from
1139 * DCP-o-matic being helpful.
1142 Film::set_video_frame_rate (int f, bool user_explicit)
1144 FilmChangeSignaller ch (this, Property::VIDEO_FRAME_RATE);
1145 _video_frame_rate = f;
1146 if (user_explicit) {
1147 _user_explicit_video_frame_rate = true;
1152 Film::set_audio_channels (int c)
1154 FilmChangeSignaller ch (this, Property::AUDIO_CHANNELS);
1155 _audio_channels = c;
1159 Film::set_three_d (bool t)
1161 FilmChangeSignaller ch (this, Property::THREE_D);
1164 if (_three_d && _two_d_version_of_three_d) {
1165 set_two_d_version_of_three_d (false);
1170 Film::set_interop (bool i)
1172 FilmChangeSignaller ch (this, Property::INTEROP);
1177 Film::set_audio_processor (AudioProcessor const * processor)
1179 FilmChangeSignaller ch1 (this, Property::AUDIO_PROCESSOR);
1180 FilmChangeSignaller ch2 (this, Property::AUDIO_CHANNELS);
1181 _audio_processor = processor;
1185 Film::set_reel_type (ReelType t)
1187 FilmChangeSignaller ch (this, Property::REEL_TYPE);
1191 /** @param r Desired reel length in bytes */
1193 Film::set_reel_length (int64_t r)
1195 FilmChangeSignaller ch (this, Property::REEL_LENGTH);
1200 Film::set_reencode_j2k (bool r)
1202 FilmChangeSignaller ch (this, Property::REENCODE_J2K);
1207 Film::signal_change (ChangeType type, int p)
1209 signal_change (type, static_cast<Property>(p));
1213 Film::signal_change (ChangeType type, Property p)
1215 if (type == ChangeType::DONE) {
1218 if (p == Property::CONTENT) {
1219 if (!_user_explicit_video_frame_rate) {
1220 set_video_frame_rate (best_video_frame_rate());
1224 emit (boost::bind (boost::ref (Change), type, p));
1226 if (p == Property::VIDEO_FRAME_RATE || p == Property::SEQUENCE) {
1227 /* We want to call Playlist::maybe_sequence but this must happen after the
1228 main signal emission (since the butler will see that emission and un-suspend itself).
1230 emit (boost::bind(&Playlist::maybe_sequence, _playlist.get(), shared_from_this()));
1238 Film::set_isdcf_date_today ()
1240 _isdcf_date = boost::gregorian::day_clock::local_day ();
1243 boost::filesystem::path
1244 Film::j2c_path (int reel, Frame frame, Eyes eyes, bool tmp) const
1246 boost::filesystem::path p;
1248 p /= video_identifier ();
1251 snprintf(buffer, sizeof(buffer), "%08d_%08" PRId64, reel, frame);
1254 if (eyes == Eyes::LEFT) {
1256 } else if (eyes == Eyes::RIGHT) {
1272 cpl_summary_compare (CPLSummary const & a, CPLSummary const & b)
1274 return a.last_write_time > b.last_write_time;
1277 /** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs.
1278 * The list will be returned in reverse order of timestamp (i.e. most recent first).
1283 if (!directory ()) {
1284 return vector<CPLSummary> ();
1287 vector<CPLSummary> out;
1289 auto const dir = directory().get();
1290 for (auto i: boost::filesystem::directory_iterator(dir)) {
1292 boost::filesystem::is_directory (i) &&
1293 i.path().leaf() != "j2c" && i.path().leaf() != "video" && i.path().leaf() != "info" && i.path().leaf() != "analysis"
1297 out.push_back (CPLSummary(i));
1304 sort (out.begin(), out.end(), cpl_summary_compare);
1310 Film::set_encrypted (bool e)
1312 FilmChangeSignaller ch (this, Property::ENCRYPTED);
1317 Film::content () const
1319 return _playlist->content ();
1322 /** @param content Content to add.
1323 * @param disable_audio_analysis true to never do automatic audio analysis, even if it is enabled in configuration.
1326 Film::examine_and_add_content (shared_ptr<Content> content, bool disable_audio_analysis)
1328 if (dynamic_pointer_cast<FFmpegContent> (content) && _directory) {
1329 run_ffprobe (content->path(0), file("ffprobe.log"));
1332 auto j = make_shared<ExamineContentJob>(shared_from_this(), content);
1334 _job_connections.push_back (
1335 j->Finished.connect (bind (&Film::maybe_add_content, this, weak_ptr<Job>(j), weak_ptr<Content>(content), disable_audio_analysis))
1338 JobManager::instance()->add (j);
1342 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c, bool disable_audio_analysis)
1344 auto job = j.lock ();
1345 if (!job || !job->finished_ok ()) {
1349 auto content = c.lock ();
1354 add_content (content);
1356 if (Config::instance()->automatic_audio_analysis() && content->audio && !disable_audio_analysis) {
1357 auto playlist = make_shared<Playlist>();
1358 playlist->add (shared_from_this(), content);
1359 boost::signals2::connection c;
1360 JobManager::instance()->analyse_audio (
1361 shared_from_this(), playlist, false, c, bind (&Film::audio_analysis_finished, this)
1363 _audio_analysis_connections.push_back (c);
1368 Film::add_content (shared_ptr<Content> c)
1370 /* Add {video,subtitle} content after any existing {video,subtitle} content */
1372 c->set_position (shared_from_this(), _playlist->video_end(shared_from_this()));
1373 } else if (!c->text.empty()) {
1374 c->set_position (shared_from_this(), _playlist->text_end(shared_from_this()));
1377 if (_template_film) {
1378 /* Take settings from the first piece of content of c's type in _template */
1379 for (auto i: _template_film->content()) {
1380 c->take_settings_from (i);
1384 _playlist->add (shared_from_this(), c);
1386 maybe_set_container_and_resolution ();
1388 set_audio_channels (14);
1389 set_interop (false);
1395 Film::maybe_set_container_and_resolution ()
1397 /* Get the only piece of video content, if there is only one */
1398 shared_ptr<VideoContent> video;
1399 for (auto i: _playlist->content()) {
1410 /* This is the only piece of video content in this Film. Use it to make a guess for
1411 * DCP container size and resolution, unless the user has already explicitly set these
1414 if (!_user_explicit_container) {
1415 if (video->size().ratio() > 2.3) {
1416 set_container (Ratio::from_id("239"), false);
1418 set_container (Ratio::from_id("185"), false);
1422 if (!_user_explicit_resolution) {
1423 if (video->size_after_crop().width > 2048 || video->size_after_crop().height > 1080) {
1424 set_resolution (Resolution::FOUR_K, false);
1426 set_resolution (Resolution::TWO_K, false);
1433 Film::remove_content (shared_ptr<Content> c)
1435 _playlist->remove (c);
1436 maybe_set_container_and_resolution ();
1440 Film::move_content_earlier (shared_ptr<Content> c)
1442 _playlist->move_earlier (shared_from_this(), c);
1446 Film::move_content_later (shared_ptr<Content> c)
1448 _playlist->move_later (shared_from_this(), c);
1451 /** @return length of the film from time 0 to the last thing on the playlist,
1452 * with a minimum length of 1 second.
1455 Film::length () const
1457 return max(DCPTime::from_seconds(1), _playlist->length(shared_from_this()).ceil(video_frame_rate()));
1461 Film::best_video_frame_rate () const
1463 /* Don't default to anything above 30fps (make the user select that explicitly) */
1464 auto best = _playlist->best_video_frame_rate ();
1472 Film::active_frame_rate_change (DCPTime t) const
1474 return _playlist->active_frame_rate_change (t, video_frame_rate ());
1478 Film::playlist_content_change (ChangeType type, weak_ptr<Content> c, int p, bool frequent)
1480 if (p == ContentProperty::VIDEO_FRAME_RATE) {
1481 signal_change (type, Property::CONTENT);
1482 } else if (p == AudioContentProperty::STREAMS) {
1483 signal_change (type, Property::NAME);
1486 if (type == ChangeType::DONE) {
1487 emit (boost::bind (boost::ref (ContentChange), type, c, p, frequent));
1489 check_settings_consistency ();
1492 ContentChange (type, c, p, frequent);
1499 Film::playlist_length_change ()
1505 Film::playlist_change (ChangeType type)
1507 signal_change (type, Property::CONTENT);
1508 signal_change (type, Property::NAME);
1510 if (type == ChangeType::DONE) {
1511 check_settings_consistency ();
1517 /** Check for (and if necessary fix) impossible settings combinations, like
1518 * video set to being referenced when it can't be.
1521 Film::check_settings_consistency ()
1523 optional<int> atmos_rate;
1524 for (auto i: content()) {
1527 int rate = lrintf (i->atmos->edit_rate().as_float());
1528 if (atmos_rate && *atmos_rate != rate) {
1529 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."));
1530 } else if (!atmos_rate && rate != video_frame_rate()) {
1532 set_video_frame_rate (rate, false);
1533 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."));
1538 bool change_made = false;
1539 for (auto i: content()) {
1540 auto d = dynamic_pointer_cast<DCPContent>(i);
1546 if (d->reference_video() && !d->can_reference_video(shared_from_this(), why_not)) {
1547 d->set_reference_video(false);
1550 if (d->reference_audio() && !d->can_reference_audio(shared_from_this(), why_not)) {
1551 d->set_reference_audio(false);
1554 if (d->reference_text(TextType::OPEN_SUBTITLE) && !d->can_reference_text(shared_from_this(), TextType::OPEN_SUBTITLE, why_not)) {
1555 d->set_reference_text(TextType::OPEN_SUBTITLE, false);
1558 if (d->reference_text(TextType::CLOSED_CAPTION) && !d->can_reference_text(shared_from_this(), TextType::CLOSED_CAPTION, why_not)) {
1559 d->set_reference_text(TextType::CLOSED_CAPTION, false);
1565 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."));
1570 Film::playlist_order_changed ()
1572 /* XXX: missing PENDING */
1573 signal_change (ChangeType::DONE, Property::CONTENT_ORDER);
1577 Film::audio_frame_rate () const
1579 /* It seems that nobody makes 96kHz DCPs at the moment, so let's avoid them.
1586 Film::set_sequence (bool s)
1588 if (s == _sequence) {
1592 FilmChangeSignaller cc (this, Property::SEQUENCE);
1594 _playlist->set_sequence (s);
1597 /** @return Size of the largest possible image in whatever resolution we are using */
1599 Film::full_frame () const
1601 switch (_resolution) {
1602 case Resolution::TWO_K:
1603 return dcp::Size (2048, 1080);
1604 case Resolution::FOUR_K:
1605 return dcp::Size (4096, 2160);
1608 DCPOMATIC_ASSERT (false);
1609 return dcp::Size ();
1612 /** @return Size of the frame */
1614 Film::frame_size () const
1616 return fit_ratio_within (container()->ratio(), full_frame ());
1620 /** @return Area of Film::frame_size() that contains picture rather than pillar/letterboxing */
1622 Film::active_area () const
1624 auto const frame = frame_size ();
1627 for (auto i: content()) {
1629 dcp::Size s = i->video->scaled_size (frame);
1630 active.width = max(active.width, s.width);
1631 active.height = max(active.height, s.height);
1639 /** @param recipient KDM recipient certificate.
1640 * @param trusted_devices Certificate thumbprints of other trusted devices (can be empty).
1641 * @param cpl_file CPL filename.
1642 * @param from KDM from time expressed as a local time with an offset from UTC.
1643 * @param until KDM to time expressed as a local time with an offset from UTC.
1644 * @param formulation KDM formulation to use.
1645 * @param disable_forensic_marking_picture true to disable forensic marking of picture.
1646 * @param disable_forensic_marking_audio if not set, don't disable forensic marking of audio. If set to 0,
1647 * disable all forensic marking; if set above 0, disable forensic marking above that channel.
1651 dcp::Certificate recipient,
1652 vector<string> trusted_devices,
1653 boost::filesystem::path cpl_file,
1654 dcp::LocalTime from,
1655 dcp::LocalTime until,
1656 dcp::Formulation formulation,
1657 bool disable_forensic_marking_picture,
1658 optional<int> disable_forensic_marking_audio
1662 throw runtime_error (_("Cannot make a KDM as this project is not encrypted."));
1665 auto cpl = make_shared<dcp::CPL>(cpl_file);
1666 auto signer = Config::instance()->signer_chain();
1667 if (!signer->valid ()) {
1668 throw InvalidSignerError ();
1671 /* Find keys that have been added to imported, encrypted DCP content */
1672 list<dcp::DecryptedKDMKey> imported_keys;
1673 for (auto i: content()) {
1674 auto d = dynamic_pointer_cast<DCPContent> (i);
1675 if (d && d->kdm()) {
1676 dcp::DecryptedKDM kdm (d->kdm().get(), Config::instance()->decryption_chain()->key().get());
1677 auto keys = kdm.keys ();
1678 copy (keys.begin(), keys.end(), back_inserter (imported_keys));
1682 map<shared_ptr<const dcp::ReelFileAsset>, dcp::Key> keys;
1684 for (auto i: cpl->reel_file_assets()) {
1685 if (!i->encrypted()) {
1689 /* Get any imported key for this ID */
1691 for (auto j: imported_keys) {
1692 if (j.id() == i->key_id().get()) {
1693 LOG_GENERAL ("Using imported key for %1", i->key_id().get());
1700 /* No imported key; it must be an asset that we encrypted */
1701 LOG_GENERAL ("Using our own key for %1", i->key_id().get());
1706 return dcp::DecryptedKDM (
1707 cpl->id(), keys, from, until, cpl->content_title_text(), cpl->content_title_text(), dcp::LocalTime().as_string()
1708 ).encrypt (signer, recipient, trusted_devices, formulation, disable_forensic_marking_picture, disable_forensic_marking_audio);
1712 /** @return The approximate disk space required to encode a DCP of this film with the
1713 * current settings, in bytes.
1716 Film::required_disk_space () const
1718 return _playlist->required_disk_space (shared_from_this(), j2k_bandwidth(), audio_channels(), audio_frame_rate());
1721 /** This method checks the disk that the Film is on and tries to decide whether or not
1722 * there will be enough space to make a DCP for it. If so, true is returned; if not,
1723 * false is returned and required and available are filled in with the amount of disk space
1724 * required and available respectively (in GB).
1726 * Note: the decision made by this method isn't, of course, 100% reliable.
1729 Film::should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const
1731 /* Create a test file and see if we can hard-link it */
1732 boost::filesystem::path test = internal_video_asset_dir() / "test";
1733 boost::filesystem::path test2 = internal_video_asset_dir() / "test2";
1734 can_hard_link = true;
1735 auto f = fopen_boost (test, "w");
1738 boost::system::error_code ec;
1739 boost::filesystem::create_hard_link (test, test2, ec);
1741 can_hard_link = false;
1743 boost::filesystem::remove (test);
1744 boost::filesystem::remove (test2);
1747 auto s = boost::filesystem::space (internal_video_asset_dir ());
1748 required = double (required_disk_space ()) / 1073741824.0f;
1749 if (!can_hard_link) {
1752 available = double (s.available) / 1073741824.0f;
1753 return (available - required) > 1;
1756 /** @return The names of the channels that audio contents' outputs are passed into;
1757 * this is either the DCP or a AudioProcessor.
1759 vector<NamedChannel>
1760 Film::audio_output_names () const
1762 if (audio_processor ()) {
1763 return audio_processor()->input_names ();
1766 DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
1768 vector<NamedChannel> n;
1770 for (int i = 0; i < audio_channels(); ++i) {
1771 if (i != 8 && i != 9 && i != 15) {
1772 n.push_back (NamedChannel(short_audio_channel_name(i), i));
1780 Film::repeat_content (ContentList c, int n)
1782 _playlist->repeat (shared_from_this(), c, n);
1786 Film::remove_content (ContentList c)
1788 _playlist->remove (c);
1792 Film::audio_analysis_finished ()
1798 Film::reels () const
1800 list<DCPTimePeriod> p;
1801 auto const len = length();
1803 switch (reel_type ()) {
1804 case ReelType::SINGLE:
1805 p.push_back (DCPTimePeriod (DCPTime (), len));
1807 case ReelType::BY_VIDEO_CONTENT:
1809 /* Collect all reel boundaries */
1810 list<DCPTime> split_points;
1811 split_points.push_back (DCPTime());
1812 split_points.push_back (len);
1813 for (auto c: content()) {
1815 for (auto t: c->reel_split_points(shared_from_this())) {
1816 split_points.push_back (t);
1818 split_points.push_back (c->end(shared_from_this()));
1822 split_points.sort ();
1823 split_points.unique ();
1825 /* Make them into periods, coalescing any that are less than 1 second long */
1826 optional<DCPTime> last;
1827 for (auto t: split_points) {
1828 if (last && (t - *last) >= DCPTime::from_seconds(1)) {
1829 /* Period from *last to t is long enough; use it and start a new one */
1830 p.push_back (DCPTimePeriod(*last, t));
1833 /* That was the first time, so start a new period */
1839 p.back().to = split_points.back();
1843 case ReelType::BY_LENGTH:
1846 /* Integer-divide reel length by the size of one frame to give the number of frames per reel,
1847 * making sure we don't go less than 1s long.
1849 Frame const reel_in_frames = max(_reel_length / ((j2k_bandwidth() / video_frame_rate()) / 8), static_cast<Frame>(video_frame_rate()));
1850 while (current < len) {
1851 DCPTime end = min (len, current + DCPTime::from_frames (reel_in_frames, video_frame_rate ()));
1852 p.push_back (DCPTimePeriod (current, end));
1862 /** @param period A period within the DCP
1863 * @return Name of the content which most contributes to the given period.
1866 Film::content_summary (DCPTimePeriod period) const
1868 return _playlist->content_summary (shared_from_this(), period);
1872 Film::use_template (string name)
1874 _template_film.reset (new Film (optional<boost::filesystem::path>()));
1875 _template_film->read_metadata (Config::instance()->template_path (name));
1876 _use_isdcf_name = _template_film->_use_isdcf_name;
1877 _dcp_content_type = _template_film->_dcp_content_type;
1878 _container = _template_film->_container;
1879 _resolution = _template_film->_resolution;
1880 _j2k_bandwidth = _template_film->_j2k_bandwidth;
1881 _video_frame_rate = _template_film->_video_frame_rate;
1882 _encrypted = _template_film->_encrypted;
1883 _audio_channels = _template_film->_audio_channels;
1884 _sequence = _template_film->_sequence;
1885 _three_d = _template_film->_three_d;
1886 _interop = _template_film->_interop;
1887 _audio_processor = _template_film->_audio_processor;
1888 _reel_type = _template_film->_reel_type;
1889 _reel_length = _template_film->_reel_length;
1892 pair<double, double>
1893 Film::speed_up_range (int dcp_frame_rate) const
1895 return _playlist->speed_up_range (dcp_frame_rate);
1899 Film::copy_from (shared_ptr<const Film> film)
1901 read_metadata (film->file (metadata_file));
1905 Film::references_dcp_video () const
1907 for (auto i: _playlist->content()) {
1908 auto d = dynamic_pointer_cast<DCPContent>(i);
1909 if (d && d->reference_video()) {
1918 Film::references_dcp_audio () const
1920 for (auto i: _playlist->content()) {
1921 auto d = dynamic_pointer_cast<DCPContent>(i);
1922 if (d && d->reference_audio()) {
1932 Film::contains_atmos_content () const
1934 for (auto i: _playlist->content()) {
1945 Film::closed_caption_tracks () const
1947 list<DCPTextTrack> tt;
1948 for (auto i: content()) {
1949 for (auto j: i->text) {
1950 /* XXX: Empty DCPTextTrack ends up being a magic value here - the "unknown" or "not specified" track */
1951 auto dtt = j->dcp_track().get_value_or(DCPTextTrack());
1952 if (j->type() == TextType::CLOSED_CAPTION && find(tt.begin(), tt.end(), dtt) == tt.end()) {
1962 Film::set_marker (dcp::Marker type, DCPTime time)
1964 FilmChangeSignaller ch (this, Property::MARKERS);
1965 _markers[type] = time;
1970 Film::unset_marker (dcp::Marker type)
1972 FilmChangeSignaller ch (this, Property::MARKERS);
1973 _markers.erase (type);
1978 Film::clear_markers ()
1980 FilmChangeSignaller ch (this, Property::MARKERS);
1986 Film::set_ratings (vector<dcp::Rating> r)
1988 FilmChangeSignaller ch (this, Property::RATINGS);
1993 Film::set_content_versions (vector<string> v)
1995 FilmChangeSignaller ch (this, Property::CONTENT_VERSIONS);
1996 _content_versions = v;
2001 Film::set_name_language (dcp::LanguageTag lang)
2003 FilmChangeSignaller ch (this, Property::NAME_LANGUAGE);
2004 _name_language = lang;
2009 Film::set_release_territory (optional<dcp::LanguageTag::RegionSubtag> region)
2011 FilmChangeSignaller ch (this, Property::RELEASE_TERRITORY);
2012 _release_territory = region;
2017 Film::set_status (dcp::Status s)
2019 FilmChangeSignaller ch (this, Property::STATUS);
2025 Film::set_version_number (int v)
2027 FilmChangeSignaller ch (this, Property::VERSION_NUMBER);
2028 _version_number = v;
2033 Film::set_chain (optional<string> c)
2035 FilmChangeSignaller ch (this, Property::CHAIN);
2041 Film::set_distributor (optional<string> d)
2043 FilmChangeSignaller ch (this, Property::DISTRIBUTOR);
2049 Film::set_luminance (optional<dcp::Luminance> l)
2051 FilmChangeSignaller ch (this, Property::LUMINANCE);
2057 Film::set_facility (optional<string> f)
2059 FilmChangeSignaller ch (this, Property::FACILITY);
2065 Film::set_studio (optional<string> s)
2067 FilmChangeSignaller ch (this, Property::STUDIO);
2073 Film::marker (dcp::Marker type) const
2075 auto i = _markers.find (type);
2076 if (i == _markers.end()) {
2082 shared_ptr<InfoFileHandle>
2083 Film::info_file_handle (DCPTimePeriod period, bool read) const
2085 return std::make_shared<InfoFileHandle>(_info_file_mutex, info_file(period), read);
2088 InfoFileHandle::InfoFileHandle (boost::mutex& mutex, boost::filesystem::path file, bool read)
2093 _handle = fopen_boost (file, "rb");
2095 throw OpenFileError (file, errno, OpenFileError::READ);
2098 auto const exists = boost::filesystem::exists (file);
2100 _handle = fopen_boost (file, "r+b");
2102 _handle = fopen_boost (file, "wb");
2106 throw OpenFileError (file, errno, exists ? OpenFileError::READ_WRITE : OpenFileError::WRITE);
2111 InfoFileHandle::~InfoFileHandle ()
2117 /** Add FFOC and LFOC markers to a list if they are not already there */
2119 Film::add_ffoc_lfoc (Markers& markers) const
2121 if (markers.find(dcp::Marker::FFOC) == markers.end()) {
2122 markers[dcp::Marker::FFOC] = dcpomatic::DCPTime::from_frames(1, video_frame_rate());
2125 if (markers.find(dcp::Marker::LFOC) == markers.end()) {
2126 markers[dcp::Marker::LFOC] = length() - DCPTime::from_frames(1, video_frame_rate());
2132 Film::set_temp_version (bool t)
2134 FilmChangeSignaller ch (this, Property::TEMP_VERSION);
2140 Film::set_pre_release (bool p)
2142 FilmChangeSignaller ch (this, Property::PRE_RELEASE);
2148 Film::set_red_band (bool r)
2150 FilmChangeSignaller ch (this, Property::RED_BAND);
2156 Film::set_two_d_version_of_three_d (bool t)
2158 FilmChangeSignaller ch (this, Property::TWO_D_VERSION_OF_THREE_D);
2159 _two_d_version_of_three_d = t;
2164 Film::set_audio_language (optional<dcp::LanguageTag> language)
2166 FilmChangeSignaller ch (this, Property::AUDIO_LANGUAGE);
2167 _audio_language = language;
2172 Film::has_sign_language_video_channel () const
2174 return _audio_channels >= static_cast<int>(dcp::Channel::SIGN_LANGUAGE);
2179 Film::set_sign_language_video_language (optional<dcp::LanguageTag> lang)
2181 FilmChangeSignaller ch (this, Property::SIGN_LANGUAGE_VIDEO_LANGUAGE);
2182 _sign_language_video_language = lang;