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/date_time.hpp>
31 #include <libxml++/libxml++.h>
32 #include <libcxml/cxml.h>
33 #include <libdcp/signer_chain.h>
34 #include <libdcp/cpl.h>
35 #include <libdcp/signer.h>
36 #include <libdcp/util.h>
37 #include <libdcp/kdm.h>
38 #include <libdcp/raw_convert.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;
73 using boost::shared_ptr;
74 using boost::weak_ptr;
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 using libdcp::raw_convert;
85 * AudioMapping XML changed.
87 * Subtitle offset changed to subtitle y offset, and subtitle x offset added.
89 * Use <Scale> tag in <VideoContent> rather than <Ratio>.
91 int const Film::current_state_version = 8;
93 /** Construct a Film object in a given directory.
95 * @param dir Film directory.
98 Film::Film (boost::filesystem::path dir, bool log)
99 : _playlist (new Playlist)
100 , _use_dci_name (true)
101 , _dcp_content_type (Config::instance()->default_dcp_content_type ())
102 , _container (Config::instance()->default_container ())
103 , _resolution (RESOLUTION_2K)
104 , _scaler (Scaler::from_id ("bicubic"))
105 , _with_subtitles (false)
108 , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
109 , _dci_metadata (Config::instance()->default_dci_metadata ())
110 , _video_frame_rate (24)
111 , _audio_channels (6)
113 , _sequence_video (true)
115 , _state_version (current_state_version)
118 set_dci_date_today ();
120 _playlist->Changed.connect (bind (&Film::playlist_changed, this));
121 _playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2));
123 /* Make state.directory a complete path without ..s (where possible)
124 (Code swiped from Adam Bowen on stackoverflow)
127 boost::filesystem::path p (boost::filesystem::system_complete (dir));
128 boost::filesystem::path result;
129 for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
131 if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
134 result = result.parent_path ();
136 } else if (*i != ".") {
141 set_directory (result);
143 _log.reset (new FileLog (file ("log")));
145 _log.reset (new NullLog);
148 _playlist->set_sequence_video (_sequence_video);
152 Film::video_identifier () const
154 assert (container ());
157 s.imbue (std::locale::classic ());
159 s << container()->id()
160 << "_" << resolution_to_string (_resolution)
161 << "_" << _playlist->video_identifier()
162 << "_" << _video_frame_rate
163 << "_" << scaler()->id()
164 << "_" << j2k_bandwidth();
185 /** @return The path to the directory to write video frame info files to */
186 boost::filesystem::path
187 Film::info_dir () const
189 boost::filesystem::path p;
191 p /= video_identifier ();
195 boost::filesystem::path
196 Film::internal_video_mxf_dir () const
198 return dir ("video");
201 boost::filesystem::path
202 Film::internal_video_mxf_filename () const
204 return video_identifier() + ".mxf";
207 boost::filesystem::path
208 Film::video_mxf_filename () const
210 return filename_safe_name() + "_video.mxf";
213 boost::filesystem::path
214 Film::audio_mxf_filename () const
216 return filename_safe_name() + "_audio.mxf";
220 Film::filename_safe_name () const
222 string const n = name ();
224 for (size_t i = 0; i < n.length(); ++i) {
225 if (isalnum (n[i])) {
235 boost::filesystem::path
236 Film::audio_analysis_dir () const
238 return dir ("analysis");
241 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
245 set_dci_date_today ();
247 if (dcp_name().find ("/") != string::npos) {
248 throw BadSettingError (_("name"), _("cannot contain slashes"));
251 /* It seems to make sense to auto-save metadata here, since the make DCP may last
252 a long time, and crashes/power failures are moderately likely.
256 log()->log (String::compose ("DCP-o-matic %1 git %2 using %3", dcpomatic_version, dcpomatic_git_commit, dependency_version_summary()));
260 gethostname (buffer, sizeof (buffer));
261 log()->log (String::compose ("Starting to make DCP on %1", buffer));
264 ContentList cl = content ();
265 for (ContentList::const_iterator i = cl.begin(); i != cl.end(); ++i) {
266 log()->log (String::compose ("Content: %1", (*i)->technical_summary()));
268 log()->log (String::compose ("DCP video rate %1 fps", video_frame_rate()));
269 log()->log (String::compose ("%1 threads", Config::instance()->num_local_encoding_threads()));
270 log()->log (String::compose ("J2K bandwidth %1", j2k_bandwidth()));
271 #ifdef DCPOMATIC_DEBUG
272 log()->log ("DCP-o-matic built in debug mode.");
274 log()->log ("DCP-o-matic built in optimised mode.");
277 log()->log ("libdcp built in debug mode.");
279 log()->log ("libdcp built in optimised mode.");
282 #ifdef DCPOMATIC_WINDOWS
284 info.dwOSVersionInfoSize = sizeof (info);
285 GetVersionEx (&info);
286 log()->log (String::compose ("Windows version %1.%2.%3 SP %4", info.dwMajorVersion, info.dwMinorVersion, info.dwBuildNumber, info.szCSDVersion));
289 log()->log (String::compose ("CPU: %1, %2 processors", cpu_info(), boost::thread::hardware_concurrency ()));
290 list<pair<string, string> > const m = mount_info ();
291 for (list<pair<string, string> >::const_iterator i = m.begin(); i != m.end(); ++i) {
292 log()->log (String::compose ("Mount: %1 %2", i->first, i->second));
295 if (container() == 0) {
296 throw MissingSettingError (_("container"));
299 if (content().empty()) {
300 throw StringError (_("You must add some content to the DCP before creating it"));
303 if (dcp_content_type() == 0) {
304 throw MissingSettingError (_("content type"));
307 if (name().empty()) {
308 throw MissingSettingError (_("name"));
311 JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
314 /** Start a job to send our DCP to the configured TMS */
316 Film::send_dcp_to_tms ()
318 shared_ptr<Job> j (new SCPDCPJob (shared_from_this()));
319 JobManager::instance()->add (j);
322 /** Count the number of frames that have been encoded for this film.
323 * @return frame count.
326 Film::encoded_frames () const
328 if (container() == 0) {
333 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (info_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
335 boost::this_thread::interruption_point ();
341 shared_ptr<xmlpp::Document>
342 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 (raw_convert<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 (raw_convert<string> (_j2k_bandwidth));
363 _dci_metadata.as_xml (root->add_child ("DCIMetadata"));
364 root->add_child("VideoFrameRate")->add_child_text (raw_convert<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 (raw_convert<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 ()
394 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
395 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!"));
398 cxml::Document f ("Metadata");
399 f.read_file (file ("metadata.xml"));
401 _state_version = f.number_child<int> ("Version");
402 if (_state_version > current_state_version) {
403 throw StringError (_("This film was created with a newer version of DCP-o-matic, and it cannot be loaded into this version. Sorry!"));
406 _name = f.string_child ("Name");
407 _use_dci_name = f.bool_child ("UseDCIName");
410 optional<string> c = f.optional_string_child ("DCPContentType");
412 _dcp_content_type = DCPContentType::from_dci_name (c.get ());
417 optional<string> c = f.optional_string_child ("Container");
419 _container = Ratio::from_id (c.get ());
423 _resolution = string_to_resolution (f.string_child ("Resolution"));
424 _scaler = Scaler::from_id (f.string_child ("Scaler"));
425 _with_subtitles = f.bool_child ("WithSubtitles");
426 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
427 _dci_metadata = DCIMetadata (f.node_child ("DCIMetadata"));
428 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
429 _dci_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
430 _signed = f.optional_bool_child("Signed").get_value_or (true);
431 _encrypted = f.bool_child ("Encrypted");
432 _audio_channels = f.number_child<int> ("AudioChannels");
433 _sequence_video = f.bool_child ("SequenceVideo");
434 _three_d = f.bool_child ("ThreeD");
435 _interop = f.bool_child ("Interop");
436 _key = libdcp::Key (f.string_child ("Key"));
439 /* This method is the only one that can return notes (so far) */
440 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
446 /** Given a directory name, return its full path within the Film's directory.
447 * The directory (and its parents) will be created if they do not exist.
449 boost::filesystem::path
450 Film::dir (boost::filesystem::path d) const
452 boost::filesystem::path p;
456 boost::filesystem::create_directories (p);
461 /** Given a file or directory name, return its full path within the Film's directory.
462 * Any required parent directories will be created.
464 boost::filesystem::path
465 Film::file (boost::filesystem::path f) const
467 boost::filesystem::path p;
471 boost::filesystem::create_directories (p.parent_path ());
476 /** @return a DCI-compliant name for a DCP of this film */
478 Film::dci_name (bool if_created_now) const
482 string fixed_name = to_upper_copy (name());
483 for (size_t i = 0; i < fixed_name.length(); ++i) {
484 if (fixed_name[i] == ' ') {
489 /* Spec is that the name part should be maximum 14 characters, as I understand it */
490 if (fixed_name.length() > 14) {
491 fixed_name = fixed_name.substr (0, 14);
496 if (dcp_content_type()) {
497 d << "_" << dcp_content_type()->dci_name();
498 d << "-" << dci_metadata().content_version;
505 if (video_frame_rate() != 24) {
506 d << "-" << video_frame_rate();
510 d << "_" << container()->dci_name();
513 DCIMetadata const dm = dci_metadata ();
515 if (!dm.audio_language.empty ()) {
516 d << "_" << dm.audio_language;
517 if (!dm.subtitle_language.empty()) {
518 d << "-" << dm.subtitle_language;
524 if (!dm.territory.empty ()) {
525 d << "_" << dm.territory;
526 if (!dm.rating.empty ()) {
527 d << "-" << dm.rating;
531 switch (audio_channels ()) {
552 d << "_" << resolution_to_string (_resolution);
554 if (!dm.studio.empty ()) {
555 d << "_" << dm.studio;
558 if (if_created_now) {
559 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
561 d << "_" << boost::gregorian::to_iso_string (_dci_date);
564 if (!dm.facility.empty ()) {
565 d << "_" << dm.facility;
568 if (!dm.package_type.empty ()) {
569 d << "_" << dm.package_type;
575 /** @return name to give the DCP */
577 Film::dcp_name (bool if_created_now) const
579 if (use_dci_name()) {
580 return dci_name (if_created_now);
588 Film::set_directory (boost::filesystem::path d)
595 Film::set_name (string n)
598 signal_changed (NAME);
602 Film::set_use_dci_name (bool u)
605 signal_changed (USE_DCI_NAME);
609 Film::set_dcp_content_type (DCPContentType const * t)
611 _dcp_content_type = t;
612 signal_changed (DCP_CONTENT_TYPE);
616 Film::set_container (Ratio const * c)
619 signal_changed (CONTAINER);
623 Film::set_resolution (Resolution r)
626 signal_changed (RESOLUTION);
630 Film::set_scaler (Scaler const * s)
633 signal_changed (SCALER);
637 Film::set_with_subtitles (bool w)
640 signal_changed (WITH_SUBTITLES);
644 Film::set_j2k_bandwidth (int b)
647 signal_changed (J2K_BANDWIDTH);
651 Film::set_dci_metadata (DCIMetadata m)
654 signal_changed (DCI_METADATA);
658 Film::set_video_frame_rate (int f)
660 _video_frame_rate = f;
661 signal_changed (VIDEO_FRAME_RATE);
665 Film::set_audio_channels (int c)
668 signal_changed (AUDIO_CHANNELS);
672 Film::set_three_d (bool t)
675 signal_changed (THREE_D);
679 Film::set_interop (bool i)
682 signal_changed (INTEROP);
686 Film::signal_changed (Property p)
692 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
694 case Film::VIDEO_FRAME_RATE:
695 case Film::SEQUENCE_VIDEO:
696 _playlist->maybe_sequence_video ();
703 ui_signaller->emit (boost::bind (boost::ref (Changed), p));
708 Film::set_dci_date_today ()
710 _dci_date = boost::gregorian::day_clock::local_day ();
713 boost::filesystem::path
714 Film::info_path (int f, Eyes e) const
716 boost::filesystem::path p;
721 s << setfill('0') << f;
723 if (e == EYES_LEFT) {
725 } else if (e == EYES_RIGHT) {
733 /* info_dir() will already have added any initial bit of the path,
734 so don't call file() on this.
739 boost::filesystem::path
740 Film::j2c_path (int f, Eyes e, bool t) const
742 boost::filesystem::path p;
744 p /= video_identifier ();
748 s << setfill('0') << f;
750 if (e == EYES_LEFT) {
752 } else if (e == EYES_RIGHT) {
766 /** @return List of subdirectories (not full paths) containing DCPs that can be successfully libdcp::DCP::read() */
767 list<boost::filesystem::path>
770 list<boost::filesystem::path> out;
772 boost::filesystem::path const dir = directory ();
773 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
775 boost::filesystem::is_directory (*i) &&
776 i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
780 libdcp::DCP dcp (*i);
782 out.push_back (i->path().leaf ());
793 Film::make_player () const
795 return shared_ptr<Player> (new Player (shared_from_this (), _playlist));
799 Film::set_signed (bool s)
802 signal_changed (SIGNED);
806 Film::set_encrypted (bool e)
809 signal_changed (ENCRYPTED);
813 Film::playlist () const
819 Film::content () const
821 return _playlist->content ();
825 Film::examine_and_add_content (shared_ptr<Content> c)
827 if (dynamic_pointer_cast<FFmpegContent> (c)) {
828 run_ffprobe (c->path(0), file ("ffprobe.log"), _log);
831 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
832 j->Finished.connect (bind (&Film::maybe_add_content, this, boost::weak_ptr<Job> (j), boost::weak_ptr<Content> (c)));
833 JobManager::instance()->add (j);
837 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
839 shared_ptr<Job> job = j.lock ();
840 if (!job || !job->finished_ok ()) {
844 shared_ptr<Content> content = c.lock ();
846 add_content (content);
851 Film::add_content (shared_ptr<Content> c)
853 /* Add video content after any existing content */
854 if (dynamic_pointer_cast<VideoContent> (c)) {
855 c->set_position (_playlist->video_end ());
862 Film::remove_content (shared_ptr<Content> c)
864 _playlist->remove (c);
868 Film::move_content_earlier (shared_ptr<Content> c)
870 _playlist->move_earlier (c);
874 Film::move_content_later (shared_ptr<Content> c)
876 _playlist->move_later (c);
880 Film::length () const
882 return _playlist->length ();
886 Film::has_subtitles () const
888 return _playlist->has_subtitles ();
892 Film::best_video_frame_rate () const
894 return _playlist->best_dcp_frame_rate ();
898 Film::playlist_content_changed (boost::weak_ptr<Content> c, int p)
900 if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
901 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
905 ui_signaller->emit (boost::bind (boost::ref (ContentChanged), c, p));
910 Film::playlist_changed ()
912 signal_changed (CONTENT);
916 Film::time_to_audio_frames (Time t) const
918 return divide_with_round (t * audio_frame_rate (), TIME_HZ);
922 Film::time_to_video_frames (Time t) const
924 return divide_with_round (t * video_frame_rate (), TIME_HZ);
928 Film::audio_frames_to_time (OutputAudioFrame f) const
930 return divide_with_round (f * TIME_HZ, audio_frame_rate ());
934 Film::video_frames_to_time (OutputVideoFrame f) const
936 return divide_with_round (f * TIME_HZ, video_frame_rate ());
940 Film::audio_frame_rate () const
947 Film::set_sequence_video (bool s)
950 _playlist->set_sequence_video (s);
951 signal_changed (SEQUENCE_VIDEO);
954 /** @return Size of the largest possible image in whatever resolution we are using */
956 Film::full_frame () const
958 switch (_resolution) {
960 return libdcp::Size (2048, 1080);
962 return libdcp::Size (4096, 2160);
966 return libdcp::Size ();
969 /** @return Size of the frame */
971 Film::frame_size () const
973 return fit_ratio_within (container()->ratio(), full_frame ());
978 shared_ptr<libdcp::Certificate> target,
979 boost::filesystem::path dcp_dir,
980 boost::posix_time::ptime from,
981 boost::posix_time::ptime until
984 shared_ptr<const Signer> signer = make_signer ();
986 libdcp::DCP dcp (dir (dcp_dir.string ()));
991 throw KDMError (_("Could not read DCP to make KDM for"));
994 time_t now = time (0);
995 struct tm* tm = localtime (&now);
996 string const issue_date = libdcp::tm_to_string (tm);
998 dcp.cpls().front()->set_mxf_keys (key ());
1000 return libdcp::KDM (dcp.cpls().front(), signer, target, from, until, "DCP-o-matic", issue_date);
1005 list<shared_ptr<Screen> > screens,
1006 boost::filesystem::path dcp,
1007 boost::posix_time::ptime from,
1008 boost::posix_time::ptime until
1011 list<libdcp::KDM> kdms;
1013 for (list<shared_ptr<Screen> >::iterator i = screens.begin(); i != screens.end(); ++i) {
1014 kdms.push_back (make_kdm ((*i)->certificate, dcp, from, until));
1020 /** @return The approximate disk space required to encode a DCP of this film with the
1021 * current settings, in bytes.
1024 Film::required_disk_space () const
1026 return uint64_t (j2k_bandwidth() / 8) * length() / TIME_HZ;
1029 /** This method checks the disk that the Film is on and tries to decide whether or not
1030 * there will be enough space to make a DCP for it. If so, true is returned; if not,
1031 * false is returned and required and availabe are filled in with the amount of disk space
1032 * required and available respectively (in Gb).
1034 * Note: the decision made by this method isn't, of course, 100% reliable.
1037 Film::should_be_enough_disk_space (double& required, double& available) const
1039 boost::filesystem::space_info s = boost::filesystem::space (internal_video_mxf_dir ());
1040 required = double (required_disk_space ()) / 1073741824.0f;
1041 available = double (s.available) / 1073741824.0f;
1042 return (available - required) > 1;