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;
96 using boost::shared_ptr;
97 using boost::weak_ptr;
98 using boost::dynamic_pointer_cast;
99 using boost::optional;
100 using boost::is_any_of;
101 using dcp::raw_convert;
103 string const Film::metadata_file = "metadata.xml";
106 * AudioMapping XML changed.
108 * Subtitle offset changed to subtitle y offset, and subtitle x offset added.
110 * Use <Scale> tag in <VideoContent> rather than <Ratio>.
114 * Subtitle X and Y scale.
116 * Bumped to 32 for 2.0 branch; some times are expressed in Times rather
120 * Changed <Period> to <Subtitle> in FFmpegSubtitleStream
122 * Content only contains audio/subtitle-related tags if those things
125 * VideoFrameType in VideoContent is a string rather than an integer.
127 * EffectColour rather than OutlineColour in Subtitle.
129 * TextContent can be in a Caption tag, and some of the tag names
130 * have had Subtitle prefixes or suffixes removed.
132 int const Film::current_state_version = 37;
134 /** Construct a Film object in a given directory.
136 * @param dir Film directory.
139 Film::Film (optional<boost::filesystem::path> dir)
140 : _playlist (new Playlist)
141 , _use_isdcf_name (true)
142 , _dcp_content_type (Config::instance()->default_dcp_content_type ())
143 , _container (Config::instance()->default_container ())
144 , _resolution (RESOLUTION_2K)
147 , _context_id (dcp::make_uuid ())
148 , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
149 , _isdcf_metadata (Config::instance()->default_isdcf_metadata ())
150 , _video_frame_rate (24)
151 , _audio_channels (Config::instance()->default_dcp_audio_channels ())
154 , _interop (Config::instance()->default_interop ())
155 , _audio_processor (0)
156 , _reel_type (REELTYPE_SINGLE)
157 , _reel_length (2000000000)
158 , _upload_after_make_dcp (Config::instance()->default_upload_after_make_dcp())
159 , _reencode_j2k (false)
160 , _user_explicit_video_frame_rate (false)
161 , _state_version (current_state_version)
164 set_isdcf_date_today ();
166 _playlist_change_connection = _playlist->Change.connect (bind (&Film::playlist_change, this, _1));
167 _playlist_order_changed_connection = _playlist->OrderChanged.connect (bind (&Film::playlist_order_changed, this));
168 _playlist_content_change_connection = _playlist->ContentChange.connect (bind (&Film::playlist_content_change, this, _1, _2, _3, _4));
171 /* Make state.directory a complete path without ..s (where possible)
172 (Code swiped from Adam Bowen on stackoverflow)
173 XXX: couldn't/shouldn't this just be boost::filesystem::canonical?
176 boost::filesystem::path p (boost::filesystem::system_complete (dir.get()));
177 boost::filesystem::path result;
178 for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
180 if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
183 result = result.parent_path ();
185 } else if (*i != ".") {
190 set_directory (result.make_preferred ());
194 _log.reset (new FileLog (file ("log")));
196 _log.reset (new NullLog);
199 _playlist->set_sequence (_sequence);
204 BOOST_FOREACH (boost::signals2::connection& i, _job_connections) {
208 BOOST_FOREACH (boost::signals2::connection& i, _audio_analysis_connections) {
214 Film::video_identifier () const
216 DCPOMATIC_ASSERT (container ());
218 string s = container()->id()
219 + "_" + resolution_to_string (_resolution)
220 + "_" + _playlist->video_identifier()
221 + "_" + raw_convert<string>(_video_frame_rate)
222 + "_" + raw_convert<string>(j2k_bandwidth());
243 /** @return The file to write video frame info to */
244 boost::filesystem::path
245 Film::info_file (DCPTimePeriod period) const
247 boost::filesystem::path p;
249 p /= video_identifier () + "_" + raw_convert<string> (period.from.get()) + "_" + raw_convert<string> (period.to.get());
253 boost::filesystem::path
254 Film::internal_video_asset_dir () const
256 return dir ("video");
259 boost::filesystem::path
260 Film::internal_video_asset_filename (DCPTimePeriod p) const
262 return video_identifier() + "_" + raw_convert<string> (p.from.get()) + "_" + raw_convert<string> (p.to.get()) + ".mxf";
265 boost::filesystem::path
266 Film::audio_analysis_path (shared_ptr<const Playlist> playlist) const
268 boost::filesystem::path p = dir ("analysis");
271 BOOST_FOREACH (shared_ptr<Content> i, playlist->content ()) {
276 digester.add (i->digest ());
277 digester.add (i->audio->mapping().digest ());
278 if (playlist->content().size() != 1) {
279 /* Analyses should be considered equal regardless of gain
280 if they were made from just one piece of content. This
281 is because we can fake any gain change in a single-content
282 analysis at the plotting stage rather than having to
285 digester.add (i->audio->gain ());
289 if (audio_processor ()) {
290 digester.add (audio_processor()->id ());
293 digester.add (audio_channels());
295 p /= digester.get ();
299 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
303 if (dcp_name().find ("/") != string::npos) {
304 throw BadSettingError (_("name"), _("Cannot contain slashes"));
307 if (container() == 0) {
308 throw MissingSettingError (_("container"));
311 if (content().empty()) {
312 throw runtime_error (_("You must add some content to the DCP before creating it"));
315 if (dcp_content_type() == 0) {
316 throw MissingSettingError (_("content type"));
319 if (name().empty()) {
323 BOOST_FOREACH (shared_ptr<const Content> i, content ()) {
324 if (!i->paths_valid()) {
325 throw runtime_error (_("some of your content is missing"));
327 shared_ptr<const DCPContent> dcp = dynamic_pointer_cast<const DCPContent> (i);
328 if (dcp && dcp->needs_kdm()) {
329 throw runtime_error (_("Some of your content needs a KDM"));
331 if (dcp && dcp->needs_assets()) {
332 throw runtime_error (_("Some of your content needs an OV"));
336 set_isdcf_date_today ();
338 BOOST_FOREACH (string i, environment_info ()) {
342 BOOST_FOREACH (shared_ptr<const Content> i, content ()) {
343 LOG_GENERAL ("Content: %1", i->technical_summary());
345 LOG_GENERAL ("DCP video rate %1 fps", video_frame_rate());
346 if (Config::instance()->only_servers_encode ()) {
347 LOG_GENERAL_NC ("0 threads: ONLY SERVERS SET TO ENCODE");
349 LOG_GENERAL ("%1 threads", Config::instance()->master_encoding_threads());
351 LOG_GENERAL ("J2K bandwidth %1", j2k_bandwidth());
353 shared_ptr<TranscodeJob> tj (new TranscodeJob (shared_from_this()));
354 tj->set_encoder (shared_ptr<Encoder> (new DCPEncoder (shared_from_this(), tj)));
355 shared_ptr<CheckContentChangeJob> cc (new CheckContentChangeJob (shared_from_this(), tj));
356 JobManager::instance()->add (cc);
359 /** Start a job to send our DCP to the configured TMS */
361 Film::send_dcp_to_tms ()
363 shared_ptr<Job> j (new UploadJob (shared_from_this()));
364 JobManager::instance()->add (j);
367 shared_ptr<xmlpp::Document>
368 Film::metadata (bool with_content_paths) const
370 shared_ptr<xmlpp::Document> doc (new xmlpp::Document);
371 xmlpp::Element* root = doc->create_root_node ("Metadata");
373 root->add_child("Version")->add_child_text (raw_convert<string> (current_state_version));
374 root->add_child("Name")->add_child_text (_name);
375 root->add_child("UseISDCFName")->add_child_text (_use_isdcf_name ? "1" : "0");
377 if (_dcp_content_type) {
378 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->isdcf_name ());
382 root->add_child("Container")->add_child_text (_container->id ());
385 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
386 root->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
387 _isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
388 root->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
389 root->add_child("ISDCFDate")->add_child_text (boost::gregorian::to_iso_string (_isdcf_date));
390 root->add_child("AudioChannels")->add_child_text (raw_convert<string> (_audio_channels));
391 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
392 root->add_child("Sequence")->add_child_text (_sequence ? "1" : "0");
393 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
394 root->add_child("Signed")->add_child_text (_signed ? "1" : "0");
395 root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
396 root->add_child("Key")->add_child_text (_key.hex ());
397 root->add_child("ContextID")->add_child_text (_context_id);
398 if (_audio_processor) {
399 root->add_child("AudioProcessor")->add_child_text (_audio_processor->id ());
401 root->add_child("ReelType")->add_child_text (raw_convert<string> (static_cast<int> (_reel_type)));
402 root->add_child("ReelLength")->add_child_text (raw_convert<string> (_reel_length));
403 root->add_child("UploadAfterMakeDCP")->add_child_text (_upload_after_make_dcp ? "1" : "0");
404 root->add_child("ReencodeJ2K")->add_child_text (_reencode_j2k ? "1" : "0");
405 root->add_child("UserExplicitVideoFrameRate")->add_child_text(_user_explicit_video_frame_rate ? "1" : "0");
406 for (map<dcp::Marker, DCPTime>::const_iterator i = _markers.begin(); i != _markers.end(); ++i) {
407 xmlpp::Element* m = root->add_child("Marker");
408 m->set_attribute("Type", dcp::marker_to_string(i->first));
409 m->add_child_text(raw_convert<string>(i->second.get()));
411 _playlist->as_xml (root->add_child ("Playlist"), with_content_paths);
417 Film::write_metadata (boost::filesystem::path path) const
419 shared_ptr<xmlpp::Document> doc = metadata ();
420 doc->write_to_file_formatted (path.string());
423 /** Write state to our `metadata' file */
425 Film::write_metadata () const
427 DCPOMATIC_ASSERT (directory());
428 boost::filesystem::create_directories (directory().get());
429 shared_ptr<xmlpp::Document> doc = metadata ();
430 doc->write_to_file_formatted (file(metadata_file).string ());
434 /** Write a template from this film */
436 Film::write_template (boost::filesystem::path path) const
438 boost::filesystem::create_directories (path.parent_path());
439 shared_ptr<xmlpp::Document> doc = metadata (false);
440 doc->write_to_file_formatted (path.string ());
443 /** Read state from our metadata file.
444 * @return Notes about things that the user should know about, or empty.
447 Film::read_metadata (optional<boost::filesystem::path> path)
450 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file (metadata_file))) {
451 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!"));
454 path = file (metadata_file);
457 cxml::Document f ("Metadata");
458 f.read_file (path.get ());
460 _state_version = f.number_child<int> ("Version");
461 if (_state_version > current_state_version) {
462 throw runtime_error (_("This film was created with a newer version of DCP-o-matic, and it cannot be loaded into this version. Sorry!"));
463 } else if (_state_version < current_state_version) {
464 /* This is an older version; save a copy (if we haven't already) */
465 boost::filesystem::path const older = path->parent_path() / String::compose("metadata.%1.xml", _state_version);
466 if (!boost::filesystem::is_regular_file(older)) {
468 boost::filesystem::copy_file(*path, older);
470 /* Never mind; at least we tried */
475 _name = f.string_child ("Name");
476 if (_state_version >= 9) {
477 _use_isdcf_name = f.bool_child ("UseISDCFName");
478 _isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
479 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("ISDCFDate"));
481 _use_isdcf_name = f.bool_child ("UseDCIName");
482 _isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
483 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
488 optional<string> c = f.optional_string_child ("DCPContentType");
490 _dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
495 optional<string> c = f.optional_string_child ("Container");
497 _container = Ratio::from_id (c.get ());
501 _resolution = string_to_resolution (f.string_child ("Resolution"));
502 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
503 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
504 _signed = f.optional_bool_child("Signed").get_value_or (true);
505 _encrypted = f.bool_child ("Encrypted");
506 _audio_channels = f.number_child<int> ("AudioChannels");
507 /* We used to allow odd numbers (and zero) channels, but it's just not worth
510 if (_audio_channels == 0) {
512 } else if ((_audio_channels % 2) == 1) {
516 if (f.optional_bool_child("SequenceVideo")) {
517 _sequence = f.bool_child("SequenceVideo");
519 _sequence = f.bool_child("Sequence");
522 _three_d = f.bool_child ("ThreeD");
523 _interop = f.bool_child ("Interop");
524 _key = dcp::Key (f.string_child ("Key"));
525 _context_id = f.optional_string_child("ContextID").get_value_or (dcp::make_uuid ());
527 if (f.optional_string_child ("AudioProcessor")) {
528 _audio_processor = AudioProcessor::from_id (f.string_child ("AudioProcessor"));
530 _audio_processor = 0;
533 _reel_type = static_cast<ReelType> (f.optional_number_child<int>("ReelType").get_value_or (static_cast<int>(REELTYPE_SINGLE)));
534 _reel_length = f.optional_number_child<int64_t>("ReelLength").get_value_or (2000000000);
535 _upload_after_make_dcp = f.optional_bool_child("UploadAfterMakeDCP").get_value_or (false);
536 _reencode_j2k = f.optional_bool_child("ReencodeJ2K").get_value_or(false);
537 _user_explicit_video_frame_rate = f.optional_bool_child("UserExplicitVideoFrameRate").get_value_or(false);
539 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("Marker")) {
540 _markers[dcp::marker_from_string(i->string_attribute("Type"))] = DCPTime(dcp::raw_convert<DCPTime::Type>(i->content()));
544 /* This method is the only one that can return notes (so far) */
545 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
547 /* Write backtraces to this film's directory, until another film is loaded */
549 set_backtrace_file (file ("backtrace.txt"));
556 /** Given a directory name, return its full path within the Film's directory.
557 * @param d directory name within the Film's directory.
558 * @param create true to create the directory (and its parents) if they do not exist.
560 boost::filesystem::path
561 Film::dir (boost::filesystem::path d, bool create) const
563 DCPOMATIC_ASSERT (_directory);
565 boost::filesystem::path p;
566 p /= _directory.get();
570 boost::filesystem::create_directories (p);
576 /** Given a file or directory name, return its full path within the Film's directory.
577 * Any required parent directories will be created.
579 boost::filesystem::path
580 Film::file (boost::filesystem::path f) const
582 DCPOMATIC_ASSERT (_directory);
584 boost::filesystem::path p;
585 p /= _directory.get();
588 boost::filesystem::create_directories (p.parent_path ());
594 Film::mapped_audio_channels () const
598 if (audio_processor ()) {
599 /* Processors are mapped 1:1 to DCP outputs so we can work out mappings from there */
600 for (int i = 0; i < audio_processor()->out_channels(); ++i) {
601 mapped.push_back (i);
604 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
606 list<int> c = i->audio->mapping().mapped_output_channels ();
607 copy (c.begin(), c.end(), back_inserter (mapped));
618 /** @return a ISDCF-compliant name for a DCP of this film */
620 Film::isdcf_name (bool if_created_now) const
624 string raw_name = name ();
626 /* Split the raw name up into words */
627 vector<string> words;
628 split (words, raw_name, is_any_of (" _-"));
632 /* Add each word to fixed_name */
633 for (vector<string>::const_iterator i = words.begin(); i != words.end(); ++i) {
636 /* First letter is always capitalised */
637 w[0] = toupper (w[0]);
639 /* Count caps in w */
641 for (size_t i = 0; i < w.size(); ++i) {
642 if (isupper (w[i])) {
647 /* If w is all caps make the rest of it lower case, otherwise
650 if (caps == w.size ()) {
651 for (size_t i = 1; i < w.size(); ++i) {
652 w[i] = tolower (w[i]);
656 for (size_t i = 0; i < w.size(); ++i) {
661 if (fixed_name.length() > 14) {
662 fixed_name = fixed_name.substr (0, 14);
667 if (dcp_content_type()) {
668 d += "_" + dcp_content_type()->isdcf_name();
669 d += "-" + raw_convert<string>(isdcf_metadata().content_version);
672 ISDCFMetadata const dm = isdcf_metadata ();
674 if (dm.temp_version) {
678 if (dm.pre_release) {
686 if (!dm.chain.empty ()) {
694 if (dm.two_d_version_of_three_d) {
698 if (!dm.mastered_luminance.empty ()) {
699 d += "-" + dm.mastered_luminance;
702 if (video_frame_rate() != 24) {
703 d += "-" + raw_convert<string>(video_frame_rate());
707 d += "_" + container()->isdcf_name();
710 /* XXX: this uses the first bit of content only */
712 /* Interior aspect ratio. The standard says we don't do this for trailers, for some strange reason */
713 if (dcp_content_type() && dcp_content_type()->libdcp_kind() != dcp::TRAILER) {
714 Ratio const * content_ratio = 0;
715 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
717 /* Here's the first piece of video content */
718 if (i->video->scale().ratio ()) {
719 content_ratio = i->video->scale().ratio ();
721 content_ratio = Ratio::from_ratio (i->video->size().ratio ());
727 if (content_ratio && content_ratio != container()) {
728 /* This needs to be the numeric version of the ratio, and ::id() is close enough */
729 d += "-" + content_ratio->id();
733 if (!dm.audio_language.empty ()) {
734 d += "_" + dm.audio_language;
736 /* I'm not clear on the precise details of the convention for CCAP labelling;
737 for now I'm just appending -CCAP if we have any closed captions.
740 optional<string> subtitle_language;
741 bool burnt_in = true;
743 BOOST_FOREACH (shared_ptr<Content> i, content()) {
744 BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
745 if (j->type() == TEXT_OPEN_SUBTITLE && j->use()) {
746 subtitle_language = j->language ();
750 } else if (j->type() == TEXT_CLOSED_CAPTION && j->use()) {
756 if (dm.subtitle_language) {
757 /* Subtitle language is overridden in ISDCF metadata, primarily to handle
758 content with pre-burnt subtitles.
760 d += "-" + *dm.subtitle_language;
764 } else if (subtitle_language) {
765 /* Language is worked out from the content */
766 if (burnt_in && *subtitle_language != "XX") {
767 transform (subtitle_language->begin(), subtitle_language->end(), subtitle_language->begin(), ::tolower);
769 transform (subtitle_language->begin(), subtitle_language->end(), subtitle_language->begin(), ::toupper);
772 d += "-" + *subtitle_language;
782 if (!dm.territory.empty ()) {
783 d += "_" + dm.territory;
784 if (dm.rating.empty ()) {
787 d += "-" + dm.rating;
791 /* Count mapped audio channels */
793 pair<int, int> ch = audio_channel_types (mapped_audio_channels(), audio_channels());
794 if (!ch.first && !ch.second) {
796 } else if (ch.first) {
797 d += String::compose("_%1%2", ch.first, ch.second);
802 d += "_" + resolution_to_string (_resolution);
804 if (!dm.studio.empty ()) {
805 d += "_" + dm.studio;
808 if (if_created_now) {
809 d += "_" + boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
811 d += "_" + boost::gregorian::to_iso_string (_isdcf_date);
814 if (!dm.facility.empty ()) {
815 d += "_" + dm.facility;
829 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
830 shared_ptr<const DCPContent> dc = dynamic_pointer_cast<const DCPContent> (i);
835 bool any_text = false;
836 for (int i = 0; i < TEXT_COUNT; ++i) {
837 if (dc->reference_text(static_cast<TextType>(i))) {
841 if (dc->reference_video() || dc->reference_audio() || any_text) {
855 /** @return name to give the DCP */
857 Film::dcp_name (bool if_created_now) const
860 if (use_isdcf_name()) {
861 return careful_string_filter (isdcf_name (if_created_now));
864 return careful_string_filter (name ());
868 Film::set_directory (boost::filesystem::path d)
875 Film::set_name (string n)
877 ChangeSignaller<Film> ch (this, NAME);
882 Film::set_use_isdcf_name (bool u)
884 ChangeSignaller<Film> ch (this, USE_ISDCF_NAME);
889 Film::set_dcp_content_type (DCPContentType const * t)
891 ChangeSignaller<Film> ch (this, DCP_CONTENT_TYPE);
892 _dcp_content_type = t;
896 Film::set_container (Ratio const * c)
898 ChangeSignaller<Film> ch (this, CONTAINER);
903 Film::set_resolution (Resolution r)
905 ChangeSignaller<Film> ch (this, RESOLUTION);
910 Film::set_j2k_bandwidth (int b)
912 ChangeSignaller<Film> ch (this, J2K_BANDWIDTH);
917 Film::set_isdcf_metadata (ISDCFMetadata m)
919 ChangeSignaller<Film> ch (this, ISDCF_METADATA);
923 /** @param f New frame rate.
924 * @param user_explicit true if this comes from a direct user instruction, false if it is from
925 * DCP-o-matic being helpful.
928 Film::set_video_frame_rate (int f, bool user_explicit)
930 ChangeSignaller<Film> ch (this, VIDEO_FRAME_RATE);
931 _video_frame_rate = f;
933 _user_explicit_video_frame_rate = true;
938 Film::set_audio_channels (int c)
940 ChangeSignaller<Film> ch (this, AUDIO_CHANNELS);
945 Film::set_three_d (bool t)
947 ChangeSignaller<Film> ch (this, THREE_D);
950 if (_three_d && _isdcf_metadata.two_d_version_of_three_d) {
951 ChangeSignaller<Film> ch (this, ISDCF_METADATA);
952 _isdcf_metadata.two_d_version_of_three_d = false;
957 Film::set_interop (bool i)
959 ChangeSignaller<Film> ch (this, INTEROP);
964 Film::set_audio_processor (AudioProcessor const * processor)
966 ChangeSignaller<Film> ch1 (this, AUDIO_PROCESSOR);
967 ChangeSignaller<Film> ch2 (this, AUDIO_CHANNELS);
968 _audio_processor = processor;
972 Film::set_reel_type (ReelType t)
974 ChangeSignaller<Film> ch (this, REEL_TYPE);
978 /** @param r Desired reel length in bytes */
980 Film::set_reel_length (int64_t r)
982 ChangeSignaller<Film> ch (this, REEL_LENGTH);
987 Film::set_upload_after_make_dcp (bool u)
989 ChangeSignaller<Film> ch (this, UPLOAD_AFTER_MAKE_DCP);
990 _upload_after_make_dcp = u;
994 Film::set_reencode_j2k (bool r)
996 ChangeSignaller<Film> ch (this, REENCODE_J2K);
1001 Film::signal_change (ChangeType type, int p)
1003 signal_change (type, static_cast<Property>(p));
1007 Film::signal_change (ChangeType type, Property p)
1009 if (type == CHANGE_TYPE_DONE) {
1012 if (p == Film::CONTENT) {
1013 if (!_user_explicit_video_frame_rate) {
1014 set_video_frame_rate (best_video_frame_rate());
1018 emit (boost::bind (boost::ref (Change), type, p));
1020 if (p == Film::VIDEO_FRAME_RATE || p == Film::SEQUENCE) {
1021 /* We want to call Playlist::maybe_sequence but this must happen after the
1022 main signal emission (since the butler will see that emission and un-suspend itself).
1024 emit (boost::bind(&Playlist::maybe_sequence, _playlist.get(), shared_from_this()));
1032 Film::set_isdcf_date_today ()
1034 _isdcf_date = boost::gregorian::day_clock::local_day ();
1037 boost::filesystem::path
1038 Film::j2c_path (int reel, Frame frame, Eyes eyes, bool tmp) const
1040 boost::filesystem::path p;
1042 p /= video_identifier ();
1045 snprintf(buffer, sizeof(buffer), "%08d_%08" PRId64, reel, frame);
1048 if (eyes == EYES_LEFT) {
1050 } else if (eyes == EYES_RIGHT) {
1066 cpl_summary_compare (CPLSummary const & a, CPLSummary const & b)
1068 return a.last_write_time > b.last_write_time;
1071 /** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs.
1072 * The list will be returned in reverse order of timestamp (i.e. most recent first).
1077 if (!directory ()) {
1078 return vector<CPLSummary> ();
1081 vector<CPLSummary> out;
1083 boost::filesystem::path const dir = directory().get();
1084 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
1086 boost::filesystem::is_directory (*i) &&
1087 i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
1091 out.push_back (CPLSummary(*i));
1098 sort (out.begin(), out.end(), cpl_summary_compare);
1104 Film::set_signed (bool s)
1106 ChangeSignaller<Film> ch (this, SIGNED);
1111 Film::set_encrypted (bool e)
1113 ChangeSignaller<Film> ch (this, ENCRYPTED);
1118 Film::set_key (dcp::Key key)
1120 ChangeSignaller<Film> ch (this, KEY);
1125 Film::content () const
1127 return _playlist->content ();
1130 /** @param content Content to add.
1131 * @param disable_audio_analysis true to never do automatic audio analysis, even if it is enabled in configuration.
1134 Film::examine_and_add_content (shared_ptr<Content> content, bool disable_audio_analysis)
1136 if (dynamic_pointer_cast<FFmpegContent> (content) && _directory) {
1137 run_ffprobe (content->path(0), file("ffprobe.log"));
1140 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), content));
1142 _job_connections.push_back (
1143 j->Finished.connect (bind (&Film::maybe_add_content, this, weak_ptr<Job>(j), weak_ptr<Content>(content), disable_audio_analysis))
1146 JobManager::instance()->add (j);
1150 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c, bool disable_audio_analysis)
1152 shared_ptr<Job> job = j.lock ();
1153 if (!job || !job->finished_ok ()) {
1157 shared_ptr<Content> content = c.lock ();
1162 add_content (content);
1164 if (Config::instance()->automatic_audio_analysis() && content->audio && !disable_audio_analysis) {
1165 shared_ptr<Playlist> playlist (new Playlist);
1166 playlist->add (shared_from_this(), content);
1167 boost::signals2::connection c;
1168 JobManager::instance()->analyse_audio (
1169 shared_from_this(), playlist, false, c, bind (&Film::audio_analysis_finished, this)
1171 _audio_analysis_connections.push_back (c);
1176 Film::add_content (shared_ptr<Content> c)
1178 /* Add {video,subtitle} content after any existing {video,subtitle} content */
1180 c->set_position (shared_from_this(), _playlist->video_end(shared_from_this()));
1181 } else if (!c->text.empty()) {
1182 c->set_position (shared_from_this(), _playlist->text_end(shared_from_this()));
1185 if (_template_film) {
1186 /* Take settings from the first piece of content of c's type in _template */
1187 BOOST_FOREACH (shared_ptr<Content> i, _template_film->content()) {
1188 c->take_settings_from (i);
1192 _playlist->add (shared_from_this(), c);
1196 Film::remove_content (shared_ptr<Content> c)
1198 _playlist->remove (c);
1202 Film::move_content_earlier (shared_ptr<Content> c)
1204 _playlist->move_earlier (shared_from_this(), c);
1208 Film::move_content_later (shared_ptr<Content> c)
1210 _playlist->move_later (shared_from_this(), c);
1213 /** @return length of the film from time 0 to the last thing on the playlist */
1215 Film::length () const
1217 return _playlist->length(shared_from_this()).ceil(video_frame_rate());
1221 Film::best_video_frame_rate () const
1223 /* Don't default to anything above 30fps (make the user select that explicitly) */
1224 int best = _playlist->best_video_frame_rate ();
1232 Film::active_frame_rate_change (DCPTime t) const
1234 return _playlist->active_frame_rate_change (t, video_frame_rate ());
1238 Film::playlist_content_change (ChangeType type, weak_ptr<Content> c, int p, bool frequent)
1240 if (p == ContentProperty::VIDEO_FRAME_RATE) {
1241 signal_change (type, Film::CONTENT);
1242 } else if (p == AudioContentProperty::STREAMS) {
1243 signal_change (type, Film::NAME);
1246 if (type == CHANGE_TYPE_DONE) {
1247 emit (boost::bind (boost::ref (ContentChange), type, c, p, frequent));
1249 ContentChange (type, c, p, frequent);
1254 Film::playlist_change (ChangeType type)
1256 signal_change (type, CONTENT);
1257 signal_change (type, NAME);
1259 if (type == CHANGE_TYPE_DONE) {
1260 /* Check that this change hasn't made our settings inconsistent */
1261 bool change_made = false;
1262 BOOST_FOREACH (shared_ptr<Content> i, content()) {
1263 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent>(i);
1269 if (d->reference_video() && !d->can_reference_video(shared_from_this(), why_not)) {
1270 d->set_reference_video(false);
1273 if (d->reference_audio() && !d->can_reference_audio(shared_from_this(), why_not)) {
1274 d->set_reference_audio(false);
1280 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."));
1286 Film::playlist_order_changed ()
1288 /* XXX: missing PENDING */
1289 signal_change (CHANGE_TYPE_DONE, CONTENT_ORDER);
1293 Film::audio_frame_rate () const
1295 /* It seems that nobody makes 96kHz DCPs at the moment, so let's avoid them.
1302 Film::set_sequence (bool s)
1304 if (s == _sequence) {
1308 ChangeSignaller<Film> cc (this, SEQUENCE);
1310 _playlist->set_sequence (s);
1313 /** @return Size of the largest possible image in whatever resolution we are using */
1315 Film::full_frame () const
1317 switch (_resolution) {
1319 return dcp::Size (2048, 1080);
1321 return dcp::Size (4096, 2160);
1324 DCPOMATIC_ASSERT (false);
1325 return dcp::Size ();
1328 /** @return Size of the frame */
1330 Film::frame_size () const
1332 return fit_ratio_within (container()->ratio(), full_frame ());
1335 /** @param recipient KDM recipient certificate.
1336 * @param trusted_devices Certificate thumbprints of other trusted devices (can be empty).
1337 * @param cpl_file CPL filename.
1338 * @param from KDM from time expressed as a local time with an offset from UTC.
1339 * @param until KDM to time expressed as a local time with an offset from UTC.
1340 * @param formulation KDM formulation to use.
1341 * @param disable_forensic_marking_picture true to disable forensic marking of picture.
1342 * @param disable_forensic_marking_audio if not set, don't disable forensic marking of audio. If set to 0,
1343 * disable all forensic marking; if set above 0, disable forensic marking above that channel.
1347 dcp::Certificate recipient,
1348 vector<string> trusted_devices,
1349 boost::filesystem::path cpl_file,
1350 dcp::LocalTime from,
1351 dcp::LocalTime until,
1352 dcp::Formulation formulation,
1353 bool disable_forensic_marking_picture,
1354 optional<int> disable_forensic_marking_audio
1358 throw runtime_error (_("Cannot make a KDM as this project is not encrypted."));
1361 shared_ptr<const dcp::CPL> cpl (new dcp::CPL (cpl_file));
1362 shared_ptr<const dcp::CertificateChain> signer = Config::instance()->signer_chain ();
1363 if (!signer->valid ()) {
1364 throw InvalidSignerError ();
1367 /* Find keys that have been added to imported, encrypted DCP content */
1368 list<dcp::DecryptedKDMKey> imported_keys;
1369 BOOST_FOREACH (shared_ptr<Content> i, content()) {
1370 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent> (i);
1371 if (d && d->kdm()) {
1372 dcp::DecryptedKDM kdm (d->kdm().get(), Config::instance()->decryption_chain()->key().get());
1373 list<dcp::DecryptedKDMKey> keys = kdm.keys ();
1374 copy (keys.begin(), keys.end(), back_inserter (imported_keys));
1378 map<shared_ptr<const dcp::ReelMXF>, dcp::Key> keys;
1380 BOOST_FOREACH(shared_ptr<const dcp::ReelMXF> i, cpl->reel_mxfs()) {
1385 /* Get any imported key for this ID */
1387 BOOST_FOREACH (dcp::DecryptedKDMKey j, imported_keys) {
1388 if (j.id() == i->key_id().get()) {
1389 LOG_GENERAL ("Using imported key for %1", i->key_id().get());
1396 /* No imported key; it must be an asset that we encrypted */
1397 LOG_GENERAL ("Using our own key for %1", i->key_id().get());
1402 return dcp::DecryptedKDM (
1403 cpl->id(), keys, from, until, cpl->content_title_text(), cpl->content_title_text(), dcp::LocalTime().as_string()
1404 ).encrypt (signer, recipient, trusted_devices, formulation, disable_forensic_marking_picture, disable_forensic_marking_audio);
1407 /** @param screens Screens to make KDMs for.
1408 * @param cpl_file Path to CPL to make KDMs for.
1409 * @param from KDM from time expressed as a local time in the time zone of the Screen's Cinema.
1410 * @param until KDM to time expressed as a local time in the time zone of the Screen's Cinema.
1411 * @param formulation KDM formulation to use.
1412 * @param disable_forensic_marking_picture true to disable forensic marking of picture.
1413 * @param disable_forensic_marking_audio if not set, don't disable forensic marking of audio. If set to 0,
1414 * disable all forensic marking; if set above 0, disable forensic marking above that channel.
1418 list<shared_ptr<Screen> > screens,
1419 boost::filesystem::path cpl_file,
1420 boost::posix_time::ptime from,
1421 boost::posix_time::ptime until,
1422 dcp::Formulation formulation,
1423 bool disable_forensic_marking_picture,
1424 optional<int> disable_forensic_marking_audio
1427 list<ScreenKDM> kdms;
1429 BOOST_FOREACH (shared_ptr<Screen> i, screens) {
1431 dcp::EncryptedKDM const kdm = make_kdm (
1433 i->trusted_device_thumbprints(),
1435 dcp::LocalTime (from, i->cinema ? i->cinema->utc_offset_hour() : 0, i->cinema ? i->cinema->utc_offset_minute() : 0),
1436 dcp::LocalTime (until, i->cinema ? i->cinema->utc_offset_hour() : 0, i->cinema ? i->cinema->utc_offset_minute() : 0),
1438 disable_forensic_marking_picture,
1439 disable_forensic_marking_audio
1442 kdms.push_back (ScreenKDM (i, kdm));
1449 /** @return The approximate disk space required to encode a DCP of this film with the
1450 * current settings, in bytes.
1453 Film::required_disk_space () const
1455 return _playlist->required_disk_space (shared_from_this(), j2k_bandwidth(), audio_channels(), audio_frame_rate());
1458 /** This method checks the disk that the Film is on and tries to decide whether or not
1459 * there will be enough space to make a DCP for it. If so, true is returned; if not,
1460 * false is returned and required and available are filled in with the amount of disk space
1461 * required and available respectively (in GB).
1463 * Note: the decision made by this method isn't, of course, 100% reliable.
1466 Film::should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const
1468 /* Create a test file and see if we can hard-link it */
1469 boost::filesystem::path test = internal_video_asset_dir() / "test";
1470 boost::filesystem::path test2 = internal_video_asset_dir() / "test2";
1471 can_hard_link = true;
1472 FILE* f = fopen_boost (test, "w");
1475 boost::system::error_code ec;
1476 boost::filesystem::create_hard_link (test, test2, ec);
1478 can_hard_link = false;
1480 boost::filesystem::remove (test);
1481 boost::filesystem::remove (test2);
1484 boost::filesystem::space_info s = boost::filesystem::space (internal_video_asset_dir ());
1485 required = double (required_disk_space ()) / 1073741824.0f;
1486 if (!can_hard_link) {
1489 available = double (s.available) / 1073741824.0f;
1490 return (available - required) > 1;
1494 Film::subtitle_language () const
1496 set<string> languages;
1498 BOOST_FOREACH (shared_ptr<Content> i, content()) {
1499 BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
1500 languages.insert (j->language ());
1505 BOOST_FOREACH (string s, languages) {
1506 if (!all.empty ()) {
1516 /** @return The names of the channels that audio contents' outputs are passed into;
1517 * this is either the DCP or a AudioProcessor.
1520 Film::audio_output_names () const
1522 if (audio_processor ()) {
1523 return audio_processor()->input_names ();
1526 DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
1530 for (int i = 0; i < audio_channels(); ++i) {
1531 n.push_back (short_audio_channel_name (i));
1538 Film::repeat_content (ContentList c, int n)
1540 _playlist->repeat (shared_from_this(), c, n);
1544 Film::remove_content (ContentList c)
1546 _playlist->remove (c);
1550 Film::audio_analysis_finished ()
1556 Film::reels () const
1558 list<DCPTimePeriod> p;
1559 DCPTime const len = length();
1561 switch (reel_type ()) {
1562 case REELTYPE_SINGLE:
1563 p.push_back (DCPTimePeriod (DCPTime (), len));
1565 case REELTYPE_BY_VIDEO_CONTENT:
1567 optional<DCPTime> last_split;
1568 shared_ptr<Content> last_video;
1569 BOOST_FOREACH (shared_ptr<Content> c, content ()) {
1571 BOOST_FOREACH (DCPTime t, c->reel_split_points(shared_from_this())) {
1573 p.push_back (DCPTimePeriod (last_split.get(), t));
1581 DCPTime video_end = last_video ? last_video->end(shared_from_this()) : DCPTime(0);
1583 /* Definitely go from the last split to the end of the video content */
1584 p.push_back (DCPTimePeriod (last_split.get(), video_end));
1587 if (video_end < len) {
1588 /* And maybe go after that as well if there is any non-video hanging over the end */
1589 p.push_back (DCPTimePeriod (video_end, len));
1593 case REELTYPE_BY_LENGTH:
1596 /* Integer-divide reel length by the size of one frame to give the number of frames per reel */
1597 Frame const reel_in_frames = _reel_length / ((j2k_bandwidth() / video_frame_rate()) / 8);
1598 while (current < len) {
1599 DCPTime end = min (len, current + DCPTime::from_frames (reel_in_frames, video_frame_rate ()));
1600 p.push_back (DCPTimePeriod (current, end));
1610 /** @param period A period within the DCP
1611 * @return Name of the content which most contributes to the given period.
1614 Film::content_summary (DCPTimePeriod period) const
1616 return _playlist->content_summary (shared_from_this(), period);
1620 Film::use_template (string name)
1622 _template_film.reset (new Film (optional<boost::filesystem::path>()));
1623 _template_film->read_metadata (Config::instance()->template_path (name));
1624 _use_isdcf_name = _template_film->_use_isdcf_name;
1625 _dcp_content_type = _template_film->_dcp_content_type;
1626 _container = _template_film->_container;
1627 _resolution = _template_film->_resolution;
1628 _j2k_bandwidth = _template_film->_j2k_bandwidth;
1629 _video_frame_rate = _template_film->_video_frame_rate;
1630 _signed = _template_film->_signed;
1631 _encrypted = _template_film->_encrypted;
1632 _audio_channels = _template_film->_audio_channels;
1633 _sequence = _template_film->_sequence;
1634 _three_d = _template_film->_three_d;
1635 _interop = _template_film->_interop;
1636 _audio_processor = _template_film->_audio_processor;
1637 _reel_type = _template_film->_reel_type;
1638 _reel_length = _template_film->_reel_length;
1639 _upload_after_make_dcp = _template_film->_upload_after_make_dcp;
1640 _isdcf_metadata = _template_film->_isdcf_metadata;
1643 pair<double, double>
1644 Film::speed_up_range (int dcp_frame_rate) const
1646 return _playlist->speed_up_range (dcp_frame_rate);
1650 Film::copy_from (shared_ptr<const Film> film)
1652 read_metadata (film->file (metadata_file));
1656 Film::references_dcp_video () const
1658 BOOST_FOREACH (shared_ptr<Content> i, _playlist->content()) {
1659 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent>(i);
1660 if (d && d->reference_video()) {
1669 Film::references_dcp_audio () const
1671 BOOST_FOREACH (shared_ptr<Content> i, _playlist->content()) {
1672 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent>(i);
1673 if (d && d->reference_audio()) {
1682 Film::closed_caption_tracks () const
1684 list<DCPTextTrack> tt;
1685 BOOST_FOREACH (shared_ptr<Content> i, content()) {
1686 BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
1687 /* XXX: Empty DCPTextTrack ends up being a magic value here - the "unknown" or "not specified" track */
1688 DCPTextTrack dtt = j->dcp_track().get_value_or(DCPTextTrack());
1689 if (j->type() == TEXT_CLOSED_CAPTION && find(tt.begin(), tt.end(), dtt) == tt.end()) {
1699 Film::set_marker (dcp::Marker type, DCPTime time)
1701 ChangeSignaller<Film> ch (this, MARKERS);
1702 _markers[type] = time;
1706 Film::unset_marker (dcp::Marker type)
1708 ChangeSignaller<Film> ch (this, MARKERS);
1709 _markers.erase (type);
1713 Film::marker (dcp::Marker type) const
1715 map<dcp::Marker, DCPTime>::const_iterator i = _markers.find (type);
1716 if (i == _markers.end()) {
1717 return optional<DCPTime>();