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
107 int const Film::current_state_version = 32;
109 /** Construct a Film object in a given directory.
111 * @param dir Film directory.
114 Film::Film (boost::filesystem::path dir, bool log)
115 : _playlist (new Playlist)
116 , _use_isdcf_name (true)
117 , _dcp_content_type (Config::instance()->default_dcp_content_type ())
118 , _container (Config::instance()->default_container ())
119 , _resolution (RESOLUTION_2K)
122 , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
123 , _isdcf_metadata (Config::instance()->default_isdcf_metadata ())
124 , _video_frame_rate (24)
125 , _audio_channels (6)
127 , _sequence_video (true)
128 , _interop (Config::instance()->default_interop ())
129 , _audio_processor (0)
130 , _reel_type (REELTYPE_SINGLE)
131 , _reel_length (2000000000)
132 , _state_version (current_state_version)
135 set_isdcf_date_today ();
137 _playlist_changed_connection = _playlist->Changed.connect (bind (&Film::playlist_changed, this));
138 _playlist_content_changed_connection = _playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2, _3));
140 /* Make state.directory a complete path without ..s (where possible)
141 (Code swiped from Adam Bowen on stackoverflow)
142 XXX: couldn't/shouldn't this just be boost::filesystem::canonical?
145 boost::filesystem::path p (boost::filesystem::system_complete (dir));
146 boost::filesystem::path result;
147 for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
149 if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
152 result = result.parent_path ();
154 } else if (*i != ".") {
159 set_directory (result.make_preferred ());
161 _log.reset (new FileLog (file ("log")));
163 _log.reset (new NullLog);
166 _playlist->set_sequence_video (_sequence_video);
171 BOOST_FOREACH (boost::signals2::connection& i, _job_connections) {
175 BOOST_FOREACH (boost::signals2::connection& i, _audio_analysis_connections) {
181 Film::video_identifier () const
183 DCPOMATIC_ASSERT (container ());
186 s.imbue (std::locale::classic ());
188 s << container()->id()
189 << "_" << resolution_to_string (_resolution)
190 << "_" << _playlist->video_identifier()
191 << "_" << _video_frame_rate
192 << "_" << j2k_bandwidth();
213 /** @return The file to write video frame info to */
214 boost::filesystem::path
215 Film::info_file (DCPTimePeriod period) const
217 boost::filesystem::path p;
219 p /= video_identifier () + "_" + raw_convert<string> (period.from.get()) + "_" + raw_convert<string> (period.to.get());
223 boost::filesystem::path
224 Film::internal_video_asset_dir () const
226 return dir ("video");
229 boost::filesystem::path
230 Film::internal_video_asset_filename (DCPTimePeriod p) const
232 return video_identifier() + "_" + raw_convert<string> (p.from.get()) + "_" + raw_convert<string> (p.to.get()) + ".mxf";
235 boost::filesystem::path
236 Film::audio_analysis_path (shared_ptr<const Playlist> playlist) const
238 boost::filesystem::path p = dir ("analysis");
240 MD5Digester digester;
241 BOOST_FOREACH (shared_ptr<Content> i, playlist->content ()) {
242 shared_ptr<AudioContent> ac = dynamic_pointer_cast<AudioContent> (i);
247 digester.add (ac->digest ());
248 digester.add (ac->audio_mapping().digest ());
249 if (playlist->content().size() != 1) {
250 /* Analyses should be considered equal regardless of gain
251 if they were made from just one piece of content. This
252 is because we can fake any gain change in a single-content
253 analysis at the plotting stage rather than having to
256 digester.add (ac->audio_gain ());
260 if (audio_processor ()) {
261 digester.add (audio_processor()->id ());
264 p /= digester.get ();
268 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
272 if (dcp_name().find ("/") != string::npos) {
273 throw BadSettingError (_("name"), _("cannot contain slashes"));
276 set_isdcf_date_today ();
278 BOOST_FOREACH (string i, environment_info ()) {
282 BOOST_FOREACH (shared_ptr<const Content> i, content ()) {
283 LOG_GENERAL ("Content: %1", i->technical_summary());
285 LOG_GENERAL ("DCP video rate %1 fps", video_frame_rate());
286 if (Config::instance()->only_servers_encode ()) {
287 LOG_GENERAL_NC ("0 threads: ONLY SERVERS SET TO ENCODE");
289 LOG_GENERAL ("%1 threads", Config::instance()->num_local_encoding_threads());
291 LOG_GENERAL ("J2K bandwidth %1", j2k_bandwidth());
293 if (container() == 0) {
294 throw MissingSettingError (_("container"));
297 if (content().empty()) {
298 throw runtime_error (_("You must add some content to the DCP before creating it"));
301 if (dcp_content_type() == 0) {
302 throw MissingSettingError (_("content type"));
305 if (name().empty()) {
306 throw MissingSettingError (_("name"));
309 JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
312 /** Start a job to send our DCP to the configured TMS */
314 Film::send_dcp_to_tms ()
316 shared_ptr<Job> j (new UploadJob (shared_from_this()));
317 JobManager::instance()->add (j);
320 shared_ptr<xmlpp::Document>
321 Film::metadata () const
323 shared_ptr<xmlpp::Document> doc (new xmlpp::Document);
324 xmlpp::Element* root = doc->create_root_node ("Metadata");
326 root->add_child("Version")->add_child_text (raw_convert<string> (current_state_version));
327 root->add_child("Name")->add_child_text (_name);
328 root->add_child("UseISDCFName")->add_child_text (_use_isdcf_name ? "1" : "0");
330 if (_dcp_content_type) {
331 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->isdcf_name ());
335 root->add_child("Container")->add_child_text (_container->id ());
338 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
339 root->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
340 _isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
341 root->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
342 root->add_child("ISDCFDate")->add_child_text (boost::gregorian::to_iso_string (_isdcf_date));
343 root->add_child("AudioChannels")->add_child_text (raw_convert<string> (_audio_channels));
344 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
345 root->add_child("SequenceVideo")->add_child_text (_sequence_video ? "1" : "0");
346 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
347 root->add_child("Signed")->add_child_text (_signed ? "1" : "0");
348 root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
349 root->add_child("Key")->add_child_text (_key.hex ());
350 if (_audio_processor) {
351 root->add_child("AudioProcessor")->add_child_text (_audio_processor->id ());
353 root->add_child("ReelType")->add_child_text (raw_convert<string> (_reel_type));
354 root->add_child("ReelLength")->add_child_text (raw_convert<string> (_reel_length));
355 _playlist->as_xml (root->add_child ("Playlist"));
360 /** Write state to our `metadata' file */
362 Film::write_metadata () const
364 boost::filesystem::create_directories (directory ());
365 shared_ptr<xmlpp::Document> doc = metadata ();
366 doc->write_to_file_formatted (file("metadata.xml").string ());
370 /** Read state from our metadata file.
371 * @return Notes about things that the user should know about, or empty.
374 Film::read_metadata ()
376 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
377 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!"));
380 cxml::Document f ("Metadata");
381 f.read_file (file ("metadata.xml"));
383 _state_version = f.number_child<int> ("Version");
384 if (_state_version > current_state_version) {
385 throw runtime_error (_("This film was created with a newer version of DCP-o-matic, and it cannot be loaded into this version. Sorry!"));
388 _name = f.string_child ("Name");
389 if (_state_version >= 9) {
390 _use_isdcf_name = f.bool_child ("UseISDCFName");
391 _isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
392 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("ISDCFDate"));
394 _use_isdcf_name = f.bool_child ("UseDCIName");
395 _isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
396 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
400 optional<string> c = f.optional_string_child ("DCPContentType");
402 _dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
407 optional<string> c = f.optional_string_child ("Container");
409 _container = Ratio::from_id (c.get ());
413 _resolution = string_to_resolution (f.string_child ("Resolution"));
414 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
415 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
416 _signed = f.optional_bool_child("Signed").get_value_or (true);
417 _encrypted = f.bool_child ("Encrypted");
418 _audio_channels = f.number_child<int> ("AudioChannels");
419 /* We used to allow odd numbers (and zero) channels, but it's just not worth
422 if (_audio_channels == 0) {
424 } else if ((_audio_channels % 2) == 1) {
427 _sequence_video = f.bool_child ("SequenceVideo");
428 _three_d = f.bool_child ("ThreeD");
429 _interop = f.bool_child ("Interop");
430 _key = dcp::Key (f.string_child ("Key"));
432 if (f.optional_string_child ("AudioProcessor")) {
433 _audio_processor = AudioProcessor::from_id (f.string_child ("AudioProcessor"));
435 _audio_processor = 0;
438 _reel_type = static_cast<ReelType> (f.optional_number_child<int>("ReelType").get_value_or (static_cast<int>(REELTYPE_SINGLE)));
439 _reel_length = f.optional_number_child<int64_t>("ReelLength").get_value_or (2000000000);
442 /* This method is the only one that can return notes (so far) */
443 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
445 /* Write backtraces to this film's directory, until another film is loaded */
446 set_backtrace_file (file ("backtrace.txt"));
452 /** Given a directory name, return its full path within the Film's directory.
453 * The directory (and its parents) will be created if they do not exist.
455 boost::filesystem::path
456 Film::dir (boost::filesystem::path d) const
458 boost::filesystem::path p;
462 boost::filesystem::create_directories (p);
467 /** Given a file or directory name, return its full path within the Film's directory.
468 * Any required parent directories will be created.
470 boost::filesystem::path
471 Film::file (boost::filesystem::path f) const
473 boost::filesystem::path p;
477 boost::filesystem::create_directories (p.parent_path ());
482 /** @return a ISDCF-compliant name for a DCP of this film */
484 Film::isdcf_name (bool if_created_now) const
488 string raw_name = name ();
490 /* Split the raw name up into words */
491 vector<string> words;
492 split (words, raw_name, is_any_of (" _-"));
496 /* Add each word to fixed_name */
497 for (vector<string>::const_iterator i = words.begin(); i != words.end(); ++i) {
500 /* First letter is always capitalised */
501 w[0] = toupper (w[0]);
503 /* Count caps in w */
505 for (size_t i = 0; i < w.size(); ++i) {
506 if (isupper (w[i])) {
511 /* If w is all caps make the rest of it lower case, otherwise
514 if (caps == w.size ()) {
515 for (size_t i = 1; i < w.size(); ++i) {
516 w[i] = tolower (w[i]);
520 for (size_t i = 0; i < w.size(); ++i) {
525 if (fixed_name.length() > 14) {
526 fixed_name = fixed_name.substr (0, 14);
531 if (dcp_content_type()) {
532 d << "_" << dcp_content_type()->isdcf_name();
533 d << "-" << isdcf_metadata().content_version;
536 ISDCFMetadata const dm = isdcf_metadata ();
538 if (dm.temp_version) {
542 if (dm.pre_release) {
550 if (!dm.chain.empty ()) {
551 d << "-" << dm.chain;
558 if (dm.two_d_version_of_three_d) {
562 if (!dm.mastered_luminance.empty ()) {
563 d << "-" << dm.mastered_luminance;
566 if (video_frame_rate() != 24) {
567 d << "-" << video_frame_rate();
571 d << "_" << container()->isdcf_name();
574 /* XXX: this uses the first bit of content only */
576 /* The standard says we don't do this for trailers, for some strange reason */
577 if (dcp_content_type() && dcp_content_type()->libdcp_kind() != dcp::TRAILER) {
578 Ratio const * content_ratio = 0;
579 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
580 shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (i);
582 /* Here's the first piece of video content */
583 if (vc->scale().ratio ()) {
584 content_ratio = vc->scale().ratio ();
586 content_ratio = Ratio::from_ratio (vc->video_size().ratio ());
592 if (content_ratio && content_ratio != container()) {
593 d << "-" << content_ratio->isdcf_name();
597 if (!dm.audio_language.empty ()) {
598 d << "_" << dm.audio_language;
599 if (!dm.subtitle_language.empty()) {
601 bool burnt_in = false;
602 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
603 shared_ptr<SubtitleContent> sc = dynamic_pointer_cast<SubtitleContent> (i);
608 if (sc->use_subtitles() && sc->burn_subtitles()) {
613 string language = dm.subtitle_language;
615 transform (language.begin(), language.end(), language.begin(), ::tolower);
617 transform (language.begin(), language.end(), language.begin(), ::toupper);
620 d << "-" << language;
626 if (!dm.territory.empty ()) {
627 d << "_" << dm.territory;
628 if (dm.rating.empty ()) {
631 d << "-" << dm.rating;
635 /* Find all mapped channels */
640 if (audio_processor ()) {
641 /* Processors are mapped 1:1 to DCP outputs so we can guess the number of LFE/
642 non-LFE from the channel counts.
644 non_lfe = audio_processor()->out_channels ();
651 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
652 shared_ptr<const AudioContent> ac = dynamic_pointer_cast<const AudioContent> (i);
654 list<int> c = ac->audio_mapping().mapped_output_channels ();
655 copy (c.begin(), c.end(), back_inserter (mapped));
664 for (list<int>::const_iterator i = mapped.begin(); i != mapped.end(); ++i) {
665 if (*i >= audio_channels()) {
666 /* This channel is mapped but is not included in the DCP */
670 if (static_cast<dcp::Channel> (*i) == dcp::LFE) {
679 d << "_" << non_lfe << lfe;
684 d << "_" << resolution_to_string (_resolution);
686 if (!dm.studio.empty ()) {
687 d << "_" << dm.studio;
690 if (if_created_now) {
691 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
693 d << "_" << boost::gregorian::to_iso_string (_isdcf_date);
696 if (!dm.facility.empty ()) {
697 d << "_" << dm.facility;
711 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
712 shared_ptr<const DCPContent> dc = dynamic_pointer_cast<const DCPContent> (i);
713 if (dc && (dc->reference_video() || dc->reference_audio() || dc->reference_subtitle())) {
727 /** @return name to give the DCP */
729 Film::dcp_name (bool if_created_now) const
732 if (use_isdcf_name()) {
733 unfiltered = isdcf_name (if_created_now);
735 unfiltered = name ();
738 /* Filter out `bad' characters which cause problems with some systems.
739 There's no apparent list of what really is allowed, so this is a guess.
743 string const allowed = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-_";
744 for (size_t i = 0; i < unfiltered.size(); ++i) {
745 if (allowed.find (unfiltered[i]) != string::npos) {
746 filtered += unfiltered[i];
754 Film::set_directory (boost::filesystem::path d)
761 Film::set_name (string n)
764 signal_changed (NAME);
768 Film::set_use_isdcf_name (bool u)
771 signal_changed (USE_ISDCF_NAME);
775 Film::set_dcp_content_type (DCPContentType const * t)
777 _dcp_content_type = t;
778 signal_changed (DCP_CONTENT_TYPE);
782 Film::set_container (Ratio const * c)
785 signal_changed (CONTAINER);
789 Film::set_resolution (Resolution r)
792 signal_changed (RESOLUTION);
796 Film::set_j2k_bandwidth (int b)
799 signal_changed (J2K_BANDWIDTH);
803 Film::set_isdcf_metadata (ISDCFMetadata m)
806 signal_changed (ISDCF_METADATA);
810 Film::set_video_frame_rate (int f)
812 _video_frame_rate = f;
813 signal_changed (VIDEO_FRAME_RATE);
817 Film::set_audio_channels (int c)
820 signal_changed (AUDIO_CHANNELS);
824 Film::set_three_d (bool t)
827 signal_changed (THREE_D);
829 if (_three_d && _isdcf_metadata.two_d_version_of_three_d) {
830 _isdcf_metadata.two_d_version_of_three_d = false;
831 signal_changed (ISDCF_METADATA);
836 Film::set_interop (bool i)
839 signal_changed (INTEROP);
843 Film::set_audio_processor (AudioProcessor const * processor)
845 _audio_processor = processor;
846 signal_changed (AUDIO_PROCESSOR);
847 signal_changed (AUDIO_CHANNELS);
851 Film::set_reel_type (ReelType t)
854 signal_changed (REEL_TYPE);
857 /** @param r Desired reel length in bytes */
859 Film::set_reel_length (int64_t r)
862 signal_changed (REEL_LENGTH);
866 Film::signal_changed (Property p)
872 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
874 case Film::VIDEO_FRAME_RATE:
875 case Film::SEQUENCE_VIDEO:
876 _playlist->maybe_sequence_video ();
882 emit (boost::bind (boost::ref (Changed), p));
886 Film::set_isdcf_date_today ()
888 _isdcf_date = boost::gregorian::day_clock::local_day ();
891 boost::filesystem::path
892 Film::j2c_path (int reel, Frame frame, Eyes eyes, bool tmp) const
894 boost::filesystem::path p;
896 p /= video_identifier ();
900 s << setfill('0') << reel << "_" << frame;
902 if (eyes == EYES_LEFT) {
904 } else if (eyes == EYES_RIGHT) {
918 /** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs */
922 vector<CPLSummary> out;
924 boost::filesystem::path const dir = directory ();
925 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
927 boost::filesystem::is_directory (*i) &&
928 i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
936 i->path().leaf().string(),
937 dcp.cpls().front()->id(),
938 dcp.cpls().front()->annotation_text(),
939 dcp.cpls().front()->file()
952 Film::set_signed (bool s)
955 signal_changed (SIGNED);
959 Film::set_encrypted (bool e)
962 signal_changed (ENCRYPTED);
966 Film::set_key (dcp::Key key)
969 signal_changed (KEY);
973 Film::content () const
975 return _playlist->content ();
979 Film::examine_content (shared_ptr<Content> c)
981 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
982 JobManager::instance()->add (j);
986 Film::examine_and_add_content (shared_ptr<Content> c)
988 if (dynamic_pointer_cast<FFmpegContent> (c) && !_directory.empty ()) {
989 run_ffprobe (c->path(0), file ("ffprobe.log"), _log);
992 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
994 _job_connections.push_back (
995 j->Finished.connect (bind (&Film::maybe_add_content, this, weak_ptr<Job> (j), weak_ptr<Content> (c)))
998 JobManager::instance()->add (j);
1002 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
1004 shared_ptr<Job> job = j.lock ();
1005 if (!job || !job->finished_ok ()) {
1009 shared_ptr<Content> content = c.lock ();
1014 add_content (content);
1015 if (Config::instance()->automatic_audio_analysis ()) {
1016 shared_ptr<Playlist> playlist (new Playlist);
1017 playlist->add (content);
1018 boost::signals2::connection c;
1019 JobManager::instance()->analyse_audio (
1020 shared_from_this (), playlist, c, bind (&Film::audio_analysis_finished, this)
1022 _audio_analysis_connections.push_back (c);
1027 Film::add_content (shared_ptr<Content> c)
1029 /* Add video content after any existing content */
1030 if (dynamic_pointer_cast<VideoContent> (c)) {
1031 c->set_position (_playlist->video_end ());
1038 Film::remove_content (shared_ptr<Content> c)
1040 _playlist->remove (c);
1044 Film::move_content_earlier (shared_ptr<Content> c)
1046 _playlist->move_earlier (c);
1050 Film::move_content_later (shared_ptr<Content> c)
1052 _playlist->move_later (c);
1055 /** @return length of the film from time 0 to the last thing on the playlist */
1057 Film::length () const
1059 return _playlist->length ();
1063 Film::best_video_frame_rate () const
1065 return _playlist->best_dcp_frame_rate ();
1069 Film::active_frame_rate_change (DCPTime t) const
1071 return _playlist->active_frame_rate_change (t, video_frame_rate ());
1075 Film::playlist_content_changed (weak_ptr<Content> c, int p, bool frequent)
1079 if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
1080 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
1081 } else if (p == AudioContentProperty::AUDIO_STREAMS) {
1082 signal_changed (NAME);
1085 emit (boost::bind (boost::ref (ContentChanged), c, p, frequent));
1089 Film::playlist_changed ()
1091 signal_changed (CONTENT);
1092 signal_changed (NAME);
1096 Film::audio_frame_rate () const
1098 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
1099 shared_ptr<AudioContent> a = dynamic_pointer_cast<AudioContent> (i);
1100 if (a && a->has_rate_above_48k ()) {
1109 Film::set_sequence_video (bool s)
1111 _sequence_video = s;
1112 _playlist->set_sequence_video (s);
1113 signal_changed (SEQUENCE_VIDEO);
1116 /** @return Size of the largest possible image in whatever resolution we are using */
1118 Film::full_frame () const
1120 switch (_resolution) {
1122 return dcp::Size (2048, 1080);
1124 return dcp::Size (4096, 2160);
1127 DCPOMATIC_ASSERT (false);
1128 return dcp::Size ();
1131 /** @return Size of the frame */
1133 Film::frame_size () const
1135 return fit_ratio_within (container()->ratio(), full_frame ());
1140 dcp::Certificate recipient,
1141 vector<dcp::Certificate> trusted_devices,
1142 boost::filesystem::path cpl_file,
1143 dcp::LocalTime from,
1144 dcp::LocalTime until,
1145 dcp::Formulation formulation
1148 shared_ptr<const dcp::CPL> cpl (new dcp::CPL (cpl_file));
1149 shared_ptr<const dcp::CertificateChain> signer = Config::instance()->signer_chain ();
1150 if (!signer->valid ()) {
1151 throw InvalidSignerError ();
1154 return dcp::DecryptedKDM (
1155 cpl, key(), from, until, "DCP-o-matic", cpl->content_title_text(), dcp::LocalTime().as_string()
1156 ).encrypt (signer, recipient, trusted_devices, formulation);
1161 list<shared_ptr<Screen> > screens,
1162 boost::filesystem::path dcp,
1163 dcp::LocalTime from,
1164 dcp::LocalTime until,
1165 dcp::Formulation formulation
1168 list<ScreenKDM> kdms;
1170 BOOST_FOREACH (shared_ptr<Screen> i, screens) {
1172 kdms.push_back (ScreenKDM (i, make_kdm (i->recipient.get(), i->trusted_devices, dcp, from, until, formulation)));
1179 /** @return The approximate disk space required to encode a DCP of this film with the
1180 * current settings, in bytes.
1183 Film::required_disk_space () const
1185 return _playlist->required_disk_space (j2k_bandwidth(), audio_channels(), audio_frame_rate());
1188 /** This method checks the disk that the Film is on and tries to decide whether or not
1189 * there will be enough space to make a DCP for it. If so, true is returned; if not,
1190 * false is returned and required and available are filled in with the amount of disk space
1191 * required and available respectively (in Gb).
1193 * Note: the decision made by this method isn't, of course, 100% reliable.
1196 Film::should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const
1198 /* Create a test file and see if we can hard-link it */
1199 boost::filesystem::path test = internal_video_asset_dir() / "test";
1200 boost::filesystem::path test2 = internal_video_asset_dir() / "test2";
1201 can_hard_link = true;
1202 FILE* f = fopen_boost (test, "w");
1205 boost::system::error_code ec;
1206 boost::filesystem::create_hard_link (test, test2, ec);
1208 can_hard_link = false;
1210 boost::filesystem::remove (test);
1211 boost::filesystem::remove (test2);
1214 boost::filesystem::space_info s = boost::filesystem::space (internal_video_asset_dir ());
1215 required = double (required_disk_space ()) / 1073741824.0f;
1216 if (!can_hard_link) {
1219 available = double (s.available) / 1073741824.0f;
1220 return (available - required) > 1;
1224 Film::subtitle_language () const
1226 set<string> languages;
1228 ContentList cl = content ();
1229 BOOST_FOREACH (shared_ptr<Content>& c, cl) {
1230 shared_ptr<SubtitleContent> sc = dynamic_pointer_cast<SubtitleContent> (c);
1232 languages.insert (sc->subtitle_language ());
1237 BOOST_FOREACH (string s, languages) {
1238 if (!all.empty ()) {
1248 /** Change the gains of the supplied AudioMapping to make it a default
1249 * for this film. The defaults are guessed based on what processor (if any)
1250 * is in use and the number of input channels.
1253 Film::make_audio_mapping_default (AudioMapping& mapping) const
1255 if (audio_processor ()) {
1256 audio_processor()->make_audio_mapping_default (mapping);
1258 mapping.make_zero ();
1259 if (mapping.input_channels() == 1) {
1260 /* Mono -> Centre */
1261 mapping.set (0, static_cast<int> (dcp::CENTRE), 1);
1264 for (int i = 0; i < min (mapping.input_channels(), mapping.output_channels()); ++i) {
1265 mapping.set (i, i, 1);
1271 /** @return The names of the channels that audio contents' outputs are passed into;
1272 * this is either the DCP or a AudioProcessor.
1275 Film::audio_output_names () const
1277 if (audio_processor ()) {
1278 return audio_processor()->input_names ();
1281 DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
1284 n.push_back (_("L"));
1285 n.push_back (_("R"));
1286 n.push_back (_("C"));
1287 n.push_back (_("Lfe"));
1288 n.push_back (_("Ls"));
1289 n.push_back (_("Rs"));
1290 n.push_back (_("HI"));
1291 n.push_back (_("VI"));
1292 n.push_back (_("Lc"));
1293 n.push_back (_("Rc"));
1294 n.push_back (_("BsL"));
1295 n.push_back (_("BsR"));
1296 n.push_back (_("DBP"));
1297 n.push_back (_("DBS"));
1301 return vector<string> (n.begin(), n.begin() + audio_channels ());
1305 Film::repeat_content (ContentList c, int n)
1307 _playlist->repeat (c, n);
1311 Film::remove_content (ContentList c)
1313 _playlist->remove (c);
1317 Film::audio_analysis_finished ()
1323 Film::reels () const
1325 list<DCPTimePeriod> p;
1326 DCPTime const len = length().round_up (video_frame_rate ());
1328 switch (reel_type ()) {
1329 case REELTYPE_SINGLE:
1330 p.push_back (DCPTimePeriod (DCPTime (), len));
1332 case REELTYPE_BY_VIDEO_CONTENT:
1334 optional<DCPTime> last_split;
1335 shared_ptr<VideoContent> last_video;
1336 ContentList cl = content ();
1337 BOOST_FOREACH (shared_ptr<Content> c, content ()) {
1338 shared_ptr<VideoContent> v = dynamic_pointer_cast<VideoContent> (c);
1340 BOOST_FOREACH (DCPTime t, v->reel_split_points()) {
1342 p.push_back (DCPTimePeriod (last_split.get(), t));
1350 DCPTime video_end = last_video ? last_video->end() : DCPTime(0);
1352 /* Definitely go from the last split to the end of the video content */
1353 p.push_back (DCPTimePeriod (last_split.get(), video_end));
1356 if (video_end < len) {
1357 /* And maybe go after that as well if there is any non-video hanging over the end */
1358 p.push_back (DCPTimePeriod (video_end, len));
1362 case REELTYPE_BY_LENGTH:
1365 /* Integer-divide reel length by the size of one frame to give the number of frames per reel */
1366 Frame const reel_in_frames = _reel_length / ((j2k_bandwidth() / video_frame_rate()) / 8);
1367 while (current < len) {
1368 DCPTime end = min (len, current + DCPTime::from_frames (reel_in_frames, video_frame_rate ()));
1369 p.push_back (DCPTimePeriod (current, end));