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 * Use <Scale> tag in <VideoContent> rather than <Ratio>.
91 int const Film::current_state_version = 8;
93 /** Construct a Film object in a given directory.
95 * @param dir Film directory.
98 Film::Film (boost::filesystem::path dir, bool log)
99 : _playlist (new Playlist)
100 , _use_dci_name (true)
101 , _dcp_content_type (Config::instance()->default_dcp_content_type ())
102 , _container (Config::instance()->default_container ())
103 , _resolution (RESOLUTION_2K)
104 , _scaler (Scaler::from_id ("bicubic"))
105 , _with_subtitles (false)
108 , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
109 , _dci_metadata (Config::instance()->default_dci_metadata ())
110 , _video_frame_rate (24)
111 , _audio_channels (6)
113 , _sequence_video (true)
115 , _state_version (current_state_version)
118 set_dci_date_today ();
120 _playlist->Changed.connect (bind (&Film::playlist_changed, this));
121 _playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2));
123 /* Make state.directory a complete path without ..s (where possible)
124 (Code swiped from Adam Bowen on stackoverflow)
127 boost::filesystem::path p (boost::filesystem::system_complete (dir));
128 boost::filesystem::path result;
129 for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
131 if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
134 result = result.parent_path ();
136 } else if (*i != ".") {
141 set_directory (result);
143 _log.reset (new FileLog (file ("log")));
145 _log.reset (new NullLog);
148 _playlist->set_sequence_video (_sequence_video);
152 Film::video_identifier () const
154 assert (container ());
158 s << container()->id()
159 << "_" << resolution_to_string (_resolution)
160 << "_" << _playlist->video_identifier()
161 << "_" << _video_frame_rate
162 << "_" << scaler()->id()
163 << "_" << j2k_bandwidth();
184 /** @return The path to the directory to write video frame info files to */
185 boost::filesystem::path
186 Film::info_dir () const
188 boost::filesystem::path p;
190 p /= video_identifier ();
194 boost::filesystem::path
195 Film::internal_video_mxf_dir () const
197 return dir ("video");
200 boost::filesystem::path
201 Film::internal_video_mxf_filename () const
203 return video_identifier() + ".mxf";
206 boost::filesystem::path
207 Film::video_mxf_filename () const
209 return filename_safe_name() + "_video.mxf";
212 boost::filesystem::path
213 Film::audio_mxf_filename () const
215 return filename_safe_name() + "_audio.mxf";
219 Film::filename_safe_name () const
221 string const n = name ();
223 for (size_t i = 0; i < n.length(); ++i) {
224 if (isalnum (n[i])) {
234 boost::filesystem::path
235 Film::audio_analysis_path (shared_ptr<const AudioContent> c) const
237 boost::filesystem::path p = dir ("analysis");
242 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
246 set_dci_date_today ();
248 if (dcp_name().find ("/") != string::npos) {
249 throw BadSettingError (_("name"), _("cannot contain slashes"));
252 log()->log (String::compose ("DCP-o-matic %1 git %2 using %3", dcpomatic_version, dcpomatic_git_commit, dependency_version_summary()));
256 gethostname (buffer, sizeof (buffer));
257 log()->log (String::compose ("Starting to make DCP on %1", buffer));
260 ContentList cl = content ();
261 for (ContentList::const_iterator i = cl.begin(); i != cl.end(); ++i) {
262 log()->log (String::compose ("Content: %1", (*i)->technical_summary()));
264 log()->log (String::compose ("DCP video rate %1 fps", video_frame_rate()));
265 log()->log (String::compose ("%1 threads", Config::instance()->num_local_encoding_threads()));
266 log()->log (String::compose ("J2K bandwidth %1", j2k_bandwidth()));
267 #ifdef DCPOMATIC_DEBUG
268 log()->log ("DCP-o-matic built in debug mode.");
270 log()->log ("DCP-o-matic built in optimised mode.");
273 log()->log ("libdcp built in debug mode.");
275 log()->log ("libdcp built in optimised mode.");
278 #ifdef DCPOMATIC_WINDOWS
280 info.dwOSVersionInfoSize = sizeof (info);
281 GetVersionEx (&info);
282 log()->log (String::compose ("Windows version %1.%2.%3 SP %4", info.dwMajorVersion, info.dwMinorVersion, info.dwBuildNumber, info.szCSDVersion));
285 log()->log (String::compose ("CPU: %1, %2 processors", cpu_info(), boost::thread::hardware_concurrency ()));
286 list<pair<string, string> > const m = mount_info ();
287 for (list<pair<string, string> >::const_iterator i = m.begin(); i != m.end(); ++i) {
288 log()->log (String::compose ("Mount: %1 %2", i->first, i->second));
291 if (container() == 0) {
292 throw MissingSettingError (_("container"));
295 if (content().empty()) {
296 throw StringError (_("You must add some content to the DCP before creating it"));
299 if (dcp_content_type() == 0) {
300 throw MissingSettingError (_("content type"));
303 if (name().empty()) {
304 throw MissingSettingError (_("name"));
307 JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
310 /** Start a job to send our DCP to the configured TMS */
312 Film::send_dcp_to_tms ()
314 shared_ptr<Job> j (new SCPDCPJob (shared_from_this()));
315 JobManager::instance()->add (j);
318 /** Count the number of frames that have been encoded for this film.
319 * @return frame count.
322 Film::encoded_frames () const
324 if (container() == 0) {
329 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (info_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
331 boost::this_thread::interruption_point ();
337 shared_ptr<xmlpp::Document>
338 Film::metadata () const
342 shared_ptr<xmlpp::Document> doc (new xmlpp::Document);
343 xmlpp::Element* root = doc->create_root_node ("Metadata");
345 root->add_child("Version")->add_child_text (lexical_cast<string> (current_state_version));
346 root->add_child("Name")->add_child_text (_name);
347 root->add_child("UseDCIName")->add_child_text (_use_dci_name ? "1" : "0");
349 if (_dcp_content_type) {
350 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->dci_name ());
354 root->add_child("Container")->add_child_text (_container->id ());
357 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
358 root->add_child("Scaler")->add_child_text (_scaler->id ());
359 root->add_child("WithSubtitles")->add_child_text (_with_subtitles ? "1" : "0");
360 root->add_child("J2KBandwidth")->add_child_text (lexical_cast<string> (_j2k_bandwidth));
361 _dci_metadata.as_xml (root->add_child ("DCIMetadata"));
362 root->add_child("VideoFrameRate")->add_child_text (lexical_cast<string> (_video_frame_rate));
363 root->add_child("DCIDate")->add_child_text (boost::gregorian::to_iso_string (_dci_date));
364 root->add_child("AudioChannels")->add_child_text (lexical_cast<string> (_audio_channels));
365 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
366 root->add_child("SequenceVideo")->add_child_text (_sequence_video ? "1" : "0");
367 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
368 root->add_child("Signed")->add_child_text (_signed ? "1" : "0");
369 root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
370 root->add_child("Key")->add_child_text (_key.hex ());
371 _playlist->as_xml (root->add_child ("Playlist"));
376 /** Write state to our `metadata' file */
378 Film::write_metadata () const
380 boost::filesystem::create_directories (directory ());
381 shared_ptr<xmlpp::Document> doc = metadata ();
382 doc->write_to_file_formatted (file("metadata.xml").string ());
386 /** Read state from our metadata file */
388 Film::read_metadata ()
392 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
393 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!"));
396 cxml::Document f ("Metadata");
397 f.read_file (file ("metadata.xml"));
399 _state_version = f.number_child<int> ("Version");
401 _name = f.string_child ("Name");
402 _use_dci_name = f.bool_child ("UseDCIName");
405 optional<string> c = f.optional_string_child ("DCPContentType");
407 _dcp_content_type = DCPContentType::from_dci_name (c.get ());
412 optional<string> c = f.optional_string_child ("Container");
414 _container = Ratio::from_id (c.get ());
418 _resolution = string_to_resolution (f.string_child ("Resolution"));
419 _scaler = Scaler::from_id (f.string_child ("Scaler"));
420 _with_subtitles = f.bool_child ("WithSubtitles");
421 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
422 _dci_metadata = DCIMetadata (f.node_child ("DCIMetadata"));
423 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
424 _dci_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
425 _signed = f.optional_bool_child("Signed").get_value_or (true);
426 _encrypted = f.bool_child ("Encrypted");
427 _audio_channels = f.number_child<int> ("AudioChannels");
428 _sequence_video = f.bool_child ("SequenceVideo");
429 _three_d = f.bool_child ("ThreeD");
430 _interop = f.bool_child ("Interop");
431 _key = libdcp::Key (f.string_child ("Key"));
432 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version);
437 /** Given a directory name, return its full path within the Film's directory.
438 * The directory (and its parents) will be created if they do not exist.
440 boost::filesystem::path
441 Film::dir (boost::filesystem::path d) const
443 boost::filesystem::path p;
447 boost::filesystem::create_directories (p);
452 /** Given a file or directory name, return its full path within the Film's directory.
453 * Any required parent directories will be created.
455 boost::filesystem::path
456 Film::file (boost::filesystem::path f) const
458 boost::filesystem::path p;
462 boost::filesystem::create_directories (p.parent_path ());
467 /** @return a DCI-compliant name for a DCP of this film */
469 Film::dci_name (bool if_created_now) const
473 string fixed_name = to_upper_copy (name());
474 for (size_t i = 0; i < fixed_name.length(); ++i) {
475 if (fixed_name[i] == ' ') {
480 /* Spec is that the name part should be maximum 14 characters, as I understand it */
481 if (fixed_name.length() > 14) {
482 fixed_name = fixed_name.substr (0, 14);
487 if (dcp_content_type()) {
488 d << "_" << dcp_content_type()->dci_name();
489 d << "-" << dci_metadata().content_version;
496 if (video_frame_rate() != 24) {
497 d << "-" << video_frame_rate();
501 d << "_" << container()->dci_name();
504 DCIMetadata const dm = dci_metadata ();
506 if (!dm.audio_language.empty ()) {
507 d << "_" << dm.audio_language;
508 if (!dm.subtitle_language.empty()) {
509 d << "-" << dm.subtitle_language;
515 if (!dm.territory.empty ()) {
516 d << "_" << dm.territory;
517 if (!dm.rating.empty ()) {
518 d << "-" << dm.rating;
522 switch (audio_channels ()) {
543 d << "_" << resolution_to_string (_resolution);
545 if (!dm.studio.empty ()) {
546 d << "_" << dm.studio;
549 if (if_created_now) {
550 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
552 d << "_" << boost::gregorian::to_iso_string (_dci_date);
555 if (!dm.facility.empty ()) {
556 d << "_" << dm.facility;
559 if (!dm.package_type.empty ()) {
560 d << "_" << dm.package_type;
566 /** @return name to give the DCP */
568 Film::dcp_name (bool if_created_now) const
570 if (use_dci_name()) {
571 return dci_name (if_created_now);
579 Film::set_directory (boost::filesystem::path d)
586 Film::set_name (string n)
589 signal_changed (NAME);
593 Film::set_use_dci_name (bool u)
596 signal_changed (USE_DCI_NAME);
600 Film::set_dcp_content_type (DCPContentType const * t)
602 _dcp_content_type = t;
603 signal_changed (DCP_CONTENT_TYPE);
607 Film::set_container (Ratio const * c)
610 signal_changed (CONTAINER);
614 Film::set_resolution (Resolution r)
617 signal_changed (RESOLUTION);
621 Film::set_scaler (Scaler const * s)
624 signal_changed (SCALER);
628 Film::set_with_subtitles (bool w)
631 signal_changed (WITH_SUBTITLES);
635 Film::set_j2k_bandwidth (int b)
638 signal_changed (J2K_BANDWIDTH);
642 Film::set_dci_metadata (DCIMetadata m)
645 signal_changed (DCI_METADATA);
649 Film::set_video_frame_rate (int f)
651 _video_frame_rate = f;
652 signal_changed (VIDEO_FRAME_RATE);
656 Film::set_audio_channels (int c)
659 signal_changed (AUDIO_CHANNELS);
663 Film::set_three_d (bool t)
666 signal_changed (THREE_D);
670 Film::set_interop (bool i)
673 signal_changed (INTEROP);
677 Film::signal_changed (Property p)
683 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
685 case Film::VIDEO_FRAME_RATE:
686 case Film::SEQUENCE_VIDEO:
687 _playlist->maybe_sequence_video ();
694 ui_signaller->emit (boost::bind (boost::ref (Changed), p));
699 Film::set_dci_date_today ()
701 _dci_date = boost::gregorian::day_clock::local_day ();
704 boost::filesystem::path
705 Film::info_path (int f, Eyes e) const
707 boost::filesystem::path p;
712 s << setfill('0') << f;
714 if (e == EYES_LEFT) {
716 } else if (e == EYES_RIGHT) {
724 /* info_dir() will already have added any initial bit of the path,
725 so don't call file() on this.
730 boost::filesystem::path
731 Film::j2c_path (int f, Eyes e, bool t) const
733 boost::filesystem::path p;
735 p /= video_identifier ();
739 s << setfill('0') << f;
741 if (e == EYES_LEFT) {
743 } else if (e == EYES_RIGHT) {
757 /** @return List of subdirectories (not full paths) containing DCPs that can be successfully libdcp::DCP::read() */
758 list<boost::filesystem::path>
761 list<boost::filesystem::path> out;
763 boost::filesystem::path const dir = directory ();
764 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
766 boost::filesystem::is_directory (*i) &&
767 i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
771 libdcp::DCP dcp (*i);
773 out.push_back (i->path().leaf ());
784 Film::make_player () const
786 return shared_ptr<Player> (new Player (shared_from_this (), _playlist));
790 Film::set_signed (bool s)
793 signal_changed (SIGNED);
797 Film::set_encrypted (bool e)
800 signal_changed (ENCRYPTED);
804 Film::playlist () const
810 Film::content () const
812 return _playlist->content ();
816 Film::examine_and_add_content (shared_ptr<Content> c)
818 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
819 j->Finished.connect (bind (&Film::maybe_add_content, this, boost::weak_ptr<Job> (j), boost::weak_ptr<Content> (c)));
820 JobManager::instance()->add (j);
824 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
826 shared_ptr<Job> job = j.lock ();
827 if (!job || !job->finished_ok ()) {
831 shared_ptr<Content> content = c.lock ();
833 add_content (content);
838 Film::add_content (shared_ptr<Content> c)
840 /* Add video content after any existing content */
841 if (dynamic_pointer_cast<VideoContent> (c)) {
842 c->set_position (_playlist->video_end ());
849 Film::remove_content (shared_ptr<Content> c)
851 _playlist->remove (c);
855 Film::move_content_earlier (shared_ptr<Content> c)
857 _playlist->move_earlier (c);
861 Film::move_content_later (shared_ptr<Content> c)
863 _playlist->move_later (c);
867 Film::length () const
869 return _playlist->length ();
873 Film::has_subtitles () const
875 return _playlist->has_subtitles ();
879 Film::best_video_frame_rate () const
881 return _playlist->best_dcp_frame_rate ();
885 Film::playlist_content_changed (boost::weak_ptr<Content> c, int p)
887 if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
888 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
892 ui_signaller->emit (boost::bind (boost::ref (ContentChanged), c, p));
897 Film::playlist_changed ()
899 signal_changed (CONTENT);
903 Film::time_to_audio_frames (Time t) const
905 return divide_with_round (t * audio_frame_rate (), TIME_HZ);
909 Film::time_to_video_frames (Time t) const
911 return divide_with_round (t * video_frame_rate (), TIME_HZ);
915 Film::audio_frames_to_time (OutputAudioFrame f) const
917 return divide_with_round (f * TIME_HZ, audio_frame_rate ());
921 Film::video_frames_to_time (OutputVideoFrame f) const
923 return divide_with_round (f * TIME_HZ, video_frame_rate ());
927 Film::audio_frame_rate () const
934 Film::set_sequence_video (bool s)
937 _playlist->set_sequence_video (s);
938 signal_changed (SEQUENCE_VIDEO);
942 Film::full_frame () const
944 switch (_resolution) {
946 return libdcp::Size (2048, 1080);
948 return libdcp::Size (4096, 2160);
952 return libdcp::Size ();
957 shared_ptr<libdcp::Certificate> target,
958 boost::filesystem::path dcp_dir,
959 boost::posix_time::ptime from,
960 boost::posix_time::ptime until
963 shared_ptr<const Signer> signer = make_signer ();
965 libdcp::DCP dcp (dir (dcp_dir.string ()));
970 throw KDMError (_("Could not read DCP to make KDM for"));
973 time_t now = time (0);
974 struct tm* tm = localtime (&now);
975 string const issue_date = libdcp::tm_to_string (tm);
977 dcp.cpls().front()->set_mxf_keys (key ());
979 return libdcp::KDM (dcp.cpls().front(), signer, target, from, until, "DCP-o-matic", issue_date);
984 list<shared_ptr<Screen> > screens,
985 boost::filesystem::path dcp,
986 boost::posix_time::ptime from,
987 boost::posix_time::ptime until
990 list<libdcp::KDM> kdms;
992 for (list<shared_ptr<Screen> >::iterator i = screens.begin(); i != screens.end(); ++i) {
993 kdms.push_back (make_kdm ((*i)->certificate, dcp, from, until));
999 /** @return The approximate disk space required to encode a DCP of this film with the
1000 * current settings, in bytes.
1003 Film::required_disk_space () const
1005 return uint64_t (j2k_bandwidth() / 8) * length() / TIME_HZ;
1008 /** This method checks the disk that the Film is on and tries to decide whether or not
1009 * there will be enough space to make a DCP for it. If so, true is returned; if not,
1010 * false is returned and required and availabe are filled in with the amount of disk space
1011 * required and available respectively (in Gb).
1013 * Note: the decision made by this method isn't, of course, 100% reliable.
1016 Film::should_be_enough_disk_space (double& required, double& available) const
1018 boost::filesystem::space_info s = boost::filesystem::space (internal_video_mxf_dir ());
1019 required = double (required_disk_space ()) / 1073741824.0f;
1020 available = double (s.available) / 1073741824.0f;
1021 return (available - required) > 1;