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 int const Film::state_version = 6;
89 /** Construct a Film object in a given directory.
91 * @param dir Film directory.
94 Film::Film (boost::filesystem::path dir)
95 : _playlist (new Playlist)
96 , _use_dci_name (true)
97 , _dcp_content_type (Config::instance()->default_dcp_content_type ())
98 , _container (Config::instance()->default_container ())
99 , _resolution (RESOLUTION_2K)
100 , _scaler (Scaler::from_id ("bicubic"))
101 , _with_subtitles (false)
104 , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
105 , _dci_metadata (Config::instance()->default_dci_metadata ())
106 , _video_frame_rate (24)
107 , _audio_channels (MAX_AUDIO_CHANNELS)
109 , _sequence_video (true)
113 set_dci_date_today ();
115 _playlist->Changed.connect (bind (&Film::playlist_changed, this));
116 _playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2));
118 /* Make state.directory a complete path without ..s (where possible)
119 (Code swiped from Adam Bowen on stackoverflow)
122 boost::filesystem::path p (boost::filesystem::system_complete (dir));
123 boost::filesystem::path result;
124 for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
126 if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
129 result = result.parent_path ();
131 } else if (*i != ".") {
136 set_directory (result);
137 _log.reset (new FileLog (file ("log")));
139 _playlist->set_sequence_video (_sequence_video);
143 Film::video_identifier () const
145 assert (container ());
149 s << container()->id()
150 << "_" << resolution_to_string (_resolution)
151 << "_" << _playlist->video_identifier()
152 << "_" << _video_frame_rate
153 << "_" << scaler()->id()
154 << "_" << j2k_bandwidth();
175 /** @return The path to the directory to write video frame info files to */
176 boost::filesystem::path
177 Film::info_dir () const
179 boost::filesystem::path p;
181 p /= video_identifier ();
185 boost::filesystem::path
186 Film::internal_video_mxf_dir () const
188 return dir ("video");
191 boost::filesystem::path
192 Film::internal_video_mxf_filename () const
194 return video_identifier() + ".mxf";
197 boost::filesystem::path
198 Film::video_mxf_filename () const
200 return filename_safe_name() + "_video.mxf";
203 boost::filesystem::path
204 Film::audio_mxf_filename () const
206 return filename_safe_name() + "_audio.mxf";
210 Film::filename_safe_name () const
212 string const n = name ();
214 for (size_t i = 0; i < n.length(); ++i) {
215 if (isalnum (n[i])) {
225 boost::filesystem::path
226 Film::audio_analysis_path (shared_ptr<const AudioContent> c) const
228 boost::filesystem::path p = dir ("analysis");
233 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
237 set_dci_date_today ();
239 if (dcp_name().find ("/") != string::npos) {
240 throw BadSettingError (_("name"), _("cannot contain slashes"));
243 log()->log (String::compose ("DCP-o-matic %1 git %2 using %3", dcpomatic_version, dcpomatic_git_commit, dependency_version_summary()));
247 gethostname (buffer, sizeof (buffer));
248 log()->log (String::compose ("Starting to make DCP on %1", buffer));
251 ContentList cl = content ();
252 for (ContentList::const_iterator i = cl.begin(); i != cl.end(); ++i) {
253 log()->log (String::compose ("Content: %1", (*i)->technical_summary()));
255 log()->log (String::compose ("DCP video rate %1 fps", video_frame_rate()));
256 log()->log (String::compose ("%1 threads", Config::instance()->num_local_encoding_threads()));
257 log()->log (String::compose ("J2K bandwidth %1", j2k_bandwidth()));
258 #ifdef DCPOMATIC_DEBUG
259 log()->log ("DCP-o-matic built in debug mode.");
261 log()->log ("DCP-o-matic built in optimised mode.");
264 log()->log ("libdcp built in debug mode.");
266 log()->log ("libdcp built in optimised mode.");
268 log()->log (String::compose ("CPU: %1, %2 processors", cpu_info(), boost::thread::hardware_concurrency ()));
269 list<pair<string, string> > const m = mount_info ();
270 for (list<pair<string, string> >::const_iterator i = m.begin(); i != m.end(); ++i) {
271 log()->log (String::compose ("Mount: %1 %2", i->first, i->second));
274 if (container() == 0) {
275 throw MissingSettingError (_("container"));
278 if (content().empty()) {
279 throw StringError (_("You must add some content to the DCP before creating it"));
282 if (dcp_content_type() == 0) {
283 throw MissingSettingError (_("content type"));
286 if (name().empty()) {
287 throw MissingSettingError (_("name"));
290 JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
293 /** Start a job to send our DCP to the configured TMS */
295 Film::send_dcp_to_tms ()
297 shared_ptr<Job> j (new SCPDCPJob (shared_from_this()));
298 JobManager::instance()->add (j);
301 /** Count the number of frames that have been encoded for this film.
302 * @return frame count.
305 Film::encoded_frames () const
307 if (container() == 0) {
312 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (info_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
314 boost::this_thread::interruption_point ();
320 /** Write state to our `metadata' file */
322 Film::write_metadata () const
324 if (!boost::filesystem::exists (directory ())) {
325 boost::filesystem::create_directory (directory ());
330 boost::filesystem::create_directories (directory ());
333 xmlpp::Element* root = doc.create_root_node ("Metadata");
335 root->add_child("Version")->add_child_text (lexical_cast<string> (state_version));
336 root->add_child("Name")->add_child_text (_name);
337 root->add_child("UseDCIName")->add_child_text (_use_dci_name ? "1" : "0");
339 if (_dcp_content_type) {
340 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->dci_name ());
344 root->add_child("Container")->add_child_text (_container->id ());
347 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
348 root->add_child("Scaler")->add_child_text (_scaler->id ());
349 root->add_child("WithSubtitles")->add_child_text (_with_subtitles ? "1" : "0");
350 root->add_child("J2KBandwidth")->add_child_text (lexical_cast<string> (_j2k_bandwidth));
351 _dci_metadata.as_xml (root->add_child ("DCIMetadata"));
352 root->add_child("VideoFrameRate")->add_child_text (lexical_cast<string> (_video_frame_rate));
353 root->add_child("DCIDate")->add_child_text (boost::gregorian::to_iso_string (_dci_date));
354 root->add_child("AudioChannels")->add_child_text (lexical_cast<string> (_audio_channels));
355 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
356 root->add_child("SequenceVideo")->add_child_text (_sequence_video ? "1" : "0");
357 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
358 root->add_child("Signed")->add_child_text (_signed ? "1" : "0");
359 root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
360 root->add_child("Key")->add_child_text (_key.hex ());
361 _playlist->as_xml (root->add_child ("Playlist"));
363 doc.write_to_file_formatted (file("metadata.xml").string ());
368 /** Read state from our metadata file */
370 Film::read_metadata ()
374 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
375 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!"));
378 cxml::Document f ("Metadata");
379 f.read_file (file ("metadata.xml"));
381 int const version = f.number_child<int> ("Version");
383 _name = f.string_child ("Name");
384 _use_dci_name = f.bool_child ("UseDCIName");
387 optional<string> c = f.optional_string_child ("DCPContentType");
389 _dcp_content_type = DCPContentType::from_dci_name (c.get ());
394 optional<string> c = f.optional_string_child ("Container");
396 _container = Ratio::from_id (c.get ());
400 _resolution = string_to_resolution (f.string_child ("Resolution"));
401 _scaler = Scaler::from_id (f.string_child ("Scaler"));
402 _with_subtitles = f.bool_child ("WithSubtitles");
403 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
404 _dci_metadata = DCIMetadata (f.node_child ("DCIMetadata"));
405 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
406 _dci_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
407 _signed = f.optional_bool_child("Signed").get_value_or (true);
408 _encrypted = f.bool_child ("Encrypted");
409 _audio_channels = f.number_child<int> ("AudioChannels");
410 _sequence_video = f.bool_child ("SequenceVideo");
411 _three_d = f.bool_child ("ThreeD");
412 _interop = f.bool_child ("Interop");
413 _key = libdcp::Key (f.string_child ("Key"));
414 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), version);
419 /** Given a directory name, return its full path within the Film's directory.
420 * The directory (and its parents) will be created if they do not exist.
422 boost::filesystem::path
423 Film::dir (boost::filesystem::path d) const
425 boost::filesystem::path p;
429 boost::filesystem::create_directories (p);
434 /** Given a file or directory name, return its full path within the Film's directory.
435 * Any required parent directories will be created.
437 boost::filesystem::path
438 Film::file (boost::filesystem::path f) const
440 boost::filesystem::path p;
444 boost::filesystem::create_directories (p.parent_path ());
449 /** @return a DCI-compliant name for a DCP of this film */
451 Film::dci_name (bool if_created_now) const
455 string fixed_name = to_upper_copy (name());
456 for (size_t i = 0; i < fixed_name.length(); ++i) {
457 if (fixed_name[i] == ' ') {
462 /* Spec is that the name part should be maximum 14 characters, as I understand it */
463 if (fixed_name.length() > 14) {
464 fixed_name = fixed_name.substr (0, 14);
469 if (dcp_content_type()) {
470 d << "_" << dcp_content_type()->dci_name();
471 d << "-" << dci_metadata().content_version;
478 if (video_frame_rate() != 24) {
479 d << "-" << video_frame_rate();
483 d << "_" << container()->dci_name();
486 DCIMetadata const dm = dci_metadata ();
488 if (!dm.audio_language.empty ()) {
489 d << "_" << dm.audio_language;
490 if (!dm.subtitle_language.empty()) {
491 d << "-" << dm.subtitle_language;
497 if (!dm.territory.empty ()) {
498 d << "_" << dm.territory;
499 if (!dm.rating.empty ()) {
500 d << "-" << dm.rating;
504 switch (audio_channels ()) {
525 d << "_" << resolution_to_string (_resolution);
527 if (!dm.studio.empty ()) {
528 d << "_" << dm.studio;
531 if (if_created_now) {
532 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
534 d << "_" << boost::gregorian::to_iso_string (_dci_date);
537 if (!dm.facility.empty ()) {
538 d << "_" << dm.facility;
541 if (!dm.package_type.empty ()) {
542 d << "_" << dm.package_type;
548 /** @return name to give the DCP */
550 Film::dcp_name (bool if_created_now) const
552 if (use_dci_name()) {
553 return dci_name (if_created_now);
561 Film::set_directory (boost::filesystem::path d)
568 Film::set_name (string n)
571 signal_changed (NAME);
575 Film::set_use_dci_name (bool u)
578 signal_changed (USE_DCI_NAME);
582 Film::set_dcp_content_type (DCPContentType const * t)
584 _dcp_content_type = t;
585 signal_changed (DCP_CONTENT_TYPE);
589 Film::set_container (Ratio const * c)
592 signal_changed (CONTAINER);
596 Film::set_resolution (Resolution r)
599 signal_changed (RESOLUTION);
603 Film::set_scaler (Scaler const * s)
606 signal_changed (SCALER);
610 Film::set_with_subtitles (bool w)
613 signal_changed (WITH_SUBTITLES);
617 Film::set_j2k_bandwidth (int b)
620 signal_changed (J2K_BANDWIDTH);
624 Film::set_dci_metadata (DCIMetadata m)
627 signal_changed (DCI_METADATA);
631 Film::set_video_frame_rate (int f)
633 _video_frame_rate = f;
634 signal_changed (VIDEO_FRAME_RATE);
638 Film::set_audio_channels (int c)
641 signal_changed (AUDIO_CHANNELS);
645 Film::set_three_d (bool t)
648 signal_changed (THREE_D);
652 Film::set_interop (bool i)
655 signal_changed (INTEROP);
659 Film::signal_changed (Property p)
665 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
667 case Film::VIDEO_FRAME_RATE:
668 case Film::SEQUENCE_VIDEO:
669 _playlist->maybe_sequence_video ();
676 ui_signaller->emit (boost::bind (boost::ref (Changed), p));
681 Film::set_dci_date_today ()
683 _dci_date = boost::gregorian::day_clock::local_day ();
686 boost::filesystem::path
687 Film::info_path (int f, Eyes e) const
689 boost::filesystem::path p;
694 s << setfill('0') << f;
696 if (e == EYES_LEFT) {
698 } else if (e == EYES_RIGHT) {
706 /* info_dir() will already have added any initial bit of the path,
707 so don't call file() on this.
712 boost::filesystem::path
713 Film::j2c_path (int f, Eyes e, bool t) const
715 boost::filesystem::path p;
717 p /= video_identifier ();
721 s << setfill('0') << f;
723 if (e == EYES_LEFT) {
725 } else if (e == EYES_RIGHT) {
739 /** @return List of subdirectories (not full paths) containing DCPs that can be successfully libdcp::DCP::read() */
740 list<boost::filesystem::path>
743 list<boost::filesystem::path> out;
745 boost::filesystem::path const dir = directory ();
746 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
748 boost::filesystem::is_directory (*i) &&
749 i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
753 libdcp::DCP dcp (*i);
755 out.push_back (i->path().leaf ());
766 Film::make_player () const
768 return shared_ptr<Player> (new Player (shared_from_this (), _playlist));
772 Film::set_signed (bool s)
775 signal_changed (SIGNED);
779 Film::set_encrypted (bool e)
782 signal_changed (ENCRYPTED);
786 Film::playlist () const
792 Film::content () const
794 return _playlist->content ();
798 Film::examine_and_add_content (shared_ptr<Content> c)
800 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
801 j->Finished.connect (bind (&Film::maybe_add_content, this, boost::weak_ptr<Job> (j), boost::weak_ptr<Content> (c)));
802 JobManager::instance()->add (j);
806 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
808 shared_ptr<Job> job = j.lock ();
809 if (!job || !job->finished_ok ()) {
813 shared_ptr<Content> content = c.lock ();
815 add_content (content);
820 Film::add_content (shared_ptr<Content> c)
822 /* Add video content after any existing content */
823 if (dynamic_pointer_cast<VideoContent> (c)) {
824 c->set_position (_playlist->video_end ());
831 Film::remove_content (shared_ptr<Content> c)
833 _playlist->remove (c);
837 Film::move_content_earlier (shared_ptr<Content> c)
839 _playlist->move_earlier (c);
843 Film::move_content_later (shared_ptr<Content> c)
845 _playlist->move_later (c);
849 Film::length () const
851 return _playlist->length ();
855 Film::has_subtitles () const
857 return _playlist->has_subtitles ();
861 Film::best_video_frame_rate () const
863 return _playlist->best_dcp_frame_rate ();
867 Film::playlist_content_changed (boost::weak_ptr<Content> c, int p)
869 if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
870 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
874 ui_signaller->emit (boost::bind (boost::ref (ContentChanged), c, p));
879 Film::playlist_changed ()
881 signal_changed (CONTENT);
885 Film::time_to_audio_frames (Time t) const
887 return t * audio_frame_rate () / TIME_HZ;
891 Film::time_to_video_frames (Time t) const
893 return t * video_frame_rate () / TIME_HZ;
897 Film::audio_frames_to_time (OutputAudioFrame f) const
899 return f * TIME_HZ / audio_frame_rate ();
903 Film::video_frames_to_time (OutputVideoFrame f) const
905 return f * TIME_HZ / video_frame_rate ();
909 Film::audio_frame_rate () const
916 Film::set_sequence_video (bool s)
919 _playlist->set_sequence_video (s);
920 signal_changed (SEQUENCE_VIDEO);
924 Film::full_frame () const
926 switch (_resolution) {
928 return libdcp::Size (2048, 1080);
930 return libdcp::Size (4096, 2160);
934 return libdcp::Size ();
939 shared_ptr<libdcp::Certificate> target,
940 boost::filesystem::path dcp_dir,
941 boost::posix_time::ptime from,
942 boost::posix_time::ptime until
945 shared_ptr<const Signer> signer = make_signer ();
947 libdcp::DCP dcp (dir (dcp_dir.string ()));
952 throw KDMError (_("Could not read DCP to make KDM for"));
955 time_t now = time (0);
956 struct tm* tm = localtime (&now);
957 string const issue_date = libdcp::tm_to_string (tm);
959 dcp.cpls().front()->set_mxf_keys (key ());
961 return libdcp::KDM (dcp.cpls().front(), signer, target, from, until, "DCP-o-matic", issue_date);
966 list<shared_ptr<Screen> > screens,
967 boost::filesystem::path dcp,
968 boost::posix_time::ptime from,
969 boost::posix_time::ptime until
972 list<libdcp::KDM> kdms;
974 for (list<shared_ptr<Screen> >::iterator i = screens.begin(); i != screens.end(); ++i) {
975 kdms.push_back (make_kdm ((*i)->certificate, dcp, from, until));
981 /** @return The approximate disk space required to encode a DCP of this film with the
982 * current settings, in bytes.
985 Film::required_disk_space () const
987 return uint64_t (j2k_bandwidth() / 8) * length() / TIME_HZ;
990 /** This method checks the disk that the Film is on and tries to decide whether or not
991 * there will be enough space to make a DCP for it. If so, true is returned; if not,
992 * false is returned and required and availabe are filled in with the amount of disk space
993 * required and available respectively (in Gb).
995 * Note: the decision made by this method isn't, of course, 100% reliable.
998 Film::should_be_enough_disk_space (double& required, double& available) const
1000 boost::filesystem::space_info s = boost::filesystem::space (internal_video_mxf_dir ());
1001 required = double (required_disk_space ()) / 1073741824.0f;
1002 available = double (s.available) / 1073741824.0f;
1003 return (available - required) > 1;