2 Copyright (C) 2012-2016 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 and video content, and details of
23 * how they should be presented in a DCP.
29 #include "job_manager.h"
30 #include "transcode_job.h"
31 #include "upload_job.h"
34 #include "exceptions.h"
35 #include "examine_content_job.h"
38 #include "dcp_content_type.h"
41 #include "safe_stringstream.h"
42 #include "environment_info.h"
43 #include "raw_convert.h"
44 #include "audio_processor.h"
45 #include "md5_digester.h"
46 #include "compose.hpp"
48 #include "audio_content.h"
49 #include "video_content.h"
50 #include "subtitle_content.h"
51 #include "ffmpeg_content.h"
52 #include "dcp_content.h"
53 #include "screen_kdm.h"
55 #include <libcxml/cxml.h>
57 #include <dcp/certificate_chain.h>
59 #include <dcp/local_time.h>
60 #include <dcp/decrypted_kdm.h>
61 #include <libxml++/libxml++.h>
62 #include <boost/filesystem.hpp>
63 #include <boost/algorithm/string.hpp>
64 #include <boost/foreach.hpp>
85 using std::runtime_error;
86 using boost::shared_ptr;
87 using boost::weak_ptr;
88 using boost::dynamic_pointer_cast;
89 using boost::optional;
90 using boost::is_any_of;
92 #define LOG_GENERAL(...) log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
93 #define LOG_GENERAL_NC(...) log()->log (__VA_ARGS__, LogEntry::TYPE_GENERAL);
96 * AudioMapping XML changed.
98 * Subtitle offset changed to subtitle y offset, and subtitle x offset added.
100 * Use <Scale> tag in <VideoContent> rather than <Ratio>.
104 * Subtitle X and Y scale.
106 * Bumped to 32 for 2.0 branch; some times are expressed in Times rather
110 * Changed <Period> to <Subtitle> in FFmpegSubtitleStream
112 int const Film::current_state_version = 33;
114 /** Construct a Film object in a given directory.
116 * @param dir Film directory.
119 Film::Film (boost::filesystem::path dir, bool log)
120 : _playlist (new Playlist)
121 , _use_isdcf_name (true)
122 , _dcp_content_type (Config::instance()->default_dcp_content_type ())
123 , _container (Config::instance()->default_container ())
124 , _resolution (RESOLUTION_2K)
127 , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
128 , _isdcf_metadata (Config::instance()->default_isdcf_metadata ())
129 , _video_frame_rate (24)
130 , _audio_channels (6)
133 , _interop (Config::instance()->default_interop ())
134 , _audio_processor (0)
135 , _reel_type (REELTYPE_SINGLE)
136 , _reel_length (2000000000)
137 , _upload_after_make_dcp (false)
138 , _state_version (current_state_version)
141 set_isdcf_date_today ();
143 _playlist_changed_connection = _playlist->Changed.connect (bind (&Film::playlist_changed, this));
144 _playlist_order_changed_connection = _playlist->OrderChanged.connect (bind (&Film::playlist_order_changed, this));
145 _playlist_content_changed_connection = _playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2, _3));
147 /* Make state.directory a complete path without ..s (where possible)
148 (Code swiped from Adam Bowen on stackoverflow)
149 XXX: couldn't/shouldn't this just be boost::filesystem::canonical?
152 boost::filesystem::path p (boost::filesystem::system_complete (dir));
153 boost::filesystem::path result;
154 for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
156 if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
159 result = result.parent_path ();
161 } else if (*i != ".") {
166 set_directory (result.make_preferred ());
168 _log.reset (new FileLog (file ("log")));
170 _log.reset (new NullLog);
173 _playlist->set_sequence (_sequence);
178 BOOST_FOREACH (boost::signals2::connection& i, _job_connections) {
182 BOOST_FOREACH (boost::signals2::connection& i, _audio_analysis_connections) {
188 Film::video_identifier () const
190 DCPOMATIC_ASSERT (container ());
193 s.imbue (std::locale::classic ());
195 s << container()->id()
196 << "_" << resolution_to_string (_resolution)
197 << "_" << _playlist->video_identifier()
198 << "_" << _video_frame_rate
199 << "_" << j2k_bandwidth();
220 /** @return The file to write video frame info to */
221 boost::filesystem::path
222 Film::info_file (DCPTimePeriod period) const
224 boost::filesystem::path p;
226 p /= video_identifier () + "_" + raw_convert<string> (period.from.get()) + "_" + raw_convert<string> (period.to.get());
230 boost::filesystem::path
231 Film::internal_video_asset_dir () const
233 return dir ("video");
236 boost::filesystem::path
237 Film::internal_video_asset_filename (DCPTimePeriod p) const
239 return video_identifier() + "_" + raw_convert<string> (p.from.get()) + "_" + raw_convert<string> (p.to.get()) + ".mxf";
242 boost::filesystem::path
243 Film::audio_analysis_path (shared_ptr<const Playlist> playlist) const
245 boost::filesystem::path p = dir ("analysis");
247 MD5Digester digester;
248 BOOST_FOREACH (shared_ptr<Content> i, playlist->content ()) {
253 digester.add (i->digest ());
254 digester.add (i->audio->mapping().digest ());
255 if (playlist->content().size() != 1) {
256 /* Analyses should be considered equal regardless of gain
257 if they were made from just one piece of content. This
258 is because we can fake any gain change in a single-content
259 analysis at the plotting stage rather than having to
262 digester.add (i->audio->gain ());
266 if (audio_processor ()) {
267 digester.add (audio_processor()->id ());
270 p /= digester.get ();
274 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
278 if (dcp_name().find ("/") != string::npos) {
279 throw BadSettingError (_("name"), _("cannot contain slashes"));
282 set_isdcf_date_today ();
284 BOOST_FOREACH (string i, environment_info ()) {
288 BOOST_FOREACH (shared_ptr<const Content> i, content ()) {
289 LOG_GENERAL ("Content: %1", i->technical_summary());
291 LOG_GENERAL ("DCP video rate %1 fps", video_frame_rate());
292 if (Config::instance()->only_servers_encode ()) {
293 LOG_GENERAL_NC ("0 threads: ONLY SERVERS SET TO ENCODE");
295 LOG_GENERAL ("%1 threads", Config::instance()->num_local_encoding_threads());
297 LOG_GENERAL ("J2K bandwidth %1", j2k_bandwidth());
299 if (container() == 0) {
300 throw MissingSettingError (_("container"));
303 if (content().empty()) {
304 throw runtime_error (_("You must add some content to the DCP before creating it"));
307 if (dcp_content_type() == 0) {
308 throw MissingSettingError (_("content type"));
311 if (name().empty()) {
312 throw MissingSettingError (_("name"));
315 JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
318 /** Start a job to send our DCP to the configured TMS */
320 Film::send_dcp_to_tms ()
322 shared_ptr<Job> j (new UploadJob (shared_from_this()));
323 JobManager::instance()->add (j);
326 shared_ptr<xmlpp::Document>
327 Film::metadata () const
329 shared_ptr<xmlpp::Document> doc (new xmlpp::Document);
330 xmlpp::Element* root = doc->create_root_node ("Metadata");
332 root->add_child("Version")->add_child_text (raw_convert<string> (current_state_version));
333 root->add_child("Name")->add_child_text (_name);
334 root->add_child("UseISDCFName")->add_child_text (_use_isdcf_name ? "1" : "0");
336 if (_dcp_content_type) {
337 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->isdcf_name ());
341 root->add_child("Container")->add_child_text (_container->id ());
344 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
345 root->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
346 _isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
347 root->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
348 root->add_child("ISDCFDate")->add_child_text (boost::gregorian::to_iso_string (_isdcf_date));
349 root->add_child("AudioChannels")->add_child_text (raw_convert<string> (_audio_channels));
350 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
351 root->add_child("Sequence")->add_child_text (_sequence ? "1" : "0");
352 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
353 root->add_child("Signed")->add_child_text (_signed ? "1" : "0");
354 root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
355 root->add_child("Key")->add_child_text (_key.hex ());
356 if (_audio_processor) {
357 root->add_child("AudioProcessor")->add_child_text (_audio_processor->id ());
359 root->add_child("ReelType")->add_child_text (raw_convert<string> (_reel_type));
360 root->add_child("ReelLength")->add_child_text (raw_convert<string> (_reel_length));
361 root->add_child("UploadAfterMakeDCP")->add_child_text (_upload_after_make_dcp ? "1" : "0");
362 _playlist->as_xml (root->add_child ("Playlist"));
367 /** Write state to our `metadata' file */
369 Film::write_metadata () const
371 boost::filesystem::create_directories (directory ());
372 shared_ptr<xmlpp::Document> doc = metadata ();
373 doc->write_to_file_formatted (file("metadata.xml").string ());
377 /** Read state from our metadata file.
378 * @return Notes about things that the user should know about, or empty.
381 Film::read_metadata ()
383 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
384 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!"));
387 cxml::Document f ("Metadata");
388 f.read_file (file ("metadata.xml"));
390 _state_version = f.number_child<int> ("Version");
391 if (_state_version > current_state_version) {
392 throw runtime_error (_("This film was created with a newer version of DCP-o-matic, and it cannot be loaded into this version. Sorry!"));
395 _name = f.string_child ("Name");
396 if (_state_version >= 9) {
397 _use_isdcf_name = f.bool_child ("UseISDCFName");
398 _isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
399 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("ISDCFDate"));
401 _use_isdcf_name = f.bool_child ("UseDCIName");
402 _isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
403 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
407 optional<string> c = f.optional_string_child ("DCPContentType");
409 _dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
414 optional<string> c = f.optional_string_child ("Container");
416 _container = Ratio::from_id (c.get ());
420 _resolution = string_to_resolution (f.string_child ("Resolution"));
421 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
422 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
423 _signed = f.optional_bool_child("Signed").get_value_or (true);
424 _encrypted = f.bool_child ("Encrypted");
425 _audio_channels = f.number_child<int> ("AudioChannels");
426 /* We used to allow odd numbers (and zero) channels, but it's just not worth
429 if (_audio_channels == 0) {
431 } else if ((_audio_channels % 2) == 1) {
435 if (f.optional_bool_child("SequenceVideo")) {
436 _sequence = f.bool_child("SequenceVideo");
438 _sequence = f.bool_child("Sequence");
441 _three_d = f.bool_child ("ThreeD");
442 _interop = f.bool_child ("Interop");
443 _key = dcp::Key (f.string_child ("Key"));
445 if (f.optional_string_child ("AudioProcessor")) {
446 _audio_processor = AudioProcessor::from_id (f.string_child ("AudioProcessor"));
448 _audio_processor = 0;
451 _reel_type = static_cast<ReelType> (f.optional_number_child<int>("ReelType").get_value_or (static_cast<int>(REELTYPE_SINGLE)));
452 _reel_length = f.optional_number_child<int64_t>("ReelLength").get_value_or (2000000000);
453 _upload_after_make_dcp = f.optional_bool_child("UploadAfterMakeDCP").get_value_or (false);
456 /* This method is the only one that can return notes (so far) */
457 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
459 /* Write backtraces to this film's directory, until another film is loaded */
460 set_backtrace_file (file ("backtrace.txt"));
466 /** Given a directory name, return its full path within the Film's directory.
467 * The directory (and its parents) will be created if they do not exist.
469 boost::filesystem::path
470 Film::dir (boost::filesystem::path d) const
472 boost::filesystem::path p;
476 boost::filesystem::create_directories (p);
481 /** Given a file or directory name, return its full path within the Film's directory.
482 * Any required parent directories will be created.
484 boost::filesystem::path
485 Film::file (boost::filesystem::path f) const
487 boost::filesystem::path p;
491 boost::filesystem::create_directories (p.parent_path ());
497 Film::mapped_audio_channels () const
501 if (audio_processor ()) {
502 /* Processors are mapped 1:1 to DCP outputs so we can work out mappings from there */
503 for (int i = 0; i < audio_processor()->out_channels(); ++i) {
504 mapped.push_back (i);
507 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
509 list<int> c = i->audio->mapping().mapped_output_channels ();
510 copy (c.begin(), c.end(), back_inserter (mapped));
521 /** @return a ISDCF-compliant name for a DCP of this film */
523 Film::isdcf_name (bool if_created_now) const
527 string raw_name = name ();
529 /* Split the raw name up into words */
530 vector<string> words;
531 split (words, raw_name, is_any_of (" _-"));
535 /* Add each word to fixed_name */
536 for (vector<string>::const_iterator i = words.begin(); i != words.end(); ++i) {
539 /* First letter is always capitalised */
540 w[0] = toupper (w[0]);
542 /* Count caps in w */
544 for (size_t i = 0; i < w.size(); ++i) {
545 if (isupper (w[i])) {
550 /* If w is all caps make the rest of it lower case, otherwise
553 if (caps == w.size ()) {
554 for (size_t i = 1; i < w.size(); ++i) {
555 w[i] = tolower (w[i]);
559 for (size_t i = 0; i < w.size(); ++i) {
564 if (fixed_name.length() > 14) {
565 fixed_name = fixed_name.substr (0, 14);
570 if (dcp_content_type()) {
571 d << "_" << dcp_content_type()->isdcf_name();
572 d << "-" << isdcf_metadata().content_version;
575 ISDCFMetadata const dm = isdcf_metadata ();
577 if (dm.temp_version) {
581 if (dm.pre_release) {
589 if (!dm.chain.empty ()) {
590 d << "-" << dm.chain;
597 if (dm.two_d_version_of_three_d) {
601 if (!dm.mastered_luminance.empty ()) {
602 d << "-" << dm.mastered_luminance;
605 if (video_frame_rate() != 24) {
606 d << "-" << video_frame_rate();
610 d << "_" << container()->isdcf_name();
613 /* XXX: this uses the first bit of content only */
615 /* The standard says we don't do this for trailers, for some strange reason */
616 if (dcp_content_type() && dcp_content_type()->libdcp_kind() != dcp::TRAILER) {
617 Ratio const * content_ratio = 0;
618 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
620 /* Here's the first piece of video content */
621 if (i->video->scale().ratio ()) {
622 content_ratio = i->video->scale().ratio ();
624 content_ratio = Ratio::from_ratio (i->video->size().ratio ());
630 if (content_ratio && content_ratio != container()) {
631 d << "-" << content_ratio->isdcf_name();
635 if (!dm.audio_language.empty ()) {
636 d << "_" << dm.audio_language;
637 if (!dm.subtitle_language.empty()) {
639 bool burnt_in = true;
640 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
645 if (i->subtitle->use() && !i->subtitle->burn()) {
650 string language = dm.subtitle_language;
651 if (burnt_in && language != "XX") {
652 transform (language.begin(), language.end(), language.begin(), ::tolower);
654 transform (language.begin(), language.end(), language.begin(), ::toupper);
657 d << "-" << language;
663 if (!dm.territory.empty ()) {
664 d << "_" << dm.territory;
665 if (dm.rating.empty ()) {
668 d << "-" << dm.rating;
672 /* Count mapped audio channels */
677 BOOST_FOREACH (int i, mapped_audio_channels ()) {
678 if (i >= audio_channels()) {
679 /* This channel is mapped but is not included in the DCP */
683 if (static_cast<dcp::Channel> (i) == dcp::LFE) {
691 d << "_" << non_lfe << lfe;
696 d << "_" << resolution_to_string (_resolution);
698 if (!dm.studio.empty ()) {
699 d << "_" << dm.studio;
702 if (if_created_now) {
703 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
705 d << "_" << boost::gregorian::to_iso_string (_isdcf_date);
708 if (!dm.facility.empty ()) {
709 d << "_" << dm.facility;
723 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
724 shared_ptr<const DCPContent> dc = dynamic_pointer_cast<const DCPContent> (i);
725 if (dc && (dc->reference_video() || dc->reference_audio() || dc->reference_subtitle())) {
739 /** @return name to give the DCP */
741 Film::dcp_name (bool if_created_now) const
744 if (use_isdcf_name()) {
745 unfiltered = isdcf_name (if_created_now);
747 unfiltered = name ();
750 /* Filter out `bad' characters which cause problems with some systems.
751 There's no apparent list of what really is allowed, so this is a guess.
755 string const allowed = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-_";
756 for (size_t i = 0; i < unfiltered.size(); ++i) {
757 if (allowed.find (unfiltered[i]) != string::npos) {
758 filtered += unfiltered[i];
766 Film::set_directory (boost::filesystem::path d)
773 Film::set_name (string n)
776 signal_changed (NAME);
780 Film::set_use_isdcf_name (bool u)
783 signal_changed (USE_ISDCF_NAME);
787 Film::set_dcp_content_type (DCPContentType const * t)
789 _dcp_content_type = t;
790 signal_changed (DCP_CONTENT_TYPE);
794 Film::set_container (Ratio const * c)
797 signal_changed (CONTAINER);
801 Film::set_resolution (Resolution r)
804 signal_changed (RESOLUTION);
808 Film::set_j2k_bandwidth (int b)
811 signal_changed (J2K_BANDWIDTH);
815 Film::set_isdcf_metadata (ISDCFMetadata m)
818 signal_changed (ISDCF_METADATA);
822 Film::set_video_frame_rate (int f)
824 _video_frame_rate = f;
825 signal_changed (VIDEO_FRAME_RATE);
829 Film::set_audio_channels (int c)
832 signal_changed (AUDIO_CHANNELS);
836 Film::set_three_d (bool t)
839 signal_changed (THREE_D);
841 if (_three_d && _isdcf_metadata.two_d_version_of_three_d) {
842 _isdcf_metadata.two_d_version_of_three_d = false;
843 signal_changed (ISDCF_METADATA);
848 Film::set_interop (bool i)
851 signal_changed (INTEROP);
855 Film::set_audio_processor (AudioProcessor const * processor)
857 _audio_processor = processor;
858 signal_changed (AUDIO_PROCESSOR);
859 signal_changed (AUDIO_CHANNELS);
863 Film::set_reel_type (ReelType t)
866 signal_changed (REEL_TYPE);
869 /** @param r Desired reel length in bytes */
871 Film::set_reel_length (int64_t r)
874 signal_changed (REEL_LENGTH);
878 Film::set_upload_after_make_dcp (bool u)
880 _upload_after_make_dcp = u;
881 signal_changed (UPLOAD_AFTER_MAKE_DCP);
885 Film::signal_changed (Property p)
891 set_video_frame_rate (_playlist->best_video_frame_rate ());
893 case Film::VIDEO_FRAME_RATE:
895 _playlist->maybe_sequence ();
901 emit (boost::bind (boost::ref (Changed), p));
905 Film::set_isdcf_date_today ()
907 _isdcf_date = boost::gregorian::day_clock::local_day ();
910 boost::filesystem::path
911 Film::j2c_path (int reel, Frame frame, Eyes eyes, bool tmp) const
913 boost::filesystem::path p;
915 p /= video_identifier ();
919 s << setfill('0') << reel << "_" << frame;
921 if (eyes == EYES_LEFT) {
923 } else if (eyes == EYES_RIGHT) {
937 /** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs */
941 vector<CPLSummary> out;
943 boost::filesystem::path const dir = directory ();
944 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
946 boost::filesystem::is_directory (*i) &&
947 i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
955 i->path().leaf().string(),
956 dcp.cpls().front()->id(),
957 dcp.cpls().front()->annotation_text(),
958 dcp.cpls().front()->file()
971 Film::set_signed (bool s)
974 signal_changed (SIGNED);
978 Film::set_encrypted (bool e)
981 signal_changed (ENCRYPTED);
985 Film::set_key (dcp::Key key)
988 signal_changed (KEY);
992 Film::content () const
994 return _playlist->content ();
998 Film::examine_content (shared_ptr<Content> c)
1000 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
1001 JobManager::instance()->add (j);
1005 Film::examine_and_add_content (shared_ptr<Content> c)
1007 if (dynamic_pointer_cast<FFmpegContent> (c) && !_directory.empty ()) {
1008 run_ffprobe (c->path(0), file ("ffprobe.log"), _log);
1011 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
1013 _job_connections.push_back (
1014 j->Finished.connect (bind (&Film::maybe_add_content, this, weak_ptr<Job> (j), weak_ptr<Content> (c)))
1017 JobManager::instance()->add (j);
1021 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
1023 shared_ptr<Job> job = j.lock ();
1024 if (!job || !job->finished_ok ()) {
1028 shared_ptr<Content> content = c.lock ();
1033 add_content (content);
1034 if (Config::instance()->automatic_audio_analysis() && content->audio) {
1035 shared_ptr<Playlist> playlist (new Playlist);
1036 playlist->add (content);
1037 boost::signals2::connection c;
1038 JobManager::instance()->analyse_audio (
1039 shared_from_this (), playlist, c, bind (&Film::audio_analysis_finished, this)
1041 _audio_analysis_connections.push_back (c);
1046 Film::add_content (shared_ptr<Content> c)
1048 /* Add {video,subtitle} content after any existing {video,subtitle} content */
1050 c->set_position (_playlist->video_end ());
1051 } else if (c->subtitle) {
1052 c->set_position (_playlist->subtitle_end ());
1059 Film::remove_content (shared_ptr<Content> c)
1061 _playlist->remove (c);
1065 Film::move_content_earlier (shared_ptr<Content> c)
1067 _playlist->move_earlier (c);
1071 Film::move_content_later (shared_ptr<Content> c)
1073 _playlist->move_later (c);
1076 /** @return length of the film from time 0 to the last thing on the playlist */
1078 Film::length () const
1080 return _playlist->length ();
1084 Film::best_video_frame_rate () const
1086 return _playlist->best_video_frame_rate ();
1090 Film::active_frame_rate_change (DCPTime t) const
1092 return _playlist->active_frame_rate_change (t, video_frame_rate ());
1096 Film::playlist_content_changed (weak_ptr<Content> c, int p, bool frequent)
1100 if (p == ContentProperty::VIDEO_FRAME_RATE) {
1101 set_video_frame_rate (_playlist->best_video_frame_rate ());
1102 } else if (p == AudioContentProperty::STREAMS) {
1103 signal_changed (NAME);
1106 emit (boost::bind (boost::ref (ContentChanged), c, p, frequent));
1110 Film::playlist_changed ()
1112 signal_changed (CONTENT);
1113 signal_changed (NAME);
1117 Film::playlist_order_changed ()
1119 signal_changed (CONTENT_ORDER);
1123 Film::audio_frame_rate () const
1125 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
1126 if (i->audio && i->audio->has_rate_above_48k ()) {
1135 Film::set_sequence (bool s)
1138 _playlist->set_sequence (s);
1139 signal_changed (SEQUENCE);
1142 /** @return Size of the largest possible image in whatever resolution we are using */
1144 Film::full_frame () const
1146 switch (_resolution) {
1148 return dcp::Size (2048, 1080);
1150 return dcp::Size (4096, 2160);
1153 DCPOMATIC_ASSERT (false);
1154 return dcp::Size ();
1157 /** @return Size of the frame */
1159 Film::frame_size () const
1161 return fit_ratio_within (container()->ratio(), full_frame ());
1164 /** @param from KDM from time expressed as a local time with an offset from UTC
1165 * @param to KDM to time expressed as a local time with an offset from UTC
1169 dcp::Certificate recipient,
1170 vector<dcp::Certificate> trusted_devices,
1171 boost::filesystem::path cpl_file,
1172 dcp::LocalTime from,
1173 dcp::LocalTime until,
1174 dcp::Formulation formulation
1177 shared_ptr<const dcp::CPL> cpl (new dcp::CPL (cpl_file));
1178 shared_ptr<const dcp::CertificateChain> signer = Config::instance()->signer_chain ();
1179 if (!signer->valid ()) {
1180 throw InvalidSignerError ();
1183 return dcp::DecryptedKDM (
1184 cpl, key(), from, until, cpl->content_title_text(), cpl->content_title_text(), dcp::LocalTime().as_string()
1185 ).encrypt (signer, recipient, trusted_devices, formulation);
1188 /** @param from KDM from time expressed as a local time in the time zone of the Screen's Cinema.
1189 * @param to KDM to time expressed as a local time in the time zone of the Screen's Cinema.
1193 list<shared_ptr<Screen> > screens,
1194 boost::filesystem::path dcp,
1195 boost::posix_time::ptime from,
1196 boost::posix_time::ptime until,
1197 dcp::Formulation formulation
1200 list<ScreenKDM> kdms;
1202 BOOST_FOREACH (shared_ptr<Screen> i, screens) {
1204 dcp::EncryptedKDM const kdm = make_kdm (
1208 dcp::LocalTime (from, i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute()),
1209 dcp::LocalTime (until, i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute()),
1213 kdms.push_back (ScreenKDM (i, kdm));
1220 /** @return The approximate disk space required to encode a DCP of this film with the
1221 * current settings, in bytes.
1224 Film::required_disk_space () const
1226 return _playlist->required_disk_space (j2k_bandwidth(), audio_channels(), audio_frame_rate());
1229 /** This method checks the disk that the Film is on and tries to decide whether or not
1230 * there will be enough space to make a DCP for it. If so, true is returned; if not,
1231 * false is returned and required and available are filled in with the amount of disk space
1232 * required and available respectively (in Gb).
1234 * Note: the decision made by this method isn't, of course, 100% reliable.
1237 Film::should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const
1239 /* Create a test file and see if we can hard-link it */
1240 boost::filesystem::path test = internal_video_asset_dir() / "test";
1241 boost::filesystem::path test2 = internal_video_asset_dir() / "test2";
1242 can_hard_link = true;
1243 FILE* f = fopen_boost (test, "w");
1246 boost::system::error_code ec;
1247 boost::filesystem::create_hard_link (test, test2, ec);
1249 can_hard_link = false;
1251 boost::filesystem::remove (test);
1252 boost::filesystem::remove (test2);
1255 boost::filesystem::space_info s = boost::filesystem::space (internal_video_asset_dir ());
1256 required = double (required_disk_space ()) / 1073741824.0f;
1257 if (!can_hard_link) {
1260 available = double (s.available) / 1073741824.0f;
1261 return (available - required) > 1;
1265 Film::subtitle_language () const
1267 set<string> languages;
1269 ContentList cl = content ();
1270 BOOST_FOREACH (shared_ptr<Content>& c, cl) {
1272 languages.insert (c->subtitle->language ());
1277 BOOST_FOREACH (string s, languages) {
1278 if (!all.empty ()) {
1288 /** Change the gains of the supplied AudioMapping to make it a default
1289 * for this film. The defaults are guessed based on what processor (if any)
1290 * is in use and the number of input channels.
1293 Film::make_audio_mapping_default (AudioMapping& mapping) const
1295 if (audio_processor ()) {
1296 audio_processor()->make_audio_mapping_default (mapping);
1298 mapping.make_zero ();
1299 if (mapping.input_channels() == 1) {
1300 /* Mono -> Centre */
1301 mapping.set (0, static_cast<int> (dcp::CENTRE), 1);
1304 for (int i = 0; i < min (mapping.input_channels(), mapping.output_channels()); ++i) {
1305 mapping.set (i, i, 1);
1311 /** @return The names of the channels that audio contents' outputs are passed into;
1312 * this is either the DCP or a AudioProcessor.
1315 Film::audio_output_names () const
1317 if (audio_processor ()) {
1318 return audio_processor()->input_names ();
1321 DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
1324 n.push_back (_("L"));
1325 n.push_back (_("R"));
1326 n.push_back (_("C"));
1327 n.push_back (_("Lfe"));
1328 n.push_back (_("Ls"));
1329 n.push_back (_("Rs"));
1330 n.push_back (_("HI"));
1331 n.push_back (_("VI"));
1332 n.push_back (_("Lc"));
1333 n.push_back (_("Rc"));
1334 n.push_back (_("BsL"));
1335 n.push_back (_("BsR"));
1336 n.push_back (_("DBP"));
1337 n.push_back (_("DBS"));
1341 return vector<string> (n.begin(), n.begin() + audio_channels ());
1345 Film::repeat_content (ContentList c, int n)
1347 _playlist->repeat (c, n);
1351 Film::remove_content (ContentList c)
1353 _playlist->remove (c);
1357 Film::audio_analysis_finished ()
1363 Film::reels () const
1365 list<DCPTimePeriod> p;
1366 DCPTime const len = length().round_up (video_frame_rate ());
1368 switch (reel_type ()) {
1369 case REELTYPE_SINGLE:
1370 p.push_back (DCPTimePeriod (DCPTime (), len));
1372 case REELTYPE_BY_VIDEO_CONTENT:
1374 optional<DCPTime> last_split;
1375 shared_ptr<Content> last_video;
1376 ContentList cl = content ();
1377 BOOST_FOREACH (shared_ptr<Content> c, content ()) {
1379 BOOST_FOREACH (DCPTime t, c->reel_split_points()) {
1381 p.push_back (DCPTimePeriod (last_split.get(), t));
1389 DCPTime video_end = last_video ? last_video->end() : DCPTime(0);
1391 /* Definitely go from the last split to the end of the video content */
1392 p.push_back (DCPTimePeriod (last_split.get(), video_end));
1395 if (video_end < len) {
1396 /* And maybe go after that as well if there is any non-video hanging over the end */
1397 p.push_back (DCPTimePeriod (video_end, len));
1401 case REELTYPE_BY_LENGTH:
1404 /* Integer-divide reel length by the size of one frame to give the number of frames per reel */
1405 Frame const reel_in_frames = _reel_length / ((j2k_bandwidth() / video_frame_rate()) / 8);
1406 while (current < len) {
1407 DCPTime end = min (len, current + DCPTime::from_frames (reel_in_frames, video_frame_rate ()));
1408 p.push_back (DCPTimePeriod (current, end));