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/lexical_cast.hpp>
31 #include <libxml++/libxml++.h>
32 #include <libcxml/cxml.h>
33 #include <dcp/signer_chain.h>
35 #include <dcp/signer.h>
37 #include <dcp/local_time.h>
38 #include <dcp/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 dcp::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 * Bumped to 32 for 2.0 branch; some times are expressed in Times rather
99 int const Film::current_state_version = 32;
101 /** Construct a Film object in a given directory.
103 * @param dir Film directory.
106 Film::Film (boost::filesystem::path dir, bool log)
107 : _playlist (new Playlist)
108 , _use_isdcf_name (true)
109 , _dcp_content_type (Config::instance()->default_dcp_content_type ())
110 , _container (Config::instance()->default_container ())
111 , _resolution (RESOLUTION_2K)
112 , _scaler (Scaler::from_id ("bicubic"))
113 , _with_subtitles (false)
116 , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
117 , _isdcf_metadata (Config::instance()->default_isdcf_metadata ())
118 , _video_frame_rate (24)
119 , _audio_channels (6)
121 , _sequence_video (true)
123 , _state_version (current_state_version)
126 set_isdcf_date_today ();
128 _playlist->Changed.connect (bind (&Film::playlist_changed, this));
129 _playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2));
131 /* Make state.directory a complete path without ..s (where possible)
132 (Code swiped from Adam Bowen on stackoverflow)
135 boost::filesystem::path p (boost::filesystem::system_complete (dir));
136 boost::filesystem::path result;
137 for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
139 if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
142 result = result.parent_path ();
144 } else if (*i != ".") {
149 set_directory (result);
151 _log.reset (new FileLog (file ("log")));
153 _log.reset (new NullLog);
156 _playlist->set_sequence_video (_sequence_video);
160 Film::video_identifier () const
162 assert (container ());
165 s.imbue (std::locale::classic ());
167 s << container()->id()
168 << "_" << resolution_to_string (_resolution)
169 << "_" << _playlist->video_identifier()
170 << "_" << _video_frame_rate
171 << "_" << scaler()->id()
172 << "_" << j2k_bandwidth();
190 if (_with_subtitles) {
197 /** @return The path to the directory to write video frame info files to */
198 boost::filesystem::path
199 Film::info_dir () const
201 boost::filesystem::path p;
203 p /= video_identifier ();
207 boost::filesystem::path
208 Film::internal_video_mxf_dir () const
210 return dir ("video");
213 boost::filesystem::path
214 Film::internal_video_mxf_filename () const
216 return video_identifier() + ".mxf";
219 boost::filesystem::path
220 Film::video_mxf_filename () const
222 return filename_safe_name() + "_video.mxf";
225 boost::filesystem::path
226 Film::audio_mxf_filename () const
228 return filename_safe_name() + "_audio.mxf";
232 Film::filename_safe_name () const
234 string const n = name ();
236 for (size_t i = 0; i < n.length(); ++i) {
237 if (isalnum (n[i])) {
247 boost::filesystem::path
248 Film::audio_analysis_dir () const
250 return dir ("analysis");
253 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
257 set_isdcf_date_today ();
259 if (dcp_name().find ("/") != string::npos) {
260 throw BadSettingError (_("name"), _("cannot contain slashes"));
263 /* It seems to make sense to auto-save metadata here, since the make DCP may last
264 a long time, and crashes/power failures are moderately likely.
268 LOG_GENERAL ("DCP-o-matic %1 git %2 using %3", dcpomatic_version, dcpomatic_git_commit, dependency_version_summary());
272 gethostname (buffer, sizeof (buffer));
273 LOG_GENERAL ("Starting to make DCP on %1", buffer);
276 ContentList cl = content ();
277 for (ContentList::const_iterator i = cl.begin(); i != cl.end(); ++i) {
278 LOG_GENERAL ("Content: %1", (*i)->technical_summary());
280 LOG_GENERAL ("DCP video rate %1 fps", video_frame_rate());
281 LOG_GENERAL ("%1 threads", Config::instance()->num_local_encoding_threads());
282 LOG_GENERAL ("J2K bandwidth %1", j2k_bandwidth());
283 #ifdef DCPOMATIC_DEBUG
284 LOG_GENERAL_NC ("DCP-o-matic built in debug mode.");
286 LOG_GENERAL_NC ("DCP-o-matic built in optimised mode.");
289 LOG_GENERAL_NC ("libdcp built in debug mode.");
291 LOG_GENERAL_NC ("libdcp built in optimised mode.");
294 #ifdef DCPOMATIC_WINDOWS
296 info.dwOSVersionInfoSize = sizeof (info);
297 GetVersionEx (&info);
298 LOG_GENERAL ("Windows version %1.%2.%3 SP %4", info.dwMajorVersion, info.dwMinorVersion, info.dwBuildNumber, info.szCSDVersion);
301 LOG_GENERAL ("CPU: %1, %2 processors", cpu_info(), boost::thread::hardware_concurrency ());
302 list<pair<string, string> > const m = mount_info ();
303 for (list<pair<string, string> >::const_iterator i = m.begin(); i != m.end(); ++i) {
304 LOG_GENERAL ("Mount: %1 %2", i->first, i->second);
307 if (container() == 0) {
308 throw MissingSettingError (_("container"));
311 if (content().empty()) {
312 throw StringError (_("You must add some content to the DCP before creating it"));
315 if (dcp_content_type() == 0) {
316 throw MissingSettingError (_("content type"));
319 if (name().empty()) {
320 throw MissingSettingError (_("name"));
323 JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
326 /** Start a job to send our DCP to the configured TMS */
328 Film::send_dcp_to_tms ()
330 shared_ptr<Job> j (new SCPDCPJob (shared_from_this()));
331 JobManager::instance()->add (j);
334 /** Count the number of frames that have been encoded for this film.
335 * @return frame count.
338 Film::encoded_frames () const
340 if (container() == 0) {
345 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (info_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
347 boost::this_thread::interruption_point ();
353 shared_ptr<xmlpp::Document>
354 Film::metadata () const
356 shared_ptr<xmlpp::Document> doc (new xmlpp::Document);
357 xmlpp::Element* root = doc->create_root_node ("Metadata");
359 root->add_child("Version")->add_child_text (raw_convert<string> (current_state_version));
360 root->add_child("Name")->add_child_text (_name);
361 root->add_child("UseISDCFName")->add_child_text (_use_isdcf_name ? "1" : "0");
363 if (_dcp_content_type) {
364 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->isdcf_name ());
368 root->add_child("Container")->add_child_text (_container->id ());
371 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
372 root->add_child("Scaler")->add_child_text (_scaler->id ());
373 root->add_child("WithSubtitles")->add_child_text (_with_subtitles ? "1" : "0");
374 root->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
375 _isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
376 root->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
377 root->add_child("ISDCFDate")->add_child_text (boost::gregorian::to_iso_string (_isdcf_date));
378 root->add_child("AudioChannels")->add_child_text (raw_convert<string> (_audio_channels));
379 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
380 root->add_child("SequenceVideo")->add_child_text (_sequence_video ? "1" : "0");
381 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
382 root->add_child("Signed")->add_child_text (_signed ? "1" : "0");
383 root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
384 root->add_child("Key")->add_child_text (_key.hex ());
385 _playlist->as_xml (root->add_child ("Playlist"));
390 /** Write state to our `metadata' file */
392 Film::write_metadata () const
394 boost::filesystem::create_directories (directory ());
395 shared_ptr<xmlpp::Document> doc = metadata ();
396 doc->write_to_file_formatted (file("metadata.xml").string ());
400 /** Read state from our metadata file.
401 * @return Notes about things that the user should know about, or empty.
404 Film::read_metadata ()
406 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
407 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!"));
410 cxml::Document f ("Metadata");
411 f.read_file (file ("metadata.xml"));
413 _state_version = f.number_child<int> ("Version");
414 if (_state_version > current_state_version) {
415 throw StringError (_("This film was created with a newer version of DCP-o-matic, and it cannot be loaded into this version. Sorry!"));
418 _name = f.string_child ("Name");
419 if (_state_version >= 9) {
420 _use_isdcf_name = f.bool_child ("UseISDCFName");
421 _isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
422 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("ISDCFDate"));
424 _use_isdcf_name = f.bool_child ("UseDCIName");
425 _isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
426 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
430 optional<string> c = f.optional_string_child ("DCPContentType");
432 _dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
437 optional<string> c = f.optional_string_child ("Container");
439 _container = Ratio::from_id (c.get ());
443 _resolution = string_to_resolution (f.string_child ("Resolution"));
444 _scaler = Scaler::from_id (f.string_child ("Scaler"));
445 _with_subtitles = f.bool_child ("WithSubtitles");
446 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
447 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
448 _signed = f.optional_bool_child("Signed").get_value_or (true);
449 _encrypted = f.bool_child ("Encrypted");
450 _audio_channels = f.number_child<int> ("AudioChannels");
451 _sequence_video = f.bool_child ("SequenceVideo");
452 _three_d = f.bool_child ("ThreeD");
453 _interop = f.bool_child ("Interop");
454 _key = dcp::Key (f.string_child ("Key"));
457 /* This method is the only one that can return notes (so far) */
458 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
464 /** Given a directory name, return its full path within the Film's directory.
465 * The directory (and its parents) will be created if they do not exist.
467 boost::filesystem::path
468 Film::dir (boost::filesystem::path d) const
470 boost::filesystem::path p;
474 boost::filesystem::create_directories (p);
479 /** Given a file or directory name, return its full path within the Film's directory.
480 * Any required parent directories will be created.
482 boost::filesystem::path
483 Film::file (boost::filesystem::path f) const
485 boost::filesystem::path p;
489 boost::filesystem::create_directories (p.parent_path ());
494 /** @return a ISDCF-compliant name for a DCP of this film */
496 Film::isdcf_name (bool if_created_now) const
500 string raw_name = name ();
502 bool cap_next = true;
503 for (size_t i = 0; i < raw_name.length(); ++i) {
504 if (raw_name[i] == ' ') {
506 } else if (cap_next) {
507 fixed_name += toupper (raw_name[i]);
510 fixed_name += tolower (raw_name[i]);
514 if (fixed_name.length() > 14) {
515 fixed_name = fixed_name.substr (0, 14);
520 if (dcp_content_type()) {
521 d << "_" << dcp_content_type()->isdcf_name();
522 d << "-" << isdcf_metadata().content_version;
525 ISDCFMetadata const dm = isdcf_metadata ();
527 if (dm.temp_version) {
531 if (dm.pre_release) {
539 if (!dm.chain.empty ()) {
540 d << "-" << dm.chain;
547 if (dm.two_d_version_of_three_d) {
551 if (!dm.mastered_luminance.empty ()) {
552 d << "-" << dm.mastered_luminance;
555 if (video_frame_rate() != 24) {
556 d << "-" << video_frame_rate();
560 d << "_" << container()->isdcf_name();
563 /* XXX: this only works for content which has been scaled to a given ratio,
564 and uses the first bit of content only.
567 /* The standard says we don't do this for trailers, for some strange reason */
568 if (dcp_content_type() && dcp_content_type()->libdcp_kind() != dcp::TRAILER) {
569 ContentList cl = content ();
570 Ratio const * content_ratio = 0;
571 for (ContentList::const_iterator i = cl.begin(); i != cl.end(); ++i) {
572 shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (*i);
573 if (vc && (content_ratio == 0 || vc->scale().ratio() != content_ratio)) {
574 content_ratio = vc->scale().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 ()) {
595 d << "-" << dm.rating;
599 switch (audio_channels ()) {
622 d << "_" << resolution_to_string (_resolution);
624 if (!dm.studio.empty ()) {
625 d << "_" << dm.studio;
628 if (if_created_now) {
629 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
631 d << "_" << boost::gregorian::to_iso_string (_isdcf_date);
634 if (!dm.facility.empty ()) {
635 d << "_" << dm.facility;
648 if (!dm.package_type.empty ()) {
649 d << "_" << dm.package_type;
655 /** @return name to give the DCP */
657 Film::dcp_name (bool if_created_now) const
659 if (use_isdcf_name()) {
660 return isdcf_name (if_created_now);
668 Film::set_directory (boost::filesystem::path d)
675 Film::set_name (string n)
678 signal_changed (NAME);
682 Film::set_use_isdcf_name (bool u)
685 signal_changed (USE_ISDCF_NAME);
689 Film::set_dcp_content_type (DCPContentType const * t)
691 _dcp_content_type = t;
692 signal_changed (DCP_CONTENT_TYPE);
696 Film::set_container (Ratio const * c)
699 signal_changed (CONTAINER);
703 Film::set_resolution (Resolution r)
706 signal_changed (RESOLUTION);
710 Film::set_scaler (Scaler const * s)
713 signal_changed (SCALER);
717 Film::set_with_subtitles (bool w)
720 signal_changed (WITH_SUBTITLES);
724 Film::set_j2k_bandwidth (int b)
727 signal_changed (J2K_BANDWIDTH);
731 Film::set_isdcf_metadata (ISDCFMetadata m)
734 signal_changed (ISDCF_METADATA);
738 Film::set_video_frame_rate (int f)
740 _video_frame_rate = f;
741 signal_changed (VIDEO_FRAME_RATE);
745 Film::set_audio_channels (int c)
748 signal_changed (AUDIO_CHANNELS);
752 Film::set_three_d (bool t)
755 signal_changed (THREE_D);
759 Film::set_interop (bool i)
762 signal_changed (INTEROP);
766 Film::signal_changed (Property p)
772 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
774 case Film::VIDEO_FRAME_RATE:
775 case Film::SEQUENCE_VIDEO:
776 _playlist->maybe_sequence_video ();
783 ui_signaller->emit (boost::bind (boost::ref (Changed), p));
788 Film::set_isdcf_date_today ()
790 _isdcf_date = boost::gregorian::day_clock::local_day ();
793 boost::filesystem::path
794 Film::info_path (int f, Eyes e) const
796 boost::filesystem::path p;
801 s << setfill('0') << f;
803 if (e == EYES_LEFT) {
805 } else if (e == EYES_RIGHT) {
813 /* info_dir() will already have added any initial bit of the path,
814 so don't call file() on this.
819 boost::filesystem::path
820 Film::j2c_path (int f, Eyes e, bool t) const
822 boost::filesystem::path p;
824 p /= video_identifier ();
828 s << setfill('0') << f;
830 if (e == EYES_LEFT) {
832 } else if (e == EYES_RIGHT) {
846 /** Find all the DCPs in our directory that can be libdcp::DCP::read() and return details of their CPLs */
850 vector<CPLSummary> out;
852 boost::filesystem::path const dir = directory ();
853 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
855 boost::filesystem::is_directory (*i) &&
856 i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
864 i->path().leaf().string(),
865 dcp.cpls().front()->id(),
866 dcp.cpls().front()->annotation_text(),
867 dcp.cpls().front()->file()
880 Film::make_player () const
882 return shared_ptr<Player> (new Player (shared_from_this (), _playlist));
886 Film::set_signed (bool s)
889 signal_changed (SIGNED);
893 Film::set_encrypted (bool e)
896 signal_changed (ENCRYPTED);
900 Film::playlist () const
906 Film::content () const
908 return _playlist->content ();
912 Film::examine_and_add_content (shared_ptr<Content> c)
914 if (dynamic_pointer_cast<FFmpegContent> (c)) {
915 run_ffprobe (c->path(0), file ("ffprobe.log"), _log);
918 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
919 j->Finished.connect (bind (&Film::maybe_add_content, this, boost::weak_ptr<Job> (j), boost::weak_ptr<Content> (c)));
920 JobManager::instance()->add (j);
924 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
926 shared_ptr<Job> job = j.lock ();
927 if (!job || !job->finished_ok ()) {
931 shared_ptr<Content> content = c.lock ();
933 add_content (content);
938 Film::add_content (shared_ptr<Content> c)
940 /* Add video content after any existing content */
941 if (dynamic_pointer_cast<VideoContent> (c)) {
942 c->set_position (_playlist->video_end ());
949 Film::remove_content (shared_ptr<Content> c)
951 _playlist->remove (c);
955 Film::move_content_earlier (shared_ptr<Content> c)
957 _playlist->move_earlier (c);
961 Film::move_content_later (shared_ptr<Content> c)
963 _playlist->move_later (c);
967 Film::length () const
969 return _playlist->length ();
973 Film::has_subtitles () const
975 return _playlist->has_subtitles ();
979 Film::best_video_frame_rate () const
981 return _playlist->best_dcp_frame_rate ();
985 Film::active_frame_rate_change (DCPTime t) const
987 return _playlist->active_frame_rate_change (t, video_frame_rate ());
991 Film::playlist_content_changed (boost::weak_ptr<Content> c, int p)
993 if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
994 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
998 ui_signaller->emit (boost::bind (boost::ref (ContentChanged), c, p));
1003 Film::playlist_changed ()
1005 signal_changed (CONTENT);
1009 Film::audio_frame_rate () const
1016 Film::set_sequence_video (bool s)
1018 _sequence_video = s;
1019 _playlist->set_sequence_video (s);
1020 signal_changed (SEQUENCE_VIDEO);
1023 /** @return Size of the largest possible image in whatever resolution we are using */
1025 Film::full_frame () const
1027 switch (_resolution) {
1029 return dcp::Size (2048, 1080);
1031 return dcp::Size (4096, 2160);
1035 return dcp::Size ();
1038 /** @return Size of the frame */
1040 Film::frame_size () const
1042 return fit_ratio_within (container()->ratio(), full_frame ());
1047 shared_ptr<dcp::Certificate> target,
1048 boost::filesystem::path cpl_file,
1049 dcp::LocalTime from,
1050 dcp::LocalTime until
1053 shared_ptr<const dcp::CPL> cpl (new dcp::CPL (cpl_file));
1054 return dcp::DecryptedKDM (
1055 cpl, from, until, "DCP-o-matic", cpl->content_title_text(), dcp::LocalTime().as_string()
1056 ).encrypt (make_signer(), target);
1059 list<dcp::EncryptedKDM>
1061 list<shared_ptr<Screen> > screens,
1062 boost::filesystem::path dcp,
1063 dcp::LocalTime from,
1064 dcp::LocalTime until
1067 list<dcp::EncryptedKDM> kdms;
1069 for (list<shared_ptr<Screen> >::iterator i = screens.begin(); i != screens.end(); ++i) {
1070 kdms.push_back (make_kdm ((*i)->certificate, dcp, from, until));
1076 /** @return The approximate disk space required to encode a DCP of this film with the
1077 * current settings, in bytes.
1080 Film::required_disk_space () const
1082 return uint64_t (j2k_bandwidth() / 8) * length().seconds();
1085 /** This method checks the disk that the Film is on and tries to decide whether or not
1086 * there will be enough space to make a DCP for it. If so, true is returned; if not,
1087 * false is returned and required and availabe are filled in with the amount of disk space
1088 * required and available respectively (in Gb).
1090 * Note: the decision made by this method isn't, of course, 100% reliable.
1093 Film::should_be_enough_disk_space (double& required, double& available) const
1095 boost::filesystem::space_info s = boost::filesystem::space (internal_video_mxf_dir ());
1096 required = double (required_disk_space ()) / 1073741824.0f;
1097 available = double (s.available) / 1073741824.0f;
1098 return (available - required) > 1;