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::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)
115 set_dci_date_today ();
117 _playlist->Changed.connect (bind (&Film::playlist_changed, this));
118 _playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2));
120 /* Make state.directory a complete path without ..s (where possible)
121 (Code swiped from Adam Bowen on stackoverflow)
124 boost::filesystem::path p (boost::filesystem::system_complete (dir));
125 boost::filesystem::path result;
126 for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
128 if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
131 result = result.parent_path ();
133 } else if (*i != ".") {
138 set_directory (result);
140 _log.reset (new FileLog (file ("log")));
142 _log.reset (new NullLog);
145 _playlist->set_sequence_video (_sequence_video);
149 Film::video_identifier () const
151 assert (container ());
155 s << container()->id()
156 << "_" << resolution_to_string (_resolution)
157 << "_" << _playlist->video_identifier()
158 << "_" << _video_frame_rate
159 << "_" << scaler()->id()
160 << "_" << j2k_bandwidth();
181 /** @return The path to the directory to write video frame info files to */
182 boost::filesystem::path
183 Film::info_dir () const
185 boost::filesystem::path p;
187 p /= video_identifier ();
191 boost::filesystem::path
192 Film::internal_video_mxf_dir () const
194 return dir ("video");
197 boost::filesystem::path
198 Film::internal_video_mxf_filename () const
200 return video_identifier() + ".mxf";
203 boost::filesystem::path
204 Film::video_mxf_filename () const
206 return filename_safe_name() + "_video.mxf";
209 boost::filesystem::path
210 Film::audio_mxf_filename () const
212 return filename_safe_name() + "_audio.mxf";
216 Film::filename_safe_name () const
218 string const n = name ();
220 for (size_t i = 0; i < n.length(); ++i) {
221 if (isalnum (n[i])) {
231 boost::filesystem::path
232 Film::audio_analysis_path (shared_ptr<const AudioContent> c) const
234 boost::filesystem::path p = dir ("analysis");
239 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
243 set_dci_date_today ();
245 if (dcp_name().find ("/") != string::npos) {
246 throw BadSettingError (_("name"), _("cannot contain slashes"));
249 log()->log (String::compose ("DCP-o-matic %1 git %2 using %3", dcpomatic_version, dcpomatic_git_commit, dependency_version_summary()));
253 gethostname (buffer, sizeof (buffer));
254 log()->log (String::compose ("Starting to make DCP on %1", buffer));
257 ContentList cl = content ();
258 for (ContentList::const_iterator i = cl.begin(); i != cl.end(); ++i) {
259 log()->log (String::compose ("Content: %1", (*i)->technical_summary()));
261 log()->log (String::compose ("DCP video rate %1 fps", video_frame_rate()));
262 log()->log (String::compose ("%1 threads", Config::instance()->num_local_encoding_threads()));
263 log()->log (String::compose ("J2K bandwidth %1", j2k_bandwidth()));
264 #ifdef DCPOMATIC_DEBUG
265 log()->log ("DCP-o-matic built in debug mode.");
267 log()->log ("DCP-o-matic built in optimised mode.");
270 log()->log ("libdcp built in debug mode.");
272 log()->log ("libdcp built in optimised mode.");
275 #ifdef DCPOMATIC_WINDOWS
277 info.dwOSVersionInfoSize = sizeof (info);
278 GetVersionEx (&info);
279 log()->log (String::compose ("Windows version %1.%2.%3 SP %4", info.dwMajorVersion, info.dwMinorVersion, info.dwBuildNumber, info.szCSDVersion));
282 log()->log (String::compose ("CPU: %1, %2 processors", cpu_info(), boost::thread::hardware_concurrency ()));
283 list<pair<string, string> > const m = mount_info ();
284 for (list<pair<string, string> >::const_iterator i = m.begin(); i != m.end(); ++i) {
285 log()->log (String::compose ("Mount: %1 %2", i->first, i->second));
288 if (container() == 0) {
289 throw MissingSettingError (_("container"));
292 if (content().empty()) {
293 throw StringError (_("You must add some content to the DCP before creating it"));
296 if (dcp_content_type() == 0) {
297 throw MissingSettingError (_("content type"));
300 if (name().empty()) {
301 throw MissingSettingError (_("name"));
304 JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
307 /** Start a job to send our DCP to the configured TMS */
309 Film::send_dcp_to_tms ()
311 shared_ptr<Job> j (new SCPDCPJob (shared_from_this()));
312 JobManager::instance()->add (j);
315 /** Count the number of frames that have been encoded for this film.
316 * @return frame count.
319 Film::encoded_frames () const
321 if (container() == 0) {
326 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (info_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
328 boost::this_thread::interruption_point ();
334 shared_ptr<xmlpp::Document>
335 Film::metadata () const
339 shared_ptr<xmlpp::Document> doc (new xmlpp::Document);
340 xmlpp::Element* root = doc->create_root_node ("Metadata");
342 root->add_child("Version")->add_child_text (lexical_cast<string> (state_version));
343 root->add_child("Name")->add_child_text (_name);
344 root->add_child("UseDCIName")->add_child_text (_use_dci_name ? "1" : "0");
346 if (_dcp_content_type) {
347 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->dci_name ());
351 root->add_child("Container")->add_child_text (_container->id ());
354 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
355 root->add_child("Scaler")->add_child_text (_scaler->id ());
356 root->add_child("WithSubtitles")->add_child_text (_with_subtitles ? "1" : "0");
357 root->add_child("J2KBandwidth")->add_child_text (lexical_cast<string> (_j2k_bandwidth));
358 _dci_metadata.as_xml (root->add_child ("DCIMetadata"));
359 root->add_child("VideoFrameRate")->add_child_text (lexical_cast<string> (_video_frame_rate));
360 root->add_child("DCIDate")->add_child_text (boost::gregorian::to_iso_string (_dci_date));
361 root->add_child("AudioChannels")->add_child_text (lexical_cast<string> (_audio_channels));
362 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
363 root->add_child("SequenceVideo")->add_child_text (_sequence_video ? "1" : "0");
364 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
365 root->add_child("Signed")->add_child_text (_signed ? "1" : "0");
366 root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
367 root->add_child("Key")->add_child_text (_key.hex ());
368 _playlist->as_xml (root->add_child ("Playlist"));
373 /** Write state to our `metadata' file */
375 Film::write_metadata () const
377 boost::filesystem::create_directories (directory ());
378 shared_ptr<xmlpp::Document> doc = metadata ();
379 doc->write_to_file_formatted (file("metadata.xml").string ());
383 /** Read state from our metadata file */
385 Film::read_metadata ()
389 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
390 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!"));
393 cxml::Document f ("Metadata");
394 f.read_file (file ("metadata.xml"));
396 int const version = f.number_child<int> ("Version");
398 _name = f.string_child ("Name");
399 _use_dci_name = f.bool_child ("UseDCIName");
402 optional<string> c = f.optional_string_child ("DCPContentType");
404 _dcp_content_type = DCPContentType::from_dci_name (c.get ());
409 optional<string> c = f.optional_string_child ("Container");
411 _container = Ratio::from_id (c.get ());
415 _resolution = string_to_resolution (f.string_child ("Resolution"));
416 _scaler = Scaler::from_id (f.string_child ("Scaler"));
417 _with_subtitles = f.bool_child ("WithSubtitles");
418 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
419 _dci_metadata = DCIMetadata (f.node_child ("DCIMetadata"));
420 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
421 _dci_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
422 _signed = f.optional_bool_child("Signed").get_value_or (true);
423 _encrypted = f.bool_child ("Encrypted");
424 _audio_channels = f.number_child<int> ("AudioChannels");
425 _sequence_video = f.bool_child ("SequenceVideo");
426 _three_d = f.bool_child ("ThreeD");
427 _interop = f.bool_child ("Interop");
428 _key = libdcp::Key (f.string_child ("Key"));
429 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), version);
434 /** Given a directory name, return its full path within the Film's directory.
435 * The directory (and its parents) will be created if they do not exist.
437 boost::filesystem::path
438 Film::dir (boost::filesystem::path d) const
440 boost::filesystem::path p;
444 boost::filesystem::create_directories (p);
449 /** Given a file or directory name, return its full path within the Film's directory.
450 * Any required parent directories will be created.
452 boost::filesystem::path
453 Film::file (boost::filesystem::path f) const
455 boost::filesystem::path p;
459 boost::filesystem::create_directories (p.parent_path ());
464 /** @return a DCI-compliant name for a DCP of this film */
466 Film::dci_name (bool if_created_now) const
470 string fixed_name = to_upper_copy (name());
471 for (size_t i = 0; i < fixed_name.length(); ++i) {
472 if (fixed_name[i] == ' ') {
477 /* Spec is that the name part should be maximum 14 characters, as I understand it */
478 if (fixed_name.length() > 14) {
479 fixed_name = fixed_name.substr (0, 14);
484 if (dcp_content_type()) {
485 d << "_" << dcp_content_type()->dci_name();
486 d << "-" << dci_metadata().content_version;
493 if (video_frame_rate() != 24) {
494 d << "-" << video_frame_rate();
498 d << "_" << container()->dci_name();
501 DCIMetadata const dm = dci_metadata ();
503 if (!dm.audio_language.empty ()) {
504 d << "_" << dm.audio_language;
505 if (!dm.subtitle_language.empty()) {
506 d << "-" << dm.subtitle_language;
512 if (!dm.territory.empty ()) {
513 d << "_" << dm.territory;
514 if (!dm.rating.empty ()) {
515 d << "-" << dm.rating;
519 switch (audio_channels ()) {
540 d << "_" << resolution_to_string (_resolution);
542 if (!dm.studio.empty ()) {
543 d << "_" << dm.studio;
546 if (if_created_now) {
547 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
549 d << "_" << boost::gregorian::to_iso_string (_dci_date);
552 if (!dm.facility.empty ()) {
553 d << "_" << dm.facility;
556 if (!dm.package_type.empty ()) {
557 d << "_" << dm.package_type;
563 /** @return name to give the DCP */
565 Film::dcp_name (bool if_created_now) const
567 if (use_dci_name()) {
568 return dci_name (if_created_now);
576 Film::set_directory (boost::filesystem::path d)
583 Film::set_name (string n)
586 signal_changed (NAME);
590 Film::set_use_dci_name (bool u)
593 signal_changed (USE_DCI_NAME);
597 Film::set_dcp_content_type (DCPContentType const * t)
599 _dcp_content_type = t;
600 signal_changed (DCP_CONTENT_TYPE);
604 Film::set_container (Ratio const * c)
607 signal_changed (CONTAINER);
611 Film::set_resolution (Resolution r)
614 signal_changed (RESOLUTION);
618 Film::set_scaler (Scaler const * s)
621 signal_changed (SCALER);
625 Film::set_with_subtitles (bool w)
628 signal_changed (WITH_SUBTITLES);
632 Film::set_j2k_bandwidth (int b)
635 signal_changed (J2K_BANDWIDTH);
639 Film::set_dci_metadata (DCIMetadata m)
642 signal_changed (DCI_METADATA);
646 Film::set_video_frame_rate (int f)
648 _video_frame_rate = f;
649 signal_changed (VIDEO_FRAME_RATE);
653 Film::set_audio_channels (int c)
656 signal_changed (AUDIO_CHANNELS);
660 Film::set_three_d (bool t)
663 signal_changed (THREE_D);
667 Film::set_interop (bool i)
670 signal_changed (INTEROP);
674 Film::signal_changed (Property p)
680 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
682 case Film::VIDEO_FRAME_RATE:
683 case Film::SEQUENCE_VIDEO:
684 _playlist->maybe_sequence_video ();
691 ui_signaller->emit (boost::bind (boost::ref (Changed), p));
696 Film::set_dci_date_today ()
698 _dci_date = boost::gregorian::day_clock::local_day ();
701 boost::filesystem::path
702 Film::info_path (int f, Eyes e) const
704 boost::filesystem::path p;
709 s << setfill('0') << f;
711 if (e == EYES_LEFT) {
713 } else if (e == EYES_RIGHT) {
721 /* info_dir() will already have added any initial bit of the path,
722 so don't call file() on this.
727 boost::filesystem::path
728 Film::j2c_path (int f, Eyes e, bool t) const
730 boost::filesystem::path p;
732 p /= video_identifier ();
736 s << setfill('0') << f;
738 if (e == EYES_LEFT) {
740 } else if (e == EYES_RIGHT) {
754 /** @return List of subdirectories (not full paths) containing DCPs that can be successfully libdcp::DCP::read() */
755 list<boost::filesystem::path>
758 list<boost::filesystem::path> out;
760 boost::filesystem::path const dir = directory ();
761 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
763 boost::filesystem::is_directory (*i) &&
764 i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
768 libdcp::DCP dcp (*i);
770 out.push_back (i->path().leaf ());
781 Film::make_player () const
783 return shared_ptr<Player> (new Player (shared_from_this (), _playlist));
787 Film::set_signed (bool s)
790 signal_changed (SIGNED);
794 Film::set_encrypted (bool e)
797 signal_changed (ENCRYPTED);
801 Film::playlist () const
807 Film::content () const
809 return _playlist->content ();
813 Film::examine_and_add_content (shared_ptr<Content> c)
815 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
816 j->Finished.connect (bind (&Film::maybe_add_content, this, boost::weak_ptr<Job> (j), boost::weak_ptr<Content> (c)));
817 JobManager::instance()->add (j);
821 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
823 shared_ptr<Job> job = j.lock ();
824 if (!job || !job->finished_ok ()) {
828 shared_ptr<Content> content = c.lock ();
830 add_content (content);
835 Film::add_content (shared_ptr<Content> c)
837 /* Add video content after any existing content */
838 if (dynamic_pointer_cast<VideoContent> (c)) {
839 c->set_position (_playlist->video_end ());
846 Film::remove_content (shared_ptr<Content> c)
848 _playlist->remove (c);
852 Film::move_content_earlier (shared_ptr<Content> c)
854 _playlist->move_earlier (c);
858 Film::move_content_later (shared_ptr<Content> c)
860 _playlist->move_later (c);
864 Film::length () const
866 return _playlist->length ();
870 Film::has_subtitles () const
872 return _playlist->has_subtitles ();
876 Film::best_video_frame_rate () const
878 return _playlist->best_dcp_frame_rate ();
882 Film::playlist_content_changed (boost::weak_ptr<Content> c, int p)
884 if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
885 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
889 ui_signaller->emit (boost::bind (boost::ref (ContentChanged), c, p));
894 Film::playlist_changed ()
896 signal_changed (CONTENT);
900 Film::time_to_audio_frames (Time t) const
902 return t * audio_frame_rate () / TIME_HZ;
906 Film::time_to_video_frames (Time t) const
908 return t * video_frame_rate () / TIME_HZ;
912 Film::audio_frames_to_time (OutputAudioFrame f) const
914 return f * TIME_HZ / audio_frame_rate ();
918 Film::video_frames_to_time (OutputVideoFrame f) const
920 return f * TIME_HZ / video_frame_rate ();
924 Film::audio_frame_rate () const
931 Film::set_sequence_video (bool s)
934 _playlist->set_sequence_video (s);
935 signal_changed (SEQUENCE_VIDEO);
939 Film::full_frame () const
941 switch (_resolution) {
943 return libdcp::Size (2048, 1080);
945 return libdcp::Size (4096, 2160);
949 return libdcp::Size ();
954 shared_ptr<libdcp::Certificate> target,
955 boost::filesystem::path dcp_dir,
956 boost::posix_time::ptime from,
957 boost::posix_time::ptime until
960 shared_ptr<const Signer> signer = make_signer ();
962 libdcp::DCP dcp (dir (dcp_dir.string ()));
967 throw KDMError (_("Could not read DCP to make KDM for"));
970 time_t now = time (0);
971 struct tm* tm = localtime (&now);
972 string const issue_date = libdcp::tm_to_string (tm);
974 dcp.cpls().front()->set_mxf_keys (key ());
976 return libdcp::KDM (dcp.cpls().front(), signer, target, from, until, "DCP-o-matic", issue_date);
981 list<shared_ptr<Screen> > screens,
982 boost::filesystem::path dcp,
983 boost::posix_time::ptime from,
984 boost::posix_time::ptime until
987 list<libdcp::KDM> kdms;
989 for (list<shared_ptr<Screen> >::iterator i = screens.begin(); i != screens.end(); ++i) {
990 kdms.push_back (make_kdm ((*i)->certificate, dcp, from, until));
996 /** @return The approximate disk space required to encode a DCP of this film with the
997 * current settings, in bytes.
1000 Film::required_disk_space () const
1002 return uint64_t (j2k_bandwidth() / 8) * length() / TIME_HZ;
1005 /** This method checks the disk that the Film is on and tries to decide whether or not
1006 * there will be enough space to make a DCP for it. If so, true is returned; if not,
1007 * false is returned and required and availabe are filled in with the amount of disk space
1008 * required and available respectively (in Gb).
1010 * Note: the decision made by this method isn't, of course, 100% reliable.
1013 Film::should_be_enough_disk_space (double& required, double& available) const
1015 boost::filesystem::space_info s = boost::filesystem::space (internal_video_mxf_dir ());
1016 required = double (required_disk_space ()) / 1073741824.0f;
1017 available = double (s.available) / 1073741824.0f;
1018 return (available - required) > 1;