2 Copyright (C) 2012-2015 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"
53 #include <libcxml/cxml.h>
55 #include <dcp/certificate_chain.h>
57 #include <dcp/local_time.h>
58 #include <dcp/decrypted_kdm.h>
59 #include <libxml++/libxml++.h>
60 #include <boost/filesystem.hpp>
61 #include <boost/algorithm/string.hpp>
62 #include <boost/foreach.hpp>
83 using std::runtime_error;
84 using boost::shared_ptr;
85 using boost::weak_ptr;
86 using boost::dynamic_pointer_cast;
87 using boost::optional;
88 using boost::is_any_of;
90 #define LOG_GENERAL(...) log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
91 #define LOG_GENERAL_NC(...) log()->log (__VA_ARGS__, LogEntry::TYPE_GENERAL);
94 * AudioMapping XML changed.
96 * Subtitle offset changed to subtitle y offset, and subtitle x offset added.
98 * Use <Scale> tag in <VideoContent> rather than <Ratio>.
102 * Subtitle X and Y scale.
104 * Bumped to 32 for 2.0 branch; some times are expressed in Times rather
108 * Changed <Period> to <Subtitle> in FFmpegSubtitleStream
110 int const Film::current_state_version = 33;
112 /** Construct a Film object in a given directory.
114 * @param dir Film directory.
117 Film::Film (boost::filesystem::path dir, bool log)
118 : _playlist (new Playlist)
119 , _use_isdcf_name (true)
120 , _dcp_content_type (Config::instance()->default_dcp_content_type ())
121 , _container (Config::instance()->default_container ())
122 , _resolution (RESOLUTION_2K)
125 , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
126 , _isdcf_metadata (Config::instance()->default_isdcf_metadata ())
127 , _video_frame_rate (24)
128 , _audio_channels (6)
130 , _sequence_video (true)
131 , _interop (Config::instance()->default_interop ())
132 , _audio_processor (0)
133 , _reel_type (REELTYPE_SINGLE)
134 , _reel_length (2000000000)
135 , _state_version (current_state_version)
138 set_isdcf_date_today ();
140 _playlist_changed_connection = _playlist->Changed.connect (bind (&Film::playlist_changed, this));
141 _playlist_order_changed_connection = _playlist->OrderChanged.connect (bind (&Film::playlist_order_changed, this));
142 _playlist_content_changed_connection = _playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2, _3));
144 /* Make state.directory a complete path without ..s (where possible)
145 (Code swiped from Adam Bowen on stackoverflow)
146 XXX: couldn't/shouldn't this just be boost::filesystem::canonical?
149 boost::filesystem::path p (boost::filesystem::system_complete (dir));
150 boost::filesystem::path result;
151 for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
153 if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
156 result = result.parent_path ();
158 } else if (*i != ".") {
163 set_directory (result.make_preferred ());
165 _log.reset (new FileLog (file ("log")));
167 _log.reset (new NullLog);
170 _playlist->set_sequence_video (_sequence_video);
175 BOOST_FOREACH (boost::signals2::connection& i, _job_connections) {
179 BOOST_FOREACH (boost::signals2::connection& i, _audio_analysis_connections) {
185 Film::video_identifier () const
187 DCPOMATIC_ASSERT (container ());
190 s.imbue (std::locale::classic ());
192 s << container()->id()
193 << "_" << resolution_to_string (_resolution)
194 << "_" << _playlist->video_identifier()
195 << "_" << _video_frame_rate
196 << "_" << j2k_bandwidth();
217 /** @return The file to write video frame info to */
218 boost::filesystem::path
219 Film::info_file (DCPTimePeriod period) const
221 boost::filesystem::path p;
223 p /= video_identifier () + "_" + raw_convert<string> (period.from.get()) + "_" + raw_convert<string> (period.to.get());
227 boost::filesystem::path
228 Film::internal_video_asset_dir () const
230 return dir ("video");
233 boost::filesystem::path
234 Film::internal_video_asset_filename (DCPTimePeriod p) const
236 return video_identifier() + "_" + raw_convert<string> (p.from.get()) + "_" + raw_convert<string> (p.to.get()) + ".mxf";
239 boost::filesystem::path
240 Film::audio_analysis_path (shared_ptr<const Playlist> playlist) const
242 boost::filesystem::path p = dir ("analysis");
244 MD5Digester digester;
245 BOOST_FOREACH (shared_ptr<Content> i, playlist->content ()) {
246 shared_ptr<AudioContent> ac = dynamic_pointer_cast<AudioContent> (i);
251 digester.add (ac->digest ());
252 digester.add (ac->audio_mapping().digest ());
253 if (playlist->content().size() != 1) {
254 /* Analyses should be considered equal regardless of gain
255 if they were made from just one piece of content. This
256 is because we can fake any gain change in a single-content
257 analysis at the plotting stage rather than having to
260 digester.add (ac->audio_gain ());
264 if (audio_processor ()) {
265 digester.add (audio_processor()->id ());
268 p /= digester.get ();
272 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
276 if (dcp_name().find ("/") != string::npos) {
277 throw BadSettingError (_("name"), _("cannot contain slashes"));
280 set_isdcf_date_today ();
282 BOOST_FOREACH (string i, environment_info ()) {
286 BOOST_FOREACH (shared_ptr<const Content> i, content ()) {
287 LOG_GENERAL ("Content: %1", i->technical_summary());
289 LOG_GENERAL ("DCP video rate %1 fps", video_frame_rate());
290 if (Config::instance()->only_servers_encode ()) {
291 LOG_GENERAL_NC ("0 threads: ONLY SERVERS SET TO ENCODE");
293 LOG_GENERAL ("%1 threads", Config::instance()->num_local_encoding_threads());
295 LOG_GENERAL ("J2K bandwidth %1", j2k_bandwidth());
297 if (container() == 0) {
298 throw MissingSettingError (_("container"));
301 if (content().empty()) {
302 throw runtime_error (_("You must add some content to the DCP before creating it"));
305 if (dcp_content_type() == 0) {
306 throw MissingSettingError (_("content type"));
309 if (name().empty()) {
310 throw MissingSettingError (_("name"));
313 JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
316 /** Start a job to send our DCP to the configured TMS */
318 Film::send_dcp_to_tms ()
320 shared_ptr<Job> j (new UploadJob (shared_from_this()));
321 JobManager::instance()->add (j);
324 shared_ptr<xmlpp::Document>
325 Film::metadata () const
327 shared_ptr<xmlpp::Document> doc (new xmlpp::Document);
328 xmlpp::Element* root = doc->create_root_node ("Metadata");
330 root->add_child("Version")->add_child_text (raw_convert<string> (current_state_version));
331 root->add_child("Name")->add_child_text (_name);
332 root->add_child("UseISDCFName")->add_child_text (_use_isdcf_name ? "1" : "0");
334 if (_dcp_content_type) {
335 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->isdcf_name ());
339 root->add_child("Container")->add_child_text (_container->id ());
342 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
343 root->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
344 _isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
345 root->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
346 root->add_child("ISDCFDate")->add_child_text (boost::gregorian::to_iso_string (_isdcf_date));
347 root->add_child("AudioChannels")->add_child_text (raw_convert<string> (_audio_channels));
348 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
349 root->add_child("SequenceVideo")->add_child_text (_sequence_video ? "1" : "0");
350 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
351 root->add_child("Signed")->add_child_text (_signed ? "1" : "0");
352 root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
353 root->add_child("Key")->add_child_text (_key.hex ());
354 if (_audio_processor) {
355 root->add_child("AudioProcessor")->add_child_text (_audio_processor->id ());
357 root->add_child("ReelType")->add_child_text (raw_convert<string> (_reel_type));
358 root->add_child("ReelLength")->add_child_text (raw_convert<string> (_reel_length));
359 _playlist->as_xml (root->add_child ("Playlist"));
364 /** Write state to our `metadata' file */
366 Film::write_metadata () const
368 boost::filesystem::create_directories (directory ());
369 shared_ptr<xmlpp::Document> doc = metadata ();
370 doc->write_to_file_formatted (file("metadata.xml").string ());
374 /** Read state from our metadata file.
375 * @return Notes about things that the user should know about, or empty.
378 Film::read_metadata ()
380 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
381 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!"));
384 cxml::Document f ("Metadata");
385 f.read_file (file ("metadata.xml"));
387 _state_version = f.number_child<int> ("Version");
388 if (_state_version > current_state_version) {
389 throw runtime_error (_("This film was created with a newer version of DCP-o-matic, and it cannot be loaded into this version. Sorry!"));
392 _name = f.string_child ("Name");
393 if (_state_version >= 9) {
394 _use_isdcf_name = f.bool_child ("UseISDCFName");
395 _isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
396 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("ISDCFDate"));
398 _use_isdcf_name = f.bool_child ("UseDCIName");
399 _isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
400 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
404 optional<string> c = f.optional_string_child ("DCPContentType");
406 _dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
411 optional<string> c = f.optional_string_child ("Container");
413 _container = Ratio::from_id (c.get ());
417 _resolution = string_to_resolution (f.string_child ("Resolution"));
418 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
419 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
420 _signed = f.optional_bool_child("Signed").get_value_or (true);
421 _encrypted = f.bool_child ("Encrypted");
422 _audio_channels = f.number_child<int> ("AudioChannels");
423 /* We used to allow odd numbers (and zero) channels, but it's just not worth
426 if (_audio_channels == 0) {
428 } else if ((_audio_channels % 2) == 1) {
431 _sequence_video = f.bool_child ("SequenceVideo");
432 _three_d = f.bool_child ("ThreeD");
433 _interop = f.bool_child ("Interop");
434 _key = dcp::Key (f.string_child ("Key"));
436 if (f.optional_string_child ("AudioProcessor")) {
437 _audio_processor = AudioProcessor::from_id (f.string_child ("AudioProcessor"));
439 _audio_processor = 0;
442 _reel_type = static_cast<ReelType> (f.optional_number_child<int>("ReelType").get_value_or (static_cast<int>(REELTYPE_SINGLE)));
443 _reel_length = f.optional_number_child<int64_t>("ReelLength").get_value_or (2000000000);
446 /* This method is the only one that can return notes (so far) */
447 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
449 /* Write backtraces to this film's directory, until another film is loaded */
450 set_backtrace_file (file ("backtrace.txt"));
456 /** Given a directory name, return its full path within the Film's directory.
457 * The directory (and its parents) will be created if they do not exist.
459 boost::filesystem::path
460 Film::dir (boost::filesystem::path d) const
462 boost::filesystem::path p;
466 boost::filesystem::create_directories (p);
471 /** Given a file or directory name, return its full path within the Film's directory.
472 * Any required parent directories will be created.
474 boost::filesystem::path
475 Film::file (boost::filesystem::path f) const
477 boost::filesystem::path p;
481 boost::filesystem::create_directories (p.parent_path ());
486 /** @return a ISDCF-compliant name for a DCP of this film */
488 Film::isdcf_name (bool if_created_now) const
492 string raw_name = name ();
494 /* Split the raw name up into words */
495 vector<string> words;
496 split (words, raw_name, is_any_of (" _-"));
500 /* Add each word to fixed_name */
501 for (vector<string>::const_iterator i = words.begin(); i != words.end(); ++i) {
504 /* First letter is always capitalised */
505 w[0] = toupper (w[0]);
507 /* Count caps in w */
509 for (size_t i = 0; i < w.size(); ++i) {
510 if (isupper (w[i])) {
515 /* If w is all caps make the rest of it lower case, otherwise
518 if (caps == w.size ()) {
519 for (size_t i = 1; i < w.size(); ++i) {
520 w[i] = tolower (w[i]);
524 for (size_t i = 0; i < w.size(); ++i) {
529 if (fixed_name.length() > 14) {
530 fixed_name = fixed_name.substr (0, 14);
535 if (dcp_content_type()) {
536 d << "_" << dcp_content_type()->isdcf_name();
537 d << "-" << isdcf_metadata().content_version;
540 ISDCFMetadata const dm = isdcf_metadata ();
542 if (dm.temp_version) {
546 if (dm.pre_release) {
554 if (!dm.chain.empty ()) {
555 d << "-" << dm.chain;
562 if (dm.two_d_version_of_three_d) {
566 if (!dm.mastered_luminance.empty ()) {
567 d << "-" << dm.mastered_luminance;
570 if (video_frame_rate() != 24) {
571 d << "-" << video_frame_rate();
575 d << "_" << container()->isdcf_name();
578 /* XXX: this uses the first bit of content only */
580 /* The standard says we don't do this for trailers, for some strange reason */
581 if (dcp_content_type() && dcp_content_type()->libdcp_kind() != dcp::TRAILER) {
582 Ratio const * content_ratio = 0;
583 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
584 shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (i);
586 /* Here's the first piece of video content */
587 if (vc->scale().ratio ()) {
588 content_ratio = vc->scale().ratio ();
590 content_ratio = Ratio::from_ratio (vc->video_size().ratio ());
596 if (content_ratio && content_ratio != container()) {
597 d << "-" << content_ratio->isdcf_name();
601 if (!dm.audio_language.empty ()) {
602 d << "_" << dm.audio_language;
603 if (!dm.subtitle_language.empty()) {
605 bool burnt_in = false;
606 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
607 shared_ptr<SubtitleContent> sc = dynamic_pointer_cast<SubtitleContent> (i);
612 if (sc->use_subtitles() && sc->burn_subtitles()) {
617 string language = dm.subtitle_language;
619 transform (language.begin(), language.end(), language.begin(), ::tolower);
621 transform (language.begin(), language.end(), language.begin(), ::toupper);
624 d << "-" << language;
630 if (!dm.territory.empty ()) {
631 d << "_" << dm.territory;
632 if (dm.rating.empty ()) {
635 d << "-" << dm.rating;
639 /* Find all mapped channels */
644 if (audio_processor ()) {
645 /* Processors are mapped 1:1 to DCP outputs so we can guess the number of LFE/
646 non-LFE from the channel counts.
648 non_lfe = audio_processor()->out_channels ();
655 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
656 shared_ptr<const AudioContent> ac = dynamic_pointer_cast<const AudioContent> (i);
658 list<int> c = ac->audio_mapping().mapped_output_channels ();
659 copy (c.begin(), c.end(), back_inserter (mapped));
668 for (list<int>::const_iterator i = mapped.begin(); i != mapped.end(); ++i) {
669 if (*i >= audio_channels()) {
670 /* This channel is mapped but is not included in the DCP */
674 if (static_cast<dcp::Channel> (*i) == dcp::LFE) {
683 d << "_" << non_lfe << lfe;
688 d << "_" << resolution_to_string (_resolution);
690 if (!dm.studio.empty ()) {
691 d << "_" << dm.studio;
694 if (if_created_now) {
695 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
697 d << "_" << boost::gregorian::to_iso_string (_isdcf_date);
700 if (!dm.facility.empty ()) {
701 d << "_" << dm.facility;
715 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
716 shared_ptr<const DCPContent> dc = dynamic_pointer_cast<const DCPContent> (i);
717 if (dc && (dc->reference_video() || dc->reference_audio() || dc->reference_subtitle())) {
731 /** @return name to give the DCP */
733 Film::dcp_name (bool if_created_now) const
736 if (use_isdcf_name()) {
737 unfiltered = isdcf_name (if_created_now);
739 unfiltered = name ();
742 /* Filter out `bad' characters which cause problems with some systems.
743 There's no apparent list of what really is allowed, so this is a guess.
747 string const allowed = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-_";
748 for (size_t i = 0; i < unfiltered.size(); ++i) {
749 if (allowed.find (unfiltered[i]) != string::npos) {
750 filtered += unfiltered[i];
758 Film::set_directory (boost::filesystem::path d)
765 Film::set_name (string n)
768 signal_changed (NAME);
772 Film::set_use_isdcf_name (bool u)
775 signal_changed (USE_ISDCF_NAME);
779 Film::set_dcp_content_type (DCPContentType const * t)
781 _dcp_content_type = t;
782 signal_changed (DCP_CONTENT_TYPE);
786 Film::set_container (Ratio const * c)
789 signal_changed (CONTAINER);
793 Film::set_resolution (Resolution r)
796 signal_changed (RESOLUTION);
800 Film::set_j2k_bandwidth (int b)
803 signal_changed (J2K_BANDWIDTH);
807 Film::set_isdcf_metadata (ISDCFMetadata m)
810 signal_changed (ISDCF_METADATA);
814 Film::set_video_frame_rate (int f)
816 _video_frame_rate = f;
817 signal_changed (VIDEO_FRAME_RATE);
821 Film::set_audio_channels (int c)
824 signal_changed (AUDIO_CHANNELS);
828 Film::set_three_d (bool t)
831 signal_changed (THREE_D);
833 if (_three_d && _isdcf_metadata.two_d_version_of_three_d) {
834 _isdcf_metadata.two_d_version_of_three_d = false;
835 signal_changed (ISDCF_METADATA);
840 Film::set_interop (bool i)
843 signal_changed (INTEROP);
847 Film::set_audio_processor (AudioProcessor const * processor)
849 _audio_processor = processor;
850 signal_changed (AUDIO_PROCESSOR);
851 signal_changed (AUDIO_CHANNELS);
855 Film::set_reel_type (ReelType t)
858 signal_changed (REEL_TYPE);
861 /** @param r Desired reel length in bytes */
863 Film::set_reel_length (int64_t r)
866 signal_changed (REEL_LENGTH);
870 Film::signal_changed (Property p)
876 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
878 case Film::VIDEO_FRAME_RATE:
879 case Film::SEQUENCE_VIDEO:
880 _playlist->maybe_sequence_video ();
886 emit (boost::bind (boost::ref (Changed), p));
890 Film::set_isdcf_date_today ()
892 _isdcf_date = boost::gregorian::day_clock::local_day ();
895 boost::filesystem::path
896 Film::j2c_path (int reel, Frame frame, Eyes eyes, bool tmp) const
898 boost::filesystem::path p;
900 p /= video_identifier ();
904 s << setfill('0') << reel << "_" << frame;
906 if (eyes == EYES_LEFT) {
908 } else if (eyes == EYES_RIGHT) {
922 /** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs */
926 vector<CPLSummary> out;
928 boost::filesystem::path const dir = directory ();
929 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
931 boost::filesystem::is_directory (*i) &&
932 i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
940 i->path().leaf().string(),
941 dcp.cpls().front()->id(),
942 dcp.cpls().front()->annotation_text(),
943 dcp.cpls().front()->file()
956 Film::set_signed (bool s)
959 signal_changed (SIGNED);
963 Film::set_encrypted (bool e)
966 signal_changed (ENCRYPTED);
970 Film::set_key (dcp::Key key)
973 signal_changed (KEY);
977 Film::content () const
979 return _playlist->content ();
983 Film::examine_content (shared_ptr<Content> c)
985 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
986 JobManager::instance()->add (j);
990 Film::examine_and_add_content (shared_ptr<Content> c)
992 if (dynamic_pointer_cast<FFmpegContent> (c) && !_directory.empty ()) {
993 run_ffprobe (c->path(0), file ("ffprobe.log"), _log);
996 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
998 _job_connections.push_back (
999 j->Finished.connect (bind (&Film::maybe_add_content, this, weak_ptr<Job> (j), weak_ptr<Content> (c)))
1002 JobManager::instance()->add (j);
1006 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
1008 shared_ptr<Job> job = j.lock ();
1009 if (!job || !job->finished_ok ()) {
1013 shared_ptr<Content> content = c.lock ();
1018 add_content (content);
1019 if (Config::instance()->automatic_audio_analysis ()) {
1020 shared_ptr<Playlist> playlist (new Playlist);
1021 playlist->add (content);
1022 boost::signals2::connection c;
1023 JobManager::instance()->analyse_audio (
1024 shared_from_this (), playlist, c, bind (&Film::audio_analysis_finished, this)
1026 _audio_analysis_connections.push_back (c);
1031 Film::add_content (shared_ptr<Content> c)
1033 /* Add video content after any existing content */
1034 if (dynamic_pointer_cast<VideoContent> (c)) {
1035 c->set_position (_playlist->video_end ());
1042 Film::remove_content (shared_ptr<Content> c)
1044 _playlist->remove (c);
1048 Film::move_content_earlier (shared_ptr<Content> c)
1050 _playlist->move_earlier (c);
1054 Film::move_content_later (shared_ptr<Content> c)
1056 _playlist->move_later (c);
1059 /** @return length of the film from time 0 to the last thing on the playlist */
1061 Film::length () const
1063 return _playlist->length ();
1067 Film::best_video_frame_rate () const
1069 return _playlist->best_dcp_frame_rate ();
1073 Film::active_frame_rate_change (DCPTime t) const
1075 return _playlist->active_frame_rate_change (t, video_frame_rate ());
1079 Film::playlist_content_changed (weak_ptr<Content> c, int p, bool frequent)
1083 if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
1084 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
1085 } else if (p == AudioContentProperty::AUDIO_STREAMS) {
1086 signal_changed (NAME);
1089 emit (boost::bind (boost::ref (ContentChanged), c, p, frequent));
1093 Film::playlist_changed ()
1095 signal_changed (CONTENT);
1096 signal_changed (NAME);
1100 Film::playlist_order_changed ()
1102 signal_changed (CONTENT_ORDER);
1106 Film::audio_frame_rate () const
1108 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
1109 shared_ptr<AudioContent> a = dynamic_pointer_cast<AudioContent> (i);
1110 if (a && a->has_rate_above_48k ()) {
1119 Film::set_sequence_video (bool s)
1121 _sequence_video = s;
1122 _playlist->set_sequence_video (s);
1123 signal_changed (SEQUENCE_VIDEO);
1126 /** @return Size of the largest possible image in whatever resolution we are using */
1128 Film::full_frame () const
1130 switch (_resolution) {
1132 return dcp::Size (2048, 1080);
1134 return dcp::Size (4096, 2160);
1137 DCPOMATIC_ASSERT (false);
1138 return dcp::Size ();
1141 /** @return Size of the frame */
1143 Film::frame_size () const
1145 return fit_ratio_within (container()->ratio(), full_frame ());
1150 dcp::Certificate recipient,
1151 vector<dcp::Certificate> trusted_devices,
1152 boost::filesystem::path cpl_file,
1153 dcp::LocalTime from,
1154 dcp::LocalTime until,
1155 dcp::Formulation formulation
1158 shared_ptr<const dcp::CPL> cpl (new dcp::CPL (cpl_file));
1159 shared_ptr<const dcp::CertificateChain> signer = Config::instance()->signer_chain ();
1160 if (!signer->valid ()) {
1161 throw InvalidSignerError ();
1164 return dcp::DecryptedKDM (
1165 cpl, key(), from, until, "DCP-o-matic", cpl->content_title_text(), dcp::LocalTime().as_string()
1166 ).encrypt (signer, recipient, trusted_devices, formulation);
1171 list<shared_ptr<Screen> > screens,
1172 boost::filesystem::path dcp,
1173 dcp::LocalTime from,
1174 dcp::LocalTime until,
1175 dcp::Formulation formulation
1178 list<ScreenKDM> kdms;
1180 BOOST_FOREACH (shared_ptr<Screen> i, screens) {
1182 kdms.push_back (ScreenKDM (i, make_kdm (i->recipient.get(), i->trusted_devices, dcp, from, until, formulation)));
1189 /** @return The approximate disk space required to encode a DCP of this film with the
1190 * current settings, in bytes.
1193 Film::required_disk_space () const
1195 return _playlist->required_disk_space (j2k_bandwidth(), audio_channels(), audio_frame_rate());
1198 /** This method checks the disk that the Film is on and tries to decide whether or not
1199 * there will be enough space to make a DCP for it. If so, true is returned; if not,
1200 * false is returned and required and available are filled in with the amount of disk space
1201 * required and available respectively (in Gb).
1203 * Note: the decision made by this method isn't, of course, 100% reliable.
1206 Film::should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const
1208 /* Create a test file and see if we can hard-link it */
1209 boost::filesystem::path test = internal_video_asset_dir() / "test";
1210 boost::filesystem::path test2 = internal_video_asset_dir() / "test2";
1211 can_hard_link = true;
1212 FILE* f = fopen_boost (test, "w");
1215 boost::system::error_code ec;
1216 boost::filesystem::create_hard_link (test, test2, ec);
1218 can_hard_link = false;
1220 boost::filesystem::remove (test);
1221 boost::filesystem::remove (test2);
1224 boost::filesystem::space_info s = boost::filesystem::space (internal_video_asset_dir ());
1225 required = double (required_disk_space ()) / 1073741824.0f;
1226 if (!can_hard_link) {
1229 available = double (s.available) / 1073741824.0f;
1230 return (available - required) > 1;
1234 Film::subtitle_language () const
1236 set<string> languages;
1238 ContentList cl = content ();
1239 BOOST_FOREACH (shared_ptr<Content>& c, cl) {
1240 shared_ptr<SubtitleContent> sc = dynamic_pointer_cast<SubtitleContent> (c);
1242 languages.insert (sc->subtitle_language ());
1247 BOOST_FOREACH (string s, languages) {
1248 if (!all.empty ()) {
1258 /** Change the gains of the supplied AudioMapping to make it a default
1259 * for this film. The defaults are guessed based on what processor (if any)
1260 * is in use and the number of input channels.
1263 Film::make_audio_mapping_default (AudioMapping& mapping) const
1265 if (audio_processor ()) {
1266 audio_processor()->make_audio_mapping_default (mapping);
1268 mapping.make_zero ();
1269 if (mapping.input_channels() == 1) {
1270 /* Mono -> Centre */
1271 mapping.set (0, static_cast<int> (dcp::CENTRE), 1);
1274 for (int i = 0; i < min (mapping.input_channels(), mapping.output_channels()); ++i) {
1275 mapping.set (i, i, 1);
1281 /** @return The names of the channels that audio contents' outputs are passed into;
1282 * this is either the DCP or a AudioProcessor.
1285 Film::audio_output_names () const
1287 if (audio_processor ()) {
1288 return audio_processor()->input_names ();
1291 DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
1294 n.push_back (_("L"));
1295 n.push_back (_("R"));
1296 n.push_back (_("C"));
1297 n.push_back (_("Lfe"));
1298 n.push_back (_("Ls"));
1299 n.push_back (_("Rs"));
1300 n.push_back (_("HI"));
1301 n.push_back (_("VI"));
1302 n.push_back (_("Lc"));
1303 n.push_back (_("Rc"));
1304 n.push_back (_("BsL"));
1305 n.push_back (_("BsR"));
1306 n.push_back (_("DBP"));
1307 n.push_back (_("DBS"));
1311 return vector<string> (n.begin(), n.begin() + audio_channels ());
1315 Film::repeat_content (ContentList c, int n)
1317 _playlist->repeat (c, n);
1321 Film::remove_content (ContentList c)
1323 _playlist->remove (c);
1327 Film::audio_analysis_finished ()
1333 Film::reels () const
1335 list<DCPTimePeriod> p;
1336 DCPTime const len = length().round_up (video_frame_rate ());
1338 switch (reel_type ()) {
1339 case REELTYPE_SINGLE:
1340 p.push_back (DCPTimePeriod (DCPTime (), len));
1342 case REELTYPE_BY_VIDEO_CONTENT:
1344 optional<DCPTime> last_split;
1345 shared_ptr<VideoContent> last_video;
1346 ContentList cl = content ();
1347 BOOST_FOREACH (shared_ptr<Content> c, content ()) {
1348 shared_ptr<VideoContent> v = dynamic_pointer_cast<VideoContent> (c);
1350 BOOST_FOREACH (DCPTime t, v->reel_split_points()) {
1352 p.push_back (DCPTimePeriod (last_split.get(), t));
1360 DCPTime video_end = last_video ? last_video->end() : DCPTime(0);
1362 /* Definitely go from the last split to the end of the video content */
1363 p.push_back (DCPTimePeriod (last_split.get(), video_end));
1366 if (video_end < len) {
1367 /* And maybe go after that as well if there is any non-video hanging over the end */
1368 p.push_back (DCPTimePeriod (video_end, len));
1372 case REELTYPE_BY_LENGTH:
1375 /* Integer-divide reel length by the size of one frame to give the number of frames per reel */
1376 Frame const reel_in_frames = _reel_length / ((j2k_bandwidth() / video_frame_rate()) / 8);
1377 while (current < len) {
1378 DCPTime end = min (len, current + DCPTime::from_frames (reel_in_frames, video_frame_rate ()));
1379 p.push_back (DCPTimePeriod (current, end));