2 Copyright (C) 2012-2019 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.
29 #include "job_manager.h"
30 #include "dcp_encoder.h"
31 #include "transcode_job.h"
32 #include "upload_job.h"
35 #include "dcpomatic_log.h"
36 #include "exceptions.h"
37 #include "examine_content_job.h"
40 #include "dcp_content_type.h"
43 #include "environment_info.h"
44 #include "audio_processor.h"
46 #include "compose.hpp"
48 #include "audio_content.h"
49 #include "video_content.h"
50 #include "text_content.h"
51 #include "ffmpeg_content.h"
52 #include "dcp_content.h"
53 #include "screen_kdm.h"
55 #include "change_signaller.h"
56 #include "check_content_change_job.h"
57 #include <libcxml/cxml.h>
59 #include <dcp/certificate_chain.h>
61 #include <dcp/local_time.h>
62 #include <dcp/decrypted_kdm.h>
63 #include <dcp/raw_convert.h>
64 #include <dcp/reel_mxf.h>
65 #include <dcp/reel_asset.h>
66 #include <libxml++/libxml++.h>
67 #include <boost/filesystem.hpp>
68 #include <boost/algorithm/string.hpp>
69 #include <boost/foreach.hpp>
70 #include <boost/regex.hpp>
91 using std::runtime_error;
93 using std::back_inserter;
97 using boost::shared_ptr;
98 using boost::weak_ptr;
99 using boost::dynamic_pointer_cast;
100 using boost::optional;
101 using boost::is_any_of;
102 using dcp::raw_convert;
103 using namespace dcpomatic;
105 string const Film::metadata_file = "metadata.xml";
108 * AudioMapping XML changed.
110 * Subtitle offset changed to subtitle y offset, and subtitle x offset added.
112 * Use <Scale> tag in <VideoContent> rather than <Ratio>.
116 * Subtitle X and Y scale.
118 * Bumped to 32 for 2.0 branch; some times are expressed in Times rather
122 * Changed <Period> to <Subtitle> in FFmpegSubtitleStream
124 * Content only contains audio/subtitle-related tags if those things
127 * VideoFrameType in VideoContent is a string rather than an integer.
129 * EffectColour rather than OutlineColour in Subtitle.
131 * TextContent can be in a Caption tag, and some of the tag names
132 * have had Subtitle prefixes or suffixes removed.
134 int const Film::current_state_version = 37;
136 /** Construct a Film object in a given directory.
138 * @param dir Film directory.
141 Film::Film (optional<boost::filesystem::path> dir)
142 : _playlist (new Playlist)
143 , _use_isdcf_name (true)
144 , _dcp_content_type (Config::instance()->default_dcp_content_type ())
145 , _container (Config::instance()->default_container ())
146 , _resolution (RESOLUTION_2K)
149 , _context_id (dcp::make_uuid ())
150 , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
151 , _isdcf_metadata (Config::instance()->default_isdcf_metadata ())
152 , _video_frame_rate (24)
153 , _audio_channels (Config::instance()->default_dcp_audio_channels ())
156 , _interop (Config::instance()->default_interop ())
157 , _audio_processor (0)
158 , _reel_type (REELTYPE_SINGLE)
159 , _reel_length (2000000000)
160 , _upload_after_make_dcp (Config::instance()->default_upload_after_make_dcp())
161 , _reencode_j2k (false)
162 , _user_explicit_video_frame_rate (false)
163 , _state_version (current_state_version)
167 set_isdcf_date_today ();
169 _playlist_change_connection = _playlist->Change.connect (bind (&Film::playlist_change, this, _1));
170 _playlist_order_changed_connection = _playlist->OrderChanged.connect (bind (&Film::playlist_order_changed, this));
171 _playlist_content_change_connection = _playlist->ContentChange.connect (bind (&Film::playlist_content_change, this, _1, _2, _3, _4));
174 /* Make state.directory a complete path without ..s (where possible)
175 (Code swiped from Adam Bowen on stackoverflow)
176 XXX: couldn't/shouldn't this just be boost::filesystem::canonical?
179 boost::filesystem::path p (boost::filesystem::system_complete (dir.get()));
180 boost::filesystem::path result;
181 for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
183 boost::system::error_code ec;
184 if (boost::filesystem::is_symlink(result, ec) || result.filename() == "..") {
187 result = result.parent_path ();
189 } else if (*i != ".") {
194 set_directory (result.make_preferred ());
198 _log.reset (new FileLog (file ("log")));
200 _log.reset (new NullLog);
203 _playlist->set_sequence (_sequence);
208 BOOST_FOREACH (boost::signals2::connection& i, _job_connections) {
212 BOOST_FOREACH (boost::signals2::connection& i, _audio_analysis_connections) {
218 Film::video_identifier () const
220 DCPOMATIC_ASSERT (container ());
222 string s = container()->id()
223 + "_" + resolution_to_string (_resolution)
224 + "_" + _playlist->video_identifier()
225 + "_" + raw_convert<string>(_video_frame_rate)
226 + "_" + raw_convert<string>(j2k_bandwidth());
229 /* This is insecure but hey, the key is in plaintext in metadata.xml */
230 s += "_E" + _key.hex();
248 /** @return The file to write video frame info to */
249 boost::filesystem::path
250 Film::info_file (DCPTimePeriod period) const
252 boost::filesystem::path p;
254 p /= video_identifier () + "_" + raw_convert<string> (period.from.get()) + "_" + raw_convert<string> (period.to.get());
258 boost::filesystem::path
259 Film::internal_video_asset_dir () const
261 return dir ("video");
264 boost::filesystem::path
265 Film::internal_video_asset_filename (DCPTimePeriod p) const
267 return video_identifier() + "_" + raw_convert<string> (p.from.get()) + "_" + raw_convert<string> (p.to.get()) + ".mxf";
270 boost::filesystem::path
271 Film::audio_analysis_path (shared_ptr<const Playlist> playlist) const
273 boost::filesystem::path p = dir ("analysis");
276 BOOST_FOREACH (shared_ptr<Content> i, playlist->content ()) {
281 digester.add (i->digest ());
282 digester.add (i->audio->mapping().digest ());
283 if (playlist->content().size() != 1) {
284 /* Analyses should be considered equal regardless of gain
285 if they were made from just one piece of content. This
286 is because we can fake any gain change in a single-content
287 analysis at the plotting stage rather than having to
290 digester.add (i->audio->gain ());
294 if (audio_processor ()) {
295 digester.add (audio_processor()->id ());
298 digester.add (audio_channels());
300 p /= digester.get ();
304 /** Add suitable Jobs to the JobManager to create a DCP for this Film.
305 * @param gui true if this is being called from a GUI tool.
306 * @param check true to check the content in the project for changes before making the DCP.
309 Film::make_dcp (bool gui, bool check)
311 if (dcp_name().find ("/") != string::npos) {
312 throw BadSettingError (_("name"), _("Cannot contain slashes"));
315 if (container() == 0) {
316 throw MissingSettingError (_("container"));
319 if (content().empty()) {
320 throw runtime_error (_("You must add some content to the DCP before creating it"));
323 if (dcp_content_type() == 0) {
324 throw MissingSettingError (_("content type"));
327 if (name().empty()) {
331 BOOST_FOREACH (shared_ptr<const Content> i, content ()) {
332 if (!i->paths_valid()) {
333 throw runtime_error (_("some of your content is missing"));
335 shared_ptr<const DCPContent> dcp = dynamic_pointer_cast<const DCPContent> (i);
336 if (dcp && dcp->needs_kdm()) {
337 throw runtime_error (_("Some of your content needs a KDM"));
339 if (dcp && dcp->needs_assets()) {
340 throw runtime_error (_("Some of your content needs an OV"));
344 set_isdcf_date_today ();
346 BOOST_FOREACH (string i, environment_info ()) {
350 BOOST_FOREACH (shared_ptr<const Content> i, content ()) {
351 LOG_GENERAL ("Content: %1", i->technical_summary());
353 LOG_GENERAL ("DCP video rate %1 fps", video_frame_rate());
354 if (Config::instance()->only_servers_encode ()) {
355 LOG_GENERAL_NC ("0 threads: ONLY SERVERS SET TO ENCODE");
357 LOG_GENERAL ("%1 threads", Config::instance()->master_encoding_threads());
359 LOG_GENERAL ("J2K bandwidth %1", j2k_bandwidth());
361 shared_ptr<TranscodeJob> tj (new TranscodeJob (shared_from_this()));
362 tj->set_encoder (shared_ptr<Encoder> (new DCPEncoder (shared_from_this(), tj)));
364 shared_ptr<CheckContentChangeJob> cc (new CheckContentChangeJob(shared_from_this(), tj, gui));
365 JobManager::instance()->add (cc);
367 JobManager::instance()->add (tj);
371 /** Start a job to send our DCP to the configured TMS */
373 Film::send_dcp_to_tms ()
375 shared_ptr<Job> j (new UploadJob (shared_from_this()));
376 JobManager::instance()->add (j);
379 shared_ptr<xmlpp::Document>
380 Film::metadata (bool with_content_paths) const
382 shared_ptr<xmlpp::Document> doc (new xmlpp::Document);
383 xmlpp::Element* root = doc->create_root_node ("Metadata");
385 root->add_child("Version")->add_child_text (raw_convert<string> (current_state_version));
386 root->add_child("Name")->add_child_text (_name);
387 root->add_child("UseISDCFName")->add_child_text (_use_isdcf_name ? "1" : "0");
389 if (_dcp_content_type) {
390 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->isdcf_name ());
394 root->add_child("Container")->add_child_text (_container->id ());
397 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
398 root->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
399 _isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
400 root->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
401 root->add_child("ISDCFDate")->add_child_text (boost::gregorian::to_iso_string (_isdcf_date));
402 root->add_child("AudioChannels")->add_child_text (raw_convert<string> (_audio_channels));
403 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
404 root->add_child("Sequence")->add_child_text (_sequence ? "1" : "0");
405 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
406 root->add_child("Signed")->add_child_text (_signed ? "1" : "0");
407 root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
408 root->add_child("Key")->add_child_text (_key.hex ());
409 root->add_child("ContextID")->add_child_text (_context_id);
410 if (_audio_processor) {
411 root->add_child("AudioProcessor")->add_child_text (_audio_processor->id ());
413 root->add_child("ReelType")->add_child_text (raw_convert<string> (static_cast<int> (_reel_type)));
414 root->add_child("ReelLength")->add_child_text (raw_convert<string> (_reel_length));
415 root->add_child("UploadAfterMakeDCP")->add_child_text (_upload_after_make_dcp ? "1" : "0");
416 root->add_child("ReencodeJ2K")->add_child_text (_reencode_j2k ? "1" : "0");
417 root->add_child("UserExplicitVideoFrameRate")->add_child_text(_user_explicit_video_frame_rate ? "1" : "0");
418 for (map<dcp::Marker, DCPTime>::const_iterator i = _markers.begin(); i != _markers.end(); ++i) {
419 xmlpp::Element* m = root->add_child("Marker");
420 m->set_attribute("Type", dcp::marker_to_string(i->first));
421 m->add_child_text(raw_convert<string>(i->second.get()));
423 BOOST_FOREACH (dcp::Rating i, _ratings) {
424 i.as_xml (root->add_child("Rating"));
426 _playlist->as_xml (root->add_child ("Playlist"), with_content_paths);
432 Film::write_metadata (boost::filesystem::path path) const
434 shared_ptr<xmlpp::Document> doc = metadata ();
435 doc->write_to_file_formatted (path.string());
438 /** Write state to our `metadata' file */
440 Film::write_metadata () const
442 DCPOMATIC_ASSERT (directory());
443 boost::filesystem::create_directories (directory().get());
444 shared_ptr<xmlpp::Document> doc = metadata ();
445 doc->write_to_file_formatted (file(metadata_file).string ());
449 /** Write a template from this film */
451 Film::write_template (boost::filesystem::path path) const
453 boost::filesystem::create_directories (path.parent_path());
454 shared_ptr<xmlpp::Document> doc = metadata (false);
455 doc->write_to_file_formatted (path.string ());
458 /** Read state from our metadata file.
459 * @return Notes about things that the user should know about, or empty.
462 Film::read_metadata (optional<boost::filesystem::path> path)
465 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file (metadata_file))) {
466 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!"));
469 path = file (metadata_file);
472 cxml::Document f ("Metadata");
473 f.read_file (path.get ());
475 _state_version = f.number_child<int> ("Version");
476 if (_state_version > current_state_version) {
477 throw runtime_error (_("This film was created with a newer version of DCP-o-matic, and it cannot be loaded into this version. Sorry!"));
478 } else if (_state_version < current_state_version) {
479 /* This is an older version; save a copy (if we haven't already) */
480 boost::filesystem::path const older = path->parent_path() / String::compose("metadata.%1.xml", _state_version);
481 if (!boost::filesystem::is_regular_file(older)) {
483 boost::filesystem::copy_file(*path, older);
485 /* Never mind; at least we tried */
490 _name = f.string_child ("Name");
491 if (_state_version >= 9) {
492 _use_isdcf_name = f.bool_child ("UseISDCFName");
493 _isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
494 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("ISDCFDate"));
496 _use_isdcf_name = f.bool_child ("UseDCIName");
497 _isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
498 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
503 optional<string> c = f.optional_string_child ("DCPContentType");
505 _dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
510 optional<string> c = f.optional_string_child ("Container");
512 _container = Ratio::from_id (c.get ());
516 _resolution = string_to_resolution (f.string_child ("Resolution"));
517 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
518 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
519 _signed = f.optional_bool_child("Signed").get_value_or (true);
520 _encrypted = f.bool_child ("Encrypted");
521 _audio_channels = f.number_child<int> ("AudioChannels");
522 /* We used to allow odd numbers (and zero) channels, but it's just not worth
525 if (_audio_channels == 0) {
527 } else if ((_audio_channels % 2) == 1) {
531 if (f.optional_bool_child("SequenceVideo")) {
532 _sequence = f.bool_child("SequenceVideo");
534 _sequence = f.bool_child("Sequence");
537 _three_d = f.bool_child ("ThreeD");
538 _interop = f.bool_child ("Interop");
539 _key = dcp::Key (f.string_child ("Key"));
540 _context_id = f.optional_string_child("ContextID").get_value_or (dcp::make_uuid ());
542 if (f.optional_string_child ("AudioProcessor")) {
543 _audio_processor = AudioProcessor::from_id (f.string_child ("AudioProcessor"));
545 _audio_processor = 0;
548 if (_audio_processor && !Config::instance()->show_experimental_audio_processors()) {
549 list<AudioProcessor const *> ap = AudioProcessor::visible();
550 if (find(ap.begin(), ap.end(), _audio_processor) == ap.end()) {
551 Config::instance()->set_show_experimental_audio_processors(true);
555 _reel_type = static_cast<ReelType> (f.optional_number_child<int>("ReelType").get_value_or (static_cast<int>(REELTYPE_SINGLE)));
556 _reel_length = f.optional_number_child<int64_t>("ReelLength").get_value_or (2000000000);
557 _upload_after_make_dcp = f.optional_bool_child("UploadAfterMakeDCP").get_value_or (false);
558 _reencode_j2k = f.optional_bool_child("ReencodeJ2K").get_value_or(false);
559 _user_explicit_video_frame_rate = f.optional_bool_child("UserExplicitVideoFrameRate").get_value_or(false);
561 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("Marker")) {
562 _markers[dcp::marker_from_string(i->string_attribute("Type"))] = DCPTime(dcp::raw_convert<DCPTime::Type>(i->content()));
565 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("Rating")) {
566 _ratings.push_back (dcp::Rating(i));
570 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
572 /* Write backtraces to this film's directory, until another film is loaded */
574 set_backtrace_file (file ("backtrace.txt"));
581 /** Given a directory name, return its full path within the Film's directory.
582 * @param d directory name within the Film's directory.
583 * @param create true to create the directory (and its parents) if they do not exist.
585 boost::filesystem::path
586 Film::dir (boost::filesystem::path d, bool create) const
588 DCPOMATIC_ASSERT (_directory);
590 boost::filesystem::path p;
591 p /= _directory.get();
595 boost::filesystem::create_directories (p);
601 /** Given a file or directory name, return its full path within the Film's directory.
602 * Any required parent directories will be created.
604 boost::filesystem::path
605 Film::file (boost::filesystem::path f) const
607 DCPOMATIC_ASSERT (_directory);
609 boost::filesystem::path p;
610 p /= _directory.get();
613 boost::filesystem::create_directories (p.parent_path ());
619 Film::mapped_audio_channels () const
623 if (audio_processor ()) {
624 /* Processors are mapped 1:1 to DCP outputs so we can work out mappings from there */
625 for (int i = 0; i < audio_processor()->out_channels(); ++i) {
626 mapped.push_back (i);
629 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
631 list<int> c = i->audio->mapping().mapped_output_channels ();
632 copy (c.begin(), c.end(), back_inserter (mapped));
643 /** @return a ISDCF-compliant name for a DCP of this film */
645 Film::isdcf_name (bool if_created_now) const
649 string raw_name = name ();
651 /* Split the raw name up into words */
652 vector<string> words;
653 split (words, raw_name, is_any_of (" _-"));
657 /* Add each word to fixed_name */
658 for (vector<string>::const_iterator i = words.begin(); i != words.end(); ++i) {
661 /* First letter is always capitalised */
662 w[0] = toupper (w[0]);
664 /* Count caps in w */
666 for (size_t i = 0; i < w.size(); ++i) {
667 if (isupper (w[i])) {
672 /* If w is all caps make the rest of it lower case, otherwise
675 if (caps == w.size ()) {
676 for (size_t i = 1; i < w.size(); ++i) {
677 w[i] = tolower (w[i]);
681 for (size_t i = 0; i < w.size(); ++i) {
686 if (fixed_name.length() > 14) {
687 fixed_name = fixed_name.substr (0, 14);
692 if (dcp_content_type()) {
693 d += "_" + dcp_content_type()->isdcf_name();
694 d += "-" + raw_convert<string>(isdcf_metadata().content_version);
697 ISDCFMetadata const dm = isdcf_metadata ();
699 if (dm.temp_version) {
703 if (dm.pre_release) {
711 if (!dm.chain.empty ()) {
719 if (dm.two_d_version_of_three_d) {
723 if (!dm.mastered_luminance.empty ()) {
724 d += "-" + dm.mastered_luminance;
727 if (video_frame_rate() != 24) {
728 d += "-" + raw_convert<string>(video_frame_rate());
732 d += "_" + container()->isdcf_name();
735 /* XXX: this uses the first bit of content only */
737 /* Interior aspect ratio. The standard says we don't do this for trailers, for some strange reason */
738 if (dcp_content_type() && dcp_content_type()->libdcp_kind() != dcp::TRAILER) {
739 Ratio const * content_ratio = 0;
740 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
742 /* Here's the first piece of video content */
743 if (i->video->scale().ratio ()) {
744 content_ratio = i->video->scale().ratio ();
746 content_ratio = Ratio::from_ratio (i->video->size().ratio ());
752 if (content_ratio && content_ratio != container()) {
753 /* This needs to be the numeric version of the ratio, and ::id() is close enough */
754 d += "-" + content_ratio->id();
758 if (!dm.audio_language.empty ()) {
759 d += "_" + dm.audio_language;
761 /* I'm not clear on the precise details of the convention for CCAP labelling;
762 for now I'm just appending -CCAP if we have any closed captions.
765 optional<string> subtitle_language;
766 bool burnt_in = true;
768 BOOST_FOREACH (shared_ptr<Content> i, content()) {
769 BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
770 if (j->type() == TEXT_OPEN_SUBTITLE && j->use()) {
771 subtitle_language = j->language ();
775 } else if (j->type() == TEXT_CLOSED_CAPTION && j->use()) {
781 if (dm.subtitle_language) {
782 /* Subtitle language is overridden in ISDCF metadata, primarily to handle
783 content with pre-burnt subtitles.
785 d += "-" + *dm.subtitle_language;
789 } else if (subtitle_language) {
790 /* Language is worked out from the content */
791 if (burnt_in && *subtitle_language != "XX") {
792 transform (subtitle_language->begin(), subtitle_language->end(), subtitle_language->begin(), ::tolower);
794 transform (subtitle_language->begin(), subtitle_language->end(), subtitle_language->begin(), ::toupper);
797 d += "-" + *subtitle_language;
807 if (!dm.territory.empty ()) {
808 d += "_" + dm.territory;
809 if (dm.rating.empty ()) {
812 d += "-" + dm.rating;
816 /* Count mapped audio channels */
818 list<int> mapped = mapped_audio_channels ();
820 pair<int, int> ch = audio_channel_types (mapped, audio_channels());
821 if (!ch.first && !ch.second) {
823 } else if (ch.first) {
824 d += String::compose("_%1%2", ch.first, ch.second);
827 if (audio_channels() > static_cast<int>(dcp::HI) && find(mapped.begin(), mapped.end(), dcp::HI) != mapped.end()) {
830 if (audio_channels() > static_cast<int>(dcp::VI) && find(mapped.begin(), mapped.end(), dcp::VI) != mapped.end()) {
834 d += "_" + resolution_to_string (_resolution);
836 if (!dm.studio.empty ()) {
837 d += "_" + dm.studio;
840 if (if_created_now) {
841 d += "_" + boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
843 d += "_" + boost::gregorian::to_iso_string (_isdcf_date);
846 if (!dm.facility.empty ()) {
847 d += "_" + dm.facility;
861 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
862 shared_ptr<const DCPContent> dc = dynamic_pointer_cast<const DCPContent> (i);
867 bool any_text = false;
868 for (int i = 0; i < TEXT_COUNT; ++i) {
869 if (dc->reference_text(static_cast<TextType>(i))) {
873 if (dc->reference_video() || dc->reference_audio() || any_text) {
887 /** @return name to give the DCP */
889 Film::dcp_name (bool if_created_now) const
892 if (use_isdcf_name()) {
893 return careful_string_filter (isdcf_name (if_created_now));
896 return careful_string_filter (name ());
900 Film::set_directory (boost::filesystem::path d)
907 Film::set_name (string n)
909 ChangeSignaller<Film> ch (this, NAME);
914 Film::set_use_isdcf_name (bool u)
916 ChangeSignaller<Film> ch (this, USE_ISDCF_NAME);
921 Film::set_dcp_content_type (DCPContentType const * t)
923 ChangeSignaller<Film> ch (this, DCP_CONTENT_TYPE);
924 _dcp_content_type = t;
928 Film::set_container (Ratio const * c)
930 ChangeSignaller<Film> ch (this, CONTAINER);
935 Film::set_resolution (Resolution r)
937 ChangeSignaller<Film> ch (this, RESOLUTION);
942 Film::set_j2k_bandwidth (int b)
944 ChangeSignaller<Film> ch (this, J2K_BANDWIDTH);
949 Film::set_isdcf_metadata (ISDCFMetadata m)
951 ChangeSignaller<Film> ch (this, ISDCF_METADATA);
955 /** @param f New frame rate.
956 * @param user_explicit true if this comes from a direct user instruction, false if it is from
957 * DCP-o-matic being helpful.
960 Film::set_video_frame_rate (int f, bool user_explicit)
962 ChangeSignaller<Film> ch (this, VIDEO_FRAME_RATE);
963 _video_frame_rate = f;
965 _user_explicit_video_frame_rate = true;
970 Film::set_audio_channels (int c)
972 ChangeSignaller<Film> ch (this, AUDIO_CHANNELS);
977 Film::set_three_d (bool t)
979 ChangeSignaller<Film> ch (this, THREE_D);
982 if (_three_d && _isdcf_metadata.two_d_version_of_three_d) {
983 ChangeSignaller<Film> ch (this, ISDCF_METADATA);
984 _isdcf_metadata.two_d_version_of_three_d = false;
989 Film::set_interop (bool i)
991 ChangeSignaller<Film> ch (this, INTEROP);
996 Film::set_audio_processor (AudioProcessor const * processor)
998 ChangeSignaller<Film> ch1 (this, AUDIO_PROCESSOR);
999 ChangeSignaller<Film> ch2 (this, AUDIO_CHANNELS);
1000 _audio_processor = processor;
1004 Film::set_reel_type (ReelType t)
1006 ChangeSignaller<Film> ch (this, REEL_TYPE);
1010 /** @param r Desired reel length in bytes */
1012 Film::set_reel_length (int64_t r)
1014 ChangeSignaller<Film> ch (this, REEL_LENGTH);
1019 Film::set_upload_after_make_dcp (bool u)
1021 ChangeSignaller<Film> ch (this, UPLOAD_AFTER_MAKE_DCP);
1022 _upload_after_make_dcp = u;
1026 Film::set_reencode_j2k (bool r)
1028 ChangeSignaller<Film> ch (this, REENCODE_J2K);
1033 Film::signal_change (ChangeType type, int p)
1035 signal_change (type, static_cast<Property>(p));
1039 Film::signal_change (ChangeType type, Property p)
1041 if (type == CHANGE_TYPE_DONE) {
1044 if (p == Film::CONTENT) {
1045 if (!_user_explicit_video_frame_rate) {
1046 set_video_frame_rate (best_video_frame_rate());
1050 emit (boost::bind (boost::ref (Change), type, p));
1052 if (p == Film::VIDEO_FRAME_RATE || p == Film::SEQUENCE) {
1053 /* We want to call Playlist::maybe_sequence but this must happen after the
1054 main signal emission (since the butler will see that emission and un-suspend itself).
1056 emit (boost::bind(&Playlist::maybe_sequence, _playlist.get(), shared_from_this()));
1064 Film::set_isdcf_date_today ()
1066 _isdcf_date = boost::gregorian::day_clock::local_day ();
1069 boost::filesystem::path
1070 Film::j2c_path (int reel, Frame frame, Eyes eyes, bool tmp) const
1072 boost::filesystem::path p;
1074 p /= video_identifier ();
1077 snprintf(buffer, sizeof(buffer), "%08d_%08" PRId64, reel, frame);
1080 if (eyes == EYES_LEFT) {
1082 } else if (eyes == EYES_RIGHT) {
1098 cpl_summary_compare (CPLSummary const & a, CPLSummary const & b)
1100 return a.last_write_time > b.last_write_time;
1103 /** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs.
1104 * The list will be returned in reverse order of timestamp (i.e. most recent first).
1109 if (!directory ()) {
1110 return vector<CPLSummary> ();
1113 vector<CPLSummary> out;
1115 boost::filesystem::path const dir = directory().get();
1116 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
1118 boost::filesystem::is_directory (*i) &&
1119 i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
1123 out.push_back (CPLSummary(*i));
1130 sort (out.begin(), out.end(), cpl_summary_compare);
1136 Film::set_signed (bool s)
1138 ChangeSignaller<Film> ch (this, SIGNED);
1143 Film::set_encrypted (bool e)
1145 ChangeSignaller<Film> ch (this, ENCRYPTED);
1150 Film::set_key (dcp::Key key)
1152 ChangeSignaller<Film> ch (this, KEY);
1157 Film::content () const
1159 return _playlist->content ();
1162 /** @param content Content to add.
1163 * @param disable_audio_analysis true to never do automatic audio analysis, even if it is enabled in configuration.
1166 Film::examine_and_add_content (shared_ptr<Content> content, bool disable_audio_analysis)
1168 if (dynamic_pointer_cast<FFmpegContent> (content) && _directory) {
1169 run_ffprobe (content->path(0), file("ffprobe.log"));
1172 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), content));
1174 _job_connections.push_back (
1175 j->Finished.connect (bind (&Film::maybe_add_content, this, weak_ptr<Job>(j), weak_ptr<Content>(content), disable_audio_analysis))
1178 JobManager::instance()->add (j);
1182 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c, bool disable_audio_analysis)
1184 shared_ptr<Job> job = j.lock ();
1185 if (!job || !job->finished_ok ()) {
1189 shared_ptr<Content> content = c.lock ();
1194 add_content (content);
1196 if (Config::instance()->automatic_audio_analysis() && content->audio && !disable_audio_analysis) {
1197 shared_ptr<Playlist> playlist (new Playlist);
1198 playlist->add (shared_from_this(), content);
1199 boost::signals2::connection c;
1200 JobManager::instance()->analyse_audio (
1201 shared_from_this(), playlist, false, c, bind (&Film::audio_analysis_finished, this)
1203 _audio_analysis_connections.push_back (c);
1208 Film::add_content (shared_ptr<Content> c)
1210 /* Add {video,subtitle} content after any existing {video,subtitle} content */
1212 c->set_position (shared_from_this(), _playlist->video_end(shared_from_this()));
1213 } else if (!c->text.empty()) {
1214 c->set_position (shared_from_this(), _playlist->text_end(shared_from_this()));
1217 if (_template_film) {
1218 /* Take settings from the first piece of content of c's type in _template */
1219 BOOST_FOREACH (shared_ptr<Content> i, _template_film->content()) {
1220 c->take_settings_from (i);
1224 _playlist->add (shared_from_this(), c);
1228 Film::remove_content (shared_ptr<Content> c)
1230 _playlist->remove (c);
1234 Film::move_content_earlier (shared_ptr<Content> c)
1236 _playlist->move_earlier (shared_from_this(), c);
1240 Film::move_content_later (shared_ptr<Content> c)
1242 _playlist->move_later (shared_from_this(), c);
1245 /** @return length of the film from time 0 to the last thing on the playlist */
1247 Film::length () const
1249 return _playlist->length(shared_from_this()).ceil(video_frame_rate());
1253 Film::best_video_frame_rate () const
1255 /* Don't default to anything above 30fps (make the user select that explicitly) */
1256 int best = _playlist->best_video_frame_rate ();
1264 Film::active_frame_rate_change (DCPTime t) const
1266 return _playlist->active_frame_rate_change (t, video_frame_rate ());
1270 Film::playlist_content_change (ChangeType type, weak_ptr<Content> c, int p, bool frequent)
1272 if (p == ContentProperty::VIDEO_FRAME_RATE) {
1273 signal_change (type, Film::CONTENT);
1274 } else if (p == AudioContentProperty::STREAMS) {
1275 signal_change (type, Film::NAME);
1278 if (type == CHANGE_TYPE_DONE) {
1279 emit (boost::bind (boost::ref (ContentChange), type, c, p, frequent));
1281 check_settings_consistency ();
1284 ContentChange (type, c, p, frequent);
1289 Film::playlist_change (ChangeType type)
1291 signal_change (type, CONTENT);
1292 signal_change (type, NAME);
1294 if (type == CHANGE_TYPE_DONE) {
1295 check_settings_consistency ();
1299 /** Check for (and if necessary fix) impossible settings combinations, like
1300 * video set to being referenced when it can't be.
1303 Film::check_settings_consistency ()
1305 bool change_made = false;
1306 BOOST_FOREACH (shared_ptr<Content> i, content()) {
1307 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent>(i);
1313 if (d->reference_video() && !d->can_reference_video(shared_from_this(), why_not)) {
1314 d->set_reference_video(false);
1317 if (d->reference_audio() && !d->can_reference_audio(shared_from_this(), why_not)) {
1318 d->set_reference_audio(false);
1324 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."));
1329 Film::playlist_order_changed ()
1331 /* XXX: missing PENDING */
1332 signal_change (CHANGE_TYPE_DONE, CONTENT_ORDER);
1336 Film::audio_frame_rate () const
1338 /* It seems that nobody makes 96kHz DCPs at the moment, so let's avoid them.
1345 Film::set_sequence (bool s)
1347 if (s == _sequence) {
1351 ChangeSignaller<Film> cc (this, SEQUENCE);
1353 _playlist->set_sequence (s);
1356 /** @return Size of the largest possible image in whatever resolution we are using */
1358 Film::full_frame () const
1360 switch (_resolution) {
1362 return dcp::Size (2048, 1080);
1364 return dcp::Size (4096, 2160);
1367 DCPOMATIC_ASSERT (false);
1368 return dcp::Size ();
1371 /** @return Size of the frame */
1373 Film::frame_size () const
1375 return fit_ratio_within (container()->ratio(), full_frame ());
1378 /** @param recipient KDM recipient certificate.
1379 * @param trusted_devices Certificate thumbprints of other trusted devices (can be empty).
1380 * @param cpl_file CPL filename.
1381 * @param from KDM from time expressed as a local time with an offset from UTC.
1382 * @param until KDM to time expressed as a local time with an offset from UTC.
1383 * @param formulation KDM formulation to use.
1384 * @param disable_forensic_marking_picture true to disable forensic marking of picture.
1385 * @param disable_forensic_marking_audio if not set, don't disable forensic marking of audio. If set to 0,
1386 * disable all forensic marking; if set above 0, disable forensic marking above that channel.
1390 dcp::Certificate recipient,
1391 vector<string> trusted_devices,
1392 boost::filesystem::path cpl_file,
1393 dcp::LocalTime from,
1394 dcp::LocalTime until,
1395 dcp::Formulation formulation,
1396 bool disable_forensic_marking_picture,
1397 optional<int> disable_forensic_marking_audio
1401 throw runtime_error (_("Cannot make a KDM as this project is not encrypted."));
1404 shared_ptr<const dcp::CPL> cpl (new dcp::CPL (cpl_file));
1405 shared_ptr<const dcp::CertificateChain> signer = Config::instance()->signer_chain ();
1406 if (!signer->valid ()) {
1407 throw InvalidSignerError ();
1410 /* Find keys that have been added to imported, encrypted DCP content */
1411 list<dcp::DecryptedKDMKey> imported_keys;
1412 BOOST_FOREACH (shared_ptr<Content> i, content()) {
1413 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent> (i);
1414 if (d && d->kdm()) {
1415 dcp::DecryptedKDM kdm (d->kdm().get(), Config::instance()->decryption_chain()->key().get());
1416 list<dcp::DecryptedKDMKey> keys = kdm.keys ();
1417 copy (keys.begin(), keys.end(), back_inserter (imported_keys));
1421 map<shared_ptr<const dcp::ReelMXF>, dcp::Key> keys;
1423 BOOST_FOREACH(shared_ptr<const dcp::ReelMXF> i, cpl->reel_mxfs()) {
1428 /* Get any imported key for this ID */
1430 BOOST_FOREACH (dcp::DecryptedKDMKey j, imported_keys) {
1431 if (j.id() == i->key_id().get()) {
1432 LOG_GENERAL ("Using imported key for %1", i->key_id().get());
1439 /* No imported key; it must be an asset that we encrypted */
1440 LOG_GENERAL ("Using our own key for %1", i->key_id().get());
1445 return dcp::DecryptedKDM (
1446 cpl->id(), keys, from, until, cpl->content_title_text(), cpl->content_title_text(), dcp::LocalTime().as_string()
1447 ).encrypt (signer, recipient, trusted_devices, formulation, disable_forensic_marking_picture, disable_forensic_marking_audio);
1450 /** @param screens Screens to make KDMs for.
1451 * @param cpl_file Path to CPL to make KDMs for.
1452 * @param from KDM from time expressed as a local time in the time zone of the Screen's Cinema.
1453 * @param until KDM to time expressed as a local time in the time zone of the Screen's Cinema.
1454 * @param formulation KDM formulation to use.
1455 * @param disable_forensic_marking_picture true to disable forensic marking of picture.
1456 * @param disable_forensic_marking_audio if not set, don't disable forensic marking of audio. If set to 0,
1457 * disable all forensic marking; if set above 0, disable forensic marking above that channel.
1459 list<shared_ptr<ScreenKDM> >
1461 list<shared_ptr<Screen> > screens,
1462 boost::filesystem::path cpl_file,
1463 boost::posix_time::ptime from,
1464 boost::posix_time::ptime until,
1465 dcp::Formulation formulation,
1466 bool disable_forensic_marking_picture,
1467 optional<int> disable_forensic_marking_audio
1470 list<shared_ptr<ScreenKDM> > kdms;
1472 BOOST_FOREACH (shared_ptr<Screen> i, screens) {
1474 dcp::EncryptedKDM const kdm = make_kdm (
1476 i->trusted_device_thumbprints(),
1478 dcp::LocalTime (from, i->cinema ? i->cinema->utc_offset_hour() : 0, i->cinema ? i->cinema->utc_offset_minute() : 0),
1479 dcp::LocalTime (until, i->cinema ? i->cinema->utc_offset_hour() : 0, i->cinema ? i->cinema->utc_offset_minute() : 0),
1481 disable_forensic_marking_picture,
1482 disable_forensic_marking_audio
1485 kdms.push_back (shared_ptr<ScreenKDM>(new DCPScreenKDM(i, kdm)));
1492 /** @return The approximate disk space required to encode a DCP of this film with the
1493 * current settings, in bytes.
1496 Film::required_disk_space () const
1498 return _playlist->required_disk_space (shared_from_this(), j2k_bandwidth(), audio_channels(), audio_frame_rate());
1501 /** This method checks the disk that the Film is on and tries to decide whether or not
1502 * there will be enough space to make a DCP for it. If so, true is returned; if not,
1503 * false is returned and required and available are filled in with the amount of disk space
1504 * required and available respectively (in GB).
1506 * Note: the decision made by this method isn't, of course, 100% reliable.
1509 Film::should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const
1511 /* Create a test file and see if we can hard-link it */
1512 boost::filesystem::path test = internal_video_asset_dir() / "test";
1513 boost::filesystem::path test2 = internal_video_asset_dir() / "test2";
1514 can_hard_link = true;
1515 FILE* f = fopen_boost (test, "w");
1518 boost::system::error_code ec;
1519 boost::filesystem::create_hard_link (test, test2, ec);
1521 can_hard_link = false;
1523 boost::filesystem::remove (test);
1524 boost::filesystem::remove (test2);
1527 boost::filesystem::space_info s = boost::filesystem::space (internal_video_asset_dir ());
1528 required = double (required_disk_space ()) / 1073741824.0f;
1529 if (!can_hard_link) {
1532 available = double (s.available) / 1073741824.0f;
1533 return (available - required) > 1;
1537 Film::subtitle_language () const
1539 set<string> languages;
1541 BOOST_FOREACH (shared_ptr<Content> i, content()) {
1542 BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
1543 languages.insert (j->language ());
1548 BOOST_FOREACH (string s, languages) {
1549 if (!all.empty ()) {
1559 /** @return The names of the channels that audio contents' outputs are passed into;
1560 * this is either the DCP or a AudioProcessor.
1563 Film::audio_output_names () const
1565 if (audio_processor ()) {
1566 return audio_processor()->input_names ();
1569 DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
1573 for (int i = 0; i < audio_channels(); ++i) {
1574 n.push_back (short_audio_channel_name (i));
1581 Film::repeat_content (ContentList c, int n)
1583 _playlist->repeat (shared_from_this(), c, n);
1587 Film::remove_content (ContentList c)
1589 _playlist->remove (c);
1593 Film::audio_analysis_finished ()
1599 Film::reels () const
1601 list<DCPTimePeriod> p;
1602 DCPTime const len = length();
1604 switch (reel_type ()) {
1605 case REELTYPE_SINGLE:
1606 p.push_back (DCPTimePeriod (DCPTime (), len));
1608 case REELTYPE_BY_VIDEO_CONTENT:
1610 /* Collect all reel boundaries */
1611 list<DCPTime> split_points;
1612 split_points.push_back (DCPTime());
1613 split_points.push_back (len);
1614 BOOST_FOREACH (shared_ptr<Content> c, content()) {
1616 BOOST_FOREACH (DCPTime t, c->reel_split_points(shared_from_this())) {
1617 split_points.push_back (t);
1619 split_points.push_back (c->end(shared_from_this()));
1623 split_points.sort ();
1624 split_points.unique ();
1626 /* Make them into periods */
1627 optional<DCPTime> last;
1628 BOOST_FOREACH (DCPTime t, split_points) {
1630 p.push_back (DCPTimePeriod(*last, t));
1636 case REELTYPE_BY_LENGTH:
1639 /* Integer-divide reel length by the size of one frame to give the number of frames per reel */
1640 Frame const reel_in_frames = _reel_length / ((j2k_bandwidth() / video_frame_rate()) / 8);
1641 while (current < len) {
1642 DCPTime end = min (len, current + DCPTime::from_frames (reel_in_frames, video_frame_rate ()));
1643 p.push_back (DCPTimePeriod (current, end));
1653 /** @param period A period within the DCP
1654 * @return Name of the content which most contributes to the given period.
1657 Film::content_summary (DCPTimePeriod period) const
1659 return _playlist->content_summary (shared_from_this(), period);
1663 Film::use_template (string name)
1665 _template_film.reset (new Film (optional<boost::filesystem::path>()));
1666 _template_film->read_metadata (Config::instance()->template_path (name));
1667 _use_isdcf_name = _template_film->_use_isdcf_name;
1668 _dcp_content_type = _template_film->_dcp_content_type;
1669 _container = _template_film->_container;
1670 _resolution = _template_film->_resolution;
1671 _j2k_bandwidth = _template_film->_j2k_bandwidth;
1672 _video_frame_rate = _template_film->_video_frame_rate;
1673 _signed = _template_film->_signed;
1674 _encrypted = _template_film->_encrypted;
1675 _audio_channels = _template_film->_audio_channels;
1676 _sequence = _template_film->_sequence;
1677 _three_d = _template_film->_three_d;
1678 _interop = _template_film->_interop;
1679 _audio_processor = _template_film->_audio_processor;
1680 _reel_type = _template_film->_reel_type;
1681 _reel_length = _template_film->_reel_length;
1682 _upload_after_make_dcp = _template_film->_upload_after_make_dcp;
1683 _isdcf_metadata = _template_film->_isdcf_metadata;
1686 pair<double, double>
1687 Film::speed_up_range (int dcp_frame_rate) const
1689 return _playlist->speed_up_range (dcp_frame_rate);
1693 Film::copy_from (shared_ptr<const Film> film)
1695 read_metadata (film->file (metadata_file));
1699 Film::references_dcp_video () const
1701 BOOST_FOREACH (shared_ptr<Content> i, _playlist->content()) {
1702 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent>(i);
1703 if (d && d->reference_video()) {
1712 Film::references_dcp_audio () const
1714 BOOST_FOREACH (shared_ptr<Content> i, _playlist->content()) {
1715 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent>(i);
1716 if (d && d->reference_audio()) {
1725 Film::closed_caption_tracks () const
1727 list<DCPTextTrack> tt;
1728 BOOST_FOREACH (shared_ptr<Content> i, content()) {
1729 BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
1730 /* XXX: Empty DCPTextTrack ends up being a magic value here - the "unknown" or "not specified" track */
1731 DCPTextTrack dtt = j->dcp_track().get_value_or(DCPTextTrack());
1732 if (j->type() == TEXT_CLOSED_CAPTION && find(tt.begin(), tt.end(), dtt) == tt.end()) {
1742 Film::set_marker (dcp::Marker type, DCPTime time)
1744 ChangeSignaller<Film> ch (this, MARKERS);
1745 _markers[type] = time;
1749 Film::unset_marker (dcp::Marker type)
1751 ChangeSignaller<Film> ch (this, MARKERS);
1752 _markers.erase (type);
1756 Film::set_ratings (vector<dcp::Rating> r)
1758 ChangeSignaller<Film> ch (this, RATINGS);
1763 Film::marker (dcp::Marker type) const
1765 map<dcp::Marker, DCPTime>::const_iterator i = _markers.find (type);
1766 if (i == _markers.end()) {
1767 return optional<DCPTime>();
1772 shared_ptr<InfoFileHandle>
1773 Film::info_file_handle (DCPTimePeriod period, bool read) const
1775 return shared_ptr<InfoFileHandle> (new InfoFileHandle(_info_file_mutex, info_file(period), read));
1778 InfoFileHandle::InfoFileHandle (boost::mutex& mutex, boost::filesystem::path file, bool read)
1783 _handle = fopen_boost (file, "rb");
1785 throw OpenFileError (file, errno, OpenFileError::READ);
1788 bool const exists = boost::filesystem::exists (file);
1790 _handle = fopen_boost (file, "r+b");
1792 _handle = fopen_boost (file, "wb");
1796 throw OpenFileError (file, errno, exists ? OpenFileError::READ_WRITE : OpenFileError::WRITE);
1801 InfoFileHandle::~InfoFileHandle ()