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 <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;
73 using boost::shared_ptr;
74 using boost::weak_ptr;
75 using boost::lexical_cast;
76 using boost::dynamic_pointer_cast;
77 using boost::to_upper_copy;
78 using boost::ends_with;
79 using boost::starts_with;
80 using boost::optional;
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 ());
158 s << container()->id()
159 << "_" << resolution_to_string (_resolution)
160 << "_" << _playlist->video_identifier()
161 << "_" << _video_frame_rate
162 << "_" << scaler()->id()
163 << "_" << j2k_bandwidth();
184 /** @return The path to the directory to write video frame info files to */
185 boost::filesystem::path
186 Film::info_dir () const
188 boost::filesystem::path p;
190 p /= video_identifier ();
194 boost::filesystem::path
195 Film::internal_video_mxf_dir () const
197 return dir ("video");
200 boost::filesystem::path
201 Film::internal_video_mxf_filename () const
203 return video_identifier() + ".mxf";
206 boost::filesystem::path
207 Film::video_mxf_filename () const
209 return filename_safe_name() + "_video.mxf";
212 boost::filesystem::path
213 Film::audio_mxf_filename () const
215 return filename_safe_name() + "_audio.mxf";
219 Film::filename_safe_name () const
221 string const n = name ();
223 for (size_t i = 0; i < n.length(); ++i) {
224 if (isalnum (n[i])) {
234 boost::filesystem::path
235 Film::audio_analysis_dir () const
237 return dir ("analysis");
240 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
244 set_dci_date_today ();
246 if (dcp_name().find ("/") != string::npos) {
247 throw BadSettingError (_("name"), _("cannot contain slashes"));
250 /* It seems to make sense to auto-save metadata here, since the make DCP may last
251 a long time, and crashes/power failures are moderately likely.
255 log()->log (String::compose ("DCP-o-matic %1 git %2 using %3", dcpomatic_version, dcpomatic_git_commit, dependency_version_summary()));
259 gethostname (buffer, sizeof (buffer));
260 log()->log (String::compose ("Starting to make DCP on %1", buffer));
263 ContentList cl = content ();
264 for (ContentList::const_iterator i = cl.begin(); i != cl.end(); ++i) {
265 log()->log (String::compose ("Content: %1", (*i)->technical_summary()));
267 log()->log (String::compose ("DCP video rate %1 fps", video_frame_rate()));
268 log()->log (String::compose ("%1 threads", Config::instance()->num_local_encoding_threads()));
269 log()->log (String::compose ("J2K bandwidth %1", j2k_bandwidth()));
270 #ifdef DCPOMATIC_DEBUG
271 log()->log ("DCP-o-matic built in debug mode.");
273 log()->log ("DCP-o-matic built in optimised mode.");
276 log()->log ("libdcp built in debug mode.");
278 log()->log ("libdcp built in optimised mode.");
281 #ifdef DCPOMATIC_WINDOWS
283 info.dwOSVersionInfoSize = sizeof (info);
284 GetVersionEx (&info);
285 log()->log (String::compose ("Windows version %1.%2.%3 SP %4", info.dwMajorVersion, info.dwMinorVersion, info.dwBuildNumber, info.szCSDVersion));
288 log()->log (String::compose ("CPU: %1, %2 processors", cpu_info(), boost::thread::hardware_concurrency ()));
289 list<pair<string, string> > const m = mount_info ();
290 for (list<pair<string, string> >::const_iterator i = m.begin(); i != m.end(); ++i) {
291 log()->log (String::compose ("Mount: %1 %2", i->first, i->second));
294 if (container() == 0) {
295 throw MissingSettingError (_("container"));
298 if (content().empty()) {
299 throw StringError (_("You must add some content to the DCP before creating it"));
302 if (dcp_content_type() == 0) {
303 throw MissingSettingError (_("content type"));
306 if (name().empty()) {
307 throw MissingSettingError (_("name"));
310 JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
313 /** Start a job to send our DCP to the configured TMS */
315 Film::send_dcp_to_tms ()
317 shared_ptr<Job> j (new SCPDCPJob (shared_from_this()));
318 JobManager::instance()->add (j);
321 /** Count the number of frames that have been encoded for this film.
322 * @return frame count.
325 Film::encoded_frames () const
327 if (container() == 0) {
332 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (info_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
334 boost::this_thread::interruption_point ();
340 shared_ptr<xmlpp::Document>
341 Film::metadata () const
345 shared_ptr<xmlpp::Document> doc (new xmlpp::Document);
346 xmlpp::Element* root = doc->create_root_node ("Metadata");
348 root->add_child("Version")->add_child_text (lexical_cast<string> (current_state_version));
349 root->add_child("Name")->add_child_text (_name);
350 root->add_child("UseDCIName")->add_child_text (_use_dci_name ? "1" : "0");
352 if (_dcp_content_type) {
353 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->dci_name ());
357 root->add_child("Container")->add_child_text (_container->id ());
360 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
361 root->add_child("Scaler")->add_child_text (_scaler->id ());
362 root->add_child("WithSubtitles")->add_child_text (_with_subtitles ? "1" : "0");
363 root->add_child("J2KBandwidth")->add_child_text (lexical_cast<string> (_j2k_bandwidth));
364 _dci_metadata.as_xml (root->add_child ("DCIMetadata"));
365 root->add_child("VideoFrameRate")->add_child_text (lexical_cast<string> (_video_frame_rate));
366 root->add_child("DCIDate")->add_child_text (boost::gregorian::to_iso_string (_dci_date));
367 root->add_child("AudioChannels")->add_child_text (lexical_cast<string> (_audio_channels));
368 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
369 root->add_child("SequenceVideo")->add_child_text (_sequence_video ? "1" : "0");
370 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
371 root->add_child("Signed")->add_child_text (_signed ? "1" : "0");
372 root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
373 root->add_child("Key")->add_child_text (_key.hex ());
374 _playlist->as_xml (root->add_child ("Playlist"));
379 /** Write state to our `metadata' file */
381 Film::write_metadata () const
383 boost::filesystem::create_directories (directory ());
384 shared_ptr<xmlpp::Document> doc = metadata ();
385 doc->write_to_file_formatted (file("metadata.xml").string ());
389 /** Read state from our metadata file.
390 * @return Notes about things that the user should know about, or empty.
393 Film::read_metadata ()
397 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
398 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!"));
401 cxml::Document f ("Metadata");
402 f.read_file (file ("metadata.xml"));
404 _state_version = f.number_child<int> ("Version");
405 if (_state_version > current_state_version) {
406 throw StringError (_("This film was created with a newer version of DCP-o-matic, and it cannot be loaded into this version. Sorry!"));
409 _name = f.string_child ("Name");
410 _use_dci_name = f.bool_child ("UseDCIName");
413 optional<string> c = f.optional_string_child ("DCPContentType");
415 _dcp_content_type = DCPContentType::from_dci_name (c.get ());
420 optional<string> c = f.optional_string_child ("Container");
422 _container = Ratio::from_id (c.get ());
426 _resolution = string_to_resolution (f.string_child ("Resolution"));
427 _scaler = Scaler::from_id (f.string_child ("Scaler"));
428 _with_subtitles = f.bool_child ("WithSubtitles");
429 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
430 _dci_metadata = DCIMetadata (f.node_child ("DCIMetadata"));
431 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
432 _dci_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
433 _signed = f.optional_bool_child("Signed").get_value_or (true);
434 _encrypted = f.bool_child ("Encrypted");
435 _audio_channels = f.number_child<int> ("AudioChannels");
436 _sequence_video = f.bool_child ("SequenceVideo");
437 _three_d = f.bool_child ("ThreeD");
438 _interop = f.bool_child ("Interop");
439 _key = libdcp::Key (f.string_child ("Key"));
442 /* This method is the only one that can return notes (so far) */
443 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
449 /** Given a directory name, return its full path within the Film's directory.
450 * The directory (and its parents) will be created if they do not exist.
452 boost::filesystem::path
453 Film::dir (boost::filesystem::path d) const
455 boost::filesystem::path p;
459 boost::filesystem::create_directories (p);
464 /** Given a file or directory name, return its full path within the Film's directory.
465 * Any required parent directories will be created.
467 boost::filesystem::path
468 Film::file (boost::filesystem::path f) const
470 boost::filesystem::path p;
474 boost::filesystem::create_directories (p.parent_path ());
479 /** @return a DCI-compliant name for a DCP of this film */
481 Film::dci_name (bool if_created_now) const
485 string fixed_name = to_upper_copy (name());
486 for (size_t i = 0; i < fixed_name.length(); ++i) {
487 if (fixed_name[i] == ' ') {
492 /* Spec is that the name part should be maximum 14 characters, as I understand it */
493 if (fixed_name.length() > 14) {
494 fixed_name = fixed_name.substr (0, 14);
499 if (dcp_content_type()) {
500 d << "_" << dcp_content_type()->dci_name();
501 d << "-" << dci_metadata().content_version;
508 if (video_frame_rate() != 24) {
509 d << "-" << video_frame_rate();
513 d << "_" << container()->dci_name();
516 DCIMetadata const dm = dci_metadata ();
518 if (!dm.audio_language.empty ()) {
519 d << "_" << dm.audio_language;
520 if (!dm.subtitle_language.empty()) {
521 d << "-" << dm.subtitle_language;
527 if (!dm.territory.empty ()) {
528 d << "_" << dm.territory;
529 if (!dm.rating.empty ()) {
530 d << "-" << dm.rating;
534 switch (audio_channels ()) {
555 d << "_" << resolution_to_string (_resolution);
557 if (!dm.studio.empty ()) {
558 d << "_" << dm.studio;
561 if (if_created_now) {
562 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
564 d << "_" << boost::gregorian::to_iso_string (_dci_date);
567 if (!dm.facility.empty ()) {
568 d << "_" << dm.facility;
571 if (!dm.package_type.empty ()) {
572 d << "_" << dm.package_type;
578 /** @return name to give the DCP */
580 Film::dcp_name (bool if_created_now) const
582 if (use_dci_name()) {
583 return dci_name (if_created_now);
591 Film::set_directory (boost::filesystem::path d)
598 Film::set_name (string n)
601 signal_changed (NAME);
605 Film::set_use_dci_name (bool u)
608 signal_changed (USE_DCI_NAME);
612 Film::set_dcp_content_type (DCPContentType const * t)
614 _dcp_content_type = t;
615 signal_changed (DCP_CONTENT_TYPE);
619 Film::set_container (Ratio const * c)
622 signal_changed (CONTAINER);
626 Film::set_resolution (Resolution r)
629 signal_changed (RESOLUTION);
633 Film::set_scaler (Scaler const * s)
636 signal_changed (SCALER);
640 Film::set_with_subtitles (bool w)
643 signal_changed (WITH_SUBTITLES);
647 Film::set_j2k_bandwidth (int b)
650 signal_changed (J2K_BANDWIDTH);
654 Film::set_dci_metadata (DCIMetadata m)
657 signal_changed (DCI_METADATA);
661 Film::set_video_frame_rate (int f)
663 _video_frame_rate = f;
664 signal_changed (VIDEO_FRAME_RATE);
668 Film::set_audio_channels (int c)
671 signal_changed (AUDIO_CHANNELS);
675 Film::set_three_d (bool t)
678 signal_changed (THREE_D);
682 Film::set_interop (bool i)
685 signal_changed (INTEROP);
689 Film::signal_changed (Property p)
695 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
697 case Film::VIDEO_FRAME_RATE:
698 case Film::SEQUENCE_VIDEO:
699 _playlist->maybe_sequence_video ();
706 ui_signaller->emit (boost::bind (boost::ref (Changed), p));
711 Film::set_dci_date_today ()
713 _dci_date = boost::gregorian::day_clock::local_day ();
716 boost::filesystem::path
717 Film::info_path (int f, Eyes e) const
719 boost::filesystem::path p;
724 s << setfill('0') << f;
726 if (e == EYES_LEFT) {
728 } else if (e == EYES_RIGHT) {
736 /* info_dir() will already have added any initial bit of the path,
737 so don't call file() on this.
742 boost::filesystem::path
743 Film::j2c_path (int f, Eyes e, bool t) const
745 boost::filesystem::path p;
747 p /= video_identifier ();
751 s << setfill('0') << f;
753 if (e == EYES_LEFT) {
755 } else if (e == EYES_RIGHT) {
769 /** @return List of subdirectories (not full paths) containing DCPs that can be successfully libdcp::DCP::read() */
770 list<boost::filesystem::path>
773 list<boost::filesystem::path> out;
775 boost::filesystem::path const dir = directory ();
776 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
778 boost::filesystem::is_directory (*i) &&
779 i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
783 libdcp::DCP dcp (*i);
785 out.push_back (i->path().leaf ());
796 Film::make_player () const
798 return shared_ptr<Player> (new Player (shared_from_this (), _playlist));
802 Film::set_signed (bool s)
805 signal_changed (SIGNED);
809 Film::set_encrypted (bool e)
812 signal_changed (ENCRYPTED);
816 Film::playlist () const
822 Film::content () const
824 return _playlist->content ();
828 Film::examine_and_add_content (shared_ptr<Content> c)
830 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
831 j->Finished.connect (bind (&Film::maybe_add_content, this, boost::weak_ptr<Job> (j), boost::weak_ptr<Content> (c)));
832 JobManager::instance()->add (j);
836 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
838 shared_ptr<Job> job = j.lock ();
839 if (!job || !job->finished_ok ()) {
843 shared_ptr<Content> content = c.lock ();
845 add_content (content);
850 Film::add_content (shared_ptr<Content> c)
852 /* Add video content after any existing content */
853 if (dynamic_pointer_cast<VideoContent> (c)) {
854 c->set_position (_playlist->video_end ());
861 Film::remove_content (shared_ptr<Content> c)
863 _playlist->remove (c);
867 Film::move_content_earlier (shared_ptr<Content> c)
869 _playlist->move_earlier (c);
873 Film::move_content_later (shared_ptr<Content> c)
875 _playlist->move_later (c);
879 Film::length () const
881 return _playlist->length ();
885 Film::has_subtitles () const
887 return _playlist->has_subtitles ();
891 Film::best_video_frame_rate () const
893 return _playlist->best_dcp_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::time_to_audio_frames (Time t) const
917 return divide_with_round (t * audio_frame_rate (), TIME_HZ);
921 Film::time_to_video_frames (Time t) const
923 return divide_with_round (t * video_frame_rate (), TIME_HZ);
927 Film::audio_frames_to_time (OutputAudioFrame f) const
929 return divide_with_round (f * TIME_HZ, audio_frame_rate ());
933 Film::video_frames_to_time (OutputVideoFrame f) const
935 return divide_with_round (f * TIME_HZ, video_frame_rate ());
939 Film::audio_frame_rate () const
946 Film::set_sequence_video (bool s)
949 _playlist->set_sequence_video (s);
950 signal_changed (SEQUENCE_VIDEO);
953 /** @return Size of the largest possible image in whatever resolution we are using */
955 Film::full_frame () const
957 switch (_resolution) {
959 return libdcp::Size (2048, 1080);
961 return libdcp::Size (4096, 2160);
965 return libdcp::Size ();
968 /** @return Size of the frame */
970 Film::frame_size () const
972 return fit_ratio_within (container()->ratio(), full_frame ());
977 shared_ptr<libdcp::Certificate> target,
978 boost::filesystem::path dcp_dir,
979 boost::posix_time::ptime from,
980 boost::posix_time::ptime until
983 shared_ptr<const Signer> signer = make_signer ();
985 libdcp::DCP dcp (dir (dcp_dir.string ()));
990 throw KDMError (_("Could not read DCP to make KDM for"));
993 time_t now = time (0);
994 struct tm* tm = localtime (&now);
995 string const issue_date = libdcp::tm_to_string (tm);
997 dcp.cpls().front()->set_mxf_keys (key ());
999 return libdcp::KDM (dcp.cpls().front(), signer, target, from, until, "DCP-o-matic", issue_date);
1004 list<shared_ptr<Screen> > screens,
1005 boost::filesystem::path dcp,
1006 boost::posix_time::ptime from,
1007 boost::posix_time::ptime until
1010 list<libdcp::KDM> kdms;
1012 for (list<shared_ptr<Screen> >::iterator i = screens.begin(); i != screens.end(); ++i) {
1013 kdms.push_back (make_kdm ((*i)->certificate, dcp, from, until));
1019 /** @return The approximate disk space required to encode a DCP of this film with the
1020 * current settings, in bytes.
1023 Film::required_disk_space () const
1025 return uint64_t (j2k_bandwidth() / 8) * length() / TIME_HZ;
1028 /** This method checks the disk that the Film is on and tries to decide whether or not
1029 * there will be enough space to make a DCP for it. If so, true is returned; if not,
1030 * false is returned and required and availabe are filled in with the amount of disk space
1031 * required and available respectively (in Gb).
1033 * Note: the decision made by this method isn't, of course, 100% reliable.
1036 Film::should_be_enough_disk_space (double& required, double& available) const
1038 boost::filesystem::space_info s = boost::filesystem::space (internal_video_mxf_dir ());
1039 required = double (required_disk_space ()) / 1073741824.0f;
1040 available = double (s.available) / 1073741824.0f;
1041 return (available - required) > 1;