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)
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 (MAX_AUDIO_CHANNELS)
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);
139 _log.reset (new FileLog (file ("log")));
141 _playlist->set_sequence_video (_sequence_video);
145 Film::video_identifier () const
147 assert (container ());
151 s << container()->id()
152 << "_" << resolution_to_string (_resolution)
153 << "_" << _playlist->video_identifier()
154 << "_" << _video_frame_rate
155 << "_" << scaler()->id()
156 << "_" << j2k_bandwidth();
177 /** @return The path to the directory to write video frame info files to */
178 boost::filesystem::path
179 Film::info_dir () const
181 boost::filesystem::path p;
183 p /= video_identifier ();
187 boost::filesystem::path
188 Film::internal_video_mxf_dir () const
190 return dir ("video");
193 boost::filesystem::path
194 Film::internal_video_mxf_filename () const
196 return video_identifier() + ".mxf";
199 boost::filesystem::path
200 Film::video_mxf_filename () const
202 return filename_safe_name() + "_video.mxf";
205 boost::filesystem::path
206 Film::audio_mxf_filename () const
208 return filename_safe_name() + "_audio.mxf";
212 Film::filename_safe_name () const
214 string const n = name ();
216 for (size_t i = 0; i < n.length(); ++i) {
217 if (isalnum (n[i])) {
227 boost::filesystem::path
228 Film::audio_analysis_path (shared_ptr<const AudioContent> c) const
230 boost::filesystem::path p = dir ("analysis");
235 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
239 set_dci_date_today ();
241 if (dcp_name().find ("/") != string::npos) {
242 throw BadSettingError (_("name"), _("cannot contain slashes"));
245 log()->log (String::compose ("DCP-o-matic %1 git %2 using %3", dcpomatic_version, dcpomatic_git_commit, dependency_version_summary()));
249 gethostname (buffer, sizeof (buffer));
250 log()->log (String::compose ("Starting to make DCP on %1", buffer));
253 ContentList cl = content ();
254 for (ContentList::const_iterator i = cl.begin(); i != cl.end(); ++i) {
255 log()->log (String::compose ("Content: %1", (*i)->technical_summary()));
257 log()->log (String::compose ("DCP video rate %1 fps", video_frame_rate()));
258 log()->log (String::compose ("%1 threads", Config::instance()->num_local_encoding_threads()));
259 log()->log (String::compose ("J2K bandwidth %1", j2k_bandwidth()));
260 #ifdef DCPOMATIC_DEBUG
261 log()->log ("DCP-o-matic built in debug mode.");
263 log()->log ("DCP-o-matic built in optimised mode.");
266 log()->log ("libdcp built in debug mode.");
268 log()->log ("libdcp built in optimised mode.");
271 #ifdef DCPOMATIC_WINDOWS
273 info.dwOSVersionInfoSize = sizeof (info);
274 GetVersionEx (&info);
275 log()->log (String::compose ("Windows version %1.%2.%3 SP %4", info.dwMajorVersion, info.dwMinorVersion, info.dwBuildNumber, info.szCSDVersion));
278 log()->log (String::compose ("CPU: %1, %2 processors", cpu_info(), boost::thread::hardware_concurrency ()));
279 list<pair<string, string> > const m = mount_info ();
280 for (list<pair<string, string> >::const_iterator i = m.begin(); i != m.end(); ++i) {
281 log()->log (String::compose ("Mount: %1 %2", i->first, i->second));
284 if (container() == 0) {
285 throw MissingSettingError (_("container"));
288 if (content().empty()) {
289 throw StringError (_("You must add some content to the DCP before creating it"));
292 if (dcp_content_type() == 0) {
293 throw MissingSettingError (_("content type"));
296 if (name().empty()) {
297 throw MissingSettingError (_("name"));
300 JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
303 /** Start a job to send our DCP to the configured TMS */
305 Film::send_dcp_to_tms ()
307 shared_ptr<Job> j (new SCPDCPJob (shared_from_this()));
308 JobManager::instance()->add (j);
311 /** Count the number of frames that have been encoded for this film.
312 * @return frame count.
315 Film::encoded_frames () const
317 if (container() == 0) {
322 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (info_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
324 boost::this_thread::interruption_point ();
330 /** Write state to our `metadata' file */
332 Film::write_metadata () const
334 if (!boost::filesystem::exists (directory ())) {
335 boost::filesystem::create_directory (directory ());
340 boost::filesystem::create_directories (directory ());
343 xmlpp::Element* root = doc.create_root_node ("Metadata");
345 root->add_child("Version")->add_child_text (lexical_cast<string> (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"));
373 doc.write_to_file_formatted (file("metadata.xml").string ());
378 /** Read state from our metadata file */
380 Film::read_metadata ()
384 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
385 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!"));
388 cxml::Document f ("Metadata");
389 f.read_file (file ("metadata.xml"));
391 int const version = f.number_child<int> ("Version");
393 _name = f.string_child ("Name");
394 _use_dci_name = f.bool_child ("UseDCIName");
397 optional<string> c = f.optional_string_child ("DCPContentType");
399 _dcp_content_type = DCPContentType::from_dci_name (c.get ());
404 optional<string> c = f.optional_string_child ("Container");
406 _container = Ratio::from_id (c.get ());
410 _resolution = string_to_resolution (f.string_child ("Resolution"));
411 _scaler = Scaler::from_id (f.string_child ("Scaler"));
412 _with_subtitles = f.bool_child ("WithSubtitles");
413 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
414 _dci_metadata = DCIMetadata (f.node_child ("DCIMetadata"));
415 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
416 _dci_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
417 _signed = f.optional_bool_child("Signed").get_value_or (true);
418 _encrypted = f.bool_child ("Encrypted");
419 _audio_channels = f.number_child<int> ("AudioChannels");
420 _sequence_video = f.bool_child ("SequenceVideo");
421 _three_d = f.bool_child ("ThreeD");
422 _interop = f.bool_child ("Interop");
423 _key = libdcp::Key (f.string_child ("Key"));
424 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), version);
429 /** Given a directory name, return its full path within the Film's directory.
430 * The directory (and its parents) will be created if they do not exist.
432 boost::filesystem::path
433 Film::dir (boost::filesystem::path d) const
435 boost::filesystem::path p;
439 boost::filesystem::create_directories (p);
444 /** Given a file or directory name, return its full path within the Film's directory.
445 * Any required parent directories will be created.
447 boost::filesystem::path
448 Film::file (boost::filesystem::path f) const
450 boost::filesystem::path p;
454 boost::filesystem::create_directories (p.parent_path ());
459 /** @return a DCI-compliant name for a DCP of this film */
461 Film::dci_name (bool if_created_now) const
465 string fixed_name = to_upper_copy (name());
466 for (size_t i = 0; i < fixed_name.length(); ++i) {
467 if (fixed_name[i] == ' ') {
472 /* Spec is that the name part should be maximum 14 characters, as I understand it */
473 if (fixed_name.length() > 14) {
474 fixed_name = fixed_name.substr (0, 14);
479 if (dcp_content_type()) {
480 d << "_" << dcp_content_type()->dci_name();
481 d << "-" << dci_metadata().content_version;
488 if (video_frame_rate() != 24) {
489 d << "-" << video_frame_rate();
493 d << "_" << container()->dci_name();
496 DCIMetadata const dm = dci_metadata ();
498 if (!dm.audio_language.empty ()) {
499 d << "_" << dm.audio_language;
500 if (!dm.subtitle_language.empty()) {
501 d << "-" << dm.subtitle_language;
507 if (!dm.territory.empty ()) {
508 d << "_" << dm.territory;
509 if (!dm.rating.empty ()) {
510 d << "-" << dm.rating;
514 switch (audio_channels ()) {
535 d << "_" << resolution_to_string (_resolution);
537 if (!dm.studio.empty ()) {
538 d << "_" << dm.studio;
541 if (if_created_now) {
542 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
544 d << "_" << boost::gregorian::to_iso_string (_dci_date);
547 if (!dm.facility.empty ()) {
548 d << "_" << dm.facility;
551 if (!dm.package_type.empty ()) {
552 d << "_" << dm.package_type;
558 /** @return name to give the DCP */
560 Film::dcp_name (bool if_created_now) const
562 if (use_dci_name()) {
563 return dci_name (if_created_now);
571 Film::set_directory (boost::filesystem::path d)
578 Film::set_name (string n)
581 signal_changed (NAME);
585 Film::set_use_dci_name (bool u)
588 signal_changed (USE_DCI_NAME);
592 Film::set_dcp_content_type (DCPContentType const * t)
594 _dcp_content_type = t;
595 signal_changed (DCP_CONTENT_TYPE);
599 Film::set_container (Ratio const * c)
602 signal_changed (CONTAINER);
606 Film::set_resolution (Resolution r)
609 signal_changed (RESOLUTION);
613 Film::set_scaler (Scaler const * s)
616 signal_changed (SCALER);
620 Film::set_with_subtitles (bool w)
623 signal_changed (WITH_SUBTITLES);
627 Film::set_j2k_bandwidth (int b)
630 signal_changed (J2K_BANDWIDTH);
634 Film::set_dci_metadata (DCIMetadata m)
637 signal_changed (DCI_METADATA);
641 Film::set_video_frame_rate (int f)
643 _video_frame_rate = f;
644 signal_changed (VIDEO_FRAME_RATE);
648 Film::set_audio_channels (int c)
651 signal_changed (AUDIO_CHANNELS);
655 Film::set_three_d (bool t)
658 signal_changed (THREE_D);
662 Film::set_interop (bool i)
665 signal_changed (INTEROP);
669 Film::signal_changed (Property p)
675 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
677 case Film::VIDEO_FRAME_RATE:
678 case Film::SEQUENCE_VIDEO:
679 _playlist->maybe_sequence_video ();
686 ui_signaller->emit (boost::bind (boost::ref (Changed), p));
691 Film::set_dci_date_today ()
693 _dci_date = boost::gregorian::day_clock::local_day ();
696 boost::filesystem::path
697 Film::info_path (int f, Eyes e) const
699 boost::filesystem::path p;
704 s << setfill('0') << f;
706 if (e == EYES_LEFT) {
708 } else if (e == EYES_RIGHT) {
716 /* info_dir() will already have added any initial bit of the path,
717 so don't call file() on this.
722 boost::filesystem::path
723 Film::j2c_path (int f, Eyes e, bool t) const
725 boost::filesystem::path p;
727 p /= video_identifier ();
731 s << setfill('0') << f;
733 if (e == EYES_LEFT) {
735 } else if (e == EYES_RIGHT) {
749 /** @return List of subdirectories (not full paths) containing DCPs that can be successfully libdcp::DCP::read() */
750 list<boost::filesystem::path>
753 list<boost::filesystem::path> out;
755 boost::filesystem::path const dir = directory ();
756 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
758 boost::filesystem::is_directory (*i) &&
759 i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
763 libdcp::DCP dcp (*i);
765 out.push_back (i->path().leaf ());
776 Film::make_player () const
778 return shared_ptr<Player> (new Player (shared_from_this (), _playlist));
782 Film::set_signed (bool s)
785 signal_changed (SIGNED);
789 Film::set_encrypted (bool e)
792 signal_changed (ENCRYPTED);
796 Film::playlist () const
802 Film::content () const
804 return _playlist->content ();
808 Film::examine_and_add_content (shared_ptr<Content> c)
810 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
811 j->Finished.connect (bind (&Film::maybe_add_content, this, boost::weak_ptr<Job> (j), boost::weak_ptr<Content> (c)));
812 JobManager::instance()->add (j);
816 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
818 shared_ptr<Job> job = j.lock ();
819 if (!job || !job->finished_ok ()) {
823 shared_ptr<Content> content = c.lock ();
825 add_content (content);
830 Film::add_content (shared_ptr<Content> c)
832 /* Add video content after any existing content */
833 if (dynamic_pointer_cast<VideoContent> (c)) {
834 c->set_position (_playlist->video_end ());
841 Film::remove_content (shared_ptr<Content> c)
843 _playlist->remove (c);
847 Film::move_content_earlier (shared_ptr<Content> c)
849 _playlist->move_earlier (c);
853 Film::move_content_later (shared_ptr<Content> c)
855 _playlist->move_later (c);
859 Film::length () const
861 return _playlist->length ();
865 Film::has_subtitles () const
867 return _playlist->has_subtitles ();
871 Film::best_video_frame_rate () const
873 return _playlist->best_dcp_frame_rate ();
877 Film::active_frame_rate_change (DCPTime t) const
879 return _playlist->active_frame_rate_change (t, video_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 (DCPTime t) const
903 return t * audio_frame_rate () / TIME_HZ;
907 Film::time_to_video_frames (DCPTime t) const
909 return t * video_frame_rate () / TIME_HZ;
913 Film::audio_frames_to_time (AudioFrame f) const
915 return f * TIME_HZ / audio_frame_rate ();
919 Film::video_frames_to_time (VideoFrame 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;