2 Copyright (C) 2012-2013 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 <boost/date_time.hpp>
32 #include <libxml++/libxml++.h>
33 #include <libcxml/cxml.h>
34 #include <libdcp/signer_chain.h>
35 #include <libdcp/cpl.h>
36 #include <libdcp/signer.h>
37 #include <libdcp/util.h>
38 #include <libdcp/kdm.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::lexical_cast;
76 using boost::dynamic_pointer_cast;
77 using boost::to_upper_copy;
78 using boost::ends_with;
79 using boost::starts_with;
80 using boost::optional;
85 * AudioMapping XML changed.
87 * Subtitle offset changed to subtitle y offset, and subtitle x offset added.
89 int const Film::current_state_version = 7;
91 /** Construct a Film object in a given directory.
93 * @param dir Film directory.
96 Film::Film (boost::filesystem::path dir, bool log)
97 : _playlist (new Playlist)
98 , _use_dci_name (true)
99 , _dcp_content_type (Config::instance()->default_dcp_content_type ())
100 , _container (Config::instance()->default_container ())
101 , _resolution (RESOLUTION_2K)
102 , _scaler (Scaler::from_id ("bicubic"))
103 , _with_subtitles (false)
106 , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
107 , _dci_metadata (Config::instance()->default_dci_metadata ())
108 , _video_frame_rate (24)
109 , _audio_channels (6)
111 , _sequence_video (true)
113 , _state_version (current_state_version)
116 set_dci_date_today ();
118 _playlist->Changed.connect (bind (&Film::playlist_changed, this));
119 _playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2));
121 /* Make state.directory a complete path without ..s (where possible)
122 (Code swiped from Adam Bowen on stackoverflow)
125 boost::filesystem::path p (boost::filesystem::system_complete (dir));
126 boost::filesystem::path result;
127 for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
129 if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
132 result = result.parent_path ();
134 } else if (*i != ".") {
139 set_directory (result);
141 _log.reset (new FileLog (file ("log")));
143 _log.reset (new NullLog);
146 _playlist->set_sequence_video (_sequence_video);
150 Film::video_identifier () const
152 assert (container ());
156 s << container()->id()
157 << "_" << resolution_to_string (_resolution)
158 << "_" << _playlist->video_identifier()
159 << "_" << _video_frame_rate
160 << "_" << scaler()->id()
161 << "_" << j2k_bandwidth();
182 /** @return The path to the directory to write video frame info files to */
183 boost::filesystem::path
184 Film::info_dir () const
186 boost::filesystem::path p;
188 p /= video_identifier ();
192 boost::filesystem::path
193 Film::internal_video_mxf_dir () const
195 return dir ("video");
198 boost::filesystem::path
199 Film::internal_video_mxf_filename () const
201 return video_identifier() + ".mxf";
204 boost::filesystem::path
205 Film::video_mxf_filename () const
207 return filename_safe_name() + "_video.mxf";
210 boost::filesystem::path
211 Film::audio_mxf_filename () const
213 return filename_safe_name() + "_audio.mxf";
217 Film::filename_safe_name () const
219 string const n = name ();
221 for (size_t i = 0; i < n.length(); ++i) {
222 if (isalnum (n[i])) {
232 boost::filesystem::path
233 Film::audio_analysis_path (shared_ptr<const AudioContent> c) const
235 boost::filesystem::path p = dir ("analysis");
240 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
244 set_dci_date_today ();
246 if (dcp_name().find ("/") != string::npos) {
247 throw BadSettingError (_("name"), _("cannot contain slashes"));
250 log()->log (String::compose ("DCP-o-matic %1 git %2 using %3", dcpomatic_version, dcpomatic_git_commit, dependency_version_summary()));
254 gethostname (buffer, sizeof (buffer));
255 log()->log (String::compose ("Starting to make DCP on %1", buffer));
258 ContentList cl = content ();
259 for (ContentList::const_iterator i = cl.begin(); i != cl.end(); ++i) {
260 log()->log (String::compose ("Content: %1", (*i)->technical_summary()));
262 log()->log (String::compose ("DCP video rate %1 fps", video_frame_rate()));
263 log()->log (String::compose ("%1 threads", Config::instance()->num_local_encoding_threads()));
264 log()->log (String::compose ("J2K bandwidth %1", j2k_bandwidth()));
265 #ifdef DCPOMATIC_DEBUG
266 log()->log ("DCP-o-matic built in debug mode.");
268 log()->log ("DCP-o-matic built in optimised mode.");
271 log()->log ("libdcp built in debug mode.");
273 log()->log ("libdcp built in optimised mode.");
276 #ifdef DCPOMATIC_WINDOWS
278 info.dwOSVersionInfoSize = sizeof (info);
279 GetVersionEx (&info);
280 log()->log (String::compose ("Windows version %1.%2.%3 SP %4", info.dwMajorVersion, info.dwMinorVersion, info.dwBuildNumber, info.szCSDVersion));
283 log()->log (String::compose ("CPU: %1, %2 processors", cpu_info(), boost::thread::hardware_concurrency ()));
284 list<pair<string, string> > const m = mount_info ();
285 for (list<pair<string, string> >::const_iterator i = m.begin(); i != m.end(); ++i) {
286 log()->log (String::compose ("Mount: %1 %2", i->first, i->second));
289 if (container() == 0) {
290 throw MissingSettingError (_("container"));
293 if (content().empty()) {
294 throw StringError (_("You must add some content to the DCP before creating it"));
297 if (dcp_content_type() == 0) {
298 throw MissingSettingError (_("content type"));
301 if (name().empty()) {
302 throw MissingSettingError (_("name"));
305 JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
308 /** Start a job to send our DCP to the configured TMS */
310 Film::send_dcp_to_tms ()
312 shared_ptr<Job> j (new SCPDCPJob (shared_from_this()));
313 JobManager::instance()->add (j);
316 /** Count the number of frames that have been encoded for this film.
317 * @return frame count.
320 Film::encoded_frames () const
322 if (container() == 0) {
327 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (info_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
329 boost::this_thread::interruption_point ();
335 shared_ptr<xmlpp::Document>
336 Film::metadata () const
340 shared_ptr<xmlpp::Document> doc (new xmlpp::Document);
341 xmlpp::Element* root = doc->create_root_node ("Metadata");
343 root->add_child("Version")->add_child_text (lexical_cast<string> (current_state_version));
344 root->add_child("Name")->add_child_text (_name);
345 root->add_child("UseDCIName")->add_child_text (_use_dci_name ? "1" : "0");
347 if (_dcp_content_type) {
348 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->dci_name ());
352 root->add_child("Container")->add_child_text (_container->id ());
355 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
356 root->add_child("Scaler")->add_child_text (_scaler->id ());
357 root->add_child("WithSubtitles")->add_child_text (_with_subtitles ? "1" : "0");
358 root->add_child("J2KBandwidth")->add_child_text (lexical_cast<string> (_j2k_bandwidth));
359 _dci_metadata.as_xml (root->add_child ("DCIMetadata"));
360 root->add_child("VideoFrameRate")->add_child_text (lexical_cast<string> (_video_frame_rate));
361 root->add_child("DCIDate")->add_child_text (boost::gregorian::to_iso_string (_dci_date));
362 root->add_child("AudioChannels")->add_child_text (lexical_cast<string> (_audio_channels));
363 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
364 root->add_child("SequenceVideo")->add_child_text (_sequence_video ? "1" : "0");
365 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
366 root->add_child("Signed")->add_child_text (_signed ? "1" : "0");
367 root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
368 root->add_child("Key")->add_child_text (_key.hex ());
369 _playlist->as_xml (root->add_child ("Playlist"));
374 /** Write state to our `metadata' file */
376 Film::write_metadata () const
378 boost::filesystem::create_directories (directory ());
379 shared_ptr<xmlpp::Document> doc = metadata ();
380 doc->write_to_file_formatted (file("metadata.xml").string ());
384 /** Read state from our metadata file */
386 Film::read_metadata ()
390 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
391 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!"));
394 cxml::Document f ("Metadata");
395 f.read_file (file ("metadata.xml"));
397 _state_version = f.number_child<int> ("Version");
399 _name = f.string_child ("Name");
400 _use_dci_name = f.bool_child ("UseDCIName");
403 optional<string> c = f.optional_string_child ("DCPContentType");
405 _dcp_content_type = DCPContentType::from_dci_name (c.get ());
410 optional<string> c = f.optional_string_child ("Container");
412 _container = Ratio::from_id (c.get ());
416 _resolution = string_to_resolution (f.string_child ("Resolution"));
417 _scaler = Scaler::from_id (f.string_child ("Scaler"));
418 _with_subtitles = f.bool_child ("WithSubtitles");
419 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
420 _dci_metadata = DCIMetadata (f.node_child ("DCIMetadata"));
421 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
422 _dci_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
423 _signed = f.optional_bool_child("Signed").get_value_or (true);
424 _encrypted = f.bool_child ("Encrypted");
425 _audio_channels = f.number_child<int> ("AudioChannels");
426 _sequence_video = f.bool_child ("SequenceVideo");
427 _three_d = f.bool_child ("ThreeD");
428 _interop = f.bool_child ("Interop");
429 _key = libdcp::Key (f.string_child ("Key"));
430 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version);
435 /** Given a directory name, return its full path within the Film's directory.
436 * The directory (and its parents) will be created if they do not exist.
438 boost::filesystem::path
439 Film::dir (boost::filesystem::path d) const
441 boost::filesystem::path p;
445 boost::filesystem::create_directories (p);
450 /** Given a file or directory name, return its full path within the Film's directory.
451 * Any required parent directories will be created.
453 boost::filesystem::path
454 Film::file (boost::filesystem::path f) const
456 boost::filesystem::path p;
460 boost::filesystem::create_directories (p.parent_path ());
465 /** @return a DCI-compliant name for a DCP of this film */
467 Film::dci_name (bool if_created_now) const
471 string fixed_name = to_upper_copy (name());
472 for (size_t i = 0; i < fixed_name.length(); ++i) {
473 if (fixed_name[i] == ' ') {
478 /* Spec is that the name part should be maximum 14 characters, as I understand it */
479 if (fixed_name.length() > 14) {
480 fixed_name = fixed_name.substr (0, 14);
485 if (dcp_content_type()) {
486 d << "_" << dcp_content_type()->dci_name();
487 d << "-" << dci_metadata().content_version;
494 if (video_frame_rate() != 24) {
495 d << "-" << video_frame_rate();
499 d << "_" << container()->dci_name();
502 DCIMetadata const dm = dci_metadata ();
504 if (!dm.audio_language.empty ()) {
505 d << "_" << dm.audio_language;
506 if (!dm.subtitle_language.empty()) {
507 d << "-" << dm.subtitle_language;
513 if (!dm.territory.empty ()) {
514 d << "_" << dm.territory;
515 if (!dm.rating.empty ()) {
516 d << "-" << dm.rating;
520 switch (audio_channels ()) {
541 d << "_" << resolution_to_string (_resolution);
543 if (!dm.studio.empty ()) {
544 d << "_" << dm.studio;
547 if (if_created_now) {
548 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
550 d << "_" << boost::gregorian::to_iso_string (_dci_date);
553 if (!dm.facility.empty ()) {
554 d << "_" << dm.facility;
557 if (!dm.package_type.empty ()) {
558 d << "_" << dm.package_type;
564 /** @return name to give the DCP */
566 Film::dcp_name (bool if_created_now) const
568 if (use_dci_name()) {
569 return dci_name (if_created_now);
577 Film::set_directory (boost::filesystem::path d)
584 Film::set_name (string n)
587 signal_changed (NAME);
591 Film::set_use_dci_name (bool u)
594 signal_changed (USE_DCI_NAME);
598 Film::set_dcp_content_type (DCPContentType const * t)
600 _dcp_content_type = t;
601 signal_changed (DCP_CONTENT_TYPE);
605 Film::set_container (Ratio const * c)
608 signal_changed (CONTAINER);
612 Film::set_resolution (Resolution r)
615 signal_changed (RESOLUTION);
619 Film::set_scaler (Scaler const * s)
622 signal_changed (SCALER);
626 Film::set_with_subtitles (bool w)
629 signal_changed (WITH_SUBTITLES);
633 Film::set_j2k_bandwidth (int b)
636 signal_changed (J2K_BANDWIDTH);
640 Film::set_dci_metadata (DCIMetadata m)
643 signal_changed (DCI_METADATA);
647 Film::set_video_frame_rate (int f)
649 _video_frame_rate = f;
650 signal_changed (VIDEO_FRAME_RATE);
654 Film::set_audio_channels (int c)
657 signal_changed (AUDIO_CHANNELS);
661 Film::set_three_d (bool t)
664 signal_changed (THREE_D);
668 Film::set_interop (bool i)
671 signal_changed (INTEROP);
675 Film::signal_changed (Property p)
681 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
683 case Film::VIDEO_FRAME_RATE:
684 case Film::SEQUENCE_VIDEO:
685 _playlist->maybe_sequence_video ();
692 ui_signaller->emit (boost::bind (boost::ref (Changed), p));
697 Film::set_dci_date_today ()
699 _dci_date = boost::gregorian::day_clock::local_day ();
702 boost::filesystem::path
703 Film::info_path (int f, Eyes e) const
705 boost::filesystem::path p;
710 s << setfill('0') << f;
712 if (e == EYES_LEFT) {
714 } else if (e == EYES_RIGHT) {
722 /* info_dir() will already have added any initial bit of the path,
723 so don't call file() on this.
728 boost::filesystem::path
729 Film::j2c_path (int f, Eyes e, bool t) const
731 boost::filesystem::path p;
733 p /= video_identifier ();
737 s << setfill('0') << f;
739 if (e == EYES_LEFT) {
741 } else if (e == EYES_RIGHT) {
755 /** @return List of subdirectories (not full paths) containing DCPs that can be successfully libdcp::DCP::read() */
756 list<boost::filesystem::path>
759 list<boost::filesystem::path> out;
761 boost::filesystem::path const dir = directory ();
762 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
764 boost::filesystem::is_directory (*i) &&
765 i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
769 libdcp::DCP dcp (*i);
771 out.push_back (i->path().leaf ());
782 Film::make_player () const
784 return shared_ptr<Player> (new Player (shared_from_this (), _playlist));
788 Film::set_signed (bool s)
791 signal_changed (SIGNED);
795 Film::set_encrypted (bool e)
798 signal_changed (ENCRYPTED);
802 Film::playlist () const
808 Film::content () const
810 return _playlist->content ();
814 Film::examine_and_add_content (shared_ptr<Content> c)
816 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
817 j->Finished.connect (bind (&Film::maybe_add_content, this, boost::weak_ptr<Job> (j), boost::weak_ptr<Content> (c)));
818 JobManager::instance()->add (j);
822 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
824 shared_ptr<Job> job = j.lock ();
825 if (!job || !job->finished_ok ()) {
829 shared_ptr<Content> content = c.lock ();
831 add_content (content);
836 Film::add_content (shared_ptr<Content> c)
838 /* Add video content after any existing content */
839 if (dynamic_pointer_cast<VideoContent> (c)) {
840 c->set_position (_playlist->video_end ());
847 Film::remove_content (shared_ptr<Content> c)
849 _playlist->remove (c);
853 Film::move_content_earlier (shared_ptr<Content> c)
855 _playlist->move_earlier (c);
859 Film::move_content_later (shared_ptr<Content> c)
861 _playlist->move_later (c);
865 Film::length () const
867 return _playlist->length ();
871 Film::has_subtitles () const
873 return _playlist->has_subtitles ();
877 Film::best_video_frame_rate () const
879 return _playlist->best_dcp_frame_rate ();
883 Film::playlist_content_changed (boost::weak_ptr<Content> c, int p)
885 if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
886 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
890 ui_signaller->emit (boost::bind (boost::ref (ContentChanged), c, p));
895 Film::playlist_changed ()
897 signal_changed (CONTENT);
901 Film::time_to_audio_frames (Time t) const
903 return t * audio_frame_rate () / TIME_HZ;
907 Film::time_to_video_frames (Time t) const
909 return t * video_frame_rate () / TIME_HZ;
913 Film::audio_frames_to_time (OutputAudioFrame f) const
915 return f * TIME_HZ / audio_frame_rate ();
919 Film::video_frames_to_time (OutputVideoFrame f) const
921 return f * TIME_HZ / video_frame_rate ();
925 Film::audio_frame_rate () const
932 Film::set_sequence_video (bool s)
935 _playlist->set_sequence_video (s);
936 signal_changed (SEQUENCE_VIDEO);
940 Film::full_frame () const
942 switch (_resolution) {
944 return libdcp::Size (2048, 1080);
946 return libdcp::Size (4096, 2160);
950 return libdcp::Size ();
955 shared_ptr<libdcp::Certificate> target,
956 boost::filesystem::path dcp_dir,
957 boost::posix_time::ptime from,
958 boost::posix_time::ptime until
961 shared_ptr<const Signer> signer = make_signer ();
963 libdcp::DCP dcp (dir (dcp_dir.string ()));
968 throw KDMError (_("Could not read DCP to make KDM for"));
971 time_t now = time (0);
972 struct tm* tm = localtime (&now);
973 string const issue_date = libdcp::tm_to_string (tm);
975 dcp.cpls().front()->set_mxf_keys (key ());
977 return libdcp::KDM (dcp.cpls().front(), signer, target, from, until, "DCP-o-matic", issue_date);
982 list<shared_ptr<Screen> > screens,
983 boost::filesystem::path dcp,
984 boost::posix_time::ptime from,
985 boost::posix_time::ptime until
988 list<libdcp::KDM> kdms;
990 for (list<shared_ptr<Screen> >::iterator i = screens.begin(); i != screens.end(); ++i) {
991 kdms.push_back (make_kdm ((*i)->certificate, dcp, from, until));
997 /** @return The approximate disk space required to encode a DCP of this film with the
998 * current settings, in bytes.
1001 Film::required_disk_space () const
1003 return uint64_t (j2k_bandwidth() / 8) * length() / TIME_HZ;
1006 /** This method checks the disk that the Film is on and tries to decide whether or not
1007 * there will be enough space to make a DCP for it. If so, true is returned; if not,
1008 * false is returned and required and availabe are filled in with the amount of disk space
1009 * required and available respectively (in Gb).
1011 * Note: the decision made by this method isn't, of course, 100% reliable.
1014 Film::should_be_enough_disk_space (double& required, double& available) const
1016 boost::filesystem::space_info s = boost::filesystem::space (internal_video_mxf_dir ());
1017 required = double (required_disk_space ()) / 1073741824.0f;
1018 available = double (s.available) / 1073741824.0f;
1019 return (available - required) > 1;