2 Copyright (C) 2012-2020 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_mxf.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/foreach.hpp>
73 #include <boost/regex.hpp>
94 using std::runtime_error;
96 using std::back_inserter;
100 using std::shared_ptr;
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_2K)
156 , _context_id (dcp::make_uuid ())
157 , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
158 , _isdcf_metadata (Config::instance()->default_isdcf_metadata ())
159 , _video_frame_rate (24)
160 , _audio_channels (Config::instance()->default_dcp_audio_channels ())
163 , _interop (Config::instance()->default_interop ())
164 , _audio_processor (0)
165 , _reel_type (REELTYPE_SINGLE)
166 , _reel_length (2000000000)
167 , _reencode_j2k (false)
168 , _user_explicit_video_frame_rate (false)
169 , _user_explicit_container (false)
170 , _user_explicit_resolution (false)
171 , _name_language (dcp::LanguageTag("en-US"))
172 , _audio_language (dcp::LanguageTag("en-US"))
173 , _release_territory (dcp::LanguageTag::RegionSubtag("US"))
174 , _version_number (1)
175 , _status (dcp::FINAL)
176 , _luminance (dcp::Luminance(4.5, dcp::Luminance::FOOT_LAMBERT))
177 , _state_version (current_state_version)
181 set_isdcf_date_today ();
183 _playlist_change_connection = _playlist->Change.connect (bind (&Film::playlist_change, this, _1));
184 _playlist_order_changed_connection = _playlist->OrderChange.connect (bind (&Film::playlist_order_changed, this));
185 _playlist_content_change_connection = _playlist->ContentChange.connect (bind (&Film::playlist_content_change, this, _1, _2, _3, _4));
186 _playlist_length_change_connection = _playlist->LengthChange.connect (bind(&Film::playlist_length_change, this));
189 /* Make state.directory a complete path without ..s (where possible)
190 (Code swiped from Adam Bowen on stackoverflow)
191 XXX: couldn't/shouldn't this just be boost::filesystem::canonical?
194 boost::filesystem::path p (boost::filesystem::system_complete (dir.get()));
195 boost::filesystem::path result;
196 for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
198 boost::system::error_code ec;
199 if (boost::filesystem::is_symlink(result, ec) || result.filename() == "..") {
202 result = result.parent_path ();
204 } else if (*i != ".") {
209 set_directory (result.make_preferred ());
213 _log.reset (new FileLog (file ("log")));
215 _log.reset (new NullLog);
218 _playlist->set_sequence (_sequence);
223 BOOST_FOREACH (boost::signals2::connection& i, _job_connections) {
227 BOOST_FOREACH (boost::signals2::connection& i, _audio_analysis_connections) {
233 Film::video_identifier () const
235 DCPOMATIC_ASSERT (container ());
237 string s = container()->id()
238 + "_" + resolution_to_string (_resolution)
239 + "_" + _playlist->video_identifier()
240 + "_" + raw_convert<string>(_video_frame_rate)
241 + "_" + raw_convert<string>(j2k_bandwidth());
244 /* This is insecure but hey, the key is in plaintext in metadata.xml */
245 s += "_E" + _key.hex();
263 /** @return The file to write video frame info to */
264 boost::filesystem::path
265 Film::info_file (DCPTimePeriod period) const
267 boost::filesystem::path p;
269 p /= video_identifier () + "_" + raw_convert<string> (period.from.get()) + "_" + raw_convert<string> (period.to.get());
273 boost::filesystem::path
274 Film::internal_video_asset_dir () const
276 return dir ("video");
279 boost::filesystem::path
280 Film::internal_video_asset_filename (DCPTimePeriod p) const
282 return video_identifier() + "_" + raw_convert<string> (p.from.get()) + "_" + raw_convert<string> (p.to.get()) + ".mxf";
285 boost::filesystem::path
286 Film::audio_analysis_path (shared_ptr<const Playlist> playlist) const
288 boost::filesystem::path p = dir ("analysis");
291 BOOST_FOREACH (shared_ptr<Content> i, playlist->content ()) {
296 digester.add (i->digest ());
297 digester.add (i->audio->mapping().digest ());
298 if (playlist->content().size() != 1) {
299 /* Analyses should be considered equal regardless of gain
300 if they were made from just one piece of content. This
301 is because we can fake any gain change in a single-content
302 analysis at the plotting stage rather than having to
305 digester.add (i->audio->gain ());
309 if (audio_processor ()) {
310 digester.add (audio_processor()->id ());
313 digester.add (audio_channels());
315 p /= digester.get ();
320 boost::filesystem::path
321 Film::subtitle_analysis_path (shared_ptr<const Content> content) const
323 boost::filesystem::path p = dir ("analysis");
326 digester.add (content->digest());
328 if (!content->text.empty()) {
329 shared_ptr<TextContent> tc = content->text.front();
330 digester.add (tc->x_scale());
331 digester.add (tc->y_scale());
332 BOOST_FOREACH (shared_ptr<dcpomatic::Font> i, tc->fonts()) {
333 digester.add (i->id());
336 digester.add (tc->effect().get());
338 digester.add (tc->line_spacing());
339 digester.add (tc->outline_width());
342 shared_ptr<const FFmpegContent> fc = dynamic_pointer_cast<const FFmpegContent>(content);
344 digester.add (fc->subtitle_stream()->identifier());
347 p /= digester.get ();
352 /** Add suitable Jobs to the JobManager to create a DCP for this Film.
353 * @param gui true if this is being called from a GUI tool.
354 * @param check true to check the content in the project for changes before making the DCP.
357 Film::make_dcp (bool gui, bool check)
359 if (dcp_name().find ("/") != string::npos) {
360 throw BadSettingError (_("name"), _("Cannot contain slashes"));
363 if (container() == 0) {
364 throw MissingSettingError (_("container"));
367 if (content().empty()) {
368 throw runtime_error (_("You must add some content to the DCP before creating it"));
371 if (length() == DCPTime()) {
372 throw runtime_error (_("The DCP is empty, perhaps because all the content has zero length."));
375 if (dcp_content_type() == 0) {
376 throw MissingSettingError (_("content type"));
379 if (name().empty()) {
383 BOOST_FOREACH (shared_ptr<const Content> i, content ()) {
384 if (!i->paths_valid()) {
385 throw runtime_error (_("some of your content is missing"));
387 shared_ptr<const DCPContent> dcp = dynamic_pointer_cast<const DCPContent> (i);
388 if (dcp && dcp->needs_kdm()) {
389 throw runtime_error (_("Some of your content needs a KDM"));
391 if (dcp && dcp->needs_assets()) {
392 throw runtime_error (_("Some of your content needs an OV"));
396 set_isdcf_date_today ();
398 BOOST_FOREACH (string i, environment_info ()) {
402 BOOST_FOREACH (shared_ptr<const Content> i, content ()) {
403 LOG_GENERAL ("Content: %1", i->technical_summary());
405 LOG_GENERAL ("DCP video rate %1 fps", video_frame_rate());
406 if (Config::instance()->only_servers_encode ()) {
407 LOG_GENERAL_NC ("0 threads: ONLY SERVERS SET TO ENCODE");
409 LOG_GENERAL ("%1 threads", Config::instance()->master_encoding_threads());
411 LOG_GENERAL ("J2K bandwidth %1", j2k_bandwidth());
413 shared_ptr<TranscodeJob> tj (new TranscodeJob (shared_from_this()));
414 tj->set_encoder (shared_ptr<Encoder> (new DCPEncoder (shared_from_this(), tj)));
416 shared_ptr<CheckContentChangeJob> cc (new CheckContentChangeJob(shared_from_this(), tj, gui));
417 JobManager::instance()->add (cc);
419 JobManager::instance()->add (tj);
423 /** Start a job to send our DCP to the configured TMS */
425 Film::send_dcp_to_tms ()
427 shared_ptr<Job> j (new UploadJob (shared_from_this()));
428 JobManager::instance()->add (j);
431 shared_ptr<xmlpp::Document>
432 Film::metadata (bool with_content_paths) const
434 shared_ptr<xmlpp::Document> doc (new xmlpp::Document);
435 xmlpp::Element* root = doc->create_root_node ("Metadata");
437 root->add_child("Version")->add_child_text (raw_convert<string> (current_state_version));
438 root->add_child("Name")->add_child_text (_name);
439 root->add_child("UseISDCFName")->add_child_text (_use_isdcf_name ? "1" : "0");
441 if (_dcp_content_type) {
442 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->isdcf_name ());
446 root->add_child("Container")->add_child_text (_container->id ());
449 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
450 root->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
451 _isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
452 root->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
453 root->add_child("ISDCFDate")->add_child_text (boost::gregorian::to_iso_string (_isdcf_date));
454 root->add_child("AudioChannels")->add_child_text (raw_convert<string> (_audio_channels));
455 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
456 root->add_child("Sequence")->add_child_text (_sequence ? "1" : "0");
457 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
458 root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
459 root->add_child("Key")->add_child_text (_key.hex ());
460 root->add_child("ContextID")->add_child_text (_context_id);
461 if (_audio_processor) {
462 root->add_child("AudioProcessor")->add_child_text (_audio_processor->id ());
464 root->add_child("ReelType")->add_child_text (raw_convert<string> (static_cast<int> (_reel_type)));
465 root->add_child("ReelLength")->add_child_text (raw_convert<string> (_reel_length));
466 root->add_child("ReencodeJ2K")->add_child_text (_reencode_j2k ? "1" : "0");
467 root->add_child("UserExplicitVideoFrameRate")->add_child_text(_user_explicit_video_frame_rate ? "1" : "0");
468 for (map<dcp::Marker, DCPTime>::const_iterator i = _markers.begin(); i != _markers.end(); ++i) {
469 xmlpp::Element* m = root->add_child("Marker");
470 m->set_attribute("Type", dcp::marker_to_string(i->first));
471 m->add_child_text(raw_convert<string>(i->second.get()));
473 BOOST_FOREACH (dcp::Rating i, _ratings) {
474 i.as_xml (root->add_child("Rating"));
476 BOOST_FOREACH (string i, _content_versions) {
477 root->add_child("ContentVersion")->add_child_text(i);
479 root->add_child("NameLanguage")->add_child_text(_name_language.to_string());
480 root->add_child("AudioLanguage")->add_child_text(_audio_language.to_string());
481 root->add_child("ReleaseTerritory")->add_child_text(_release_territory.subtag());
482 root->add_child("VersionNumber")->add_child_text(raw_convert<string>(_version_number));
483 root->add_child("Status")->add_child_text(dcp::status_to_string(_status));
484 root->add_child("Chain")->add_child_text(_chain);
485 root->add_child("Distributor")->add_child_text(_distributor);
486 root->add_child("Facility")->add_child_text(_facility);
487 root->add_child("LuminanceValue")->add_child_text(raw_convert<string>(_luminance.value()));
488 root->add_child("LuminanceUnit")->add_child_text(dcp::Luminance::unit_to_string(_luminance.unit()));
489 root->add_child("UserExplicitContainer")->add_child_text(_user_explicit_container ? "1" : "0");
490 root->add_child("UserExplicitResolution")->add_child_text(_user_explicit_resolution ? "1" : "0");
491 BOOST_FOREACH (dcp::LanguageTag i, _subtitle_languages) {
492 root->add_child("SubtitleLanguage")->add_child_text(i.to_string());
494 _playlist->as_xml (root->add_child ("Playlist"), with_content_paths);
500 Film::write_metadata (boost::filesystem::path path) const
502 shared_ptr<xmlpp::Document> doc = metadata ();
503 doc->write_to_file_formatted (path.string());
506 /** Write state to our `metadata' file */
508 Film::write_metadata () const
510 DCPOMATIC_ASSERT (directory());
511 boost::filesystem::create_directories (directory().get());
512 shared_ptr<xmlpp::Document> doc = metadata ();
513 doc->write_to_file_formatted (file(metadata_file).string ());
517 /** Write a template from this film */
519 Film::write_template (boost::filesystem::path path) const
521 boost::filesystem::create_directories (path.parent_path());
522 shared_ptr<xmlpp::Document> doc = metadata (false);
523 doc->write_to_file_formatted (path.string ());
526 /** Read state from our metadata file.
527 * @return Notes about things that the user should know about, or empty.
530 Film::read_metadata (optional<boost::filesystem::path> path)
533 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file (metadata_file))) {
534 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!"));
537 path = file (metadata_file);
540 if (!boost::filesystem::exists(*path)) {
541 throw FileNotFoundError(*path);
544 cxml::Document f ("Metadata");
545 f.read_file (path.get ());
547 _state_version = f.number_child<int> ("Version");
548 if (_state_version > current_state_version) {
549 throw runtime_error (_("This film was created with a newer version of DCP-o-matic, and it cannot be loaded into this version. Sorry!"));
550 } else if (_state_version < current_state_version) {
551 /* This is an older version; save a copy (if we haven't already) */
552 boost::filesystem::path const older = path->parent_path() / String::compose("metadata.%1.xml", _state_version);
553 if (!boost::filesystem::is_regular_file(older)) {
555 boost::filesystem::copy_file(*path, older);
557 /* Never mind; at least we tried */
562 _name = f.string_child ("Name");
563 if (_state_version >= 9) {
564 _use_isdcf_name = f.bool_child ("UseISDCFName");
565 _isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
566 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("ISDCFDate"));
568 _use_isdcf_name = f.bool_child ("UseDCIName");
569 _isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
570 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
575 optional<string> c = f.optional_string_child ("DCPContentType");
577 _dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
582 optional<string> c = f.optional_string_child ("Container");
584 _container = Ratio::from_id (c.get ());
588 _resolution = string_to_resolution (f.string_child ("Resolution"));
589 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
590 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
591 _encrypted = f.bool_child ("Encrypted");
592 _audio_channels = f.number_child<int> ("AudioChannels");
593 /* We used to allow odd numbers (and zero) channels, but it's just not worth
596 if (_audio_channels == 0) {
598 } else if ((_audio_channels % 2) == 1) {
602 if (f.optional_bool_child("SequenceVideo")) {
603 _sequence = f.bool_child("SequenceVideo");
605 _sequence = f.bool_child("Sequence");
608 _three_d = f.bool_child ("ThreeD");
609 _interop = f.bool_child ("Interop");
610 _key = dcp::Key (f.string_child ("Key"));
611 _context_id = f.optional_string_child("ContextID").get_value_or (dcp::make_uuid ());
613 if (f.optional_string_child ("AudioProcessor")) {
614 _audio_processor = AudioProcessor::from_id (f.string_child ("AudioProcessor"));
616 _audio_processor = 0;
619 if (_audio_processor && !Config::instance()->show_experimental_audio_processors()) {
620 list<AudioProcessor const *> ap = AudioProcessor::visible();
621 if (find(ap.begin(), ap.end(), _audio_processor) == ap.end()) {
622 Config::instance()->set_show_experimental_audio_processors(true);
626 _reel_type = static_cast<ReelType> (f.optional_number_child<int>("ReelType").get_value_or (static_cast<int>(REELTYPE_SINGLE)));
627 _reel_length = f.optional_number_child<int64_t>("ReelLength").get_value_or (2000000000);
628 _reencode_j2k = f.optional_bool_child("ReencodeJ2K").get_value_or(false);
629 _user_explicit_video_frame_rate = f.optional_bool_child("UserExplicitVideoFrameRate").get_value_or(false);
631 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("Marker")) {
632 _markers[dcp::marker_from_string(i->string_attribute("Type"))] = DCPTime(dcp::raw_convert<DCPTime::Type>(i->content()));
635 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("Rating")) {
636 _ratings.push_back (dcp::Rating(i));
639 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("ContentVersion")) {
640 _content_versions.push_back (i->content());
643 optional<string> name_language = f.optional_string_child("NameLanguage");
645 _name_language = dcp::LanguageTag (*name_language);
647 optional<string> audio_language = f.optional_string_child("AudioLanguage");
648 if (audio_language) {
649 _audio_language = dcp::LanguageTag (*audio_language);
651 optional<string> release_territory = f.optional_string_child("ReleaseTerritory");
652 if (release_territory) {
653 _release_territory = dcp::LanguageTag::RegionSubtag (*release_territory);
656 _version_number = f.optional_number_child<int>("VersionNumber").get_value_or(0);
658 optional<string> status = f.optional_string_child("Status");
660 _status = dcp::string_to_status (*status);
663 _chain = f.optional_string_child("Chain").get_value_or("");
664 _distributor = f.optional_string_child("Distributor").get_value_or("");
665 _facility = f.optional_string_child("Facility").get_value_or("");
667 float value = f.optional_number_child<float>("LuminanceValue").get_value_or(4.5);
668 optional<string> unit = f.optional_string_child("LuminanceUnit");
670 _luminance = dcp::Luminance (value, dcp::Luminance::string_to_unit(*unit));
673 /* Disable guessing for files made in previous DCP-o-matic versions */
674 _user_explicit_container = f.optional_bool_child("UserExplicitContainer").get_value_or(true);
675 _user_explicit_resolution = f.optional_bool_child("UserExplicitResolution").get_value_or(true);
677 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("SubtitleLanguage")) {
678 _subtitle_languages.push_back (dcp::LanguageTag(i->content()));
682 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
684 /* Write backtraces to this film's directory, until another film is loaded */
686 set_backtrace_file (file ("backtrace.txt"));
689 /* Around 2.15.108 we removed subtitle language state from the text content and the ISDCF
690 * metadata and put it into the Film instead. If we've loaded an old Film let's try and fish
691 * out the settings from where they were so that they don't get lost.
694 optional<dcp::LanguageTag> found_language;
696 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_child("Playlist")->node_children("Content")) {
697 cxml::ConstNodePtr text = i->optional_node_child("Text");
698 if (text && text->optional_string_child("Language") && !found_language) {
700 found_language = dcp::LanguageTag(text->string_child("Language"));
705 if (_state_version >= 9) {
706 optional<string> isdcf_language = f.node_child("ISDCFMetadata")->optional_string_child("SubtitleLanguage");
707 if (isdcf_language && !found_language) {
709 found_language = dcp::LanguageTag(*isdcf_language);
712 found_language = dcp::LanguageTag(boost::algorithm::to_lower_copy(*isdcf_language));
720 if (found_language) {
721 _subtitle_languages.push_back (*found_language);
728 /** Given a directory name, return its full path within the Film's directory.
729 * @param d directory name within the Film's directory.
730 * @param create true to create the directory (and its parents) if they do not exist.
732 boost::filesystem::path
733 Film::dir (boost::filesystem::path d, bool create) const
735 DCPOMATIC_ASSERT (_directory);
737 boost::filesystem::path p;
738 p /= _directory.get();
742 boost::filesystem::create_directories (p);
748 /** Given a file or directory name, return its full path within the Film's directory.
749 * Any required parent directories will be created.
751 boost::filesystem::path
752 Film::file (boost::filesystem::path f) const
754 DCPOMATIC_ASSERT (_directory);
756 boost::filesystem::path p;
757 p /= _directory.get();
760 boost::filesystem::create_directories (p.parent_path ());
766 Film::mapped_audio_channels () const
770 if (audio_processor ()) {
771 /* Processors are mapped 1:1 to DCP outputs so we can work out mappings from there */
772 for (int i = 0; i < audio_processor()->out_channels(); ++i) {
773 mapped.push_back (i);
776 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
778 list<int> c = i->audio->mapping().mapped_output_channels ();
779 copy (c.begin(), c.end(), back_inserter (mapped));
790 /** @return a ISDCF-compliant name for a DCP of this film */
792 Film::isdcf_name (bool if_created_now) const
796 string raw_name = name ();
798 /* Split the raw name up into words */
799 vector<string> words;
800 split (words, raw_name, is_any_of (" _-"));
804 /* Add each word to fixed_name */
805 for (vector<string>::const_iterator i = words.begin(); i != words.end(); ++i) {
808 /* First letter is always capitalised */
809 w[0] = toupper (w[0]);
811 /* Count caps in w */
813 for (size_t i = 0; i < w.size(); ++i) {
814 if (isupper (w[i])) {
819 /* If w is all caps make the rest of it lower case, otherwise
822 if (caps == w.size ()) {
823 for (size_t i = 1; i < w.size(); ++i) {
824 w[i] = tolower (w[i]);
828 for (size_t i = 0; i < w.size(); ++i) {
833 if (fixed_name.length() > 14) {
834 fixed_name = fixed_name.substr (0, 14);
839 if (dcp_content_type()) {
840 d += "_" + dcp_content_type()->isdcf_name();
841 d += "-" + raw_convert<string>(isdcf_metadata().content_version);
844 ISDCFMetadata const dm = isdcf_metadata ();
846 if (dm.temp_version) {
850 if (dm.pre_release) {
858 if (!dm.chain.empty ()) {
866 if (dm.two_d_version_of_three_d) {
870 if (!dm.mastered_luminance.empty ()) {
871 d += "-" + dm.mastered_luminance;
874 if (video_frame_rate() != 24) {
875 d += "-" + raw_convert<string>(video_frame_rate());
879 d += "_" + container()->isdcf_name();
882 /* XXX: this uses the first bit of content only */
884 /* Interior aspect ratio. The standard says we don't do this for trailers, for some strange reason */
885 if (dcp_content_type() && dcp_content_type()->libdcp_kind() != dcp::TRAILER) {
886 Ratio const * content_ratio = 0;
887 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
889 /* Here's the first piece of video content */
890 content_ratio = Ratio::nearest_from_ratio(i->video->scaled_size(frame_size()).ratio());
895 if (content_ratio && content_ratio != container()) {
896 /* This needs to be the numeric version of the ratio, and ::id() is close enough */
897 d += "-" + content_ratio->id();
901 if (!dm.audio_language.empty ()) {
902 d += "_" + dm.audio_language;
904 /* I'm not clear on the precise details of the convention for CCAP labelling;
905 for now I'm just appending -CCAP if we have any closed captions.
908 bool burnt_in = true;
910 BOOST_FOREACH (shared_ptr<Content> i, content()) {
911 BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
912 if (j->type() == TEXT_OPEN_SUBTITLE && j->use() && !j->burn()) {
914 } else if (j->type() == TEXT_CLOSED_CAPTION && j->use()) {
920 if (!_subtitle_languages.empty()) {
921 string lang = _subtitle_languages.front().language().get_value_or("en").subtag();
923 transform (lang.begin(), lang.end(), lang.begin(), ::tolower);
925 transform (lang.begin(), lang.end(), lang.begin(), ::toupper);
938 if (!dm.territory.empty ()) {
939 d += "_" + dm.territory;
940 if (dm.rating.empty ()) {
943 d += "-" + dm.rating;
947 /* Count mapped audio channels */
949 list<int> mapped = mapped_audio_channels ();
951 pair<int, int> ch = audio_channel_types (mapped, audio_channels());
952 if (!ch.first && !ch.second) {
954 } else if (ch.first) {
955 d += String::compose("_%1%2", ch.first, ch.second);
958 if (audio_channels() > static_cast<int>(dcp::HI) && find(mapped.begin(), mapped.end(), dcp::HI) != mapped.end()) {
961 if (audio_channels() > static_cast<int>(dcp::VI) && find(mapped.begin(), mapped.end(), dcp::VI) != mapped.end()) {
965 d += "_" + resolution_to_string (_resolution);
967 if (!dm.studio.empty ()) {
968 d += "_" + dm.studio;
971 if (if_created_now) {
972 d += "_" + boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
974 d += "_" + boost::gregorian::to_iso_string (_isdcf_date);
977 if (!dm.facility.empty ()) {
978 d += "_" + dm.facility;
992 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
993 shared_ptr<const DCPContent> dc = dynamic_pointer_cast<const DCPContent> (i);
998 bool any_text = false;
999 for (int i = 0; i < TEXT_COUNT; ++i) {
1000 if (dc->reference_text(static_cast<TextType>(i))) {
1004 if (dc->reference_video() || dc->reference_audio() || any_text) {
1018 /** @return name to give the DCP */
1020 Film::dcp_name (bool if_created_now) const
1023 if (use_isdcf_name()) {
1024 return careful_string_filter (isdcf_name (if_created_now));
1027 return careful_string_filter (name ());
1031 Film::set_directory (boost::filesystem::path d)
1038 Film::set_name (string n)
1040 ChangeSignaller<Film> ch (this, NAME);
1045 Film::set_use_isdcf_name (bool u)
1047 ChangeSignaller<Film> ch (this, USE_ISDCF_NAME);
1048 _use_isdcf_name = u;
1052 Film::set_dcp_content_type (DCPContentType const * t)
1054 ChangeSignaller<Film> ch (this, DCP_CONTENT_TYPE);
1055 _dcp_content_type = t;
1059 /** @param explicit_user true if this is being set because of
1060 * a direct user request, false if it is being done because
1061 * DCP-o-matic is guessing the best container to use.
1064 Film::set_container (Ratio const * c, bool explicit_user)
1066 ChangeSignaller<Film> ch (this, CONTAINER);
1069 if (explicit_user) {
1070 _user_explicit_container = true;
1075 /** @param explicit_user true if this is being set because of
1076 * a direct user request, false if it is being done because
1077 * DCP-o-matic is guessing the best resolution to use.
1080 Film::set_resolution (Resolution r, bool explicit_user)
1082 ChangeSignaller<Film> ch (this, RESOLUTION);
1085 if (explicit_user) {
1086 _user_explicit_resolution = true;
1092 Film::set_j2k_bandwidth (int b)
1094 ChangeSignaller<Film> ch (this, J2K_BANDWIDTH);
1099 Film::set_isdcf_metadata (ISDCFMetadata m)
1101 ChangeSignaller<Film> ch (this, ISDCF_METADATA);
1102 _isdcf_metadata = m;
1105 /** @param f New frame rate.
1106 * @param user_explicit true if this comes from a direct user instruction, false if it is from
1107 * DCP-o-matic being helpful.
1110 Film::set_video_frame_rate (int f, bool user_explicit)
1112 ChangeSignaller<Film> ch (this, VIDEO_FRAME_RATE);
1113 _video_frame_rate = f;
1114 if (user_explicit) {
1115 _user_explicit_video_frame_rate = true;
1120 Film::set_audio_channels (int c)
1122 ChangeSignaller<Film> ch (this, AUDIO_CHANNELS);
1123 _audio_channels = c;
1127 Film::set_three_d (bool t)
1129 ChangeSignaller<Film> ch (this, THREE_D);
1132 if (_three_d && _isdcf_metadata.two_d_version_of_three_d) {
1133 ChangeSignaller<Film> ch (this, ISDCF_METADATA);
1134 _isdcf_metadata.two_d_version_of_three_d = false;
1139 Film::set_interop (bool i)
1141 ChangeSignaller<Film> ch (this, INTEROP);
1146 Film::set_audio_processor (AudioProcessor const * processor)
1148 ChangeSignaller<Film> ch1 (this, AUDIO_PROCESSOR);
1149 ChangeSignaller<Film> ch2 (this, AUDIO_CHANNELS);
1150 _audio_processor = processor;
1154 Film::set_reel_type (ReelType t)
1156 ChangeSignaller<Film> ch (this, REEL_TYPE);
1160 /** @param r Desired reel length in bytes */
1162 Film::set_reel_length (int64_t r)
1164 ChangeSignaller<Film> ch (this, REEL_LENGTH);
1169 Film::set_reencode_j2k (bool r)
1171 ChangeSignaller<Film> ch (this, REENCODE_J2K);
1176 Film::signal_change (ChangeType type, int p)
1178 signal_change (type, static_cast<Property>(p));
1182 Film::signal_change (ChangeType type, Property p)
1184 if (type == CHANGE_TYPE_DONE) {
1187 if (p == Film::CONTENT) {
1188 if (!_user_explicit_video_frame_rate) {
1189 set_video_frame_rate (best_video_frame_rate());
1193 emit (boost::bind (boost::ref (Change), type, p));
1195 if (p == Film::VIDEO_FRAME_RATE || p == Film::SEQUENCE) {
1196 /* We want to call Playlist::maybe_sequence but this must happen after the
1197 main signal emission (since the butler will see that emission and un-suspend itself).
1199 emit (boost::bind(&Playlist::maybe_sequence, _playlist.get(), shared_from_this()));
1207 Film::set_isdcf_date_today ()
1209 _isdcf_date = boost::gregorian::day_clock::local_day ();
1212 boost::filesystem::path
1213 Film::j2c_path (int reel, Frame frame, Eyes eyes, bool tmp) const
1215 boost::filesystem::path p;
1217 p /= video_identifier ();
1220 snprintf(buffer, sizeof(buffer), "%08d_%08" PRId64, reel, frame);
1223 if (eyes == EYES_LEFT) {
1225 } else if (eyes == EYES_RIGHT) {
1241 cpl_summary_compare (CPLSummary const & a, CPLSummary const & b)
1243 return a.last_write_time > b.last_write_time;
1246 /** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs.
1247 * The list will be returned in reverse order of timestamp (i.e. most recent first).
1252 if (!directory ()) {
1253 return vector<CPLSummary> ();
1256 vector<CPLSummary> out;
1258 boost::filesystem::path const dir = directory().get();
1259 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
1261 boost::filesystem::is_directory (*i) &&
1262 i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
1266 out.push_back (CPLSummary(*i));
1273 sort (out.begin(), out.end(), cpl_summary_compare);
1279 Film::set_encrypted (bool e)
1281 ChangeSignaller<Film> ch (this, ENCRYPTED);
1286 Film::content () const
1288 return _playlist->content ();
1291 /** @param content Content to add.
1292 * @param disable_audio_analysis true to never do automatic audio analysis, even if it is enabled in configuration.
1295 Film::examine_and_add_content (shared_ptr<Content> content, bool disable_audio_analysis)
1297 if (dynamic_pointer_cast<FFmpegContent> (content) && _directory) {
1298 run_ffprobe (content->path(0), file("ffprobe.log"));
1301 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), content));
1303 _job_connections.push_back (
1304 j->Finished.connect (bind (&Film::maybe_add_content, this, weak_ptr<Job>(j), weak_ptr<Content>(content), disable_audio_analysis))
1307 JobManager::instance()->add (j);
1311 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c, bool disable_audio_analysis)
1313 shared_ptr<Job> job = j.lock ();
1314 if (!job || !job->finished_ok ()) {
1318 shared_ptr<Content> content = c.lock ();
1323 add_content (content);
1325 if (Config::instance()->automatic_audio_analysis() && content->audio && !disable_audio_analysis) {
1326 shared_ptr<Playlist> playlist (new Playlist);
1327 playlist->add (shared_from_this(), content);
1328 boost::signals2::connection c;
1329 JobManager::instance()->analyse_audio (
1330 shared_from_this(), playlist, false, c, bind (&Film::audio_analysis_finished, this)
1332 _audio_analysis_connections.push_back (c);
1337 Film::add_content (shared_ptr<Content> c)
1339 /* Add {video,subtitle} content after any existing {video,subtitle} content */
1341 c->set_position (shared_from_this(), _playlist->video_end(shared_from_this()));
1342 } else if (!c->text.empty()) {
1343 c->set_position (shared_from_this(), _playlist->text_end(shared_from_this()));
1346 if (_template_film) {
1347 /* Take settings from the first piece of content of c's type in _template */
1348 BOOST_FOREACH (shared_ptr<Content> i, _template_film->content()) {
1349 c->take_settings_from (i);
1353 _playlist->add (shared_from_this(), c);
1355 maybe_set_container_and_resolution ();
1357 set_audio_channels (14);
1358 set_interop (false);
1364 Film::maybe_set_container_and_resolution ()
1366 /* Get the only piece of video content, if there is only one */
1367 shared_ptr<VideoContent> video;
1368 BOOST_FOREACH (shared_ptr<const Content> i, _playlist->content()) {
1379 /* This is the only piece of video content in this Film. Use it to make a guess for
1380 * DCP container size and resolution, unless the user has already explicitly set these
1383 if (!_user_explicit_container) {
1384 if (video->size().ratio() > 2.3) {
1385 set_container (Ratio::from_id("239"), false);
1387 set_container (Ratio::from_id("185"), false);
1391 if (!_user_explicit_resolution) {
1392 if (video->size_after_crop().width > 2048 || video->size_after_crop().height > 1080) {
1393 set_resolution (RESOLUTION_4K, false);
1395 set_resolution (RESOLUTION_2K, false);
1402 Film::remove_content (shared_ptr<Content> c)
1404 _playlist->remove (c);
1405 maybe_set_container_and_resolution ();
1409 Film::move_content_earlier (shared_ptr<Content> c)
1411 _playlist->move_earlier (shared_from_this(), c);
1415 Film::move_content_later (shared_ptr<Content> c)
1417 _playlist->move_later (shared_from_this(), c);
1420 /** @return length of the film from time 0 to the last thing on the playlist,
1421 * with a minimum length of 1 second.
1424 Film::length () const
1426 return max(DCPTime::from_seconds(1), _playlist->length(shared_from_this()).ceil(video_frame_rate()));
1430 Film::best_video_frame_rate () const
1432 /* Don't default to anything above 30fps (make the user select that explicitly) */
1433 int best = _playlist->best_video_frame_rate ();
1441 Film::active_frame_rate_change (DCPTime t) const
1443 return _playlist->active_frame_rate_change (t, video_frame_rate ());
1447 Film::playlist_content_change (ChangeType type, weak_ptr<Content> c, int p, bool frequent)
1449 if (p == ContentProperty::VIDEO_FRAME_RATE) {
1450 signal_change (type, Film::CONTENT);
1451 } else if (p == AudioContentProperty::STREAMS) {
1452 signal_change (type, Film::NAME);
1455 if (type == CHANGE_TYPE_DONE) {
1456 emit (boost::bind (boost::ref (ContentChange), type, c, p, frequent));
1458 check_settings_consistency ();
1461 ContentChange (type, c, p, frequent);
1468 Film::playlist_length_change ()
1474 Film::playlist_change (ChangeType type)
1476 signal_change (type, CONTENT);
1477 signal_change (type, NAME);
1479 if (type == CHANGE_TYPE_DONE) {
1480 check_settings_consistency ();
1486 /** Check for (and if necessary fix) impossible settings combinations, like
1487 * video set to being referenced when it can't be.
1490 Film::check_settings_consistency ()
1492 optional<int> atmos_rate;
1493 BOOST_FOREACH (shared_ptr<Content> i, content()) {
1496 int rate = lrintf (i->atmos->edit_rate().as_float());
1497 if (atmos_rate && *atmos_rate != rate) {
1498 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."));
1499 } else if (!atmos_rate && rate != video_frame_rate()) {
1501 set_video_frame_rate (rate, false);
1502 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."));
1507 bool change_made = false;
1508 BOOST_FOREACH (shared_ptr<Content> i, content()) {
1509 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent>(i);
1515 if (d->reference_video() && !d->can_reference_video(shared_from_this(), why_not)) {
1516 d->set_reference_video(false);
1519 if (d->reference_audio() && !d->can_reference_audio(shared_from_this(), why_not)) {
1520 d->set_reference_audio(false);
1523 if (d->reference_text(TEXT_OPEN_SUBTITLE) && !d->can_reference_text(shared_from_this(), TEXT_OPEN_SUBTITLE, why_not)) {
1524 d->set_reference_text(TEXT_OPEN_SUBTITLE, false);
1527 if (d->reference_text(TEXT_CLOSED_CAPTION) && !d->can_reference_text(shared_from_this(), TEXT_CLOSED_CAPTION, why_not)) {
1528 d->set_reference_text(TEXT_CLOSED_CAPTION, false);
1534 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."));
1539 Film::playlist_order_changed ()
1541 /* XXX: missing PENDING */
1542 signal_change (CHANGE_TYPE_DONE, CONTENT_ORDER);
1546 Film::audio_frame_rate () const
1548 /* It seems that nobody makes 96kHz DCPs at the moment, so let's avoid them.
1555 Film::set_sequence (bool s)
1557 if (s == _sequence) {
1561 ChangeSignaller<Film> cc (this, SEQUENCE);
1563 _playlist->set_sequence (s);
1566 /** @return Size of the largest possible image in whatever resolution we are using */
1568 Film::full_frame () const
1570 switch (_resolution) {
1572 return dcp::Size (2048, 1080);
1574 return dcp::Size (4096, 2160);
1577 DCPOMATIC_ASSERT (false);
1578 return dcp::Size ();
1581 /** @return Size of the frame */
1583 Film::frame_size () const
1585 return fit_ratio_within (container()->ratio(), full_frame ());
1589 /** @return Area of Film::frame_size() that contains picture rather than pillar/letterboxing */
1591 Film::active_area () const
1593 dcp::Size const frame = frame_size ();
1596 BOOST_FOREACH (shared_ptr<Content> i, content()) {
1598 dcp::Size s = i->video->scaled_size (frame);
1599 active.width = max(active.width, s.width);
1600 active.height = max(active.height, s.height);
1608 /** @param recipient KDM recipient certificate.
1609 * @param trusted_devices Certificate thumbprints of other trusted devices (can be empty).
1610 * @param cpl_file CPL filename.
1611 * @param from KDM from time expressed as a local time with an offset from UTC.
1612 * @param until KDM to time expressed as a local time with an offset from UTC.
1613 * @param formulation KDM formulation to use.
1614 * @param disable_forensic_marking_picture true to disable forensic marking of picture.
1615 * @param disable_forensic_marking_audio if not set, don't disable forensic marking of audio. If set to 0,
1616 * disable all forensic marking; if set above 0, disable forensic marking above that channel.
1620 dcp::Certificate recipient,
1621 vector<string> trusted_devices,
1622 boost::filesystem::path cpl_file,
1623 dcp::LocalTime from,
1624 dcp::LocalTime until,
1625 dcp::Formulation formulation,
1626 bool disable_forensic_marking_picture,
1627 optional<int> disable_forensic_marking_audio
1631 throw runtime_error (_("Cannot make a KDM as this project is not encrypted."));
1634 shared_ptr<const dcp::CPL> cpl (new dcp::CPL (cpl_file));
1635 shared_ptr<const dcp::CertificateChain> signer = Config::instance()->signer_chain ();
1636 if (!signer->valid ()) {
1637 throw InvalidSignerError ();
1640 /* Find keys that have been added to imported, encrypted DCP content */
1641 list<dcp::DecryptedKDMKey> imported_keys;
1642 BOOST_FOREACH (shared_ptr<Content> i, content()) {
1643 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent> (i);
1644 if (d && d->kdm()) {
1645 dcp::DecryptedKDM kdm (d->kdm().get(), Config::instance()->decryption_chain()->key().get());
1646 list<dcp::DecryptedKDMKey> keys = kdm.keys ();
1647 copy (keys.begin(), keys.end(), back_inserter (imported_keys));
1651 map<shared_ptr<const dcp::ReelMXF>, dcp::Key> keys;
1653 BOOST_FOREACH(shared_ptr<const dcp::ReelMXF> i, cpl->reel_mxfs()) {
1658 /* Get any imported key for this ID */
1660 BOOST_FOREACH (dcp::DecryptedKDMKey j, imported_keys) {
1661 if (j.id() == i->key_id().get()) {
1662 LOG_GENERAL ("Using imported key for %1", i->key_id().get());
1669 /* No imported key; it must be an asset that we encrypted */
1670 LOG_GENERAL ("Using our own key for %1", i->key_id().get());
1675 return dcp::DecryptedKDM (
1676 cpl->id(), keys, from, until, cpl->content_title_text(), cpl->content_title_text(), dcp::LocalTime().as_string()
1677 ).encrypt (signer, recipient, trusted_devices, formulation, disable_forensic_marking_picture, disable_forensic_marking_audio);
1681 /** @return The approximate disk space required to encode a DCP of this film with the
1682 * current settings, in bytes.
1685 Film::required_disk_space () const
1687 return _playlist->required_disk_space (shared_from_this(), j2k_bandwidth(), audio_channels(), audio_frame_rate());
1690 /** This method checks the disk that the Film is on and tries to decide whether or not
1691 * there will be enough space to make a DCP for it. If so, true is returned; if not,
1692 * false is returned and required and available are filled in with the amount of disk space
1693 * required and available respectively (in GB).
1695 * Note: the decision made by this method isn't, of course, 100% reliable.
1698 Film::should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const
1700 /* Create a test file and see if we can hard-link it */
1701 boost::filesystem::path test = internal_video_asset_dir() / "test";
1702 boost::filesystem::path test2 = internal_video_asset_dir() / "test2";
1703 can_hard_link = true;
1704 FILE* f = fopen_boost (test, "w");
1707 boost::system::error_code ec;
1708 boost::filesystem::create_hard_link (test, test2, ec);
1710 can_hard_link = false;
1712 boost::filesystem::remove (test);
1713 boost::filesystem::remove (test2);
1716 boost::filesystem::space_info s = boost::filesystem::space (internal_video_asset_dir ());
1717 required = double (required_disk_space ()) / 1073741824.0f;
1718 if (!can_hard_link) {
1721 available = double (s.available) / 1073741824.0f;
1722 return (available - required) > 1;
1725 /** @return The names of the channels that audio contents' outputs are passed into;
1726 * this is either the DCP or a AudioProcessor.
1728 vector<NamedChannel>
1729 Film::audio_output_names () const
1731 if (audio_processor ()) {
1732 return audio_processor()->input_names ();
1735 DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
1737 vector<NamedChannel> n;
1739 for (int i = 0; i < audio_channels(); ++i) {
1740 if (i != 8 && i != 9 && i != 15) {
1741 n.push_back (NamedChannel(short_audio_channel_name(i), i));
1749 Film::repeat_content (ContentList c, int n)
1751 _playlist->repeat (shared_from_this(), c, n);
1755 Film::remove_content (ContentList c)
1757 _playlist->remove (c);
1761 Film::audio_analysis_finished ()
1767 Film::reels () const
1769 list<DCPTimePeriod> p;
1770 DCPTime const len = length();
1772 switch (reel_type ()) {
1773 case REELTYPE_SINGLE:
1774 p.push_back (DCPTimePeriod (DCPTime (), len));
1776 case REELTYPE_BY_VIDEO_CONTENT:
1778 /* Collect all reel boundaries */
1779 list<DCPTime> split_points;
1780 split_points.push_back (DCPTime());
1781 split_points.push_back (len);
1782 BOOST_FOREACH (shared_ptr<Content> c, content()) {
1784 BOOST_FOREACH (DCPTime t, c->reel_split_points(shared_from_this())) {
1785 split_points.push_back (t);
1787 split_points.push_back (c->end(shared_from_this()));
1791 split_points.sort ();
1792 split_points.unique ();
1794 /* Make them into periods, coalescing any that are less than 1 second long */
1795 optional<DCPTime> last;
1796 BOOST_FOREACH (DCPTime t, split_points) {
1797 if (last && (t - *last) >= DCPTime::from_seconds(1)) {
1798 /* Period from *last to t is long enough; use it and start a new one */
1799 p.push_back (DCPTimePeriod(*last, t));
1802 /* That was the first time, so start a new period */
1808 case REELTYPE_BY_LENGTH:
1811 /* Integer-divide reel length by the size of one frame to give the number of frames per reel,
1812 * making sure we don't go less than 1s long.
1814 Frame const reel_in_frames = max(_reel_length / ((j2k_bandwidth() / video_frame_rate()) / 8), static_cast<Frame>(video_frame_rate()));
1815 while (current < len) {
1816 DCPTime end = min (len, current + DCPTime::from_frames (reel_in_frames, video_frame_rate ()));
1817 p.push_back (DCPTimePeriod (current, end));
1827 /** @param period A period within the DCP
1828 * @return Name of the content which most contributes to the given period.
1831 Film::content_summary (DCPTimePeriod period) const
1833 return _playlist->content_summary (shared_from_this(), period);
1837 Film::use_template (string name)
1839 _template_film.reset (new Film (optional<boost::filesystem::path>()));
1840 _template_film->read_metadata (Config::instance()->template_path (name));
1841 _use_isdcf_name = _template_film->_use_isdcf_name;
1842 _dcp_content_type = _template_film->_dcp_content_type;
1843 _container = _template_film->_container;
1844 _resolution = _template_film->_resolution;
1845 _j2k_bandwidth = _template_film->_j2k_bandwidth;
1846 _video_frame_rate = _template_film->_video_frame_rate;
1847 _encrypted = _template_film->_encrypted;
1848 _audio_channels = _template_film->_audio_channels;
1849 _sequence = _template_film->_sequence;
1850 _three_d = _template_film->_three_d;
1851 _interop = _template_film->_interop;
1852 _audio_processor = _template_film->_audio_processor;
1853 _reel_type = _template_film->_reel_type;
1854 _reel_length = _template_film->_reel_length;
1855 _isdcf_metadata = _template_film->_isdcf_metadata;
1858 pair<double, double>
1859 Film::speed_up_range (int dcp_frame_rate) const
1861 return _playlist->speed_up_range (dcp_frame_rate);
1865 Film::copy_from (shared_ptr<const Film> film)
1867 read_metadata (film->file (metadata_file));
1871 Film::references_dcp_video () const
1873 BOOST_FOREACH (shared_ptr<Content> i, _playlist->content()) {
1874 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent>(i);
1875 if (d && d->reference_video()) {
1884 Film::references_dcp_audio () const
1886 BOOST_FOREACH (shared_ptr<Content> i, _playlist->content()) {
1887 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent>(i);
1888 if (d && d->reference_audio()) {
1898 Film::contains_atmos_content () const
1900 BOOST_FOREACH (shared_ptr<Content> i, _playlist->content()) {
1911 Film::closed_caption_tracks () const
1913 list<DCPTextTrack> tt;
1914 BOOST_FOREACH (shared_ptr<Content> i, content()) {
1915 BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
1916 /* XXX: Empty DCPTextTrack ends up being a magic value here - the "unknown" or "not specified" track */
1917 DCPTextTrack dtt = j->dcp_track().get_value_or(DCPTextTrack());
1918 if (j->type() == TEXT_CLOSED_CAPTION && find(tt.begin(), tt.end(), dtt) == tt.end()) {
1928 Film::set_marker (dcp::Marker type, DCPTime time)
1930 ChangeSignaller<Film> ch (this, MARKERS);
1931 _markers[type] = time;
1935 Film::unset_marker (dcp::Marker type)
1937 ChangeSignaller<Film> ch (this, MARKERS);
1938 _markers.erase (type);
1943 Film::clear_markers ()
1945 ChangeSignaller<Film> ch (this, MARKERS);
1951 Film::set_ratings (vector<dcp::Rating> r)
1953 ChangeSignaller<Film> ch (this, RATINGS);
1958 Film::set_content_versions (vector<string> v)
1960 ChangeSignaller<Film> ch (this, CONTENT_VERSIONS);
1961 _content_versions = v;
1966 Film::set_name_language (dcp::LanguageTag lang)
1968 ChangeSignaller<Film> ch (this, NAME_LANGUAGE);
1969 _name_language = lang;
1974 Film::set_audio_language (dcp::LanguageTag lang)
1976 ChangeSignaller<Film> ch (this, AUDIO_LANGUAGE);
1977 _audio_language = lang;
1982 Film::set_release_territory (dcp::LanguageTag::RegionSubtag region)
1984 ChangeSignaller<Film> ch (this, RELEASE_TERRITORY);
1985 _release_territory = region;
1990 Film::set_status (dcp::Status s)
1992 ChangeSignaller<Film> ch (this, STATUS);
1998 Film::set_version_number (int v)
2000 ChangeSignaller<Film> ch (this, VERSION_NUMBER);
2001 _version_number = v;
2006 Film::set_chain (string c)
2008 ChangeSignaller<Film> ch (this, CHAIN);
2014 Film::set_distributor (string d)
2016 ChangeSignaller<Film> ch (this, DISTRIBUTOR);
2022 Film::set_luminance (dcp::Luminance l)
2024 ChangeSignaller<Film> ch (this, LUMINANCE);
2030 Film::set_subtitle_language (dcp::LanguageTag language)
2032 vector<dcp::LanguageTag> lang;
2033 lang.push_back (language);
2034 set_subtitle_languages (lang);
2039 Film::unset_subtitle_language ()
2041 ChangeSignaller<Film> ch (this, SUBTITLE_LANGUAGES);
2042 _subtitle_languages.clear();
2047 Film::set_subtitle_languages (vector<dcp::LanguageTag> languages)
2049 ChangeSignaller<Film> ch (this, SUBTITLE_LANGUAGES);
2050 _subtitle_languages = languages;
2055 Film::set_facility (string f)
2057 ChangeSignaller<Film> ch (this, FACILITY);
2063 Film::marker (dcp::Marker type) const
2065 map<dcp::Marker, DCPTime>::const_iterator i = _markers.find (type);
2066 if (i == _markers.end()) {
2067 return optional<DCPTime>();
2072 shared_ptr<InfoFileHandle>
2073 Film::info_file_handle (DCPTimePeriod period, bool read) const
2075 return shared_ptr<InfoFileHandle> (new InfoFileHandle(_info_file_mutex, info_file(period), read));
2078 InfoFileHandle::InfoFileHandle (boost::mutex& mutex, boost::filesystem::path file, bool read)
2083 _handle = fopen_boost (file, "rb");
2085 throw OpenFileError (file, errno, OpenFileError::READ);
2088 bool const exists = boost::filesystem::exists (file);
2090 _handle = fopen_boost (file, "r+b");
2092 _handle = fopen_boost (file, "wb");
2096 throw OpenFileError (file, errno, exists ? OpenFileError::READ_WRITE : OpenFileError::WRITE);
2101 InfoFileHandle::~InfoFileHandle ()
2107 /** Add FFOC and LFOC markers to a list if they are not already there */
2109 Film::add_ffoc_lfoc (Markers& markers) const
2111 if (markers.find(dcp::Marker::FFOC) == markers.end()) {
2112 markers[dcp::Marker::FFOC] = dcpomatic::DCPTime(0);
2115 if (markers.find(dcp::Marker::LFOC) == markers.end()) {
2116 markers[dcp::Marker::LFOC] = length() - DCPTime::from_frames(1, video_frame_rate());