2 Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 * @brief A representation of some audio and video content, and details of
22 * how they should be presented in a DCP.
28 #include "job_manager.h"
29 #include "transcode_job.h"
30 #include "upload_job.h"
33 #include "exceptions.h"
34 #include "examine_content_job.h"
37 #include "dcp_content_type.h"
40 #include "safe_stringstream.h"
41 #include "environment_info.h"
42 #include "raw_convert.h"
43 #include "audio_processor.h"
44 #include "md5_digester.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>
84 using std::runtime_error;
85 using boost::shared_ptr;
86 using boost::weak_ptr;
87 using boost::dynamic_pointer_cast;
88 using boost::optional;
89 using boost::is_any_of;
91 #define LOG_GENERAL(...) log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
92 #define LOG_GENERAL_NC(...) log()->log (__VA_ARGS__, LogEntry::TYPE_GENERAL);
95 * AudioMapping XML changed.
97 * Subtitle offset changed to subtitle y offset, and subtitle x offset added.
99 * Use <Scale> tag in <VideoContent> rather than <Ratio>.
103 * Subtitle X and Y scale.
105 * Bumped to 32 for 2.0 branch; some times are expressed in Times rather
109 * Changed <Period> to <Subtitle> in FFmpegSubtitleStream
111 int const Film::current_state_version = 33;
113 /** Construct a Film object in a given directory.
115 * @param dir Film directory.
118 Film::Film (boost::filesystem::path dir, bool log)
119 : _playlist (new Playlist)
120 , _use_isdcf_name (true)
121 , _dcp_content_type (Config::instance()->default_dcp_content_type ())
122 , _container (Config::instance()->default_container ())
123 , _resolution (RESOLUTION_2K)
126 , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
127 , _isdcf_metadata (Config::instance()->default_isdcf_metadata ())
128 , _video_frame_rate (24)
129 , _audio_channels (6)
132 , _interop (Config::instance()->default_interop ())
133 , _audio_processor (0)
134 , _reel_type (REELTYPE_SINGLE)
135 , _reel_length (2000000000)
136 , _upload_after_make_dcp (false)
137 , _state_version (current_state_version)
140 set_isdcf_date_today ();
142 _playlist_changed_connection = _playlist->Changed.connect (bind (&Film::playlist_changed, this));
143 _playlist_order_changed_connection = _playlist->OrderChanged.connect (bind (&Film::playlist_order_changed, this));
144 _playlist_content_changed_connection = _playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2, _3));
146 /* Make state.directory a complete path without ..s (where possible)
147 (Code swiped from Adam Bowen on stackoverflow)
148 XXX: couldn't/shouldn't this just be boost::filesystem::canonical?
151 boost::filesystem::path p (boost::filesystem::system_complete (dir));
152 boost::filesystem::path result;
153 for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
155 if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
158 result = result.parent_path ();
160 } else if (*i != ".") {
165 set_directory (result.make_preferred ());
167 _log.reset (new FileLog (file ("log")));
169 _log.reset (new NullLog);
172 _playlist->set_sequence (_sequence);
177 BOOST_FOREACH (boost::signals2::connection& i, _job_connections) {
181 BOOST_FOREACH (boost::signals2::connection& i, _audio_analysis_connections) {
187 Film::video_identifier () const
189 DCPOMATIC_ASSERT (container ());
192 s.imbue (std::locale::classic ());
194 s << container()->id()
195 << "_" << resolution_to_string (_resolution)
196 << "_" << _playlist->video_identifier()
197 << "_" << _video_frame_rate
198 << "_" << j2k_bandwidth();
219 /** @return The file to write video frame info to */
220 boost::filesystem::path
221 Film::info_file (DCPTimePeriod period) const
223 boost::filesystem::path p;
225 p /= video_identifier () + "_" + raw_convert<string> (period.from.get()) + "_" + raw_convert<string> (period.to.get());
229 boost::filesystem::path
230 Film::internal_video_asset_dir () const
232 return dir ("video");
235 boost::filesystem::path
236 Film::internal_video_asset_filename (DCPTimePeriod p) const
238 return video_identifier() + "_" + raw_convert<string> (p.from.get()) + "_" + raw_convert<string> (p.to.get()) + ".mxf";
241 boost::filesystem::path
242 Film::audio_analysis_path (shared_ptr<const Playlist> playlist) const
244 boost::filesystem::path p = dir ("analysis");
246 MD5Digester digester;
247 BOOST_FOREACH (shared_ptr<Content> i, playlist->content ()) {
252 digester.add (i->digest ());
253 digester.add (i->audio->mapping().digest ());
254 if (playlist->content().size() != 1) {
255 /* Analyses should be considered equal regardless of gain
256 if they were made from just one piece of content. This
257 is because we can fake any gain change in a single-content
258 analysis at the plotting stage rather than having to
261 digester.add (i->audio->gain ());
265 if (audio_processor ()) {
266 digester.add (audio_processor()->id ());
269 p /= digester.get ();
273 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
277 if (dcp_name().find ("/") != string::npos) {
278 throw BadSettingError (_("name"), _("cannot contain slashes"));
281 set_isdcf_date_today ();
283 BOOST_FOREACH (string i, environment_info ()) {
287 BOOST_FOREACH (shared_ptr<const Content> i, content ()) {
288 LOG_GENERAL ("Content: %1", i->technical_summary());
290 LOG_GENERAL ("DCP video rate %1 fps", video_frame_rate());
291 if (Config::instance()->only_servers_encode ()) {
292 LOG_GENERAL_NC ("0 threads: ONLY SERVERS SET TO ENCODE");
294 LOG_GENERAL ("%1 threads", Config::instance()->num_local_encoding_threads());
296 LOG_GENERAL ("J2K bandwidth %1", j2k_bandwidth());
298 if (container() == 0) {
299 throw MissingSettingError (_("container"));
302 if (content().empty()) {
303 throw runtime_error (_("You must add some content to the DCP before creating it"));
306 if (dcp_content_type() == 0) {
307 throw MissingSettingError (_("content type"));
310 if (name().empty()) {
311 throw MissingSettingError (_("name"));
314 JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
317 /** Start a job to send our DCP to the configured TMS */
319 Film::send_dcp_to_tms ()
321 shared_ptr<Job> j (new UploadJob (shared_from_this()));
322 JobManager::instance()->add (j);
325 shared_ptr<xmlpp::Document>
326 Film::metadata () const
328 shared_ptr<xmlpp::Document> doc (new xmlpp::Document);
329 xmlpp::Element* root = doc->create_root_node ("Metadata");
331 root->add_child("Version")->add_child_text (raw_convert<string> (current_state_version));
332 root->add_child("Name")->add_child_text (_name);
333 root->add_child("UseISDCFName")->add_child_text (_use_isdcf_name ? "1" : "0");
335 if (_dcp_content_type) {
336 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->isdcf_name ());
340 root->add_child("Container")->add_child_text (_container->id ());
343 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
344 root->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
345 _isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
346 root->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
347 root->add_child("ISDCFDate")->add_child_text (boost::gregorian::to_iso_string (_isdcf_date));
348 root->add_child("AudioChannels")->add_child_text (raw_convert<string> (_audio_channels));
349 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
350 root->add_child("Sequence")->add_child_text (_sequence ? "1" : "0");
351 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
352 root->add_child("Signed")->add_child_text (_signed ? "1" : "0");
353 root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
354 root->add_child("Key")->add_child_text (_key.hex ());
355 if (_audio_processor) {
356 root->add_child("AudioProcessor")->add_child_text (_audio_processor->id ());
358 root->add_child("ReelType")->add_child_text (raw_convert<string> (_reel_type));
359 root->add_child("ReelLength")->add_child_text (raw_convert<string> (_reel_length));
360 root->add_child("UploadAfterMakeDCP")->add_child_text (_upload_after_make_dcp ? "1" : "0");
361 _playlist->as_xml (root->add_child ("Playlist"));
366 /** Write state to our `metadata' file */
368 Film::write_metadata () const
370 boost::filesystem::create_directories (directory ());
371 shared_ptr<xmlpp::Document> doc = metadata ();
372 doc->write_to_file_formatted (file("metadata.xml").string ());
376 /** Read state from our metadata file.
377 * @return Notes about things that the user should know about, or empty.
380 Film::read_metadata ()
382 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
383 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!"));
386 cxml::Document f ("Metadata");
387 f.read_file (file ("metadata.xml"));
389 _state_version = f.number_child<int> ("Version");
390 if (_state_version > current_state_version) {
391 throw runtime_error (_("This film was created with a newer version of DCP-o-matic, and it cannot be loaded into this version. Sorry!"));
394 _name = f.string_child ("Name");
395 if (_state_version >= 9) {
396 _use_isdcf_name = f.bool_child ("UseISDCFName");
397 _isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
398 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("ISDCFDate"));
400 _use_isdcf_name = f.bool_child ("UseDCIName");
401 _isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
402 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
406 optional<string> c = f.optional_string_child ("DCPContentType");
408 _dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
413 optional<string> c = f.optional_string_child ("Container");
415 _container = Ratio::from_id (c.get ());
419 _resolution = string_to_resolution (f.string_child ("Resolution"));
420 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
421 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
422 _signed = f.optional_bool_child("Signed").get_value_or (true);
423 _encrypted = f.bool_child ("Encrypted");
424 _audio_channels = f.number_child<int> ("AudioChannels");
425 /* We used to allow odd numbers (and zero) channels, but it's just not worth
428 if (_audio_channels == 0) {
430 } else if ((_audio_channels % 2) == 1) {
434 if (f.optional_bool_child("SequenceVideo")) {
435 _sequence = f.bool_child("SequenceVideo");
437 _sequence = f.bool_child("Sequence");
440 _three_d = f.bool_child ("ThreeD");
441 _interop = f.bool_child ("Interop");
442 _key = dcp::Key (f.string_child ("Key"));
444 if (f.optional_string_child ("AudioProcessor")) {
445 _audio_processor = AudioProcessor::from_id (f.string_child ("AudioProcessor"));
447 _audio_processor = 0;
450 _reel_type = static_cast<ReelType> (f.optional_number_child<int>("ReelType").get_value_or (static_cast<int>(REELTYPE_SINGLE)));
451 _reel_length = f.optional_number_child<int64_t>("ReelLength").get_value_or (2000000000);
452 _upload_after_make_dcp = f.optional_bool_child("UploadAfterMakeDCP").get_value_or (false);
455 /* This method is the only one that can return notes (so far) */
456 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
458 /* Write backtraces to this film's directory, until another film is loaded */
459 set_backtrace_file (file ("backtrace.txt"));
465 /** Given a directory name, return its full path within the Film's directory.
466 * The directory (and its parents) will be created if they do not exist.
468 boost::filesystem::path
469 Film::dir (boost::filesystem::path d) const
471 boost::filesystem::path p;
475 boost::filesystem::create_directories (p);
480 /** Given a file or directory name, return its full path within the Film's directory.
481 * Any required parent directories will be created.
483 boost::filesystem::path
484 Film::file (boost::filesystem::path f) const
486 boost::filesystem::path p;
490 boost::filesystem::create_directories (p.parent_path ());
496 Film::mapped_audio_channels () const
500 if (audio_processor ()) {
501 /* Processors are mapped 1:1 to DCP outputs so we can work out mappings from there */
502 for (int i = 0; i < audio_processor()->out_channels(); ++i) {
503 mapped.push_back (i);
506 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
508 list<int> c = i->audio->mapping().mapped_output_channels ();
509 copy (c.begin(), c.end(), back_inserter (mapped));
520 /** @return a ISDCF-compliant name for a DCP of this film */
522 Film::isdcf_name (bool if_created_now) const
526 string raw_name = name ();
528 /* Split the raw name up into words */
529 vector<string> words;
530 split (words, raw_name, is_any_of (" _-"));
534 /* Add each word to fixed_name */
535 for (vector<string>::const_iterator i = words.begin(); i != words.end(); ++i) {
538 /* First letter is always capitalised */
539 w[0] = toupper (w[0]);
541 /* Count caps in w */
543 for (size_t i = 0; i < w.size(); ++i) {
544 if (isupper (w[i])) {
549 /* If w is all caps make the rest of it lower case, otherwise
552 if (caps == w.size ()) {
553 for (size_t i = 1; i < w.size(); ++i) {
554 w[i] = tolower (w[i]);
558 for (size_t i = 0; i < w.size(); ++i) {
563 if (fixed_name.length() > 14) {
564 fixed_name = fixed_name.substr (0, 14);
569 if (dcp_content_type()) {
570 d << "_" << dcp_content_type()->isdcf_name();
571 d << "-" << isdcf_metadata().content_version;
574 ISDCFMetadata const dm = isdcf_metadata ();
576 if (dm.temp_version) {
580 if (dm.pre_release) {
588 if (!dm.chain.empty ()) {
589 d << "-" << dm.chain;
596 if (dm.two_d_version_of_three_d) {
600 if (!dm.mastered_luminance.empty ()) {
601 d << "-" << dm.mastered_luminance;
604 if (video_frame_rate() != 24) {
605 d << "-" << video_frame_rate();
609 d << "_" << container()->isdcf_name();
612 /* XXX: this uses the first bit of content only */
614 /* The standard says we don't do this for trailers, for some strange reason */
615 if (dcp_content_type() && dcp_content_type()->libdcp_kind() != dcp::TRAILER) {
616 Ratio const * content_ratio = 0;
617 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
619 /* Here's the first piece of video content */
620 if (i->video->scale().ratio ()) {
621 content_ratio = i->video->scale().ratio ();
623 content_ratio = Ratio::from_ratio (i->video->size().ratio ());
629 if (content_ratio && content_ratio != container()) {
630 d << "-" << content_ratio->isdcf_name();
634 if (!dm.audio_language.empty ()) {
635 d << "_" << dm.audio_language;
636 if (!dm.subtitle_language.empty()) {
638 bool burnt_in = true;
639 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
644 if (i->subtitle->use() && !i->subtitle->burn()) {
649 string language = dm.subtitle_language;
650 if (burnt_in && language != "XX") {
651 transform (language.begin(), language.end(), language.begin(), ::tolower);
653 transform (language.begin(), language.end(), language.begin(), ::toupper);
656 d << "-" << language;
662 if (!dm.territory.empty ()) {
663 d << "_" << dm.territory;
664 if (dm.rating.empty ()) {
667 d << "-" << dm.rating;
671 /* Count mapped audio channels */
676 BOOST_FOREACH (int i, mapped_audio_channels ()) {
677 if (i >= audio_channels()) {
678 /* This channel is mapped but is not included in the DCP */
682 if (static_cast<dcp::Channel> (i) == dcp::LFE) {
690 d << "_" << non_lfe << lfe;
695 d << "_" << resolution_to_string (_resolution);
697 if (!dm.studio.empty ()) {
698 d << "_" << dm.studio;
701 if (if_created_now) {
702 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
704 d << "_" << boost::gregorian::to_iso_string (_isdcf_date);
707 if (!dm.facility.empty ()) {
708 d << "_" << dm.facility;
722 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
723 shared_ptr<const DCPContent> dc = dynamic_pointer_cast<const DCPContent> (i);
724 if (dc && (dc->reference_video() || dc->reference_audio() || dc->reference_subtitle())) {
738 /** @return name to give the DCP */
740 Film::dcp_name (bool if_created_now) const
743 if (use_isdcf_name()) {
744 unfiltered = isdcf_name (if_created_now);
746 unfiltered = name ();
749 /* Filter out `bad' characters which cause problems with some systems.
750 There's no apparent list of what really is allowed, so this is a guess.
754 string const allowed = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-_";
755 for (size_t i = 0; i < unfiltered.size(); ++i) {
756 if (allowed.find (unfiltered[i]) != string::npos) {
757 filtered += unfiltered[i];
765 Film::set_directory (boost::filesystem::path d)
772 Film::set_name (string n)
775 signal_changed (NAME);
779 Film::set_use_isdcf_name (bool u)
782 signal_changed (USE_ISDCF_NAME);
786 Film::set_dcp_content_type (DCPContentType const * t)
788 _dcp_content_type = t;
789 signal_changed (DCP_CONTENT_TYPE);
793 Film::set_container (Ratio const * c)
796 signal_changed (CONTAINER);
800 Film::set_resolution (Resolution r)
803 signal_changed (RESOLUTION);
807 Film::set_j2k_bandwidth (int b)
810 signal_changed (J2K_BANDWIDTH);
814 Film::set_isdcf_metadata (ISDCFMetadata m)
817 signal_changed (ISDCF_METADATA);
821 Film::set_video_frame_rate (int f)
823 _video_frame_rate = f;
824 signal_changed (VIDEO_FRAME_RATE);
828 Film::set_audio_channels (int c)
831 signal_changed (AUDIO_CHANNELS);
835 Film::set_three_d (bool t)
838 signal_changed (THREE_D);
840 if (_three_d && _isdcf_metadata.two_d_version_of_three_d) {
841 _isdcf_metadata.two_d_version_of_three_d = false;
842 signal_changed (ISDCF_METADATA);
847 Film::set_interop (bool i)
850 signal_changed (INTEROP);
854 Film::set_audio_processor (AudioProcessor const * processor)
856 _audio_processor = processor;
857 signal_changed (AUDIO_PROCESSOR);
858 signal_changed (AUDIO_CHANNELS);
862 Film::set_reel_type (ReelType t)
865 signal_changed (REEL_TYPE);
868 /** @param r Desired reel length in bytes */
870 Film::set_reel_length (int64_t r)
873 signal_changed (REEL_LENGTH);
877 Film::set_upload_after_make_dcp (bool u)
879 _upload_after_make_dcp = u;
880 signal_changed (UPLOAD_AFTER_MAKE_DCP);
884 Film::signal_changed (Property p)
890 set_video_frame_rate (_playlist->best_video_frame_rate ());
892 case Film::VIDEO_FRAME_RATE:
894 _playlist->maybe_sequence ();
900 emit (boost::bind (boost::ref (Changed), p));
904 Film::set_isdcf_date_today ()
906 _isdcf_date = boost::gregorian::day_clock::local_day ();
909 boost::filesystem::path
910 Film::j2c_path (int reel, Frame frame, Eyes eyes, bool tmp) const
912 boost::filesystem::path p;
914 p /= video_identifier ();
918 s << setfill('0') << reel << "_" << frame;
920 if (eyes == EYES_LEFT) {
922 } else if (eyes == EYES_RIGHT) {
936 /** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs */
940 vector<CPLSummary> out;
942 boost::filesystem::path const dir = directory ();
943 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
945 boost::filesystem::is_directory (*i) &&
946 i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
954 i->path().leaf().string(),
955 dcp.cpls().front()->id(),
956 dcp.cpls().front()->annotation_text(),
957 dcp.cpls().front()->file()
970 Film::set_signed (bool s)
973 signal_changed (SIGNED);
977 Film::set_encrypted (bool e)
980 signal_changed (ENCRYPTED);
984 Film::set_key (dcp::Key key)
987 signal_changed (KEY);
991 Film::content () const
993 return _playlist->content ();
997 Film::examine_content (shared_ptr<Content> c)
999 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
1000 JobManager::instance()->add (j);
1004 Film::examine_and_add_content (shared_ptr<Content> c)
1006 if (dynamic_pointer_cast<FFmpegContent> (c) && !_directory.empty ()) {
1007 run_ffprobe (c->path(0), file ("ffprobe.log"), _log);
1010 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
1012 _job_connections.push_back (
1013 j->Finished.connect (bind (&Film::maybe_add_content, this, weak_ptr<Job> (j), weak_ptr<Content> (c)))
1016 JobManager::instance()->add (j);
1020 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
1022 shared_ptr<Job> job = j.lock ();
1023 if (!job || !job->finished_ok ()) {
1027 shared_ptr<Content> content = c.lock ();
1032 add_content (content);
1033 if (Config::instance()->automatic_audio_analysis() && content->audio) {
1034 shared_ptr<Playlist> playlist (new Playlist);
1035 playlist->add (content);
1036 boost::signals2::connection c;
1037 JobManager::instance()->analyse_audio (
1038 shared_from_this (), playlist, c, bind (&Film::audio_analysis_finished, this)
1040 _audio_analysis_connections.push_back (c);
1045 Film::add_content (shared_ptr<Content> c)
1047 /* Add {video,subtitle} content after any existing {video,subtitle} content */
1049 c->set_position (_playlist->video_end ());
1050 } else if (c->subtitle) {
1051 c->set_position (_playlist->subtitle_end ());
1058 Film::remove_content (shared_ptr<Content> c)
1060 _playlist->remove (c);
1064 Film::move_content_earlier (shared_ptr<Content> c)
1066 _playlist->move_earlier (c);
1070 Film::move_content_later (shared_ptr<Content> c)
1072 _playlist->move_later (c);
1075 /** @return length of the film from time 0 to the last thing on the playlist */
1077 Film::length () const
1079 return _playlist->length ();
1083 Film::best_video_frame_rate () const
1085 return _playlist->best_video_frame_rate ();
1089 Film::active_frame_rate_change (DCPTime t) const
1091 return _playlist->active_frame_rate_change (t, video_frame_rate ());
1095 Film::playlist_content_changed (weak_ptr<Content> c, int p, bool frequent)
1099 if (p == ContentProperty::VIDEO_FRAME_RATE) {
1100 set_video_frame_rate (_playlist->best_video_frame_rate ());
1101 } else if (p == AudioContentProperty::STREAMS) {
1102 signal_changed (NAME);
1105 emit (boost::bind (boost::ref (ContentChanged), c, p, frequent));
1109 Film::playlist_changed ()
1111 signal_changed (CONTENT);
1112 signal_changed (NAME);
1116 Film::playlist_order_changed ()
1118 signal_changed (CONTENT_ORDER);
1122 Film::audio_frame_rate () const
1124 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
1125 if (i->audio && i->audio->has_rate_above_48k ()) {
1134 Film::set_sequence (bool s)
1137 _playlist->set_sequence (s);
1138 signal_changed (SEQUENCE);
1141 /** @return Size of the largest possible image in whatever resolution we are using */
1143 Film::full_frame () const
1145 switch (_resolution) {
1147 return dcp::Size (2048, 1080);
1149 return dcp::Size (4096, 2160);
1152 DCPOMATIC_ASSERT (false);
1153 return dcp::Size ();
1156 /** @return Size of the frame */
1158 Film::frame_size () const
1160 return fit_ratio_within (container()->ratio(), full_frame ());
1163 /** @param from KDM from time expressed as a local time with an offset from UTC
1164 * @param to KDM to time expressed as a local time with an offset from UTC
1168 dcp::Certificate recipient,
1169 vector<dcp::Certificate> trusted_devices,
1170 boost::filesystem::path cpl_file,
1171 dcp::LocalTime from,
1172 dcp::LocalTime until,
1173 dcp::Formulation formulation
1176 shared_ptr<const dcp::CPL> cpl (new dcp::CPL (cpl_file));
1177 shared_ptr<const dcp::CertificateChain> signer = Config::instance()->signer_chain ();
1178 if (!signer->valid ()) {
1179 throw InvalidSignerError ();
1182 return dcp::DecryptedKDM (
1183 cpl, key(), from, until, cpl->content_title_text(), cpl->content_title_text(), dcp::LocalTime().as_string()
1184 ).encrypt (signer, recipient, trusted_devices, formulation);
1187 /** @param from KDM from time expressed as a local time in the time zone of the Screen's Cinema.
1188 * @param to KDM to time expressed as a local time in the time zone of the Screen's Cinema.
1192 list<shared_ptr<Screen> > screens,
1193 boost::filesystem::path dcp,
1194 boost::posix_time::ptime from,
1195 boost::posix_time::ptime until,
1196 dcp::Formulation formulation
1199 list<ScreenKDM> kdms;
1201 BOOST_FOREACH (shared_ptr<Screen> i, screens) {
1203 dcp::EncryptedKDM const kdm = make_kdm (
1207 dcp::LocalTime (from, i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute()),
1208 dcp::LocalTime (until, i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute()),
1212 kdms.push_back (ScreenKDM (i, kdm));
1219 /** @return The approximate disk space required to encode a DCP of this film with the
1220 * current settings, in bytes.
1223 Film::required_disk_space () const
1225 return _playlist->required_disk_space (j2k_bandwidth(), audio_channels(), audio_frame_rate());
1228 /** This method checks the disk that the Film is on and tries to decide whether or not
1229 * there will be enough space to make a DCP for it. If so, true is returned; if not,
1230 * false is returned and required and available are filled in with the amount of disk space
1231 * required and available respectively (in Gb).
1233 * Note: the decision made by this method isn't, of course, 100% reliable.
1236 Film::should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const
1238 /* Create a test file and see if we can hard-link it */
1239 boost::filesystem::path test = internal_video_asset_dir() / "test";
1240 boost::filesystem::path test2 = internal_video_asset_dir() / "test2";
1241 can_hard_link = true;
1242 FILE* f = fopen_boost (test, "w");
1245 boost::system::error_code ec;
1246 boost::filesystem::create_hard_link (test, test2, ec);
1248 can_hard_link = false;
1250 boost::filesystem::remove (test);
1251 boost::filesystem::remove (test2);
1254 boost::filesystem::space_info s = boost::filesystem::space (internal_video_asset_dir ());
1255 required = double (required_disk_space ()) / 1073741824.0f;
1256 if (!can_hard_link) {
1259 available = double (s.available) / 1073741824.0f;
1260 return (available - required) > 1;
1264 Film::subtitle_language () const
1266 set<string> languages;
1268 ContentList cl = content ();
1269 BOOST_FOREACH (shared_ptr<Content>& c, cl) {
1271 languages.insert (c->subtitle->language ());
1276 BOOST_FOREACH (string s, languages) {
1277 if (!all.empty ()) {
1287 /** Change the gains of the supplied AudioMapping to make it a default
1288 * for this film. The defaults are guessed based on what processor (if any)
1289 * is in use and the number of input channels.
1292 Film::make_audio_mapping_default (AudioMapping& mapping) const
1294 if (audio_processor ()) {
1295 audio_processor()->make_audio_mapping_default (mapping);
1297 mapping.make_zero ();
1298 if (mapping.input_channels() == 1) {
1299 /* Mono -> Centre */
1300 mapping.set (0, static_cast<int> (dcp::CENTRE), 1);
1303 for (int i = 0; i < min (mapping.input_channels(), mapping.output_channels()); ++i) {
1304 mapping.set (i, i, 1);
1310 /** @return The names of the channels that audio contents' outputs are passed into;
1311 * this is either the DCP or a AudioProcessor.
1314 Film::audio_output_names () const
1316 if (audio_processor ()) {
1317 return audio_processor()->input_names ();
1320 DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
1323 n.push_back (_("L"));
1324 n.push_back (_("R"));
1325 n.push_back (_("C"));
1326 n.push_back (_("Lfe"));
1327 n.push_back (_("Ls"));
1328 n.push_back (_("Rs"));
1329 n.push_back (_("HI"));
1330 n.push_back (_("VI"));
1331 n.push_back (_("Lc"));
1332 n.push_back (_("Rc"));
1333 n.push_back (_("BsL"));
1334 n.push_back (_("BsR"));
1335 n.push_back (_("DBP"));
1336 n.push_back (_("DBS"));
1340 return vector<string> (n.begin(), n.begin() + audio_channels ());
1344 Film::repeat_content (ContentList c, int n)
1346 _playlist->repeat (c, n);
1350 Film::remove_content (ContentList c)
1352 _playlist->remove (c);
1356 Film::audio_analysis_finished ()
1362 Film::reels () const
1364 list<DCPTimePeriod> p;
1365 DCPTime const len = length().round_up (video_frame_rate ());
1367 switch (reel_type ()) {
1368 case REELTYPE_SINGLE:
1369 p.push_back (DCPTimePeriod (DCPTime (), len));
1371 case REELTYPE_BY_VIDEO_CONTENT:
1373 optional<DCPTime> last_split;
1374 shared_ptr<Content> last_video;
1375 ContentList cl = content ();
1376 BOOST_FOREACH (shared_ptr<Content> c, content ()) {
1378 BOOST_FOREACH (DCPTime t, c->reel_split_points()) {
1380 p.push_back (DCPTimePeriod (last_split.get(), t));
1388 DCPTime video_end = last_video ? last_video->end() : DCPTime(0);
1390 /* Definitely go from the last split to the end of the video content */
1391 p.push_back (DCPTimePeriod (last_split.get(), video_end));
1394 if (video_end < len) {
1395 /* And maybe go after that as well if there is any non-video hanging over the end */
1396 p.push_back (DCPTimePeriod (video_end, len));
1400 case REELTYPE_BY_LENGTH:
1403 /* Integer-divide reel length by the size of one frame to give the number of frames per reel */
1404 Frame const reel_in_frames = _reel_length / ((j2k_bandwidth() / video_frame_rate()) / 8);
1405 while (current < len) {
1406 DCPTime end = min (len, current + DCPTime::from_frames (reel_in_frames, video_frame_rate ()));
1407 p.push_back (DCPTimePeriod (current, end));