2 Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 * @brief A representation of some audio and video content, and details of
22 * how they should be presented in a DCP.
28 #include "job_manager.h"
29 #include "transcode_job.h"
30 #include "upload_job.h"
33 #include "exceptions.h"
34 #include "examine_content_job.h"
37 #include "dcp_content_type.h"
40 #include "safe_stringstream.h"
41 #include "environment_info.h"
42 #include "raw_convert.h"
43 #include "audio_processor.h"
44 #include "md5_digester.h"
45 #include "compose.hpp"
47 #include "audio_content.h"
48 #include "video_content.h"
49 #include "subtitle_content.h"
50 #include "ffmpeg_content.h"
51 #include "dcp_content.h"
52 #include "screen_kdm.h"
53 #include <libcxml/cxml.h>
55 #include <dcp/certificate_chain.h>
57 #include <dcp/local_time.h>
58 #include <dcp/decrypted_kdm.h>
59 #include <libxml++/libxml++.h>
60 #include <boost/filesystem.hpp>
61 #include <boost/algorithm/string.hpp>
62 #include <boost/foreach.hpp>
83 using std::runtime_error;
84 using boost::shared_ptr;
85 using boost::weak_ptr;
86 using boost::dynamic_pointer_cast;
87 using boost::optional;
88 using boost::is_any_of;
90 #define LOG_GENERAL(...) log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
91 #define LOG_GENERAL_NC(...) log()->log (__VA_ARGS__, LogEntry::TYPE_GENERAL);
94 * AudioMapping XML changed.
96 * Subtitle offset changed to subtitle y offset, and subtitle x offset added.
98 * Use <Scale> tag in <VideoContent> rather than <Ratio>.
102 * Subtitle X and Y scale.
104 * Bumped to 32 for 2.0 branch; some times are expressed in Times rather
107 int const Film::current_state_version = 32;
109 /** Construct a Film object in a given directory.
111 * @param dir Film directory.
114 Film::Film (boost::filesystem::path dir, bool log)
115 : _playlist (new Playlist)
116 , _use_isdcf_name (true)
117 , _dcp_content_type (Config::instance()->default_dcp_content_type ())
118 , _container (Config::instance()->default_container ())
119 , _resolution (RESOLUTION_2K)
122 , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
123 , _isdcf_metadata (Config::instance()->default_isdcf_metadata ())
124 , _video_frame_rate (24)
125 , _audio_channels (6)
127 , _sequence_video (true)
128 , _interop (Config::instance()->default_interop ())
129 , _audio_processor (0)
130 , _reel_type (REELTYPE_SINGLE)
131 , _reel_length (2000000000)
132 , _state_version (current_state_version)
135 set_isdcf_date_today ();
137 _playlist_changed_connection = _playlist->Changed.connect (bind (&Film::playlist_changed, this));
138 _playlist_content_changed_connection = _playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2, _3));
140 /* Make state.directory a complete path without ..s (where possible)
141 (Code swiped from Adam Bowen on stackoverflow)
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 BOOST_FOREACH (boost::signals2::connection& i, _job_connections) {
174 BOOST_FOREACH (boost::signals2::connection& i, _audio_analysis_connections) {
180 Film::video_identifier () const
182 DCPOMATIC_ASSERT (container ());
185 s.imbue (std::locale::classic ());
187 s << container()->id()
188 << "_" << resolution_to_string (_resolution)
189 << "_" << _playlist->video_identifier()
190 << "_" << _video_frame_rate
191 << "_" << j2k_bandwidth();
212 /** @return The file to write video frame info to */
213 boost::filesystem::path
214 Film::info_file (DCPTimePeriod period) const
216 boost::filesystem::path p;
218 p /= video_identifier () + "_" + raw_convert<string> (period.from.get()) + "_" + raw_convert<string> (period.to.get());
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 (DCPTimePeriod p) const
231 return video_identifier() + "_" + raw_convert<string> (p.from.get()) + "_" + raw_convert<string> (p.to.get()) + ".mxf";
234 boost::filesystem::path
235 Film::audio_analysis_path (shared_ptr<const Playlist> playlist) const
237 boost::filesystem::path p = dir ("analysis");
239 MD5Digester digester;
240 BOOST_FOREACH (shared_ptr<Content> i, playlist->content ()) {
241 shared_ptr<AudioContent> ac = dynamic_pointer_cast<AudioContent> (i);
246 digester.add (ac->digest ());
247 digester.add (ac->audio_mapping().digest ());
248 if (playlist->content().size() != 1) {
249 /* Analyses should be considered equal regardless of gain
250 if they were made from just one piece of content. This
251 is because we can fake any gain change in a single-content
252 analysis at the plotting stage rather than having to
255 digester.add (ac->audio_gain ());
259 if (audio_processor ()) {
260 digester.add (audio_processor()->id ());
263 p /= digester.get ();
267 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
271 if (dcp_name().find ("/") != string::npos) {
272 throw BadSettingError (_("name"), _("cannot contain slashes"));
275 set_isdcf_date_today ();
277 environment_info (log ());
279 BOOST_FOREACH (shared_ptr<const Content> i, content ()) {
280 LOG_GENERAL ("Content: %1", i->technical_summary());
282 LOG_GENERAL ("DCP video rate %1 fps", video_frame_rate());
283 if (Config::instance()->only_servers_encode ()) {
284 LOG_GENERAL_NC ("0 threads: ONLY SERVERS SET TO ENCODE");
286 LOG_GENERAL ("%1 threads", Config::instance()->num_local_encoding_threads());
288 LOG_GENERAL ("J2K bandwidth %1", j2k_bandwidth());
290 if (container() == 0) {
291 throw MissingSettingError (_("container"));
294 if (content().empty()) {
295 throw runtime_error (_("You must add some content to the DCP before creating it"));
298 if (dcp_content_type() == 0) {
299 throw MissingSettingError (_("content type"));
302 if (name().empty()) {
303 throw MissingSettingError (_("name"));
306 JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
309 /** Start a job to send our DCP to the configured TMS */
311 Film::send_dcp_to_tms ()
313 shared_ptr<Job> j (new UploadJob (shared_from_this()));
314 JobManager::instance()->add (j);
317 shared_ptr<xmlpp::Document>
318 Film::metadata () const
320 shared_ptr<xmlpp::Document> doc (new xmlpp::Document);
321 xmlpp::Element* root = doc->create_root_node ("Metadata");
323 root->add_child("Version")->add_child_text (raw_convert<string> (current_state_version));
324 root->add_child("Name")->add_child_text (_name);
325 root->add_child("UseISDCFName")->add_child_text (_use_isdcf_name ? "1" : "0");
327 if (_dcp_content_type) {
328 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->isdcf_name ());
332 root->add_child("Container")->add_child_text (_container->id ());
335 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
336 root->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
337 _isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
338 root->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
339 root->add_child("ISDCFDate")->add_child_text (boost::gregorian::to_iso_string (_isdcf_date));
340 root->add_child("AudioChannels")->add_child_text (raw_convert<string> (_audio_channels));
341 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
342 root->add_child("SequenceVideo")->add_child_text (_sequence_video ? "1" : "0");
343 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
344 root->add_child("Signed")->add_child_text (_signed ? "1" : "0");
345 root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
346 root->add_child("Key")->add_child_text (_key.hex ());
347 if (_audio_processor) {
348 root->add_child("AudioProcessor")->add_child_text (_audio_processor->id ());
350 root->add_child("ReelType")->add_child_text (raw_convert<string> (_reel_type));
351 root->add_child("ReelLength")->add_child_text (raw_convert<string> (_reel_length));
352 _playlist->as_xml (root->add_child ("Playlist"));
357 /** Write state to our `metadata' file */
359 Film::write_metadata () const
361 boost::filesystem::create_directories (directory ());
362 shared_ptr<xmlpp::Document> doc = metadata ();
363 doc->write_to_file_formatted (file("metadata.xml").string ());
367 /** Read state from our metadata file.
368 * @return Notes about things that the user should know about, or empty.
371 Film::read_metadata ()
373 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
374 throw runtime_error (_("This film was created with an older version of DCP-o-matic, and unfortunately it cannot be loaded into this version. You will need to create a new Film, re-add your content and set it up again. Sorry!"));
377 cxml::Document f ("Metadata");
378 f.read_file (file ("metadata.xml"));
380 _state_version = f.number_child<int> ("Version");
381 if (_state_version > current_state_version) {
382 throw runtime_error (_("This film was created with a newer version of DCP-o-matic, and it cannot be loaded into this version. Sorry!"));
385 _name = f.string_child ("Name");
386 if (_state_version >= 9) {
387 _use_isdcf_name = f.bool_child ("UseISDCFName");
388 _isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
389 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("ISDCFDate"));
391 _use_isdcf_name = f.bool_child ("UseDCIName");
392 _isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
393 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
397 optional<string> c = f.optional_string_child ("DCPContentType");
399 _dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
404 optional<string> c = f.optional_string_child ("Container");
406 _container = Ratio::from_id (c.get ());
410 _resolution = string_to_resolution (f.string_child ("Resolution"));
411 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
412 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
413 _signed = f.optional_bool_child("Signed").get_value_or (true);
414 _encrypted = f.bool_child ("Encrypted");
415 _audio_channels = f.number_child<int> ("AudioChannels");
416 /* We used to allow odd numbers (and zero) channels, but it's just not worth
419 if (_audio_channels == 0) {
421 } else if ((_audio_channels % 2) == 1) {
424 _sequence_video = f.bool_child ("SequenceVideo");
425 _three_d = f.bool_child ("ThreeD");
426 _interop = f.bool_child ("Interop");
427 _key = dcp::Key (f.string_child ("Key"));
429 if (f.optional_string_child ("AudioProcessor")) {
430 _audio_processor = AudioProcessor::from_id (f.string_child ("AudioProcessor"));
432 _audio_processor = 0;
435 _reel_type = static_cast<ReelType> (f.optional_number_child<int>("ReelType").get_value_or (static_cast<int>(REELTYPE_SINGLE)));
436 _reel_length = f.optional_number_child<int64_t>("ReelLength").get_value_or (2000000000);
439 /* This method is the only one that can return notes (so far) */
440 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
442 /* Write backtraces to this film's directory, until another film is loaded */
443 set_backtrace_file (file ("backtrace.txt"));
449 /** Given a directory name, return its full path within the Film's directory.
450 * The directory (and its parents) will be created if they do not exist.
452 boost::filesystem::path
453 Film::dir (boost::filesystem::path d) const
455 boost::filesystem::path p;
459 boost::filesystem::create_directories (p);
464 /** Given a file or directory name, return its full path within the Film's directory.
465 * Any required parent directories will be created.
467 boost::filesystem::path
468 Film::file (boost::filesystem::path f) const
470 boost::filesystem::path p;
474 boost::filesystem::create_directories (p.parent_path ());
479 /** @return a ISDCF-compliant name for a DCP of this film */
481 Film::isdcf_name (bool if_created_now) const
485 string raw_name = name ();
487 /* Split the raw name up into words */
488 vector<string> words;
489 split (words, raw_name, is_any_of (" _-"));
493 /* Add each word to fixed_name */
494 for (vector<string>::const_iterator i = words.begin(); i != words.end(); ++i) {
497 /* First letter is always capitalised */
498 w[0] = toupper (w[0]);
500 /* Count caps in w */
502 for (size_t i = 0; i < w.size(); ++i) {
503 if (isupper (w[i])) {
508 /* If w is all caps make the rest of it lower case, otherwise
511 if (caps == w.size ()) {
512 for (size_t i = 1; i < w.size(); ++i) {
513 w[i] = tolower (w[i]);
517 for (size_t i = 0; i < w.size(); ++i) {
522 if (fixed_name.length() > 14) {
523 fixed_name = fixed_name.substr (0, 14);
528 if (dcp_content_type()) {
529 d << "_" << dcp_content_type()->isdcf_name();
530 d << "-" << isdcf_metadata().content_version;
533 ISDCFMetadata const dm = isdcf_metadata ();
535 if (dm.temp_version) {
539 if (dm.pre_release) {
547 if (!dm.chain.empty ()) {
548 d << "-" << dm.chain;
555 if (dm.two_d_version_of_three_d) {
559 if (!dm.mastered_luminance.empty ()) {
560 d << "-" << dm.mastered_luminance;
563 if (video_frame_rate() != 24) {
564 d << "-" << video_frame_rate();
568 d << "_" << container()->isdcf_name();
571 /* XXX: this uses the first bit of content only */
573 /* The standard says we don't do this for trailers, for some strange reason */
574 if (dcp_content_type() && dcp_content_type()->libdcp_kind() != dcp::TRAILER) {
575 Ratio const * content_ratio = 0;
576 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
577 shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (i);
579 /* Here's the first piece of video content */
580 if (vc->scale().ratio ()) {
581 content_ratio = vc->scale().ratio ();
583 content_ratio = Ratio::from_ratio (vc->video_size().ratio ());
589 if (content_ratio && content_ratio != container()) {
590 d << "-" << content_ratio->isdcf_name();
594 if (!dm.audio_language.empty ()) {
595 d << "_" << dm.audio_language;
596 if (!dm.subtitle_language.empty()) {
597 d << "-" << dm.subtitle_language;
603 if (!dm.territory.empty ()) {
604 d << "_" << dm.territory;
605 if (dm.rating.empty ()) {
608 d << "-" << dm.rating;
612 /* Find all mapped channels */
617 if (audio_processor ()) {
618 /* Processors are mapped 1:1 to DCP outputs so we can guess the number of LFE/
619 non-LFE from the channel counts.
621 non_lfe = audio_processor()->out_channels ();
628 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
629 shared_ptr<const AudioContent> ac = dynamic_pointer_cast<const AudioContent> (i);
631 list<int> c = ac->audio_mapping().mapped_output_channels ();
632 copy (c.begin(), c.end(), back_inserter (mapped));
641 for (list<int>::const_iterator i = mapped.begin(); i != mapped.end(); ++i) {
642 if (*i >= audio_channels()) {
643 /* This channel is mapped but is not included in the DCP */
647 if (static_cast<dcp::Channel> (*i) == dcp::LFE) {
656 d << "_" << non_lfe << lfe;
661 d << "_" << resolution_to_string (_resolution);
663 if (!dm.studio.empty ()) {
664 d << "_" << dm.studio;
667 if (if_created_now) {
668 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
670 d << "_" << boost::gregorian::to_iso_string (_isdcf_date);
673 if (!dm.facility.empty ()) {
674 d << "_" << dm.facility;
688 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
689 shared_ptr<const DCPContent> dc = dynamic_pointer_cast<const DCPContent> (i);
690 if (dc && (dc->reference_video() || dc->reference_audio() || dc->reference_subtitle())) {
704 /** @return name to give the DCP */
706 Film::dcp_name (bool if_created_now) const
709 if (use_isdcf_name()) {
710 unfiltered = isdcf_name (if_created_now);
712 unfiltered = name ();
715 /* Filter out `bad' characters which cause problems with some systems.
716 There's no apparent list of what really is allowed, so this is a guess.
720 string const allowed = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-_";
721 for (size_t i = 0; i < unfiltered.size(); ++i) {
722 if (allowed.find (unfiltered[i]) != string::npos) {
723 filtered += unfiltered[i];
731 Film::set_directory (boost::filesystem::path d)
738 Film::set_name (string n)
741 signal_changed (NAME);
745 Film::set_use_isdcf_name (bool u)
748 signal_changed (USE_ISDCF_NAME);
752 Film::set_dcp_content_type (DCPContentType const * t)
754 _dcp_content_type = t;
755 signal_changed (DCP_CONTENT_TYPE);
759 Film::set_container (Ratio const * c)
762 signal_changed (CONTAINER);
766 Film::set_resolution (Resolution r)
769 signal_changed (RESOLUTION);
773 Film::set_j2k_bandwidth (int b)
776 signal_changed (J2K_BANDWIDTH);
780 Film::set_isdcf_metadata (ISDCFMetadata m)
783 signal_changed (ISDCF_METADATA);
787 Film::set_video_frame_rate (int f)
789 _video_frame_rate = f;
790 signal_changed (VIDEO_FRAME_RATE);
794 Film::set_audio_channels (int c)
797 signal_changed (AUDIO_CHANNELS);
801 Film::set_three_d (bool t)
804 signal_changed (THREE_D);
806 if (_three_d && _isdcf_metadata.two_d_version_of_three_d) {
807 _isdcf_metadata.two_d_version_of_three_d = false;
808 signal_changed (ISDCF_METADATA);
813 Film::set_interop (bool i)
816 signal_changed (INTEROP);
820 Film::set_audio_processor (AudioProcessor const * processor)
822 _audio_processor = processor;
823 signal_changed (AUDIO_PROCESSOR);
824 signal_changed (AUDIO_CHANNELS);
828 Film::set_reel_type (ReelType t)
831 signal_changed (REEL_TYPE);
835 Film::set_reel_length (int64_t r)
838 signal_changed (REEL_LENGTH);
842 Film::signal_changed (Property p)
848 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
850 case Film::VIDEO_FRAME_RATE:
851 case Film::SEQUENCE_VIDEO:
852 _playlist->maybe_sequence_video ();
858 emit (boost::bind (boost::ref (Changed), p));
862 Film::set_isdcf_date_today ()
864 _isdcf_date = boost::gregorian::day_clock::local_day ();
867 boost::filesystem::path
868 Film::j2c_path (int f, Eyes e, bool t) const
870 boost::filesystem::path p;
872 p /= video_identifier ();
876 s << setfill('0') << f;
878 if (e == EYES_LEFT) {
880 } else if (e == EYES_RIGHT) {
894 /** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs */
898 vector<CPLSummary> out;
900 boost::filesystem::path const dir = directory ();
901 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
903 boost::filesystem::is_directory (*i) &&
904 i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
912 i->path().leaf().string(),
913 dcp.cpls().front()->id(),
914 dcp.cpls().front()->annotation_text(),
915 dcp.cpls().front()->file()
928 Film::set_signed (bool s)
931 signal_changed (SIGNED);
935 Film::set_encrypted (bool e)
938 signal_changed (ENCRYPTED);
942 Film::set_key (dcp::Key key)
945 signal_changed (KEY);
949 Film::content () const
951 return _playlist->content ();
955 Film::examine_content (shared_ptr<Content> c)
957 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
958 JobManager::instance()->add (j);
962 Film::examine_and_add_content (shared_ptr<Content> c)
964 if (dynamic_pointer_cast<FFmpegContent> (c) && !_directory.empty ()) {
965 run_ffprobe (c->path(0), file ("ffprobe.log"), _log);
968 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
970 _job_connections.push_back (
971 j->Finished.connect (bind (&Film::maybe_add_content, this, weak_ptr<Job> (j), weak_ptr<Content> (c)))
974 JobManager::instance()->add (j);
978 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
980 shared_ptr<Job> job = j.lock ();
981 if (!job || !job->finished_ok ()) {
985 shared_ptr<Content> content = c.lock ();
990 add_content (content);
991 if (Config::instance()->automatic_audio_analysis ()) {
992 shared_ptr<Playlist> playlist (new Playlist);
993 playlist->add (content);
994 boost::signals2::connection c;
995 JobManager::instance()->analyse_audio (
996 shared_from_this (), playlist, c, bind (&Film::audio_analysis_finished, this)
998 _audio_analysis_connections.push_back (c);
1003 Film::add_content (shared_ptr<Content> c)
1005 /* Add video content after any existing content */
1006 if (dynamic_pointer_cast<VideoContent> (c)) {
1007 c->set_position (_playlist->video_end ());
1014 Film::remove_content (shared_ptr<Content> c)
1016 _playlist->remove (c);
1020 Film::move_content_earlier (shared_ptr<Content> c)
1022 _playlist->move_earlier (c);
1026 Film::move_content_later (shared_ptr<Content> c)
1028 _playlist->move_later (c);
1031 /** @return length of the film from time 0 to the last thing on the playlist */
1033 Film::length () const
1035 return _playlist->length ();
1039 Film::best_video_frame_rate () const
1041 return _playlist->best_dcp_frame_rate ();
1045 Film::active_frame_rate_change (DCPTime t) const
1047 return _playlist->active_frame_rate_change (t, video_frame_rate ());
1051 Film::playlist_content_changed (weak_ptr<Content> c, int p, bool frequent)
1055 if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
1056 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
1057 } else if (p == AudioContentProperty::AUDIO_STREAMS) {
1058 signal_changed (NAME);
1061 emit (boost::bind (boost::ref (ContentChanged), c, p, frequent));
1065 Film::playlist_changed ()
1067 signal_changed (CONTENT);
1068 signal_changed (NAME);
1072 Film::audio_frame_rate () const
1074 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
1075 shared_ptr<AudioContent> a = dynamic_pointer_cast<AudioContent> (i);
1076 if (a && a->has_rate_above_48k ()) {
1085 Film::set_sequence_video (bool s)
1087 _sequence_video = s;
1088 _playlist->set_sequence_video (s);
1089 signal_changed (SEQUENCE_VIDEO);
1092 /** @return Size of the largest possible image in whatever resolution we are using */
1094 Film::full_frame () const
1096 switch (_resolution) {
1098 return dcp::Size (2048, 1080);
1100 return dcp::Size (4096, 2160);
1103 DCPOMATIC_ASSERT (false);
1104 return dcp::Size ();
1107 /** @return Size of the frame */
1109 Film::frame_size () const
1111 return fit_ratio_within (container()->ratio(), full_frame ());
1116 dcp::Certificate target,
1117 boost::filesystem::path cpl_file,
1118 dcp::LocalTime from,
1119 dcp::LocalTime until,
1120 dcp::Formulation formulation
1123 shared_ptr<const dcp::CPL> cpl (new dcp::CPL (cpl_file));
1124 shared_ptr<const dcp::CertificateChain> signer = Config::instance()->signer_chain ();
1125 if (!signer->valid ()) {
1126 throw InvalidSignerError ();
1129 return dcp::DecryptedKDM (
1130 cpl, key(), from, until, "DCP-o-matic", cpl->content_title_text(), dcp::LocalTime().as_string()
1131 ).encrypt (signer, target, formulation);
1136 list<shared_ptr<Screen> > screens,
1137 boost::filesystem::path dcp,
1138 dcp::LocalTime from,
1139 dcp::LocalTime until,
1140 dcp::Formulation formulation
1143 list<ScreenKDM> kdms;
1145 BOOST_FOREACH (shared_ptr<Screen> i, screens) {
1146 if (i->certificate) {
1147 kdms.push_back (ScreenKDM (i, make_kdm (i->certificate.get(), dcp, from, until, formulation)));
1154 /** @return The approximate disk space required to encode a DCP of this film with the
1155 * current settings, in bytes.
1158 Film::required_disk_space () const
1160 return uint64_t (j2k_bandwidth() / 8) * length().seconds();
1163 /** This method checks the disk that the Film is on and tries to decide whether or not
1164 * there will be enough space to make a DCP for it. If so, true is returned; if not,
1165 * false is returned and required and availabe are filled in with the amount of disk space
1166 * required and available respectively (in Gb).
1168 * Note: the decision made by this method isn't, of course, 100% reliable.
1171 Film::should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const
1173 /* Create a test file and see if we can hard-link it */
1174 boost::filesystem::path test = internal_video_asset_dir() / "test";
1175 boost::filesystem::path test2 = internal_video_asset_dir() / "test2";
1176 can_hard_link = true;
1177 FILE* f = fopen_boost (test, "w");
1180 boost::system::error_code ec;
1181 boost::filesystem::create_hard_link (test, test2, ec);
1183 can_hard_link = false;
1185 boost::filesystem::remove (test);
1186 boost::filesystem::remove (test2);
1189 boost::filesystem::space_info s = boost::filesystem::space (internal_video_asset_dir ());
1190 required = double (required_disk_space ()) / 1073741824.0f;
1191 if (!can_hard_link) {
1194 available = double (s.available) / 1073741824.0f;
1195 return (available - required) > 1;
1199 Film::subtitle_language () const
1201 set<string> languages;
1203 ContentList cl = content ();
1204 BOOST_FOREACH (shared_ptr<Content>& c, cl) {
1205 shared_ptr<SubtitleContent> sc = dynamic_pointer_cast<SubtitleContent> (c);
1207 languages.insert (sc->subtitle_language ());
1212 BOOST_FOREACH (string s, languages) {
1213 if (!all.empty ()) {
1223 /** Change the gains of the supplied AudioMapping to make it a default
1224 * for this film. The defaults are guessed based on what processor (if any)
1225 * is in use and the number of input channels.
1228 Film::make_audio_mapping_default (AudioMapping& mapping) const
1230 if (audio_processor ()) {
1231 audio_processor()->make_audio_mapping_default (mapping);
1233 mapping.make_zero ();
1234 if (mapping.input_channels() == 1) {
1235 /* Mono -> Centre */
1236 mapping.set (0, static_cast<int> (dcp::CENTRE), 1);
1239 for (int i = 0; i < min (mapping.input_channels(), mapping.output_channels()); ++i) {
1240 mapping.set (i, i, 1);
1246 /** @return The names of the channels that audio contents' outputs are passed into;
1247 * this is either the DCP or a AudioProcessor.
1250 Film::audio_output_names () const
1252 if (audio_processor ()) {
1253 return audio_processor()->input_names ();
1257 n.push_back (_("L"));
1258 n.push_back (_("R"));
1259 n.push_back (_("C"));
1260 n.push_back (_("Lfe"));
1261 n.push_back (_("Ls"));
1262 n.push_back (_("Rs"));
1263 n.push_back (_("HI"));
1264 n.push_back (_("VI"));
1265 n.push_back (_("Lc"));
1266 n.push_back (_("Rc"));
1267 n.push_back (_("BsL"));
1268 n.push_back (_("BsR"));
1270 return vector<string> (n.begin(), n.begin() + audio_channels ());
1274 Film::repeat_content (ContentList c, int n)
1276 _playlist->repeat (c, n);
1280 Film::remove_content (ContentList c)
1282 _playlist->remove (c);
1286 Film::audio_analysis_finished ()
1292 Film::reels () const
1294 list<DCPTimePeriod> p;
1295 DCPTime const len = length ();
1297 switch (reel_type ()) {
1298 case REELTYPE_SINGLE:
1299 p.push_back (DCPTimePeriod (DCPTime (), len));
1301 case REELTYPE_BY_VIDEO_CONTENT:
1303 optional<DCPTime> last_split;
1304 shared_ptr<VideoContent> last_video;
1305 ContentList cl = content ();
1306 BOOST_FOREACH (shared_ptr<Content> c, content ()) {
1307 shared_ptr<VideoContent> v = dynamic_pointer_cast<VideoContent> (c);
1309 BOOST_FOREACH (DCPTime t, v->reel_split_points()) {
1311 p.push_back (DCPTimePeriod (last_split.get(), t));
1319 DCPTime video_end = last_video ? last_video->end() : DCPTime(0);
1321 /* Definitely go from the last split to the end of the video content */
1322 p.push_back (DCPTimePeriod (last_split.get(), video_end));
1325 if (video_end < len) {
1326 /* And maybe go after that as well if there is any non-video hanging over the end */
1327 p.push_back (DCPTimePeriod (video_end, len));
1331 case REELTYPE_BY_LENGTH:
1334 /* Integer-divide reel length by the size of one frame to give the number of frames per reel */
1335 Frame const reel_in_frames = _reel_length / ((j2k_bandwidth() / video_frame_rate()) / 8);
1336 while (current < len) {
1337 DCPTime end = min (len, current + DCPTime::from_frames (reel_in_frames, video_frame_rate ()));
1338 p.push_back (DCPTimePeriod (current, end));