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 "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;
95 using boost::shared_ptr;
96 using boost::weak_ptr;
97 using boost::dynamic_pointer_cast;
98 using boost::optional;
99 using boost::is_any_of;
100 using dcp::raw_convert;
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 , _reencode_j2k (false)
159 , _state_version (current_state_version)
162 set_isdcf_date_today ();
164 _playlist_change_connection = _playlist->Change.connect (bind (&Film::playlist_change, this, _1));
165 _playlist_order_changed_connection = _playlist->OrderChanged.connect (bind (&Film::playlist_order_changed, this));
166 _playlist_content_change_connection = _playlist->ContentChange.connect (bind (&Film::playlist_content_change, this, _1, _2, _3, _4));
169 /* Make state.directory a complete path without ..s (where possible)
170 (Code swiped from Adam Bowen on stackoverflow)
171 XXX: couldn't/shouldn't this just be boost::filesystem::canonical?
174 boost::filesystem::path p (boost::filesystem::system_complete (dir.get()));
175 boost::filesystem::path result;
176 for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
178 if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
181 result = result.parent_path ();
183 } else if (*i != ".") {
188 set_directory (result.make_preferred ());
192 _log.reset (new FileLog (file ("log")));
194 _log.reset (new NullLog);
197 _playlist->set_sequence (_sequence);
202 BOOST_FOREACH (boost::signals2::connection& i, _job_connections) {
206 BOOST_FOREACH (boost::signals2::connection& i, _audio_analysis_connections) {
212 Film::video_identifier () const
214 DCPOMATIC_ASSERT (container ());
216 string s = container()->id()
217 + "_" + resolution_to_string (_resolution)
218 + "_" + _playlist->video_identifier()
219 + "_" + raw_convert<string>(_video_frame_rate)
220 + "_" + raw_convert<string>(j2k_bandwidth());
241 /** @return The file to write video frame info to */
242 boost::filesystem::path
243 Film::info_file (DCPTimePeriod period) const
245 boost::filesystem::path p;
247 p /= video_identifier () + "_" + raw_convert<string> (period.from.get()) + "_" + raw_convert<string> (period.to.get());
251 boost::filesystem::path
252 Film::internal_video_asset_dir () const
254 return dir ("video");
257 boost::filesystem::path
258 Film::internal_video_asset_filename (DCPTimePeriod p) const
260 return video_identifier() + "_" + raw_convert<string> (p.from.get()) + "_" + raw_convert<string> (p.to.get()) + ".mxf";
263 boost::filesystem::path
264 Film::audio_analysis_path (shared_ptr<const Playlist> playlist) const
266 boost::filesystem::path p = dir ("analysis");
269 BOOST_FOREACH (shared_ptr<Content> i, playlist->content ()) {
274 digester.add (i->digest ());
275 digester.add (i->audio->mapping().digest ());
276 if (playlist->content().size() != 1) {
277 /* Analyses should be considered equal regardless of gain
278 if they were made from just one piece of content. This
279 is because we can fake any gain change in a single-content
280 analysis at the plotting stage rather than having to
283 digester.add (i->audio->gain ());
287 if (audio_processor ()) {
288 digester.add (audio_processor()->id ());
291 p /= digester.get ();
295 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
299 if (dcp_name().find ("/") != string::npos) {
300 throw BadSettingError (_("name"), _("Cannot contain slashes"));
303 if (container() == 0) {
304 throw MissingSettingError (_("container"));
307 if (content().empty()) {
308 throw runtime_error (_("You must add some content to the DCP before creating it"));
311 if (dcp_content_type() == 0) {
312 throw MissingSettingError (_("content type"));
315 if (name().empty()) {
319 BOOST_FOREACH (shared_ptr<const Content> i, content ()) {
320 if (!i->paths_valid()) {
321 throw runtime_error (_("some of your content is missing"));
323 shared_ptr<const DCPContent> dcp = dynamic_pointer_cast<const DCPContent> (i);
324 if (dcp && dcp->needs_kdm()) {
325 throw runtime_error (_("Some of your content needs a KDM"));
327 if (dcp && dcp->needs_assets()) {
328 throw runtime_error (_("Some of your content needs an OV"));
332 set_isdcf_date_today ();
334 BOOST_FOREACH (string i, environment_info ()) {
338 BOOST_FOREACH (shared_ptr<const Content> i, content ()) {
339 LOG_GENERAL ("Content: %1", i->technical_summary());
341 LOG_GENERAL ("DCP video rate %1 fps", video_frame_rate());
342 if (Config::instance()->only_servers_encode ()) {
343 LOG_GENERAL_NC ("0 threads: ONLY SERVERS SET TO ENCODE");
345 LOG_GENERAL ("%1 threads", Config::instance()->master_encoding_threads());
347 LOG_GENERAL ("J2K bandwidth %1", j2k_bandwidth());
349 shared_ptr<TranscodeJob> tj (new TranscodeJob (shared_from_this()));
350 tj->set_encoder (shared_ptr<Encoder> (new DCPEncoder (shared_from_this(), tj)));
351 shared_ptr<CheckContentChangeJob> cc (new CheckContentChangeJob (shared_from_this(), tj));
352 JobManager::instance()->add (cc);
355 /** Start a job to send our DCP to the configured TMS */
357 Film::send_dcp_to_tms ()
359 shared_ptr<Job> j (new UploadJob (shared_from_this()));
360 JobManager::instance()->add (j);
363 shared_ptr<xmlpp::Document>
364 Film::metadata (bool with_content_paths) const
366 shared_ptr<xmlpp::Document> doc (new xmlpp::Document);
367 xmlpp::Element* root = doc->create_root_node ("Metadata");
369 root->add_child("Version")->add_child_text (raw_convert<string> (current_state_version));
370 root->add_child("Name")->add_child_text (_name);
371 root->add_child("UseISDCFName")->add_child_text (_use_isdcf_name ? "1" : "0");
373 if (_dcp_content_type) {
374 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->isdcf_name ());
378 root->add_child("Container")->add_child_text (_container->id ());
381 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
382 root->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
383 _isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
384 root->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
385 root->add_child("ISDCFDate")->add_child_text (boost::gregorian::to_iso_string (_isdcf_date));
386 root->add_child("AudioChannels")->add_child_text (raw_convert<string> (_audio_channels));
387 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
388 root->add_child("Sequence")->add_child_text (_sequence ? "1" : "0");
389 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
390 root->add_child("Signed")->add_child_text (_signed ? "1" : "0");
391 root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
392 root->add_child("Key")->add_child_text (_key.hex ());
393 root->add_child("ContextID")->add_child_text (_context_id);
394 if (_audio_processor) {
395 root->add_child("AudioProcessor")->add_child_text (_audio_processor->id ());
397 root->add_child("ReelType")->add_child_text (raw_convert<string> (static_cast<int> (_reel_type)));
398 root->add_child("ReelLength")->add_child_text (raw_convert<string> (_reel_length));
399 root->add_child("UploadAfterMakeDCP")->add_child_text (_upload_after_make_dcp ? "1" : "0");
400 root->add_child("ReencodeJ2K")->add_child_text (_reencode_j2k ? "1" : "0");
401 _playlist->as_xml (root->add_child ("Playlist"), with_content_paths);
407 Film::write_metadata (boost::filesystem::path path) const
409 shared_ptr<xmlpp::Document> doc = metadata ();
410 doc->write_to_file_formatted (path.string());
413 /** Write state to our `metadata' file */
415 Film::write_metadata () const
417 DCPOMATIC_ASSERT (directory());
418 boost::filesystem::create_directories (directory().get());
419 shared_ptr<xmlpp::Document> doc = metadata ();
420 doc->write_to_file_formatted (file(metadata_file).string ());
424 /** Write a template from this film */
426 Film::write_template (boost::filesystem::path path) const
428 boost::filesystem::create_directories (path.parent_path());
429 shared_ptr<xmlpp::Document> doc = metadata (false);
430 doc->write_to_file_formatted (path.string ());
433 /** Read state from our metadata file.
434 * @return Notes about things that the user should know about, or empty.
437 Film::read_metadata (optional<boost::filesystem::path> path)
440 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file (metadata_file))) {
441 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!"));
444 path = file (metadata_file);
447 cxml::Document f ("Metadata");
448 f.read_file (path.get ());
450 _state_version = f.number_child<int> ("Version");
451 if (_state_version > current_state_version) {
452 throw runtime_error (_("This film was created with a newer version of DCP-o-matic, and it cannot be loaded into this version. Sorry!"));
455 _name = f.string_child ("Name");
456 if (_state_version >= 9) {
457 _use_isdcf_name = f.bool_child ("UseISDCFName");
458 _isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
459 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("ISDCFDate"));
461 _use_isdcf_name = f.bool_child ("UseDCIName");
462 _isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
463 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
467 optional<string> c = f.optional_string_child ("DCPContentType");
469 _dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
474 optional<string> c = f.optional_string_child ("Container");
476 _container = Ratio::from_id (c.get ());
480 _resolution = string_to_resolution (f.string_child ("Resolution"));
481 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
482 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
483 _signed = f.optional_bool_child("Signed").get_value_or (true);
484 _encrypted = f.bool_child ("Encrypted");
485 _audio_channels = f.number_child<int> ("AudioChannels");
486 /* We used to allow odd numbers (and zero) channels, but it's just not worth
489 if (_audio_channels == 0) {
491 } else if ((_audio_channels % 2) == 1) {
495 if (f.optional_bool_child("SequenceVideo")) {
496 _sequence = f.bool_child("SequenceVideo");
498 _sequence = f.bool_child("Sequence");
501 _three_d = f.bool_child ("ThreeD");
502 _interop = f.bool_child ("Interop");
503 _key = dcp::Key (f.string_child ("Key"));
504 _context_id = f.optional_string_child("ContextID").get_value_or (dcp::make_uuid ());
506 if (f.optional_string_child ("AudioProcessor")) {
507 _audio_processor = AudioProcessor::from_id (f.string_child ("AudioProcessor"));
509 _audio_processor = 0;
512 _reel_type = static_cast<ReelType> (f.optional_number_child<int>("ReelType").get_value_or (static_cast<int>(REELTYPE_SINGLE)));
513 _reel_length = f.optional_number_child<int64_t>("ReelLength").get_value_or (2000000000);
514 _upload_after_make_dcp = f.optional_bool_child("UploadAfterMakeDCP").get_value_or (false);
515 _reencode_j2k = f.optional_bool_child("ReencodeJ2K").get_value_or(false);
518 /* This method is the only one that can return notes (so far) */
519 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
521 /* Write backtraces to this film's directory, until another film is loaded */
523 set_backtrace_file (file ("backtrace.txt"));
530 /** Given a directory name, return its full path within the Film's directory.
531 * @param d directory name within the Film's directory.
532 * @param create true to create the directory (and its parents) if they do not exist.
534 boost::filesystem::path
535 Film::dir (boost::filesystem::path d, bool create) const
537 DCPOMATIC_ASSERT (_directory);
539 boost::filesystem::path p;
540 p /= _directory.get();
544 boost::filesystem::create_directories (p);
550 /** Given a file or directory name, return its full path within the Film's directory.
551 * Any required parent directories will be created.
553 boost::filesystem::path
554 Film::file (boost::filesystem::path f) const
556 DCPOMATIC_ASSERT (_directory);
558 boost::filesystem::path p;
559 p /= _directory.get();
562 boost::filesystem::create_directories (p.parent_path ());
568 Film::mapped_audio_channels () const
572 if (audio_processor ()) {
573 /* Processors are mapped 1:1 to DCP outputs so we can work out mappings from there */
574 for (int i = 0; i < audio_processor()->out_channels(); ++i) {
575 mapped.push_back (i);
578 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
580 list<int> c = i->audio->mapping().mapped_output_channels ();
581 copy (c.begin(), c.end(), back_inserter (mapped));
592 /** @return a ISDCF-compliant name for a DCP of this film */
594 Film::isdcf_name (bool if_created_now) const
598 string raw_name = name ();
600 /* Split the raw name up into words */
601 vector<string> words;
602 split (words, raw_name, is_any_of (" _-"));
606 /* Add each word to fixed_name */
607 for (vector<string>::const_iterator i = words.begin(); i != words.end(); ++i) {
610 /* First letter is always capitalised */
611 w[0] = toupper (w[0]);
613 /* Count caps in w */
615 for (size_t i = 0; i < w.size(); ++i) {
616 if (isupper (w[i])) {
621 /* If w is all caps make the rest of it lower case, otherwise
624 if (caps == w.size ()) {
625 for (size_t i = 1; i < w.size(); ++i) {
626 w[i] = tolower (w[i]);
630 for (size_t i = 0; i < w.size(); ++i) {
635 if (fixed_name.length() > 14) {
636 fixed_name = fixed_name.substr (0, 14);
641 if (dcp_content_type()) {
642 d += "_" + dcp_content_type()->isdcf_name();
643 d += "-" + raw_convert<string>(isdcf_metadata().content_version);
646 ISDCFMetadata const dm = isdcf_metadata ();
648 if (dm.temp_version) {
652 if (dm.pre_release) {
660 if (!dm.chain.empty ()) {
668 if (dm.two_d_version_of_three_d) {
672 if (!dm.mastered_luminance.empty ()) {
673 d += "-" + dm.mastered_luminance;
676 if (video_frame_rate() != 24) {
677 d += "-" + raw_convert<string>(video_frame_rate());
681 d += "_" + container()->isdcf_name();
684 /* XXX: this uses the first bit of content only */
686 /* Interior aspect ratio. The standard says we don't do this for trailers, for some strange reason */
687 if (dcp_content_type() && dcp_content_type()->libdcp_kind() != dcp::TRAILER) {
688 Ratio const * content_ratio = 0;
689 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
691 /* Here's the first piece of video content */
692 if (i->video->scale().ratio ()) {
693 content_ratio = i->video->scale().ratio ();
695 content_ratio = Ratio::from_ratio (i->video->size().ratio ());
701 if (content_ratio && content_ratio != container()) {
702 /* This needs to be the numeric version of the ratio, and ::id() is close enough */
703 d += "-" + content_ratio->id();
707 if (!dm.audio_language.empty ()) {
708 d += "_" + dm.audio_language;
709 if (!dm.subtitle_language.empty()) {
711 /* I'm not clear on the precise details of the convention for CCAP labelling;
712 for now I'm just appending -CCAP if we have any closed captions.
715 bool burnt_in = true;
717 BOOST_FOREACH (shared_ptr<Content> i, content()) {
718 BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
719 if (j->type() == TEXT_OPEN_SUBTITLE && j->use() && !j->burn()) {
721 } else if (j->type() == TEXT_CLOSED_CAPTION) {
727 string language = dm.subtitle_language;
728 if (burnt_in && language != "XX") {
729 transform (language.begin(), language.end(), language.begin(), ::tolower);
731 transform (language.begin(), language.end(), language.begin(), ::toupper);
743 if (!dm.territory.empty ()) {
744 d += "_" + dm.territory;
745 if (dm.rating.empty ()) {
748 d += "-" + dm.rating;
752 /* Count mapped audio channels */
754 pair<int, int> ch = audio_channel_types (mapped_audio_channels(), audio_channels());
755 if (!ch.first && !ch.second) {
757 } else if (ch.first) {
758 d += String::compose("_%1%2", ch.first, ch.second);
763 d += "_" + resolution_to_string (_resolution);
765 if (!dm.studio.empty ()) {
766 d += "_" + dm.studio;
769 if (if_created_now) {
770 d += "_" + boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
772 d += "_" + boost::gregorian::to_iso_string (_isdcf_date);
775 if (!dm.facility.empty ()) {
776 d += "_" + dm.facility;
790 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
791 shared_ptr<const DCPContent> dc = dynamic_pointer_cast<const DCPContent> (i);
796 bool any_text = false;
797 for (int i = 0; i < TEXT_COUNT; ++i) {
798 if (dc->reference_text(static_cast<TextType>(i))) {
802 if (dc->reference_video() || dc->reference_audio() || any_text) {
816 /** @return name to give the DCP */
818 Film::dcp_name (bool if_created_now) const
821 if (use_isdcf_name()) {
822 return careful_string_filter (isdcf_name (if_created_now));
825 return careful_string_filter (name ());
829 Film::set_directory (boost::filesystem::path d)
836 Film::set_name (string n)
838 ChangeSignaller<Film> ch (this, NAME);
843 Film::set_use_isdcf_name (bool u)
845 ChangeSignaller<Film> ch (this, USE_ISDCF_NAME);
850 Film::set_dcp_content_type (DCPContentType const * t)
852 ChangeSignaller<Film> ch (this, DCP_CONTENT_TYPE);
853 _dcp_content_type = t;
857 Film::set_container (Ratio const * c)
859 ChangeSignaller<Film> ch (this, CONTAINER);
864 Film::set_resolution (Resolution r)
866 ChangeSignaller<Film> ch (this, RESOLUTION);
871 Film::set_j2k_bandwidth (int b)
873 ChangeSignaller<Film> ch (this, J2K_BANDWIDTH);
878 Film::set_isdcf_metadata (ISDCFMetadata m)
880 ChangeSignaller<Film> ch (this, ISDCF_METADATA);
885 Film::set_video_frame_rate (int f)
887 ChangeSignaller<Film> ch (this, VIDEO_FRAME_RATE);
888 _video_frame_rate = f;
892 Film::set_audio_channels (int c)
894 ChangeSignaller<Film> ch (this, AUDIO_CHANNELS);
899 Film::set_three_d (bool t)
901 ChangeSignaller<Film> ch (this, THREE_D);
904 if (_three_d && _isdcf_metadata.two_d_version_of_three_d) {
905 ChangeSignaller<Film> ch (this, ISDCF_METADATA);
906 _isdcf_metadata.two_d_version_of_three_d = false;
911 Film::set_interop (bool i)
913 ChangeSignaller<Film> ch (this, INTEROP);
918 Film::set_audio_processor (AudioProcessor const * processor)
920 ChangeSignaller<Film> ch1 (this, AUDIO_PROCESSOR);
921 ChangeSignaller<Film> ch2 (this, AUDIO_CHANNELS);
922 _audio_processor = processor;
926 Film::set_reel_type (ReelType t)
928 ChangeSignaller<Film> ch (this, REEL_TYPE);
932 /** @param r Desired reel length in bytes */
934 Film::set_reel_length (int64_t r)
936 ChangeSignaller<Film> ch (this, REEL_LENGTH);
941 Film::set_upload_after_make_dcp (bool u)
943 ChangeSignaller<Film> ch (this, UPLOAD_AFTER_MAKE_DCP);
944 _upload_after_make_dcp = u;
948 Film::set_reencode_j2k (bool r)
950 ChangeSignaller<Film> ch (this, REENCODE_J2K);
955 Film::signal_change (ChangeType type, int p)
957 signal_change (type, static_cast<Property>(p));
961 Film::signal_change (ChangeType type, Property p)
963 if (type == CHANGE_TYPE_DONE) {
966 if (p == Film::CONTENT) {
967 set_video_frame_rate (_playlist->best_video_frame_rate ());
970 emit (boost::bind (boost::ref (Change), type, p));
972 if (p == Film::VIDEO_FRAME_RATE || p == Film::SEQUENCE) {
973 /* We want to call Playlist::maybe_sequence but this must happen after the
974 main signal emission (since the butler will see that emission and un-suspend itself).
976 emit (boost::bind(&Playlist::maybe_sequence, _playlist.get(), shared_from_this()));
984 Film::set_isdcf_date_today ()
986 _isdcf_date = boost::gregorian::day_clock::local_day ();
989 boost::filesystem::path
990 Film::j2c_path (int reel, Frame frame, Eyes eyes, bool tmp) const
992 boost::filesystem::path p;
994 p /= video_identifier ();
997 snprintf(buffer, sizeof(buffer), "%08d_%08" PRId64, reel, frame);
1000 if (eyes == EYES_LEFT) {
1002 } else if (eyes == EYES_RIGHT) {
1016 /** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs */
1020 if (!directory ()) {
1021 return vector<CPLSummary> ();
1024 vector<CPLSummary> out;
1026 boost::filesystem::path const dir = directory().get();
1027 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
1029 boost::filesystem::is_directory (*i) &&
1030 i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
1036 DCPOMATIC_ASSERT (dcp.cpls().front()->file());
1039 i->path().leaf().string(),
1040 dcp.cpls().front()->id(),
1041 dcp.cpls().front()->annotation_text(),
1042 dcp.cpls().front()->file().get()
1055 Film::set_signed (bool s)
1057 ChangeSignaller<Film> ch (this, SIGNED);
1062 Film::set_encrypted (bool e)
1064 ChangeSignaller<Film> ch (this, ENCRYPTED);
1069 Film::set_key (dcp::Key key)
1071 ChangeSignaller<Film> ch (this, KEY);
1076 Film::content () const
1078 return _playlist->content ();
1081 /** @param content Content to add.
1082 * @param disable_audio_analysis true to never do automatic audio analysis, even if it is enabled in configuration.
1085 Film::examine_and_add_content (shared_ptr<Content> content, bool disable_audio_analysis)
1087 if (dynamic_pointer_cast<FFmpegContent> (content) && _directory) {
1088 run_ffprobe (content->path(0), file("ffprobe.log"));
1091 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), content));
1093 _job_connections.push_back (
1094 j->Finished.connect (bind (&Film::maybe_add_content, this, weak_ptr<Job>(j), weak_ptr<Content>(content), disable_audio_analysis))
1097 JobManager::instance()->add (j);
1101 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c, bool disable_audio_analysis)
1103 shared_ptr<Job> job = j.lock ();
1104 if (!job || !job->finished_ok ()) {
1108 shared_ptr<Content> content = c.lock ();
1113 add_content (content);
1115 if (Config::instance()->automatic_audio_analysis() && content->audio && !disable_audio_analysis) {
1116 shared_ptr<Playlist> playlist (new Playlist);
1117 playlist->add (shared_from_this(), content);
1118 boost::signals2::connection c;
1119 JobManager::instance()->analyse_audio (
1120 shared_from_this(), playlist, false, c, bind (&Film::audio_analysis_finished, this)
1122 _audio_analysis_connections.push_back (c);
1127 Film::add_content (shared_ptr<Content> c)
1129 /* Add {video,subtitle} content after any existing {video,subtitle} content */
1131 c->set_position (shared_from_this(), _playlist->video_end(shared_from_this()));
1132 } else if (!c->text.empty()) {
1133 c->set_position (shared_from_this(), _playlist->text_end(shared_from_this()));
1136 if (_template_film) {
1137 /* Take settings from the first piece of content of c's type in _template */
1138 BOOST_FOREACH (shared_ptr<Content> i, _template_film->content()) {
1139 c->take_settings_from (i);
1143 _playlist->add (shared_from_this(), c);
1147 Film::remove_content (shared_ptr<Content> c)
1149 _playlist->remove (c);
1153 Film::move_content_earlier (shared_ptr<Content> c)
1155 _playlist->move_earlier (shared_from_this(), c);
1159 Film::move_content_later (shared_ptr<Content> c)
1161 _playlist->move_later (shared_from_this(), c);
1164 /** @return length of the film from time 0 to the last thing on the playlist */
1166 Film::length () const
1168 return _playlist->length(shared_from_this()).ceil(video_frame_rate());
1172 Film::best_video_frame_rate () const
1174 return _playlist->best_video_frame_rate ();
1178 Film::active_frame_rate_change (DCPTime t) const
1180 return _playlist->active_frame_rate_change (t, video_frame_rate ());
1184 Film::playlist_content_change (ChangeType type, weak_ptr<Content> c, int p, bool frequent)
1186 if (p == ContentProperty::VIDEO_FRAME_RATE) {
1187 signal_change (type, Film::CONTENT);
1188 } else if (p == AudioContentProperty::STREAMS) {
1189 signal_change (type, Film::NAME);
1192 if (type == CHANGE_TYPE_DONE) {
1193 emit (boost::bind (boost::ref (ContentChange), type, c, p, frequent));
1195 ContentChange (type, c, p, frequent);
1200 Film::playlist_change (ChangeType type)
1202 signal_change (type, CONTENT);
1203 signal_change (type, NAME);
1207 Film::playlist_order_changed ()
1209 /* XXX: missing PENDING */
1210 signal_change (CHANGE_TYPE_DONE, CONTENT_ORDER);
1214 Film::audio_frame_rate () const
1216 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
1217 if (i->audio && i->audio->has_rate_above_48k ()) {
1226 Film::set_sequence (bool s)
1228 if (s == _sequence) {
1232 ChangeSignaller<Film> cc (this, SEQUENCE);
1234 _playlist->set_sequence (s);
1237 /** @return Size of the largest possible image in whatever resolution we are using */
1239 Film::full_frame () const
1241 switch (_resolution) {
1243 return dcp::Size (2048, 1080);
1245 return dcp::Size (4096, 2160);
1248 DCPOMATIC_ASSERT (false);
1249 return dcp::Size ();
1252 /** @return Size of the frame */
1254 Film::frame_size () const
1256 return fit_ratio_within (container()->ratio(), full_frame ());
1259 /** @param recipient KDM recipient certificate.
1260 * @param trusted_devices Certificate thumbprints of other trusted devices (can be empty).
1261 * @param cpl_file CPL filename.
1262 * @param from KDM from time expressed as a local time with an offset from UTC.
1263 * @param until KDM to time expressed as a local time with an offset from UTC.
1264 * @param formulation KDM formulation to use.
1265 * @param disable_forensic_marking_picture true to disable forensic marking of picture.
1266 * @param disable_forensic_marking_audio if not set, don't disable forensic marking of audio. If set to 0,
1267 * disable all forensic marking; if set above 0, disable forensic marking above that channel.
1271 dcp::Certificate recipient,
1272 vector<string> trusted_devices,
1273 boost::filesystem::path cpl_file,
1274 dcp::LocalTime from,
1275 dcp::LocalTime until,
1276 dcp::Formulation formulation,
1277 bool disable_forensic_marking_picture,
1278 optional<int> disable_forensic_marking_audio
1282 throw runtime_error (_("Cannot make a KDM as this project is not encrypted."));
1285 shared_ptr<const dcp::CPL> cpl (new dcp::CPL (cpl_file));
1286 shared_ptr<const dcp::CertificateChain> signer = Config::instance()->signer_chain ();
1287 if (!signer->valid ()) {
1288 throw InvalidSignerError ();
1291 /* Find keys that have been added to imported, encrypted DCP content */
1292 list<dcp::DecryptedKDMKey> imported_keys;
1293 BOOST_FOREACH (shared_ptr<Content> i, content()) {
1294 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent> (i);
1295 if (d && d->kdm()) {
1296 dcp::DecryptedKDM kdm (d->kdm().get(), Config::instance()->decryption_chain()->key().get());
1297 list<dcp::DecryptedKDMKey> keys = kdm.keys ();
1298 copy (keys.begin(), keys.end(), back_inserter (imported_keys));
1302 map<shared_ptr<const dcp::ReelMXF>, dcp::Key> keys;
1304 BOOST_FOREACH(shared_ptr<const dcp::ReelAsset> i, cpl->reel_assets ()) {
1305 shared_ptr<const dcp::ReelMXF> mxf = boost::dynamic_pointer_cast<const dcp::ReelMXF> (i);
1306 if (!mxf || !mxf->key_id()) {
1310 /* Get any imported key for this ID */
1312 BOOST_FOREACH (dcp::DecryptedKDMKey j, imported_keys) {
1313 if (j.id() == mxf->key_id().get()) {
1314 LOG_GENERAL ("Using imported key for %1", mxf->key_id().get());
1315 keys[mxf] = j.key();
1321 /* No imported key; it must be an asset that we encrypted */
1322 LOG_GENERAL ("Using our own key for %1", mxf->key_id().get());
1327 return dcp::DecryptedKDM (
1328 cpl->id(), keys, from, until, cpl->content_title_text(), cpl->content_title_text(), dcp::LocalTime().as_string()
1329 ).encrypt (signer, recipient, trusted_devices, formulation, disable_forensic_marking_picture, disable_forensic_marking_audio);
1332 /** @param screens Screens to make KDMs for.
1333 * @param cpl_file Path to CPL to make KDMs for.
1334 * @param from KDM from time expressed as a local time in the time zone of the Screen's Cinema.
1335 * @param until KDM to time expressed as a local time in the time zone of the Screen's Cinema.
1336 * @param formulation KDM formulation to use.
1337 * @param disable_forensic_marking_picture true to disable forensic marking of picture.
1338 * @param disable_forensic_marking_audio if not set, don't disable forensic marking of audio. If set to 0,
1339 * disable all forensic marking; if set above 0, disable forensic marking above that channel.
1343 list<shared_ptr<Screen> > screens,
1344 boost::filesystem::path cpl_file,
1345 boost::posix_time::ptime from,
1346 boost::posix_time::ptime until,
1347 dcp::Formulation formulation,
1348 bool disable_forensic_marking_picture,
1349 optional<int> disable_forensic_marking_audio
1352 list<ScreenKDM> kdms;
1354 BOOST_FOREACH (shared_ptr<Screen> i, screens) {
1356 dcp::EncryptedKDM const kdm = make_kdm (
1358 i->trusted_device_thumbprints(),
1360 dcp::LocalTime (from, i->cinema ? i->cinema->utc_offset_hour() : 0, i->cinema ? i->cinema->utc_offset_minute() : 0),
1361 dcp::LocalTime (until, i->cinema ? i->cinema->utc_offset_hour() : 0, i->cinema ? i->cinema->utc_offset_minute() : 0),
1363 disable_forensic_marking_picture,
1364 disable_forensic_marking_audio
1367 kdms.push_back (ScreenKDM (i, kdm));
1374 /** @return The approximate disk space required to encode a DCP of this film with the
1375 * current settings, in bytes.
1378 Film::required_disk_space () const
1380 return _playlist->required_disk_space (shared_from_this(), j2k_bandwidth(), audio_channels(), audio_frame_rate());
1383 /** This method checks the disk that the Film is on and tries to decide whether or not
1384 * there will be enough space to make a DCP for it. If so, true is returned; if not,
1385 * false is returned and required and available are filled in with the amount of disk space
1386 * required and available respectively (in Gb).
1388 * Note: the decision made by this method isn't, of course, 100% reliable.
1391 Film::should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const
1393 /* Create a test file and see if we can hard-link it */
1394 boost::filesystem::path test = internal_video_asset_dir() / "test";
1395 boost::filesystem::path test2 = internal_video_asset_dir() / "test2";
1396 can_hard_link = true;
1397 FILE* f = fopen_boost (test, "w");
1400 boost::system::error_code ec;
1401 boost::filesystem::create_hard_link (test, test2, ec);
1403 can_hard_link = false;
1405 boost::filesystem::remove (test);
1406 boost::filesystem::remove (test2);
1409 boost::filesystem::space_info s = boost::filesystem::space (internal_video_asset_dir ());
1410 required = double (required_disk_space ()) / 1073741824.0f;
1411 if (!can_hard_link) {
1414 available = double (s.available) / 1073741824.0f;
1415 return (available - required) > 1;
1419 Film::subtitle_language () const
1421 set<string> languages;
1423 BOOST_FOREACH (shared_ptr<Content> i, content()) {
1424 BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
1425 languages.insert (j->language ());
1430 BOOST_FOREACH (string s, languages) {
1431 if (!all.empty ()) {
1441 /** @return The names of the channels that audio contents' outputs are passed into;
1442 * this is either the DCP or a AudioProcessor.
1445 Film::audio_output_names () const
1447 if (audio_processor ()) {
1448 return audio_processor()->input_names ();
1451 DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
1455 for (int i = 0; i < audio_channels(); ++i) {
1456 n.push_back (short_audio_channel_name (i));
1463 Film::repeat_content (ContentList c, int n)
1465 _playlist->repeat (shared_from_this(), c, n);
1469 Film::remove_content (ContentList c)
1471 _playlist->remove (c);
1475 Film::audio_analysis_finished ()
1481 Film::reels () const
1483 list<DCPTimePeriod> p;
1484 DCPTime const len = length();
1486 switch (reel_type ()) {
1487 case REELTYPE_SINGLE:
1488 p.push_back (DCPTimePeriod (DCPTime (), len));
1490 case REELTYPE_BY_VIDEO_CONTENT:
1492 optional<DCPTime> last_split;
1493 shared_ptr<Content> last_video;
1494 BOOST_FOREACH (shared_ptr<Content> c, content ()) {
1496 BOOST_FOREACH (DCPTime t, c->reel_split_points(shared_from_this())) {
1498 p.push_back (DCPTimePeriod (last_split.get(), t));
1506 DCPTime video_end = last_video ? last_video->end(shared_from_this()) : DCPTime(0);
1508 /* Definitely go from the last split to the end of the video content */
1509 p.push_back (DCPTimePeriod (last_split.get(), video_end));
1512 if (video_end < len) {
1513 /* And maybe go after that as well if there is any non-video hanging over the end */
1514 p.push_back (DCPTimePeriod (video_end, len));
1518 case REELTYPE_BY_LENGTH:
1521 /* Integer-divide reel length by the size of one frame to give the number of frames per reel */
1522 Frame const reel_in_frames = _reel_length / ((j2k_bandwidth() / video_frame_rate()) / 8);
1523 while (current < len) {
1524 DCPTime end = min (len, current + DCPTime::from_frames (reel_in_frames, video_frame_rate ()));
1525 p.push_back (DCPTimePeriod (current, end));
1535 /** @param period A period within the DCP
1536 * @return Name of the content which most contributes to the given period.
1539 Film::content_summary (DCPTimePeriod period) const
1541 return _playlist->content_summary (shared_from_this(), period);
1545 Film::use_template (string name)
1547 _template_film.reset (new Film (optional<boost::filesystem::path>()));
1548 _template_film->read_metadata (Config::instance()->template_path (name));
1549 _use_isdcf_name = _template_film->_use_isdcf_name;
1550 _dcp_content_type = _template_film->_dcp_content_type;
1551 _container = _template_film->_container;
1552 _resolution = _template_film->_resolution;
1553 _j2k_bandwidth = _template_film->_j2k_bandwidth;
1554 _video_frame_rate = _template_film->_video_frame_rate;
1555 _signed = _template_film->_signed;
1556 _encrypted = _template_film->_encrypted;
1557 _audio_channels = _template_film->_audio_channels;
1558 _sequence = _template_film->_sequence;
1559 _three_d = _template_film->_three_d;
1560 _interop = _template_film->_interop;
1561 _audio_processor = _template_film->_audio_processor;
1562 _reel_type = _template_film->_reel_type;
1563 _reel_length = _template_film->_reel_length;
1564 _upload_after_make_dcp = _template_film->_upload_after_make_dcp;
1565 _isdcf_metadata = _template_film->_isdcf_metadata;
1568 pair<double, double>
1569 Film::speed_up_range (int dcp_frame_rate) const
1571 return _playlist->speed_up_range (dcp_frame_rate);
1575 Film::copy_from (shared_ptr<const Film> film)
1577 read_metadata (film->file (metadata_file));
1581 Film::references_dcp_video () const
1583 BOOST_FOREACH (shared_ptr<Content> i, _playlist->content()) {
1584 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent>(i);
1585 if (d && d->reference_video()) {
1594 Film::references_dcp_audio () const
1596 BOOST_FOREACH (shared_ptr<Content> i, _playlist->content()) {
1597 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent>(i);
1598 if (d && d->reference_audio()) {
1607 Film::closed_caption_tracks () const
1609 list<DCPTextTrack> tt;
1610 BOOST_FOREACH (shared_ptr<Content> i, content()) {
1611 BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
1612 /* XXX: Empty DCPTextTrack ends up being a magic value here */
1613 DCPTextTrack dtt = j->dcp_track().get_value_or(DCPTextTrack());
1614 if (j->type() == TEXT_CLOSED_CAPTION && find(tt.begin(), tt.end(), dtt) == tt.end()) {