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/crypt_chain.h>
35 #include <libdcp/cpl.h>
39 #include "job_manager.h"
40 #include "transcode_job.h"
41 #include "scp_dcp_job.h"
43 #include "exceptions.h"
44 #include "examine_content_job.h"
48 #include "ui_signaller.h"
51 #include "dcp_content_type.h"
59 using std::stringstream;
72 using boost::shared_ptr;
73 using boost::weak_ptr;
74 using boost::lexical_cast;
75 using boost::dynamic_pointer_cast;
76 using boost::to_upper_copy;
77 using boost::ends_with;
78 using boost::starts_with;
79 using boost::optional;
82 int const Film::state_version = 4;
84 /** Construct a Film object in a given directory.
86 * @param dir Film directory.
89 Film::Film (boost::filesystem::path dir)
90 : _playlist (new Playlist)
91 , _use_dci_name (true)
92 , _dcp_content_type (Config::instance()->default_dcp_content_type ())
93 , _container (Config::instance()->default_container ())
94 , _resolution (RESOLUTION_2K)
95 , _scaler (Scaler::from_id ("bicubic"))
96 , _with_subtitles (false)
98 , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
99 , _dci_metadata (Config::instance()->default_dci_metadata ())
100 , _video_frame_rate (24)
101 , _audio_channels (MAX_AUDIO_CHANNELS)
103 , _sequence_video (true)
107 set_dci_date_today ();
109 _playlist->Changed.connect (bind (&Film::playlist_changed, this));
110 _playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2));
112 /* Make state.directory a complete path without ..s (where possible)
113 (Code swiped from Adam Bowen on stackoverflow)
116 boost::filesystem::path p (boost::filesystem::system_complete (dir));
117 boost::filesystem::path result;
118 for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
120 if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
123 result = result.parent_path ();
125 } else if (*i != ".") {
130 set_directory (result.string ());
131 _log.reset (new FileLog (file ("log")));
133 _playlist->set_sequence_video (_sequence_video);
137 Film::video_identifier () const
139 assert (container ());
143 s << container()->id()
144 << "_" << resolution_to_string (_resolution)
145 << "_" << _playlist->video_identifier()
146 << "_" << _video_frame_rate
147 << "_" << scaler()->id()
148 << "_" << j2k_bandwidth();
163 /** @return The path to the directory to write video frame info files to */
165 Film::info_dir () const
167 boost::filesystem::path p;
169 p /= video_identifier ();
170 return dir (p.string());
174 Film::internal_video_mxf_dir () const
176 return dir ("video");
180 Film::internal_video_mxf_filename () const
182 return video_identifier() + ".mxf";
186 Film::video_mxf_filename () const
188 return filename_safe_name() + "_video.mxf";
192 Film::audio_mxf_filename () const
194 return filename_safe_name() + "_audio.mxf";
198 Film::filename_safe_name () const
200 string const n = name ();
202 for (size_t i = 0; i < n.length(); ++i) {
203 if (isalnum (n[i])) {
213 boost::filesystem::path
214 Film::audio_analysis_path (shared_ptr<const AudioContent> c) const
216 boost::filesystem::path p = dir ("analysis");
221 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
225 set_dci_date_today ();
227 if (dcp_name().find ("/") != string::npos) {
228 throw BadSettingError (_("name"), _("cannot contain slashes"));
231 log()->log (String::compose ("DCP-o-matic %1 git %2 using %3", dcpomatic_version, dcpomatic_git_commit, dependency_version_summary()));
235 gethostname (buffer, sizeof (buffer));
236 log()->log (String::compose ("Starting to make DCP on %1", buffer));
239 ContentList cl = content ();
240 for (ContentList::const_iterator i = cl.begin(); i != cl.end(); ++i) {
241 log()->log (String::compose ("Content: %1", (*i)->technical_summary()));
243 log()->log (String::compose ("DCP video rate %1 fps", video_frame_rate()));
244 log()->log (String::compose ("%1 threads", Config::instance()->num_local_encoding_threads()));
245 log()->log (String::compose ("J2K bandwidth %1", j2k_bandwidth()));
246 #ifdef DCPOMATIC_DEBUG
247 log()->log ("DCP-o-matic built in debug mode.");
249 log()->log ("DCP-o-matic built in optimised mode.");
252 log()->log ("libdcp built in debug mode.");
254 log()->log ("libdcp built in optimised mode.");
256 log()->log (String::compose ("CPU: %1, %2 processors", cpu_info(), boost::thread::hardware_concurrency ()));
257 list<pair<string, string> > const m = mount_info ();
258 for (list<pair<string, string> >::const_iterator i = m.begin(); i != m.end(); ++i) {
259 log()->log (String::compose ("Mount: %1 %2", i->first, i->second));
262 if (container() == 0) {
263 throw MissingSettingError (_("container"));
266 if (content().empty()) {
267 throw StringError (_("You must add some content to the DCP before creating it"));
270 if (dcp_content_type() == 0) {
271 throw MissingSettingError (_("content type"));
274 if (name().empty()) {
275 throw MissingSettingError (_("name"));
278 JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
281 /** Start a job to send our DCP to the configured TMS */
283 Film::send_dcp_to_tms ()
285 shared_ptr<Job> j (new SCPDCPJob (shared_from_this()));
286 JobManager::instance()->add (j);
289 /** Count the number of frames that have been encoded for this film.
290 * @return frame count.
293 Film::encoded_frames () const
295 if (container() == 0) {
300 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (info_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
302 boost::this_thread::interruption_point ();
308 /** Write state to our `metadata' file */
310 Film::write_metadata () const
312 if (!boost::filesystem::exists (directory())) {
313 boost::filesystem::create_directory (directory());
318 boost::filesystem::create_directories (directory());
321 xmlpp::Element* root = doc.create_root_node ("Metadata");
323 root->add_child("Version")->add_child_text (lexical_cast<string> (state_version));
324 root->add_child("Name")->add_child_text (_name);
325 root->add_child("UseDCIName")->add_child_text (_use_dci_name ? "1" : "0");
327 if (_dcp_content_type) {
328 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->dci_name ());
332 root->add_child("Container")->add_child_text (_container->id ());
335 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
336 root->add_child("Scaler")->add_child_text (_scaler->id ());
337 root->add_child("WithSubtitles")->add_child_text (_with_subtitles ? "1" : "0");
338 root->add_child("J2KBandwidth")->add_child_text (lexical_cast<string> (_j2k_bandwidth));
339 _dci_metadata.as_xml (root->add_child ("DCIMetadata"));
340 root->add_child("VideoFrameRate")->add_child_text (lexical_cast<string> (_video_frame_rate));
341 root->add_child("DCIDate")->add_child_text (boost::gregorian::to_iso_string (_dci_date));
342 root->add_child("AudioChannels")->add_child_text (lexical_cast<string> (_audio_channels));
343 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
344 root->add_child("SequenceVideo")->add_child_text (_sequence_video ? "1" : "0");
345 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
346 root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
347 _playlist->as_xml (root->add_child ("Playlist"));
349 doc.write_to_file_formatted (file ("metadata.xml"));
354 /** Read state from our metadata file */
356 Film::read_metadata ()
360 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
361 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!"));
364 cxml::Document f ("Metadata");
365 f.read_file (file ("metadata.xml"));
367 _name = f.string_child ("Name");
368 _use_dci_name = f.bool_child ("UseDCIName");
371 optional<string> c = f.optional_string_child ("DCPContentType");
373 _dcp_content_type = DCPContentType::from_dci_name (c.get ());
378 optional<string> c = f.optional_string_child ("Container");
380 _container = Ratio::from_id (c.get ());
384 _resolution = string_to_resolution (f.string_child ("Resolution"));
385 _scaler = Scaler::from_id (f.string_child ("Scaler"));
386 _with_subtitles = f.bool_child ("WithSubtitles");
387 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
388 _dci_metadata = DCIMetadata (f.node_child ("DCIMetadata"));
389 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
390 _dci_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
391 _audio_channels = f.number_child<int> ("AudioChannels");
392 _sequence_video = f.bool_child ("SequenceVideo");
393 _three_d = f.bool_child ("ThreeD");
394 _interop = f.bool_child ("Interop");
396 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"));
401 /** Given a directory name, return its full path within the Film's directory.
402 * The directory (and its parents) will be created if they do not exist.
405 Film::dir (string d) const
407 boost::filesystem::path p;
411 boost::filesystem::create_directories (p);
416 /** Given a file or directory name, return its full path within the Film's directory.
417 * Any required parent directories will be created.
420 Film::file (string f) const
422 boost::filesystem::path p;
426 boost::filesystem::create_directories (p.parent_path ());
431 /** @return a DCI-compliant name for a DCP of this film */
433 Film::dci_name (bool if_created_now) const
437 string fixed_name = to_upper_copy (name());
438 for (size_t i = 0; i < fixed_name.length(); ++i) {
439 if (fixed_name[i] == ' ') {
444 /* Spec is that the name part should be maximum 14 characters, as I understand it */
445 if (fixed_name.length() > 14) {
446 fixed_name = fixed_name.substr (0, 14);
451 if (dcp_content_type()) {
452 d << "_" << dcp_content_type()->dci_name();
453 d << "-" << dci_metadata().content_version;
460 if (video_frame_rate() != 24) {
461 d << "-" << video_frame_rate();
465 d << "_" << container()->dci_name();
468 DCIMetadata const dm = dci_metadata ();
470 if (!dm.audio_language.empty ()) {
471 d << "_" << dm.audio_language;
472 if (!dm.subtitle_language.empty() && with_subtitles()) {
473 d << "-" << dm.subtitle_language;
479 if (!dm.territory.empty ()) {
480 d << "_" << dm.territory;
481 if (!dm.rating.empty ()) {
482 d << "-" << dm.rating;
486 switch (audio_channels ()) {
507 d << "_" << resolution_to_string (_resolution);
509 if (!dm.studio.empty ()) {
510 d << "_" << dm.studio;
513 if (if_created_now) {
514 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
516 d << "_" << boost::gregorian::to_iso_string (_dci_date);
519 if (!dm.facility.empty ()) {
520 d << "_" << dm.facility;
523 if (!dm.package_type.empty ()) {
524 d << "_" << dm.package_type;
530 /** @return name to give the DCP */
532 Film::dcp_name (bool if_created_now) const
534 if (use_dci_name()) {
535 return dci_name (if_created_now);
543 Film::set_directory (string d)
550 Film::set_name (string n)
553 signal_changed (NAME);
557 Film::set_use_dci_name (bool u)
560 signal_changed (USE_DCI_NAME);
564 Film::set_dcp_content_type (DCPContentType const * t)
566 _dcp_content_type = t;
567 signal_changed (DCP_CONTENT_TYPE);
571 Film::set_container (Ratio const * c)
574 signal_changed (CONTAINER);
578 Film::set_resolution (Resolution r)
581 signal_changed (RESOLUTION);
585 Film::set_scaler (Scaler const * s)
588 signal_changed (SCALER);
592 Film::set_with_subtitles (bool w)
595 signal_changed (WITH_SUBTITLES);
599 Film::set_j2k_bandwidth (int b)
602 signal_changed (J2K_BANDWIDTH);
606 Film::set_dci_metadata (DCIMetadata m)
609 signal_changed (DCI_METADATA);
613 Film::set_video_frame_rate (int f)
615 _video_frame_rate = f;
616 signal_changed (VIDEO_FRAME_RATE);
620 Film::set_audio_channels (int c)
623 signal_changed (AUDIO_CHANNELS);
627 Film::set_three_d (bool t)
630 signal_changed (THREE_D);
634 Film::set_interop (bool i)
637 signal_changed (INTEROP);
641 Film::signal_changed (Property p)
647 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
649 case Film::VIDEO_FRAME_RATE:
650 case Film::SEQUENCE_VIDEO:
651 _playlist->maybe_sequence_video ();
658 ui_signaller->emit (boost::bind (boost::ref (Changed), p));
663 Film::set_dci_date_today ()
665 _dci_date = boost::gregorian::day_clock::local_day ();
669 Film::info_path (int f, Eyes e) const
671 boost::filesystem::path p;
676 s << setfill('0') << f;
678 if (e == EYES_LEFT) {
680 } else if (e == EYES_RIGHT) {
688 /* info_dir() will already have added any initial bit of the path,
689 so don't call file() on this.
695 Film::j2c_path (int f, Eyes e, bool t) const
697 boost::filesystem::path p;
699 p /= video_identifier ();
703 s << setfill('0') << f;
705 if (e == EYES_LEFT) {
707 } else if (e == EYES_RIGHT) {
718 return file (p.string ());
721 /** Make an educated guess as to whether we have a complete DCP
723 * @return true if we do.
727 Film::have_dcp () const
730 libdcp::DCP dcp (dir (dcp_name()));
740 Film::make_player () const
742 return shared_ptr<Player> (new Player (shared_from_this (), _playlist));
746 Film::set_encrypted (bool e)
749 signal_changed (ENCRYPTED);
753 Film::playlist () const
759 Film::content () const
761 return _playlist->content ();
765 Film::examine_and_add_content (shared_ptr<Content> c)
767 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
768 j->Finished.connect (bind (&Film::maybe_add_content, this, boost::weak_ptr<Job> (j), boost::weak_ptr<Content> (c)));
769 JobManager::instance()->add (j);
773 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
775 shared_ptr<Job> job = j.lock ();
776 if (!job || !job->finished_ok ()) {
780 shared_ptr<Content> content = c.lock ();
782 add_content (content);
787 Film::add_content (shared_ptr<Content> c)
789 /* Add video content after any existing content */
790 if (dynamic_pointer_cast<VideoContent> (c)) {
791 c->set_position (_playlist->video_end ());
798 Film::remove_content (shared_ptr<Content> c)
800 _playlist->remove (c);
804 Film::length () const
806 return _playlist->length ();
810 Film::has_subtitles () const
812 return _playlist->has_subtitles ();
816 Film::best_video_frame_rate () const
818 return _playlist->best_dcp_frame_rate ();
822 Film::playlist_content_changed (boost::weak_ptr<Content> c, int p)
824 if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
825 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
829 ui_signaller->emit (boost::bind (boost::ref (ContentChanged), c, p));
834 Film::playlist_changed ()
836 signal_changed (CONTENT);
840 Film::time_to_audio_frames (Time t) const
842 return t * audio_frame_rate () / TIME_HZ;
846 Film::time_to_video_frames (Time t) const
848 return t * video_frame_rate () / TIME_HZ;
852 Film::audio_frames_to_time (OutputAudioFrame f) const
854 return f * TIME_HZ / audio_frame_rate ();
858 Film::video_frames_to_time (OutputVideoFrame f) const
860 return f * TIME_HZ / video_frame_rate ();
864 Film::audio_frame_rate () const
871 Film::set_sequence_video (bool s)
874 _playlist->set_sequence_video (s);
875 signal_changed (SEQUENCE_VIDEO);
879 Film::full_frame () const
881 switch (_resolution) {
883 return libdcp::Size (2048, 1080);
885 return libdcp::Size (4096, 2160);
889 return libdcp::Size ();
894 list<shared_ptr<Screen> > screens,
895 boost::posix_time::ptime from,
896 boost::posix_time::ptime until,
900 string const cd = Config::instance()->crypt_chain_directory ();
901 if (boost::filesystem::is_empty (cd)) {
902 libdcp::make_crypt_chain (cd);
905 libdcp::CertificateChain chain;
908 boost::filesystem::path p (cd);
909 p /= "ca.self-signed.pem";
910 chain.add (shared_ptr<libdcp::Certificate> (new libdcp::Certificate (p.string ())));
914 boost::filesystem::path p (cd);
915 p /= "intermediate.signed.pem";
916 chain.add (shared_ptr<libdcp::Certificate> (new libdcp::Certificate (p.string ())));
920 boost::filesystem::path p (cd);
921 p /= "leaf.signed.pem";
922 chain.add (shared_ptr<libdcp::Certificate> (new libdcp::Certificate (p.string ())));
925 boost::filesystem::path signer_key (cd);
926 signer_key /= "leaf.key";
928 /* Find the DCP to make the KDM for */
929 string const dir = this->directory ();
931 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
932 if (boost::filesystem::is_directory (*i) && i->path().leaf() != "j2c" && i->path().leaf() != "wavs") {
933 dcps.push_back (i->path().string());
938 throw KDMError ("Could not find DCP to make KDM for");
939 } else if (dcps.size() > 1) {
940 throw KDMError ("More than one possible DCP to make KDM for");
943 for (list<shared_ptr<Screen> >::iterator i = screens.begin(); i != screens.end(); ++i) {
945 libdcp::DCP dcp (dcps.front ());
948 /* XXX: single CPL only */
949 shared_ptr<xmlpp::Document> kdm = dcp.cpls().front()->make_kdm (
950 chain, signer_key.string(), (*i)->certificate, from, until, _interop, libdcp::MXFMetadata (), Config::instance()->dcp_metadata ()
953 boost::filesystem::path out = directory;
955 kdm->write_to_file_formatted (out.string());