2 Copyright (C) 2012-2014 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 /* It seems to make sense to auto-save metadata here, since the make DCP may last
250 a long time, and crashes/power failures are moderately likely.
254 log()->log (String::compose ("DCP-o-matic %1 git %2 using %3", dcpomatic_version, dcpomatic_git_commit, dependency_version_summary()));
258 gethostname (buffer, sizeof (buffer));
259 log()->log (String::compose ("Starting to make DCP on %1", buffer));
262 ContentList cl = content ();
263 for (ContentList::const_iterator i = cl.begin(); i != cl.end(); ++i) {
264 log()->log (String::compose ("Content: %1", (*i)->technical_summary()));
266 log()->log (String::compose ("DCP video rate %1 fps", video_frame_rate()));
267 log()->log (String::compose ("%1 threads", Config::instance()->num_local_encoding_threads()));
268 log()->log (String::compose ("J2K bandwidth %1", j2k_bandwidth()));
269 #ifdef DCPOMATIC_DEBUG
270 log()->log ("DCP-o-matic built in debug mode.");
272 log()->log ("DCP-o-matic built in optimised mode.");
275 log()->log ("libdcp built in debug mode.");
277 log()->log ("libdcp built in optimised mode.");
280 #ifdef DCPOMATIC_WINDOWS
282 info.dwOSVersionInfoSize = sizeof (info);
283 GetVersionEx (&info);
284 log()->log (String::compose ("Windows version %1.%2.%3 SP %4", info.dwMajorVersion, info.dwMinorVersion, info.dwBuildNumber, info.szCSDVersion));
287 log()->log (String::compose ("CPU: %1, %2 processors", cpu_info(), boost::thread::hardware_concurrency ()));
288 list<pair<string, string> > const m = mount_info ();
289 for (list<pair<string, string> >::const_iterator i = m.begin(); i != m.end(); ++i) {
290 log()->log (String::compose ("Mount: %1 %2", i->first, i->second));
293 if (container() == 0) {
294 throw MissingSettingError (_("container"));
297 if (content().empty()) {
298 throw StringError (_("You must add some content to the DCP before creating it"));
301 if (dcp_content_type() == 0) {
302 throw MissingSettingError (_("content type"));
305 if (name().empty()) {
306 throw MissingSettingError (_("name"));
309 JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
312 /** Start a job to send our DCP to the configured TMS */
314 Film::send_dcp_to_tms ()
316 shared_ptr<Job> j (new SCPDCPJob (shared_from_this()));
317 JobManager::instance()->add (j);
320 /** Count the number of frames that have been encoded for this film.
321 * @return frame count.
324 Film::encoded_frames () const
326 if (container() == 0) {
331 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (info_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
333 boost::this_thread::interruption_point ();
339 shared_ptr<xmlpp::Document>
340 Film::metadata () const
344 shared_ptr<xmlpp::Document> doc (new xmlpp::Document);
345 xmlpp::Element* root = doc->create_root_node ("Metadata");
347 root->add_child("Version")->add_child_text (lexical_cast<string> (current_state_version));
348 root->add_child("Name")->add_child_text (_name);
349 root->add_child("UseDCIName")->add_child_text (_use_dci_name ? "1" : "0");
351 if (_dcp_content_type) {
352 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->dci_name ());
356 root->add_child("Container")->add_child_text (_container->id ());
359 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
360 root->add_child("Scaler")->add_child_text (_scaler->id ());
361 root->add_child("WithSubtitles")->add_child_text (_with_subtitles ? "1" : "0");
362 root->add_child("J2KBandwidth")->add_child_text (lexical_cast<string> (_j2k_bandwidth));
363 _dci_metadata.as_xml (root->add_child ("DCIMetadata"));
364 root->add_child("VideoFrameRate")->add_child_text (lexical_cast<string> (_video_frame_rate));
365 root->add_child("DCIDate")->add_child_text (boost::gregorian::to_iso_string (_dci_date));
366 root->add_child("AudioChannels")->add_child_text (lexical_cast<string> (_audio_channels));
367 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
368 root->add_child("SequenceVideo")->add_child_text (_sequence_video ? "1" : "0");
369 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
370 root->add_child("Signed")->add_child_text (_signed ? "1" : "0");
371 root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
372 root->add_child("Key")->add_child_text (_key.hex ());
373 _playlist->as_xml (root->add_child ("Playlist"));
378 /** Write state to our `metadata' file */
380 Film::write_metadata () const
382 boost::filesystem::create_directories (directory ());
383 shared_ptr<xmlpp::Document> doc = metadata ();
384 doc->write_to_file_formatted (file("metadata.xml").string ());
388 /** Read state from our metadata file.
389 * @return Notes about things that the user should know about, or empty.
392 Film::read_metadata ()
396 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
397 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!"));
400 cxml::Document f ("Metadata");
401 f.read_file (file ("metadata.xml"));
403 _state_version = f.number_child<int> ("Version");
404 if (_state_version > current_state_version) {
405 throw StringError (_("This film was created with a newer version of DCP-o-matic, and it cannot be loaded into this version. Sorry!"));
408 _name = f.string_child ("Name");
409 _use_dci_name = f.bool_child ("UseDCIName");
412 optional<string> c = f.optional_string_child ("DCPContentType");
414 _dcp_content_type = DCPContentType::from_dci_name (c.get ());
419 optional<string> c = f.optional_string_child ("Container");
421 _container = Ratio::from_id (c.get ());
425 _resolution = string_to_resolution (f.string_child ("Resolution"));
426 _scaler = Scaler::from_id (f.string_child ("Scaler"));
427 _with_subtitles = f.bool_child ("WithSubtitles");
428 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
429 _dci_metadata = DCIMetadata (f.node_child ("DCIMetadata"));
430 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
431 _dci_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
432 _signed = f.optional_bool_child("Signed").get_value_or (true);
433 _encrypted = f.bool_child ("Encrypted");
434 _audio_channels = f.number_child<int> ("AudioChannels");
435 _sequence_video = f.bool_child ("SequenceVideo");
436 _three_d = f.bool_child ("ThreeD");
437 _interop = f.bool_child ("Interop");
438 _key = dcp::Key (f.string_child ("Key"));
441 /* This method is the only one that can return notes (so far) */
442 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
448 /** Given a directory name, return its full path within the Film's directory.
449 * The directory (and its parents) will be created if they do not exist.
451 boost::filesystem::path
452 Film::dir (boost::filesystem::path d) const
454 boost::filesystem::path p;
458 boost::filesystem::create_directories (p);
463 /** Given a file or directory name, return its full path within the Film's directory.
464 * Any required parent directories will be created.
466 boost::filesystem::path
467 Film::file (boost::filesystem::path f) const
469 boost::filesystem::path p;
473 boost::filesystem::create_directories (p.parent_path ());
478 /** @return a DCI-compliant name for a DCP of this film */
480 Film::dci_name (bool if_created_now) const
484 string fixed_name = to_upper_copy (name());
485 for (size_t i = 0; i < fixed_name.length(); ++i) {
486 if (fixed_name[i] == ' ') {
491 /* Spec is that the name part should be maximum 14 characters, as I understand it */
492 if (fixed_name.length() > 14) {
493 fixed_name = fixed_name.substr (0, 14);
498 if (dcp_content_type()) {
499 d << "_" << dcp_content_type()->dci_name();
500 d << "-" << dci_metadata().content_version;
507 if (video_frame_rate() != 24) {
508 d << "-" << video_frame_rate();
512 d << "_" << container()->dci_name();
515 DCIMetadata const dm = dci_metadata ();
517 if (!dm.audio_language.empty ()) {
518 d << "_" << dm.audio_language;
519 if (!dm.subtitle_language.empty()) {
520 d << "-" << dm.subtitle_language;
526 if (!dm.territory.empty ()) {
527 d << "_" << dm.territory;
528 if (!dm.rating.empty ()) {
529 d << "-" << dm.rating;
533 switch (audio_channels ()) {
554 d << "_" << resolution_to_string (_resolution);
556 if (!dm.studio.empty ()) {
557 d << "_" << dm.studio;
560 if (if_created_now) {
561 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
563 d << "_" << boost::gregorian::to_iso_string (_dci_date);
566 if (!dm.facility.empty ()) {
567 d << "_" << dm.facility;
570 if (!dm.package_type.empty ()) {
571 d << "_" << dm.package_type;
577 /** @return name to give the DCP */
579 Film::dcp_name (bool if_created_now) const
581 if (use_dci_name()) {
582 return dci_name (if_created_now);
590 Film::set_directory (boost::filesystem::path d)
597 Film::set_name (string n)
600 signal_changed (NAME);
604 Film::set_use_dci_name (bool u)
607 signal_changed (USE_DCI_NAME);
611 Film::set_dcp_content_type (DCPContentType const * t)
613 _dcp_content_type = t;
614 signal_changed (DCP_CONTENT_TYPE);
618 Film::set_container (Ratio const * c)
621 signal_changed (CONTAINER);
625 Film::set_resolution (Resolution r)
628 signal_changed (RESOLUTION);
632 Film::set_scaler (Scaler const * s)
635 signal_changed (SCALER);
639 Film::set_with_subtitles (bool w)
642 signal_changed (WITH_SUBTITLES);
646 Film::set_j2k_bandwidth (int b)
649 signal_changed (J2K_BANDWIDTH);
653 Film::set_dci_metadata (DCIMetadata m)
656 signal_changed (DCI_METADATA);
660 Film::set_video_frame_rate (int f)
662 _video_frame_rate = f;
663 signal_changed (VIDEO_FRAME_RATE);
667 Film::set_audio_channels (int c)
670 signal_changed (AUDIO_CHANNELS);
674 Film::set_three_d (bool t)
677 signal_changed (THREE_D);
681 Film::set_interop (bool i)
684 signal_changed (INTEROP);
688 Film::signal_changed (Property p)
694 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
696 case Film::VIDEO_FRAME_RATE:
697 case Film::SEQUENCE_VIDEO:
698 _playlist->maybe_sequence_video ();
705 ui_signaller->emit (boost::bind (boost::ref (Changed), p));
710 Film::set_dci_date_today ()
712 _dci_date = boost::gregorian::day_clock::local_day ();
715 boost::filesystem::path
716 Film::info_path (int f, Eyes e) const
718 boost::filesystem::path p;
723 s << setfill('0') << f;
725 if (e == EYES_LEFT) {
727 } else if (e == EYES_RIGHT) {
735 /* info_dir() will already have added any initial bit of the path,
736 so don't call file() on this.
741 boost::filesystem::path
742 Film::j2c_path (int f, Eyes e, bool t) const
744 boost::filesystem::path p;
746 p /= video_identifier ();
750 s << setfill('0') << f;
752 if (e == EYES_LEFT) {
754 } else if (e == EYES_RIGHT) {
768 /** @return List of subdirectories (not full paths) containing DCPs that can be successfully dcp::DCP::read() */
769 list<boost::filesystem::path>
772 list<boost::filesystem::path> out;
774 boost::filesystem::path const dir = directory ();
775 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
777 boost::filesystem::is_directory (*i) &&
778 i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
784 out.push_back (i->path().leaf ());
795 Film::make_player () const
797 return shared_ptr<Player> (new Player (shared_from_this (), _playlist));
801 Film::set_signed (bool s)
804 signal_changed (SIGNED);
808 Film::set_encrypted (bool e)
811 signal_changed (ENCRYPTED);
815 Film::playlist () const
821 Film::content () const
823 return _playlist->content ();
827 Film::examine_and_add_content (shared_ptr<Content> c)
829 if (dynamic_pointer_cast<FFmpegContent> (c)) {
830 run_ffprobe (c->path(0), file ("ffprobe.log"), _log);
833 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
834 j->Finished.connect (bind (&Film::maybe_add_content, this, boost::weak_ptr<Job> (j), boost::weak_ptr<Content> (c)));
835 JobManager::instance()->add (j);
839 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
841 shared_ptr<Job> job = j.lock ();
842 if (!job || !job->finished_ok ()) {
846 shared_ptr<Content> content = c.lock ();
848 add_content (content);
853 Film::add_content (shared_ptr<Content> c)
855 /* Add video content after any existing content */
856 if (dynamic_pointer_cast<VideoContent> (c)) {
857 c->set_position (_playlist->video_end ());
864 Film::remove_content (shared_ptr<Content> c)
866 _playlist->remove (c);
870 Film::move_content_earlier (shared_ptr<Content> c)
872 _playlist->move_earlier (c);
876 Film::move_content_later (shared_ptr<Content> c)
878 _playlist->move_later (c);
882 Film::length () const
884 return _playlist->length ();
888 Film::has_subtitles () const
890 return _playlist->has_subtitles ();
894 Film::best_video_frame_rate () const
896 return _playlist->best_dcp_frame_rate ();
900 Film::active_frame_rate_change (DCPTime t) const
902 return _playlist->active_frame_rate_change (t, video_frame_rate ());
906 Film::playlist_content_changed (boost::weak_ptr<Content> c, int p)
908 if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
909 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
913 ui_signaller->emit (boost::bind (boost::ref (ContentChanged), c, p));
918 Film::playlist_changed ()
920 signal_changed (CONTENT);
924 Film::audio_frame_rate () const
931 Film::set_sequence_video (bool s)
934 _playlist->set_sequence_video (s);
935 signal_changed (SEQUENCE_VIDEO);
938 /** @return Size of the largest possible image in whatever resolution we are using */
940 Film::full_frame () const
942 switch (_resolution) {
944 return dcp::Size (2048, 1080);
946 return dcp::Size (4096, 2160);
953 /** @return Size of the frame */
955 Film::frame_size () const
957 return fit_ratio_within (container()->ratio(), full_frame ());
962 shared_ptr<dcp::Certificate> target,
963 boost::filesystem::path dcp_dir,
968 shared_ptr<const Signer> signer = make_signer ();
970 dcp::DCP dcp (dir (dcp_dir.string ()));
975 throw KDMError (_("Could not read DCP to make KDM for"));
978 dcp.cpls().front()->set_mxf_keys (key ());
980 return dcp::DecryptedKDM (
981 dcp.cpls().front(), from, until, "DCP-o-matic", dcp.cpls().front()->content_title_text(), dcp::LocalTime().as_string()
982 ).encrypt (signer, target);
985 list<dcp::EncryptedKDM>
987 list<shared_ptr<Screen> > screens,
988 boost::filesystem::path dcp,
993 list<dcp::EncryptedKDM> kdms;
995 for (list<shared_ptr<Screen> >::iterator i = screens.begin(); i != screens.end(); ++i) {
996 kdms.push_back (make_kdm ((*i)->certificate, dcp, from, until));
1002 /** @return The approximate disk space required to encode a DCP of this film with the
1003 * current settings, in bytes.
1006 Film::required_disk_space () const
1008 return uint64_t (j2k_bandwidth() / 8) * length().seconds();
1011 /** This method checks the disk that the Film is on and tries to decide whether or not
1012 * there will be enough space to make a DCP for it. If so, true is returned; if not,
1013 * false is returned and required and availabe are filled in with the amount of disk space
1014 * required and available respectively (in Gb).
1016 * Note: the decision made by this method isn't, of course, 100% reliable.
1019 Film::should_be_enough_disk_space (double& required, double& available) const
1021 boost::filesystem::space_info s = boost::filesystem::space (internal_video_mxf_dir ());
1022 required = double (required_disk_space ()) / 1073741824.0f;
1023 available = double (s.available) / 1073741824.0f;
1024 return (available - required) > 1;