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 "scp_dcp_job.h"
32 #include "exceptions.h"
33 #include "examine_content_job.h"
37 #include "dcp_content_type.h"
41 #include "safe_stringstream.h"
42 #include "environment_info.h"
43 #include "raw_convert.h"
44 #include "audio_processor.h"
45 #include "md5_digester.h"
46 #include <libcxml/cxml.h>
48 #include <dcp/signer.h>
50 #include <dcp/local_time.h>
51 #include <dcp/decrypted_kdm.h>
52 #include <libxml++/libxml++.h>
53 #include <boost/filesystem.hpp>
54 #include <boost/algorithm/string.hpp>
55 #include <boost/lexical_cast.hpp>
56 #include <boost/foreach.hpp>
80 using boost::shared_ptr;
81 using boost::weak_ptr;
82 using boost::dynamic_pointer_cast;
83 using boost::to_upper_copy;
84 using boost::ends_with;
85 using boost::starts_with;
86 using boost::optional;
87 using boost::is_any_of;
91 #define LOG_GENERAL(...) log()->log (String::compose (__VA_ARGS__), Log::TYPE_GENERAL);
92 #define LOG_GENERAL_NC(...) log()->log (__VA_ARGS__, Log::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
108 int const Film::current_state_version = 32;
110 /** Construct a Film object in a given directory.
112 * @param dir Film directory.
115 Film::Film (boost::filesystem::path dir, bool log)
116 : _playlist (new Playlist)
117 , _use_isdcf_name (true)
118 , _dcp_content_type (Config::instance()->default_dcp_content_type ())
119 , _container (Config::instance()->default_container ())
120 , _resolution (RESOLUTION_2K)
123 , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
124 , _isdcf_metadata (Config::instance()->default_isdcf_metadata ())
125 , _video_frame_rate (24)
126 , _audio_channels (6)
128 , _sequence_video (true)
130 , _burn_subtitles (false)
131 , _audio_processor (0)
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));
140 /* Make state.directory a complete path without ..s (where possible)
141 (Code swiped from Adam Bowen on stackoverflow)
144 boost::filesystem::path p (boost::filesystem::system_complete (dir));
145 boost::filesystem::path result;
146 for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
148 if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
151 result = result.parent_path ();
153 } else if (*i != ".") {
158 set_directory (result.make_preferred ());
160 _log.reset (new FileLog (file ("log")));
162 _log.reset (new NullLog);
165 _playlist->set_sequence_video (_sequence_video);
170 for (list<boost::signals2::connection>::const_iterator i = _job_connections.begin(); i != _job_connections.end(); ++i) {
176 Film::video_identifier () const
178 DCPOMATIC_ASSERT (container ());
181 s.imbue (std::locale::classic ());
183 s << container()->id()
184 << "_" << resolution_to_string (_resolution)
185 << "_" << _playlist->video_identifier()
186 << "_" << _video_frame_rate
187 << "_" << j2k_bandwidth();
201 if (_burn_subtitles) {
212 /** @return The file to write video frame info to */
213 boost::filesystem::path
214 Film::info_file () const
216 boost::filesystem::path p;
218 p /= video_identifier ();
222 boost::filesystem::path
223 Film::internal_video_asset_dir () const
225 return dir ("video");
228 boost::filesystem::path
229 Film::internal_video_asset_filename () const
231 return video_identifier() + ".mxf";
235 Film::filename_safe_name () const
237 string const n = name ();
239 for (size_t i = 0; i < n.length(); ++i) {
240 if (isalnum (n[i])) {
250 boost::filesystem::path
251 Film::audio_analysis_path (shared_ptr<const Playlist> playlist) const
253 boost::filesystem::path p = dir ("analysis");
255 MD5Digester digester;
256 BOOST_FOREACH (shared_ptr<Content> i, playlist->content ()) {
257 shared_ptr<AudioContent> ac = dynamic_pointer_cast<AudioContent> (i);
262 digester.add (ac->digest ());
263 digester.add (ac->audio_mapping().digest ());
264 digester.add (ac->audio_gain ());
267 if (audio_processor ()) {
268 digester.add (audio_processor()->id ());
271 p /= digester.get ();
275 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
279 set_isdcf_date_today ();
281 if (dcp_name().find ("/") != string::npos) {
282 throw BadSettingError (_("name"), _("cannot contain slashes"));
285 environment_info (log ());
287 ContentList cl = content ();
288 for (ContentList::const_iterator i = cl.begin(); i != cl.end(); ++i) {
289 LOG_GENERAL ("Content: %1", (*i)->technical_summary());
291 LOG_GENERAL ("DCP video rate %1 fps", video_frame_rate());
292 LOG_GENERAL ("%1 threads", Config::instance()->num_local_encoding_threads());
293 LOG_GENERAL ("J2K bandwidth %1", j2k_bandwidth());
295 if (container() == 0) {
296 throw MissingSettingError (_("container"));
299 if (content().empty()) {
300 throw StringError (_("You must add some content to the DCP before creating it"));
303 if (dcp_content_type() == 0) {
304 throw MissingSettingError (_("content type"));
307 if (name().empty()) {
308 throw MissingSettingError (_("name"));
311 JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
314 /** Start a job to send our DCP to the configured TMS */
316 Film::send_dcp_to_tms ()
318 shared_ptr<Job> j (new SCPDCPJob (shared_from_this()));
319 JobManager::instance()->add (j);
322 shared_ptr<xmlpp::Document>
323 Film::metadata () const
325 shared_ptr<xmlpp::Document> doc (new xmlpp::Document);
326 xmlpp::Element* root = doc->create_root_node ("Metadata");
328 root->add_child("Version")->add_child_text (raw_convert<string> (current_state_version));
329 root->add_child("Name")->add_child_text (_name);
330 root->add_child("UseISDCFName")->add_child_text (_use_isdcf_name ? "1" : "0");
332 if (_dcp_content_type) {
333 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->isdcf_name ());
337 root->add_child("Container")->add_child_text (_container->id ());
340 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
341 root->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
342 _isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
343 root->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
344 root->add_child("ISDCFDate")->add_child_text (boost::gregorian::to_iso_string (_isdcf_date));
345 root->add_child("AudioChannels")->add_child_text (raw_convert<string> (_audio_channels));
346 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
347 root->add_child("SequenceVideo")->add_child_text (_sequence_video ? "1" : "0");
348 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
349 root->add_child("BurnSubtitles")->add_child_text (_burn_subtitles ? "1" : "0");
350 root->add_child("Signed")->add_child_text (_signed ? "1" : "0");
351 root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
352 root->add_child("Key")->add_child_text (_key.hex ());
353 if (_audio_processor) {
354 root->add_child("AudioProcessor")->add_child_text (_audio_processor->id ());
356 _playlist->as_xml (root->add_child ("Playlist"));
361 /** Write state to our `metadata' file */
363 Film::write_metadata () const
365 boost::filesystem::create_directories (directory ());
366 shared_ptr<xmlpp::Document> doc = metadata ();
367 doc->write_to_file_formatted (file("metadata.xml").string ());
371 /** Read state from our metadata file.
372 * @return Notes about things that the user should know about, or empty.
375 Film::read_metadata ()
377 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
378 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!"));
381 cxml::Document f ("Metadata");
382 f.read_file (file ("metadata.xml"));
384 _state_version = f.number_child<int> ("Version");
385 if (_state_version > current_state_version) {
386 throw StringError (_("This film was created with a newer version of DCP-o-matic, and it cannot be loaded into this version. Sorry!"));
389 _name = f.string_child ("Name");
390 if (_state_version >= 9) {
391 _use_isdcf_name = f.bool_child ("UseISDCFName");
392 _isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
393 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("ISDCFDate"));
395 _use_isdcf_name = f.bool_child ("UseDCIName");
396 _isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
397 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
401 optional<string> c = f.optional_string_child ("DCPContentType");
403 _dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
408 optional<string> c = f.optional_string_child ("Container");
410 _container = Ratio::from_id (c.get ());
414 _resolution = string_to_resolution (f.string_child ("Resolution"));
415 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
416 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
417 _signed = f.optional_bool_child("Signed").get_value_or (true);
418 _encrypted = f.bool_child ("Encrypted");
419 _audio_channels = f.number_child<int> ("AudioChannels");
420 /* We used to allow odd numbers (and zero) channels, but it's just not worth
423 if (_audio_channels == 0) {
425 } else if ((_audio_channels % 2) == 1) {
428 _sequence_video = f.bool_child ("SequenceVideo");
429 _three_d = f.bool_child ("ThreeD");
430 _interop = f.bool_child ("Interop");
431 if (_state_version >= 32) {
432 _burn_subtitles = f.bool_child ("BurnSubtitles");
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;
443 /* This method is the only one that can return notes (so far) */
444 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
446 /* Write backtraces to this film's directory, until another film is loaded */
447 set_backtrace_file (file ("backtrace.txt"));
453 /** Given a directory name, return its full path within the Film's directory.
454 * The directory (and its parents) will be created if they do not exist.
456 boost::filesystem::path
457 Film::dir (boost::filesystem::path d) const
459 boost::filesystem::path p;
463 boost::filesystem::create_directories (p);
468 /** Given a file or directory name, return its full path within the Film's directory.
469 * Any required parent directories will be created.
471 boost::filesystem::path
472 Film::file (boost::filesystem::path f) const
474 boost::filesystem::path p;
478 boost::filesystem::create_directories (p.parent_path ());
483 /** @return a ISDCF-compliant name for a DCP of this film */
485 Film::isdcf_name (bool if_created_now) const
489 string raw_name = name ();
491 /* Split the raw name up into words */
492 vector<string> words;
493 split (words, raw_name, is_any_of (" "));
497 /* Add each word to fixed_name */
498 for (vector<string>::const_iterator i = words.begin(); i != words.end(); ++i) {
501 /* First letter is always capitalised */
502 w[0] = toupper (w[0]);
504 /* Count caps in w */
506 for (size_t i = 0; i < w.size(); ++i) {
507 if (isupper (w[i])) {
512 /* If w is all caps make the rest of it lower case, otherwise
515 if (caps == w.size ()) {
516 for (size_t i = 1; i < w.size(); ++i) {
517 w[i] = tolower (w[i]);
521 for (size_t i = 0; i < w.size(); ++i) {
526 if (fixed_name.length() > 14) {
527 fixed_name = fixed_name.substr (0, 14);
532 if (dcp_content_type()) {
533 d << "_" << dcp_content_type()->isdcf_name();
534 d << "-" << isdcf_metadata().content_version;
537 ISDCFMetadata const dm = isdcf_metadata ();
539 if (dm.temp_version) {
543 if (dm.pre_release) {
551 if (!dm.chain.empty ()) {
552 d << "-" << dm.chain;
559 if (dm.two_d_version_of_three_d) {
563 if (!dm.mastered_luminance.empty ()) {
564 d << "-" << dm.mastered_luminance;
567 if (video_frame_rate() != 24) {
568 d << "-" << video_frame_rate();
572 d << "_" << container()->isdcf_name();
575 ContentList cl = content ();
577 /* XXX: this uses the first bit of content only */
579 /* The standard says we don't do this for trailers, for some strange reason */
580 if (dcp_content_type() && dcp_content_type()->libdcp_kind() != dcp::TRAILER) {
581 Ratio const * content_ratio = 0;
582 for (ContentList::iterator i = cl.begin(); i != cl.end(); ++i) {
583 shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (*i);
585 /* Here's the first piece of video content */
586 if (vc->scale().ratio ()) {
587 content_ratio = vc->scale().ratio ();
589 content_ratio = Ratio::from_ratio (vc->video_size().ratio ());
595 if (content_ratio && content_ratio != container()) {
596 d << "-" << content_ratio->isdcf_name();
600 if (!dm.audio_language.empty ()) {
601 d << "_" << dm.audio_language;
602 if (!dm.subtitle_language.empty()) {
603 d << "-" << dm.subtitle_language;
609 if (!dm.territory.empty ()) {
610 d << "_" << dm.territory;
611 if (!dm.rating.empty ()) {
612 d << "-" << dm.rating;
616 /* Find all mapped channels */
619 for (ContentList::const_iterator i = cl.begin(); i != cl.end(); ++i) {
620 shared_ptr<const AudioContent> ac = dynamic_pointer_cast<const AudioContent> (*i);
622 list<int> c = ac->audio_mapping().mapped_output_channels ();
623 copy (c.begin(), c.end(), back_inserter (mapped));
634 for (list<int>::const_iterator i = mapped.begin(); i != mapped.end(); ++i) {
635 if (*i >= audio_channels()) {
636 /* This channel is mapped but is not included in the DCP */
640 if (static_cast<dcp::Channel> (*i) == dcp::LFE) {
648 d << "_" << non_lfe << lfe;
653 d << "_" << resolution_to_string (_resolution);
655 if (!dm.studio.empty ()) {
656 d << "_" << dm.studio;
659 if (if_created_now) {
660 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
662 d << "_" << boost::gregorian::to_iso_string (_isdcf_date);
665 if (!dm.facility.empty ()) {
666 d << "_" << dm.facility;
679 if (!dm.package_type.empty ()) {
680 d << "_" << dm.package_type;
686 /** @return name to give the DCP */
688 Film::dcp_name (bool if_created_now) const
691 if (use_isdcf_name()) {
692 unfiltered = isdcf_name (if_created_now);
694 unfiltered = name ();
697 /* Filter out `bad' characters which cause problems with some systems.
698 There's no apparent list of what really is allowed, so this is a guess.
702 string const allowed = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-_";
703 for (size_t i = 0; i < unfiltered.size(); ++i) {
704 if (allowed.find (unfiltered[i]) != string::npos) {
705 filtered += unfiltered[i];
713 Film::set_directory (boost::filesystem::path d)
720 Film::set_name (string n)
723 signal_changed (NAME);
727 Film::set_use_isdcf_name (bool u)
730 signal_changed (USE_ISDCF_NAME);
734 Film::set_dcp_content_type (DCPContentType const * t)
736 _dcp_content_type = t;
737 signal_changed (DCP_CONTENT_TYPE);
741 Film::set_container (Ratio const * c)
744 signal_changed (CONTAINER);
748 Film::set_resolution (Resolution r)
751 signal_changed (RESOLUTION);
755 Film::set_j2k_bandwidth (int b)
758 signal_changed (J2K_BANDWIDTH);
762 Film::set_isdcf_metadata (ISDCFMetadata m)
765 signal_changed (ISDCF_METADATA);
769 Film::set_video_frame_rate (int f)
771 _video_frame_rate = f;
772 signal_changed (VIDEO_FRAME_RATE);
776 Film::set_audio_channels (int c)
779 signal_changed (AUDIO_CHANNELS);
783 Film::set_three_d (bool t)
786 signal_changed (THREE_D);
790 Film::set_interop (bool i)
793 signal_changed (INTEROP);
797 Film::set_burn_subtitles (bool b)
800 signal_changed (BURN_SUBTITLES);
804 Film::set_audio_processor (AudioProcessor const * processor)
806 _audio_processor = processor;
807 signal_changed (AUDIO_PROCESSOR);
811 Film::signal_changed (Property p)
817 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
819 case Film::VIDEO_FRAME_RATE:
820 case Film::SEQUENCE_VIDEO:
821 _playlist->maybe_sequence_video ();
827 emit (boost::bind (boost::ref (Changed), p));
831 Film::set_isdcf_date_today ()
833 _isdcf_date = boost::gregorian::day_clock::local_day ();
836 boost::filesystem::path
837 Film::j2c_path (int f, Eyes e, bool t) const
839 boost::filesystem::path p;
841 p /= video_identifier ();
845 s << setfill('0') << f;
847 if (e == EYES_LEFT) {
849 } else if (e == EYES_RIGHT) {
863 /** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs */
867 vector<CPLSummary> out;
869 boost::filesystem::path const dir = directory ();
870 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
872 boost::filesystem::is_directory (*i) &&
873 i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
881 i->path().leaf().string(),
882 dcp.cpls().front()->id(),
883 dcp.cpls().front()->annotation_text(),
884 dcp.cpls().front()->file()
897 Film::make_player () const
899 return shared_ptr<Player> (new Player (shared_from_this (), _playlist));
903 Film::set_signed (bool s)
906 signal_changed (SIGNED);
910 Film::set_encrypted (bool e)
913 signal_changed (ENCRYPTED);
917 Film::set_key (dcp::Key key)
920 signal_changed (KEY);
924 Film::playlist () const
930 Film::content () const
932 return _playlist->content ();
936 Film::examine_content (shared_ptr<Content> c)
938 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
939 JobManager::instance()->add (j);
943 Film::examine_and_add_content (shared_ptr<Content> c)
945 if (dynamic_pointer_cast<FFmpegContent> (c)) {
946 run_ffprobe (c->path(0), file ("ffprobe.log"), _log);
949 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
951 _job_connections.push_back (
952 j->Finished.connect (bind (&Film::maybe_add_content, this, boost::weak_ptr<Job> (j), boost::weak_ptr<Content> (c)))
955 JobManager::instance()->add (j);
959 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
961 shared_ptr<Job> job = j.lock ();
962 if (!job || !job->finished_ok ()) {
966 shared_ptr<Content> content = c.lock ();
968 add_content (content);
973 Film::add_content (shared_ptr<Content> c)
975 /* Add video content after any existing content */
976 if (dynamic_pointer_cast<VideoContent> (c)) {
977 c->set_position (_playlist->video_end ());
984 Film::remove_content (shared_ptr<Content> c)
986 _playlist->remove (c);
990 Film::move_content_earlier (shared_ptr<Content> c)
992 _playlist->move_earlier (c);
996 Film::move_content_later (shared_ptr<Content> c)
998 _playlist->move_later (c);
1002 Film::length () const
1004 return _playlist->length ();
1008 Film::best_video_frame_rate () const
1010 return _playlist->best_dcp_frame_rate ();
1014 Film::active_frame_rate_change (DCPTime t) const
1016 return _playlist->active_frame_rate_change (t, video_frame_rate ());
1020 Film::playlist_content_changed (boost::weak_ptr<Content> c, int p)
1022 if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
1023 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
1024 } else if (p == AudioContentProperty::AUDIO_STREAMS) {
1025 signal_changed (NAME);
1028 emit (boost::bind (boost::ref (ContentChanged), c, p));
1032 Film::playlist_changed ()
1034 signal_changed (CONTENT);
1035 signal_changed (NAME);
1039 Film::audio_frame_rate () const
1046 Film::set_sequence_video (bool s)
1048 _sequence_video = s;
1049 _playlist->set_sequence_video (s);
1050 signal_changed (SEQUENCE_VIDEO);
1053 /** @return Size of the largest possible image in whatever resolution we are using */
1055 Film::full_frame () const
1057 switch (_resolution) {
1059 return dcp::Size (2048, 1080);
1061 return dcp::Size (4096, 2160);
1064 DCPOMATIC_ASSERT (false);
1065 return dcp::Size ();
1068 /** @return Size of the frame */
1070 Film::frame_size () const
1072 return fit_ratio_within (container()->ratio(), full_frame ());
1077 dcp::Certificate target,
1078 boost::filesystem::path cpl_file,
1079 dcp::LocalTime from,
1080 dcp::LocalTime until,
1081 dcp::Formulation formulation
1084 shared_ptr<const dcp::CPL> cpl (new dcp::CPL (cpl_file));
1085 shared_ptr<const dcp::Signer> signer = Config::instance()->signer();
1086 if (!signer->valid ()) {
1087 throw InvalidSignerError ();
1090 return dcp::DecryptedKDM (
1091 cpl, key(), from, until, "DCP-o-matic", cpl->content_title_text(), dcp::LocalTime().as_string()
1092 ).encrypt (signer, target, formulation);
1095 list<dcp::EncryptedKDM>
1097 list<shared_ptr<Screen> > screens,
1098 boost::filesystem::path dcp,
1099 dcp::LocalTime from,
1100 dcp::LocalTime until,
1101 dcp::Formulation formulation
1104 list<dcp::EncryptedKDM> kdms;
1106 for (list<shared_ptr<Screen> >::iterator i = screens.begin(); i != screens.end(); ++i) {
1107 if ((*i)->certificate) {
1108 kdms.push_back (make_kdm ((*i)->certificate.get(), dcp, from, until, formulation));
1115 /** @return The approximate disk space required to encode a DCP of this film with the
1116 * current settings, in bytes.
1119 Film::required_disk_space () const
1121 return uint64_t (j2k_bandwidth() / 8) * length().seconds();
1124 /** This method checks the disk that the Film is on and tries to decide whether or not
1125 * there will be enough space to make a DCP for it. If so, true is returned; if not,
1126 * false is returned and required and availabe are filled in with the amount of disk space
1127 * required and available respectively (in Gb).
1129 * Note: the decision made by this method isn't, of course, 100% reliable.
1132 Film::should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const
1134 /* Create a test file and see if we can hard-link it */
1135 boost::filesystem::path test = internal_video_asset_dir() / "test";
1136 boost::filesystem::path test2 = internal_video_asset_dir() / "test2";
1137 can_hard_link = true;
1138 FILE* f = fopen_boost (test, "w");
1141 boost::system::error_code ec;
1142 boost::filesystem::create_hard_link (test, test2, ec);
1144 can_hard_link = false;
1146 boost::filesystem::remove (test);
1147 boost::filesystem::remove (test2);
1150 boost::filesystem::space_info s = boost::filesystem::space (internal_video_asset_dir ());
1151 required = double (required_disk_space ()) / 1073741824.0f;
1152 if (!can_hard_link) {
1155 available = double (s.available) / 1073741824.0f;
1156 return (available - required) > 1;
1160 Film::subtitle_language () const
1162 set<string> languages;
1164 ContentList cl = content ();
1165 BOOST_FOREACH (shared_ptr<Content>& c, cl) {
1166 shared_ptr<SubtitleContent> sc = dynamic_pointer_cast<SubtitleContent> (c);
1168 languages.insert (sc->subtitle_language ());
1173 BOOST_FOREACH (string s, languages) {
1174 if (!all.empty ()) {
1184 /** Change the gains of the supplied AudioMapping to make it a default
1185 * for this film. The defaults are guessed based on what processor (if any)
1186 * is in use and the number of input channels.
1189 Film::make_audio_mapping_default (AudioMapping& mapping) const
1191 if (audio_processor ()) {
1192 audio_processor()->make_audio_mapping_default (mapping);
1194 mapping.make_zero ();
1195 if (mapping.input_channels() == 1) {
1196 /* Mono -> Centre */
1197 mapping.set (0, static_cast<int> (dcp::CENTRE), 1);
1200 for (int i = 0; i < min (mapping.input_channels(), mapping.output_channels()); ++i) {
1201 mapping.set (i, i, 1);
1207 /** @return The names of the channels that audio contents' outputs are passed into;
1208 * this is either the DCP or a AudioProcessor.
1211 Film::audio_output_names () const
1213 if (audio_processor ()) {
1214 return audio_processor()->input_names ();
1218 n.push_back (_("L"));
1219 n.push_back (_("R"));
1220 n.push_back (_("C"));
1221 n.push_back (_("Lfe"));
1222 n.push_back (_("Ls"));
1223 n.push_back (_("Rs"));
1224 n.push_back (_("HI"));
1225 n.push_back (_("VI"));
1226 n.push_back (_("Lc"));
1227 n.push_back (_("Rc"));
1228 n.push_back (_("BsL"));
1229 n.push_back (_("BsR"));
1231 return vector<string> (n.begin(), n.begin() + audio_channels ());