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;
75 using boost::shared_ptr;
76 using boost::weak_ptr;
77 using boost::lexical_cast;
78 using boost::dynamic_pointer_cast;
79 using boost::to_upper_copy;
80 using boost::ends_with;
81 using boost::starts_with;
82 using boost::optional;
86 int const Film::state_version = 4;
88 /** Construct a Film object in a given directory.
90 * @param dir Film directory.
93 Film::Film (boost::filesystem::path dir)
94 : _playlist (new Playlist)
95 , _use_dci_name (true)
96 , _dcp_content_type (Config::instance()->default_dcp_content_type ())
97 , _container (Config::instance()->default_container ())
98 , _resolution (RESOLUTION_2K)
99 , _scaler (Scaler::from_id ("bicubic"))
100 , _with_subtitles (false)
102 , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
103 , _dci_metadata (Config::instance()->default_dci_metadata ())
104 , _video_frame_rate (24)
105 , _audio_channels (MAX_AUDIO_CHANNELS)
107 , _sequence_video (true)
111 set_dci_date_today ();
113 _playlist->Changed.connect (bind (&Film::playlist_changed, this));
114 _playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2));
116 /* Make state.directory a complete path without ..s (where possible)
117 (Code swiped from Adam Bowen on stackoverflow)
120 boost::filesystem::path p (boost::filesystem::system_complete (dir));
121 boost::filesystem::path result;
122 for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
124 if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
127 result = result.parent_path ();
129 } else if (*i != ".") {
134 set_directory (result);
135 _log.reset (new FileLog (file ("log")));
137 _playlist->set_sequence_video (_sequence_video);
141 Film::video_identifier () const
143 assert (container ());
147 s << container()->id()
148 << "_" << resolution_to_string (_resolution)
149 << "_" << _playlist->video_identifier()
150 << "_" << _video_frame_rate
151 << "_" << scaler()->id()
152 << "_" << j2k_bandwidth();
167 /** @return The path to the directory to write video frame info files to */
168 boost::filesystem::path
169 Film::info_dir () const
171 boost::filesystem::path p;
173 p /= video_identifier ();
177 boost::filesystem::path
178 Film::internal_video_mxf_dir () const
180 return dir ("video");
183 boost::filesystem::path
184 Film::internal_video_mxf_filename () const
186 return video_identifier() + ".mxf";
189 boost::filesystem::path
190 Film::video_mxf_filename () const
192 return filename_safe_name() + "_video.mxf";
195 boost::filesystem::path
196 Film::audio_mxf_filename () const
198 return filename_safe_name() + "_audio.mxf";
202 Film::filename_safe_name () const
204 string const n = name ();
206 for (size_t i = 0; i < n.length(); ++i) {
207 if (isalnum (n[i])) {
217 boost::filesystem::path
218 Film::audio_analysis_path (shared_ptr<const AudioContent> c) const
220 boost::filesystem::path p = dir ("analysis");
225 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
229 set_dci_date_today ();
231 if (dcp_name().find ("/") != string::npos) {
232 throw BadSettingError (_("name"), _("cannot contain slashes"));
235 log()->log (String::compose ("DCP-o-matic %1 git %2 using %3", dcpomatic_version, dcpomatic_git_commit, dependency_version_summary()));
239 gethostname (buffer, sizeof (buffer));
240 log()->log (String::compose ("Starting to make DCP on %1", buffer));
243 ContentList cl = content ();
244 for (ContentList::const_iterator i = cl.begin(); i != cl.end(); ++i) {
245 log()->log (String::compose ("Content: %1", (*i)->technical_summary()));
247 log()->log (String::compose ("DCP video rate %1 fps", video_frame_rate()));
248 log()->log (String::compose ("%1 threads", Config::instance()->num_local_encoding_threads()));
249 log()->log (String::compose ("J2K bandwidth %1", j2k_bandwidth()));
250 #ifdef DCPOMATIC_DEBUG
251 log()->log ("DCP-o-matic built in debug mode.");
253 log()->log ("DCP-o-matic built in optimised mode.");
256 log()->log ("libdcp built in debug mode.");
258 log()->log ("libdcp built in optimised mode.");
260 log()->log (String::compose ("CPU: %1, %2 processors", cpu_info(), boost::thread::hardware_concurrency ()));
261 list<pair<string, string> > const m = mount_info ();
262 for (list<pair<string, string> >::const_iterator i = m.begin(); i != m.end(); ++i) {
263 log()->log (String::compose ("Mount: %1 %2", i->first, i->second));
266 if (container() == 0) {
267 throw MissingSettingError (_("container"));
270 if (content().empty()) {
271 throw StringError (_("You must add some content to the DCP before creating it"));
274 if (dcp_content_type() == 0) {
275 throw MissingSettingError (_("content type"));
278 if (name().empty()) {
279 throw MissingSettingError (_("name"));
282 JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
285 /** Start a job to send our DCP to the configured TMS */
287 Film::send_dcp_to_tms ()
289 shared_ptr<Job> j (new SCPDCPJob (shared_from_this()));
290 JobManager::instance()->add (j);
293 /** Count the number of frames that have been encoded for this film.
294 * @return frame count.
297 Film::encoded_frames () const
299 if (container() == 0) {
304 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (info_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
306 boost::this_thread::interruption_point ();
312 /** Write state to our `metadata' file */
314 Film::write_metadata () const
316 if (!boost::filesystem::exists (directory ())) {
317 boost::filesystem::create_directory (directory ());
322 boost::filesystem::create_directories (directory ());
325 xmlpp::Element* root = doc.create_root_node ("Metadata");
327 root->add_child("Version")->add_child_text (lexical_cast<string> (state_version));
328 root->add_child("Name")->add_child_text (_name);
329 root->add_child("UseDCIName")->add_child_text (_use_dci_name ? "1" : "0");
331 if (_dcp_content_type) {
332 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->dci_name ());
336 root->add_child("Container")->add_child_text (_container->id ());
339 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
340 root->add_child("Scaler")->add_child_text (_scaler->id ());
341 root->add_child("WithSubtitles")->add_child_text (_with_subtitles ? "1" : "0");
342 root->add_child("J2KBandwidth")->add_child_text (lexical_cast<string> (_j2k_bandwidth));
343 _dci_metadata.as_xml (root->add_child ("DCIMetadata"));
344 root->add_child("VideoFrameRate")->add_child_text (lexical_cast<string> (_video_frame_rate));
345 root->add_child("DCIDate")->add_child_text (boost::gregorian::to_iso_string (_dci_date));
346 root->add_child("AudioChannels")->add_child_text (lexical_cast<string> (_audio_channels));
347 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
348 root->add_child("SequenceVideo")->add_child_text (_sequence_video ? "1" : "0");
349 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
350 root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
351 root->add_child("Key")->add_child_text (_key.hex ());
352 _playlist->as_xml (root->add_child ("Playlist"));
354 doc.write_to_file_formatted (file("metadata.xml").string ());
359 /** Read state from our metadata file */
361 Film::read_metadata ()
365 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
366 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!"));
369 cxml::Document f ("Metadata");
370 f.read_file (file ("metadata.xml"));
372 _name = f.string_child ("Name");
373 _use_dci_name = f.bool_child ("UseDCIName");
376 optional<string> c = f.optional_string_child ("DCPContentType");
378 _dcp_content_type = DCPContentType::from_dci_name (c.get ());
383 optional<string> c = f.optional_string_child ("Container");
385 _container = Ratio::from_id (c.get ());
389 _resolution = string_to_resolution (f.string_child ("Resolution"));
390 _scaler = Scaler::from_id (f.string_child ("Scaler"));
391 _with_subtitles = f.bool_child ("WithSubtitles");
392 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
393 _dci_metadata = DCIMetadata (f.node_child ("DCIMetadata"));
394 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
395 _dci_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
396 _encrypted = f.bool_child ("Encrypted");
397 _audio_channels = f.number_child<int> ("AudioChannels");
398 _sequence_video = f.bool_child ("SequenceVideo");
399 _three_d = f.bool_child ("ThreeD");
400 _interop = f.bool_child ("Interop");
401 _key = libdcp::Key (f.string_child ("Key"));
402 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"));
407 /** Given a directory name, return its full path within the Film's directory.
408 * The directory (and its parents) will be created if they do not exist.
410 boost::filesystem::path
411 Film::dir (boost::filesystem::path d) const
413 boost::filesystem::path p;
417 boost::filesystem::create_directories (p);
422 /** Given a file or directory name, return its full path within the Film's directory.
423 * Any required parent directories will be created.
425 boost::filesystem::path
426 Film::file (boost::filesystem::path f) const
428 boost::filesystem::path p;
432 boost::filesystem::create_directories (p.parent_path ());
437 /** @return a DCI-compliant name for a DCP of this film */
439 Film::dci_name (bool if_created_now) const
443 string fixed_name = to_upper_copy (name());
444 for (size_t i = 0; i < fixed_name.length(); ++i) {
445 if (fixed_name[i] == ' ') {
450 /* Spec is that the name part should be maximum 14 characters, as I understand it */
451 if (fixed_name.length() > 14) {
452 fixed_name = fixed_name.substr (0, 14);
457 if (dcp_content_type()) {
458 d << "_" << dcp_content_type()->dci_name();
459 d << "-" << dci_metadata().content_version;
466 if (video_frame_rate() != 24) {
467 d << "-" << video_frame_rate();
471 d << "_" << container()->dci_name();
474 DCIMetadata const dm = dci_metadata ();
476 if (!dm.audio_language.empty ()) {
477 d << "_" << dm.audio_language;
478 if (!dm.subtitle_language.empty()) {
479 d << "-" << dm.subtitle_language;
485 if (!dm.territory.empty ()) {
486 d << "_" << dm.territory;
487 if (!dm.rating.empty ()) {
488 d << "-" << dm.rating;
492 switch (audio_channels ()) {
513 d << "_" << resolution_to_string (_resolution);
515 if (!dm.studio.empty ()) {
516 d << "_" << dm.studio;
519 if (if_created_now) {
520 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
522 d << "_" << boost::gregorian::to_iso_string (_dci_date);
525 if (!dm.facility.empty ()) {
526 d << "_" << dm.facility;
529 if (!dm.package_type.empty ()) {
530 d << "_" << dm.package_type;
536 /** @return name to give the DCP */
538 Film::dcp_name (bool if_created_now) const
540 if (use_dci_name()) {
541 return dci_name (if_created_now);
549 Film::set_directory (boost::filesystem::path d)
556 Film::set_name (string n)
559 signal_changed (NAME);
563 Film::set_use_dci_name (bool u)
566 signal_changed (USE_DCI_NAME);
570 Film::set_dcp_content_type (DCPContentType const * t)
572 _dcp_content_type = t;
573 signal_changed (DCP_CONTENT_TYPE);
577 Film::set_container (Ratio const * c)
580 signal_changed (CONTAINER);
584 Film::set_resolution (Resolution r)
587 signal_changed (RESOLUTION);
591 Film::set_scaler (Scaler const * s)
594 signal_changed (SCALER);
598 Film::set_with_subtitles (bool w)
601 signal_changed (WITH_SUBTITLES);
605 Film::set_j2k_bandwidth (int b)
608 signal_changed (J2K_BANDWIDTH);
612 Film::set_dci_metadata (DCIMetadata m)
615 signal_changed (DCI_METADATA);
619 Film::set_video_frame_rate (int f)
621 _video_frame_rate = f;
622 signal_changed (VIDEO_FRAME_RATE);
626 Film::set_audio_channels (int c)
629 signal_changed (AUDIO_CHANNELS);
633 Film::set_three_d (bool t)
636 signal_changed (THREE_D);
640 Film::set_interop (bool i)
643 signal_changed (INTEROP);
647 Film::signal_changed (Property p)
653 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
655 case Film::VIDEO_FRAME_RATE:
656 case Film::SEQUENCE_VIDEO:
657 _playlist->maybe_sequence_video ();
664 ui_signaller->emit (boost::bind (boost::ref (Changed), p));
669 Film::set_dci_date_today ()
671 _dci_date = boost::gregorian::day_clock::local_day ();
674 boost::filesystem::path
675 Film::info_path (int f, Eyes e) const
677 boost::filesystem::path p;
682 s << setfill('0') << f;
684 if (e == EYES_LEFT) {
686 } else if (e == EYES_RIGHT) {
694 /* info_dir() will already have added any initial bit of the path,
695 so don't call file() on this.
700 boost::filesystem::path
701 Film::j2c_path (int f, Eyes e, bool t) const
703 boost::filesystem::path p;
705 p /= video_identifier ();
709 s << setfill('0') << f;
711 if (e == EYES_LEFT) {
713 } else if (e == EYES_RIGHT) {
727 /** @return List of subdirectories (not full paths) containing DCPs that can be successfully libdcp::DCP::read() */
728 list<boost::filesystem::path>
731 list<boost::filesystem::path> out;
733 boost::filesystem::path const dir = directory ();
734 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
736 boost::filesystem::is_directory (*i) &&
737 i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
741 libdcp::DCP dcp (*i);
743 out.push_back (i->path().leaf ());
754 Film::make_player () const
756 return shared_ptr<Player> (new Player (shared_from_this (), _playlist));
760 Film::set_encrypted (bool e)
763 signal_changed (ENCRYPTED);
767 Film::playlist () const
773 Film::content () const
775 return _playlist->content ();
779 Film::examine_and_add_content (shared_ptr<Content> c)
781 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
782 j->Finished.connect (bind (&Film::maybe_add_content, this, boost::weak_ptr<Job> (j), boost::weak_ptr<Content> (c)));
783 JobManager::instance()->add (j);
787 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
789 shared_ptr<Job> job = j.lock ();
790 if (!job || !job->finished_ok ()) {
794 shared_ptr<Content> content = c.lock ();
796 add_content (content);
801 Film::add_content (shared_ptr<Content> c)
803 /* Add video content after any existing content */
804 if (dynamic_pointer_cast<VideoContent> (c)) {
805 c->set_position (_playlist->video_end ());
812 Film::remove_content (shared_ptr<Content> c)
814 _playlist->remove (c);
818 Film::move_content_earlier (shared_ptr<Content> c)
820 _playlist->move_earlier (c);
824 Film::move_content_later (shared_ptr<Content> c)
826 _playlist->move_later (c);
830 Film::length () const
832 return _playlist->length ();
836 Film::has_subtitles () const
838 return _playlist->has_subtitles ();
842 Film::best_video_frame_rate () const
844 return _playlist->best_dcp_frame_rate ();
848 Film::content_paths_valid () const
850 return _playlist->content_paths_valid ();
854 Film::playlist_content_changed (boost::weak_ptr<Content> c, int p)
856 if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
857 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
861 ui_signaller->emit (boost::bind (boost::ref (ContentChanged), c, p));
866 Film::playlist_changed ()
868 signal_changed (CONTENT);
872 Film::time_to_audio_frames (Time t) const
874 return t * audio_frame_rate () / TIME_HZ;
878 Film::time_to_video_frames (Time t) const
880 return t * video_frame_rate () / TIME_HZ;
884 Film::audio_frames_to_time (OutputAudioFrame f) const
886 return f * TIME_HZ / audio_frame_rate ();
890 Film::video_frames_to_time (OutputVideoFrame f) const
892 return f * TIME_HZ / video_frame_rate ();
896 Film::audio_frame_rate () const
903 Film::set_sequence_video (bool s)
906 _playlist->set_sequence_video (s);
907 signal_changed (SEQUENCE_VIDEO);
911 Film::full_frame () const
913 switch (_resolution) {
915 return libdcp::Size (2048, 1080);
917 return libdcp::Size (4096, 2160);
921 return libdcp::Size ();
926 shared_ptr<libdcp::Certificate> target,
927 boost::filesystem::path dcp_dir,
928 boost::posix_time::ptime from,
929 boost::posix_time::ptime until
932 shared_ptr<const Signer> signer = make_signer ();
934 libdcp::DCP dcp (dir (dcp_dir.string ()));
939 throw KDMError (_("Could not read DCP to make KDM for"));
942 time_t now = time (0);
943 struct tm* tm = localtime (&now);
944 string const issue_date = libdcp::tm_to_string (tm);
946 dcp.cpls().front()->set_mxf_keys (key ());
948 return libdcp::KDM (dcp.cpls().front(), signer, target, from, until, "DCP-o-matic", issue_date);
953 list<shared_ptr<Screen> > screens,
954 boost::filesystem::path dcp,
955 boost::posix_time::ptime from,
956 boost::posix_time::ptime until
959 list<libdcp::KDM> kdms;
961 for (list<shared_ptr<Screen> >::iterator i = screens.begin(); i != screens.end(); ++i) {
962 kdms.push_back (make_kdm ((*i)->certificate, dcp, from, until));