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 "change_signaller.h"
55 #include "check_content_change_job.h"
56 #include <libcxml/cxml.h>
58 #include <dcp/certificate_chain.h>
60 #include <dcp/local_time.h>
61 #include <dcp/decrypted_kdm.h>
62 #include <dcp/raw_convert.h>
63 #include <dcp/reel_mxf.h>
64 #include <dcp/reel_asset.h>
65 #include <libxml++/libxml++.h>
66 #include <boost/filesystem.hpp>
67 #include <boost/algorithm/string.hpp>
68 #include <boost/foreach.hpp>
69 #include <boost/regex.hpp>
90 using std::runtime_error;
92 using std::back_inserter;
94 using boost::shared_ptr;
95 using boost::weak_ptr;
96 using boost::dynamic_pointer_cast;
97 using boost::optional;
98 using boost::is_any_of;
99 using dcp::raw_convert;
101 #define LOG_GENERAL(...) log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
102 #define LOG_GENERAL_NC(...) log()->log (__VA_ARGS__, LogEntry::TYPE_GENERAL);
104 string const Film::metadata_file = "metadata.xml";
107 * AudioMapping XML changed.
109 * Subtitle offset changed to subtitle y offset, and subtitle x offset added.
111 * Use <Scale> tag in <VideoContent> rather than <Ratio>.
115 * Subtitle X and Y scale.
117 * Bumped to 32 for 2.0 branch; some times are expressed in Times rather
121 * Changed <Period> to <Subtitle> in FFmpegSubtitleStream
123 * Content only contains audio/subtitle-related tags if those things
126 * VideoFrameType in VideoContent is a string rather than an integer.
128 * EffectColour rather than OutlineColour in Subtitle.
130 * TextContent can be in a Caption tag, and some of the tag names
131 * have had Subtitle prefixes or suffixes removed.
133 int const Film::current_state_version = 37;
135 /** Construct a Film object in a given directory.
137 * @param dir Film directory.
140 Film::Film (optional<boost::filesystem::path> dir)
141 : _playlist (new Playlist)
142 , _use_isdcf_name (true)
143 , _dcp_content_type (Config::instance()->default_dcp_content_type ())
144 , _container (Config::instance()->default_container ())
145 , _resolution (RESOLUTION_2K)
148 , _context_id (dcp::make_uuid ())
149 , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
150 , _isdcf_metadata (Config::instance()->default_isdcf_metadata ())
151 , _video_frame_rate (24)
152 , _audio_channels (Config::instance()->default_dcp_audio_channels ())
155 , _interop (Config::instance()->default_interop ())
156 , _audio_processor (0)
157 , _reel_type (REELTYPE_SINGLE)
158 , _reel_length (2000000000)
159 , _upload_after_make_dcp (Config::instance()->default_upload_after_make_dcp())
160 , _reencode_j2k (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 p /= digester.get ();
297 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
301 if (dcp_name().find ("/") != string::npos) {
302 throw BadSettingError (_("name"), _("Cannot contain slashes"));
305 if (container() == 0) {
306 throw MissingSettingError (_("container"));
309 if (content().empty()) {
310 throw runtime_error (_("You must add some content to the DCP before creating it"));
313 if (dcp_content_type() == 0) {
314 throw MissingSettingError (_("content type"));
317 if (name().empty()) {
321 BOOST_FOREACH (shared_ptr<const Content> i, content ()) {
322 if (!i->paths_valid()) {
323 throw runtime_error (_("some of your content is missing"));
325 shared_ptr<const DCPContent> dcp = dynamic_pointer_cast<const DCPContent> (i);
326 if (dcp && dcp->needs_kdm()) {
327 throw runtime_error (_("Some of your content needs a KDM"));
329 if (dcp && dcp->needs_assets()) {
330 throw runtime_error (_("Some of your content needs an OV"));
334 set_isdcf_date_today ();
336 BOOST_FOREACH (string i, environment_info ()) {
340 BOOST_FOREACH (shared_ptr<const Content> i, content ()) {
341 LOG_GENERAL ("Content: %1", i->technical_summary());
343 LOG_GENERAL ("DCP video rate %1 fps", video_frame_rate());
344 if (Config::instance()->only_servers_encode ()) {
345 LOG_GENERAL_NC ("0 threads: ONLY SERVERS SET TO ENCODE");
347 LOG_GENERAL ("%1 threads", Config::instance()->master_encoding_threads());
349 LOG_GENERAL ("J2K bandwidth %1", j2k_bandwidth());
351 shared_ptr<TranscodeJob> tj (new TranscodeJob (shared_from_this()));
352 tj->set_encoder (shared_ptr<Encoder> (new DCPEncoder (shared_from_this(), tj)));
353 shared_ptr<CheckContentChangeJob> cc (new CheckContentChangeJob (shared_from_this(), tj));
354 JobManager::instance()->add (cc);
357 /** Start a job to send our DCP to the configured TMS */
359 Film::send_dcp_to_tms ()
361 shared_ptr<Job> j (new UploadJob (shared_from_this()));
362 JobManager::instance()->add (j);
365 shared_ptr<xmlpp::Document>
366 Film::metadata (bool with_content_paths) const
368 shared_ptr<xmlpp::Document> doc (new xmlpp::Document);
369 xmlpp::Element* root = doc->create_root_node ("Metadata");
371 root->add_child("Version")->add_child_text (raw_convert<string> (current_state_version));
372 root->add_child("Name")->add_child_text (_name);
373 root->add_child("UseISDCFName")->add_child_text (_use_isdcf_name ? "1" : "0");
375 if (_dcp_content_type) {
376 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->isdcf_name ());
380 root->add_child("Container")->add_child_text (_container->id ());
383 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
384 root->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
385 _isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
386 root->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
387 root->add_child("ISDCFDate")->add_child_text (boost::gregorian::to_iso_string (_isdcf_date));
388 root->add_child("AudioChannels")->add_child_text (raw_convert<string> (_audio_channels));
389 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
390 root->add_child("Sequence")->add_child_text (_sequence ? "1" : "0");
391 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
392 root->add_child("Signed")->add_child_text (_signed ? "1" : "0");
393 root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
394 root->add_child("Key")->add_child_text (_key.hex ());
395 root->add_child("ContextID")->add_child_text (_context_id);
396 if (_audio_processor) {
397 root->add_child("AudioProcessor")->add_child_text (_audio_processor->id ());
399 root->add_child("ReelType")->add_child_text (raw_convert<string> (static_cast<int> (_reel_type)));
400 root->add_child("ReelLength")->add_child_text (raw_convert<string> (_reel_length));
401 root->add_child("UploadAfterMakeDCP")->add_child_text (_upload_after_make_dcp ? "1" : "0");
402 root->add_child("ReencodeJ2K")->add_child_text (_reencode_j2k ? "1" : "0");
403 _playlist->as_xml (root->add_child ("Playlist"), with_content_paths);
409 Film::write_metadata (boost::filesystem::path path) const
411 shared_ptr<xmlpp::Document> doc = metadata ();
412 doc->write_to_file_formatted (path.string());
415 /** Write state to our `metadata' file */
417 Film::write_metadata () const
419 DCPOMATIC_ASSERT (directory());
420 boost::filesystem::create_directories (directory().get());
421 shared_ptr<xmlpp::Document> doc = metadata ();
422 doc->write_to_file_formatted (file(metadata_file).string ());
426 /** Write a template from this film */
428 Film::write_template (boost::filesystem::path path) const
430 boost::filesystem::create_directories (path.parent_path());
431 shared_ptr<xmlpp::Document> doc = metadata (false);
432 doc->write_to_file_formatted (path.string ());
435 /** Read state from our metadata file.
436 * @return Notes about things that the user should know about, or empty.
439 Film::read_metadata (optional<boost::filesystem::path> path)
442 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file (metadata_file))) {
443 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!"));
446 path = file (metadata_file);
449 cxml::Document f ("Metadata");
450 f.read_file (path.get ());
452 _state_version = f.number_child<int> ("Version");
453 if (_state_version > current_state_version) {
454 throw runtime_error (_("This film was created with a newer version of DCP-o-matic, and it cannot be loaded into this version. Sorry!"));
457 _name = f.string_child ("Name");
458 if (_state_version >= 9) {
459 _use_isdcf_name = f.bool_child ("UseISDCFName");
460 _isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
461 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("ISDCFDate"));
463 _use_isdcf_name = f.bool_child ("UseDCIName");
464 _isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
465 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
469 optional<string> c = f.optional_string_child ("DCPContentType");
471 _dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
476 optional<string> c = f.optional_string_child ("Container");
478 _container = Ratio::from_id (c.get ());
482 _resolution = string_to_resolution (f.string_child ("Resolution"));
483 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
484 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
485 _signed = f.optional_bool_child("Signed").get_value_or (true);
486 _encrypted = f.bool_child ("Encrypted");
487 _audio_channels = f.number_child<int> ("AudioChannels");
488 /* We used to allow odd numbers (and zero) channels, but it's just not worth
491 if (_audio_channels == 0) {
493 } else if ((_audio_channels % 2) == 1) {
497 if (f.optional_bool_child("SequenceVideo")) {
498 _sequence = f.bool_child("SequenceVideo");
500 _sequence = f.bool_child("Sequence");
503 _three_d = f.bool_child ("ThreeD");
504 _interop = f.bool_child ("Interop");
505 _key = dcp::Key (f.string_child ("Key"));
506 _context_id = f.optional_string_child("ContextID").get_value_or (dcp::make_uuid ());
508 if (f.optional_string_child ("AudioProcessor")) {
509 _audio_processor = AudioProcessor::from_id (f.string_child ("AudioProcessor"));
511 _audio_processor = 0;
514 _reel_type = static_cast<ReelType> (f.optional_number_child<int>("ReelType").get_value_or (static_cast<int>(REELTYPE_SINGLE)));
515 _reel_length = f.optional_number_child<int64_t>("ReelLength").get_value_or (2000000000);
516 _upload_after_make_dcp = f.optional_bool_child("UploadAfterMakeDCP").get_value_or (false);
517 _reencode_j2k = f.optional_bool_child("ReencodeJ2K").get_value_or(false);
520 /* This method is the only one that can return notes (so far) */
521 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
523 /* Write backtraces to this film's directory, until another film is loaded */
525 set_backtrace_file (file ("backtrace.txt"));
532 /** Given a directory name, return its full path within the Film's directory.
533 * @param d directory name within the Film's directory.
534 * @param create true to create the directory (and its parents) if they do not exist.
536 boost::filesystem::path
537 Film::dir (boost::filesystem::path d, bool create) const
539 DCPOMATIC_ASSERT (_directory);
541 boost::filesystem::path p;
542 p /= _directory.get();
546 boost::filesystem::create_directories (p);
552 /** Given a file or directory name, return its full path within the Film's directory.
553 * Any required parent directories will be created.
555 boost::filesystem::path
556 Film::file (boost::filesystem::path f) const
558 DCPOMATIC_ASSERT (_directory);
560 boost::filesystem::path p;
561 p /= _directory.get();
564 boost::filesystem::create_directories (p.parent_path ());
570 Film::mapped_audio_channels () const
574 if (audio_processor ()) {
575 /* Processors are mapped 1:1 to DCP outputs so we can work out mappings from there */
576 for (int i = 0; i < audio_processor()->out_channels(); ++i) {
577 mapped.push_back (i);
580 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
582 list<int> c = i->audio->mapping().mapped_output_channels ();
583 copy (c.begin(), c.end(), back_inserter (mapped));
594 /** @return a ISDCF-compliant name for a DCP of this film */
596 Film::isdcf_name (bool if_created_now) const
600 string raw_name = name ();
602 /* Split the raw name up into words */
603 vector<string> words;
604 split (words, raw_name, is_any_of (" _-"));
608 /* Add each word to fixed_name */
609 for (vector<string>::const_iterator i = words.begin(); i != words.end(); ++i) {
612 /* First letter is always capitalised */
613 w[0] = toupper (w[0]);
615 /* Count caps in w */
617 for (size_t i = 0; i < w.size(); ++i) {
618 if (isupper (w[i])) {
623 /* If w is all caps make the rest of it lower case, otherwise
626 if (caps == w.size ()) {
627 for (size_t i = 1; i < w.size(); ++i) {
628 w[i] = tolower (w[i]);
632 for (size_t i = 0; i < w.size(); ++i) {
637 if (fixed_name.length() > 14) {
638 fixed_name = fixed_name.substr (0, 14);
643 if (dcp_content_type()) {
644 d += "_" + dcp_content_type()->isdcf_name();
645 d += "-" + raw_convert<string>(isdcf_metadata().content_version);
648 ISDCFMetadata const dm = isdcf_metadata ();
650 if (dm.temp_version) {
654 if (dm.pre_release) {
662 if (!dm.chain.empty ()) {
670 if (dm.two_d_version_of_three_d) {
674 if (!dm.mastered_luminance.empty ()) {
675 d += "-" + dm.mastered_luminance;
678 if (video_frame_rate() != 24) {
679 d += "-" + raw_convert<string>(video_frame_rate());
683 d += "_" + container()->isdcf_name();
686 /* XXX: this uses the first bit of content only */
688 /* Interior aspect ratio. The standard says we don't do this for trailers, for some strange reason */
689 if (dcp_content_type() && dcp_content_type()->libdcp_kind() != dcp::TRAILER) {
690 Ratio const * content_ratio = 0;
691 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
693 /* Here's the first piece of video content */
694 if (i->video->scale().ratio ()) {
695 content_ratio = i->video->scale().ratio ();
697 content_ratio = Ratio::from_ratio (i->video->size().ratio ());
703 if (content_ratio && content_ratio != container()) {
704 /* This needs to be the numeric version of the ratio, and ::id() is close enough */
705 d += "-" + content_ratio->id();
709 if (!dm.audio_language.empty ()) {
710 d += "_" + dm.audio_language;
711 if (!dm.subtitle_language.empty()) {
713 /* I'm not clear on the precise details of the convention for CCAP labelling;
714 for now I'm just appending -CCAP if we have any closed captions.
717 bool burnt_in = true;
719 BOOST_FOREACH (shared_ptr<Content> i, content()) {
720 BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
721 if (j->type() == TEXT_OPEN_SUBTITLE && j->use() && !j->burn()) {
723 } else if (j->type() == TEXT_CLOSED_CAPTION) {
729 string language = dm.subtitle_language;
730 if (burnt_in && language != "XX") {
731 transform (language.begin(), language.end(), language.begin(), ::tolower);
733 transform (language.begin(), language.end(), language.begin(), ::toupper);
745 if (!dm.territory.empty ()) {
746 d += "_" + dm.territory;
747 if (dm.rating.empty ()) {
750 d += "-" + dm.rating;
754 /* Count mapped audio channels */
756 pair<int, int> ch = audio_channel_types (mapped_audio_channels(), audio_channels());
757 if (!ch.first && !ch.second) {
759 } else if (ch.first) {
760 d += String::compose("_%1%2", ch.first, ch.second);
765 d += "_" + resolution_to_string (_resolution);
767 if (!dm.studio.empty ()) {
768 d += "_" + dm.studio;
771 if (if_created_now) {
772 d += "_" + boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
774 d += "_" + boost::gregorian::to_iso_string (_isdcf_date);
777 if (!dm.facility.empty ()) {
778 d += "_" + dm.facility;
792 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
793 shared_ptr<const DCPContent> dc = dynamic_pointer_cast<const DCPContent> (i);
798 bool any_text = false;
799 for (int i = 0; i < TEXT_COUNT; ++i) {
800 if (dc->reference_text(static_cast<TextType>(i))) {
804 if (dc->reference_video() || dc->reference_audio() || any_text) {
818 /** @return name to give the DCP */
820 Film::dcp_name (bool if_created_now) const
823 if (use_isdcf_name()) {
824 return careful_string_filter (isdcf_name (if_created_now));
827 return careful_string_filter (name ());
831 Film::set_directory (boost::filesystem::path d)
838 Film::set_name (string n)
840 ChangeSignaller<Film> ch (this, NAME);
845 Film::set_use_isdcf_name (bool u)
847 ChangeSignaller<Film> ch (this, USE_ISDCF_NAME);
852 Film::set_dcp_content_type (DCPContentType const * t)
854 ChangeSignaller<Film> ch (this, DCP_CONTENT_TYPE);
855 _dcp_content_type = t;
859 Film::set_container (Ratio const * c)
861 ChangeSignaller<Film> ch (this, CONTAINER);
866 Film::set_resolution (Resolution r)
868 ChangeSignaller<Film> ch (this, RESOLUTION);
873 Film::set_j2k_bandwidth (int b)
875 ChangeSignaller<Film> ch (this, J2K_BANDWIDTH);
880 Film::set_isdcf_metadata (ISDCFMetadata m)
882 ChangeSignaller<Film> ch (this, ISDCF_METADATA);
887 Film::set_video_frame_rate (int f)
889 ChangeSignaller<Film> ch (this, VIDEO_FRAME_RATE);
890 _video_frame_rate = f;
894 Film::set_audio_channels (int c)
896 ChangeSignaller<Film> ch (this, AUDIO_CHANNELS);
901 Film::set_three_d (bool t)
903 ChangeSignaller<Film> ch (this, THREE_D);
906 if (_three_d && _isdcf_metadata.two_d_version_of_three_d) {
907 ChangeSignaller<Film> ch (this, ISDCF_METADATA);
908 _isdcf_metadata.two_d_version_of_three_d = false;
913 Film::set_interop (bool i)
915 ChangeSignaller<Film> ch (this, INTEROP);
920 Film::set_audio_processor (AudioProcessor const * processor)
922 ChangeSignaller<Film> ch1 (this, AUDIO_PROCESSOR);
923 ChangeSignaller<Film> ch2 (this, AUDIO_CHANNELS);
924 _audio_processor = processor;
928 Film::set_reel_type (ReelType t)
930 ChangeSignaller<Film> ch (this, REEL_TYPE);
934 /** @param r Desired reel length in bytes */
936 Film::set_reel_length (int64_t r)
938 ChangeSignaller<Film> ch (this, REEL_LENGTH);
943 Film::set_upload_after_make_dcp (bool u)
945 ChangeSignaller<Film> ch (this, UPLOAD_AFTER_MAKE_DCP);
946 _upload_after_make_dcp = u;
950 Film::set_reencode_j2k (bool r)
952 ChangeSignaller<Film> ch (this, REENCODE_J2K);
957 Film::signal_change (ChangeType type, int p)
959 signal_change (type, static_cast<Property>(p));
963 Film::signal_change (ChangeType type, Property p)
965 if (type == CHANGE_TYPE_DONE) {
968 if (p == Film::CONTENT) {
969 set_video_frame_rate (_playlist->best_video_frame_rate ());
972 emit (boost::bind (boost::ref (Change), type, p));
974 if (p == Film::VIDEO_FRAME_RATE || p == Film::SEQUENCE) {
975 /* We want to call Playlist::maybe_sequence but this must happen after the
976 main signal emission (since the butler will see that emission and un-suspend itself).
978 emit (boost::bind(&Playlist::maybe_sequence, _playlist.get(), shared_from_this()));
986 Film::set_isdcf_date_today ()
988 _isdcf_date = boost::gregorian::day_clock::local_day ();
991 boost::filesystem::path
992 Film::j2c_path (int reel, Frame frame, Eyes eyes, bool tmp) const
994 boost::filesystem::path p;
996 p /= video_identifier ();
999 snprintf(buffer, sizeof(buffer), "%08d_%08" PRId64, reel, frame);
1002 if (eyes == EYES_LEFT) {
1004 } else if (eyes == EYES_RIGHT) {
1018 /** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs */
1022 if (!directory ()) {
1023 return vector<CPLSummary> ();
1026 vector<CPLSummary> out;
1028 boost::filesystem::path const dir = directory().get();
1029 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
1031 boost::filesystem::is_directory (*i) &&
1032 i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
1038 DCPOMATIC_ASSERT (dcp.cpls().front()->file());
1041 i->path().leaf().string(),
1042 dcp.cpls().front()->id(),
1043 dcp.cpls().front()->annotation_text(),
1044 dcp.cpls().front()->file().get()
1057 Film::set_signed (bool s)
1059 ChangeSignaller<Film> ch (this, SIGNED);
1064 Film::set_encrypted (bool e)
1066 ChangeSignaller<Film> ch (this, ENCRYPTED);
1071 Film::set_key (dcp::Key key)
1073 ChangeSignaller<Film> ch (this, KEY);
1078 Film::content () const
1080 return _playlist->content ();
1083 /** @param content Content to add.
1084 * @param disable_audio_analysis true to never do automatic audio analysis, even if it is enabled in configuration.
1087 Film::examine_and_add_content (shared_ptr<Content> content, bool disable_audio_analysis)
1089 if (dynamic_pointer_cast<FFmpegContent> (content) && _directory) {
1090 run_ffprobe (content->path(0), file ("ffprobe.log"), _log);
1093 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), content));
1095 _job_connections.push_back (
1096 j->Finished.connect (bind (&Film::maybe_add_content, this, weak_ptr<Job>(j), weak_ptr<Content>(content), disable_audio_analysis))
1099 JobManager::instance()->add (j);
1103 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c, bool disable_audio_analysis)
1105 shared_ptr<Job> job = j.lock ();
1106 if (!job || !job->finished_ok ()) {
1110 shared_ptr<Content> content = c.lock ();
1115 add_content (content);
1117 if (Config::instance()->automatic_audio_analysis() && content->audio && !disable_audio_analysis) {
1118 shared_ptr<Playlist> playlist (new Playlist);
1119 playlist->add (shared_from_this(), content);
1120 boost::signals2::connection c;
1121 JobManager::instance()->analyse_audio (
1122 shared_from_this(), playlist, false, c, bind (&Film::audio_analysis_finished, this)
1124 _audio_analysis_connections.push_back (c);
1129 Film::add_content (shared_ptr<Content> c)
1131 /* Add {video,subtitle} content after any existing {video,subtitle} content */
1133 c->set_position (shared_from_this(), _playlist->video_end(shared_from_this()));
1134 } else if (!c->text.empty()) {
1135 c->set_position (shared_from_this(), _playlist->text_end(shared_from_this()));
1138 if (_template_film) {
1139 /* Take settings from the first piece of content of c's type in _template */
1140 BOOST_FOREACH (shared_ptr<Content> i, _template_film->content()) {
1141 c->take_settings_from (i);
1145 _playlist->add (shared_from_this(), c);
1149 Film::remove_content (shared_ptr<Content> c)
1151 _playlist->remove (c);
1155 Film::move_content_earlier (shared_ptr<Content> c)
1157 _playlist->move_earlier (shared_from_this(), c);
1161 Film::move_content_later (shared_ptr<Content> c)
1163 _playlist->move_later (shared_from_this(), c);
1166 /** @return length of the film from time 0 to the last thing on the playlist */
1168 Film::length () const
1170 return _playlist->length(shared_from_this()).ceil(video_frame_rate());
1174 Film::best_video_frame_rate () const
1176 return _playlist->best_video_frame_rate ();
1180 Film::active_frame_rate_change (DCPTime t) const
1182 return _playlist->active_frame_rate_change (t, video_frame_rate ());
1186 Film::playlist_content_change (ChangeType type, weak_ptr<Content> c, int p, bool frequent)
1188 if (p == ContentProperty::VIDEO_FRAME_RATE) {
1189 signal_change (type, Film::CONTENT);
1190 } else if (p == AudioContentProperty::STREAMS) {
1191 signal_change (type, Film::NAME);
1194 if (type == CHANGE_TYPE_DONE) {
1195 emit (boost::bind (boost::ref (ContentChange), type, c, p, frequent));
1197 ContentChange (type, c, p, frequent);
1202 Film::playlist_change (ChangeType type)
1204 signal_change (type, CONTENT);
1205 signal_change (type, NAME);
1209 Film::playlist_order_changed ()
1211 /* XXX: missing PENDING */
1212 signal_change (CHANGE_TYPE_DONE, CONTENT_ORDER);
1216 Film::audio_frame_rate () const
1218 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
1219 if (i->audio && i->audio->has_rate_above_48k ()) {
1228 Film::set_sequence (bool s)
1230 if (s == _sequence) {
1234 ChangeSignaller<Film> cc (this, SEQUENCE);
1236 _playlist->set_sequence (s);
1239 /** @return Size of the largest possible image in whatever resolution we are using */
1241 Film::full_frame () const
1243 switch (_resolution) {
1245 return dcp::Size (2048, 1080);
1247 return dcp::Size (4096, 2160);
1250 DCPOMATIC_ASSERT (false);
1251 return dcp::Size ();
1254 /** @return Size of the frame */
1256 Film::frame_size () const
1258 return fit_ratio_within (container()->ratio(), full_frame ());
1261 /** @param recipient KDM recipient certificate.
1262 * @param trusted_devices Certificate thumbprints of other trusted devices (can be empty).
1263 * @param cpl_file CPL filename.
1264 * @param from KDM from time expressed as a local time with an offset from UTC.
1265 * @param until KDM to time expressed as a local time with an offset from UTC.
1266 * @param formulation KDM formulation to use.
1267 * @param disable_forensic_marking_picture true to disable forensic marking of picture.
1268 * @param disable_forensic_marking_audio if not set, don't disable forensic marking of audio. If set to 0,
1269 * disable all forensic marking; if set above 0, disable forensic marking above that channel.
1273 dcp::Certificate recipient,
1274 vector<string> trusted_devices,
1275 boost::filesystem::path cpl_file,
1276 dcp::LocalTime from,
1277 dcp::LocalTime until,
1278 dcp::Formulation formulation,
1279 bool disable_forensic_marking_picture,
1280 optional<int> disable_forensic_marking_audio
1284 throw runtime_error (_("Cannot make a KDM as this project is not encrypted."));
1287 shared_ptr<const dcp::CPL> cpl (new dcp::CPL (cpl_file));
1288 shared_ptr<const dcp::CertificateChain> signer = Config::instance()->signer_chain ();
1289 if (!signer->valid ()) {
1290 throw InvalidSignerError ();
1293 /* Find keys that have been added to imported, encrypted DCP content */
1294 list<dcp::DecryptedKDMKey> imported_keys;
1295 BOOST_FOREACH (shared_ptr<Content> i, content()) {
1296 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent> (i);
1297 if (d && d->kdm()) {
1298 dcp::DecryptedKDM kdm (d->kdm().get(), Config::instance()->decryption_chain()->key().get());
1299 list<dcp::DecryptedKDMKey> keys = kdm.keys ();
1300 copy (keys.begin(), keys.end(), back_inserter (imported_keys));
1304 map<shared_ptr<const dcp::ReelMXF>, dcp::Key> keys;
1306 BOOST_FOREACH(shared_ptr<const dcp::ReelAsset> i, cpl->reel_assets ()) {
1307 shared_ptr<const dcp::ReelMXF> mxf = boost::dynamic_pointer_cast<const dcp::ReelMXF> (i);
1308 if (!mxf || !mxf->key_id()) {
1312 /* Get any imported key for this ID */
1314 BOOST_FOREACH (dcp::DecryptedKDMKey j, imported_keys) {
1315 if (j.id() == mxf->key_id().get()) {
1316 LOG_GENERAL ("Using imported key for %1", mxf->key_id().get());
1317 keys[mxf] = j.key();
1323 /* No imported key; it must be an asset that we encrypted */
1324 LOG_GENERAL ("Using our own key for %1", mxf->key_id().get());
1329 return dcp::DecryptedKDM (
1330 cpl->id(), keys, from, until, cpl->content_title_text(), cpl->content_title_text(), dcp::LocalTime().as_string()
1331 ).encrypt (signer, recipient, trusted_devices, formulation, disable_forensic_marking_picture, disable_forensic_marking_audio);
1334 /** @param screens Screens to make KDMs for.
1335 * @param cpl_file Path to CPL to make KDMs for.
1336 * @param from KDM from time expressed as a local time in the time zone of the Screen's Cinema.
1337 * @param until KDM to time expressed as a local time in the time zone of the Screen's Cinema.
1338 * @param formulation KDM formulation to use.
1339 * @param disable_forensic_marking_picture true to disable forensic marking of picture.
1340 * @param disable_forensic_marking_audio if not set, don't disable forensic marking of audio. If set to 0,
1341 * disable all forensic marking; if set above 0, disable forensic marking above that channel.
1345 list<shared_ptr<Screen> > screens,
1346 boost::filesystem::path cpl_file,
1347 boost::posix_time::ptime from,
1348 boost::posix_time::ptime until,
1349 dcp::Formulation formulation,
1350 bool disable_forensic_marking_picture,
1351 optional<int> disable_forensic_marking_audio
1354 list<ScreenKDM> kdms;
1356 BOOST_FOREACH (shared_ptr<Screen> i, screens) {
1358 dcp::EncryptedKDM const kdm = make_kdm (
1360 i->trusted_device_thumbprints(),
1362 dcp::LocalTime (from, i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute()),
1363 dcp::LocalTime (until, i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute()),
1365 disable_forensic_marking_picture,
1366 disable_forensic_marking_audio
1369 kdms.push_back (ScreenKDM (i, kdm));
1376 /** @return The approximate disk space required to encode a DCP of this film with the
1377 * current settings, in bytes.
1380 Film::required_disk_space () const
1382 return _playlist->required_disk_space (shared_from_this(), j2k_bandwidth(), audio_channels(), audio_frame_rate());
1385 /** This method checks the disk that the Film is on and tries to decide whether or not
1386 * there will be enough space to make a DCP for it. If so, true is returned; if not,
1387 * false is returned and required and available are filled in with the amount of disk space
1388 * required and available respectively (in Gb).
1390 * Note: the decision made by this method isn't, of course, 100% reliable.
1393 Film::should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const
1395 /* Create a test file and see if we can hard-link it */
1396 boost::filesystem::path test = internal_video_asset_dir() / "test";
1397 boost::filesystem::path test2 = internal_video_asset_dir() / "test2";
1398 can_hard_link = true;
1399 FILE* f = fopen_boost (test, "w");
1402 boost::system::error_code ec;
1403 boost::filesystem::create_hard_link (test, test2, ec);
1405 can_hard_link = false;
1407 boost::filesystem::remove (test);
1408 boost::filesystem::remove (test2);
1411 boost::filesystem::space_info s = boost::filesystem::space (internal_video_asset_dir ());
1412 required = double (required_disk_space ()) / 1073741824.0f;
1413 if (!can_hard_link) {
1416 available = double (s.available) / 1073741824.0f;
1417 return (available - required) > 1;
1421 Film::subtitle_language () const
1423 set<string> languages;
1425 BOOST_FOREACH (shared_ptr<Content> i, content()) {
1426 BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
1427 languages.insert (j->language ());
1432 BOOST_FOREACH (string s, languages) {
1433 if (!all.empty ()) {
1443 /** Change the gains of the supplied AudioMapping to make it a default
1444 * for this film. The defaults are guessed based on what processor (if any)
1445 * is in use, the number of input channels and any filename supplied.
1448 Film::make_audio_mapping_default (AudioMapping& mapping, optional<boost::filesystem::path> filename) const
1450 static string const regex[] = {
1451 ".*[\\._-]L[\\._-].*",
1452 ".*[\\._-]R[\\._-].*",
1453 ".*[\\._-]C[\\._-].*",
1454 ".*[\\._-]Lfe[\\._-].*",
1455 ".*[\\._-]Ls[\\._-].*",
1456 ".*[\\._-]Rs[\\._-].*"
1459 static int const regexes = sizeof(regex) / sizeof(*regex);
1461 if (audio_processor ()) {
1462 audio_processor()->make_audio_mapping_default (mapping);
1464 mapping.make_zero ();
1465 if (mapping.input_channels() == 1) {
1466 bool guessed = false;
1468 /* See if we can guess where this stream should go */
1470 for (int i = 0; i < regexes; ++i) {
1471 boost::regex e (regex[i], boost::regex::icase);
1472 if (boost::regex_match (filename->string(), e) && i < mapping.output_channels()) {
1473 mapping.set (0, i, 1);
1480 /* If we have no idea, just put it on centre */
1481 mapping.set (0, static_cast<int> (dcp::CENTRE), 1);
1485 for (int i = 0; i < min (mapping.input_channels(), mapping.output_channels()); ++i) {
1486 mapping.set (i, i, 1);
1492 /** @return The names of the channels that audio contents' outputs are passed into;
1493 * this is either the DCP or a AudioProcessor.
1496 Film::audio_output_names () const
1498 if (audio_processor ()) {
1499 return audio_processor()->input_names ();
1502 DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
1506 for (int i = 0; i < audio_channels(); ++i) {
1507 n.push_back (short_audio_channel_name (i));
1514 Film::repeat_content (ContentList c, int n)
1516 _playlist->repeat (shared_from_this(), c, n);
1520 Film::remove_content (ContentList c)
1522 _playlist->remove (c);
1526 Film::audio_analysis_finished ()
1532 Film::reels () const
1534 list<DCPTimePeriod> p;
1535 DCPTime const len = length();
1537 switch (reel_type ()) {
1538 case REELTYPE_SINGLE:
1539 p.push_back (DCPTimePeriod (DCPTime (), len));
1541 case REELTYPE_BY_VIDEO_CONTENT:
1543 optional<DCPTime> last_split;
1544 shared_ptr<Content> last_video;
1545 BOOST_FOREACH (shared_ptr<Content> c, content ()) {
1547 BOOST_FOREACH (DCPTime t, c->reel_split_points()) {
1549 p.push_back (DCPTimePeriod (last_split.get(), t));
1557 DCPTime video_end = last_video ? last_video->end(shared_from_this()) : DCPTime(0);
1559 /* Definitely go from the last split to the end of the video content */
1560 p.push_back (DCPTimePeriod (last_split.get(), video_end));
1563 if (video_end < len) {
1564 /* And maybe go after that as well if there is any non-video hanging over the end */
1565 p.push_back (DCPTimePeriod (video_end, len));
1569 case REELTYPE_BY_LENGTH:
1572 /* Integer-divide reel length by the size of one frame to give the number of frames per reel */
1573 Frame const reel_in_frames = _reel_length / ((j2k_bandwidth() / video_frame_rate()) / 8);
1574 while (current < len) {
1575 DCPTime end = min (len, current + DCPTime::from_frames (reel_in_frames, video_frame_rate ()));
1576 p.push_back (DCPTimePeriod (current, end));
1586 /** @param period A period within the DCP
1587 * @return Name of the content which most contributes to the given period.
1590 Film::content_summary (DCPTimePeriod period) const
1592 return _playlist->content_summary (shared_from_this(), period);
1596 Film::use_template (string name)
1598 _template_film.reset (new Film (optional<boost::filesystem::path>()));
1599 _template_film->read_metadata (Config::instance()->template_path (name));
1600 _use_isdcf_name = _template_film->_use_isdcf_name;
1601 _dcp_content_type = _template_film->_dcp_content_type;
1602 _container = _template_film->_container;
1603 _resolution = _template_film->_resolution;
1604 _j2k_bandwidth = _template_film->_j2k_bandwidth;
1605 _video_frame_rate = _template_film->_video_frame_rate;
1606 _signed = _template_film->_signed;
1607 _encrypted = _template_film->_encrypted;
1608 _audio_channels = _template_film->_audio_channels;
1609 _sequence = _template_film->_sequence;
1610 _three_d = _template_film->_three_d;
1611 _interop = _template_film->_interop;
1612 _audio_processor = _template_film->_audio_processor;
1613 _reel_type = _template_film->_reel_type;
1614 _reel_length = _template_film->_reel_length;
1615 _upload_after_make_dcp = _template_film->_upload_after_make_dcp;
1616 _isdcf_metadata = _template_film->_isdcf_metadata;
1619 pair<double, double>
1620 Film::speed_up_range (int dcp_frame_rate) const
1622 return _playlist->speed_up_range (dcp_frame_rate);
1626 Film::copy_from (shared_ptr<const Film> film)
1628 read_metadata (film->file (metadata_file));
1632 Film::references_dcp_video () const
1634 BOOST_FOREACH (shared_ptr<Content> i, _playlist->content()) {
1635 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent>(i);
1636 if (d && d->reference_video()) {
1645 Film::references_dcp_audio () const
1647 BOOST_FOREACH (shared_ptr<Content> i, _playlist->content()) {
1648 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent>(i);
1649 if (d && d->reference_audio()) {
1658 Film::closed_caption_tracks () const
1660 list<DCPTextTrack> tt;
1661 BOOST_FOREACH (shared_ptr<Content> i, content()) {
1662 BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
1663 /* XXX: Empty DCPTextTrack ends up being a magic value here */
1664 DCPTextTrack dtt = j->dcp_track().get_value_or(DCPTextTrack());
1665 if (j->type() == TEXT_CLOSED_CAPTION && find(tt.begin(), tt.end(), dtt) == tt.end()) {