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.");
269 #ifdef DCPOMATIC_WINDOWS
271 info.dwOSVersionInfoSize = sizeof (info);
272 GetVersionEx (&info);
273 log()->log (String::compose ("Windows version %1.%2.%3 SP %4", info.dwMajorVersion, info.dwMinorVersion, info.dwBuildNumber, info.szCSDVersion));
276 log()->log (String::compose ("CPU: %1, %2 processors", cpu_info(), boost::thread::hardware_concurrency ()));
277 list<pair<string, string> > const m = mount_info ();
278 for (list<pair<string, string> >::const_iterator i = m.begin(); i != m.end(); ++i) {
279 log()->log (String::compose ("Mount: %1 %2", i->first, i->second));
282 if (container() == 0) {
283 throw MissingSettingError (_("container"));
286 if (content().empty()) {
287 throw StringError (_("You must add some content to the DCP before creating it"));
290 if (dcp_content_type() == 0) {
291 throw MissingSettingError (_("content type"));
294 if (name().empty()) {
295 throw MissingSettingError (_("name"));
298 JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
301 /** Start a job to send our DCP to the configured TMS */
303 Film::send_dcp_to_tms ()
305 shared_ptr<Job> j (new SCPDCPJob (shared_from_this()));
306 JobManager::instance()->add (j);
309 /** Count the number of frames that have been encoded for this film.
310 * @return frame count.
313 Film::encoded_frames () const
315 if (container() == 0) {
320 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (info_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
322 boost::this_thread::interruption_point ();
328 /** Write state to our `metadata' file */
330 Film::write_metadata () const
332 if (!boost::filesystem::exists (directory ())) {
333 boost::filesystem::create_directory (directory ());
338 boost::filesystem::create_directories (directory ());
341 xmlpp::Element* root = doc.create_root_node ("Metadata");
343 root->add_child("Version")->add_child_text (lexical_cast<string> (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"));
371 doc.write_to_file_formatted (file("metadata.xml").string ());
376 /** Read state from our metadata file */
378 Film::read_metadata ()
382 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
383 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!"));
386 cxml::Document f ("Metadata");
387 f.read_file (file ("metadata.xml"));
389 int const version = f.number_child<int> ("Version");
391 _name = f.string_child ("Name");
392 _use_dci_name = f.bool_child ("UseDCIName");
395 optional<string> c = f.optional_string_child ("DCPContentType");
397 _dcp_content_type = DCPContentType::from_dci_name (c.get ());
402 optional<string> c = f.optional_string_child ("Container");
404 _container = Ratio::from_id (c.get ());
408 _resolution = string_to_resolution (f.string_child ("Resolution"));
409 _scaler = Scaler::from_id (f.string_child ("Scaler"));
410 _with_subtitles = f.bool_child ("WithSubtitles");
411 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
412 _dci_metadata = DCIMetadata (f.node_child ("DCIMetadata"));
413 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
414 _dci_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
415 _signed = f.optional_bool_child("Signed").get_value_or (true);
416 _encrypted = f.bool_child ("Encrypted");
417 _audio_channels = f.number_child<int> ("AudioChannels");
418 _sequence_video = f.bool_child ("SequenceVideo");
419 _three_d = f.bool_child ("ThreeD");
420 _interop = f.bool_child ("Interop");
421 _key = libdcp::Key (f.string_child ("Key"));
422 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), version);
427 /** Given a directory name, return its full path within the Film's directory.
428 * The directory (and its parents) will be created if they do not exist.
430 boost::filesystem::path
431 Film::dir (boost::filesystem::path d) const
433 boost::filesystem::path p;
437 boost::filesystem::create_directories (p);
442 /** Given a file or directory name, return its full path within the Film's directory.
443 * Any required parent directories will be created.
445 boost::filesystem::path
446 Film::file (boost::filesystem::path f) const
448 boost::filesystem::path p;
452 boost::filesystem::create_directories (p.parent_path ());
457 /** @return a DCI-compliant name for a DCP of this film */
459 Film::dci_name (bool if_created_now) const
463 string fixed_name = to_upper_copy (name());
464 for (size_t i = 0; i < fixed_name.length(); ++i) {
465 if (fixed_name[i] == ' ') {
470 /* Spec is that the name part should be maximum 14 characters, as I understand it */
471 if (fixed_name.length() > 14) {
472 fixed_name = fixed_name.substr (0, 14);
477 if (dcp_content_type()) {
478 d << "_" << dcp_content_type()->dci_name();
479 d << "-" << dci_metadata().content_version;
486 if (video_frame_rate() != 24) {
487 d << "-" << video_frame_rate();
491 d << "_" << container()->dci_name();
494 DCIMetadata const dm = dci_metadata ();
496 if (!dm.audio_language.empty ()) {
497 d << "_" << dm.audio_language;
498 if (!dm.subtitle_language.empty()) {
499 d << "-" << dm.subtitle_language;
505 if (!dm.territory.empty ()) {
506 d << "_" << dm.territory;
507 if (!dm.rating.empty ()) {
508 d << "-" << dm.rating;
512 switch (audio_channels ()) {
533 d << "_" << resolution_to_string (_resolution);
535 if (!dm.studio.empty ()) {
536 d << "_" << dm.studio;
539 if (if_created_now) {
540 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
542 d << "_" << boost::gregorian::to_iso_string (_dci_date);
545 if (!dm.facility.empty ()) {
546 d << "_" << dm.facility;
549 if (!dm.package_type.empty ()) {
550 d << "_" << dm.package_type;
556 /** @return name to give the DCP */
558 Film::dcp_name (bool if_created_now) const
560 if (use_dci_name()) {
561 return dci_name (if_created_now);
569 Film::set_directory (boost::filesystem::path d)
576 Film::set_name (string n)
579 signal_changed (NAME);
583 Film::set_use_dci_name (bool u)
586 signal_changed (USE_DCI_NAME);
590 Film::set_dcp_content_type (DCPContentType const * t)
592 _dcp_content_type = t;
593 signal_changed (DCP_CONTENT_TYPE);
597 Film::set_container (Ratio const * c)
600 signal_changed (CONTAINER);
604 Film::set_resolution (Resolution r)
607 signal_changed (RESOLUTION);
611 Film::set_scaler (Scaler const * s)
614 signal_changed (SCALER);
618 Film::set_with_subtitles (bool w)
621 signal_changed (WITH_SUBTITLES);
625 Film::set_j2k_bandwidth (int b)
628 signal_changed (J2K_BANDWIDTH);
632 Film::set_dci_metadata (DCIMetadata m)
635 signal_changed (DCI_METADATA);
639 Film::set_video_frame_rate (int f)
641 _video_frame_rate = f;
642 signal_changed (VIDEO_FRAME_RATE);
646 Film::set_audio_channels (int c)
649 signal_changed (AUDIO_CHANNELS);
653 Film::set_three_d (bool t)
656 signal_changed (THREE_D);
660 Film::set_interop (bool i)
663 signal_changed (INTEROP);
667 Film::signal_changed (Property p)
673 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
675 case Film::VIDEO_FRAME_RATE:
676 case Film::SEQUENCE_VIDEO:
677 _playlist->maybe_sequence_video ();
684 ui_signaller->emit (boost::bind (boost::ref (Changed), p));
689 Film::set_dci_date_today ()
691 _dci_date = boost::gregorian::day_clock::local_day ();
694 boost::filesystem::path
695 Film::info_path (int f, Eyes e) const
697 boost::filesystem::path p;
702 s << setfill('0') << f;
704 if (e == EYES_LEFT) {
706 } else if (e == EYES_RIGHT) {
714 /* info_dir() will already have added any initial bit of the path,
715 so don't call file() on this.
720 boost::filesystem::path
721 Film::j2c_path (int f, Eyes e, bool t) const
723 boost::filesystem::path p;
725 p /= video_identifier ();
729 s << setfill('0') << f;
731 if (e == EYES_LEFT) {
733 } else if (e == EYES_RIGHT) {
747 /** @return List of subdirectories (not full paths) containing DCPs that can be successfully libdcp::DCP::read() */
748 list<boost::filesystem::path>
751 list<boost::filesystem::path> out;
753 boost::filesystem::path const dir = directory ();
754 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
756 boost::filesystem::is_directory (*i) &&
757 i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
761 libdcp::DCP dcp (*i);
763 out.push_back (i->path().leaf ());
774 Film::make_player () const
776 return shared_ptr<Player> (new Player (shared_from_this (), _playlist));
780 Film::set_signed (bool s)
783 signal_changed (SIGNED);
787 Film::set_encrypted (bool e)
790 signal_changed (ENCRYPTED);
794 Film::playlist () const
800 Film::content () const
802 return _playlist->content ();
806 Film::examine_and_add_content (shared_ptr<Content> c)
808 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
809 j->Finished.connect (bind (&Film::maybe_add_content, this, boost::weak_ptr<Job> (j), boost::weak_ptr<Content> (c)));
810 JobManager::instance()->add (j);
814 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
816 shared_ptr<Job> job = j.lock ();
817 if (!job || !job->finished_ok ()) {
821 shared_ptr<Content> content = c.lock ();
823 add_content (content);
828 Film::add_content (shared_ptr<Content> c)
830 /* Add video content after any existing content */
831 if (dynamic_pointer_cast<VideoContent> (c)) {
832 c->set_position (_playlist->video_end ());
839 Film::remove_content (shared_ptr<Content> c)
841 _playlist->remove (c);
845 Film::move_content_earlier (shared_ptr<Content> c)
847 _playlist->move_earlier (c);
851 Film::move_content_later (shared_ptr<Content> c)
853 _playlist->move_later (c);
857 Film::length () const
859 return _playlist->length ();
863 Film::has_subtitles () const
865 return _playlist->has_subtitles ();
869 Film::best_video_frame_rate () const
871 return _playlist->best_dcp_frame_rate ();
875 Film::playlist_content_changed (boost::weak_ptr<Content> c, int p)
877 if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
878 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
882 ui_signaller->emit (boost::bind (boost::ref (ContentChanged), c, p));
887 Film::playlist_changed ()
889 signal_changed (CONTENT);
893 Film::time_to_audio_frames (Time t) const
895 return t * audio_frame_rate () / TIME_HZ;
899 Film::time_to_video_frames (Time t) const
901 return t * video_frame_rate () / TIME_HZ;
905 Film::audio_frames_to_time (OutputAudioFrame f) const
907 return f * TIME_HZ / audio_frame_rate ();
911 Film::video_frames_to_time (OutputVideoFrame f) const
913 return f * TIME_HZ / video_frame_rate ();
917 Film::audio_frame_rate () const
924 Film::set_sequence_video (bool s)
927 _playlist->set_sequence_video (s);
928 signal_changed (SEQUENCE_VIDEO);
932 Film::full_frame () const
934 switch (_resolution) {
936 return libdcp::Size (2048, 1080);
938 return libdcp::Size (4096, 2160);
942 return libdcp::Size ();
947 shared_ptr<libdcp::Certificate> target,
948 boost::filesystem::path dcp_dir,
949 boost::posix_time::ptime from,
950 boost::posix_time::ptime until
953 shared_ptr<const Signer> signer = make_signer ();
955 libdcp::DCP dcp (dir (dcp_dir.string ()));
960 throw KDMError (_("Could not read DCP to make KDM for"));
963 time_t now = time (0);
964 struct tm* tm = localtime (&now);
965 string const issue_date = libdcp::tm_to_string (tm);
967 dcp.cpls().front()->set_mxf_keys (key ());
969 return libdcp::KDM (dcp.cpls().front(), signer, target, from, until, "DCP-o-matic", issue_date);
974 list<shared_ptr<Screen> > screens,
975 boost::filesystem::path dcp,
976 boost::posix_time::ptime from,
977 boost::posix_time::ptime until
980 list<libdcp::KDM> kdms;
982 for (list<shared_ptr<Screen> >::iterator i = screens.begin(); i != screens.end(); ++i) {
983 kdms.push_back (make_kdm ((*i)->certificate, dcp, from, until));
989 /** @return The approximate disk space required to encode a DCP of this film with the
990 * current settings, in bytes.
993 Film::required_disk_space () const
995 return uint64_t (j2k_bandwidth() / 8) * length() / TIME_HZ;
998 /** This method checks the disk that the Film is on and tries to decide whether or not
999 * there will be enough space to make a DCP for it. If so, true is returned; if not,
1000 * false is returned and required and availabe are filled in with the amount of disk space
1001 * required and available respectively (in Gb).
1003 * Note: the decision made by this method isn't, of course, 100% reliable.
1006 Film::should_be_enough_disk_space (double& required, double& available) const
1008 boost::filesystem::space_info s = boost::filesystem::space (internal_video_mxf_dir ());
1009 required = double (required_disk_space ()) / 1073741824.0f;
1010 available = double (s.available) / 1073741824.0f;
1011 return (available - required) > 1;