2 Copyright (C) 2012-2018 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 "exceptions.h"
36 #include "examine_content_job.h"
39 #include "dcp_content_type.h"
42 #include "environment_info.h"
43 #include "audio_processor.h"
45 #include "compose.hpp"
47 #include "audio_content.h"
48 #include "video_content.h"
49 #include "text_content.h"
50 #include "ffmpeg_content.h"
51 #include "dcp_content.h"
52 #include "screen_kdm.h"
54 #include <libcxml/cxml.h>
56 #include <dcp/certificate_chain.h>
58 #include <dcp/local_time.h>
59 #include <dcp/decrypted_kdm.h>
60 #include <dcp/raw_convert.h>
61 #include <dcp/reel_mxf.h>
62 #include <dcp/reel_asset.h>
63 #include <libxml++/libxml++.h>
64 #include <boost/filesystem.hpp>
65 #include <boost/algorithm/string.hpp>
66 #include <boost/foreach.hpp>
67 #include <boost/regex.hpp>
88 using std::runtime_error;
90 using std::back_inserter;
92 using boost::shared_ptr;
93 using boost::weak_ptr;
94 using boost::dynamic_pointer_cast;
95 using boost::optional;
96 using boost::is_any_of;
97 using dcp::raw_convert;
99 #define LOG_GENERAL(...) log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
100 #define LOG_GENERAL_NC(...) log()->log (__VA_ARGS__, LogEntry::TYPE_GENERAL);
102 string const Film::metadata_file = "metadata.xml";
105 * AudioMapping XML changed.
107 * Subtitle offset changed to subtitle y offset, and subtitle x offset added.
109 * Use <Scale> tag in <VideoContent> rather than <Ratio>.
113 * Subtitle X and Y scale.
115 * Bumped to 32 for 2.0 branch; some times are expressed in Times rather
119 * Changed <Period> to <Subtitle> in FFmpegSubtitleStream
121 * Content only contains audio/subtitle-related tags if those things
124 * VideoFrameType in VideoContent is a string rather than an integer.
126 * EffectColour rather than OutlineColour in Subtitle.
128 * TextContent can be in a Caption tag, and some of the tag names
129 * have had Subtitle prefixes or suffixes removed.
131 int const Film::current_state_version = 37;
133 /** Construct a Film object in a given directory.
135 * @param dir Film directory.
138 Film::Film (optional<boost::filesystem::path> dir)
139 : _playlist (new Playlist)
140 , _use_isdcf_name (true)
141 , _dcp_content_type (Config::instance()->default_dcp_content_type ())
142 , _container (Config::instance()->default_container ())
143 , _resolution (RESOLUTION_2K)
146 , _context_id (dcp::make_uuid ())
147 , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
148 , _isdcf_metadata (Config::instance()->default_isdcf_metadata ())
149 , _video_frame_rate (24)
150 , _audio_channels (Config::instance()->default_dcp_audio_channels ())
153 , _interop (Config::instance()->default_interop ())
154 , _audio_processor (0)
155 , _reel_type (REELTYPE_SINGLE)
156 , _reel_length (2000000000)
157 , _upload_after_make_dcp (Config::instance()->default_upload_after_make_dcp())
158 , _state_version (current_state_version)
161 set_isdcf_date_today ();
163 _playlist_change_connection = _playlist->Change.connect (bind (&Film::playlist_change, this, _1));
164 _playlist_order_changed_connection = _playlist->OrderChanged.connect (bind (&Film::playlist_order_changed, this));
165 _playlist_content_change_connection = _playlist->ContentChange.connect (bind (&Film::playlist_content_change, this, _1, _2, _3, _4));
168 /* Make state.directory a complete path without ..s (where possible)
169 (Code swiped from Adam Bowen on stackoverflow)
170 XXX: couldn't/shouldn't this just be boost::filesystem::canonical?
173 boost::filesystem::path p (boost::filesystem::system_complete (dir.get()));
174 boost::filesystem::path result;
175 for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
177 if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
180 result = result.parent_path ();
182 } else if (*i != ".") {
187 set_directory (result.make_preferred ());
191 _log.reset (new FileLog (file ("log")));
193 _log.reset (new NullLog);
196 _playlist->set_sequence (_sequence);
201 BOOST_FOREACH (boost::signals2::connection& i, _job_connections) {
205 BOOST_FOREACH (boost::signals2::connection& i, _audio_analysis_connections) {
211 Film::video_identifier () const
213 DCPOMATIC_ASSERT (container ());
215 string s = container()->id()
216 + "_" + resolution_to_string (_resolution)
217 + "_" + _playlist->video_identifier()
218 + "_" + raw_convert<string>(_video_frame_rate)
219 + "_" + raw_convert<string>(j2k_bandwidth());
240 /** @return The file to write video frame info to */
241 boost::filesystem::path
242 Film::info_file (DCPTimePeriod period) const
244 boost::filesystem::path p;
246 p /= video_identifier () + "_" + raw_convert<string> (period.from.get()) + "_" + raw_convert<string> (period.to.get());
250 boost::filesystem::path
251 Film::internal_video_asset_dir () const
253 return dir ("video");
256 boost::filesystem::path
257 Film::internal_video_asset_filename (DCPTimePeriod p) const
259 return video_identifier() + "_" + raw_convert<string> (p.from.get()) + "_" + raw_convert<string> (p.to.get()) + ".mxf";
262 boost::filesystem::path
263 Film::audio_analysis_path (shared_ptr<const Playlist> playlist) const
265 boost::filesystem::path p = dir ("analysis");
268 BOOST_FOREACH (shared_ptr<Content> i, playlist->content ()) {
273 digester.add (i->digest ());
274 digester.add (i->audio->mapping().digest ());
275 if (playlist->content().size() != 1) {
276 /* Analyses should be considered equal regardless of gain
277 if they were made from just one piece of content. This
278 is because we can fake any gain change in a single-content
279 analysis at the plotting stage rather than having to
282 digester.add (i->audio->gain ());
286 if (audio_processor ()) {
287 digester.add (audio_processor()->id ());
290 p /= digester.get ();
294 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
298 if (dcp_name().find ("/") != string::npos) {
299 throw BadSettingError (_("name"), _("Cannot contain slashes"));
302 if (container() == 0) {
303 throw MissingSettingError (_("container"));
306 if (content().empty()) {
307 throw runtime_error (_("You must add some content to the DCP before creating it"));
310 if (dcp_content_type() == 0) {
311 throw MissingSettingError (_("content type"));
314 if (name().empty()) {
318 BOOST_FOREACH (shared_ptr<const Content> i, content ()) {
319 if (!i->paths_valid()) {
320 throw runtime_error (_("some of your content is missing"));
322 shared_ptr<const DCPContent> dcp = dynamic_pointer_cast<const DCPContent> (i);
323 if (dcp && dcp->needs_kdm()) {
324 throw runtime_error (_("Some of your content needs a KDM"));
326 if (dcp && dcp->needs_assets()) {
327 throw runtime_error (_("Some of your content needs an OV"));
331 set_isdcf_date_today ();
333 BOOST_FOREACH (string i, environment_info ()) {
337 BOOST_FOREACH (shared_ptr<const Content> i, content ()) {
338 LOG_GENERAL ("Content: %1", i->technical_summary());
340 LOG_GENERAL ("DCP video rate %1 fps", video_frame_rate());
341 if (Config::instance()->only_servers_encode ()) {
342 LOG_GENERAL_NC ("0 threads: ONLY SERVERS SET TO ENCODE");
344 LOG_GENERAL ("%1 threads", Config::instance()->master_encoding_threads());
346 LOG_GENERAL ("J2K bandwidth %1", j2k_bandwidth());
348 shared_ptr<TranscodeJob> tj (new TranscodeJob (shared_from_this()));
349 tj->set_encoder (shared_ptr<Encoder> (new DCPEncoder (shared_from_this(), tj)));
350 JobManager::instance()->add (tj);
353 /** Start a job to send our DCP to the configured TMS */
355 Film::send_dcp_to_tms ()
357 shared_ptr<Job> j (new UploadJob (shared_from_this()));
358 JobManager::instance()->add (j);
361 shared_ptr<xmlpp::Document>
362 Film::metadata (bool with_content_paths) const
364 shared_ptr<xmlpp::Document> doc (new xmlpp::Document);
365 xmlpp::Element* root = doc->create_root_node ("Metadata");
367 root->add_child("Version")->add_child_text (raw_convert<string> (current_state_version));
368 root->add_child("Name")->add_child_text (_name);
369 root->add_child("UseISDCFName")->add_child_text (_use_isdcf_name ? "1" : "0");
371 if (_dcp_content_type) {
372 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->isdcf_name ());
376 root->add_child("Container")->add_child_text (_container->id ());
379 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
380 root->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
381 _isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
382 root->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
383 root->add_child("ISDCFDate")->add_child_text (boost::gregorian::to_iso_string (_isdcf_date));
384 root->add_child("AudioChannels")->add_child_text (raw_convert<string> (_audio_channels));
385 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
386 root->add_child("Sequence")->add_child_text (_sequence ? "1" : "0");
387 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
388 root->add_child("Signed")->add_child_text (_signed ? "1" : "0");
389 root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
390 root->add_child("Key")->add_child_text (_key.hex ());
391 root->add_child("ContextID")->add_child_text (_context_id);
392 if (_audio_processor) {
393 root->add_child("AudioProcessor")->add_child_text (_audio_processor->id ());
395 root->add_child("ReelType")->add_child_text (raw_convert<string> (static_cast<int> (_reel_type)));
396 root->add_child("ReelLength")->add_child_text (raw_convert<string> (_reel_length));
397 root->add_child("UploadAfterMakeDCP")->add_child_text (_upload_after_make_dcp ? "1" : "0");
398 _playlist->as_xml (root->add_child ("Playlist"), with_content_paths);
403 /** Write state to our `metadata' file */
405 Film::write_metadata () const
407 DCPOMATIC_ASSERT (directory());
408 boost::filesystem::create_directories (directory().get());
409 shared_ptr<xmlpp::Document> doc = metadata ();
410 doc->write_to_file_formatted (file(metadata_file).string ());
414 /** Write a template from this film */
416 Film::write_template (boost::filesystem::path path) const
418 boost::filesystem::create_directories (path.parent_path());
419 shared_ptr<xmlpp::Document> doc = metadata (false);
420 doc->write_to_file_formatted (path.string ());
423 /** Read state from our metadata file.
424 * @return Notes about things that the user should know about, or empty.
427 Film::read_metadata (optional<boost::filesystem::path> path)
430 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file (metadata_file))) {
431 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!"));
434 path = file (metadata_file);
437 cxml::Document f ("Metadata");
438 f.read_file (path.get ());
440 _state_version = f.number_child<int> ("Version");
441 if (_state_version > current_state_version) {
442 throw runtime_error (_("This film was created with a newer version of DCP-o-matic, and it cannot be loaded into this version. Sorry!"));
445 _name = f.string_child ("Name");
446 if (_state_version >= 9) {
447 _use_isdcf_name = f.bool_child ("UseISDCFName");
448 _isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
449 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("ISDCFDate"));
451 _use_isdcf_name = f.bool_child ("UseDCIName");
452 _isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
453 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
457 optional<string> c = f.optional_string_child ("DCPContentType");
459 _dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
464 optional<string> c = f.optional_string_child ("Container");
466 _container = Ratio::from_id (c.get ());
470 _resolution = string_to_resolution (f.string_child ("Resolution"));
471 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
472 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
473 _signed = f.optional_bool_child("Signed").get_value_or (true);
474 _encrypted = f.bool_child ("Encrypted");
475 _audio_channels = f.number_child<int> ("AudioChannels");
476 /* We used to allow odd numbers (and zero) channels, but it's just not worth
479 if (_audio_channels == 0) {
481 } else if ((_audio_channels % 2) == 1) {
485 if (f.optional_bool_child("SequenceVideo")) {
486 _sequence = f.bool_child("SequenceVideo");
488 _sequence = f.bool_child("Sequence");
491 _three_d = f.bool_child ("ThreeD");
492 _interop = f.bool_child ("Interop");
493 _key = dcp::Key (f.string_child ("Key"));
494 _context_id = f.optional_string_child("ContextID").get_value_or (dcp::make_uuid ());
496 if (f.optional_string_child ("AudioProcessor")) {
497 _audio_processor = AudioProcessor::from_id (f.string_child ("AudioProcessor"));
499 _audio_processor = 0;
502 _reel_type = static_cast<ReelType> (f.optional_number_child<int>("ReelType").get_value_or (static_cast<int>(REELTYPE_SINGLE)));
503 _reel_length = f.optional_number_child<int64_t>("ReelLength").get_value_or (2000000000);
504 _upload_after_make_dcp = f.optional_bool_child("UploadAfterMakeDCP").get_value_or (false);
507 /* This method is the only one that can return notes (so far) */
508 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
510 /* Write backtraces to this film's directory, until another film is loaded */
512 set_backtrace_file (file ("backtrace.txt"));
519 /** Given a directory name, return its full path within the Film's directory.
520 * @param d directory name within the Film's directory.
521 * @param create true to create the directory (and its parents) if they do not exist.
523 boost::filesystem::path
524 Film::dir (boost::filesystem::path d, bool create) const
526 DCPOMATIC_ASSERT (_directory);
528 boost::filesystem::path p;
529 p /= _directory.get();
533 boost::filesystem::create_directories (p);
539 /** Given a file or directory name, return its full path within the Film's directory.
540 * Any required parent directories will be created.
542 boost::filesystem::path
543 Film::file (boost::filesystem::path f) const
545 DCPOMATIC_ASSERT (_directory);
547 boost::filesystem::path p;
548 p /= _directory.get();
551 boost::filesystem::create_directories (p.parent_path ());
557 Film::mapped_audio_channels () const
561 if (audio_processor ()) {
562 /* Processors are mapped 1:1 to DCP outputs so we can work out mappings from there */
563 for (int i = 0; i < audio_processor()->out_channels(); ++i) {
564 mapped.push_back (i);
567 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
569 list<int> c = i->audio->mapping().mapped_output_channels ();
570 copy (c.begin(), c.end(), back_inserter (mapped));
581 /** @return a ISDCF-compliant name for a DCP of this film */
583 Film::isdcf_name (bool if_created_now) const
587 string raw_name = name ();
589 /* Split the raw name up into words */
590 vector<string> words;
591 split (words, raw_name, is_any_of (" _-"));
595 /* Add each word to fixed_name */
596 for (vector<string>::const_iterator i = words.begin(); i != words.end(); ++i) {
599 /* First letter is always capitalised */
600 w[0] = toupper (w[0]);
602 /* Count caps in w */
604 for (size_t i = 0; i < w.size(); ++i) {
605 if (isupper (w[i])) {
610 /* If w is all caps make the rest of it lower case, otherwise
613 if (caps == w.size ()) {
614 for (size_t i = 1; i < w.size(); ++i) {
615 w[i] = tolower (w[i]);
619 for (size_t i = 0; i < w.size(); ++i) {
624 if (fixed_name.length() > 14) {
625 fixed_name = fixed_name.substr (0, 14);
630 if (dcp_content_type()) {
631 d += "_" + dcp_content_type()->isdcf_name();
632 d += "-" + raw_convert<string>(isdcf_metadata().content_version);
635 ISDCFMetadata const dm = isdcf_metadata ();
637 if (dm.temp_version) {
641 if (dm.pre_release) {
649 if (!dm.chain.empty ()) {
657 if (dm.two_d_version_of_three_d) {
661 if (!dm.mastered_luminance.empty ()) {
662 d += "-" + dm.mastered_luminance;
665 if (video_frame_rate() != 24) {
666 d += "-" + raw_convert<string>(video_frame_rate());
670 d += "_" + container()->isdcf_name();
673 /* XXX: this uses the first bit of content only */
675 /* Interior aspect ratio. The standard says we don't do this for trailers, for some strange reason */
676 if (dcp_content_type() && dcp_content_type()->libdcp_kind() != dcp::TRAILER) {
677 Ratio const * content_ratio = 0;
678 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
680 /* Here's the first piece of video content */
681 if (i->video->scale().ratio ()) {
682 content_ratio = i->video->scale().ratio ();
684 content_ratio = Ratio::from_ratio (i->video->size().ratio ());
690 if (content_ratio && content_ratio != container()) {
691 /* This needs to be the numeric version of the ratio, and ::id() is close enough */
692 d += "-" + content_ratio->id();
696 if (!dm.audio_language.empty ()) {
697 d += "_" + dm.audio_language;
698 if (!dm.subtitle_language.empty()) {
700 /* I'm not clear on the precise details of the convention for CCAP labelling;
701 for now I'm just appending -CCAP if we have any closed captions.
704 bool burnt_in = true;
706 BOOST_FOREACH (shared_ptr<Content> i, content()) {
707 BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
708 if (j->type() == TEXT_OPEN_SUBTITLE && j->use() && !j->burn()) {
710 } else if (j->type() == TEXT_CLOSED_CAPTION) {
716 string language = dm.subtitle_language;
717 if (burnt_in && language != "XX") {
718 transform (language.begin(), language.end(), language.begin(), ::tolower);
720 transform (language.begin(), language.end(), language.begin(), ::toupper);
732 if (!dm.territory.empty ()) {
733 d += "_" + dm.territory;
734 if (dm.rating.empty ()) {
737 d += "-" + dm.rating;
741 /* Count mapped audio channels */
743 pair<int, int> ch = audio_channel_types (mapped_audio_channels(), audio_channels());
744 if (!ch.first && !ch.second) {
746 } else if (ch.first) {
747 d += String::compose("_%1%2", ch.first, ch.second);
752 d += "_" + resolution_to_string (_resolution);
754 if (!dm.studio.empty ()) {
755 d += "_" + dm.studio;
758 if (if_created_now) {
759 d += "_" + boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
761 d += "_" + boost::gregorian::to_iso_string (_isdcf_date);
764 if (!dm.facility.empty ()) {
765 d += "_" + dm.facility;
779 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
780 shared_ptr<const DCPContent> dc = dynamic_pointer_cast<const DCPContent> (i);
785 bool any_text = false;
786 for (int i = 0; i < TEXT_COUNT; ++i) {
787 if (dc->reference_text(static_cast<TextType>(i))) {
791 if (dc->reference_video() || dc->reference_audio() || any_text) {
805 /** @return name to give the DCP */
807 Film::dcp_name (bool if_created_now) const
810 if (use_isdcf_name()) {
811 return careful_string_filter (isdcf_name (if_created_now));
814 return careful_string_filter (name ());
818 Film::set_directory (boost::filesystem::path d)
825 Film::set_name (string n)
828 signal_changed (NAME);
832 Film::set_use_isdcf_name (bool u)
835 signal_changed (USE_ISDCF_NAME);
839 Film::set_dcp_content_type (DCPContentType const * t)
841 _dcp_content_type = t;
842 signal_changed (DCP_CONTENT_TYPE);
846 Film::set_container (Ratio const * c)
849 signal_changed (CONTAINER);
853 Film::set_resolution (Resolution r)
856 signal_changed (RESOLUTION);
860 Film::set_j2k_bandwidth (int b)
863 signal_changed (J2K_BANDWIDTH);
867 Film::set_isdcf_metadata (ISDCFMetadata m)
870 signal_changed (ISDCF_METADATA);
874 Film::set_video_frame_rate (int f)
876 _video_frame_rate = f;
877 signal_changed (VIDEO_FRAME_RATE);
881 Film::set_audio_channels (int c)
884 signal_changed (AUDIO_CHANNELS);
888 Film::set_three_d (bool t)
891 signal_changed (THREE_D);
893 if (_three_d && _isdcf_metadata.two_d_version_of_three_d) {
894 _isdcf_metadata.two_d_version_of_three_d = false;
895 signal_changed (ISDCF_METADATA);
900 Film::set_interop (bool i)
903 signal_changed (INTEROP);
907 Film::set_audio_processor (AudioProcessor const * processor)
909 _audio_processor = processor;
910 signal_changed (AUDIO_PROCESSOR);
911 signal_changed (AUDIO_CHANNELS);
915 Film::set_reel_type (ReelType t)
918 signal_changed (REEL_TYPE);
921 /** @param r Desired reel length in bytes */
923 Film::set_reel_length (int64_t r)
926 signal_changed (REEL_LENGTH);
930 Film::set_upload_after_make_dcp (bool u)
932 _upload_after_make_dcp = u;
933 signal_changed (UPLOAD_AFTER_MAKE_DCP);
937 Film::signal_changed (Property p)
943 set_video_frame_rate (_playlist->best_video_frame_rate ());
945 case Film::VIDEO_FRAME_RATE:
947 _playlist->maybe_sequence ();
953 emit (boost::bind (boost::ref (Changed), p));
957 Film::set_isdcf_date_today ()
959 _isdcf_date = boost::gregorian::day_clock::local_day ();
962 boost::filesystem::path
963 Film::j2c_path (int reel, Frame frame, Eyes eyes, bool tmp) const
965 boost::filesystem::path p;
967 p /= video_identifier ();
970 snprintf(buffer, sizeof(buffer), "%08d_%08" PRId64, reel, frame);
973 if (eyes == EYES_LEFT) {
975 } else if (eyes == EYES_RIGHT) {
989 /** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs */
994 return vector<CPLSummary> ();
997 vector<CPLSummary> out;
999 boost::filesystem::path const dir = directory().get();
1000 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
1002 boost::filesystem::is_directory (*i) &&
1003 i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
1009 DCPOMATIC_ASSERT (dcp.cpls().front()->file());
1012 i->path().leaf().string(),
1013 dcp.cpls().front()->id(),
1014 dcp.cpls().front()->annotation_text(),
1015 dcp.cpls().front()->file().get()
1028 Film::set_signed (bool s)
1031 signal_changed (SIGNED);
1035 Film::set_encrypted (bool e)
1038 signal_changed (ENCRYPTED);
1042 Film::set_key (dcp::Key key)
1045 signal_changed (KEY);
1049 Film::content () const
1051 return _playlist->content ();
1054 /** @param content Content to add.
1055 * @param disable_audio_analysis true to never do automatic audio analysis, even if it is enabled in configuration.
1058 Film::examine_and_add_content (shared_ptr<Content> content, bool disable_audio_analysis)
1060 if (dynamic_pointer_cast<FFmpegContent> (content) && _directory) {
1061 run_ffprobe (content->path(0), file ("ffprobe.log"), _log);
1064 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), content));
1066 _job_connections.push_back (
1067 j->Finished.connect (bind (&Film::maybe_add_content, this, weak_ptr<Job>(j), weak_ptr<Content>(content), disable_audio_analysis))
1070 JobManager::instance()->add (j);
1074 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c, bool disable_audio_analysis)
1076 shared_ptr<Job> job = j.lock ();
1077 if (!job || !job->finished_ok ()) {
1081 shared_ptr<Content> content = c.lock ();
1086 add_content (content);
1088 if (Config::instance()->automatic_audio_analysis() && content->audio && !disable_audio_analysis) {
1089 shared_ptr<Playlist> playlist (new Playlist);
1090 playlist->add (content);
1091 boost::signals2::connection c;
1092 JobManager::instance()->analyse_audio (
1093 shared_from_this(), playlist, false, c, bind (&Film::audio_analysis_finished, this)
1095 _audio_analysis_connections.push_back (c);
1100 Film::add_content (shared_ptr<Content> c)
1102 /* Add {video,subtitle} content after any existing {video,subtitle} content */
1104 c->set_position (_playlist->video_end());
1105 } else if (!c->text.empty()) {
1106 c->set_position (_playlist->text_end());
1109 if (_template_film) {
1110 /* Take settings from the first piece of content of c's type in _template */
1111 BOOST_FOREACH (shared_ptr<Content> i, _template_film->content()) {
1112 c->take_settings_from (i);
1120 Film::remove_content (shared_ptr<Content> c)
1122 _playlist->remove (c);
1126 Film::move_content_earlier (shared_ptr<Content> c)
1128 _playlist->move_earlier (c);
1132 Film::move_content_later (shared_ptr<Content> c)
1134 _playlist->move_later (c);
1137 /** @return length of the film from time 0 to the last thing on the playlist */
1139 Film::length () const
1141 return _playlist->length().ceil(video_frame_rate());
1145 Film::best_video_frame_rate () const
1147 return _playlist->best_video_frame_rate ();
1151 Film::active_frame_rate_change (DCPTime t) const
1153 return _playlist->active_frame_rate_change (t, video_frame_rate ());
1157 Film::playlist_content_change (ChangeType type, weak_ptr<Content> c, int p, bool frequent)
1159 if (type != CHANGE_TYPE_DONE) {
1165 if (p == ContentProperty::VIDEO_FRAME_RATE) {
1166 set_video_frame_rate (_playlist->best_video_frame_rate ());
1167 } else if (p == AudioContentProperty::STREAMS) {
1168 signal_changed (NAME);
1171 emit (boost::bind (boost::ref (ContentChange), type, c, p, frequent));
1175 Film::playlist_change (ChangeType type)
1177 if (type == CHANGE_TYPE_DONE) {
1178 signal_changed (CONTENT);
1179 signal_changed (NAME);
1184 Film::playlist_order_changed ()
1186 signal_changed (CONTENT_ORDER);
1190 Film::audio_frame_rate () const
1192 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
1193 if (i->audio && i->audio->has_rate_above_48k ()) {
1202 Film::set_sequence (bool s)
1204 if (s == _sequence) {
1209 _playlist->set_sequence (s);
1210 signal_changed (SEQUENCE);
1213 /** @return Size of the largest possible image in whatever resolution we are using */
1215 Film::full_frame () const
1217 switch (_resolution) {
1219 return dcp::Size (2048, 1080);
1221 return dcp::Size (4096, 2160);
1224 DCPOMATIC_ASSERT (false);
1225 return dcp::Size ();
1228 /** @return Size of the frame */
1230 Film::frame_size () const
1232 return fit_ratio_within (container()->ratio(), full_frame ());
1235 /** @param recipient KDM recipient certificate.
1236 * @param trusted_devices Certificates of other trusted devices (can be empty).
1237 * @param cpl_file CPL filename.
1238 * @param from KDM from time expressed as a local time with an offset from UTC.
1239 * @param until KDM to time expressed as a local time with an offset from UTC.
1240 * @param formulation KDM formulation to use.
1241 * @param disable_forensic_marking_picture true to disable forensic marking of picture.
1242 * @param disable_forensic_marking_audio if not set, don't disable forensic marking of audio. If set to 0,
1243 * disable all forensic marking; if set above 0, disable forensic marking above that channel.
1247 dcp::Certificate recipient,
1248 vector<dcp::Certificate> trusted_devices,
1249 boost::filesystem::path cpl_file,
1250 dcp::LocalTime from,
1251 dcp::LocalTime until,
1252 dcp::Formulation formulation,
1253 bool disable_forensic_marking_picture,
1254 optional<int> disable_forensic_marking_audio
1258 throw runtime_error (_("Cannot make a KDM as this project is not encrypted."));
1261 shared_ptr<const dcp::CPL> cpl (new dcp::CPL (cpl_file));
1262 shared_ptr<const dcp::CertificateChain> signer = Config::instance()->signer_chain ();
1263 if (!signer->valid ()) {
1264 throw InvalidSignerError ();
1267 /* Find keys that have been added to imported, encrypted DCP content */
1268 list<dcp::DecryptedKDMKey> imported_keys;
1269 BOOST_FOREACH (shared_ptr<Content> i, content()) {
1270 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent> (i);
1271 if (d && d->kdm()) {
1272 dcp::DecryptedKDM kdm (d->kdm().get(), Config::instance()->decryption_chain()->key().get());
1273 list<dcp::DecryptedKDMKey> keys = kdm.keys ();
1274 copy (keys.begin(), keys.end(), back_inserter (imported_keys));
1278 map<shared_ptr<const dcp::ReelMXF>, dcp::Key> keys;
1280 BOOST_FOREACH(shared_ptr<const dcp::ReelAsset> i, cpl->reel_assets ()) {
1281 shared_ptr<const dcp::ReelMXF> mxf = boost::dynamic_pointer_cast<const dcp::ReelMXF> (i);
1282 if (!mxf || !mxf->key_id()) {
1286 /* Get any imported key for this ID */
1288 BOOST_FOREACH (dcp::DecryptedKDMKey j, imported_keys) {
1289 if (j.id() == mxf->key_id().get()) {
1290 LOG_GENERAL ("Using imported key for %1", mxf->key_id().get());
1291 keys[mxf] = j.key();
1297 /* No imported key; it must be an asset that we encrypted */
1298 LOG_GENERAL ("Using our own key for %1", mxf->key_id().get());
1303 return dcp::DecryptedKDM (
1304 cpl->id(), keys, from, until, cpl->content_title_text(), cpl->content_title_text(), dcp::LocalTime().as_string()
1305 ).encrypt (signer, recipient, trusted_devices, formulation, disable_forensic_marking_picture, disable_forensic_marking_audio);
1308 /** @param screens Screens to make KDMs for.
1309 * @param cpl_file Path to CPL to make KDMs for.
1310 * @param from KDM from time expressed as a local time in the time zone of the Screen's Cinema.
1311 * @param until KDM to time expressed as a local time in the time zone of the Screen's Cinema.
1312 * @param formulation KDM formulation to use.
1313 * @param disable_forensic_marking_picture true to disable forensic marking of picture.
1314 * @param disable_forensic_marking_audio if not set, don't disable forensic marking of audio. If set to 0,
1315 * disable all forensic marking; if set above 0, disable forensic marking above that channel.
1319 list<shared_ptr<Screen> > screens,
1320 boost::filesystem::path cpl_file,
1321 boost::posix_time::ptime from,
1322 boost::posix_time::ptime until,
1323 dcp::Formulation formulation,
1324 bool disable_forensic_marking_picture,
1325 optional<int> disable_forensic_marking_audio
1328 list<ScreenKDM> kdms;
1330 BOOST_FOREACH (shared_ptr<Screen> i, screens) {
1332 dcp::EncryptedKDM const kdm = make_kdm (
1336 dcp::LocalTime (from, i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute()),
1337 dcp::LocalTime (until, i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute()),
1339 disable_forensic_marking_picture,
1340 disable_forensic_marking_audio
1343 kdms.push_back (ScreenKDM (i, kdm));
1350 /** @return The approximate disk space required to encode a DCP of this film with the
1351 * current settings, in bytes.
1354 Film::required_disk_space () const
1356 return _playlist->required_disk_space (j2k_bandwidth(), audio_channels(), audio_frame_rate());
1359 /** This method checks the disk that the Film is on and tries to decide whether or not
1360 * there will be enough space to make a DCP for it. If so, true is returned; if not,
1361 * false is returned and required and available are filled in with the amount of disk space
1362 * required and available respectively (in Gb).
1364 * Note: the decision made by this method isn't, of course, 100% reliable.
1367 Film::should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const
1369 /* Create a test file and see if we can hard-link it */
1370 boost::filesystem::path test = internal_video_asset_dir() / "test";
1371 boost::filesystem::path test2 = internal_video_asset_dir() / "test2";
1372 can_hard_link = true;
1373 FILE* f = fopen_boost (test, "w");
1376 boost::system::error_code ec;
1377 boost::filesystem::create_hard_link (test, test2, ec);
1379 can_hard_link = false;
1381 boost::filesystem::remove (test);
1382 boost::filesystem::remove (test2);
1385 boost::filesystem::space_info s = boost::filesystem::space (internal_video_asset_dir ());
1386 required = double (required_disk_space ()) / 1073741824.0f;
1387 if (!can_hard_link) {
1390 available = double (s.available) / 1073741824.0f;
1391 return (available - required) > 1;
1395 Film::subtitle_language () const
1397 set<string> languages;
1399 BOOST_FOREACH (shared_ptr<Content> i, content()) {
1400 BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
1401 languages.insert (j->language ());
1406 BOOST_FOREACH (string s, languages) {
1407 if (!all.empty ()) {
1417 /** Change the gains of the supplied AudioMapping to make it a default
1418 * for this film. The defaults are guessed based on what processor (if any)
1419 * is in use, the number of input channels and any filename supplied.
1422 Film::make_audio_mapping_default (AudioMapping& mapping, optional<boost::filesystem::path> filename) const
1424 static string const regex[] = {
1425 ".*[\\._-]L[\\._-].*",
1426 ".*[\\._-]R[\\._-].*",
1427 ".*[\\._-]C[\\._-].*",
1428 ".*[\\._-]Lfe[\\._-].*",
1429 ".*[\\._-]Ls[\\._-].*",
1430 ".*[\\._-]Rs[\\._-].*"
1433 static int const regexes = sizeof(regex) / sizeof(*regex);
1435 if (audio_processor ()) {
1436 audio_processor()->make_audio_mapping_default (mapping);
1438 mapping.make_zero ();
1439 if (mapping.input_channels() == 1) {
1440 bool guessed = false;
1442 /* See if we can guess where this stream should go */
1444 for (int i = 0; i < regexes; ++i) {
1445 boost::regex e (regex[i], boost::regex::icase);
1446 if (boost::regex_match (filename->string(), e) && i < mapping.output_channels()) {
1447 mapping.set (0, i, 1);
1454 /* If we have no idea, just put it on centre */
1455 mapping.set (0, static_cast<int> (dcp::CENTRE), 1);
1459 for (int i = 0; i < min (mapping.input_channels(), mapping.output_channels()); ++i) {
1460 mapping.set (i, i, 1);
1466 /** @return The names of the channels that audio contents' outputs are passed into;
1467 * this is either the DCP or a AudioProcessor.
1470 Film::audio_output_names () const
1472 if (audio_processor ()) {
1473 return audio_processor()->input_names ();
1476 DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
1480 for (int i = 0; i < audio_channels(); ++i) {
1481 n.push_back (short_audio_channel_name (i));
1488 Film::repeat_content (ContentList c, int n)
1490 _playlist->repeat (c, n);
1494 Film::remove_content (ContentList c)
1496 _playlist->remove (c);
1500 Film::audio_analysis_finished ()
1506 Film::reels () const
1508 list<DCPTimePeriod> p;
1509 DCPTime const len = length();
1511 switch (reel_type ()) {
1512 case REELTYPE_SINGLE:
1513 p.push_back (DCPTimePeriod (DCPTime (), len));
1515 case REELTYPE_BY_VIDEO_CONTENT:
1517 optional<DCPTime> last_split;
1518 shared_ptr<Content> last_video;
1519 BOOST_FOREACH (shared_ptr<Content> c, content ()) {
1521 BOOST_FOREACH (DCPTime t, c->reel_split_points()) {
1523 p.push_back (DCPTimePeriod (last_split.get(), t));
1531 DCPTime video_end = last_video ? last_video->end() : DCPTime(0);
1533 /* Definitely go from the last split to the end of the video content */
1534 p.push_back (DCPTimePeriod (last_split.get(), video_end));
1537 if (video_end < len) {
1538 /* And maybe go after that as well if there is any non-video hanging over the end */
1539 p.push_back (DCPTimePeriod (video_end, len));
1543 case REELTYPE_BY_LENGTH:
1546 /* Integer-divide reel length by the size of one frame to give the number of frames per reel */
1547 Frame const reel_in_frames = _reel_length / ((j2k_bandwidth() / video_frame_rate()) / 8);
1548 while (current < len) {
1549 DCPTime end = min (len, current + DCPTime::from_frames (reel_in_frames, video_frame_rate ()));
1550 p.push_back (DCPTimePeriod (current, end));
1560 /** @param period A period within the DCP
1561 * @return Name of the content which most contributes to the given period.
1564 Film::content_summary (DCPTimePeriod period) const
1566 return _playlist->content_summary (period);
1570 Film::use_template (string name)
1572 _template_film.reset (new Film (optional<boost::filesystem::path>()));
1573 _template_film->read_metadata (Config::instance()->template_path (name));
1574 _use_isdcf_name = _template_film->_use_isdcf_name;
1575 _dcp_content_type = _template_film->_dcp_content_type;
1576 _container = _template_film->_container;
1577 _resolution = _template_film->_resolution;
1578 _j2k_bandwidth = _template_film->_j2k_bandwidth;
1579 _video_frame_rate = _template_film->_video_frame_rate;
1580 _signed = _template_film->_signed;
1581 _encrypted = _template_film->_encrypted;
1582 _audio_channels = _template_film->_audio_channels;
1583 _sequence = _template_film->_sequence;
1584 _three_d = _template_film->_three_d;
1585 _interop = _template_film->_interop;
1586 _audio_processor = _template_film->_audio_processor;
1587 _reel_type = _template_film->_reel_type;
1588 _reel_length = _template_film->_reel_length;
1589 _upload_after_make_dcp = _template_film->_upload_after_make_dcp;
1590 _isdcf_metadata = _template_film->_isdcf_metadata;
1593 pair<double, double>
1594 Film::speed_up_range (int dcp_frame_rate) const
1596 return _playlist->speed_up_range (dcp_frame_rate);
1600 Film::copy_from (shared_ptr<const Film> film)
1602 read_metadata (film->file (metadata_file));
1606 Film::references_dcp_video () const
1608 BOOST_FOREACH (shared_ptr<Content> i, _playlist->content()) {
1609 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent>(i);
1610 if (d && d->reference_video()) {
1619 Film::references_dcp_audio () const
1621 BOOST_FOREACH (shared_ptr<Content> i, _playlist->content()) {
1622 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent>(i);
1623 if (d && d->reference_audio()) {