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"
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/certificate_chain.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;
90 using dcp::CertificateChain;
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 , _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, _3));
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();
208 /** @return The file to write video frame info to */
209 boost::filesystem::path
210 Film::info_file () const
212 boost::filesystem::path p;
214 p /= video_identifier ();
218 boost::filesystem::path
219 Film::internal_video_asset_dir () const
221 return dir ("video");
224 boost::filesystem::path
225 Film::internal_video_asset_filename () const
227 return video_identifier() + ".mxf";
230 boost::filesystem::path
231 Film::audio_analysis_path (shared_ptr<const Playlist> playlist) const
233 boost::filesystem::path p = dir ("analysis");
235 MD5Digester digester;
236 BOOST_FOREACH (shared_ptr<Content> i, playlist->content ()) {
237 shared_ptr<AudioContent> ac = dynamic_pointer_cast<AudioContent> (i);
242 digester.add (ac->digest ());
243 digester.add (ac->audio_mapping().digest ());
244 if (playlist->content().size() != 1) {
245 /* Analyses should be considered equal regardless of gain
246 if they were made from just one piece of content. This
247 is because we can fake any gain change in a single-content
248 analysis at the plotting stage rather than having to
251 digester.add (ac->audio_gain ());
255 if (audio_processor ()) {
256 digester.add (audio_processor()->id ());
259 p /= digester.get ();
263 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
267 if (dcp_name().find ("/") != string::npos) {
268 throw BadSettingError (_("name"), _("cannot contain slashes"));
271 set_isdcf_date_today ();
273 environment_info (log ());
275 BOOST_FOREACH (shared_ptr<const Content> i, content ()) {
276 LOG_GENERAL ("Content: %1", i->technical_summary());
278 LOG_GENERAL ("DCP video rate %1 fps", video_frame_rate());
279 LOG_GENERAL ("%1 threads", Config::instance()->num_local_encoding_threads());
280 LOG_GENERAL ("J2K bandwidth %1", j2k_bandwidth());
282 if (container() == 0) {
283 throw MissingSettingError (_("container"));
286 if (content().empty()) {
287 throw StringError (_("You must add some content to the DCP before creating it"));
290 if (dcp_content_type() == 0) {
291 throw MissingSettingError (_("content type"));
294 if (name().empty()) {
295 throw MissingSettingError (_("name"));
298 JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
301 /** Start a job to send our DCP to the configured TMS */
303 Film::send_dcp_to_tms ()
305 shared_ptr<Job> j (new UploadJob (shared_from_this()));
306 JobManager::instance()->add (j);
309 shared_ptr<xmlpp::Document>
310 Film::metadata () const
312 shared_ptr<xmlpp::Document> doc (new xmlpp::Document);
313 xmlpp::Element* root = doc->create_root_node ("Metadata");
315 root->add_child("Version")->add_child_text (raw_convert<string> (current_state_version));
316 root->add_child("Name")->add_child_text (_name);
317 root->add_child("UseISDCFName")->add_child_text (_use_isdcf_name ? "1" : "0");
319 if (_dcp_content_type) {
320 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->isdcf_name ());
324 root->add_child("Container")->add_child_text (_container->id ());
327 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
328 root->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
329 _isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
330 root->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
331 root->add_child("ISDCFDate")->add_child_text (boost::gregorian::to_iso_string (_isdcf_date));
332 root->add_child("AudioChannels")->add_child_text (raw_convert<string> (_audio_channels));
333 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
334 root->add_child("SequenceVideo")->add_child_text (_sequence_video ? "1" : "0");
335 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
336 root->add_child("Signed")->add_child_text (_signed ? "1" : "0");
337 root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
338 root->add_child("Key")->add_child_text (_key.hex ());
339 if (_audio_processor) {
340 root->add_child("AudioProcessor")->add_child_text (_audio_processor->id ());
342 _playlist->as_xml (root->add_child ("Playlist"));
347 /** Write state to our `metadata' file */
349 Film::write_metadata () const
351 boost::filesystem::create_directories (directory ());
352 shared_ptr<xmlpp::Document> doc = metadata ();
353 doc->write_to_file_formatted (file("metadata.xml").string ());
357 /** Read state from our metadata file.
358 * @return Notes about things that the user should know about, or empty.
361 Film::read_metadata ()
363 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
364 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!"));
367 cxml::Document f ("Metadata");
368 f.read_file (file ("metadata.xml"));
370 _state_version = f.number_child<int> ("Version");
371 if (_state_version > current_state_version) {
372 throw StringError (_("This film was created with a newer version of DCP-o-matic, and it cannot be loaded into this version. Sorry!"));
375 _name = f.string_child ("Name");
376 if (_state_version >= 9) {
377 _use_isdcf_name = f.bool_child ("UseISDCFName");
378 _isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
379 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("ISDCFDate"));
381 _use_isdcf_name = f.bool_child ("UseDCIName");
382 _isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
383 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
387 optional<string> c = f.optional_string_child ("DCPContentType");
389 _dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
394 optional<string> c = f.optional_string_child ("Container");
396 _container = Ratio::from_id (c.get ());
400 _resolution = string_to_resolution (f.string_child ("Resolution"));
401 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
402 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
403 _signed = f.optional_bool_child("Signed").get_value_or (true);
404 _encrypted = f.bool_child ("Encrypted");
405 _audio_channels = f.number_child<int> ("AudioChannels");
406 /* We used to allow odd numbers (and zero) channels, but it's just not worth
409 if (_audio_channels == 0) {
411 } else if ((_audio_channels % 2) == 1) {
414 _sequence_video = f.bool_child ("SequenceVideo");
415 _three_d = f.bool_child ("ThreeD");
416 _interop = f.bool_child ("Interop");
417 _key = dcp::Key (f.string_child ("Key"));
419 if (f.optional_string_child ("AudioProcessor")) {
420 _audio_processor = AudioProcessor::from_id (f.string_child ("AudioProcessor"));
422 _audio_processor = 0;
426 /* This method is the only one that can return notes (so far) */
427 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
429 /* Write backtraces to this film's directory, until another film is loaded */
430 set_backtrace_file (file ("backtrace.txt"));
436 /** Given a directory name, return its full path within the Film's directory.
437 * The directory (and its parents) will be created if they do not exist.
439 boost::filesystem::path
440 Film::dir (boost::filesystem::path d) const
442 boost::filesystem::path p;
446 boost::filesystem::create_directories (p);
451 /** Given a file or directory name, return its full path within the Film's directory.
452 * Any required parent directories will be created.
454 boost::filesystem::path
455 Film::file (boost::filesystem::path f) const
457 boost::filesystem::path p;
461 boost::filesystem::create_directories (p.parent_path ());
466 /** @return a ISDCF-compliant name for a DCP of this film */
468 Film::isdcf_name (bool if_created_now) const
472 string raw_name = name ();
474 /* Split the raw name up into words */
475 vector<string> words;
476 split (words, raw_name, is_any_of (" _-"));
480 /* Add each word to fixed_name */
481 for (vector<string>::const_iterator i = words.begin(); i != words.end(); ++i) {
484 /* First letter is always capitalised */
485 w[0] = toupper (w[0]);
487 /* Count caps in w */
489 for (size_t i = 0; i < w.size(); ++i) {
490 if (isupper (w[i])) {
495 /* If w is all caps make the rest of it lower case, otherwise
498 if (caps == w.size ()) {
499 for (size_t i = 1; i < w.size(); ++i) {
500 w[i] = tolower (w[i]);
504 for (size_t i = 0; i < w.size(); ++i) {
509 if (fixed_name.length() > 14) {
510 fixed_name = fixed_name.substr (0, 14);
515 if (dcp_content_type()) {
516 d << "_" << dcp_content_type()->isdcf_name();
517 d << "-" << isdcf_metadata().content_version;
520 ISDCFMetadata const dm = isdcf_metadata ();
522 if (dm.temp_version) {
526 if (dm.pre_release) {
534 if (!dm.chain.empty ()) {
535 d << "-" << dm.chain;
542 if (dm.two_d_version_of_three_d) {
546 if (!dm.mastered_luminance.empty ()) {
547 d << "-" << dm.mastered_luminance;
550 if (video_frame_rate() != 24) {
551 d << "-" << video_frame_rate();
555 d << "_" << container()->isdcf_name();
558 ContentList cl = content ();
560 /* XXX: this uses the first bit of content only */
562 /* The standard says we don't do this for trailers, for some strange reason */
563 if (dcp_content_type() && dcp_content_type()->libdcp_kind() != dcp::TRAILER) {
564 Ratio const * content_ratio = 0;
565 for (ContentList::iterator i = cl.begin(); i != cl.end(); ++i) {
566 shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (*i);
568 /* Here's the first piece of video content */
569 if (vc->scale().ratio ()) {
570 content_ratio = vc->scale().ratio ();
572 content_ratio = Ratio::from_ratio (vc->video_size().ratio ());
578 if (content_ratio && content_ratio != container()) {
579 d << "-" << content_ratio->isdcf_name();
583 if (!dm.audio_language.empty ()) {
584 d << "_" << dm.audio_language;
585 if (!dm.subtitle_language.empty()) {
586 d << "-" << dm.subtitle_language;
592 if (!dm.territory.empty ()) {
593 d << "_" << dm.territory;
594 if (dm.rating.empty ()) {
597 d << "-" << dm.rating;
601 /* Find all mapped channels */
606 if (audio_processor ()) {
607 /* Processors are mapped 1:1 to DCP outputs so we can guess the number of LFE/
608 non-LFE from the channel counts.
610 non_lfe = audio_processor()->out_channels ();
617 for (ContentList::const_iterator i = cl.begin(); i != cl.end(); ++i) {
618 shared_ptr<const AudioContent> ac = dynamic_pointer_cast<const AudioContent> (*i);
620 list<int> c = ac->audio_mapping().mapped_output_channels ();
621 copy (c.begin(), c.end(), back_inserter (mapped));
630 for (list<int>::const_iterator i = mapped.begin(); i != mapped.end(); ++i) {
631 if (*i >= audio_channels()) {
632 /* This channel is mapped but is not included in the DCP */
636 if (static_cast<dcp::Channel> (*i) == dcp::LFE) {
645 d << "_" << non_lfe << lfe;
650 d << "_" << resolution_to_string (_resolution);
652 if (!dm.studio.empty ()) {
653 d << "_" << dm.studio;
656 if (if_created_now) {
657 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
659 d << "_" << boost::gregorian::to_iso_string (_isdcf_date);
662 if (!dm.facility.empty ()) {
663 d << "_" << dm.facility;
676 if (!dm.package_type.empty ()) {
677 d << "_" << dm.package_type;
683 /** @return name to give the DCP */
685 Film::dcp_name (bool if_created_now) const
688 if (use_isdcf_name()) {
689 unfiltered = isdcf_name (if_created_now);
691 unfiltered = name ();
694 /* Filter out `bad' characters which cause problems with some systems.
695 There's no apparent list of what really is allowed, so this is a guess.
699 string const allowed = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-_";
700 for (size_t i = 0; i < unfiltered.size(); ++i) {
701 if (allowed.find (unfiltered[i]) != string::npos) {
702 filtered += unfiltered[i];
710 Film::set_directory (boost::filesystem::path d)
717 Film::set_name (string n)
720 signal_changed (NAME);
724 Film::set_use_isdcf_name (bool u)
727 signal_changed (USE_ISDCF_NAME);
731 Film::set_dcp_content_type (DCPContentType const * t)
733 _dcp_content_type = t;
734 signal_changed (DCP_CONTENT_TYPE);
738 Film::set_container (Ratio const * c)
741 signal_changed (CONTAINER);
745 Film::set_resolution (Resolution r)
748 signal_changed (RESOLUTION);
752 Film::set_j2k_bandwidth (int b)
755 signal_changed (J2K_BANDWIDTH);
759 Film::set_isdcf_metadata (ISDCFMetadata m)
762 signal_changed (ISDCF_METADATA);
766 Film::set_video_frame_rate (int f)
768 _video_frame_rate = f;
769 signal_changed (VIDEO_FRAME_RATE);
773 Film::set_audio_channels (int c)
776 signal_changed (AUDIO_CHANNELS);
780 Film::set_three_d (bool t)
783 signal_changed (THREE_D);
785 if (_three_d && _isdcf_metadata.two_d_version_of_three_d) {
786 _isdcf_metadata.two_d_version_of_three_d = false;
787 signal_changed (ISDCF_METADATA);
792 Film::set_interop (bool i)
795 signal_changed (INTEROP);
799 Film::set_audio_processor (AudioProcessor const * processor)
801 _audio_processor = processor;
802 signal_changed (AUDIO_PROCESSOR);
803 signal_changed (AUDIO_CHANNELS);
807 Film::signal_changed (Property p)
813 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
815 case Film::VIDEO_FRAME_RATE:
816 case Film::SEQUENCE_VIDEO:
817 _playlist->maybe_sequence_video ();
823 emit (boost::bind (boost::ref (Changed), p));
827 Film::set_isdcf_date_today ()
829 _isdcf_date = boost::gregorian::day_clock::local_day ();
832 boost::filesystem::path
833 Film::j2c_path (int f, Eyes e, bool t) const
835 boost::filesystem::path p;
837 p /= video_identifier ();
841 s << setfill('0') << f;
843 if (e == EYES_LEFT) {
845 } else if (e == EYES_RIGHT) {
859 /** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs */
863 vector<CPLSummary> out;
865 boost::filesystem::path const dir = directory ();
866 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
868 boost::filesystem::is_directory (*i) &&
869 i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
877 i->path().leaf().string(),
878 dcp.cpls().front()->id(),
879 dcp.cpls().front()->annotation_text(),
880 dcp.cpls().front()->file()
893 Film::set_signed (bool s)
896 signal_changed (SIGNED);
900 Film::set_encrypted (bool e)
903 signal_changed (ENCRYPTED);
907 Film::set_key (dcp::Key key)
910 signal_changed (KEY);
914 Film::content () const
916 return _playlist->content ();
920 Film::examine_content (shared_ptr<Content> c)
922 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
923 JobManager::instance()->add (j);
927 Film::examine_and_add_content (shared_ptr<Content> c)
929 if (dynamic_pointer_cast<FFmpegContent> (c) && !_directory.empty ()) {
930 run_ffprobe (c->path(0), file ("ffprobe.log"), _log);
933 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
935 _job_connections.push_back (
936 j->Finished.connect (bind (&Film::maybe_add_content, this, boost::weak_ptr<Job> (j), boost::weak_ptr<Content> (c)))
939 JobManager::instance()->add (j);
943 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
945 shared_ptr<Job> job = j.lock ();
946 if (!job || !job->finished_ok ()) {
950 shared_ptr<Content> content = c.lock ();
952 add_content (content);
957 Film::add_content (shared_ptr<Content> c)
959 /* Add video content after any existing content */
960 if (dynamic_pointer_cast<VideoContent> (c)) {
961 c->set_position (_playlist->video_end ());
968 Film::remove_content (shared_ptr<Content> c)
970 _playlist->remove (c);
974 Film::move_content_earlier (shared_ptr<Content> c)
976 _playlist->move_earlier (c);
980 Film::move_content_later (shared_ptr<Content> c)
982 _playlist->move_later (c);
986 Film::length () const
988 return _playlist->length ();
992 Film::best_video_frame_rate () const
994 return _playlist->best_dcp_frame_rate ();
998 Film::active_frame_rate_change (DCPTime t) const
1000 return _playlist->active_frame_rate_change (t, video_frame_rate ());
1004 Film::playlist_content_changed (boost::weak_ptr<Content> c, int p, bool frequent)
1008 if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
1009 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
1010 } else if (p == AudioContentProperty::AUDIO_STREAMS) {
1011 signal_changed (NAME);
1014 emit (boost::bind (boost::ref (ContentChanged), c, p, frequent));
1018 Film::playlist_changed ()
1020 signal_changed (CONTENT);
1021 signal_changed (NAME);
1025 Film::audio_frame_rate () const
1032 Film::set_sequence_video (bool s)
1034 _sequence_video = s;
1035 _playlist->set_sequence_video (s);
1036 signal_changed (SEQUENCE_VIDEO);
1039 /** @return Size of the largest possible image in whatever resolution we are using */
1041 Film::full_frame () const
1043 switch (_resolution) {
1045 return dcp::Size (2048, 1080);
1047 return dcp::Size (4096, 2160);
1050 DCPOMATIC_ASSERT (false);
1051 return dcp::Size ();
1054 /** @return Size of the frame */
1056 Film::frame_size () const
1058 return fit_ratio_within (container()->ratio(), full_frame ());
1063 dcp::Certificate target,
1064 boost::filesystem::path cpl_file,
1065 dcp::LocalTime from,
1066 dcp::LocalTime until,
1067 dcp::Formulation formulation
1070 shared_ptr<const dcp::CPL> cpl (new dcp::CPL (cpl_file));
1071 shared_ptr<const dcp::CertificateChain> signer = Config::instance()->signer_chain ();
1072 if (!signer->valid ()) {
1073 throw InvalidSignerError ();
1076 return dcp::DecryptedKDM (
1077 cpl, key(), from, until, "DCP-o-matic", cpl->content_title_text(), dcp::LocalTime().as_string()
1078 ).encrypt (signer, target, formulation);
1081 list<dcp::EncryptedKDM>
1083 list<shared_ptr<Screen> > screens,
1084 boost::filesystem::path dcp,
1085 dcp::LocalTime from,
1086 dcp::LocalTime until,
1087 dcp::Formulation formulation
1090 list<dcp::EncryptedKDM> kdms;
1092 for (list<shared_ptr<Screen> >::iterator i = screens.begin(); i != screens.end(); ++i) {
1093 if ((*i)->certificate) {
1094 kdms.push_back (make_kdm ((*i)->certificate.get(), dcp, from, until, formulation));
1101 /** @return The approximate disk space required to encode a DCP of this film with the
1102 * current settings, in bytes.
1105 Film::required_disk_space () const
1107 return uint64_t (j2k_bandwidth() / 8) * length().seconds();
1110 /** This method checks the disk that the Film is on and tries to decide whether or not
1111 * there will be enough space to make a DCP for it. If so, true is returned; if not,
1112 * false is returned and required and availabe are filled in with the amount of disk space
1113 * required and available respectively (in Gb).
1115 * Note: the decision made by this method isn't, of course, 100% reliable.
1118 Film::should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const
1120 /* Create a test file and see if we can hard-link it */
1121 boost::filesystem::path test = internal_video_asset_dir() / "test";
1122 boost::filesystem::path test2 = internal_video_asset_dir() / "test2";
1123 can_hard_link = true;
1124 FILE* f = fopen_boost (test, "w");
1127 boost::system::error_code ec;
1128 boost::filesystem::create_hard_link (test, test2, ec);
1130 can_hard_link = false;
1132 boost::filesystem::remove (test);
1133 boost::filesystem::remove (test2);
1136 boost::filesystem::space_info s = boost::filesystem::space (internal_video_asset_dir ());
1137 required = double (required_disk_space ()) / 1073741824.0f;
1138 if (!can_hard_link) {
1141 available = double (s.available) / 1073741824.0f;
1142 return (available - required) > 1;
1146 Film::subtitle_language () const
1148 set<string> languages;
1150 ContentList cl = content ();
1151 BOOST_FOREACH (shared_ptr<Content>& c, cl) {
1152 shared_ptr<SubtitleContent> sc = dynamic_pointer_cast<SubtitleContent> (c);
1154 languages.insert (sc->subtitle_language ());
1159 BOOST_FOREACH (string s, languages) {
1160 if (!all.empty ()) {
1170 /** Change the gains of the supplied AudioMapping to make it a default
1171 * for this film. The defaults are guessed based on what processor (if any)
1172 * is in use and the number of input channels.
1175 Film::make_audio_mapping_default (AudioMapping& mapping) const
1177 if (audio_processor ()) {
1178 audio_processor()->make_audio_mapping_default (mapping);
1180 mapping.make_zero ();
1181 if (mapping.input_channels() == 1) {
1182 /* Mono -> Centre */
1183 mapping.set (0, static_cast<int> (dcp::CENTRE), 1);
1186 for (int i = 0; i < min (mapping.input_channels(), mapping.output_channels()); ++i) {
1187 mapping.set (i, i, 1);
1193 /** @return The names of the channels that audio contents' outputs are passed into;
1194 * this is either the DCP or a AudioProcessor.
1197 Film::audio_output_names () const
1199 if (audio_processor ()) {
1200 return audio_processor()->input_names ();
1204 n.push_back (_("L"));
1205 n.push_back (_("R"));
1206 n.push_back (_("C"));
1207 n.push_back (_("Lfe"));
1208 n.push_back (_("Ls"));
1209 n.push_back (_("Rs"));
1210 n.push_back (_("HI"));
1211 n.push_back (_("VI"));
1212 n.push_back (_("Lc"));
1213 n.push_back (_("Rc"));
1214 n.push_back (_("BsL"));
1215 n.push_back (_("BsR"));
1217 return vector<string> (n.begin(), n.begin() + audio_channels ());
1221 Film::repeat_content (ContentList c, int n)
1223 _playlist->repeat (c, n);
1227 Film::remove_content (ContentList c)
1229 _playlist->remove (c);