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();
277 /** @return The file to write video frame info to */
278 boost::filesystem::path
279 Film::info_file (DCPTimePeriod period) const
281 boost::filesystem::path p;
283 p /= video_identifier () + "_" + raw_convert<string> (period.from.get()) + "_" + raw_convert<string> (period.to.get());
287 boost::filesystem::path
288 Film::internal_video_asset_dir () const
290 return dir ("video");
293 boost::filesystem::path
294 Film::internal_video_asset_filename (DCPTimePeriod p) const
296 return video_identifier() + "_" + raw_convert<string> (p.from.get()) + "_" + raw_convert<string> (p.to.get()) + ".mxf";
299 boost::filesystem::path
300 Film::audio_analysis_path (shared_ptr<const Playlist> playlist) const
302 auto p = dir ("analysis");
305 for (auto i: playlist->content()) {
310 digester.add (i->digest());
311 digester.add (i->audio->mapping().digest());
312 if (playlist->content().size() != 1) {
313 /* Analyses should be considered equal regardless of gain
314 if they were made from just one piece of content. This
315 is because we can fake any gain change in a single-content
316 analysis at the plotting stage rather than having to
319 digester.add (i->audio->gain());
321 /* Likewise we only care about position if we're looking at a
322 * whole-project view.
324 digester.add (i->position().get());
325 digester.add (i->trim_start().get());
326 digester.add (i->trim_end().get());
330 if (audio_processor ()) {
331 digester.add (audio_processor()->id ());
334 digester.add (audio_channels());
336 p /= digester.get ();
341 boost::filesystem::path
342 Film::subtitle_analysis_path (shared_ptr<const Content> content) const
344 auto p = dir ("analysis");
347 digester.add (content->digest());
349 if (!content->text.empty()) {
350 auto tc = content->text.front();
351 digester.add (tc->x_scale());
352 digester.add (tc->y_scale());
353 for (auto i: tc->fonts()) {
354 digester.add (i->id());
357 digester.add (tc->effect().get());
359 digester.add (tc->line_spacing());
360 digester.add (tc->outline_width());
363 auto fc = dynamic_pointer_cast<const FFmpegContent>(content);
365 digester.add (fc->subtitle_stream()->identifier());
368 p /= digester.get ();
373 /** Add suitable Jobs to the JobManager to create a DCP for this Film.
374 * @param gui true if this is being called from a GUI tool.
375 * @param check true to check the content in the project for changes before making the DCP.
378 Film::make_dcp (bool gui, bool check)
380 if (dcp_name().find ("/") != string::npos) {
381 throw BadSettingError (_("name"), _("Cannot contain slashes"));
384 if (container() == nullptr) {
385 throw MissingSettingError (_("container"));
388 if (content().empty()) {
389 throw runtime_error (_("You must add some content to the DCP before creating it"));
392 if (length() == DCPTime()) {
393 throw runtime_error (_("The DCP is empty, perhaps because all the content has zero length."));
396 if (dcp_content_type() == nullptr) {
397 throw MissingSettingError (_("content type"));
400 if (name().empty()) {
404 for (auto i: content ()) {
405 if (!i->paths_valid()) {
406 throw runtime_error (_("some of your content is missing"));
408 auto dcp = dynamic_pointer_cast<const DCPContent>(i);
409 if (dcp && dcp->needs_kdm()) {
410 throw runtime_error (_("Some of your content needs a KDM"));
412 if (dcp && dcp->needs_assets()) {
413 throw runtime_error (_("Some of your content needs an OV"));
417 set_isdcf_date_today ();
419 for (auto i: environment_info ()) {
423 for (auto i: content ()) {
424 LOG_GENERAL ("Content: %1", i->technical_summary());
426 LOG_GENERAL ("DCP video rate %1 fps", video_frame_rate());
427 if (Config::instance()->only_servers_encode ()) {
428 LOG_GENERAL_NC ("0 threads: ONLY SERVERS SET TO ENCODE");
430 LOG_GENERAL ("%1 threads", Config::instance()->master_encoding_threads());
432 LOG_GENERAL ("J2K bandwidth %1", j2k_bandwidth());
434 auto tj = make_shared<TranscodeJob>(shared_from_this());
435 tj->set_encoder (make_shared<DCPEncoder>(shared_from_this(), tj));
437 auto cc = make_shared<CheckContentChangeJob>(shared_from_this(), tj, gui);
438 JobManager::instance()->add (cc);
440 JobManager::instance()->add (tj);
444 /** Start a job to send our DCP to the configured TMS */
446 Film::send_dcp_to_tms ()
448 JobManager::instance()->add(make_shared<UploadJob>(shared_from_this()));
451 shared_ptr<xmlpp::Document>
452 Film::metadata (bool with_content_paths) const
454 auto doc = make_shared<xmlpp::Document>();
455 auto root = doc->create_root_node ("Metadata");
457 root->add_child("Version")->add_child_text (raw_convert<string> (current_state_version));
458 root->add_child("Name")->add_child_text (_name);
459 root->add_child("UseISDCFName")->add_child_text (_use_isdcf_name ? "1" : "0");
461 if (_dcp_content_type) {
462 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->isdcf_name ());
466 root->add_child("Container")->add_child_text (_container->id ());
469 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
470 root->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
471 root->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
472 root->add_child("ISDCFDate")->add_child_text (boost::gregorian::to_iso_string (_isdcf_date));
473 root->add_child("AudioChannels")->add_child_text (raw_convert<string> (_audio_channels));
474 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
475 root->add_child("Sequence")->add_child_text (_sequence ? "1" : "0");
476 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
477 root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
478 root->add_child("Key")->add_child_text (_key.hex ());
479 root->add_child("ContextID")->add_child_text (_context_id);
480 if (_audio_processor) {
481 root->add_child("AudioProcessor")->add_child_text (_audio_processor->id ());
483 root->add_child("ReelType")->add_child_text (raw_convert<string> (static_cast<int> (_reel_type)));
484 root->add_child("ReelLength")->add_child_text (raw_convert<string> (_reel_length));
485 root->add_child("ReencodeJ2K")->add_child_text (_reencode_j2k ? "1" : "0");
486 root->add_child("UserExplicitVideoFrameRate")->add_child_text(_user_explicit_video_frame_rate ? "1" : "0");
487 for (map<dcp::Marker, DCPTime>::const_iterator i = _markers.begin(); i != _markers.end(); ++i) {
488 auto m = root->add_child("Marker");
489 m->set_attribute("Type", dcp::marker_to_string(i->first));
490 m->add_child_text(raw_convert<string>(i->second.get()));
492 for (auto i: _ratings) {
493 i.as_xml (root->add_child("Rating"));
495 for (auto i: _content_versions) {
496 root->add_child("ContentVersion")->add_child_text(i);
498 root->add_child("NameLanguage")->add_child_text(_name_language.to_string());
499 if (_release_territory) {
500 root->add_child("ReleaseTerritory")->add_child_text(_release_territory->subtag());
502 if (_sign_language_video_language) {
503 root->add_child("SignLanguageVideoLanguage")->add_child_text(_sign_language_video_language->to_string());
505 root->add_child("VersionNumber")->add_child_text(raw_convert<string>(_version_number));
506 root->add_child("Status")->add_child_text(dcp::status_to_string(_status));
508 root->add_child("Chain")->add_child_text(*_chain);
511 root->add_child("Distributor")->add_child_text(*_distributor);
514 root->add_child("Facility")->add_child_text(*_facility);
517 root->add_child("Studio")->add_child_text(*_studio);
519 root->add_child("TempVersion")->add_child_text(_temp_version ? "1" : "0");
520 root->add_child("PreRelease")->add_child_text(_pre_release ? "1" : "0");
521 root->add_child("RedBand")->add_child_text(_red_band ? "1" : "0");
522 root->add_child("TwoDVersionOfThreeD")->add_child_text(_two_d_version_of_three_d ? "1" : "0");
524 root->add_child("LuminanceValue")->add_child_text(raw_convert<string>(_luminance->value()));
525 root->add_child("LuminanceUnit")->add_child_text(dcp::Luminance::unit_to_string(_luminance->unit()));
527 root->add_child("UserExplicitContainer")->add_child_text(_user_explicit_container ? "1" : "0");
528 root->add_child("UserExplicitResolution")->add_child_text(_user_explicit_resolution ? "1" : "0");
529 if (_audio_language) {
530 root->add_child("AudioLanguage")->add_child_text(_audio_language->to_string());
532 _playlist->as_xml (root->add_child ("Playlist"), with_content_paths);
538 Film::write_metadata (boost::filesystem::path path) const
540 metadata()->write_to_file_formatted(path.string());
543 /** Write state to our `metadata' file */
545 Film::write_metadata () const
547 DCPOMATIC_ASSERT (directory());
548 boost::filesystem::create_directories (directory().get());
549 metadata()->write_to_file_formatted(file(metadata_file).string());
553 /** Write a template from this film */
555 Film::write_template (boost::filesystem::path path) const
557 boost::filesystem::create_directories (path.parent_path());
558 shared_ptr<xmlpp::Document> doc = metadata (false);
559 metadata(false)->write_to_file_formatted(path.string());
562 /** Read state from our metadata file.
563 * @return Notes about things that the user should know about, or empty.
566 Film::read_metadata (optional<boost::filesystem::path> path)
569 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file (metadata_file))) {
570 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!"));
573 path = file (metadata_file);
576 if (!boost::filesystem::exists(*path)) {
577 throw FileNotFoundError(*path);
580 cxml::Document f ("Metadata");
581 f.read_file (path.get ());
583 _state_version = f.number_child<int> ("Version");
584 if (_state_version > current_state_version) {
585 throw runtime_error (_("This film was created with a newer version of DCP-o-matic, and it cannot be loaded into this version. Sorry!"));
586 } else if (_state_version < current_state_version) {
587 /* This is an older version; save a copy (if we haven't already) */
588 auto const older = path->parent_path() / String::compose("metadata.%1.xml", _state_version);
589 if (!boost::filesystem::is_regular_file(older)) {
591 boost::filesystem::copy_file(*path, older);
593 /* Never mind; at least we tried */
598 _name = f.string_child ("Name");
599 if (_state_version >= 9) {
600 _use_isdcf_name = f.bool_child ("UseISDCFName");
601 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("ISDCFDate"));
603 _use_isdcf_name = f.bool_child ("UseDCIName");
604 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
609 auto c = f.optional_string_child("DCPContentType");
611 _dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
616 auto c = f.optional_string_child("Container");
618 _container = Ratio::from_id (c.get ());
622 _resolution = string_to_resolution (f.string_child ("Resolution"));
623 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
624 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
625 _encrypted = f.bool_child ("Encrypted");
626 _audio_channels = f.number_child<int> ("AudioChannels");
627 /* We used to allow odd numbers (and zero) channels, but it's just not worth
630 if (_audio_channels == 0) {
632 } else if ((_audio_channels % 2) == 1) {
636 if (f.optional_bool_child("SequenceVideo")) {
637 _sequence = f.bool_child("SequenceVideo");
639 _sequence = f.bool_child("Sequence");
642 _three_d = f.bool_child ("ThreeD");
643 _interop = f.bool_child ("Interop");
644 _key = dcp::Key (f.string_child ("Key"));
645 _context_id = f.optional_string_child("ContextID").get_value_or (dcp::make_uuid ());
647 if (f.optional_string_child ("AudioProcessor")) {
648 _audio_processor = AudioProcessor::from_id (f.string_child ("AudioProcessor"));
650 _audio_processor = 0;
653 if (_audio_processor && !Config::instance()->show_experimental_audio_processors()) {
654 auto ap = AudioProcessor::visible();
655 if (find(ap.begin(), ap.end(), _audio_processor) == ap.end()) {
656 Config::instance()->set_show_experimental_audio_processors(true);
660 _reel_type = static_cast<ReelType> (f.optional_number_child<int>("ReelType").get_value_or (static_cast<int>(ReelType::SINGLE)));
661 _reel_length = f.optional_number_child<int64_t>("ReelLength").get_value_or (2000000000);
662 _reencode_j2k = f.optional_bool_child("ReencodeJ2K").get_value_or(false);
663 _user_explicit_video_frame_rate = f.optional_bool_child("UserExplicitVideoFrameRate").get_value_or(false);
665 for (auto i: f.node_children("Marker")) {
666 _markers[dcp::marker_from_string(i->string_attribute("Type"))] = DCPTime(dcp::raw_convert<DCPTime::Type>(i->content()));
669 for (auto i: f.node_children("Rating")) {
670 _ratings.push_back (dcp::Rating(i));
673 for (auto i: f.node_children("ContentVersion")) {
674 _content_versions.push_back (i->content());
677 auto name_language = f.optional_string_child("NameLanguage");
679 _name_language = dcp::LanguageTag (*name_language);
681 auto release_territory = f.optional_string_child("ReleaseTerritory");
682 if (release_territory) {
683 _release_territory = dcp::LanguageTag::RegionSubtag (*release_territory);
686 auto sign_language_video_language = f.optional_string_child("SignLanguageVideoLanguage");
687 if (sign_language_video_language) {
688 _sign_language_video_language = dcp::LanguageTag(*sign_language_video_language);
691 _version_number = f.optional_number_child<int>("VersionNumber").get_value_or(0);
693 auto status = f.optional_string_child("Status");
695 _status = dcp::string_to_status (*status);
698 _chain = f.optional_string_child("Chain");
699 _distributor = f.optional_string_child("Distributor");
700 _facility = f.optional_string_child("Facility");
701 _studio = f.optional_string_child("Studio");
702 _temp_version = f.optional_bool_child("TempVersion").get_value_or(false);
703 _pre_release = f.optional_bool_child("PreRelease").get_value_or(false);
704 _red_band = f.optional_bool_child("RedBand").get_value_or(false);
705 _two_d_version_of_three_d = f.optional_bool_child("TwoDVersionOfThreeD").get_value_or(false);
707 auto value = f.optional_number_child<float>("LuminanceValue");
708 auto unit = f.optional_string_child("LuminanceUnit");
710 _luminance = dcp::Luminance (*value, dcp::Luminance::string_to_unit(*unit));
713 /* Disable guessing for files made in previous DCP-o-matic versions */
714 _user_explicit_container = f.optional_bool_child("UserExplicitContainer").get_value_or(true);
715 _user_explicit_resolution = f.optional_bool_child("UserExplicitResolution").get_value_or(true);
717 auto audio_language = f.optional_string_child("AudioLanguage");
718 if (audio_language) {
719 _audio_language = dcp::LanguageTag(*audio_language);
723 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
725 /* Write backtraces to this film's directory, until another film is loaded */
727 set_backtrace_file (file ("backtrace.txt"));
734 /** Given a directory name, return its full path within the Film's directory.
735 * @param d directory name within the Film's directory.
736 * @param create true to create the directory (and its parents) if they do not exist.
738 boost::filesystem::path
739 Film::dir (boost::filesystem::path d, bool create) const
741 DCPOMATIC_ASSERT (_directory);
743 boost::filesystem::path p;
744 p /= _directory.get();
748 boost::filesystem::create_directories (p);
754 /** Given a file or directory name, return its full path within the Film's directory.
755 * Any required parent directories will be created.
757 boost::filesystem::path
758 Film::file (boost::filesystem::path f) const
760 DCPOMATIC_ASSERT (_directory);
762 boost::filesystem::path p;
763 p /= _directory.get();
766 boost::filesystem::create_directories (p.parent_path ());
772 Film::mapped_audio_channels () const
776 if (audio_processor ()) {
777 /* Processors are mapped 1:1 to DCP outputs so we can work out mappings from there */
778 for (int i = 0; i < audio_processor()->out_channels(); ++i) {
779 mapped.push_back (i);
782 for (auto i: content()) {
784 auto c = i->audio->mapping().mapped_output_channels();
785 copy (c.begin(), c.end(), back_inserter(mapped));
797 pair<optional<dcp::LanguageTag>, vector<dcp::LanguageTag>>
798 Film::subtitle_languages () const
800 pair<optional<dcp::LanguageTag>, vector<dcp::LanguageTag>> result;
801 for (auto i: content()) {
802 for (auto j: i->text) {
803 if (j->use() && j->type() == TextType::OPEN_SUBTITLE && j->language()) {
804 if (j->language_is_additional()) {
805 result.second.push_back (j->language().get());
807 result.first = j->language().get();
811 if (i->video && i->video->burnt_subtitle_language()) {
812 result.first = i->video->burnt_subtitle_language();
816 std::sort (result.second.begin(), result.second.end());
817 auto last = std::unique (result.second.begin(), result.second.end());
818 result.second.erase (last, result.second.end());
823 /** @return a ISDCF-compliant name for a DCP of this film */
825 Film::isdcf_name (bool if_created_now) const
829 auto raw_name = name ();
831 /* Split the raw name up into words */
832 vector<string> words;
833 split (words, raw_name, is_any_of (" _-"));
837 /* Add each word to fixed_name */
838 for (auto i: words) {
841 /* First letter is always capitalised */
842 w[0] = toupper (w[0]);
844 /* Count caps in w */
846 for (size_t j = 0; j < w.size(); ++j) {
847 if (isupper (w[j])) {
852 /* If w is all caps make the rest of it lower case, otherwise
855 if (caps == w.size ()) {
856 for (size_t j = 1; j < w.size(); ++j) {
857 w[j] = tolower (w[j]);
861 for (size_t j = 0; j < w.size(); ++j) {
866 if (fixed_name.length() > 14) {
867 fixed_name = fixed_name.substr (0, 14);
872 if (dcp_content_type()) {
873 d += "_" + dcp_content_type()->isdcf_name();
874 string version = "1";
876 if (!_content_versions.empty()) {
877 auto cv = _content_versions[0];
878 if (!cv.empty() && std::all_of(cv.begin(), cv.end(), isdigit)) {
883 version = dcp::raw_convert<string>(_version_number);
900 if (_chain && !_chain->empty()) {
908 if (_two_d_version_of_three_d) {
913 auto fl = _luminance->value_in_foot_lamberts();
915 snprintf (buffer, sizeof(buffer), "%.1f", fl);
916 d += String::compose("-%1fl", buffer);
919 if (video_frame_rate() != 24) {
920 d += "-" + raw_convert<string>(video_frame_rate());
924 d += "_" + container()->isdcf_name();
927 /* XXX: this uses the first bit of content only */
929 /* Interior aspect ratio. The standard says we don't do this for trailers, for some strange reason */
930 if (dcp_content_type() && dcp_content_type()->libdcp_kind() != dcp::ContentKind::TRAILER) {
932 auto first_video = std::find_if(cl.begin(), cl.end(), [](shared_ptr<Content> c) { return static_cast<bool>(c->video); });
933 if (first_video != cl.end()) {
934 auto first_ratio = lrintf((*first_video)->video->scaled_size(frame_size()).ratio() * 100);
935 auto container_ratio = lrintf(container()->ratio() * 100);
936 if (first_ratio != container_ratio) {
937 d += "-" + dcp::raw_convert<string>(first_ratio);
942 auto audio_language = (_audio_language && _audio_language->language()) ? _audio_language->language()->subtag() : "XX";
944 d += "_" + to_upper (audio_language);
946 /* I'm not clear on the precise details of the convention for CCAP labelling;
947 for now I'm just appending -CCAP if we have any closed captions.
950 auto burnt_in = true;
952 for (auto i: content()) {
953 for (auto j: i->text) {
954 if (j->type() == TextType::OPEN_SUBTITLE && j->use() && !j->burn()) {
956 } else if (j->type() == TextType::CLOSED_CAPTION && j->use()) {
962 auto sub_langs = subtitle_languages();
963 if (sub_langs.first && sub_langs.first->language()) {
964 auto lang = sub_langs.first->language()->subtag();
966 transform (lang.begin(), lang.end(), lang.begin(), ::tolower);
968 lang = to_upper (lang);
980 if (_release_territory) {
981 auto territory = _release_territory->subtag();
982 d += "_" + to_upper (territory);
983 if (_ratings.empty ()) {
986 d += "-" + _ratings[0].label;
990 /* Count mapped audio channels */
992 auto mapped = mapped_audio_channels ();
994 auto ch = audio_channel_types (mapped, audio_channels());
995 if (!ch.first && !ch.second) {
997 } else if (ch.first) {
998 d += String::compose("_%1%2", ch.first, ch.second);
1001 if (audio_channels() > static_cast<int>(dcp::Channel::HI) && find(mapped.begin(), mapped.end(), static_cast<int>(dcp::Channel::HI)) != mapped.end()) {
1004 if (audio_channels() > static_cast<int>(dcp::Channel::VI) && find(mapped.begin(), mapped.end(), static_cast<int>(dcp::Channel::VI)) != mapped.end()) {
1008 d += "_" + resolution_to_string (_resolution);
1010 if (_studio && _studio->length() >= 2) {
1011 d += "_" + to_upper (_studio->substr(0, 4));
1014 if (if_created_now) {
1015 d += "_" + boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
1017 d += "_" + boost::gregorian::to_iso_string (_isdcf_date);
1020 if (_facility && _facility->length() >= 3) {
1021 d += "_" + to_upper(_facility->substr(0, 3));
1035 for (auto i: content()) {
1036 auto dc = dynamic_pointer_cast<const DCPContent>(i);
1041 bool any_text = false;
1042 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
1043 if (dc->reference_text(static_cast<TextType>(i))) {
1047 if (dc->reference_video() || dc->reference_audio() || any_text) {
1061 /** @return name to give the DCP */
1063 Film::dcp_name (bool if_created_now) const
1066 if (use_isdcf_name()) {
1067 return careful_string_filter (isdcf_name (if_created_now));
1070 return careful_string_filter (name ());
1074 Film::set_directory (boost::filesystem::path d)
1081 Film::set_name (string n)
1083 FilmChangeSignaller ch (this, Property::NAME);
1088 Film::set_use_isdcf_name (bool u)
1090 FilmChangeSignaller ch (this, Property::USE_ISDCF_NAME);
1091 _use_isdcf_name = u;
1095 Film::set_dcp_content_type (DCPContentType const * t)
1097 FilmChangeSignaller ch (this, Property::DCP_CONTENT_TYPE);
1098 _dcp_content_type = t;
1102 /** @param explicit_user true if this is being set because of
1103 * a direct user request, false if it is being done because
1104 * DCP-o-matic is guessing the best container to use.
1107 Film::set_container (Ratio const * c, bool explicit_user)
1109 FilmChangeSignaller ch (this, Property::CONTAINER);
1112 if (explicit_user) {
1113 _user_explicit_container = true;
1118 /** @param explicit_user true if this is being set because of
1119 * a direct user request, false if it is being done because
1120 * DCP-o-matic is guessing the best resolution to use.
1123 Film::set_resolution (Resolution r, bool explicit_user)
1125 FilmChangeSignaller ch (this, Property::RESOLUTION);
1128 if (explicit_user) {
1129 _user_explicit_resolution = true;
1135 Film::set_j2k_bandwidth (int b)
1137 FilmChangeSignaller ch (this, Property::J2K_BANDWIDTH);
1141 /** @param f New frame rate.
1142 * @param user_explicit true if this comes from a direct user instruction, false if it is from
1143 * DCP-o-matic being helpful.
1146 Film::set_video_frame_rate (int f, bool user_explicit)
1148 FilmChangeSignaller ch (this, Property::VIDEO_FRAME_RATE);
1149 _video_frame_rate = f;
1150 if (user_explicit) {
1151 _user_explicit_video_frame_rate = true;
1156 Film::set_audio_channels (int c)
1158 FilmChangeSignaller ch (this, Property::AUDIO_CHANNELS);
1159 _audio_channels = c;
1163 Film::set_three_d (bool t)
1165 FilmChangeSignaller ch (this, Property::THREE_D);
1168 if (_three_d && _two_d_version_of_three_d) {
1169 set_two_d_version_of_three_d (false);
1174 Film::set_interop (bool i)
1176 FilmChangeSignaller ch (this, Property::INTEROP);
1181 Film::set_audio_processor (AudioProcessor const * processor)
1183 FilmChangeSignaller ch1 (this, Property::AUDIO_PROCESSOR);
1184 FilmChangeSignaller ch2 (this, Property::AUDIO_CHANNELS);
1185 _audio_processor = processor;
1189 Film::set_reel_type (ReelType t)
1191 FilmChangeSignaller ch (this, Property::REEL_TYPE);
1195 /** @param r Desired reel length in bytes */
1197 Film::set_reel_length (int64_t r)
1199 FilmChangeSignaller ch (this, Property::REEL_LENGTH);
1204 Film::set_reencode_j2k (bool r)
1206 FilmChangeSignaller ch (this, Property::REENCODE_J2K);
1211 Film::signal_change (ChangeType type, int p)
1213 signal_change (type, static_cast<Property>(p));
1217 Film::signal_change (ChangeType type, Property p)
1219 if (type == ChangeType::DONE) {
1222 if (p == Property::CONTENT) {
1223 if (!_user_explicit_video_frame_rate) {
1224 set_video_frame_rate (best_video_frame_rate());
1228 emit (boost::bind (boost::ref (Change), type, p));
1230 if (p == Property::VIDEO_FRAME_RATE || p == Property::SEQUENCE) {
1231 /* We want to call Playlist::maybe_sequence but this must happen after the
1232 main signal emission (since the butler will see that emission and un-suspend itself).
1234 emit (boost::bind(&Playlist::maybe_sequence, _playlist.get(), shared_from_this()));
1242 Film::set_isdcf_date_today ()
1244 _isdcf_date = boost::gregorian::day_clock::local_day ();
1247 boost::filesystem::path
1248 Film::j2c_path (int reel, Frame frame, Eyes eyes, bool tmp) const
1250 boost::filesystem::path p;
1252 p /= video_identifier ();
1255 snprintf(buffer, sizeof(buffer), "%08d_%08" PRId64, reel, frame);
1258 if (eyes == Eyes::LEFT) {
1260 } else if (eyes == Eyes::RIGHT) {
1276 cpl_summary_compare (CPLSummary const & a, CPLSummary const & b)
1278 return a.last_write_time > b.last_write_time;
1281 /** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs.
1282 * The list will be returned in reverse order of timestamp (i.e. most recent first).
1287 if (!directory ()) {
1288 return vector<CPLSummary> ();
1291 vector<CPLSummary> out;
1293 auto const dir = directory().get();
1294 for (auto i: boost::filesystem::directory_iterator(dir)) {
1296 boost::filesystem::is_directory (i) &&
1297 i.path().leaf() != "j2c" && i.path().leaf() != "video" && i.path().leaf() != "info" && i.path().leaf() != "analysis"
1301 out.push_back (CPLSummary(i));
1308 sort (out.begin(), out.end(), cpl_summary_compare);
1314 Film::set_encrypted (bool e)
1316 FilmChangeSignaller ch (this, Property::ENCRYPTED);
1321 Film::content () const
1323 return _playlist->content ();
1326 /** @param content Content to add.
1327 * @param disable_audio_analysis true to never do automatic audio analysis, even if it is enabled in configuration.
1330 Film::examine_and_add_content (shared_ptr<Content> content, bool disable_audio_analysis)
1332 if (dynamic_pointer_cast<FFmpegContent> (content) && _directory) {
1333 run_ffprobe (content->path(0), file("ffprobe.log"));
1336 auto j = make_shared<ExamineContentJob>(shared_from_this(), content);
1338 _job_connections.push_back (
1339 j->Finished.connect (bind (&Film::maybe_add_content, this, weak_ptr<Job>(j), weak_ptr<Content>(content), disable_audio_analysis))
1342 JobManager::instance()->add (j);
1346 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c, bool disable_audio_analysis)
1348 auto job = j.lock ();
1349 if (!job || !job->finished_ok ()) {
1353 auto content = c.lock ();
1358 add_content (content);
1360 if (Config::instance()->automatic_audio_analysis() && content->audio && !disable_audio_analysis) {
1361 auto playlist = make_shared<Playlist>();
1362 playlist->add (shared_from_this(), content);
1363 boost::signals2::connection c;
1364 JobManager::instance()->analyse_audio (
1365 shared_from_this(), playlist, false, c, bind (&Film::audio_analysis_finished, this)
1367 _audio_analysis_connections.push_back (c);
1372 Film::add_content (shared_ptr<Content> c)
1374 /* Add {video,subtitle} content after any existing {video,subtitle} content */
1376 c->set_position (shared_from_this(), _playlist->video_end(shared_from_this()));
1377 } else if (!c->text.empty()) {
1378 c->set_position (shared_from_this(), _playlist->text_end(shared_from_this()));
1381 if (_template_film) {
1382 /* Take settings from the first piece of content of c's type in _template */
1383 for (auto i: _template_film->content()) {
1384 c->take_settings_from (i);
1388 _playlist->add (shared_from_this(), c);
1390 maybe_set_container_and_resolution ();
1392 set_audio_channels (14);
1393 set_interop (false);
1399 Film::maybe_set_container_and_resolution ()
1401 /* Get the only piece of video content, if there is only one */
1402 shared_ptr<VideoContent> video;
1403 for (auto i: _playlist->content()) {
1414 /* This is the only piece of video content in this Film. Use it to make a guess for
1415 * DCP container size and resolution, unless the user has already explicitly set these
1418 if (!_user_explicit_container) {
1419 if (video->size().ratio() > 2.3) {
1420 set_container (Ratio::from_id("239"), false);
1422 set_container (Ratio::from_id("185"), false);
1426 if (!_user_explicit_resolution) {
1427 if (video->size_after_crop().width > 2048 || video->size_after_crop().height > 1080) {
1428 set_resolution (Resolution::FOUR_K, false);
1430 set_resolution (Resolution::TWO_K, false);
1437 Film::remove_content (shared_ptr<Content> c)
1439 _playlist->remove (c);
1440 maybe_set_container_and_resolution ();
1444 Film::move_content_earlier (shared_ptr<Content> c)
1446 _playlist->move_earlier (shared_from_this(), c);
1450 Film::move_content_later (shared_ptr<Content> c)
1452 _playlist->move_later (shared_from_this(), c);
1455 /** @return length of the film from time 0 to the last thing on the playlist,
1456 * with a minimum length of 1 second.
1459 Film::length () const
1461 return max(DCPTime::from_seconds(1), _playlist->length(shared_from_this()).ceil(video_frame_rate()));
1465 Film::best_video_frame_rate () const
1467 /* Don't default to anything above 30fps (make the user select that explicitly) */
1468 auto best = _playlist->best_video_frame_rate ();
1476 Film::active_frame_rate_change (DCPTime t) const
1478 return _playlist->active_frame_rate_change (t, video_frame_rate ());
1482 Film::playlist_content_change (ChangeType type, weak_ptr<Content> c, int p, bool frequent)
1484 if (p == ContentProperty::VIDEO_FRAME_RATE) {
1485 signal_change (type, Property::CONTENT);
1486 } else if (p == AudioContentProperty::STREAMS) {
1487 signal_change (type, Property::NAME);
1490 if (type == ChangeType::DONE) {
1491 emit (boost::bind (boost::ref (ContentChange), type, c, p, frequent));
1493 check_settings_consistency ();
1496 ContentChange (type, c, p, frequent);
1503 Film::playlist_length_change ()
1509 Film::playlist_change (ChangeType type)
1511 signal_change (type, Property::CONTENT);
1512 signal_change (type, Property::NAME);
1514 if (type == ChangeType::DONE) {
1515 check_settings_consistency ();
1521 /** Check for (and if necessary fix) impossible settings combinations, like
1522 * video set to being referenced when it can't be.
1525 Film::check_settings_consistency ()
1527 optional<int> atmos_rate;
1528 for (auto i: content()) {
1531 int rate = lrintf (i->atmos->edit_rate().as_float());
1532 if (atmos_rate && *atmos_rate != rate) {
1533 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."));
1534 } else if (!atmos_rate && rate != video_frame_rate()) {
1536 set_video_frame_rate (rate, false);
1537 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."));
1542 bool change_made = false;
1543 for (auto i: content()) {
1544 auto d = dynamic_pointer_cast<DCPContent>(i);
1550 if (d->reference_video() && !d->can_reference_video(shared_from_this(), why_not)) {
1551 d->set_reference_video(false);
1554 if (d->reference_audio() && !d->can_reference_audio(shared_from_this(), why_not)) {
1555 d->set_reference_audio(false);
1558 if (d->reference_text(TextType::OPEN_SUBTITLE) && !d->can_reference_text(shared_from_this(), TextType::OPEN_SUBTITLE, why_not)) {
1559 d->set_reference_text(TextType::OPEN_SUBTITLE, false);
1562 if (d->reference_text(TextType::CLOSED_CAPTION) && !d->can_reference_text(shared_from_this(), TextType::CLOSED_CAPTION, why_not)) {
1563 d->set_reference_text(TextType::CLOSED_CAPTION, false);
1569 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."));
1574 Film::playlist_order_changed ()
1576 /* XXX: missing PENDING */
1577 signal_change (ChangeType::DONE, Property::CONTENT_ORDER);
1581 Film::audio_frame_rate () const
1583 /* It seems that nobody makes 96kHz DCPs at the moment, so let's avoid them.
1590 Film::set_sequence (bool s)
1592 if (s == _sequence) {
1596 FilmChangeSignaller cc (this, Property::SEQUENCE);
1598 _playlist->set_sequence (s);
1601 /** @return Size of the largest possible image in whatever resolution we are using */
1603 Film::full_frame () const
1605 switch (_resolution) {
1606 case Resolution::TWO_K:
1607 return dcp::Size (2048, 1080);
1608 case Resolution::FOUR_K:
1609 return dcp::Size (4096, 2160);
1612 DCPOMATIC_ASSERT (false);
1613 return dcp::Size ();
1616 /** @return Size of the frame */
1618 Film::frame_size () const
1620 return fit_ratio_within (container()->ratio(), full_frame ());
1624 /** @return Area of Film::frame_size() that contains picture rather than pillar/letterboxing */
1626 Film::active_area () const
1628 auto const frame = frame_size ();
1631 for (auto i: content()) {
1633 dcp::Size s = i->video->scaled_size (frame);
1634 active.width = max(active.width, s.width);
1635 active.height = max(active.height, s.height);
1643 /** @param recipient KDM recipient certificate.
1644 * @param trusted_devices Certificate thumbprints of other trusted devices (can be empty).
1645 * @param cpl_file CPL filename.
1646 * @param from KDM from time expressed as a local time with an offset from UTC.
1647 * @param until KDM to time expressed as a local time with an offset from UTC.
1648 * @param formulation KDM formulation to use.
1649 * @param disable_forensic_marking_picture true to disable forensic marking of picture.
1650 * @param disable_forensic_marking_audio if not set, don't disable forensic marking of audio. If set to 0,
1651 * disable all forensic marking; if set above 0, disable forensic marking above that channel.
1655 dcp::Certificate recipient,
1656 vector<string> trusted_devices,
1657 boost::filesystem::path cpl_file,
1658 dcp::LocalTime from,
1659 dcp::LocalTime until,
1660 dcp::Formulation formulation,
1661 bool disable_forensic_marking_picture,
1662 optional<int> disable_forensic_marking_audio
1666 throw runtime_error (_("Cannot make a KDM as this project is not encrypted."));
1669 auto cpl = make_shared<dcp::CPL>(cpl_file);
1670 auto signer = Config::instance()->signer_chain();
1671 if (!signer->valid ()) {
1672 throw InvalidSignerError ();
1675 /* Find keys that have been added to imported, encrypted DCP content */
1676 list<dcp::DecryptedKDMKey> imported_keys;
1677 for (auto i: content()) {
1678 auto d = dynamic_pointer_cast<DCPContent> (i);
1679 if (d && d->kdm()) {
1680 dcp::DecryptedKDM kdm (d->kdm().get(), Config::instance()->decryption_chain()->key().get());
1681 auto keys = kdm.keys ();
1682 copy (keys.begin(), keys.end(), back_inserter (imported_keys));
1686 map<shared_ptr<const dcp::ReelFileAsset>, dcp::Key> keys;
1688 for (auto i: cpl->reel_file_assets()) {
1689 if (!i->encrypted()) {
1693 /* Get any imported key for this ID */
1695 for (auto j: imported_keys) {
1696 if (j.id() == i->key_id().get()) {
1697 LOG_GENERAL ("Using imported key for %1", i->key_id().get());
1704 /* No imported key; it must be an asset that we encrypted */
1705 LOG_GENERAL ("Using our own key for %1", i->key_id().get());
1710 return dcp::DecryptedKDM (
1711 cpl->id(), keys, from, until, cpl->content_title_text(), cpl->content_title_text(), dcp::LocalTime().as_string()
1712 ).encrypt (signer, recipient, trusted_devices, formulation, disable_forensic_marking_picture, disable_forensic_marking_audio);
1716 /** @return The approximate disk space required to encode a DCP of this film with the
1717 * current settings, in bytes.
1720 Film::required_disk_space () const
1722 return _playlist->required_disk_space (shared_from_this(), j2k_bandwidth(), audio_channels(), audio_frame_rate());
1725 /** This method checks the disk that the Film is on and tries to decide whether or not
1726 * there will be enough space to make a DCP for it. If so, true is returned; if not,
1727 * false is returned and required and available are filled in with the amount of disk space
1728 * required and available respectively (in GB).
1730 * Note: the decision made by this method isn't, of course, 100% reliable.
1733 Film::should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const
1735 /* Create a test file and see if we can hard-link it */
1736 boost::filesystem::path test = internal_video_asset_dir() / "test";
1737 boost::filesystem::path test2 = internal_video_asset_dir() / "test2";
1738 can_hard_link = true;
1739 auto f = fopen_boost (test, "w");
1742 boost::system::error_code ec;
1743 boost::filesystem::create_hard_link (test, test2, ec);
1745 can_hard_link = false;
1747 boost::filesystem::remove (test);
1748 boost::filesystem::remove (test2);
1751 auto s = boost::filesystem::space (internal_video_asset_dir ());
1752 required = double (required_disk_space ()) / 1073741824.0f;
1753 if (!can_hard_link) {
1756 available = double (s.available) / 1073741824.0f;
1757 return (available - required) > 1;
1760 /** @return The names of the channels that audio contents' outputs are passed into;
1761 * this is either the DCP or a AudioProcessor.
1763 vector<NamedChannel>
1764 Film::audio_output_names () const
1766 if (audio_processor ()) {
1767 return audio_processor()->input_names ();
1770 DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
1772 vector<NamedChannel> n;
1774 for (int i = 0; i < audio_channels(); ++i) {
1775 if (i != 8 && i != 9 && i != 15) {
1776 n.push_back (NamedChannel(short_audio_channel_name(i), i));
1784 Film::repeat_content (ContentList c, int n)
1786 _playlist->repeat (shared_from_this(), c, n);
1790 Film::remove_content (ContentList c)
1792 _playlist->remove (c);
1796 Film::audio_analysis_finished ()
1802 Film::reels () const
1804 list<DCPTimePeriod> p;
1805 auto const len = length();
1807 switch (reel_type ()) {
1808 case ReelType::SINGLE:
1809 p.push_back (DCPTimePeriod (DCPTime (), len));
1811 case ReelType::BY_VIDEO_CONTENT:
1813 /* Collect all reel boundaries */
1814 list<DCPTime> split_points;
1815 split_points.push_back (DCPTime());
1816 split_points.push_back (len);
1817 for (auto c: content()) {
1819 for (auto t: c->reel_split_points(shared_from_this())) {
1820 split_points.push_back (t);
1822 split_points.push_back (c->end(shared_from_this()));
1826 split_points.sort ();
1827 split_points.unique ();
1829 /* Make them into periods, coalescing any that are less than 1 second long */
1830 optional<DCPTime> last;
1831 for (auto t: split_points) {
1832 if (last && (t - *last) >= DCPTime::from_seconds(1)) {
1833 /* Period from *last to t is long enough; use it and start a new one */
1834 p.push_back (DCPTimePeriod(*last, t));
1837 /* That was the first time, so start a new period */
1843 p.back().to = split_points.back();
1847 case ReelType::BY_LENGTH:
1850 /* Integer-divide reel length by the size of one frame to give the number of frames per reel,
1851 * making sure we don't go less than 1s long.
1853 Frame const reel_in_frames = max(_reel_length / ((j2k_bandwidth() / video_frame_rate()) / 8), static_cast<Frame>(video_frame_rate()));
1854 while (current < len) {
1855 DCPTime end = min (len, current + DCPTime::from_frames (reel_in_frames, video_frame_rate ()));
1856 p.push_back (DCPTimePeriod (current, end));
1866 /** @param period A period within the DCP
1867 * @return Name of the content which most contributes to the given period.
1870 Film::content_summary (DCPTimePeriod period) const
1872 return _playlist->content_summary (shared_from_this(), period);
1876 Film::use_template (string name)
1878 _template_film.reset (new Film (optional<boost::filesystem::path>()));
1879 _template_film->read_metadata (Config::instance()->template_path (name));
1880 _use_isdcf_name = _template_film->_use_isdcf_name;
1881 _dcp_content_type = _template_film->_dcp_content_type;
1882 _container = _template_film->_container;
1883 _resolution = _template_film->_resolution;
1884 _j2k_bandwidth = _template_film->_j2k_bandwidth;
1885 _video_frame_rate = _template_film->_video_frame_rate;
1886 _encrypted = _template_film->_encrypted;
1887 _audio_channels = _template_film->_audio_channels;
1888 _sequence = _template_film->_sequence;
1889 _three_d = _template_film->_three_d;
1890 _interop = _template_film->_interop;
1891 _audio_processor = _template_film->_audio_processor;
1892 _reel_type = _template_film->_reel_type;
1893 _reel_length = _template_film->_reel_length;
1896 pair<double, double>
1897 Film::speed_up_range (int dcp_frame_rate) const
1899 return _playlist->speed_up_range (dcp_frame_rate);
1903 Film::copy_from (shared_ptr<const Film> film)
1905 read_metadata (film->file (metadata_file));
1909 Film::references_dcp_video () const
1911 for (auto i: _playlist->content()) {
1912 auto d = dynamic_pointer_cast<DCPContent>(i);
1913 if (d && d->reference_video()) {
1922 Film::references_dcp_audio () const
1924 for (auto i: _playlist->content()) {
1925 auto d = dynamic_pointer_cast<DCPContent>(i);
1926 if (d && d->reference_audio()) {
1936 Film::contains_atmos_content () const
1938 for (auto i: _playlist->content()) {
1949 Film::closed_caption_tracks () const
1951 list<DCPTextTrack> tt;
1952 for (auto i: content()) {
1953 for (auto j: i->text) {
1954 /* XXX: Empty DCPTextTrack ends up being a magic value here - the "unknown" or "not specified" track */
1955 auto dtt = j->dcp_track().get_value_or(DCPTextTrack());
1956 if (j->type() == TextType::CLOSED_CAPTION && find(tt.begin(), tt.end(), dtt) == tt.end()) {
1966 Film::set_marker (dcp::Marker type, DCPTime time)
1968 FilmChangeSignaller ch (this, Property::MARKERS);
1969 _markers[type] = time;
1974 Film::unset_marker (dcp::Marker type)
1976 FilmChangeSignaller ch (this, Property::MARKERS);
1977 _markers.erase (type);
1982 Film::clear_markers ()
1984 FilmChangeSignaller ch (this, Property::MARKERS);
1990 Film::set_ratings (vector<dcp::Rating> r)
1992 FilmChangeSignaller ch (this, Property::RATINGS);
1997 Film::set_content_versions (vector<string> v)
1999 FilmChangeSignaller ch (this, Property::CONTENT_VERSIONS);
2000 _content_versions = v;
2005 Film::set_name_language (dcp::LanguageTag lang)
2007 FilmChangeSignaller ch (this, Property::NAME_LANGUAGE);
2008 _name_language = lang;
2013 Film::set_release_territory (optional<dcp::LanguageTag::RegionSubtag> region)
2015 FilmChangeSignaller ch (this, Property::RELEASE_TERRITORY);
2016 _release_territory = region;
2021 Film::set_status (dcp::Status s)
2023 FilmChangeSignaller ch (this, Property::STATUS);
2029 Film::set_version_number (int v)
2031 FilmChangeSignaller ch (this, Property::VERSION_NUMBER);
2032 _version_number = v;
2037 Film::set_chain (optional<string> c)
2039 FilmChangeSignaller ch (this, Property::CHAIN);
2045 Film::set_distributor (optional<string> d)
2047 FilmChangeSignaller ch (this, Property::DISTRIBUTOR);
2053 Film::set_luminance (optional<dcp::Luminance> l)
2055 FilmChangeSignaller ch (this, Property::LUMINANCE);
2061 Film::set_facility (optional<string> f)
2063 FilmChangeSignaller ch (this, Property::FACILITY);
2069 Film::set_studio (optional<string> s)
2071 FilmChangeSignaller ch (this, Property::STUDIO);
2077 Film::marker (dcp::Marker type) const
2079 auto i = _markers.find (type);
2080 if (i == _markers.end()) {
2086 shared_ptr<InfoFileHandle>
2087 Film::info_file_handle (DCPTimePeriod period, bool read) const
2089 return std::make_shared<InfoFileHandle>(_info_file_mutex, info_file(period), read);
2092 InfoFileHandle::InfoFileHandle (boost::mutex& mutex, boost::filesystem::path file, bool read)
2097 _handle = fopen_boost (file, "rb");
2099 throw OpenFileError (file, errno, OpenFileError::READ);
2102 auto const exists = boost::filesystem::exists (file);
2104 _handle = fopen_boost (file, "r+b");
2106 _handle = fopen_boost (file, "wb");
2110 throw OpenFileError (file, errno, exists ? OpenFileError::READ_WRITE : OpenFileError::WRITE);
2115 InfoFileHandle::~InfoFileHandle ()
2121 /** Add FFOC and LFOC markers to a list if they are not already there */
2123 Film::add_ffoc_lfoc (Markers& markers) const
2125 if (markers.find(dcp::Marker::FFOC) == markers.end()) {
2126 markers[dcp::Marker::FFOC] = dcpomatic::DCPTime::from_frames(1, video_frame_rate());
2129 if (markers.find(dcp::Marker::LFOC) == markers.end()) {
2130 markers[dcp::Marker::LFOC] = length() - DCPTime::from_frames(1, video_frame_rate());
2136 Film::set_temp_version (bool t)
2138 FilmChangeSignaller ch (this, Property::TEMP_VERSION);
2144 Film::set_pre_release (bool p)
2146 FilmChangeSignaller ch (this, Property::PRE_RELEASE);
2152 Film::set_red_band (bool r)
2154 FilmChangeSignaller ch (this, Property::RED_BAND);
2160 Film::set_two_d_version_of_three_d (bool t)
2162 FilmChangeSignaller ch (this, Property::TWO_D_VERSION_OF_THREE_D);
2163 _two_d_version_of_three_d = t;
2168 Film::set_audio_language (optional<dcp::LanguageTag> language)
2170 FilmChangeSignaller ch (this, Property::AUDIO_LANGUAGE);
2171 _audio_language = language;
2176 Film::has_sign_language_video_channel () const
2178 return _audio_channels >= static_cast<int>(dcp::Channel::SIGN_LANGUAGE);
2183 Film::set_sign_language_video_language (optional<dcp::LanguageTag> lang)
2185 FilmChangeSignaller ch (this, Property::SIGN_LANGUAGE_VIDEO_LANGUAGE);
2186 _sign_language_video_language = lang;