2 Copyright (C) 2012-2014 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.
28 #include <boost/filesystem.hpp>
29 #include <boost/algorithm/string.hpp>
30 #include <boost/date_time.hpp>
31 #include <libxml++/libxml++.h>
32 #include <libcxml/cxml.h>
33 #include <libdcp/signer_chain.h>
34 #include <libdcp/cpl.h>
35 #include <libdcp/signer.h>
36 #include <libdcp/util.h>
37 #include <libdcp/kdm.h>
38 #include <libdcp/raw_convert.h>
42 #include "job_manager.h"
43 #include "transcode_job.h"
44 #include "scp_dcp_job.h"
46 #include "exceptions.h"
47 #include "examine_content_job.h"
51 #include "ui_signaller.h"
54 #include "dcp_content_type.h"
62 using std::stringstream;
73 using boost::shared_ptr;
74 using boost::weak_ptr;
75 using boost::dynamic_pointer_cast;
76 using boost::to_upper_copy;
77 using boost::ends_with;
78 using boost::starts_with;
79 using boost::optional;
82 using libdcp::raw_convert;
84 #define LOG_GENERAL(...) log()->log (String::compose (__VA_ARGS__), Log::TYPE_GENERAL);
85 #define LOG_GENERAL_NC(...) log()->log (__VA_ARGS__, Log::TYPE_GENERAL);
88 * AudioMapping XML changed.
90 * Subtitle offset changed to subtitle y offset, and subtitle x offset added.
92 * Use <Scale> tag in <VideoContent> rather than <Ratio>.
96 int const Film::current_state_version = 9;
98 /** Construct a Film object in a given directory.
100 * @param dir Film directory.
103 Film::Film (boost::filesystem::path dir, bool log)
104 : _playlist (new Playlist)
105 , _use_isdcf_name (true)
106 , _dcp_content_type (Config::instance()->default_dcp_content_type ())
107 , _container (Config::instance()->default_container ())
108 , _resolution (RESOLUTION_2K)
109 , _scaler (Scaler::from_id ("bicubic"))
110 , _with_subtitles (false)
113 , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
114 , _isdcf_metadata (Config::instance()->default_isdcf_metadata ())
115 , _video_frame_rate (24)
116 , _audio_channels (6)
118 , _sequence_video (true)
120 , _state_version (current_state_version)
123 set_isdcf_date_today ();
125 _playlist->Changed.connect (bind (&Film::playlist_changed, this));
126 _playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2));
128 /* Make state.directory a complete path without ..s (where possible)
129 (Code swiped from Adam Bowen on stackoverflow)
132 boost::filesystem::path p (boost::filesystem::system_complete (dir));
133 boost::filesystem::path result;
134 for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
136 if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
139 result = result.parent_path ();
141 } else if (*i != ".") {
146 set_directory (result);
148 _log.reset (new FileLog (file ("log")));
150 _log.reset (new NullLog);
153 _playlist->set_sequence_video (_sequence_video);
157 Film::video_identifier () const
159 assert (container ());
162 s.imbue (std::locale::classic ());
164 s << container()->id()
165 << "_" << resolution_to_string (_resolution)
166 << "_" << _playlist->video_identifier()
167 << "_" << _video_frame_rate
168 << "_" << scaler()->id()
169 << "_" << j2k_bandwidth();
190 /** @return The path to the directory to write video frame info files to */
191 boost::filesystem::path
192 Film::info_dir () const
194 boost::filesystem::path p;
196 p /= video_identifier ();
200 boost::filesystem::path
201 Film::internal_video_mxf_dir () const
203 return dir ("video");
206 boost::filesystem::path
207 Film::internal_video_mxf_filename () const
209 return video_identifier() + ".mxf";
212 boost::filesystem::path
213 Film::video_mxf_filename () const
215 return filename_safe_name() + "_video.mxf";
218 boost::filesystem::path
219 Film::audio_mxf_filename () const
221 return filename_safe_name() + "_audio.mxf";
225 Film::filename_safe_name () const
227 string const n = name ();
229 for (size_t i = 0; i < n.length(); ++i) {
230 if (isalnum (n[i])) {
240 boost::filesystem::path
241 Film::audio_analysis_dir () const
243 return dir ("analysis");
246 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
250 set_isdcf_date_today ();
252 if (dcp_name().find ("/") != string::npos) {
253 throw BadSettingError (_("name"), _("cannot contain slashes"));
256 /* It seems to make sense to auto-save metadata here, since the make DCP may last
257 a long time, and crashes/power failures are moderately likely.
261 LOG_GENERAL ("DCP-o-matic %1 git %2 using %3", dcpomatic_version, dcpomatic_git_commit, dependency_version_summary());
265 gethostname (buffer, sizeof (buffer));
266 LOG_GENERAL ("Starting to make DCP on %1", buffer);
269 ContentList cl = content ();
270 for (ContentList::const_iterator i = cl.begin(); i != cl.end(); ++i) {
271 LOG_GENERAL ("Content: %1", (*i)->technical_summary());
273 LOG_GENERAL ("DCP video rate %1 fps", video_frame_rate());
274 LOG_GENERAL ("%1 threads", Config::instance()->num_local_encoding_threads());
275 LOG_GENERAL ("J2K bandwidth %1", j2k_bandwidth());
276 #ifdef DCPOMATIC_DEBUG
277 LOG_GENERAL_NC ("DCP-o-matic built in debug mode.");
279 LOG_GENERAL_NC ("DCP-o-matic built in optimised mode.");
282 LOG_GENERAL_NC ("libdcp built in debug mode.");
284 LOG_GENERAL_NC ("libdcp built in optimised mode.");
287 #ifdef DCPOMATIC_WINDOWS
289 info.dwOSVersionInfoSize = sizeof (info);
290 GetVersionEx (&info);
291 LOG_GENERAL ("Windows version %1.%2.%3 SP %4", info.dwMajorVersion, info.dwMinorVersion, info.dwBuildNumber, info.szCSDVersion);
294 LOG_GENERAL ("CPU: %1, %2 processors", cpu_info(), boost::thread::hardware_concurrency ());
295 list<pair<string, string> > const m = mount_info ();
296 for (list<pair<string, string> >::const_iterator i = m.begin(); i != m.end(); ++i) {
297 LOG_GENERAL ("Mount: %1 %2", i->first, i->second);
300 if (container() == 0) {
301 throw MissingSettingError (_("container"));
304 if (content().empty()) {
305 throw StringError (_("You must add some content to the DCP before creating it"));
308 if (dcp_content_type() == 0) {
309 throw MissingSettingError (_("content type"));
312 if (name().empty()) {
313 throw MissingSettingError (_("name"));
316 JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
319 /** Start a job to send our DCP to the configured TMS */
321 Film::send_dcp_to_tms ()
323 shared_ptr<Job> j (new SCPDCPJob (shared_from_this()));
324 JobManager::instance()->add (j);
327 /** Count the number of frames that have been encoded for this film.
328 * @return frame count.
331 Film::encoded_frames () const
333 if (container() == 0) {
338 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (info_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
340 boost::this_thread::interruption_point ();
346 shared_ptr<xmlpp::Document>
347 Film::metadata () const
349 shared_ptr<xmlpp::Document> doc (new xmlpp::Document);
350 xmlpp::Element* root = doc->create_root_node ("Metadata");
352 root->add_child("Version")->add_child_text (raw_convert<string> (current_state_version));
353 root->add_child("Name")->add_child_text (_name);
354 root->add_child("UseISDCFName")->add_child_text (_use_isdcf_name ? "1" : "0");
356 if (_dcp_content_type) {
357 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->isdcf_name ());
361 root->add_child("Container")->add_child_text (_container->id ());
364 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
365 root->add_child("Scaler")->add_child_text (_scaler->id ());
366 root->add_child("WithSubtitles")->add_child_text (_with_subtitles ? "1" : "0");
367 root->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
368 _isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
369 root->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
370 root->add_child("ISDCFDate")->add_child_text (boost::gregorian::to_iso_string (_isdcf_date));
371 root->add_child("AudioChannels")->add_child_text (raw_convert<string> (_audio_channels));
372 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
373 root->add_child("SequenceVideo")->add_child_text (_sequence_video ? "1" : "0");
374 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
375 root->add_child("Signed")->add_child_text (_signed ? "1" : "0");
376 root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
377 root->add_child("Key")->add_child_text (_key.hex ());
378 _playlist->as_xml (root->add_child ("Playlist"));
383 /** Write state to our `metadata' file */
385 Film::write_metadata () const
387 boost::filesystem::create_directories (directory ());
388 shared_ptr<xmlpp::Document> doc = metadata ();
389 doc->write_to_file_formatted (file("metadata.xml").string ());
393 /** Read state from our metadata file.
394 * @return Notes about things that the user should know about, or empty.
397 Film::read_metadata ()
399 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
400 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!"));
403 cxml::Document f ("Metadata");
404 f.read_file (file ("metadata.xml"));
406 _state_version = f.number_child<int> ("Version");
407 if (_state_version > current_state_version) {
408 throw StringError (_("This film was created with a newer version of DCP-o-matic, and it cannot be loaded into this version. Sorry!"));
411 _name = f.string_child ("Name");
412 if (_state_version >= 9) {
413 _use_isdcf_name = f.bool_child ("UseISDCFName");
414 _isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
415 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("ISDCFDate"));
417 _use_isdcf_name = f.bool_child ("UseDCIName");
418 _isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
419 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
423 optional<string> c = f.optional_string_child ("DCPContentType");
425 _dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
430 optional<string> c = f.optional_string_child ("Container");
432 _container = Ratio::from_id (c.get ());
436 _resolution = string_to_resolution (f.string_child ("Resolution"));
437 _scaler = Scaler::from_id (f.string_child ("Scaler"));
438 _with_subtitles = f.bool_child ("WithSubtitles");
439 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
440 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
441 _signed = f.optional_bool_child("Signed").get_value_or (true);
442 _encrypted = f.bool_child ("Encrypted");
443 _audio_channels = f.number_child<int> ("AudioChannels");
444 _sequence_video = f.bool_child ("SequenceVideo");
445 _three_d = f.bool_child ("ThreeD");
446 _interop = f.bool_child ("Interop");
447 _key = libdcp::Key (f.string_child ("Key"));
450 /* This method is the only one that can return notes (so far) */
451 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
457 /** Given a directory name, return its full path within the Film's directory.
458 * The directory (and its parents) will be created if they do not exist.
460 boost::filesystem::path
461 Film::dir (boost::filesystem::path d) const
463 boost::filesystem::path p;
467 boost::filesystem::create_directories (p);
472 /** Given a file or directory name, return its full path within the Film's directory.
473 * Any required parent directories will be created.
475 boost::filesystem::path
476 Film::file (boost::filesystem::path f) const
478 boost::filesystem::path p;
482 boost::filesystem::create_directories (p.parent_path ());
487 /** @return a ISDCF-compliant name for a DCP of this film */
489 Film::isdcf_name (bool if_created_now) const
493 string raw_name = name ();
495 bool cap_next = true;
496 for (size_t i = 0; i < raw_name.length(); ++i) {
497 if (raw_name[i] == ' ') {
499 } else if (cap_next) {
500 fixed_name += toupper (raw_name[i]);
503 fixed_name += tolower (raw_name[i]);
507 if (fixed_name.length() > 14) {
508 fixed_name = fixed_name.substr (0, 14);
513 if (dcp_content_type()) {
514 d << "_" << dcp_content_type()->isdcf_name();
515 d << "-" << isdcf_metadata().content_version;
518 ISDCFMetadata const dm = isdcf_metadata ();
520 if (dm.temp_version) {
524 if (dm.pre_release) {
532 if (!dm.chain.empty ()) {
533 d << "-" << dm.chain;
540 if (dm.two_d_version_of_three_d) {
544 if (!dm.mastered_luminance.empty ()) {
545 d << "-" << dm.mastered_luminance;
548 if (video_frame_rate() != 24) {
549 d << "-" << video_frame_rate();
553 d << "_" << container()->isdcf_name();
556 /* XXX: this only works for content which has been scaled to a given ratio,
557 and uses the first bit of content only.
560 ContentList cl = content ();
561 Ratio const * content_ratio = 0;
562 for (ContentList::const_iterator i = cl.begin(); i != cl.end(); ++i) {
563 shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (*i);
564 if (vc && (content_ratio == 0 || vc->scale().ratio() != content_ratio)) {
565 content_ratio = vc->scale().ratio();
569 if (content_ratio && content_ratio != container()) {
570 d << "-" << content_ratio->isdcf_name();
573 if (!dm.audio_language.empty ()) {
574 d << "_" << dm.audio_language;
575 if (!dm.subtitle_language.empty()) {
576 d << "-" << dm.subtitle_language;
582 if (!dm.territory.empty ()) {
583 d << "_" << dm.territory;
584 if (!dm.rating.empty ()) {
585 d << "-" << dm.rating;
589 switch (audio_channels ()) {
612 d << "_" << resolution_to_string (_resolution);
614 if (!dm.studio.empty ()) {
615 d << "_" << dm.studio;
618 if (if_created_now) {
619 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
621 d << "_" << boost::gregorian::to_iso_string (_isdcf_date);
624 if (!dm.facility.empty ()) {
625 d << "_" << dm.facility;
638 if (!dm.package_type.empty ()) {
639 d << "_" << dm.package_type;
645 /** @return name to give the DCP */
647 Film::dcp_name (bool if_created_now) const
649 if (use_isdcf_name()) {
650 return isdcf_name (if_created_now);
658 Film::set_directory (boost::filesystem::path d)
665 Film::set_name (string n)
668 signal_changed (NAME);
672 Film::set_use_isdcf_name (bool u)
675 signal_changed (USE_ISDCF_NAME);
679 Film::set_dcp_content_type (DCPContentType const * t)
681 _dcp_content_type = t;
682 signal_changed (DCP_CONTENT_TYPE);
686 Film::set_container (Ratio const * c)
689 signal_changed (CONTAINER);
693 Film::set_resolution (Resolution r)
696 signal_changed (RESOLUTION);
700 Film::set_scaler (Scaler const * s)
703 signal_changed (SCALER);
707 Film::set_with_subtitles (bool w)
710 signal_changed (WITH_SUBTITLES);
714 Film::set_j2k_bandwidth (int b)
717 signal_changed (J2K_BANDWIDTH);
721 Film::set_isdcf_metadata (ISDCFMetadata m)
724 signal_changed (ISDCF_METADATA);
728 Film::set_video_frame_rate (int f)
730 _video_frame_rate = f;
731 signal_changed (VIDEO_FRAME_RATE);
735 Film::set_audio_channels (int c)
738 signal_changed (AUDIO_CHANNELS);
742 Film::set_three_d (bool t)
745 signal_changed (THREE_D);
749 Film::set_interop (bool i)
752 signal_changed (INTEROP);
756 Film::signal_changed (Property p)
762 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
764 case Film::VIDEO_FRAME_RATE:
765 case Film::SEQUENCE_VIDEO:
766 _playlist->maybe_sequence_video ();
773 ui_signaller->emit (boost::bind (boost::ref (Changed), p));
778 Film::set_isdcf_date_today ()
780 _isdcf_date = boost::gregorian::day_clock::local_day ();
783 boost::filesystem::path
784 Film::info_path (int f, Eyes e) const
786 boost::filesystem::path p;
791 s << setfill('0') << f;
793 if (e == EYES_LEFT) {
795 } else if (e == EYES_RIGHT) {
803 /* info_dir() will already have added any initial bit of the path,
804 so don't call file() on this.
809 boost::filesystem::path
810 Film::j2c_path (int f, Eyes e, bool t) const
812 boost::filesystem::path p;
814 p /= video_identifier ();
818 s << setfill('0') << f;
820 if (e == EYES_LEFT) {
822 } else if (e == EYES_RIGHT) {
836 /** Find all the DCPs in our directory that can be libdcp::DCP::read() and return details of their CPLs */
840 vector<CPLSummary> out;
842 boost::filesystem::path const dir = directory ();
843 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
845 boost::filesystem::is_directory (*i) &&
846 i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
850 libdcp::DCP dcp (*i);
854 i->path().leaf().string(), dcp.cpls().front()->id(), dcp.cpls().front()->name(), dcp.cpls().front()->filename()
867 Film::make_player () const
869 return shared_ptr<Player> (new Player (shared_from_this (), _playlist));
873 Film::set_signed (bool s)
876 signal_changed (SIGNED);
880 Film::set_encrypted (bool e)
883 signal_changed (ENCRYPTED);
887 Film::playlist () const
893 Film::content () const
895 return _playlist->content ();
899 Film::examine_and_add_content (shared_ptr<Content> c)
901 if (dynamic_pointer_cast<FFmpegContent> (c)) {
902 run_ffprobe (c->path(0), file ("ffprobe.log"), _log);
905 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
906 j->Finished.connect (bind (&Film::maybe_add_content, this, boost::weak_ptr<Job> (j), boost::weak_ptr<Content> (c)));
907 JobManager::instance()->add (j);
911 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
913 shared_ptr<Job> job = j.lock ();
914 if (!job || !job->finished_ok ()) {
918 shared_ptr<Content> content = c.lock ();
920 add_content (content);
925 Film::add_content (shared_ptr<Content> c)
927 /* Add video content after any existing content */
928 if (dynamic_pointer_cast<VideoContent> (c)) {
929 c->set_position (_playlist->video_end ());
936 Film::remove_content (shared_ptr<Content> c)
938 _playlist->remove (c);
942 Film::move_content_earlier (shared_ptr<Content> c)
944 _playlist->move_earlier (c);
948 Film::move_content_later (shared_ptr<Content> c)
950 _playlist->move_later (c);
954 Film::length () const
956 return _playlist->length ();
960 Film::has_subtitles () const
962 return _playlist->has_subtitles ();
966 Film::best_video_frame_rate () const
968 return _playlist->best_dcp_frame_rate ();
972 Film::playlist_content_changed (boost::weak_ptr<Content> c, int p)
974 if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
975 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
979 ui_signaller->emit (boost::bind (boost::ref (ContentChanged), c, p));
984 Film::playlist_changed ()
986 signal_changed (CONTENT);
990 Film::time_to_audio_frames (Time t) const
992 return divide_with_round (t * audio_frame_rate (), TIME_HZ);
996 Film::time_to_video_frames (Time t) const
998 return divide_with_round (t * video_frame_rate (), TIME_HZ);
1002 Film::audio_frames_to_time (OutputAudioFrame f) const
1004 return divide_with_round (f * TIME_HZ, audio_frame_rate ());
1008 Film::video_frames_to_time (OutputVideoFrame f) const
1010 return divide_with_round (f * TIME_HZ, video_frame_rate ());
1014 Film::audio_frame_rate () const
1021 Film::set_sequence_video (bool s)
1023 _sequence_video = s;
1024 _playlist->set_sequence_video (s);
1025 signal_changed (SEQUENCE_VIDEO);
1028 /** @return Size of the largest possible image in whatever resolution we are using */
1030 Film::full_frame () const
1032 switch (_resolution) {
1034 return libdcp::Size (2048, 1080);
1036 return libdcp::Size (4096, 2160);
1040 return libdcp::Size ();
1043 /** @return Size of the frame */
1045 Film::frame_size () const
1047 return fit_ratio_within (container()->ratio(), full_frame ());
1050 /** @param from KDM from time in local time.
1051 * @param to KDM to time in local time.
1055 shared_ptr<libdcp::Certificate> target,
1056 boost::filesystem::path cpl_file,
1057 boost::posix_time::ptime from,
1058 boost::posix_time::ptime until
1061 shared_ptr<const Signer> signer = make_signer ();
1063 time_t now = time (0);
1064 struct tm* tm = localtime (&now);
1065 string const issue_date = libdcp::tm_to_string (tm);
1067 return libdcp::KDM (cpl_file, signer, target, key (), from, until, "DCP-o-matic", issue_date);
1072 list<shared_ptr<Screen> > screens,
1073 boost::filesystem::path dcp,
1074 boost::posix_time::ptime from,
1075 boost::posix_time::ptime until
1078 list<libdcp::KDM> kdms;
1080 for (list<shared_ptr<Screen> >::iterator i = screens.begin(); i != screens.end(); ++i) {
1081 kdms.push_back (make_kdm ((*i)->certificate, dcp, from, until));
1087 /** @return The approximate disk space required to encode a DCP of this film with the
1088 * current settings, in bytes.
1091 Film::required_disk_space () const
1093 return uint64_t (j2k_bandwidth() / 8) * length() / TIME_HZ;
1096 /** This method checks the disk that the Film is on and tries to decide whether or not
1097 * there will be enough space to make a DCP for it. If so, true is returned; if not,
1098 * false is returned and required and availabe are filled in with the amount of disk space
1099 * required and available respectively (in Gb).
1101 * Note: the decision made by this method isn't, of course, 100% reliable.
1104 Film::should_be_enough_disk_space (double& required, double& available) const
1106 boost::filesystem::space_info s = boost::filesystem::space (internal_video_mxf_dir ());
1107 required = double (required_disk_space ()) / 1073741824.0f;
1108 available = double (s.available) / 1073741824.0f;
1109 return (available - required) > 1;
1113 Film::active_frame_rate_change (Time t) const
1115 return _playlist->active_frame_rate_change (t, video_frame_rate ());