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>
40 #include "job_manager.h"
41 #include "transcode_job.h"
42 #include "scp_dcp_job.h"
44 #include "exceptions.h"
45 #include "examine_content_job.h"
49 #include "ui_signaller.h"
52 #include "dcp_content_type.h"
60 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)
99 , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
100 , _dci_metadata (Config::instance()->default_dci_metadata ())
101 , _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.string ());
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();
165 /** @return The path to the directory to write video frame info files to */
167 Film::info_dir () const
169 boost::filesystem::path p;
171 p /= video_identifier ();
172 return dir (p.string());
176 Film::internal_video_mxf_dir () const
178 return dir ("video");
182 Film::internal_video_mxf_filename () const
184 return video_identifier() + ".mxf";
188 Film::video_mxf_filename () const
190 return filename_safe_name() + "_video.mxf";
194 Film::audio_mxf_filename () const
196 return filename_safe_name() + "_audio.mxf";
200 Film::filename_safe_name () const
202 string const n = name ();
204 for (size_t i = 0; i < n.length(); ++i) {
205 if (isalnum (n[i])) {
215 boost::filesystem::path
216 Film::audio_analysis_path (shared_ptr<const AudioContent> c) const
218 boost::filesystem::path p = dir ("analysis");
223 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
227 set_dci_date_today ();
229 if (dcp_name().find ("/") != string::npos) {
230 throw BadSettingError (_("name"), _("cannot contain slashes"));
233 log()->log (String::compose ("DCP-o-matic %1 git %2 using %3", dcpomatic_version, dcpomatic_git_commit, dependency_version_summary()));
237 gethostname (buffer, sizeof (buffer));
238 log()->log (String::compose ("Starting to make DCP on %1", buffer));
241 ContentList cl = content ();
242 for (ContentList::const_iterator i = cl.begin(); i != cl.end(); ++i) {
243 log()->log (String::compose ("Content: %1", (*i)->technical_summary()));
245 log()->log (String::compose ("DCP video rate %1 fps", video_frame_rate()));
246 log()->log (String::compose ("%1 threads", Config::instance()->num_local_encoding_threads()));
247 log()->log (String::compose ("J2K bandwidth %1", j2k_bandwidth()));
248 #ifdef DCPOMATIC_DEBUG
249 log()->log ("DCP-o-matic built in debug mode.");
251 log()->log ("DCP-o-matic built in optimised mode.");
254 log()->log ("libdcp built in debug mode.");
256 log()->log ("libdcp built in optimised mode.");
258 log()->log (String::compose ("CPU: %1, %2 processors", cpu_info(), boost::thread::hardware_concurrency ()));
259 list<pair<string, string> > const m = mount_info ();
260 for (list<pair<string, string> >::const_iterator i = m.begin(); i != m.end(); ++i) {
261 log()->log (String::compose ("Mount: %1 %2", i->first, i->second));
264 if (container() == 0) {
265 throw MissingSettingError (_("container"));
268 if (content().empty()) {
269 throw StringError (_("You must add some content to the DCP before creating it"));
272 if (dcp_content_type() == 0) {
273 throw MissingSettingError (_("content type"));
276 if (name().empty()) {
277 throw MissingSettingError (_("name"));
280 JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
283 /** Start a job to send our DCP to the configured TMS */
285 Film::send_dcp_to_tms ()
287 shared_ptr<Job> j (new SCPDCPJob (shared_from_this()));
288 JobManager::instance()->add (j);
291 /** Count the number of frames that have been encoded for this film.
292 * @return frame count.
295 Film::encoded_frames () const
297 if (container() == 0) {
302 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (info_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
304 boost::this_thread::interruption_point ();
310 /** Write state to our `metadata' file */
312 Film::write_metadata () const
314 if (!boost::filesystem::exists (directory())) {
315 boost::filesystem::create_directory (directory());
320 boost::filesystem::create_directories (directory());
323 xmlpp::Element* root = doc.create_root_node ("Metadata");
325 root->add_child("Version")->add_child_text (lexical_cast<string> (state_version));
326 root->add_child("Name")->add_child_text (_name);
327 root->add_child("UseDCIName")->add_child_text (_use_dci_name ? "1" : "0");
329 if (_dcp_content_type) {
330 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->dci_name ());
334 root->add_child("Container")->add_child_text (_container->id ());
337 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
338 root->add_child("Scaler")->add_child_text (_scaler->id ());
339 root->add_child("WithSubtitles")->add_child_text (_with_subtitles ? "1" : "0");
340 root->add_child("J2KBandwidth")->add_child_text (lexical_cast<string> (_j2k_bandwidth));
341 _dci_metadata.as_xml (root->add_child ("DCIMetadata"));
342 root->add_child("VideoFrameRate")->add_child_text (lexical_cast<string> (_video_frame_rate));
343 root->add_child("DCIDate")->add_child_text (boost::gregorian::to_iso_string (_dci_date));
344 root->add_child("AudioChannels")->add_child_text (lexical_cast<string> (_audio_channels));
345 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
346 root->add_child("SequenceVideo")->add_child_text (_sequence_video ? "1" : "0");
347 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
348 root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
349 _playlist->as_xml (root->add_child ("Playlist"));
351 doc.write_to_file_formatted (file ("metadata.xml"));
356 /** Read state from our metadata file */
358 Film::read_metadata ()
362 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
363 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!"));
366 cxml::Document f ("Metadata");
367 f.read_file (file ("metadata.xml"));
369 _name = f.string_child ("Name");
370 _use_dci_name = f.bool_child ("UseDCIName");
373 optional<string> c = f.optional_string_child ("DCPContentType");
375 _dcp_content_type = DCPContentType::from_dci_name (c.get ());
380 optional<string> c = f.optional_string_child ("Container");
382 _container = Ratio::from_id (c.get ());
386 _resolution = string_to_resolution (f.string_child ("Resolution"));
387 _scaler = Scaler::from_id (f.string_child ("Scaler"));
388 _with_subtitles = f.bool_child ("WithSubtitles");
389 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
390 _dci_metadata = DCIMetadata (f.node_child ("DCIMetadata"));
391 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
392 _dci_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
393 _encrypted = f.bool_child ("Encrypted");
394 _audio_channels = f.number_child<int> ("AudioChannels");
395 _sequence_video = f.bool_child ("SequenceVideo");
396 _three_d = f.bool_child ("ThreeD");
397 _interop = f.bool_child ("Interop");
399 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"));
404 /** Given a directory name, return its full path within the Film's directory.
405 * The directory (and its parents) will be created if they do not exist.
408 Film::dir (string d) const
410 boost::filesystem::path p;
414 boost::filesystem::create_directories (p);
419 /** Given a file or directory name, return its full path within the Film's directory.
420 * Any required parent directories will be created.
423 Film::file (string f) const
425 boost::filesystem::path p;
429 boost::filesystem::create_directories (p.parent_path ());
434 /** @return a DCI-compliant name for a DCP of this film */
436 Film::dci_name (bool if_created_now) const
440 string fixed_name = to_upper_copy (name());
441 for (size_t i = 0; i < fixed_name.length(); ++i) {
442 if (fixed_name[i] == ' ') {
447 /* Spec is that the name part should be maximum 14 characters, as I understand it */
448 if (fixed_name.length() > 14) {
449 fixed_name = fixed_name.substr (0, 14);
454 if (dcp_content_type()) {
455 d << "_" << dcp_content_type()->dci_name();
456 d << "-" << dci_metadata().content_version;
463 if (video_frame_rate() != 24) {
464 d << "-" << video_frame_rate();
468 d << "_" << container()->dci_name();
471 DCIMetadata const dm = dci_metadata ();
473 if (!dm.audio_language.empty ()) {
474 d << "_" << dm.audio_language;
475 if (!dm.subtitle_language.empty() && with_subtitles()) {
476 d << "-" << dm.subtitle_language;
482 if (!dm.territory.empty ()) {
483 d << "_" << dm.territory;
484 if (!dm.rating.empty ()) {
485 d << "-" << dm.rating;
489 switch (audio_channels ()) {
510 d << "_" << resolution_to_string (_resolution);
512 if (!dm.studio.empty ()) {
513 d << "_" << dm.studio;
516 if (if_created_now) {
517 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
519 d << "_" << boost::gregorian::to_iso_string (_dci_date);
522 if (!dm.facility.empty ()) {
523 d << "_" << dm.facility;
526 if (!dm.package_type.empty ()) {
527 d << "_" << dm.package_type;
533 /** @return name to give the DCP */
535 Film::dcp_name (bool if_created_now) const
537 if (use_dci_name()) {
538 return dci_name (if_created_now);
546 Film::set_directory (string d)
553 Film::set_name (string n)
556 signal_changed (NAME);
560 Film::set_use_dci_name (bool u)
563 signal_changed (USE_DCI_NAME);
567 Film::set_dcp_content_type (DCPContentType const * t)
569 _dcp_content_type = t;
570 signal_changed (DCP_CONTENT_TYPE);
574 Film::set_container (Ratio const * c)
577 signal_changed (CONTAINER);
581 Film::set_resolution (Resolution r)
584 signal_changed (RESOLUTION);
588 Film::set_scaler (Scaler const * s)
591 signal_changed (SCALER);
595 Film::set_with_subtitles (bool w)
598 signal_changed (WITH_SUBTITLES);
602 Film::set_j2k_bandwidth (int b)
605 signal_changed (J2K_BANDWIDTH);
609 Film::set_dci_metadata (DCIMetadata m)
612 signal_changed (DCI_METADATA);
616 Film::set_video_frame_rate (int f)
618 _video_frame_rate = f;
619 signal_changed (VIDEO_FRAME_RATE);
623 Film::set_audio_channels (int c)
626 signal_changed (AUDIO_CHANNELS);
630 Film::set_three_d (bool t)
633 signal_changed (THREE_D);
637 Film::set_interop (bool i)
640 signal_changed (INTEROP);
644 Film::signal_changed (Property p)
650 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
652 case Film::VIDEO_FRAME_RATE:
653 case Film::SEQUENCE_VIDEO:
654 _playlist->maybe_sequence_video ();
661 ui_signaller->emit (boost::bind (boost::ref (Changed), p));
666 Film::set_dci_date_today ()
668 _dci_date = boost::gregorian::day_clock::local_day ();
672 Film::info_path (int f, Eyes e) const
674 boost::filesystem::path p;
679 s << setfill('0') << f;
681 if (e == EYES_LEFT) {
683 } else if (e == EYES_RIGHT) {
691 /* info_dir() will already have added any initial bit of the path,
692 so don't call file() on this.
698 Film::j2c_path (int f, Eyes e, bool t) const
700 boost::filesystem::path p;
702 p /= video_identifier ();
706 s << setfill('0') << f;
708 if (e == EYES_LEFT) {
710 } else if (e == EYES_RIGHT) {
721 return file (p.string ());
724 /** Make an educated guess as to whether we have a complete DCP
726 * @return true if we do.
730 Film::have_dcp () const
733 libdcp::DCP dcp (dir (dcp_name()));
743 Film::make_player () const
745 return shared_ptr<Player> (new Player (shared_from_this (), _playlist));
749 Film::set_encrypted (bool e)
752 signal_changed (ENCRYPTED);
756 Film::playlist () const
762 Film::content () const
764 return _playlist->content ();
768 Film::examine_and_add_content (shared_ptr<Content> c)
770 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
771 j->Finished.connect (bind (&Film::maybe_add_content, this, boost::weak_ptr<Job> (j), boost::weak_ptr<Content> (c)));
772 JobManager::instance()->add (j);
776 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
778 shared_ptr<Job> job = j.lock ();
779 if (!job || !job->finished_ok ()) {
783 shared_ptr<Content> content = c.lock ();
785 add_content (content);
790 Film::add_content (shared_ptr<Content> c)
792 /* Add video content after any existing content */
793 if (dynamic_pointer_cast<VideoContent> (c)) {
794 c->set_position (_playlist->video_end ());
801 Film::remove_content (shared_ptr<Content> c)
803 _playlist->remove (c);
807 Film::length () const
809 return _playlist->length ();
813 Film::has_subtitles () const
815 return _playlist->has_subtitles ();
819 Film::best_video_frame_rate () const
821 return _playlist->best_dcp_frame_rate ();
825 Film::playlist_content_changed (boost::weak_ptr<Content> c, int p)
827 if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
828 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
832 ui_signaller->emit (boost::bind (boost::ref (ContentChanged), c, p));
837 Film::playlist_changed ()
839 signal_changed (CONTENT);
843 Film::time_to_audio_frames (Time t) const
845 return t * audio_frame_rate () / TIME_HZ;
849 Film::time_to_video_frames (Time t) const
851 return t * video_frame_rate () / TIME_HZ;
855 Film::audio_frames_to_time (OutputAudioFrame f) const
857 return f * TIME_HZ / audio_frame_rate ();
861 Film::video_frames_to_time (OutputVideoFrame f) const
863 return f * TIME_HZ / video_frame_rate ();
867 Film::audio_frame_rate () const
874 Film::set_sequence_video (bool s)
877 _playlist->set_sequence_video (s);
878 signal_changed (SEQUENCE_VIDEO);
882 Film::full_frame () const
884 switch (_resolution) {
886 return libdcp::Size (2048, 1080);
888 return libdcp::Size (4096, 2160);
892 return libdcp::Size ();
897 list<shared_ptr<Screen> > screens,
898 boost::posix_time::ptime from,
899 boost::posix_time::ptime until,
903 boost::filesystem::path const sd = Config::instance()->signer_chain_directory ();
904 if (boost::filesystem::is_empty (sd)) {
905 libdcp::make_signer_chain (sd);
908 libdcp::CertificateChain chain;
911 boost::filesystem::path p (sd);
912 p /= "ca.self-signed.pem";
913 chain.add (shared_ptr<libdcp::Certificate> (new libdcp::Certificate (p.string ())));
917 boost::filesystem::path p (sd);
918 p /= "intermediate.signed.pem";
919 chain.add (shared_ptr<libdcp::Certificate> (new libdcp::Certificate (p.string ())));
923 boost::filesystem::path p (sd);
924 p /= "leaf.signed.pem";
925 chain.add (shared_ptr<libdcp::Certificate> (new libdcp::Certificate (p.string ())));
928 boost::filesystem::path signer_key (sd);
929 signer_key /= "leaf.key";
931 shared_ptr<const Signer> signer (new Signer (chain, signer_key));
933 /* Find the DCP to make the KDM for */
934 string const dir = this->directory ();
936 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
937 if (boost::filesystem::is_directory (*i) && i->path().leaf() != "j2c" && i->path().leaf() != "wavs") {
938 dcps.push_back (i->path().string());
943 throw KDMError ("Could not find DCP to make KDM for");
944 } else if (dcps.size() > 1) {
945 throw KDMError ("More than one possible DCP to make KDM for");
948 for (list<shared_ptr<Screen> >::iterator i = screens.begin(); i != screens.end(); ++i) {
950 libdcp::DCP dcp (dcps.front ());
953 /* XXX: single CPL only */
954 shared_ptr<xmlpp::Document> kdm = dcp.cpls().front()->make_kdm (
955 signer, (*i)->certificate, from, until, _interop, libdcp::MXFMetadata (), Config::instance()->dcp_metadata ()
958 boost::filesystem::path out = directory;
960 kdm->write_to_file_formatted (out.string());