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 = 5;
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();
173 /** @return The path to the directory to write video frame info files to */
174 boost::filesystem::path
175 Film::info_dir () const
177 boost::filesystem::path p;
179 p /= video_identifier ();
183 boost::filesystem::path
184 Film::internal_video_mxf_dir () const
186 return dir ("video");
189 boost::filesystem::path
190 Film::internal_video_mxf_filename () const
192 return video_identifier() + ".mxf";
195 boost::filesystem::path
196 Film::video_mxf_filename () const
198 return filename_safe_name() + "_video.mxf";
201 boost::filesystem::path
202 Film::audio_mxf_filename () const
204 return filename_safe_name() + "_audio.mxf";
208 Film::filename_safe_name () const
210 string const n = name ();
212 for (size_t i = 0; i < n.length(); ++i) {
213 if (isalnum (n[i])) {
223 boost::filesystem::path
224 Film::audio_analysis_path (shared_ptr<const AudioContent> c) const
226 boost::filesystem::path p = dir ("analysis");
231 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
235 set_dci_date_today ();
237 if (dcp_name().find ("/") != string::npos) {
238 throw BadSettingError (_("name"), _("cannot contain slashes"));
241 log()->log (String::compose ("DCP-o-matic %1 git %2 using %3", dcpomatic_version, dcpomatic_git_commit, dependency_version_summary()));
245 gethostname (buffer, sizeof (buffer));
246 log()->log (String::compose ("Starting to make DCP on %1", buffer));
249 ContentList cl = content ();
250 for (ContentList::const_iterator i = cl.begin(); i != cl.end(); ++i) {
251 log()->log (String::compose ("Content: %1", (*i)->technical_summary()));
253 log()->log (String::compose ("DCP video rate %1 fps", video_frame_rate()));
254 log()->log (String::compose ("%1 threads", Config::instance()->num_local_encoding_threads()));
255 log()->log (String::compose ("J2K bandwidth %1", j2k_bandwidth()));
256 #ifdef DCPOMATIC_DEBUG
257 log()->log ("DCP-o-matic built in debug mode.");
259 log()->log ("DCP-o-matic built in optimised mode.");
262 log()->log ("libdcp built in debug mode.");
264 log()->log ("libdcp built in optimised mode.");
266 log()->log (String::compose ("CPU: %1, %2 processors", cpu_info(), boost::thread::hardware_concurrency ()));
267 list<pair<string, string> > const m = mount_info ();
268 for (list<pair<string, string> >::const_iterator i = m.begin(); i != m.end(); ++i) {
269 log()->log (String::compose ("Mount: %1 %2", i->first, i->second));
272 if (container() == 0) {
273 throw MissingSettingError (_("container"));
276 if (content().empty()) {
277 throw StringError (_("You must add some content to the DCP before creating it"));
280 if (dcp_content_type() == 0) {
281 throw MissingSettingError (_("content type"));
284 if (name().empty()) {
285 throw MissingSettingError (_("name"));
288 JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
291 /** Start a job to send our DCP to the configured TMS */
293 Film::send_dcp_to_tms ()
295 shared_ptr<Job> j (new SCPDCPJob (shared_from_this()));
296 JobManager::instance()->add (j);
299 /** Count the number of frames that have been encoded for this film.
300 * @return frame count.
303 Film::encoded_frames () const
305 if (container() == 0) {
310 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (info_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
312 boost::this_thread::interruption_point ();
318 /** Write state to our `metadata' file */
320 Film::write_metadata () const
322 if (!boost::filesystem::exists (directory ())) {
323 boost::filesystem::create_directory (directory ());
328 boost::filesystem::create_directories (directory ());
331 xmlpp::Element* root = doc.create_root_node ("Metadata");
333 root->add_child("Version")->add_child_text (lexical_cast<string> (state_version));
334 root->add_child("Name")->add_child_text (_name);
335 root->add_child("UseDCIName")->add_child_text (_use_dci_name ? "1" : "0");
337 if (_dcp_content_type) {
338 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->dci_name ());
342 root->add_child("Container")->add_child_text (_container->id ());
345 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
346 root->add_child("Scaler")->add_child_text (_scaler->id ());
347 root->add_child("WithSubtitles")->add_child_text (_with_subtitles ? "1" : "0");
348 root->add_child("J2KBandwidth")->add_child_text (lexical_cast<string> (_j2k_bandwidth));
349 _dci_metadata.as_xml (root->add_child ("DCIMetadata"));
350 root->add_child("VideoFrameRate")->add_child_text (lexical_cast<string> (_video_frame_rate));
351 root->add_child("DCIDate")->add_child_text (boost::gregorian::to_iso_string (_dci_date));
352 root->add_child("AudioChannels")->add_child_text (lexical_cast<string> (_audio_channels));
353 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
354 root->add_child("SequenceVideo")->add_child_text (_sequence_video ? "1" : "0");
355 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
356 root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
357 root->add_child("Key")->add_child_text (_key.hex ());
358 _playlist->as_xml (root->add_child ("Playlist"));
360 doc.write_to_file_formatted (file("metadata.xml").string ());
365 /** Read state from our metadata file */
367 Film::read_metadata ()
371 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
372 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!"));
375 cxml::Document f ("Metadata");
376 f.read_file (file ("metadata.xml"));
378 int const version = f.number_child<int> ("Version");
380 _name = f.string_child ("Name");
381 _use_dci_name = f.bool_child ("UseDCIName");
384 optional<string> c = f.optional_string_child ("DCPContentType");
386 _dcp_content_type = DCPContentType::from_dci_name (c.get ());
391 optional<string> c = f.optional_string_child ("Container");
393 _container = Ratio::from_id (c.get ());
397 _resolution = string_to_resolution (f.string_child ("Resolution"));
398 _scaler = Scaler::from_id (f.string_child ("Scaler"));
399 _with_subtitles = f.bool_child ("WithSubtitles");
400 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
401 _dci_metadata = DCIMetadata (f.node_child ("DCIMetadata"));
402 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
403 _dci_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
404 _encrypted = f.bool_child ("Encrypted");
405 _audio_channels = f.number_child<int> ("AudioChannels");
406 _sequence_video = f.bool_child ("SequenceVideo");
407 _three_d = f.bool_child ("ThreeD");
408 _interop = f.bool_child ("Interop");
409 _key = libdcp::Key (f.string_child ("Key"));
410 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), version);
415 /** Given a directory name, return its full path within the Film's directory.
416 * The directory (and its parents) will be created if they do not exist.
418 boost::filesystem::path
419 Film::dir (boost::filesystem::path d) const
421 boost::filesystem::path p;
425 boost::filesystem::create_directories (p);
430 /** Given a file or directory name, return its full path within the Film's directory.
431 * Any required parent directories will be created.
433 boost::filesystem::path
434 Film::file (boost::filesystem::path f) const
436 boost::filesystem::path p;
440 boost::filesystem::create_directories (p.parent_path ());
445 /** @return a DCI-compliant name for a DCP of this film */
447 Film::dci_name (bool if_created_now) const
451 string fixed_name = to_upper_copy (name());
452 for (size_t i = 0; i < fixed_name.length(); ++i) {
453 if (fixed_name[i] == ' ') {
458 /* Spec is that the name part should be maximum 14 characters, as I understand it */
459 if (fixed_name.length() > 14) {
460 fixed_name = fixed_name.substr (0, 14);
465 if (dcp_content_type()) {
466 d << "_" << dcp_content_type()->dci_name();
467 d << "-" << dci_metadata().content_version;
474 if (video_frame_rate() != 24) {
475 d << "-" << video_frame_rate();
479 d << "_" << container()->dci_name();
482 DCIMetadata const dm = dci_metadata ();
484 if (!dm.audio_language.empty ()) {
485 d << "_" << dm.audio_language;
486 if (!dm.subtitle_language.empty()) {
487 d << "-" << dm.subtitle_language;
493 if (!dm.territory.empty ()) {
494 d << "_" << dm.territory;
495 if (!dm.rating.empty ()) {
496 d << "-" << dm.rating;
500 switch (audio_channels ()) {
521 d << "_" << resolution_to_string (_resolution);
523 if (!dm.studio.empty ()) {
524 d << "_" << dm.studio;
527 if (if_created_now) {
528 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
530 d << "_" << boost::gregorian::to_iso_string (_dci_date);
533 if (!dm.facility.empty ()) {
534 d << "_" << dm.facility;
537 if (!dm.package_type.empty ()) {
538 d << "_" << dm.package_type;
544 /** @return name to give the DCP */
546 Film::dcp_name (bool if_created_now) const
548 if (use_dci_name()) {
549 return dci_name (if_created_now);
557 Film::set_directory (boost::filesystem::path d)
564 Film::set_name (string n)
567 signal_changed (NAME);
571 Film::set_use_dci_name (bool u)
574 signal_changed (USE_DCI_NAME);
578 Film::set_dcp_content_type (DCPContentType const * t)
580 _dcp_content_type = t;
581 signal_changed (DCP_CONTENT_TYPE);
585 Film::set_container (Ratio const * c)
588 signal_changed (CONTAINER);
592 Film::set_resolution (Resolution r)
595 signal_changed (RESOLUTION);
599 Film::set_scaler (Scaler const * s)
602 signal_changed (SCALER);
606 Film::set_with_subtitles (bool w)
609 signal_changed (WITH_SUBTITLES);
613 Film::set_j2k_bandwidth (int b)
616 signal_changed (J2K_BANDWIDTH);
620 Film::set_dci_metadata (DCIMetadata m)
623 signal_changed (DCI_METADATA);
627 Film::set_video_frame_rate (int f)
629 _video_frame_rate = f;
630 signal_changed (VIDEO_FRAME_RATE);
634 Film::set_audio_channels (int c)
637 signal_changed (AUDIO_CHANNELS);
641 Film::set_three_d (bool t)
644 signal_changed (THREE_D);
648 Film::set_interop (bool i)
651 signal_changed (INTEROP);
655 Film::signal_changed (Property p)
661 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
663 case Film::VIDEO_FRAME_RATE:
664 case Film::SEQUENCE_VIDEO:
665 _playlist->maybe_sequence_video ();
672 ui_signaller->emit (boost::bind (boost::ref (Changed), p));
677 Film::set_dci_date_today ()
679 _dci_date = boost::gregorian::day_clock::local_day ();
682 boost::filesystem::path
683 Film::info_path (int f, Eyes e) const
685 boost::filesystem::path p;
690 s << setfill('0') << f;
692 if (e == EYES_LEFT) {
694 } else if (e == EYES_RIGHT) {
702 /* info_dir() will already have added any initial bit of the path,
703 so don't call file() on this.
708 boost::filesystem::path
709 Film::j2c_path (int f, Eyes e, bool t) const
711 boost::filesystem::path p;
713 p /= video_identifier ();
717 s << setfill('0') << f;
719 if (e == EYES_LEFT) {
721 } else if (e == EYES_RIGHT) {
735 /** @return List of subdirectories (not full paths) containing DCPs that can be successfully libdcp::DCP::read() */
736 list<boost::filesystem::path>
739 list<boost::filesystem::path> out;
741 boost::filesystem::path const dir = directory ();
742 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
744 boost::filesystem::is_directory (*i) &&
745 i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
749 libdcp::DCP dcp (*i);
751 out.push_back (i->path().leaf ());
762 Film::make_player () const
764 return shared_ptr<Player> (new Player (shared_from_this (), _playlist));
768 Film::set_encrypted (bool e)
771 signal_changed (ENCRYPTED);
775 Film::playlist () const
781 Film::content () const
783 return _playlist->content ();
787 Film::examine_and_add_content (shared_ptr<Content> c)
789 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
790 j->Finished.connect (bind (&Film::maybe_add_content, this, boost::weak_ptr<Job> (j), boost::weak_ptr<Content> (c)));
791 JobManager::instance()->add (j);
795 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
797 shared_ptr<Job> job = j.lock ();
798 if (!job || !job->finished_ok ()) {
802 shared_ptr<Content> content = c.lock ();
804 add_content (content);
809 Film::add_content (shared_ptr<Content> c)
811 /* Add video content after any existing content */
812 if (dynamic_pointer_cast<VideoContent> (c)) {
813 c->set_position (_playlist->video_end ());
820 Film::remove_content (shared_ptr<Content> c)
822 _playlist->remove (c);
826 Film::move_content_earlier (shared_ptr<Content> c)
828 _playlist->move_earlier (c);
832 Film::move_content_later (shared_ptr<Content> c)
834 _playlist->move_later (c);
838 Film::length () const
840 return _playlist->length ();
844 Film::has_subtitles () const
846 return _playlist->has_subtitles ();
850 Film::best_video_frame_rate () const
852 return _playlist->best_dcp_frame_rate ();
856 Film::content_paths_valid () const
858 return _playlist->content_paths_valid ();
862 Film::playlist_content_changed (boost::weak_ptr<Content> c, int p)
864 if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
865 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
869 ui_signaller->emit (boost::bind (boost::ref (ContentChanged), c, p));
874 Film::playlist_changed ()
876 signal_changed (CONTENT);
880 Film::time_to_audio_frames (Time t) const
882 return t * audio_frame_rate () / TIME_HZ;
886 Film::time_to_video_frames (Time t) const
888 return t * video_frame_rate () / TIME_HZ;
892 Film::audio_frames_to_time (OutputAudioFrame f) const
894 return f * TIME_HZ / audio_frame_rate ();
898 Film::video_frames_to_time (OutputVideoFrame f) const
900 return f * TIME_HZ / video_frame_rate ();
904 Film::audio_frame_rate () const
911 Film::set_sequence_video (bool s)
914 _playlist->set_sequence_video (s);
915 signal_changed (SEQUENCE_VIDEO);
919 Film::full_frame () const
921 switch (_resolution) {
923 return libdcp::Size (2048, 1080);
925 return libdcp::Size (4096, 2160);
929 return libdcp::Size ();
934 shared_ptr<libdcp::Certificate> target,
935 boost::filesystem::path dcp_dir,
936 boost::posix_time::ptime from,
937 boost::posix_time::ptime until
940 shared_ptr<const Signer> signer = make_signer ();
942 libdcp::DCP dcp (dir (dcp_dir.string ()));
947 throw KDMError (_("Could not read DCP to make KDM for"));
950 time_t now = time (0);
951 struct tm* tm = localtime (&now);
952 string const issue_date = libdcp::tm_to_string (tm);
954 dcp.cpls().front()->set_mxf_keys (key ());
956 return libdcp::KDM (dcp.cpls().front(), signer, target, from, until, "DCP-o-matic", issue_date);
961 list<shared_ptr<Screen> > screens,
962 boost::filesystem::path dcp,
963 boost::posix_time::ptime from,
964 boost::posix_time::ptime until
967 list<libdcp::KDM> kdms;
969 for (list<shared_ptr<Screen> >::iterator i = screens.begin(); i != screens.end(); ++i) {
970 kdms.push_back (make_kdm ((*i)->certificate, dcp, from, until));