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"
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 * Content only contains audio/subtitle-related tags if those things
115 int const Film::current_state_version = 34;
117 /** Construct a Film object in a given directory.
119 * @param dir Film directory.
122 Film::Film (boost::filesystem::path dir, bool log)
123 : _playlist (new Playlist)
124 , _use_isdcf_name (true)
125 , _dcp_content_type (Config::instance()->default_dcp_content_type ())
126 , _container (Config::instance()->default_container ())
127 , _resolution (RESOLUTION_2K)
130 , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
131 , _isdcf_metadata (Config::instance()->default_isdcf_metadata ())
132 , _video_frame_rate (24)
133 , _audio_channels (6)
136 , _interop (Config::instance()->default_interop ())
137 , _audio_processor (0)
138 , _reel_type (REELTYPE_SINGLE)
139 , _reel_length (2000000000)
140 , _upload_after_make_dcp (false)
141 , _state_version (current_state_version)
144 set_isdcf_date_today ();
146 _playlist_changed_connection = _playlist->Changed.connect (bind (&Film::playlist_changed, this));
147 _playlist_order_changed_connection = _playlist->OrderChanged.connect (bind (&Film::playlist_order_changed, this));
148 _playlist_content_changed_connection = _playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2, _3));
150 /* Make state.directory a complete path without ..s (where possible)
151 (Code swiped from Adam Bowen on stackoverflow)
152 XXX: couldn't/shouldn't this just be boost::filesystem::canonical?
155 boost::filesystem::path p (boost::filesystem::system_complete (dir));
156 boost::filesystem::path result;
157 for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
159 if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
162 result = result.parent_path ();
164 } else if (*i != ".") {
169 set_directory (result.make_preferred ());
171 _log.reset (new FileLog (file ("log")));
173 _log.reset (new NullLog);
176 _playlist->set_sequence (_sequence);
181 BOOST_FOREACH (boost::signals2::connection& i, _job_connections) {
185 BOOST_FOREACH (boost::signals2::connection& i, _audio_analysis_connections) {
191 Film::video_identifier () const
193 DCPOMATIC_ASSERT (container ());
196 s.imbue (std::locale::classic ());
198 s << container()->id()
199 << "_" << resolution_to_string (_resolution)
200 << "_" << _playlist->video_identifier()
201 << "_" << _video_frame_rate
202 << "_" << j2k_bandwidth();
223 /** @return The file to write video frame info to */
224 boost::filesystem::path
225 Film::info_file (DCPTimePeriod period) const
227 boost::filesystem::path p;
229 p /= video_identifier () + "_" + raw_convert<string> (period.from.get()) + "_" + raw_convert<string> (period.to.get());
233 boost::filesystem::path
234 Film::internal_video_asset_dir () const
236 return dir ("video");
239 boost::filesystem::path
240 Film::internal_video_asset_filename (DCPTimePeriod p) const
242 return video_identifier() + "_" + raw_convert<string> (p.from.get()) + "_" + raw_convert<string> (p.to.get()) + ".mxf";
245 boost::filesystem::path
246 Film::audio_analysis_path (shared_ptr<const Playlist> playlist) const
248 boost::filesystem::path p = dir ("analysis");
251 BOOST_FOREACH (shared_ptr<Content> i, playlist->content ()) {
256 digester.add (i->digest ());
257 digester.add (i->audio->mapping().digest ());
258 if (playlist->content().size() != 1) {
259 /* Analyses should be considered equal regardless of gain
260 if they were made from just one piece of content. This
261 is because we can fake any gain change in a single-content
262 analysis at the plotting stage rather than having to
265 digester.add (i->audio->gain ());
269 if (audio_processor ()) {
270 digester.add (audio_processor()->id ());
273 p /= digester.get ();
277 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
281 if (dcp_name().find ("/") != string::npos) {
282 throw BadSettingError (_("name"), _("cannot contain slashes"));
285 set_isdcf_date_today ();
287 BOOST_FOREACH (string i, environment_info ()) {
291 BOOST_FOREACH (shared_ptr<const Content> i, content ()) {
292 LOG_GENERAL ("Content: %1", i->technical_summary());
294 LOG_GENERAL ("DCP video rate %1 fps", video_frame_rate());
295 if (Config::instance()->only_servers_encode ()) {
296 LOG_GENERAL_NC ("0 threads: ONLY SERVERS SET TO ENCODE");
298 LOG_GENERAL ("%1 threads", Config::instance()->num_local_encoding_threads());
300 LOG_GENERAL ("J2K bandwidth %1", j2k_bandwidth());
302 if (container() == 0) {
303 throw MissingSettingError (_("container"));
306 if (content().empty()) {
307 throw runtime_error (_("You must add some content to the DCP before creating it"));
310 if (dcp_content_type() == 0) {
311 throw MissingSettingError (_("content type"));
314 if (name().empty()) {
315 throw MissingSettingError (_("name"));
318 JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
321 /** Start a job to send our DCP to the configured TMS */
323 Film::send_dcp_to_tms ()
325 shared_ptr<Job> j (new UploadJob (shared_from_this()));
326 JobManager::instance()->add (j);
329 shared_ptr<xmlpp::Document>
330 Film::metadata () const
332 shared_ptr<xmlpp::Document> doc (new xmlpp::Document);
333 xmlpp::Element* root = doc->create_root_node ("Metadata");
335 root->add_child("Version")->add_child_text (raw_convert<string> (current_state_version));
336 root->add_child("Name")->add_child_text (_name);
337 root->add_child("UseISDCFName")->add_child_text (_use_isdcf_name ? "1" : "0");
339 if (_dcp_content_type) {
340 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->isdcf_name ());
344 root->add_child("Container")->add_child_text (_container->id ());
347 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
348 root->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
349 _isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
350 root->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
351 root->add_child("ISDCFDate")->add_child_text (boost::gregorian::to_iso_string (_isdcf_date));
352 root->add_child("AudioChannels")->add_child_text (raw_convert<string> (_audio_channels));
353 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
354 root->add_child("Sequence")->add_child_text (_sequence ? "1" : "0");
355 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
356 root->add_child("Signed")->add_child_text (_signed ? "1" : "0");
357 root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
358 root->add_child("Key")->add_child_text (_key.hex ());
359 if (_audio_processor) {
360 root->add_child("AudioProcessor")->add_child_text (_audio_processor->id ());
362 root->add_child("ReelType")->add_child_text (raw_convert<string> (_reel_type));
363 root->add_child("ReelLength")->add_child_text (raw_convert<string> (_reel_length));
364 root->add_child("UploadAfterMakeDCP")->add_child_text (_upload_after_make_dcp ? "1" : "0");
365 _playlist->as_xml (root->add_child ("Playlist"));
370 /** Write state to our `metadata' file */
372 Film::write_metadata () const
374 boost::filesystem::create_directories (directory ());
375 shared_ptr<xmlpp::Document> doc = metadata ();
376 doc->write_to_file_formatted (file("metadata.xml").string ());
380 /** Read state from our metadata file.
381 * @return Notes about things that the user should know about, or empty.
384 Film::read_metadata ()
386 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
387 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!"));
390 cxml::Document f ("Metadata");
391 f.read_file (file ("metadata.xml"));
393 _state_version = f.number_child<int> ("Version");
394 if (_state_version > current_state_version) {
395 throw runtime_error (_("This film was created with a newer version of DCP-o-matic, and it cannot be loaded into this version. Sorry!"));
398 _name = f.string_child ("Name");
399 if (_state_version >= 9) {
400 _use_isdcf_name = f.bool_child ("UseISDCFName");
401 _isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
402 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("ISDCFDate"));
404 _use_isdcf_name = f.bool_child ("UseDCIName");
405 _isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
406 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
410 optional<string> c = f.optional_string_child ("DCPContentType");
412 _dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
417 optional<string> c = f.optional_string_child ("Container");
419 _container = Ratio::from_id (c.get ());
423 _resolution = string_to_resolution (f.string_child ("Resolution"));
424 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
425 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
426 _signed = f.optional_bool_child("Signed").get_value_or (true);
427 _encrypted = f.bool_child ("Encrypted");
428 _audio_channels = f.number_child<int> ("AudioChannels");
429 /* We used to allow odd numbers (and zero) channels, but it's just not worth
432 if (_audio_channels == 0) {
434 } else if ((_audio_channels % 2) == 1) {
438 if (f.optional_bool_child("SequenceVideo")) {
439 _sequence = f.bool_child("SequenceVideo");
441 _sequence = f.bool_child("Sequence");
444 _three_d = f.bool_child ("ThreeD");
445 _interop = f.bool_child ("Interop");
446 _key = dcp::Key (f.string_child ("Key"));
448 if (f.optional_string_child ("AudioProcessor")) {
449 _audio_processor = AudioProcessor::from_id (f.string_child ("AudioProcessor"));
451 _audio_processor = 0;
454 _reel_type = static_cast<ReelType> (f.optional_number_child<int>("ReelType").get_value_or (static_cast<int>(REELTYPE_SINGLE)));
455 _reel_length = f.optional_number_child<int64_t>("ReelLength").get_value_or (2000000000);
456 _upload_after_make_dcp = f.optional_bool_child("UploadAfterMakeDCP").get_value_or (false);
459 /* This method is the only one that can return notes (so far) */
460 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
462 /* Write backtraces to this film's directory, until another film is loaded */
463 set_backtrace_file (file ("backtrace.txt"));
469 /** Given a directory name, return its full path within the Film's directory.
470 * The directory (and its parents) will be created if they do not exist.
472 boost::filesystem::path
473 Film::dir (boost::filesystem::path d) const
475 boost::filesystem::path p;
479 boost::filesystem::create_directories (p);
484 /** Given a file or directory name, return its full path within the Film's directory.
485 * Any required parent directories will be created.
487 boost::filesystem::path
488 Film::file (boost::filesystem::path f) const
490 boost::filesystem::path p;
494 boost::filesystem::create_directories (p.parent_path ());
500 Film::mapped_audio_channels () const
504 if (audio_processor ()) {
505 /* Processors are mapped 1:1 to DCP outputs so we can work out mappings from there */
506 for (int i = 0; i < audio_processor()->out_channels(); ++i) {
507 mapped.push_back (i);
510 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
512 list<int> c = i->audio->mapping().mapped_output_channels ();
513 copy (c.begin(), c.end(), back_inserter (mapped));
524 /** @return a ISDCF-compliant name for a DCP of this film */
526 Film::isdcf_name (bool if_created_now) const
530 string raw_name = name ();
532 /* Split the raw name up into words */
533 vector<string> words;
534 split (words, raw_name, is_any_of (" _-"));
538 /* Add each word to fixed_name */
539 for (vector<string>::const_iterator i = words.begin(); i != words.end(); ++i) {
542 /* First letter is always capitalised */
543 w[0] = toupper (w[0]);
545 /* Count caps in w */
547 for (size_t i = 0; i < w.size(); ++i) {
548 if (isupper (w[i])) {
553 /* If w is all caps make the rest of it lower case, otherwise
556 if (caps == w.size ()) {
557 for (size_t i = 1; i < w.size(); ++i) {
558 w[i] = tolower (w[i]);
562 for (size_t i = 0; i < w.size(); ++i) {
567 if (fixed_name.length() > 14) {
568 fixed_name = fixed_name.substr (0, 14);
573 if (dcp_content_type()) {
574 d << "_" << dcp_content_type()->isdcf_name();
575 d << "-" << isdcf_metadata().content_version;
578 ISDCFMetadata const dm = isdcf_metadata ();
580 if (dm.temp_version) {
584 if (dm.pre_release) {
592 if (!dm.chain.empty ()) {
593 d << "-" << dm.chain;
600 if (dm.two_d_version_of_three_d) {
604 if (!dm.mastered_luminance.empty ()) {
605 d << "-" << dm.mastered_luminance;
608 if (video_frame_rate() != 24) {
609 d << "-" << video_frame_rate();
613 d << "_" << container()->isdcf_name();
616 /* XXX: this uses the first bit of content only */
618 /* The standard says we don't do this for trailers, for some strange reason */
619 if (dcp_content_type() && dcp_content_type()->libdcp_kind() != dcp::TRAILER) {
620 Ratio const * content_ratio = 0;
621 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
623 /* Here's the first piece of video content */
624 if (i->video->scale().ratio ()) {
625 content_ratio = i->video->scale().ratio ();
627 content_ratio = Ratio::from_ratio (i->video->size().ratio ());
633 if (content_ratio && content_ratio != container()) {
634 d << "-" << content_ratio->isdcf_name();
638 if (!dm.audio_language.empty ()) {
639 d << "_" << dm.audio_language;
640 if (!dm.subtitle_language.empty()) {
642 bool burnt_in = true;
643 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
648 if (i->subtitle->use() && !i->subtitle->burn()) {
653 string language = dm.subtitle_language;
654 if (burnt_in && language != "XX") {
655 transform (language.begin(), language.end(), language.begin(), ::tolower);
657 transform (language.begin(), language.end(), language.begin(), ::toupper);
660 d << "-" << language;
666 if (!dm.territory.empty ()) {
667 d << "_" << dm.territory;
668 if (dm.rating.empty ()) {
671 d << "-" << dm.rating;
675 /* Count mapped audio channels */
680 BOOST_FOREACH (int i, mapped_audio_channels ()) {
681 if (i >= audio_channels()) {
682 /* This channel is mapped but is not included in the DCP */
686 if (static_cast<dcp::Channel> (i) == dcp::LFE) {
694 d << "_" << non_lfe << lfe;
699 d << "_" << resolution_to_string (_resolution);
701 if (!dm.studio.empty ()) {
702 d << "_" << dm.studio;
705 if (if_created_now) {
706 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
708 d << "_" << boost::gregorian::to_iso_string (_isdcf_date);
711 if (!dm.facility.empty ()) {
712 d << "_" << dm.facility;
726 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
727 shared_ptr<const DCPContent> dc = dynamic_pointer_cast<const DCPContent> (i);
728 if (dc && (dc->reference_video() || dc->reference_audio() || dc->reference_subtitle())) {
742 /** @return name to give the DCP */
744 Film::dcp_name (bool if_created_now) const
747 if (use_isdcf_name()) {
748 unfiltered = isdcf_name (if_created_now);
750 unfiltered = name ();
753 /* Filter out `bad' characters which cause problems with some systems.
754 There's no apparent list of what really is allowed, so this is a guess.
758 string const allowed = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-_";
759 for (size_t i = 0; i < unfiltered.size(); ++i) {
760 if (allowed.find (unfiltered[i]) != string::npos) {
761 filtered += unfiltered[i];
769 Film::set_directory (boost::filesystem::path d)
776 Film::set_name (string n)
779 signal_changed (NAME);
783 Film::set_use_isdcf_name (bool u)
786 signal_changed (USE_ISDCF_NAME);
790 Film::set_dcp_content_type (DCPContentType const * t)
792 _dcp_content_type = t;
793 signal_changed (DCP_CONTENT_TYPE);
797 Film::set_container (Ratio const * c)
800 signal_changed (CONTAINER);
804 Film::set_resolution (Resolution r)
807 signal_changed (RESOLUTION);
811 Film::set_j2k_bandwidth (int b)
814 signal_changed (J2K_BANDWIDTH);
818 Film::set_isdcf_metadata (ISDCFMetadata m)
821 signal_changed (ISDCF_METADATA);
825 Film::set_video_frame_rate (int f)
827 _video_frame_rate = f;
828 signal_changed (VIDEO_FRAME_RATE);
832 Film::set_audio_channels (int c)
835 signal_changed (AUDIO_CHANNELS);
839 Film::set_three_d (bool t)
842 signal_changed (THREE_D);
844 if (_three_d && _isdcf_metadata.two_d_version_of_three_d) {
845 _isdcf_metadata.two_d_version_of_three_d = false;
846 signal_changed (ISDCF_METADATA);
851 Film::set_interop (bool i)
854 signal_changed (INTEROP);
858 Film::set_audio_processor (AudioProcessor const * processor)
860 _audio_processor = processor;
861 signal_changed (AUDIO_PROCESSOR);
862 signal_changed (AUDIO_CHANNELS);
866 Film::set_reel_type (ReelType t)
869 signal_changed (REEL_TYPE);
872 /** @param r Desired reel length in bytes */
874 Film::set_reel_length (int64_t r)
877 signal_changed (REEL_LENGTH);
881 Film::set_upload_after_make_dcp (bool u)
883 _upload_after_make_dcp = u;
884 signal_changed (UPLOAD_AFTER_MAKE_DCP);
888 Film::signal_changed (Property p)
894 set_video_frame_rate (_playlist->best_video_frame_rate ());
896 case Film::VIDEO_FRAME_RATE:
898 _playlist->maybe_sequence ();
904 emit (boost::bind (boost::ref (Changed), p));
908 Film::set_isdcf_date_today ()
910 _isdcf_date = boost::gregorian::day_clock::local_day ();
913 boost::filesystem::path
914 Film::j2c_path (int reel, Frame frame, Eyes eyes, bool tmp) const
916 boost::filesystem::path p;
918 p /= video_identifier ();
922 s << setfill('0') << reel << "_" << frame;
924 if (eyes == EYES_LEFT) {
926 } else if (eyes == EYES_RIGHT) {
940 /** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs */
944 vector<CPLSummary> out;
946 boost::filesystem::path const dir = directory ();
947 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
949 boost::filesystem::is_directory (*i) &&
950 i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
958 i->path().leaf().string(),
959 dcp.cpls().front()->id(),
960 dcp.cpls().front()->annotation_text(),
961 dcp.cpls().front()->file()
974 Film::set_signed (bool s)
977 signal_changed (SIGNED);
981 Film::set_encrypted (bool e)
984 signal_changed (ENCRYPTED);
988 Film::set_key (dcp::Key key)
991 signal_changed (KEY);
995 Film::content () const
997 return _playlist->content ();
1001 Film::examine_content (shared_ptr<Content> c)
1003 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
1004 JobManager::instance()->add (j);
1008 Film::examine_and_add_content (shared_ptr<Content> c)
1010 if (dynamic_pointer_cast<FFmpegContent> (c) && !_directory.empty ()) {
1011 run_ffprobe (c->path(0), file ("ffprobe.log"), _log);
1014 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
1016 _job_connections.push_back (
1017 j->Finished.connect (bind (&Film::maybe_add_content, this, weak_ptr<Job> (j), weak_ptr<Content> (c)))
1020 JobManager::instance()->add (j);
1024 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
1026 shared_ptr<Job> job = j.lock ();
1027 if (!job || !job->finished_ok ()) {
1031 shared_ptr<Content> content = c.lock ();
1036 add_content (content);
1037 if (Config::instance()->automatic_audio_analysis() && content->audio) {
1038 shared_ptr<Playlist> playlist (new Playlist);
1039 playlist->add (content);
1040 boost::signals2::connection c;
1041 JobManager::instance()->analyse_audio (
1042 shared_from_this (), playlist, c, bind (&Film::audio_analysis_finished, this)
1044 _audio_analysis_connections.push_back (c);
1049 Film::add_content (shared_ptr<Content> c)
1051 /* Add {video,subtitle} content after any existing {video,subtitle} content */
1053 c->set_position (_playlist->video_end ());
1054 } else if (c->subtitle) {
1055 c->set_position (_playlist->subtitle_end ());
1062 Film::remove_content (shared_ptr<Content> c)
1064 _playlist->remove (c);
1068 Film::move_content_earlier (shared_ptr<Content> c)
1070 _playlist->move_earlier (c);
1074 Film::move_content_later (shared_ptr<Content> c)
1076 _playlist->move_later (c);
1079 /** @return length of the film from time 0 to the last thing on the playlist */
1081 Film::length () const
1083 return _playlist->length ();
1087 Film::best_video_frame_rate () const
1089 return _playlist->best_video_frame_rate ();
1093 Film::active_frame_rate_change (DCPTime t) const
1095 return _playlist->active_frame_rate_change (t, video_frame_rate ());
1099 Film::playlist_content_changed (weak_ptr<Content> c, int p, bool frequent)
1103 if (p == ContentProperty::VIDEO_FRAME_RATE) {
1104 set_video_frame_rate (_playlist->best_video_frame_rate ());
1105 } else if (p == AudioContentProperty::STREAMS) {
1106 signal_changed (NAME);
1109 emit (boost::bind (boost::ref (ContentChanged), c, p, frequent));
1113 Film::playlist_changed ()
1115 signal_changed (CONTENT);
1116 signal_changed (NAME);
1120 Film::playlist_order_changed ()
1122 signal_changed (CONTENT_ORDER);
1126 Film::audio_frame_rate () const
1128 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
1129 if (i->audio && i->audio->has_rate_above_48k ()) {
1138 Film::set_sequence (bool s)
1141 _playlist->set_sequence (s);
1142 signal_changed (SEQUENCE);
1145 /** @return Size of the largest possible image in whatever resolution we are using */
1147 Film::full_frame () const
1149 switch (_resolution) {
1151 return dcp::Size (2048, 1080);
1153 return dcp::Size (4096, 2160);
1156 DCPOMATIC_ASSERT (false);
1157 return dcp::Size ();
1160 /** @return Size of the frame */
1162 Film::frame_size () const
1164 return fit_ratio_within (container()->ratio(), full_frame ());
1167 /** @param from KDM from time expressed as a local time with an offset from UTC
1168 * @param to KDM to time expressed as a local time with an offset from UTC
1172 dcp::Certificate recipient,
1173 vector<dcp::Certificate> trusted_devices,
1174 boost::filesystem::path cpl_file,
1175 dcp::LocalTime from,
1176 dcp::LocalTime until,
1177 dcp::Formulation formulation
1180 shared_ptr<const dcp::CPL> cpl (new dcp::CPL (cpl_file));
1181 shared_ptr<const dcp::CertificateChain> signer = Config::instance()->signer_chain ();
1182 if (!signer->valid ()) {
1183 throw InvalidSignerError ();
1186 return dcp::DecryptedKDM (
1187 cpl, key(), from, until, cpl->content_title_text(), cpl->content_title_text(), dcp::LocalTime().as_string()
1188 ).encrypt (signer, recipient, trusted_devices, formulation);
1191 /** @param from KDM from time expressed as a local time in the time zone of the Screen's Cinema.
1192 * @param to KDM to time expressed as a local time in the time zone of the Screen's Cinema.
1196 list<shared_ptr<Screen> > screens,
1197 boost::filesystem::path dcp,
1198 boost::posix_time::ptime from,
1199 boost::posix_time::ptime until,
1200 dcp::Formulation formulation
1203 list<ScreenKDM> kdms;
1205 BOOST_FOREACH (shared_ptr<Screen> i, screens) {
1207 dcp::EncryptedKDM const kdm = make_kdm (
1211 dcp::LocalTime (from, i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute()),
1212 dcp::LocalTime (until, i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute()),
1216 kdms.push_back (ScreenKDM (i, kdm));
1223 /** @return The approximate disk space required to encode a DCP of this film with the
1224 * current settings, in bytes.
1227 Film::required_disk_space () const
1229 return _playlist->required_disk_space (j2k_bandwidth(), audio_channels(), audio_frame_rate());
1232 /** This method checks the disk that the Film is on and tries to decide whether or not
1233 * there will be enough space to make a DCP for it. If so, true is returned; if not,
1234 * false is returned and required and available are filled in with the amount of disk space
1235 * required and available respectively (in Gb).
1237 * Note: the decision made by this method isn't, of course, 100% reliable.
1240 Film::should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const
1242 /* Create a test file and see if we can hard-link it */
1243 boost::filesystem::path test = internal_video_asset_dir() / "test";
1244 boost::filesystem::path test2 = internal_video_asset_dir() / "test2";
1245 can_hard_link = true;
1246 FILE* f = fopen_boost (test, "w");
1249 boost::system::error_code ec;
1250 boost::filesystem::create_hard_link (test, test2, ec);
1252 can_hard_link = false;
1254 boost::filesystem::remove (test);
1255 boost::filesystem::remove (test2);
1258 boost::filesystem::space_info s = boost::filesystem::space (internal_video_asset_dir ());
1259 required = double (required_disk_space ()) / 1073741824.0f;
1260 if (!can_hard_link) {
1263 available = double (s.available) / 1073741824.0f;
1264 return (available - required) > 1;
1268 Film::subtitle_language () const
1270 set<string> languages;
1272 ContentList cl = content ();
1273 BOOST_FOREACH (shared_ptr<Content>& c, cl) {
1275 languages.insert (c->subtitle->language ());
1280 BOOST_FOREACH (string s, languages) {
1281 if (!all.empty ()) {
1291 /** Change the gains of the supplied AudioMapping to make it a default
1292 * for this film. The defaults are guessed based on what processor (if any)
1293 * is in use and the number of input channels.
1296 Film::make_audio_mapping_default (AudioMapping& mapping) const
1298 if (audio_processor ()) {
1299 audio_processor()->make_audio_mapping_default (mapping);
1301 mapping.make_zero ();
1302 if (mapping.input_channels() == 1) {
1303 /* Mono -> Centre */
1304 mapping.set (0, static_cast<int> (dcp::CENTRE), 1);
1307 for (int i = 0; i < min (mapping.input_channels(), mapping.output_channels()); ++i) {
1308 mapping.set (i, i, 1);
1314 /** @return The names of the channels that audio contents' outputs are passed into;
1315 * this is either the DCP or a AudioProcessor.
1318 Film::audio_output_names () const
1320 if (audio_processor ()) {
1321 return audio_processor()->input_names ();
1324 DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
1327 n.push_back (_("L"));
1328 n.push_back (_("R"));
1329 n.push_back (_("C"));
1330 n.push_back (_("Lfe"));
1331 n.push_back (_("Ls"));
1332 n.push_back (_("Rs"));
1333 n.push_back (_("HI"));
1334 n.push_back (_("VI"));
1335 n.push_back (_("Lc"));
1336 n.push_back (_("Rc"));
1337 n.push_back (_("BsL"));
1338 n.push_back (_("BsR"));
1339 n.push_back (_("DBP"));
1340 n.push_back (_("DBS"));
1344 return vector<string> (n.begin(), n.begin() + audio_channels ());
1348 Film::repeat_content (ContentList c, int n)
1350 _playlist->repeat (c, n);
1354 Film::remove_content (ContentList c)
1356 _playlist->remove (c);
1360 Film::audio_analysis_finished ()
1366 Film::reels () const
1368 list<DCPTimePeriod> p;
1369 DCPTime const len = length().round_up (video_frame_rate ());
1371 switch (reel_type ()) {
1372 case REELTYPE_SINGLE:
1373 p.push_back (DCPTimePeriod (DCPTime (), len));
1375 case REELTYPE_BY_VIDEO_CONTENT:
1377 optional<DCPTime> last_split;
1378 shared_ptr<Content> last_video;
1379 ContentList cl = content ();
1380 BOOST_FOREACH (shared_ptr<Content> c, content ()) {
1382 BOOST_FOREACH (DCPTime t, c->reel_split_points()) {
1384 p.push_back (DCPTimePeriod (last_split.get(), t));
1392 DCPTime video_end = last_video ? last_video->end() : DCPTime(0);
1394 /* Definitely go from the last split to the end of the video content */
1395 p.push_back (DCPTimePeriod (last_split.get(), video_end));
1398 if (video_end < len) {
1399 /* And maybe go after that as well if there is any non-video hanging over the end */
1400 p.push_back (DCPTimePeriod (video_end, len));
1404 case REELTYPE_BY_LENGTH:
1407 /* Integer-divide reel length by the size of one frame to give the number of frames per reel */
1408 Frame const reel_in_frames = _reel_length / ((j2k_bandwidth() / video_frame_rate()) / 8);
1409 while (current < len) {
1410 DCPTime end = min (len, current + DCPTime::from_frames (reel_in_frames, video_frame_rate ()));
1411 p.push_back (DCPTimePeriod (current, end));