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>
81 using boost::shared_ptr;
82 using boost::weak_ptr;
83 using boost::dynamic_pointer_cast;
84 using boost::to_upper_copy;
85 using boost::ends_with;
86 using boost::starts_with;
87 using boost::optional;
88 using boost::is_any_of;
92 #define LOG_GENERAL(...) log()->log (String::compose (__VA_ARGS__), Log::TYPE_GENERAL);
93 #define LOG_GENERAL_NC(...) log()->log (__VA_ARGS__, Log::TYPE_GENERAL);
96 * AudioMapping XML changed.
98 * Subtitle offset changed to subtitle y offset, and subtitle x offset added.
100 * Use <Scale> tag in <VideoContent> rather than <Ratio>.
104 * Subtitle X and Y scale.
106 * Bumped to 32 for 2.0 branch; some times are expressed in Times rather
109 int const Film::current_state_version = 32;
111 /** Construct a Film object in a given directory.
113 * @param dir Film directory.
116 Film::Film (boost::filesystem::path dir, bool log)
117 : _playlist (new Playlist)
118 , _use_isdcf_name (true)
119 , _dcp_content_type (Config::instance()->default_dcp_content_type ())
120 , _container (Config::instance()->default_container ())
121 , _resolution (RESOLUTION_2K)
124 , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
125 , _isdcf_metadata (Config::instance()->default_isdcf_metadata ())
126 , _video_frame_rate (24)
127 , _audio_channels (6)
129 , _sequence_video (true)
131 , _burn_subtitles (false)
132 , _audio_processor (0)
133 , _state_version (current_state_version)
136 set_isdcf_date_today ();
138 _playlist_changed_connection = _playlist->Changed.connect (bind (&Film::playlist_changed, this));
139 _playlist_content_changed_connection = _playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2));
141 /* Make state.directory a complete path without ..s (where possible)
142 (Code swiped from Adam Bowen on stackoverflow)
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 for (list<boost::signals2::connection>::const_iterator i = _job_connections.begin(); i != _job_connections.end(); ++i) {
177 Film::video_identifier () const
179 DCPOMATIC_ASSERT (container ());
182 s.imbue (std::locale::classic ());
184 s << container()->id()
185 << "_" << resolution_to_string (_resolution)
186 << "_" << _playlist->video_identifier()
187 << "_" << _video_frame_rate
188 << "_" << j2k_bandwidth();
202 if (_burn_subtitles) {
213 /** @return The file to write video frame info to */
214 boost::filesystem::path
215 Film::info_file () const
217 boost::filesystem::path p;
219 p /= video_identifier ();
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 () const
232 return video_identifier() + ".mxf";
236 Film::filename_safe_name () const
238 string const n = name ();
240 for (size_t i = 0; i < n.length(); ++i) {
241 if (isalnum (n[i])) {
251 boost::filesystem::path
252 Film::audio_analysis_path (shared_ptr<const Playlist> playlist) const
254 boost::filesystem::path p = dir ("analysis");
256 MD5Digester digester;
257 BOOST_FOREACH (shared_ptr<Content> i, playlist->content ()) {
258 shared_ptr<AudioContent> ac = dynamic_pointer_cast<AudioContent> (i);
263 digester.add (ac->digest ());
264 digester.add (ac->audio_mapping().digest ());
265 digester.add (ac->audio_gain ());
268 if (audio_processor ()) {
269 digester.add (audio_processor()->id ());
272 p /= digester.get ();
276 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
280 set_isdcf_date_today ();
282 if (dcp_name().find ("/") != string::npos) {
283 throw BadSettingError (_("name"), _("cannot contain slashes"));
286 environment_info (log ());
288 ContentList cl = content ();
289 for (ContentList::const_iterator i = cl.begin(); i != cl.end(); ++i) {
290 LOG_GENERAL ("Content: %1", (*i)->technical_summary());
292 LOG_GENERAL ("DCP video rate %1 fps", video_frame_rate());
293 LOG_GENERAL ("%1 threads", Config::instance()->num_local_encoding_threads());
294 LOG_GENERAL ("J2K bandwidth %1", j2k_bandwidth());
296 if (container() == 0) {
297 throw MissingSettingError (_("container"));
300 if (content().empty()) {
301 throw StringError (_("You must add some content to the DCP before creating it"));
304 if (dcp_content_type() == 0) {
305 throw MissingSettingError (_("content type"));
308 if (name().empty()) {
309 throw MissingSettingError (_("name"));
312 JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
315 /** Start a job to send our DCP to the configured TMS */
317 Film::send_dcp_to_tms ()
319 shared_ptr<Job> j (new SCPDCPJob (shared_from_this()));
320 JobManager::instance()->add (j);
323 shared_ptr<xmlpp::Document>
324 Film::metadata () const
326 shared_ptr<xmlpp::Document> doc (new xmlpp::Document);
327 xmlpp::Element* root = doc->create_root_node ("Metadata");
329 root->add_child("Version")->add_child_text (raw_convert<string> (current_state_version));
330 root->add_child("Name")->add_child_text (_name);
331 root->add_child("UseISDCFName")->add_child_text (_use_isdcf_name ? "1" : "0");
333 if (_dcp_content_type) {
334 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->isdcf_name ());
338 root->add_child("Container")->add_child_text (_container->id ());
341 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
342 root->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
343 _isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
344 root->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
345 root->add_child("ISDCFDate")->add_child_text (boost::gregorian::to_iso_string (_isdcf_date));
346 root->add_child("AudioChannels")->add_child_text (raw_convert<string> (_audio_channels));
347 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
348 root->add_child("SequenceVideo")->add_child_text (_sequence_video ? "1" : "0");
349 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
350 root->add_child("BurnSubtitles")->add_child_text (_burn_subtitles ? "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 _playlist->as_xml (root->add_child ("Playlist"));
362 /** Write state to our `metadata' file */
364 Film::write_metadata () const
366 boost::filesystem::create_directories (directory ());
367 shared_ptr<xmlpp::Document> doc = metadata ();
368 doc->write_to_file_formatted (file("metadata.xml").string ());
372 /** Read state from our metadata file.
373 * @return Notes about things that the user should know about, or empty.
376 Film::read_metadata ()
378 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
379 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!"));
382 cxml::Document f ("Metadata");
383 f.read_file (file ("metadata.xml"));
385 _state_version = f.number_child<int> ("Version");
386 if (_state_version > current_state_version) {
387 throw StringError (_("This film was created with a newer version of DCP-o-matic, and it cannot be loaded into this version. Sorry!"));
390 _name = f.string_child ("Name");
391 if (_state_version >= 9) {
392 _use_isdcf_name = f.bool_child ("UseISDCFName");
393 _isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
394 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("ISDCFDate"));
396 _use_isdcf_name = f.bool_child ("UseDCIName");
397 _isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
398 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
402 optional<string> c = f.optional_string_child ("DCPContentType");
404 _dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
409 optional<string> c = f.optional_string_child ("Container");
411 _container = Ratio::from_id (c.get ());
415 _resolution = string_to_resolution (f.string_child ("Resolution"));
416 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
417 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
418 _signed = f.optional_bool_child("Signed").get_value_or (true);
419 _encrypted = f.bool_child ("Encrypted");
420 _audio_channels = f.number_child<int> ("AudioChannels");
421 /* We used to allow odd numbers (and zero) channels, but it's just not worth
424 if (_audio_channels == 0) {
426 } else if ((_audio_channels % 2) == 1) {
429 _sequence_video = f.bool_child ("SequenceVideo");
430 _three_d = f.bool_child ("ThreeD");
431 _interop = f.bool_child ("Interop");
432 if (_state_version >= 32) {
433 _burn_subtitles = f.bool_child ("BurnSubtitles");
435 _key = dcp::Key (f.string_child ("Key"));
437 if (f.optional_string_child ("AudioProcessor")) {
438 _audio_processor = AudioProcessor::from_id (f.string_child ("AudioProcessor"));
440 _audio_processor = 0;
444 /* This method is the only one that can return notes (so far) */
445 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
447 /* Write backtraces to this film's directory, until another film is loaded */
448 set_backtrace_file (file ("backtrace.txt"));
454 /** Given a directory name, return its full path within the Film's directory.
455 * The directory (and its parents) will be created if they do not exist.
457 boost::filesystem::path
458 Film::dir (boost::filesystem::path d) const
460 boost::filesystem::path p;
464 boost::filesystem::create_directories (p);
469 /** Given a file or directory name, return its full path within the Film's directory.
470 * Any required parent directories will be created.
472 boost::filesystem::path
473 Film::file (boost::filesystem::path f) const
475 boost::filesystem::path p;
479 boost::filesystem::create_directories (p.parent_path ());
484 /** @return a ISDCF-compliant name for a DCP of this film */
486 Film::isdcf_name (bool if_created_now) const
490 string raw_name = name ();
492 /* Split the raw name up into words */
493 vector<string> words;
494 split (words, raw_name, is_any_of (" "));
498 /* Add each word to fixed_name */
499 for (vector<string>::const_iterator i = words.begin(); i != words.end(); ++i) {
502 /* First letter is always capitalised */
503 w[0] = toupper (w[0]);
505 /* Count caps in w */
507 for (size_t i = 0; i < w.size(); ++i) {
508 if (isupper (w[i])) {
513 /* If w is all caps make the rest of it lower case, otherwise
516 if (caps == w.size ()) {
517 for (size_t i = 1; i < w.size(); ++i) {
518 w[i] = tolower (w[i]);
522 for (size_t i = 0; i < w.size(); ++i) {
527 if (fixed_name.length() > 14) {
528 fixed_name = fixed_name.substr (0, 14);
533 if (dcp_content_type()) {
534 d << "_" << dcp_content_type()->isdcf_name();
535 d << "-" << isdcf_metadata().content_version;
538 ISDCFMetadata const dm = isdcf_metadata ();
540 if (dm.temp_version) {
544 if (dm.pre_release) {
552 if (!dm.chain.empty ()) {
553 d << "-" << dm.chain;
560 if (dm.two_d_version_of_three_d) {
564 if (!dm.mastered_luminance.empty ()) {
565 d << "-" << dm.mastered_luminance;
568 if (video_frame_rate() != 24) {
569 d << "-" << video_frame_rate();
573 d << "_" << container()->isdcf_name();
576 ContentList cl = content ();
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 for (ContentList::iterator i = cl.begin(); i != cl.end(); ++i) {
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()) {
604 d << "-" << dm.subtitle_language;
610 if (!dm.territory.empty ()) {
611 d << "_" << dm.territory;
612 if (!dm.rating.empty ()) {
613 d << "-" << dm.rating;
617 /* Find all mapped channels */
620 for (ContentList::const_iterator i = cl.begin(); i != cl.end(); ++i) {
621 shared_ptr<const AudioContent> ac = dynamic_pointer_cast<const AudioContent> (*i);
623 list<int> c = ac->audio_mapping().mapped_output_channels ();
624 copy (c.begin(), c.end(), back_inserter (mapped));
635 for (list<int>::const_iterator i = mapped.begin(); i != mapped.end(); ++i) {
636 if (*i >= audio_channels()) {
637 /* This channel is mapped but is not included in the DCP */
641 if (static_cast<dcp::Channel> (*i) == dcp::LFE) {
649 d << "_" << non_lfe << lfe;
654 d << "_" << resolution_to_string (_resolution);
656 if (!dm.studio.empty ()) {
657 d << "_" << dm.studio;
660 if (if_created_now) {
661 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
663 d << "_" << boost::gregorian::to_iso_string (_isdcf_date);
666 if (!dm.facility.empty ()) {
667 d << "_" << dm.facility;
680 if (!dm.package_type.empty ()) {
681 d << "_" << dm.package_type;
687 /** @return name to give the DCP */
689 Film::dcp_name (bool if_created_now) const
692 if (use_isdcf_name()) {
693 unfiltered = isdcf_name (if_created_now);
695 unfiltered = name ();
698 /* Filter out `bad' characters which cause problems with some systems.
699 There's no apparent list of what really is allowed, so this is a guess.
703 string const allowed = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-_";
704 for (size_t i = 0; i < unfiltered.size(); ++i) {
705 if (allowed.find (unfiltered[i]) != string::npos) {
706 filtered += unfiltered[i];
714 Film::set_directory (boost::filesystem::path d)
721 Film::set_name (string n)
724 signal_changed (NAME);
728 Film::set_use_isdcf_name (bool u)
731 signal_changed (USE_ISDCF_NAME);
735 Film::set_dcp_content_type (DCPContentType const * t)
737 _dcp_content_type = t;
738 signal_changed (DCP_CONTENT_TYPE);
742 Film::set_container (Ratio const * c)
745 signal_changed (CONTAINER);
749 Film::set_resolution (Resolution r)
752 signal_changed (RESOLUTION);
756 Film::set_j2k_bandwidth (int b)
759 signal_changed (J2K_BANDWIDTH);
763 Film::set_isdcf_metadata (ISDCFMetadata m)
766 signal_changed (ISDCF_METADATA);
770 Film::set_video_frame_rate (int f)
772 _video_frame_rate = f;
773 signal_changed (VIDEO_FRAME_RATE);
777 Film::set_audio_channels (int c)
780 signal_changed (AUDIO_CHANNELS);
784 Film::set_three_d (bool t)
787 signal_changed (THREE_D);
791 Film::set_interop (bool i)
794 signal_changed (INTEROP);
798 Film::set_burn_subtitles (bool b)
801 signal_changed (BURN_SUBTITLES);
805 Film::set_audio_processor (AudioProcessor const * processor)
807 _audio_processor = processor;
808 signal_changed (AUDIO_PROCESSOR);
809 signal_changed (AUDIO_CHANNELS);
813 Film::signal_changed (Property p)
819 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
821 case Film::VIDEO_FRAME_RATE:
822 case Film::SEQUENCE_VIDEO:
823 _playlist->maybe_sequence_video ();
829 emit (boost::bind (boost::ref (Changed), p));
833 Film::set_isdcf_date_today ()
835 _isdcf_date = boost::gregorian::day_clock::local_day ();
838 boost::filesystem::path
839 Film::j2c_path (int f, Eyes e, bool t) const
841 boost::filesystem::path p;
843 p /= video_identifier ();
847 s << setfill('0') << f;
849 if (e == EYES_LEFT) {
851 } else if (e == EYES_RIGHT) {
865 /** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs */
869 vector<CPLSummary> out;
871 boost::filesystem::path const dir = directory ();
872 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
874 boost::filesystem::is_directory (*i) &&
875 i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
883 i->path().leaf().string(),
884 dcp.cpls().front()->id(),
885 dcp.cpls().front()->annotation_text(),
886 dcp.cpls().front()->file()
899 Film::make_player () const
901 return shared_ptr<Player> (new Player (shared_from_this (), _playlist));
905 Film::set_signed (bool s)
908 signal_changed (SIGNED);
912 Film::set_encrypted (bool e)
915 signal_changed (ENCRYPTED);
919 Film::set_key (dcp::Key key)
922 signal_changed (KEY);
926 Film::playlist () const
932 Film::content () const
934 return _playlist->content ();
938 Film::examine_content (shared_ptr<Content> c)
940 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
941 JobManager::instance()->add (j);
945 Film::examine_and_add_content (shared_ptr<Content> c)
947 if (dynamic_pointer_cast<FFmpegContent> (c)) {
948 run_ffprobe (c->path(0), file ("ffprobe.log"), _log);
951 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
953 _job_connections.push_back (
954 j->Finished.connect (bind (&Film::maybe_add_content, this, boost::weak_ptr<Job> (j), boost::weak_ptr<Content> (c)))
957 JobManager::instance()->add (j);
961 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
963 shared_ptr<Job> job = j.lock ();
964 if (!job || !job->finished_ok ()) {
968 shared_ptr<Content> content = c.lock ();
970 add_content (content);
975 Film::add_content (shared_ptr<Content> c)
977 /* Add video content after any existing content */
978 if (dynamic_pointer_cast<VideoContent> (c)) {
979 c->set_position (_playlist->video_end ());
986 Film::remove_content (shared_ptr<Content> c)
988 _playlist->remove (c);
992 Film::move_content_earlier (shared_ptr<Content> c)
994 _playlist->move_earlier (c);
998 Film::move_content_later (shared_ptr<Content> c)
1000 _playlist->move_later (c);
1004 Film::length () const
1006 return _playlist->length ();
1010 Film::best_video_frame_rate () const
1012 return _playlist->best_dcp_frame_rate ();
1016 Film::active_frame_rate_change (DCPTime t) const
1018 return _playlist->active_frame_rate_change (t, video_frame_rate ());
1022 Film::playlist_content_changed (boost::weak_ptr<Content> c, int p)
1024 if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
1025 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
1026 } else if (p == AudioContentProperty::AUDIO_STREAMS) {
1027 signal_changed (NAME);
1030 emit (boost::bind (boost::ref (ContentChanged), c, p));
1034 Film::playlist_changed ()
1036 signal_changed (CONTENT);
1037 signal_changed (NAME);
1041 Film::audio_frame_rate () const
1048 Film::set_sequence_video (bool s)
1050 _sequence_video = s;
1051 _playlist->set_sequence_video (s);
1052 signal_changed (SEQUENCE_VIDEO);
1055 /** @return Size of the largest possible image in whatever resolution we are using */
1057 Film::full_frame () const
1059 switch (_resolution) {
1061 return dcp::Size (2048, 1080);
1063 return dcp::Size (4096, 2160);
1066 DCPOMATIC_ASSERT (false);
1067 return dcp::Size ();
1070 /** @return Size of the frame */
1072 Film::frame_size () const
1074 return fit_ratio_within (container()->ratio(), full_frame ());
1079 dcp::Certificate target,
1080 boost::filesystem::path cpl_file,
1081 dcp::LocalTime from,
1082 dcp::LocalTime until,
1083 dcp::Formulation formulation
1086 shared_ptr<const dcp::CPL> cpl (new dcp::CPL (cpl_file));
1087 shared_ptr<const dcp::Signer> signer = Config::instance()->signer();
1088 if (!signer->valid ()) {
1089 throw InvalidSignerError ();
1092 return dcp::DecryptedKDM (
1093 cpl, key(), from, until, "DCP-o-matic", cpl->content_title_text(), dcp::LocalTime().as_string()
1094 ).encrypt (signer, target, formulation);
1097 list<dcp::EncryptedKDM>
1099 list<shared_ptr<Screen> > screens,
1100 boost::filesystem::path dcp,
1101 dcp::LocalTime from,
1102 dcp::LocalTime until,
1103 dcp::Formulation formulation
1106 list<dcp::EncryptedKDM> kdms;
1108 for (list<shared_ptr<Screen> >::iterator i = screens.begin(); i != screens.end(); ++i) {
1109 if ((*i)->certificate) {
1110 kdms.push_back (make_kdm ((*i)->certificate.get(), dcp, from, until, formulation));
1117 /** @return The approximate disk space required to encode a DCP of this film with the
1118 * current settings, in bytes.
1121 Film::required_disk_space () const
1123 return uint64_t (j2k_bandwidth() / 8) * length().seconds();
1126 /** This method checks the disk that the Film is on and tries to decide whether or not
1127 * there will be enough space to make a DCP for it. If so, true is returned; if not,
1128 * false is returned and required and availabe are filled in with the amount of disk space
1129 * required and available respectively (in Gb).
1131 * Note: the decision made by this method isn't, of course, 100% reliable.
1134 Film::should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const
1136 /* Create a test file and see if we can hard-link it */
1137 boost::filesystem::path test = internal_video_asset_dir() / "test";
1138 boost::filesystem::path test2 = internal_video_asset_dir() / "test2";
1139 can_hard_link = true;
1140 FILE* f = fopen_boost (test, "w");
1143 boost::system::error_code ec;
1144 boost::filesystem::create_hard_link (test, test2, ec);
1146 can_hard_link = false;
1148 boost::filesystem::remove (test);
1149 boost::filesystem::remove (test2);
1152 boost::filesystem::space_info s = boost::filesystem::space (internal_video_asset_dir ());
1153 required = double (required_disk_space ()) / 1073741824.0f;
1154 if (!can_hard_link) {
1157 available = double (s.available) / 1073741824.0f;
1158 return (available - required) > 1;
1162 Film::subtitle_language () const
1164 set<string> languages;
1166 ContentList cl = content ();
1167 BOOST_FOREACH (shared_ptr<Content>& c, cl) {
1168 shared_ptr<SubtitleContent> sc = dynamic_pointer_cast<SubtitleContent> (c);
1170 languages.insert (sc->subtitle_language ());
1175 BOOST_FOREACH (string s, languages) {
1176 if (!all.empty ()) {
1186 /** Change the gains of the supplied AudioMapping to make it a default
1187 * for this film. The defaults are guessed based on what processor (if any)
1188 * is in use and the number of input channels.
1191 Film::make_audio_mapping_default (AudioMapping& mapping) const
1193 if (audio_processor ()) {
1194 audio_processor()->make_audio_mapping_default (mapping);
1196 mapping.make_zero ();
1197 if (mapping.input_channels() == 1) {
1198 /* Mono -> Centre */
1199 mapping.set (0, static_cast<int> (dcp::CENTRE), 1);
1202 for (int i = 0; i < min (mapping.input_channels(), mapping.output_channels()); ++i) {
1203 mapping.set (i, i, 1);
1209 /** @return The names of the channels that audio contents' outputs are passed into;
1210 * this is either the DCP or a AudioProcessor.
1213 Film::audio_output_names () const
1215 if (audio_processor ()) {
1216 return audio_processor()->input_names ();
1220 n.push_back (_("L"));
1221 n.push_back (_("R"));
1222 n.push_back (_("C"));
1223 n.push_back (_("Lfe"));
1224 n.push_back (_("Ls"));
1225 n.push_back (_("Rs"));
1226 n.push_back (_("HI"));
1227 n.push_back (_("VI"));
1228 n.push_back (_("Lc"));
1229 n.push_back (_("Rc"));
1230 n.push_back (_("BsL"));
1231 n.push_back (_("BsR"));
1233 return vector<string> (n.begin(), n.begin() + audio_channels ());
1237 Film::audio_channels () const
1240 if (_audio_processor) {
1241 minimum = _audio_processor->out_channels ();
1244 if (minimum % 2 == 1) {
1248 return max (minimum, _audio_channels);