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 boost::shared_ptr;
84 using boost::weak_ptr;
85 using boost::dynamic_pointer_cast;
86 using boost::optional;
87 using boost::is_any_of;
89 #define LOG_GENERAL(...) log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
90 #define LOG_GENERAL_NC(...) log()->log (__VA_ARGS__, LogEntry::TYPE_GENERAL);
93 * AudioMapping XML changed.
95 * Subtitle offset changed to subtitle y offset, and subtitle x offset added.
97 * Use <Scale> tag in <VideoContent> rather than <Ratio>.
101 * Subtitle X and Y scale.
103 * Bumped to 32 for 2.0 branch; some times are expressed in Times rather
106 int const Film::current_state_version = 32;
108 /** Construct a Film object in a given directory.
110 * @param dir Film directory.
113 Film::Film (boost::filesystem::path dir, bool log)
114 : _playlist (new Playlist)
115 , _use_isdcf_name (true)
116 , _dcp_content_type (Config::instance()->default_dcp_content_type ())
117 , _container (Config::instance()->default_container ())
118 , _resolution (RESOLUTION_2K)
121 , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
122 , _isdcf_metadata (Config::instance()->default_isdcf_metadata ())
123 , _video_frame_rate (24)
124 , _audio_channels (6)
126 , _sequence_video (true)
127 , _interop (Config::instance()->default_interop ())
128 , _audio_processor (0)
129 , _reel_type (REELTYPE_SINGLE)
130 , _reel_length (2000000000)
131 , _state_version (current_state_version)
134 set_isdcf_date_today ();
136 _playlist_changed_connection = _playlist->Changed.connect (bind (&Film::playlist_changed, this));
137 _playlist_content_changed_connection = _playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2, _3));
139 /* Make state.directory a complete path without ..s (where possible)
140 (Code swiped from Adam Bowen on stackoverflow)
143 boost::filesystem::path p (boost::filesystem::system_complete (dir));
144 boost::filesystem::path result;
145 for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
147 if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
150 result = result.parent_path ();
152 } else if (*i != ".") {
157 set_directory (result.make_preferred ());
159 _log.reset (new FileLog (file ("log")));
161 _log.reset (new NullLog);
164 _playlist->set_sequence_video (_sequence_video);
169 BOOST_FOREACH (boost::signals2::connection& i, _job_connections) {
173 BOOST_FOREACH (boost::signals2::connection& i, _audio_analysis_connections) {
179 Film::video_identifier () const
181 DCPOMATIC_ASSERT (container ());
184 s.imbue (std::locale::classic ());
186 s << container()->id()
187 << "_" << resolution_to_string (_resolution)
188 << "_" << _playlist->video_identifier()
189 << "_" << _video_frame_rate
190 << "_" << j2k_bandwidth();
211 /** @return The file to write video frame info to */
212 boost::filesystem::path
213 Film::info_file (DCPTimePeriod period) const
215 boost::filesystem::path p;
217 p /= video_identifier () + "_" + raw_convert<string> (period.from.get()) + "_" + raw_convert<string> (period.to.get());
221 boost::filesystem::path
222 Film::internal_video_asset_dir () const
224 return dir ("video");
227 boost::filesystem::path
228 Film::internal_video_asset_filename (DCPTimePeriod p) const
230 return video_identifier() + "_" + raw_convert<string> (p.from.get()) + "_" + raw_convert<string> (p.to.get()) + ".mxf";
233 boost::filesystem::path
234 Film::audio_analysis_path (shared_ptr<const Playlist> playlist) const
236 boost::filesystem::path p = dir ("analysis");
238 MD5Digester digester;
239 BOOST_FOREACH (shared_ptr<Content> i, playlist->content ()) {
240 shared_ptr<AudioContent> ac = dynamic_pointer_cast<AudioContent> (i);
245 digester.add (ac->digest ());
246 digester.add (ac->audio_mapping().digest ());
247 if (playlist->content().size() != 1) {
248 /* Analyses should be considered equal regardless of gain
249 if they were made from just one piece of content. This
250 is because we can fake any gain change in a single-content
251 analysis at the plotting stage rather than having to
254 digester.add (ac->audio_gain ());
258 if (audio_processor ()) {
259 digester.add (audio_processor()->id ());
262 p /= digester.get ();
266 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
270 if (dcp_name().find ("/") != string::npos) {
271 throw BadSettingError (_("name"), _("cannot contain slashes"));
274 set_isdcf_date_today ();
276 environment_info (log ());
278 BOOST_FOREACH (shared_ptr<const Content> i, content ()) {
279 LOG_GENERAL ("Content: %1", i->technical_summary());
281 LOG_GENERAL ("DCP video rate %1 fps", video_frame_rate());
282 if (Config::instance()->only_servers_encode ()) {
283 LOG_GENERAL_NC ("0 threads: ONLY SERVERS SET TO ENCODE");
285 LOG_GENERAL ("%1 threads", Config::instance()->num_local_encoding_threads());
287 LOG_GENERAL ("J2K bandwidth %1", j2k_bandwidth());
289 if (container() == 0) {
290 throw MissingSettingError (_("container"));
293 if (content().empty()) {
294 throw StringError (_("You must add some content to the DCP before creating it"));
297 if (dcp_content_type() == 0) {
298 throw MissingSettingError (_("content type"));
301 if (name().empty()) {
302 throw MissingSettingError (_("name"));
305 JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
308 /** Start a job to send our DCP to the configured TMS */
310 Film::send_dcp_to_tms ()
312 shared_ptr<Job> j (new UploadJob (shared_from_this()));
313 JobManager::instance()->add (j);
316 shared_ptr<xmlpp::Document>
317 Film::metadata () const
319 shared_ptr<xmlpp::Document> doc (new xmlpp::Document);
320 xmlpp::Element* root = doc->create_root_node ("Metadata");
322 root->add_child("Version")->add_child_text (raw_convert<string> (current_state_version));
323 root->add_child("Name")->add_child_text (_name);
324 root->add_child("UseISDCFName")->add_child_text (_use_isdcf_name ? "1" : "0");
326 if (_dcp_content_type) {
327 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->isdcf_name ());
331 root->add_child("Container")->add_child_text (_container->id ());
334 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
335 root->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
336 _isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
337 root->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
338 root->add_child("ISDCFDate")->add_child_text (boost::gregorian::to_iso_string (_isdcf_date));
339 root->add_child("AudioChannels")->add_child_text (raw_convert<string> (_audio_channels));
340 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
341 root->add_child("SequenceVideo")->add_child_text (_sequence_video ? "1" : "0");
342 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
343 root->add_child("Signed")->add_child_text (_signed ? "1" : "0");
344 root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
345 root->add_child("Key")->add_child_text (_key.hex ());
346 if (_audio_processor) {
347 root->add_child("AudioProcessor")->add_child_text (_audio_processor->id ());
349 root->add_child("ReelType")->add_child_text (raw_convert<string> (_reel_type));
350 root->add_child("ReelLength")->add_child_text (raw_convert<string> (_reel_length));
351 _playlist->as_xml (root->add_child ("Playlist"));
356 /** Write state to our `metadata' file */
358 Film::write_metadata () const
360 boost::filesystem::create_directories (directory ());
361 shared_ptr<xmlpp::Document> doc = metadata ();
362 doc->write_to_file_formatted (file("metadata.xml").string ());
366 /** Read state from our metadata file.
367 * @return Notes about things that the user should know about, or empty.
370 Film::read_metadata ()
372 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
373 throw StringError (_("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!"));
376 cxml::Document f ("Metadata");
377 f.read_file (file ("metadata.xml"));
379 _state_version = f.number_child<int> ("Version");
380 if (_state_version > current_state_version) {
381 throw StringError (_("This film was created with a newer version of DCP-o-matic, and it cannot be loaded into this version. Sorry!"));
384 _name = f.string_child ("Name");
385 if (_state_version >= 9) {
386 _use_isdcf_name = f.bool_child ("UseISDCFName");
387 _isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
388 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("ISDCFDate"));
390 _use_isdcf_name = f.bool_child ("UseDCIName");
391 _isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
392 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
396 optional<string> c = f.optional_string_child ("DCPContentType");
398 _dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
403 optional<string> c = f.optional_string_child ("Container");
405 _container = Ratio::from_id (c.get ());
409 _resolution = string_to_resolution (f.string_child ("Resolution"));
410 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
411 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
412 _signed = f.optional_bool_child("Signed").get_value_or (true);
413 _encrypted = f.bool_child ("Encrypted");
414 _audio_channels = f.number_child<int> ("AudioChannels");
415 /* We used to allow odd numbers (and zero) channels, but it's just not worth
418 if (_audio_channels == 0) {
420 } else if ((_audio_channels % 2) == 1) {
423 _sequence_video = f.bool_child ("SequenceVideo");
424 _three_d = f.bool_child ("ThreeD");
425 _interop = f.bool_child ("Interop");
426 _key = dcp::Key (f.string_child ("Key"));
428 if (f.optional_string_child ("AudioProcessor")) {
429 _audio_processor = AudioProcessor::from_id (f.string_child ("AudioProcessor"));
431 _audio_processor = 0;
434 _reel_type = static_cast<ReelType> (f.optional_number_child<int>("ReelType").get_value_or (static_cast<int>(REELTYPE_SINGLE)));
435 _reel_length = f.optional_number_child<int64_t>("ReelLength").get_value_or (2000000000);
438 /* This method is the only one that can return notes (so far) */
439 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
441 /* Write backtraces to this film's directory, until another film is loaded */
442 set_backtrace_file (file ("backtrace.txt"));
448 /** Given a directory name, return its full path within the Film's directory.
449 * The directory (and its parents) will be created if they do not exist.
451 boost::filesystem::path
452 Film::dir (boost::filesystem::path d) const
454 boost::filesystem::path p;
458 boost::filesystem::create_directories (p);
463 /** Given a file or directory name, return its full path within the Film's directory.
464 * Any required parent directories will be created.
466 boost::filesystem::path
467 Film::file (boost::filesystem::path f) const
469 boost::filesystem::path p;
473 boost::filesystem::create_directories (p.parent_path ());
478 /** @return a ISDCF-compliant name for a DCP of this film */
480 Film::isdcf_name (bool if_created_now) const
484 string raw_name = name ();
486 /* Split the raw name up into words */
487 vector<string> words;
488 split (words, raw_name, is_any_of (" _-"));
492 /* Add each word to fixed_name */
493 for (vector<string>::const_iterator i = words.begin(); i != words.end(); ++i) {
496 /* First letter is always capitalised */
497 w[0] = toupper (w[0]);
499 /* Count caps in w */
501 for (size_t i = 0; i < w.size(); ++i) {
502 if (isupper (w[i])) {
507 /* If w is all caps make the rest of it lower case, otherwise
510 if (caps == w.size ()) {
511 for (size_t i = 1; i < w.size(); ++i) {
512 w[i] = tolower (w[i]);
516 for (size_t i = 0; i < w.size(); ++i) {
521 if (fixed_name.length() > 14) {
522 fixed_name = fixed_name.substr (0, 14);
527 if (dcp_content_type()) {
528 d << "_" << dcp_content_type()->isdcf_name();
529 d << "-" << isdcf_metadata().content_version;
532 ISDCFMetadata const dm = isdcf_metadata ();
534 if (dm.temp_version) {
538 if (dm.pre_release) {
546 if (!dm.chain.empty ()) {
547 d << "-" << dm.chain;
554 if (dm.two_d_version_of_three_d) {
558 if (!dm.mastered_luminance.empty ()) {
559 d << "-" << dm.mastered_luminance;
562 if (video_frame_rate() != 24) {
563 d << "-" << video_frame_rate();
567 d << "_" << container()->isdcf_name();
570 /* XXX: this uses the first bit of content only */
572 /* The standard says we don't do this for trailers, for some strange reason */
573 if (dcp_content_type() && dcp_content_type()->libdcp_kind() != dcp::TRAILER) {
574 Ratio const * content_ratio = 0;
575 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
576 shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (i);
578 /* Here's the first piece of video content */
579 if (vc->scale().ratio ()) {
580 content_ratio = vc->scale().ratio ();
582 content_ratio = Ratio::from_ratio (vc->video_size().ratio ());
588 if (content_ratio && content_ratio != container()) {
589 d << "-" << content_ratio->isdcf_name();
593 if (!dm.audio_language.empty ()) {
594 d << "_" << dm.audio_language;
595 if (!dm.subtitle_language.empty()) {
596 d << "-" << dm.subtitle_language;
602 if (!dm.territory.empty ()) {
603 d << "_" << dm.territory;
604 if (dm.rating.empty ()) {
607 d << "-" << dm.rating;
611 /* Find all mapped channels */
616 if (audio_processor ()) {
617 /* Processors are mapped 1:1 to DCP outputs so we can guess the number of LFE/
618 non-LFE from the channel counts.
620 non_lfe = audio_processor()->out_channels ();
627 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
628 shared_ptr<const AudioContent> ac = dynamic_pointer_cast<const AudioContent> (i);
630 list<int> c = ac->audio_mapping().mapped_output_channels ();
631 copy (c.begin(), c.end(), back_inserter (mapped));
640 for (list<int>::const_iterator i = mapped.begin(); i != mapped.end(); ++i) {
641 if (*i >= audio_channels()) {
642 /* This channel is mapped but is not included in the DCP */
646 if (static_cast<dcp::Channel> (*i) == dcp::LFE) {
655 d << "_" << non_lfe << lfe;
660 d << "_" << resolution_to_string (_resolution);
662 if (!dm.studio.empty ()) {
663 d << "_" << dm.studio;
666 if (if_created_now) {
667 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
669 d << "_" << boost::gregorian::to_iso_string (_isdcf_date);
672 if (!dm.facility.empty ()) {
673 d << "_" << dm.facility;
687 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
688 shared_ptr<const DCPContent> dc = dynamic_pointer_cast<const DCPContent> (i);
689 if (dc && (dc->reference_video() || dc->reference_audio() || dc->reference_subtitle())) {
703 /** @return name to give the DCP */
705 Film::dcp_name (bool if_created_now) const
708 if (use_isdcf_name()) {
709 unfiltered = isdcf_name (if_created_now);
711 unfiltered = name ();
714 /* Filter out `bad' characters which cause problems with some systems.
715 There's no apparent list of what really is allowed, so this is a guess.
719 string const allowed = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-_";
720 for (size_t i = 0; i < unfiltered.size(); ++i) {
721 if (allowed.find (unfiltered[i]) != string::npos) {
722 filtered += unfiltered[i];
730 Film::set_directory (boost::filesystem::path d)
737 Film::set_name (string n)
740 signal_changed (NAME);
744 Film::set_use_isdcf_name (bool u)
747 signal_changed (USE_ISDCF_NAME);
751 Film::set_dcp_content_type (DCPContentType const * t)
753 _dcp_content_type = t;
754 signal_changed (DCP_CONTENT_TYPE);
758 Film::set_container (Ratio const * c)
761 signal_changed (CONTAINER);
765 Film::set_resolution (Resolution r)
768 signal_changed (RESOLUTION);
772 Film::set_j2k_bandwidth (int b)
775 signal_changed (J2K_BANDWIDTH);
779 Film::set_isdcf_metadata (ISDCFMetadata m)
782 signal_changed (ISDCF_METADATA);
786 Film::set_video_frame_rate (int f)
788 _video_frame_rate = f;
789 signal_changed (VIDEO_FRAME_RATE);
793 Film::set_audio_channels (int c)
796 signal_changed (AUDIO_CHANNELS);
800 Film::set_three_d (bool t)
803 signal_changed (THREE_D);
805 if (_three_d && _isdcf_metadata.two_d_version_of_three_d) {
806 _isdcf_metadata.two_d_version_of_three_d = false;
807 signal_changed (ISDCF_METADATA);
812 Film::set_interop (bool i)
815 signal_changed (INTEROP);
819 Film::set_audio_processor (AudioProcessor const * processor)
821 _audio_processor = processor;
822 signal_changed (AUDIO_PROCESSOR);
823 signal_changed (AUDIO_CHANNELS);
827 Film::set_reel_type (ReelType t)
830 signal_changed (REEL_TYPE);
834 Film::set_reel_length (int64_t r)
837 signal_changed (REEL_LENGTH);
841 Film::signal_changed (Property p)
847 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
849 case Film::VIDEO_FRAME_RATE:
850 case Film::SEQUENCE_VIDEO:
851 _playlist->maybe_sequence_video ();
857 emit (boost::bind (boost::ref (Changed), p));
861 Film::set_isdcf_date_today ()
863 _isdcf_date = boost::gregorian::day_clock::local_day ();
866 boost::filesystem::path
867 Film::j2c_path (int f, Eyes e, bool t) const
869 boost::filesystem::path p;
871 p /= video_identifier ();
875 s << setfill('0') << f;
877 if (e == EYES_LEFT) {
879 } else if (e == EYES_RIGHT) {
893 /** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs */
897 vector<CPLSummary> out;
899 boost::filesystem::path const dir = directory ();
900 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
902 boost::filesystem::is_directory (*i) &&
903 i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
911 i->path().leaf().string(),
912 dcp.cpls().front()->id(),
913 dcp.cpls().front()->annotation_text(),
914 dcp.cpls().front()->file()
927 Film::set_signed (bool s)
930 signal_changed (SIGNED);
934 Film::set_encrypted (bool e)
937 signal_changed (ENCRYPTED);
941 Film::set_key (dcp::Key key)
944 signal_changed (KEY);
948 Film::content () const
950 return _playlist->content ();
954 Film::examine_content (shared_ptr<Content> c)
956 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
957 JobManager::instance()->add (j);
961 Film::examine_and_add_content (shared_ptr<Content> c)
963 if (dynamic_pointer_cast<FFmpegContent> (c) && !_directory.empty ()) {
964 run_ffprobe (c->path(0), file ("ffprobe.log"), _log);
967 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
969 _job_connections.push_back (
970 j->Finished.connect (bind (&Film::maybe_add_content, this, weak_ptr<Job> (j), weak_ptr<Content> (c)))
973 JobManager::instance()->add (j);
977 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
979 shared_ptr<Job> job = j.lock ();
980 if (!job || !job->finished_ok ()) {
984 shared_ptr<Content> content = c.lock ();
989 add_content (content);
990 if (Config::instance()->automatic_audio_analysis ()) {
991 shared_ptr<Playlist> playlist (new Playlist);
992 playlist->add (content);
993 boost::signals2::connection c;
994 JobManager::instance()->analyse_audio (
995 shared_from_this (), playlist, c, bind (&Film::audio_analysis_finished, this)
997 _audio_analysis_connections.push_back (c);
1002 Film::add_content (shared_ptr<Content> c)
1004 /* Add video content after any existing content */
1005 if (dynamic_pointer_cast<VideoContent> (c)) {
1006 c->set_position (_playlist->video_end ());
1013 Film::remove_content (shared_ptr<Content> c)
1015 _playlist->remove (c);
1019 Film::move_content_earlier (shared_ptr<Content> c)
1021 _playlist->move_earlier (c);
1025 Film::move_content_later (shared_ptr<Content> c)
1027 _playlist->move_later (c);
1030 /** @return length of the film from time 0 to the last thing on the playlist */
1032 Film::length () const
1034 return _playlist->length ();
1038 Film::best_video_frame_rate () const
1040 return _playlist->best_dcp_frame_rate ();
1044 Film::active_frame_rate_change (DCPTime t) const
1046 return _playlist->active_frame_rate_change (t, video_frame_rate ());
1050 Film::playlist_content_changed (weak_ptr<Content> c, int p, bool frequent)
1054 if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
1055 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
1056 } else if (p == AudioContentProperty::AUDIO_STREAMS) {
1057 signal_changed (NAME);
1060 emit (boost::bind (boost::ref (ContentChanged), c, p, frequent));
1064 Film::playlist_changed ()
1066 signal_changed (CONTENT);
1067 signal_changed (NAME);
1071 Film::audio_frame_rate () const
1073 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
1074 shared_ptr<AudioContent> a = dynamic_pointer_cast<AudioContent> (i);
1075 if (a && a->has_rate_above_48k ()) {
1084 Film::set_sequence_video (bool s)
1086 _sequence_video = s;
1087 _playlist->set_sequence_video (s);
1088 signal_changed (SEQUENCE_VIDEO);
1091 /** @return Size of the largest possible image in whatever resolution we are using */
1093 Film::full_frame () const
1095 switch (_resolution) {
1097 return dcp::Size (2048, 1080);
1099 return dcp::Size (4096, 2160);
1102 DCPOMATIC_ASSERT (false);
1103 return dcp::Size ();
1106 /** @return Size of the frame */
1108 Film::frame_size () const
1110 return fit_ratio_within (container()->ratio(), full_frame ());
1115 dcp::Certificate target,
1116 boost::filesystem::path cpl_file,
1117 dcp::LocalTime from,
1118 dcp::LocalTime until,
1119 dcp::Formulation formulation
1122 shared_ptr<const dcp::CPL> cpl (new dcp::CPL (cpl_file));
1123 shared_ptr<const dcp::CertificateChain> signer = Config::instance()->signer_chain ();
1124 if (!signer->valid ()) {
1125 throw InvalidSignerError ();
1128 return dcp::DecryptedKDM (
1129 cpl, key(), from, until, "DCP-o-matic", cpl->content_title_text(), dcp::LocalTime().as_string()
1130 ).encrypt (signer, target, formulation);
1135 list<shared_ptr<Screen> > screens,
1136 boost::filesystem::path dcp,
1137 dcp::LocalTime from,
1138 dcp::LocalTime until,
1139 dcp::Formulation formulation
1142 list<ScreenKDM> kdms;
1144 BOOST_FOREACH (shared_ptr<Screen> i, screens) {
1145 if (i->certificate) {
1146 kdms.push_back (ScreenKDM (i, make_kdm (i->certificate.get(), dcp, from, until, formulation)));
1153 /** @return The approximate disk space required to encode a DCP of this film with the
1154 * current settings, in bytes.
1157 Film::required_disk_space () const
1159 return uint64_t (j2k_bandwidth() / 8) * length().seconds();
1162 /** This method checks the disk that the Film is on and tries to decide whether or not
1163 * there will be enough space to make a DCP for it. If so, true is returned; if not,
1164 * false is returned and required and availabe are filled in with the amount of disk space
1165 * required and available respectively (in Gb).
1167 * Note: the decision made by this method isn't, of course, 100% reliable.
1170 Film::should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const
1172 /* Create a test file and see if we can hard-link it */
1173 boost::filesystem::path test = internal_video_asset_dir() / "test";
1174 boost::filesystem::path test2 = internal_video_asset_dir() / "test2";
1175 can_hard_link = true;
1176 FILE* f = fopen_boost (test, "w");
1179 boost::system::error_code ec;
1180 boost::filesystem::create_hard_link (test, test2, ec);
1182 can_hard_link = false;
1184 boost::filesystem::remove (test);
1185 boost::filesystem::remove (test2);
1188 boost::filesystem::space_info s = boost::filesystem::space (internal_video_asset_dir ());
1189 required = double (required_disk_space ()) / 1073741824.0f;
1190 if (!can_hard_link) {
1193 available = double (s.available) / 1073741824.0f;
1194 return (available - required) > 1;
1198 Film::subtitle_language () const
1200 set<string> languages;
1202 ContentList cl = content ();
1203 BOOST_FOREACH (shared_ptr<Content>& c, cl) {
1204 shared_ptr<SubtitleContent> sc = dynamic_pointer_cast<SubtitleContent> (c);
1206 languages.insert (sc->subtitle_language ());
1211 BOOST_FOREACH (string s, languages) {
1212 if (!all.empty ()) {
1222 /** Change the gains of the supplied AudioMapping to make it a default
1223 * for this film. The defaults are guessed based on what processor (if any)
1224 * is in use and the number of input channels.
1227 Film::make_audio_mapping_default (AudioMapping& mapping) const
1229 if (audio_processor ()) {
1230 audio_processor()->make_audio_mapping_default (mapping);
1232 mapping.make_zero ();
1233 if (mapping.input_channels() == 1) {
1234 /* Mono -> Centre */
1235 mapping.set (0, static_cast<int> (dcp::CENTRE), 1);
1238 for (int i = 0; i < min (mapping.input_channels(), mapping.output_channels()); ++i) {
1239 mapping.set (i, i, 1);
1245 /** @return The names of the channels that audio contents' outputs are passed into;
1246 * this is either the DCP or a AudioProcessor.
1249 Film::audio_output_names () const
1251 if (audio_processor ()) {
1252 return audio_processor()->input_names ();
1256 n.push_back (_("L"));
1257 n.push_back (_("R"));
1258 n.push_back (_("C"));
1259 n.push_back (_("Lfe"));
1260 n.push_back (_("Ls"));
1261 n.push_back (_("Rs"));
1262 n.push_back (_("HI"));
1263 n.push_back (_("VI"));
1264 n.push_back (_("Lc"));
1265 n.push_back (_("Rc"));
1266 n.push_back (_("BsL"));
1267 n.push_back (_("BsR"));
1269 return vector<string> (n.begin(), n.begin() + audio_channels ());
1273 Film::repeat_content (ContentList c, int n)
1275 _playlist->repeat (c, n);
1279 Film::remove_content (ContentList c)
1281 _playlist->remove (c);
1285 Film::audio_analysis_finished ()
1291 Film::reels () const
1293 list<DCPTimePeriod> p;
1294 p.push_back (DCPTimePeriod (DCPTime (), length ()));