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 <libxml++/libxml++.h>
32 #include <libcxml/cxml.h>
33 #include <dcp/signer_chain.h>
35 #include <dcp/signer.h>
37 #include <dcp/local_time.h>
41 #include "job_manager.h"
42 #include "transcode_job.h"
43 #include "scp_dcp_job.h"
45 #include "exceptions.h"
46 #include "examine_content_job.h"
50 #include "ui_signaller.h"
53 #include "dcp_content_type.h"
61 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;
84 * AudioMapping XML changed.
86 * Subtitle offset changed to subtitle y offset, and subtitle x offset added.
88 * Use <Scale> tag in <VideoContent> rather than <Ratio>.
90 int const Film::current_state_version = 8;
92 /** Construct a Film object in a given directory.
94 * @param dir Film directory.
97 Film::Film (boost::filesystem::path dir, bool log)
98 : _playlist (new Playlist)
99 , _use_dci_name (true)
100 , _dcp_content_type (Config::instance()->default_dcp_content_type ())
101 , _container (Config::instance()->default_container ())
102 , _resolution (RESOLUTION_2K)
103 , _scaler (Scaler::from_id ("bicubic"))
104 , _with_subtitles (false)
107 , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
108 , _dci_metadata (Config::instance()->default_dci_metadata ())
109 , _video_frame_rate (24)
110 , _audio_channels (6)
112 , _sequence_video (true)
114 , _state_version (current_state_version)
117 set_dci_date_today ();
119 _playlist->Changed.connect (bind (&Film::playlist_changed, this));
120 _playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2));
122 /* Make state.directory a complete path without ..s (where possible)
123 (Code swiped from Adam Bowen on stackoverflow)
126 boost::filesystem::path p (boost::filesystem::system_complete (dir));
127 boost::filesystem::path result;
128 for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
130 if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
133 result = result.parent_path ();
135 } else if (*i != ".") {
140 set_directory (result);
142 _log.reset (new FileLog (file ("log")));
144 _log.reset (new NullLog);
147 _playlist->set_sequence_video (_sequence_video);
151 Film::video_identifier () const
153 assert (container ());
157 s << container()->id()
158 << "_" << resolution_to_string (_resolution)
159 << "_" << _playlist->video_identifier()
160 << "_" << _video_frame_rate
161 << "_" << scaler()->id()
162 << "_" << j2k_bandwidth();
183 /** @return The path to the directory to write video frame info files to */
184 boost::filesystem::path
185 Film::info_dir () const
187 boost::filesystem::path p;
189 p /= video_identifier ();
193 boost::filesystem::path
194 Film::internal_video_mxf_dir () const
196 return dir ("video");
199 boost::filesystem::path
200 Film::internal_video_mxf_filename () const
202 return video_identifier() + ".mxf";
205 boost::filesystem::path
206 Film::video_mxf_filename () const
208 return filename_safe_name() + "_video.mxf";
211 boost::filesystem::path
212 Film::audio_mxf_filename () const
214 return filename_safe_name() + "_audio.mxf";
218 Film::filename_safe_name () const
220 string const n = name ();
222 for (size_t i = 0; i < n.length(); ++i) {
223 if (isalnum (n[i])) {
233 boost::filesystem::path
234 Film::audio_analysis_dir () const
236 return dir ("analysis");
239 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
243 set_dci_date_today ();
245 if (dcp_name().find ("/") != string::npos) {
246 throw BadSettingError (_("name"), _("cannot contain slashes"));
249 log()->log (String::compose ("DCP-o-matic %1 git %2 using %3", dcpomatic_version, dcpomatic_git_commit, dependency_version_summary()));
253 gethostname (buffer, sizeof (buffer));
254 log()->log (String::compose ("Starting to make DCP on %1", buffer));
257 ContentList cl = content ();
258 for (ContentList::const_iterator i = cl.begin(); i != cl.end(); ++i) {
259 log()->log (String::compose ("Content: %1", (*i)->technical_summary()));
261 log()->log (String::compose ("DCP video rate %1 fps", video_frame_rate()));
262 log()->log (String::compose ("%1 threads", Config::instance()->num_local_encoding_threads()));
263 log()->log (String::compose ("J2K bandwidth %1", j2k_bandwidth()));
264 #ifdef DCPOMATIC_DEBUG
265 log()->log ("DCP-o-matic built in debug mode.");
267 log()->log ("DCP-o-matic built in optimised mode.");
270 log()->log ("libdcp built in debug mode.");
272 log()->log ("libdcp built in optimised mode.");
275 #ifdef DCPOMATIC_WINDOWS
277 info.dwOSVersionInfoSize = sizeof (info);
278 GetVersionEx (&info);
279 log()->log (String::compose ("Windows version %1.%2.%3 SP %4", info.dwMajorVersion, info.dwMinorVersion, info.dwBuildNumber, info.szCSDVersion));
282 log()->log (String::compose ("CPU: %1, %2 processors", cpu_info(), boost::thread::hardware_concurrency ()));
283 list<pair<string, string> > const m = mount_info ();
284 for (list<pair<string, string> >::const_iterator i = m.begin(); i != m.end(); ++i) {
285 log()->log (String::compose ("Mount: %1 %2", i->first, i->second));
288 if (container() == 0) {
289 throw MissingSettingError (_("container"));
292 if (content().empty()) {
293 throw StringError (_("You must add some content to the DCP before creating it"));
296 if (dcp_content_type() == 0) {
297 throw MissingSettingError (_("content type"));
300 if (name().empty()) {
301 throw MissingSettingError (_("name"));
304 JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
307 /** Start a job to send our DCP to the configured TMS */
309 Film::send_dcp_to_tms ()
311 shared_ptr<Job> j (new SCPDCPJob (shared_from_this()));
312 JobManager::instance()->add (j);
315 /** Count the number of frames that have been encoded for this film.
316 * @return frame count.
319 Film::encoded_frames () const
321 if (container() == 0) {
326 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (info_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
328 boost::this_thread::interruption_point ();
334 shared_ptr<xmlpp::Document>
335 Film::metadata () const
339 shared_ptr<xmlpp::Document> doc (new xmlpp::Document);
340 xmlpp::Element* root = doc->create_root_node ("Metadata");
342 root->add_child("Version")->add_child_text (lexical_cast<string> (current_state_version));
343 root->add_child("Name")->add_child_text (_name);
344 root->add_child("UseDCIName")->add_child_text (_use_dci_name ? "1" : "0");
346 if (_dcp_content_type) {
347 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->dci_name ());
351 root->add_child("Container")->add_child_text (_container->id ());
354 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
355 root->add_child("Scaler")->add_child_text (_scaler->id ());
356 root->add_child("WithSubtitles")->add_child_text (_with_subtitles ? "1" : "0");
357 root->add_child("J2KBandwidth")->add_child_text (lexical_cast<string> (_j2k_bandwidth));
358 _dci_metadata.as_xml (root->add_child ("DCIMetadata"));
359 root->add_child("VideoFrameRate")->add_child_text (lexical_cast<string> (_video_frame_rate));
360 root->add_child("DCIDate")->add_child_text (boost::gregorian::to_iso_string (_dci_date));
361 root->add_child("AudioChannels")->add_child_text (lexical_cast<string> (_audio_channels));
362 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
363 root->add_child("SequenceVideo")->add_child_text (_sequence_video ? "1" : "0");
364 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
365 root->add_child("Signed")->add_child_text (_signed ? "1" : "0");
366 root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
367 root->add_child("Key")->add_child_text (_key.hex ());
368 _playlist->as_xml (root->add_child ("Playlist"));
373 /** Write state to our `metadata' file */
375 Film::write_metadata () const
377 boost::filesystem::create_directories (directory ());
378 shared_ptr<xmlpp::Document> doc = metadata ();
379 doc->write_to_file_formatted (file("metadata.xml").string ());
383 /** Read state from our metadata file.
384 * @return Notes about things that the user should know about, or empty.
387 Film::read_metadata ()
391 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
392 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!"));
395 cxml::Document f ("Metadata");
396 f.read_file (file ("metadata.xml"));
398 _state_version = f.number_child<int> ("Version");
399 if (_state_version > current_state_version) {
400 throw StringError (_("This film was created with a newer version of DCP-o-matic, and it cannot be loaded into this version. Sorry!"));
403 _name = f.string_child ("Name");
404 _use_dci_name = f.bool_child ("UseDCIName");
407 optional<string> c = f.optional_string_child ("DCPContentType");
409 _dcp_content_type = DCPContentType::from_dci_name (c.get ());
414 optional<string> c = f.optional_string_child ("Container");
416 _container = Ratio::from_id (c.get ());
420 _resolution = string_to_resolution (f.string_child ("Resolution"));
421 _scaler = Scaler::from_id (f.string_child ("Scaler"));
422 _with_subtitles = f.bool_child ("WithSubtitles");
423 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
424 _dci_metadata = DCIMetadata (f.node_child ("DCIMetadata"));
425 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
426 _dci_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
427 _signed = f.optional_bool_child("Signed").get_value_or (true);
428 _encrypted = f.bool_child ("Encrypted");
429 _audio_channels = f.number_child<int> ("AudioChannels");
430 _sequence_video = f.bool_child ("SequenceVideo");
431 _three_d = f.bool_child ("ThreeD");
432 _interop = f.bool_child ("Interop");
433 _key = dcp::Key (f.string_child ("Key"));
436 /* This method is the only one that can return notes (so far) */
437 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
443 /** Given a directory name, return its full path within the Film's directory.
444 * The directory (and its parents) will be created if they do not exist.
446 boost::filesystem::path
447 Film::dir (boost::filesystem::path d) const
449 boost::filesystem::path p;
453 boost::filesystem::create_directories (p);
458 /** Given a file or directory name, return its full path within the Film's directory.
459 * Any required parent directories will be created.
461 boost::filesystem::path
462 Film::file (boost::filesystem::path f) const
464 boost::filesystem::path p;
468 boost::filesystem::create_directories (p.parent_path ());
473 /** @return a DCI-compliant name for a DCP of this film */
475 Film::dci_name (bool if_created_now) const
479 string fixed_name = to_upper_copy (name());
480 for (size_t i = 0; i < fixed_name.length(); ++i) {
481 if (fixed_name[i] == ' ') {
486 /* Spec is that the name part should be maximum 14 characters, as I understand it */
487 if (fixed_name.length() > 14) {
488 fixed_name = fixed_name.substr (0, 14);
493 if (dcp_content_type()) {
494 d << "_" << dcp_content_type()->dci_name();
495 d << "-" << dci_metadata().content_version;
502 if (video_frame_rate() != 24) {
503 d << "-" << video_frame_rate();
507 d << "_" << container()->dci_name();
510 DCIMetadata const dm = dci_metadata ();
512 if (!dm.audio_language.empty ()) {
513 d << "_" << dm.audio_language;
514 if (!dm.subtitle_language.empty()) {
515 d << "-" << dm.subtitle_language;
521 if (!dm.territory.empty ()) {
522 d << "_" << dm.territory;
523 if (!dm.rating.empty ()) {
524 d << "-" << dm.rating;
528 switch (audio_channels ()) {
549 d << "_" << resolution_to_string (_resolution);
551 if (!dm.studio.empty ()) {
552 d << "_" << dm.studio;
555 if (if_created_now) {
556 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
558 d << "_" << boost::gregorian::to_iso_string (_dci_date);
561 if (!dm.facility.empty ()) {
562 d << "_" << dm.facility;
565 if (!dm.package_type.empty ()) {
566 d << "_" << dm.package_type;
572 /** @return name to give the DCP */
574 Film::dcp_name (bool if_created_now) const
576 if (use_dci_name()) {
577 return dci_name (if_created_now);
585 Film::set_directory (boost::filesystem::path d)
592 Film::set_name (string n)
595 signal_changed (NAME);
599 Film::set_use_dci_name (bool u)
602 signal_changed (USE_DCI_NAME);
606 Film::set_dcp_content_type (DCPContentType const * t)
608 _dcp_content_type = t;
609 signal_changed (DCP_CONTENT_TYPE);
613 Film::set_container (Ratio const * c)
616 signal_changed (CONTAINER);
620 Film::set_resolution (Resolution r)
623 signal_changed (RESOLUTION);
627 Film::set_scaler (Scaler const * s)
630 signal_changed (SCALER);
634 Film::set_with_subtitles (bool w)
637 signal_changed (WITH_SUBTITLES);
641 Film::set_j2k_bandwidth (int b)
644 signal_changed (J2K_BANDWIDTH);
648 Film::set_dci_metadata (DCIMetadata m)
651 signal_changed (DCI_METADATA);
655 Film::set_video_frame_rate (int f)
657 _video_frame_rate = f;
658 signal_changed (VIDEO_FRAME_RATE);
662 Film::set_audio_channels (int c)
665 signal_changed (AUDIO_CHANNELS);
669 Film::set_three_d (bool t)
672 signal_changed (THREE_D);
676 Film::set_interop (bool i)
679 signal_changed (INTEROP);
683 Film::signal_changed (Property p)
689 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
691 case Film::VIDEO_FRAME_RATE:
692 case Film::SEQUENCE_VIDEO:
693 _playlist->maybe_sequence_video ();
700 ui_signaller->emit (boost::bind (boost::ref (Changed), p));
705 Film::set_dci_date_today ()
707 _dci_date = boost::gregorian::day_clock::local_day ();
710 boost::filesystem::path
711 Film::info_path (int f, Eyes e) const
713 boost::filesystem::path p;
718 s << setfill('0') << f;
720 if (e == EYES_LEFT) {
722 } else if (e == EYES_RIGHT) {
730 /* info_dir() will already have added any initial bit of the path,
731 so don't call file() on this.
736 boost::filesystem::path
737 Film::j2c_path (int f, Eyes e, bool t) const
739 boost::filesystem::path p;
741 p /= video_identifier ();
745 s << setfill('0') << f;
747 if (e == EYES_LEFT) {
749 } else if (e == EYES_RIGHT) {
763 /** @return List of subdirectories (not full paths) containing DCPs that can be successfully dcp::DCP::read() */
764 list<boost::filesystem::path>
767 list<boost::filesystem::path> out;
769 boost::filesystem::path const dir = directory ();
770 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
772 boost::filesystem::is_directory (*i) &&
773 i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
779 out.push_back (i->path().leaf ());
790 Film::make_player () const
792 return shared_ptr<Player> (new Player (shared_from_this (), _playlist));
796 Film::set_signed (bool s)
799 signal_changed (SIGNED);
803 Film::set_encrypted (bool e)
806 signal_changed (ENCRYPTED);
810 Film::playlist () const
816 Film::content () const
818 return _playlist->content ();
822 Film::examine_and_add_content (shared_ptr<Content> c)
824 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
825 j->Finished.connect (bind (&Film::maybe_add_content, this, boost::weak_ptr<Job> (j), boost::weak_ptr<Content> (c)));
826 JobManager::instance()->add (j);
830 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
832 shared_ptr<Job> job = j.lock ();
833 if (!job || !job->finished_ok ()) {
837 shared_ptr<Content> content = c.lock ();
839 add_content (content);
844 Film::add_content (shared_ptr<Content> c)
846 /* Add video content after any existing content */
847 if (dynamic_pointer_cast<VideoContent> (c)) {
848 c->set_position (_playlist->video_end ());
855 Film::remove_content (shared_ptr<Content> c)
857 _playlist->remove (c);
861 Film::move_content_earlier (shared_ptr<Content> c)
863 _playlist->move_earlier (c);
867 Film::move_content_later (shared_ptr<Content> c)
869 _playlist->move_later (c);
873 Film::length () const
875 return _playlist->length ();
879 Film::has_subtitles () const
881 return _playlist->has_subtitles ();
885 Film::best_video_frame_rate () const
887 return _playlist->best_dcp_frame_rate ();
891 Film::active_frame_rate_change (DCPTime t) const
893 return _playlist->active_frame_rate_change (t, video_frame_rate ());
897 Film::playlist_content_changed (boost::weak_ptr<Content> c, int p)
899 if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
900 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
904 ui_signaller->emit (boost::bind (boost::ref (ContentChanged), c, p));
909 Film::playlist_changed ()
911 signal_changed (CONTENT);
915 Film::audio_frame_rate () const
922 Film::set_sequence_video (bool s)
925 _playlist->set_sequence_video (s);
926 signal_changed (SEQUENCE_VIDEO);
929 /** @return Size of the largest possible image in whatever resolution we are using */
931 Film::full_frame () const
933 switch (_resolution) {
935 return dcp::Size (2048, 1080);
937 return dcp::Size (4096, 2160);
944 /** @return Size of the frame */
946 Film::frame_size () const
948 return fit_ratio_within (container()->ratio(), full_frame ());
953 shared_ptr<dcp::Certificate> target,
954 boost::filesystem::path dcp_dir,
959 shared_ptr<const Signer> signer = make_signer ();
961 dcp::DCP dcp (dir (dcp_dir.string ()));
966 throw KDMError (_("Could not read DCP to make KDM for"));
969 dcp.cpls().front()->set_mxf_keys (key ());
971 return dcp::DecryptedKDM (
972 dcp.cpls().front(), from, until, "DCP-o-matic", dcp.cpls().front()->content_title_text(), dcp::LocalTime().as_string()
973 ).encrypt (signer, target);
976 list<dcp::EncryptedKDM>
978 list<shared_ptr<Screen> > screens,
979 boost::filesystem::path dcp,
984 list<dcp::EncryptedKDM> kdms;
986 for (list<shared_ptr<Screen> >::iterator i = screens.begin(); i != screens.end(); ++i) {
987 kdms.push_back (make_kdm ((*i)->certificate, dcp, from, until));
993 /** @return The approximate disk space required to encode a DCP of this film with the
994 * current settings, in bytes.
997 Film::required_disk_space () const
999 return uint64_t (j2k_bandwidth() / 8) * length().seconds();
1002 /** This method checks the disk that the Film is on and tries to decide whether or not
1003 * there will be enough space to make a DCP for it. If so, true is returned; if not,
1004 * false is returned and required and availabe are filled in with the amount of disk space
1005 * required and available respectively (in Gb).
1007 * Note: the decision made by this method isn't, of course, 100% reliable.
1010 Film::should_be_enough_disk_space (double& required, double& available) const
1012 boost::filesystem::space_info s = boost::filesystem::space (internal_video_mxf_dir ());
1013 required = double (required_disk_space ()) / 1073741824.0f;
1014 available = double (s.available) / 1073741824.0f;
1015 return (available - required) > 1;