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 "environment_info.h"
42 #include "raw_convert.h"
43 #include "audio_processor.h"
45 #include "compose.hpp"
47 #include "audio_content.h"
48 #include "video_content.h"
49 #include "subtitle_content.h"
50 #include "ffmpeg_content.h"
51 #include "dcp_content.h"
52 #include "screen_kdm.h"
54 #include <libcxml/cxml.h>
56 #include <dcp/certificate_chain.h>
58 #include <dcp/local_time.h>
59 #include <dcp/decrypted_kdm.h>
60 #include <libxml++/libxml++.h>
61 #include <boost/filesystem.hpp>
62 #include <boost/algorithm/string.hpp>
63 #include <boost/foreach.hpp>
64 #include <boost/regex.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 * Content only contains audio/subtitle-related tags if those things
115 * VideoFrameType in VideoContent is a string rather than an integer.
117 * EffectColour rather than OutlineColour in Subtitle.
119 int const Film::current_state_version = 36;
121 /** Construct a Film object in a given directory.
123 * @param dir Film directory.
126 Film::Film (boost::filesystem::path dir, bool log)
127 : _playlist (new Playlist)
128 , _use_isdcf_name (true)
129 , _dcp_content_type (Config::instance()->default_dcp_content_type ())
130 , _container (Config::instance()->default_container ())
131 , _resolution (RESOLUTION_2K)
134 , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
135 , _isdcf_metadata (Config::instance()->default_isdcf_metadata ())
136 , _video_frame_rate (24)
137 , _audio_channels (Config::instance()->default_dcp_audio_channels ())
140 , _interop (Config::instance()->default_interop ())
141 , _audio_processor (0)
142 , _reel_type (REELTYPE_SINGLE)
143 , _reel_length (2000000000)
144 , _upload_after_make_dcp (false)
145 , _state_version (current_state_version)
148 set_isdcf_date_today ();
150 _playlist_changed_connection = _playlist->Changed.connect (bind (&Film::playlist_changed, this));
151 _playlist_order_changed_connection = _playlist->OrderChanged.connect (bind (&Film::playlist_order_changed, this));
152 _playlist_content_changed_connection = _playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2, _3));
154 /* Make state.directory a complete path without ..s (where possible)
155 (Code swiped from Adam Bowen on stackoverflow)
156 XXX: couldn't/shouldn't this just be boost::filesystem::canonical?
159 boost::filesystem::path p (boost::filesystem::system_complete (dir));
160 boost::filesystem::path result;
161 for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
163 if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
166 result = result.parent_path ();
168 } else if (*i != ".") {
173 set_directory (result.make_preferred ());
175 _log.reset (new FileLog (file ("log")));
177 _log.reset (new NullLog);
180 _playlist->set_sequence (_sequence);
185 BOOST_FOREACH (boost::signals2::connection& i, _job_connections) {
189 BOOST_FOREACH (boost::signals2::connection& i, _audio_analysis_connections) {
195 Film::video_identifier () const
197 DCPOMATIC_ASSERT (container ());
199 string s = container()->id()
200 + "_" + resolution_to_string (_resolution)
201 + "_" + _playlist->video_identifier()
202 + "_" + raw_convert<string>(_video_frame_rate)
203 + "_" + raw_convert<string>(j2k_bandwidth());
224 /** @return The file to write video frame info to */
225 boost::filesystem::path
226 Film::info_file (DCPTimePeriod period) const
228 boost::filesystem::path p;
230 p /= video_identifier () + "_" + raw_convert<string> (period.from.get()) + "_" + raw_convert<string> (period.to.get());
234 boost::filesystem::path
235 Film::internal_video_asset_dir () const
237 return dir ("video");
240 boost::filesystem::path
241 Film::internal_video_asset_filename (DCPTimePeriod p) const
243 return video_identifier() + "_" + raw_convert<string> (p.from.get()) + "_" + raw_convert<string> (p.to.get()) + ".mxf";
246 boost::filesystem::path
247 Film::audio_analysis_path (shared_ptr<const Playlist> playlist) const
249 boost::filesystem::path p = dir ("analysis");
252 BOOST_FOREACH (shared_ptr<Content> i, playlist->content ()) {
257 digester.add (i->digest ());
258 digester.add (i->audio->mapping().digest ());
259 if (playlist->content().size() != 1) {
260 /* Analyses should be considered equal regardless of gain
261 if they were made from just one piece of content. This
262 is because we can fake any gain change in a single-content
263 analysis at the plotting stage rather than having to
266 digester.add (i->audio->gain ());
270 if (audio_processor ()) {
271 digester.add (audio_processor()->id ());
274 p /= digester.get ();
278 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
282 if (dcp_name().find ("/") != string::npos) {
283 throw BadSettingError (_("name"), _("cannot contain slashes"));
286 set_isdcf_date_today ();
288 BOOST_FOREACH (string i, environment_info ()) {
292 BOOST_FOREACH (shared_ptr<const Content> i, content ()) {
293 LOG_GENERAL ("Content: %1", i->technical_summary());
295 LOG_GENERAL ("DCP video rate %1 fps", video_frame_rate());
296 if (Config::instance()->only_servers_encode ()) {
297 LOG_GENERAL_NC ("0 threads: ONLY SERVERS SET TO ENCODE");
299 LOG_GENERAL ("%1 threads", Config::instance()->num_local_encoding_threads());
301 LOG_GENERAL ("J2K bandwidth %1", j2k_bandwidth());
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()) {
316 throw MissingSettingError (_("name"));
319 JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
322 /** Start a job to send our DCP to the configured TMS */
324 Film::send_dcp_to_tms ()
326 shared_ptr<Job> j (new UploadJob (shared_from_this()));
327 JobManager::instance()->add (j);
330 shared_ptr<xmlpp::Document>
331 Film::metadata () const
333 shared_ptr<xmlpp::Document> doc (new xmlpp::Document);
334 xmlpp::Element* root = doc->create_root_node ("Metadata");
336 root->add_child("Version")->add_child_text (raw_convert<string> (current_state_version));
337 root->add_child("Name")->add_child_text (_name);
338 root->add_child("UseISDCFName")->add_child_text (_use_isdcf_name ? "1" : "0");
340 if (_dcp_content_type) {
341 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->isdcf_name ());
345 root->add_child("Container")->add_child_text (_container->id ());
348 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
349 root->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
350 _isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
351 root->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
352 root->add_child("ISDCFDate")->add_child_text (boost::gregorian::to_iso_string (_isdcf_date));
353 root->add_child("AudioChannels")->add_child_text (raw_convert<string> (_audio_channels));
354 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
355 root->add_child("Sequence")->add_child_text (_sequence ? "1" : "0");
356 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
357 root->add_child("Signed")->add_child_text (_signed ? "1" : "0");
358 root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
359 root->add_child("Key")->add_child_text (_key.hex ());
360 if (_audio_processor) {
361 root->add_child("AudioProcessor")->add_child_text (_audio_processor->id ());
363 root->add_child("ReelType")->add_child_text (raw_convert<string> (_reel_type));
364 root->add_child("ReelLength")->add_child_text (raw_convert<string> (_reel_length));
365 root->add_child("UploadAfterMakeDCP")->add_child_text (_upload_after_make_dcp ? "1" : "0");
366 _playlist->as_xml (root->add_child ("Playlist"));
371 /** Write state to our `metadata' file */
373 Film::write_metadata () const
375 boost::filesystem::create_directories (directory ());
376 shared_ptr<xmlpp::Document> doc = metadata ();
377 doc->write_to_file_formatted (file("metadata.xml").string ());
381 /** Read state from our metadata file.
382 * @return Notes about things that the user should know about, or empty.
385 Film::read_metadata ()
387 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
388 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!"));
391 cxml::Document f ("Metadata");
392 f.read_file (file ("metadata.xml"));
394 _state_version = f.number_child<int> ("Version");
395 if (_state_version > current_state_version) {
396 throw runtime_error (_("This film was created with a newer version of DCP-o-matic, and it cannot be loaded into this version. Sorry!"));
399 _name = f.string_child ("Name");
400 if (_state_version >= 9) {
401 _use_isdcf_name = f.bool_child ("UseISDCFName");
402 _isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
403 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("ISDCFDate"));
405 _use_isdcf_name = f.bool_child ("UseDCIName");
406 _isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
407 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
411 optional<string> c = f.optional_string_child ("DCPContentType");
413 _dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
418 optional<string> c = f.optional_string_child ("Container");
420 _container = Ratio::from_id (c.get ());
424 _resolution = string_to_resolution (f.string_child ("Resolution"));
425 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
426 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
427 _signed = f.optional_bool_child("Signed").get_value_or (true);
428 _encrypted = f.bool_child ("Encrypted");
429 _audio_channels = f.number_child<int> ("AudioChannels");
430 /* We used to allow odd numbers (and zero) channels, but it's just not worth
433 if (_audio_channels == 0) {
435 } else if ((_audio_channels % 2) == 1) {
439 if (f.optional_bool_child("SequenceVideo")) {
440 _sequence = f.bool_child("SequenceVideo");
442 _sequence = f.bool_child("Sequence");
445 _three_d = f.bool_child ("ThreeD");
446 _interop = f.bool_child ("Interop");
447 _key = dcp::Key (f.string_child ("Key"));
449 if (f.optional_string_child ("AudioProcessor")) {
450 _audio_processor = AudioProcessor::from_id (f.string_child ("AudioProcessor"));
452 _audio_processor = 0;
455 _reel_type = static_cast<ReelType> (f.optional_number_child<int>("ReelType").get_value_or (static_cast<int>(REELTYPE_SINGLE)));
456 _reel_length = f.optional_number_child<int64_t>("ReelLength").get_value_or (2000000000);
457 _upload_after_make_dcp = f.optional_bool_child("UploadAfterMakeDCP").get_value_or (false);
460 /* This method is the only one that can return notes (so far) */
461 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
463 /* Write backtraces to this film's directory, until another film is loaded */
464 set_backtrace_file (file ("backtrace.txt"));
470 /** Given a directory name, return its full path within the Film's directory.
471 * The directory (and its parents) will be created if they do not exist.
473 boost::filesystem::path
474 Film::dir (boost::filesystem::path d) const
476 boost::filesystem::path p;
480 boost::filesystem::create_directories (p);
485 /** Given a file or directory name, return its full path within the Film's directory.
486 * Any required parent directories will be created.
488 boost::filesystem::path
489 Film::file (boost::filesystem::path f) const
491 boost::filesystem::path p;
495 boost::filesystem::create_directories (p.parent_path ());
501 Film::mapped_audio_channels () const
505 if (audio_processor ()) {
506 /* Processors are mapped 1:1 to DCP outputs so we can work out mappings from there */
507 for (int i = 0; i < audio_processor()->out_channels(); ++i) {
508 mapped.push_back (i);
511 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
513 list<int> c = i->audio->mapping().mapped_output_channels ();
514 copy (c.begin(), c.end(), back_inserter (mapped));
525 /** @return a ISDCF-compliant name for a DCP of this film */
527 Film::isdcf_name (bool if_created_now) const
531 string raw_name = name ();
533 /* Split the raw name up into words */
534 vector<string> words;
535 split (words, raw_name, is_any_of (" _-"));
539 /* Add each word to fixed_name */
540 for (vector<string>::const_iterator i = words.begin(); i != words.end(); ++i) {
543 /* First letter is always capitalised */
544 w[0] = toupper (w[0]);
546 /* Count caps in w */
548 for (size_t i = 0; i < w.size(); ++i) {
549 if (isupper (w[i])) {
554 /* If w is all caps make the rest of it lower case, otherwise
557 if (caps == w.size ()) {
558 for (size_t i = 1; i < w.size(); ++i) {
559 w[i] = tolower (w[i]);
563 for (size_t i = 0; i < w.size(); ++i) {
568 if (fixed_name.length() > 14) {
569 fixed_name = fixed_name.substr (0, 14);
574 if (dcp_content_type()) {
575 d += "_" + dcp_content_type()->isdcf_name();
576 d += "-" + raw_convert<string>(isdcf_metadata().content_version);
579 ISDCFMetadata const dm = isdcf_metadata ();
581 if (dm.temp_version) {
585 if (dm.pre_release) {
593 if (!dm.chain.empty ()) {
601 if (dm.two_d_version_of_three_d) {
605 if (!dm.mastered_luminance.empty ()) {
606 d += "-" + dm.mastered_luminance;
609 if (video_frame_rate() != 24) {
610 d += "-" + raw_convert<string>(video_frame_rate());
614 d += "_" + container()->isdcf_name();
617 /* XXX: this uses the first bit of content only */
619 /* The standard says we don't do this for trailers, for some strange reason */
620 if (dcp_content_type() && dcp_content_type()->libdcp_kind() != dcp::TRAILER) {
621 Ratio const * content_ratio = 0;
622 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
624 /* Here's the first piece of video content */
625 if (i->video->scale().ratio ()) {
626 content_ratio = i->video->scale().ratio ();
628 content_ratio = Ratio::from_ratio (i->video->size().ratio ());
634 if (content_ratio && content_ratio != container()) {
635 d += "-" + content_ratio->isdcf_name();
639 if (!dm.audio_language.empty ()) {
640 d += "_" + dm.audio_language;
641 if (!dm.subtitle_language.empty()) {
643 bool burnt_in = true;
644 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
649 if (i->subtitle->use() && !i->subtitle->burn()) {
654 string language = dm.subtitle_language;
655 if (burnt_in && language != "XX") {
656 transform (language.begin(), language.end(), language.begin(), ::tolower);
658 transform (language.begin(), language.end(), language.begin(), ::toupper);
667 if (!dm.territory.empty ()) {
668 d += "_" + dm.territory;
669 if (dm.rating.empty ()) {
672 d += "-" + dm.rating;
676 /* Count mapped audio channels */
681 BOOST_FOREACH (int i, mapped_audio_channels ()) {
682 if (i >= audio_channels()) {
683 /* This channel is mapped but is not included in the DCP */
687 if (static_cast<dcp::Channel> (i) == dcp::LFE) {
695 d += String::compose("_%1%2", non_lfe, lfe);
700 d += "_" + resolution_to_string (_resolution);
702 if (!dm.studio.empty ()) {
703 d += "_" + dm.studio;
706 if (if_created_now) {
707 d += "_" + boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
709 d += "_" + boost::gregorian::to_iso_string (_isdcf_date);
712 if (!dm.facility.empty ()) {
713 d += "_" + dm.facility;
727 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
728 shared_ptr<const DCPContent> dc = dynamic_pointer_cast<const DCPContent> (i);
729 if (dc && (dc->reference_video() || dc->reference_audio() || dc->reference_subtitle())) {
743 /** @return name to give the DCP */
745 Film::dcp_name (bool if_created_now) const
748 if (use_isdcf_name()) {
749 unfiltered = isdcf_name (if_created_now);
751 unfiltered = name ();
754 /* Filter out `bad' characters which cause problems with some systems.
755 There's no apparent list of what really is allowed, so this is a guess.
759 string const allowed = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-_";
760 for (size_t i = 0; i < unfiltered.size(); ++i) {
761 if (allowed.find (unfiltered[i]) != string::npos) {
762 filtered += unfiltered[i];
770 Film::set_directory (boost::filesystem::path d)
777 Film::set_name (string n)
780 signal_changed (NAME);
784 Film::set_use_isdcf_name (bool u)
787 signal_changed (USE_ISDCF_NAME);
791 Film::set_dcp_content_type (DCPContentType const * t)
793 _dcp_content_type = t;
794 signal_changed (DCP_CONTENT_TYPE);
798 Film::set_container (Ratio const * c)
801 signal_changed (CONTAINER);
805 Film::set_resolution (Resolution r)
808 signal_changed (RESOLUTION);
812 Film::set_j2k_bandwidth (int b)
815 signal_changed (J2K_BANDWIDTH);
819 Film::set_isdcf_metadata (ISDCFMetadata m)
822 signal_changed (ISDCF_METADATA);
826 Film::set_video_frame_rate (int f)
828 _video_frame_rate = f;
829 signal_changed (VIDEO_FRAME_RATE);
833 Film::set_audio_channels (int c)
836 signal_changed (AUDIO_CHANNELS);
840 Film::set_three_d (bool t)
843 signal_changed (THREE_D);
845 if (_three_d && _isdcf_metadata.two_d_version_of_three_d) {
846 _isdcf_metadata.two_d_version_of_three_d = false;
847 signal_changed (ISDCF_METADATA);
852 Film::set_interop (bool i)
855 signal_changed (INTEROP);
859 Film::set_audio_processor (AudioProcessor const * processor)
861 _audio_processor = processor;
862 signal_changed (AUDIO_PROCESSOR);
863 signal_changed (AUDIO_CHANNELS);
867 Film::set_reel_type (ReelType t)
870 signal_changed (REEL_TYPE);
873 /** @param r Desired reel length in bytes */
875 Film::set_reel_length (int64_t r)
878 signal_changed (REEL_LENGTH);
882 Film::set_upload_after_make_dcp (bool u)
884 _upload_after_make_dcp = u;
885 signal_changed (UPLOAD_AFTER_MAKE_DCP);
889 Film::signal_changed (Property p)
895 set_video_frame_rate (_playlist->best_video_frame_rate ());
897 case Film::VIDEO_FRAME_RATE:
899 _playlist->maybe_sequence ();
905 emit (boost::bind (boost::ref (Changed), p));
909 Film::set_isdcf_date_today ()
911 _isdcf_date = boost::gregorian::day_clock::local_day ();
914 boost::filesystem::path
915 Film::j2c_path (int reel, Frame frame, Eyes eyes, bool tmp) const
917 boost::filesystem::path p;
919 p /= video_identifier ();
922 snprintf(buffer, sizeof(buffer), "%08d_%08" PRId64, reel, frame);
925 if (eyes == EYES_LEFT) {
927 } else if (eyes == EYES_RIGHT) {
941 /** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs */
945 vector<CPLSummary> out;
947 boost::filesystem::path const dir = directory ();
948 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
950 boost::filesystem::is_directory (*i) &&
951 i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
959 i->path().leaf().string(),
960 dcp.cpls().front()->id(),
961 dcp.cpls().front()->annotation_text(),
962 dcp.cpls().front()->file()
975 Film::set_signed (bool s)
978 signal_changed (SIGNED);
982 Film::set_encrypted (bool e)
985 signal_changed (ENCRYPTED);
989 Film::set_key (dcp::Key key)
992 signal_changed (KEY);
996 Film::content () const
998 return _playlist->content ();
1002 Film::examine_content (shared_ptr<Content> c)
1004 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
1005 JobManager::instance()->add (j);
1009 Film::examine_and_add_content (shared_ptr<Content> c)
1011 if (dynamic_pointer_cast<FFmpegContent> (c) && !_directory.empty ()) {
1012 run_ffprobe (c->path(0), file ("ffprobe.log"), _log);
1015 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
1017 _job_connections.push_back (
1018 j->Finished.connect (bind (&Film::maybe_add_content, this, weak_ptr<Job> (j), weak_ptr<Content> (c)))
1021 JobManager::instance()->add (j);
1025 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
1027 shared_ptr<Job> job = j.lock ();
1028 if (!job || !job->finished_ok ()) {
1032 shared_ptr<Content> content = c.lock ();
1037 add_content (content);
1038 if (Config::instance()->automatic_audio_analysis() && content->audio) {
1039 shared_ptr<Playlist> playlist (new Playlist);
1040 playlist->add (content);
1041 boost::signals2::connection c;
1042 JobManager::instance()->analyse_audio (
1043 shared_from_this (), playlist, c, bind (&Film::audio_analysis_finished, this)
1045 _audio_analysis_connections.push_back (c);
1050 Film::add_content (shared_ptr<Content> c)
1052 /* Add {video,subtitle} content after any existing {video,subtitle} content */
1054 c->set_position (_playlist->video_end ());
1055 } else if (c->subtitle) {
1056 c->set_position (_playlist->subtitle_end ());
1063 Film::remove_content (shared_ptr<Content> c)
1065 _playlist->remove (c);
1069 Film::move_content_earlier (shared_ptr<Content> c)
1071 _playlist->move_earlier (c);
1075 Film::move_content_later (shared_ptr<Content> c)
1077 _playlist->move_later (c);
1080 /** @return length of the film from time 0 to the last thing on the playlist */
1082 Film::length () const
1084 return _playlist->length ();
1088 Film::best_video_frame_rate () const
1090 return _playlist->best_video_frame_rate ();
1094 Film::active_frame_rate_change (DCPTime t) const
1096 return _playlist->active_frame_rate_change (t, video_frame_rate ());
1100 Film::playlist_content_changed (weak_ptr<Content> c, int p, bool frequent)
1104 if (p == ContentProperty::VIDEO_FRAME_RATE) {
1105 set_video_frame_rate (_playlist->best_video_frame_rate ());
1106 } else if (p == AudioContentProperty::STREAMS) {
1107 signal_changed (NAME);
1110 emit (boost::bind (boost::ref (ContentChanged), c, p, frequent));
1114 Film::playlist_changed ()
1116 signal_changed (CONTENT);
1117 signal_changed (NAME);
1121 Film::playlist_order_changed ()
1123 signal_changed (CONTENT_ORDER);
1127 Film::audio_frame_rate () const
1129 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
1130 if (i->audio && i->audio->has_rate_above_48k ()) {
1139 Film::set_sequence (bool s)
1142 _playlist->set_sequence (s);
1143 signal_changed (SEQUENCE);
1146 /** @return Size of the largest possible image in whatever resolution we are using */
1148 Film::full_frame () const
1150 switch (_resolution) {
1152 return dcp::Size (2048, 1080);
1154 return dcp::Size (4096, 2160);
1157 DCPOMATIC_ASSERT (false);
1158 return dcp::Size ();
1161 /** @return Size of the frame */
1163 Film::frame_size () const
1165 return fit_ratio_within (container()->ratio(), full_frame ());
1168 /** @param from KDM from time expressed as a local time with an offset from UTC
1169 * @param to KDM to time expressed as a local time with an offset from UTC
1173 dcp::Certificate recipient,
1174 vector<dcp::Certificate> trusted_devices,
1175 boost::filesystem::path cpl_file,
1176 dcp::LocalTime from,
1177 dcp::LocalTime until,
1178 dcp::Formulation formulation
1181 shared_ptr<const dcp::CPL> cpl (new dcp::CPL (cpl_file));
1182 shared_ptr<const dcp::CertificateChain> signer = Config::instance()->signer_chain ();
1183 if (!signer->valid ()) {
1184 throw InvalidSignerError ();
1187 return dcp::DecryptedKDM (
1188 cpl, key(), from, until, cpl->content_title_text(), cpl->content_title_text(), dcp::LocalTime().as_string()
1189 ).encrypt (signer, recipient, trusted_devices, formulation);
1192 /** @param from KDM from time expressed as a local time in the time zone of the Screen's Cinema.
1193 * @param to KDM to time expressed as a local time in the time zone of the Screen's Cinema.
1197 list<shared_ptr<Screen> > screens,
1198 boost::filesystem::path dcp,
1199 boost::posix_time::ptime from,
1200 boost::posix_time::ptime until,
1201 dcp::Formulation formulation
1204 list<ScreenKDM> kdms;
1206 BOOST_FOREACH (shared_ptr<Screen> i, screens) {
1208 dcp::EncryptedKDM const kdm = make_kdm (
1212 dcp::LocalTime (from, i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute()),
1213 dcp::LocalTime (until, i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute()),
1217 kdms.push_back (ScreenKDM (i, kdm));
1224 /** @return The approximate disk space required to encode a DCP of this film with the
1225 * current settings, in bytes.
1228 Film::required_disk_space () const
1230 return _playlist->required_disk_space (j2k_bandwidth(), audio_channels(), audio_frame_rate());
1233 /** This method checks the disk that the Film is on and tries to decide whether or not
1234 * there will be enough space to make a DCP for it. If so, true is returned; if not,
1235 * false is returned and required and available are filled in with the amount of disk space
1236 * required and available respectively (in Gb).
1238 * Note: the decision made by this method isn't, of course, 100% reliable.
1241 Film::should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const
1243 /* Create a test file and see if we can hard-link it */
1244 boost::filesystem::path test = internal_video_asset_dir() / "test";
1245 boost::filesystem::path test2 = internal_video_asset_dir() / "test2";
1246 can_hard_link = true;
1247 FILE* f = fopen_boost (test, "w");
1250 boost::system::error_code ec;
1251 boost::filesystem::create_hard_link (test, test2, ec);
1253 can_hard_link = false;
1255 boost::filesystem::remove (test);
1256 boost::filesystem::remove (test2);
1259 boost::filesystem::space_info s = boost::filesystem::space (internal_video_asset_dir ());
1260 required = double (required_disk_space ()) / 1073741824.0f;
1261 if (!can_hard_link) {
1264 available = double (s.available) / 1073741824.0f;
1265 return (available - required) > 1;
1269 Film::subtitle_language () const
1271 set<string> languages;
1273 ContentList cl = content ();
1274 BOOST_FOREACH (shared_ptr<Content>& c, cl) {
1276 languages.insert (c->subtitle->language ());
1281 BOOST_FOREACH (string s, languages) {
1282 if (!all.empty ()) {
1292 /** Change the gains of the supplied AudioMapping to make it a default
1293 * for this film. The defaults are guessed based on what processor (if any)
1294 * is in use, the number of input channels and any filename supplied.
1297 Film::make_audio_mapping_default (AudioMapping& mapping, optional<boost::filesystem::path> filename) const
1299 static string const regex[] = {
1300 ".*[\\._-]L[\\._-].*",
1301 ".*[\\._-]R[\\._-].*",
1302 ".*[\\._-]C[\\._-].*",
1303 ".*[\\._-]Lfe[\\._-].*",
1304 ".*[\\._-]Ls[\\._-].*",
1305 ".*[\\._-]Rs[\\._-].*"
1308 static int const regexes = sizeof(regex) / sizeof(*regex);
1310 if (audio_processor ()) {
1311 audio_processor()->make_audio_mapping_default (mapping);
1313 mapping.make_zero ();
1314 if (mapping.input_channels() == 1) {
1315 bool guessed = false;
1317 /* See if we can guess where this stream should go */
1319 for (int i = 0; i < regexes; ++i) {
1320 boost::regex e (regex[i], boost::regex::icase);
1321 if (boost::regex_match (filename->string(), e) && i < mapping.output_channels()) {
1322 mapping.set (0, i, 1);
1329 /* If we have no idea, just put it on centre */
1330 mapping.set (0, static_cast<int> (dcp::CENTRE), 1);
1334 for (int i = 0; i < min (mapping.input_channels(), mapping.output_channels()); ++i) {
1335 mapping.set (i, i, 1);
1341 /** @return The names of the channels that audio contents' outputs are passed into;
1342 * this is either the DCP or a AudioProcessor.
1345 Film::audio_output_names () const
1347 if (audio_processor ()) {
1348 return audio_processor()->input_names ();
1351 DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
1354 n.push_back (_("L"));
1355 n.push_back (_("R"));
1356 n.push_back (_("C"));
1357 n.push_back (_("Lfe"));
1358 n.push_back (_("Ls"));
1359 n.push_back (_("Rs"));
1360 n.push_back (_("HI"));
1361 n.push_back (_("VI"));
1362 n.push_back (_("Lc"));
1363 n.push_back (_("Rc"));
1364 n.push_back (_("BsL"));
1365 n.push_back (_("BsR"));
1366 n.push_back (_("DBP"));
1367 n.push_back (_("DBS"));
1371 return vector<string> (n.begin(), n.begin() + audio_channels ());
1375 Film::repeat_content (ContentList c, int n)
1377 _playlist->repeat (c, n);
1381 Film::remove_content (ContentList c)
1383 _playlist->remove (c);
1387 Film::audio_analysis_finished ()
1393 Film::reels () const
1395 list<DCPTimePeriod> p;
1396 DCPTime const len = length().round_up (video_frame_rate ());
1398 switch (reel_type ()) {
1399 case REELTYPE_SINGLE:
1400 p.push_back (DCPTimePeriod (DCPTime (), len));
1402 case REELTYPE_BY_VIDEO_CONTENT:
1404 optional<DCPTime> last_split;
1405 shared_ptr<Content> last_video;
1406 BOOST_FOREACH (shared_ptr<Content> c, content ()) {
1408 BOOST_FOREACH (DCPTime t, c->reel_split_points()) {
1410 p.push_back (DCPTimePeriod (last_split.get(), t));
1418 DCPTime video_end = last_video ? last_video->end() : DCPTime(0);
1420 /* Definitely go from the last split to the end of the video content */
1421 p.push_back (DCPTimePeriod (last_split.get(), video_end));
1424 if (video_end < len) {
1425 /* And maybe go after that as well if there is any non-video hanging over the end */
1426 p.push_back (DCPTimePeriod (video_end, len));
1430 case REELTYPE_BY_LENGTH:
1433 /* Integer-divide reel length by the size of one frame to give the number of frames per reel */
1434 Frame const reel_in_frames = _reel_length / ((j2k_bandwidth() / video_frame_rate()) / 8);
1435 while (current < len) {
1436 DCPTime end = min (len, current + DCPTime::from_frames (reel_in_frames, video_frame_rate ()));
1437 p.push_back (DCPTimePeriod (current, end));
1448 Film::content_summary (DCPTimePeriod period) const
1450 return _playlist->content_summary (period);