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;
84 int const Film::state_version = 4;
86 /** Construct a Film object in a given directory.
88 * @param dir Film directory.
91 Film::Film (boost::filesystem::path dir)
92 : _playlist (new Playlist)
93 , _use_dci_name (true)
94 , _dcp_content_type (Config::instance()->default_dcp_content_type ())
95 , _container (Config::instance()->default_container ())
96 , _resolution (RESOLUTION_2K)
97 , _scaler (Scaler::from_id ("bicubic"))
98 , _with_subtitles (false)
100 , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
101 , _dci_metadata (Config::instance()->default_dci_metadata ())
102 , _video_frame_rate (24)
103 , _audio_channels (MAX_AUDIO_CHANNELS)
105 , _sequence_video (true)
109 set_dci_date_today ();
111 _playlist->Changed.connect (bind (&Film::playlist_changed, this));
112 _playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2));
114 /* Make state.directory a complete path without ..s (where possible)
115 (Code swiped from Adam Bowen on stackoverflow)
118 boost::filesystem::path p (boost::filesystem::system_complete (dir));
119 boost::filesystem::path result;
120 for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
122 if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
125 result = result.parent_path ();
127 } else if (*i != ".") {
132 set_directory (result);
133 _log.reset (new FileLog (file ("log")));
135 _playlist->set_sequence_video (_sequence_video);
139 Film::video_identifier () const
141 assert (container ());
145 s << container()->id()
146 << "_" << resolution_to_string (_resolution)
147 << "_" << _playlist->video_identifier()
148 << "_" << _video_frame_rate
149 << "_" << scaler()->id()
150 << "_" << j2k_bandwidth();
171 /** @return The path to the directory to write video frame info files to */
172 boost::filesystem::path
173 Film::info_dir () const
175 boost::filesystem::path p;
177 p /= video_identifier ();
181 boost::filesystem::path
182 Film::internal_video_mxf_dir () const
184 return dir ("video");
187 boost::filesystem::path
188 Film::internal_video_mxf_filename () const
190 return video_identifier() + ".mxf";
193 boost::filesystem::path
194 Film::video_mxf_filename () const
196 return filename_safe_name() + "_video.mxf";
199 boost::filesystem::path
200 Film::audio_mxf_filename () const
202 return filename_safe_name() + "_audio.mxf";
206 Film::filename_safe_name () const
208 string const n = name ();
210 for (size_t i = 0; i < n.length(); ++i) {
211 if (isalnum (n[i])) {
221 boost::filesystem::path
222 Film::audio_analysis_path (shared_ptr<const AudioContent> c) const
224 boost::filesystem::path p = dir ("analysis");
229 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
233 set_dci_date_today ();
235 if (dcp_name().find ("/") != string::npos) {
236 throw BadSettingError (_("name"), _("cannot contain slashes"));
239 log()->log (String::compose ("DCP-o-matic %1 git %2 using %3", dcpomatic_version, dcpomatic_git_commit, dependency_version_summary()));
243 gethostname (buffer, sizeof (buffer));
244 log()->log (String::compose ("Starting to make DCP on %1", buffer));
247 ContentList cl = content ();
248 for (ContentList::const_iterator i = cl.begin(); i != cl.end(); ++i) {
249 log()->log (String::compose ("Content: %1", (*i)->technical_summary()));
251 log()->log (String::compose ("DCP video rate %1 fps", video_frame_rate()));
252 log()->log (String::compose ("%1 threads", Config::instance()->num_local_encoding_threads()));
253 log()->log (String::compose ("J2K bandwidth %1", j2k_bandwidth()));
254 #ifdef DCPOMATIC_DEBUG
255 log()->log ("DCP-o-matic built in debug mode.");
257 log()->log ("DCP-o-matic built in optimised mode.");
260 log()->log ("libdcp built in debug mode.");
262 log()->log ("libdcp built in optimised mode.");
264 log()->log (String::compose ("CPU: %1, %2 processors", cpu_info(), boost::thread::hardware_concurrency ()));
265 list<pair<string, string> > const m = mount_info ();
266 for (list<pair<string, string> >::const_iterator i = m.begin(); i != m.end(); ++i) {
267 log()->log (String::compose ("Mount: %1 %2", i->first, i->second));
270 if (container() == 0) {
271 throw MissingSettingError (_("container"));
274 if (content().empty()) {
275 throw StringError (_("You must add some content to the DCP before creating it"));
278 if (dcp_content_type() == 0) {
279 throw MissingSettingError (_("content type"));
282 if (name().empty()) {
283 throw MissingSettingError (_("name"));
286 JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
289 /** Start a job to send our DCP to the configured TMS */
291 Film::send_dcp_to_tms ()
293 shared_ptr<Job> j (new SCPDCPJob (shared_from_this()));
294 JobManager::instance()->add (j);
297 /** Count the number of frames that have been encoded for this film.
298 * @return frame count.
301 Film::encoded_frames () const
303 if (container() == 0) {
308 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (info_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
310 boost::this_thread::interruption_point ();
316 /** Write state to our `metadata' file */
318 Film::write_metadata () const
320 if (!boost::filesystem::exists (directory ())) {
321 boost::filesystem::create_directory (directory ());
326 boost::filesystem::create_directories (directory ());
329 xmlpp::Element* root = doc.create_root_node ("Metadata");
331 root->add_child("Version")->add_child_text (lexical_cast<string> (state_version));
332 root->add_child("Name")->add_child_text (_name);
333 root->add_child("UseDCIName")->add_child_text (_use_dci_name ? "1" : "0");
335 if (_dcp_content_type) {
336 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->dci_name ());
340 root->add_child("Container")->add_child_text (_container->id ());
343 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
344 root->add_child("Scaler")->add_child_text (_scaler->id ());
345 root->add_child("WithSubtitles")->add_child_text (_with_subtitles ? "1" : "0");
346 root->add_child("J2KBandwidth")->add_child_text (lexical_cast<string> (_j2k_bandwidth));
347 _dci_metadata.as_xml (root->add_child ("DCIMetadata"));
348 root->add_child("VideoFrameRate")->add_child_text (lexical_cast<string> (_video_frame_rate));
349 root->add_child("DCIDate")->add_child_text (boost::gregorian::to_iso_string (_dci_date));
350 root->add_child("AudioChannels")->add_child_text (lexical_cast<string> (_audio_channels));
351 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
352 root->add_child("SequenceVideo")->add_child_text (_sequence_video ? "1" : "0");
353 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
354 root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
355 root->add_child("Key")->add_child_text (_key.hex ());
356 _playlist->as_xml (root->add_child ("Playlist"));
358 doc.write_to_file_formatted (file("metadata.xml").string ());
363 /** Read state from our metadata file */
365 Film::read_metadata ()
369 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
370 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!"));
373 cxml::Document f ("Metadata");
374 f.read_file (file ("metadata.xml"));
376 _name = f.string_child ("Name");
377 _use_dci_name = f.bool_child ("UseDCIName");
380 optional<string> c = f.optional_string_child ("DCPContentType");
382 _dcp_content_type = DCPContentType::from_dci_name (c.get ());
387 optional<string> c = f.optional_string_child ("Container");
389 _container = Ratio::from_id (c.get ());
393 _resolution = string_to_resolution (f.string_child ("Resolution"));
394 _scaler = Scaler::from_id (f.string_child ("Scaler"));
395 _with_subtitles = f.bool_child ("WithSubtitles");
396 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
397 _dci_metadata = DCIMetadata (f.node_child ("DCIMetadata"));
398 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
399 _dci_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
400 _encrypted = f.bool_child ("Encrypted");
401 _audio_channels = f.number_child<int> ("AudioChannels");
402 _sequence_video = f.bool_child ("SequenceVideo");
403 _three_d = f.bool_child ("ThreeD");
404 _interop = f.bool_child ("Interop");
405 _key = libdcp::Key (f.string_child ("Key"));
406 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"));
411 /** Given a directory name, return its full path within the Film's directory.
412 * The directory (and its parents) will be created if they do not exist.
414 boost::filesystem::path
415 Film::dir (boost::filesystem::path d) const
417 boost::filesystem::path p;
421 boost::filesystem::create_directories (p);
426 /** Given a file or directory name, return its full path within the Film's directory.
427 * Any required parent directories will be created.
429 boost::filesystem::path
430 Film::file (boost::filesystem::path f) const
432 boost::filesystem::path p;
436 boost::filesystem::create_directories (p.parent_path ());
441 /** @return a DCI-compliant name for a DCP of this film */
443 Film::dci_name (bool if_created_now) const
447 string fixed_name = to_upper_copy (name());
448 for (size_t i = 0; i < fixed_name.length(); ++i) {
449 if (fixed_name[i] == ' ') {
454 /* Spec is that the name part should be maximum 14 characters, as I understand it */
455 if (fixed_name.length() > 14) {
456 fixed_name = fixed_name.substr (0, 14);
461 if (dcp_content_type()) {
462 d << "_" << dcp_content_type()->dci_name();
463 d << "-" << dci_metadata().content_version;
470 if (video_frame_rate() != 24) {
471 d << "-" << video_frame_rate();
475 d << "_" << container()->dci_name();
478 DCIMetadata const dm = dci_metadata ();
480 if (!dm.audio_language.empty ()) {
481 d << "_" << dm.audio_language;
482 if (!dm.subtitle_language.empty()) {
483 d << "-" << dm.subtitle_language;
489 if (!dm.territory.empty ()) {
490 d << "_" << dm.territory;
491 if (!dm.rating.empty ()) {
492 d << "-" << dm.rating;
496 switch (audio_channels ()) {
517 d << "_" << resolution_to_string (_resolution);
519 if (!dm.studio.empty ()) {
520 d << "_" << dm.studio;
523 if (if_created_now) {
524 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
526 d << "_" << boost::gregorian::to_iso_string (_dci_date);
529 if (!dm.facility.empty ()) {
530 d << "_" << dm.facility;
533 if (!dm.package_type.empty ()) {
534 d << "_" << dm.package_type;
540 /** @return name to give the DCP */
542 Film::dcp_name (bool if_created_now) const
544 if (use_dci_name()) {
545 return dci_name (if_created_now);
553 Film::set_directory (boost::filesystem::path d)
560 Film::set_name (string n)
563 signal_changed (NAME);
567 Film::set_use_dci_name (bool u)
570 signal_changed (USE_DCI_NAME);
574 Film::set_dcp_content_type (DCPContentType const * t)
576 _dcp_content_type = t;
577 signal_changed (DCP_CONTENT_TYPE);
581 Film::set_container (Ratio const * c)
584 signal_changed (CONTAINER);
588 Film::set_resolution (Resolution r)
591 signal_changed (RESOLUTION);
595 Film::set_scaler (Scaler const * s)
598 signal_changed (SCALER);
602 Film::set_with_subtitles (bool w)
605 signal_changed (WITH_SUBTITLES);
609 Film::set_j2k_bandwidth (int b)
612 signal_changed (J2K_BANDWIDTH);
616 Film::set_dci_metadata (DCIMetadata m)
619 signal_changed (DCI_METADATA);
623 Film::set_video_frame_rate (int f)
625 _video_frame_rate = f;
626 signal_changed (VIDEO_FRAME_RATE);
630 Film::set_audio_channels (int c)
633 signal_changed (AUDIO_CHANNELS);
637 Film::set_three_d (bool t)
640 signal_changed (THREE_D);
644 Film::set_interop (bool i)
647 signal_changed (INTEROP);
651 Film::signal_changed (Property p)
657 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
659 case Film::VIDEO_FRAME_RATE:
660 case Film::SEQUENCE_VIDEO:
661 _playlist->maybe_sequence_video ();
668 ui_signaller->emit (boost::bind (boost::ref (Changed), p));
673 Film::set_dci_date_today ()
675 _dci_date = boost::gregorian::day_clock::local_day ();
678 boost::filesystem::path
679 Film::info_path (int f, Eyes e) const
681 boost::filesystem::path p;
686 s << setfill('0') << f;
688 if (e == EYES_LEFT) {
690 } else if (e == EYES_RIGHT) {
698 /* info_dir() will already have added any initial bit of the path,
699 so don't call file() on this.
704 boost::filesystem::path
705 Film::j2c_path (int f, Eyes e, bool t) const
707 boost::filesystem::path p;
709 p /= video_identifier ();
713 s << setfill('0') << f;
715 if (e == EYES_LEFT) {
717 } else if (e == EYES_RIGHT) {
731 /** @return List of subdirectories (not full paths) containing DCPs that can be successfully libdcp::DCP::read() */
732 list<boost::filesystem::path>
735 list<boost::filesystem::path> out;
737 boost::filesystem::path const dir = directory ();
738 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
740 boost::filesystem::is_directory (*i) &&
741 i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
745 libdcp::DCP dcp (*i);
747 out.push_back (i->path().leaf ());
758 Film::make_player () const
760 return shared_ptr<Player> (new Player (shared_from_this (), _playlist));
764 Film::set_encrypted (bool e)
767 signal_changed (ENCRYPTED);
771 Film::playlist () const
777 Film::content () const
779 return _playlist->content ();
783 Film::examine_and_add_content (shared_ptr<Content> c)
785 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
786 j->Finished.connect (bind (&Film::maybe_add_content, this, boost::weak_ptr<Job> (j), boost::weak_ptr<Content> (c)));
787 JobManager::instance()->add (j);
791 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
793 shared_ptr<Job> job = j.lock ();
794 if (!job || !job->finished_ok ()) {
798 shared_ptr<Content> content = c.lock ();
800 add_content (content);
805 Film::add_content (shared_ptr<Content> c)
807 /* Add video content after any existing content */
808 if (dynamic_pointer_cast<VideoContent> (c)) {
809 c->set_position (_playlist->video_end ());
816 Film::remove_content (shared_ptr<Content> c)
818 _playlist->remove (c);
822 Film::move_content_earlier (shared_ptr<Content> c)
824 _playlist->move_earlier (c);
828 Film::move_content_later (shared_ptr<Content> c)
830 _playlist->move_later (c);
834 Film::length () const
836 return _playlist->length ();
840 Film::has_subtitles () const
842 return _playlist->has_subtitles ();
846 Film::best_video_frame_rate () const
848 return _playlist->best_dcp_frame_rate ();
852 Film::content_paths_valid () const
854 return _playlist->content_paths_valid ();
858 Film::playlist_content_changed (boost::weak_ptr<Content> c, int p)
860 if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
861 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
865 ui_signaller->emit (boost::bind (boost::ref (ContentChanged), c, p));
870 Film::playlist_changed ()
872 signal_changed (CONTENT);
876 Film::time_to_audio_frames (Time t) const
878 return t * audio_frame_rate () / TIME_HZ;
882 Film::time_to_video_frames (Time t) const
884 return t * video_frame_rate () / TIME_HZ;
888 Film::audio_frames_to_time (OutputAudioFrame f) const
890 return f * TIME_HZ / audio_frame_rate ();
894 Film::video_frames_to_time (OutputVideoFrame f) const
896 return f * TIME_HZ / video_frame_rate ();
900 Film::audio_frame_rate () const
907 Film::set_sequence_video (bool s)
910 _playlist->set_sequence_video (s);
911 signal_changed (SEQUENCE_VIDEO);
915 Film::full_frame () const
917 switch (_resolution) {
919 return libdcp::Size (2048, 1080);
921 return libdcp::Size (4096, 2160);
925 return libdcp::Size ();
930 shared_ptr<libdcp::Certificate> target,
931 boost::filesystem::path dcp_dir,
932 boost::posix_time::ptime from,
933 boost::posix_time::ptime until
936 shared_ptr<const Signer> signer = make_signer ();
938 libdcp::DCP dcp (dir (dcp_dir.string ()));
943 throw KDMError (_("Could not read DCP to make KDM for"));
946 time_t now = time (0);
947 struct tm* tm = localtime (&now);
948 string const issue_date = libdcp::tm_to_string (tm);
950 dcp.cpls().front()->set_mxf_keys (key ());
952 return libdcp::KDM (dcp.cpls().front(), signer, target, from, until, "DCP-o-matic", issue_date);
957 list<shared_ptr<Screen> > screens,
958 boost::filesystem::path dcp,
959 boost::posix_time::ptime from,
960 boost::posix_time::ptime until
963 list<libdcp::KDM> kdms;
965 for (list<shared_ptr<Screen> >::iterator i = screens.begin(); i != screens.end(); ++i) {
966 kdms.push_back (make_kdm ((*i)->certificate, dcp, from, until));