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;
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 log()->log (String::compose ("DCP-o-matic %1 git %2 using %3", dcpomatic_version, dcpomatic_git_commit, dependency_version_summary()));
254 gethostname (buffer, sizeof (buffer));
255 log()->log (String::compose ("Starting to make DCP on %1", buffer));
258 ContentList cl = content ();
259 for (ContentList::const_iterator i = cl.begin(); i != cl.end(); ++i) {
260 log()->log (String::compose ("Content: %1", (*i)->technical_summary()));
262 log()->log (String::compose ("DCP video rate %1 fps", video_frame_rate()));
263 log()->log (String::compose ("%1 threads", Config::instance()->num_local_encoding_threads()));
264 log()->log (String::compose ("J2K bandwidth %1", j2k_bandwidth()));
265 #ifdef DCPOMATIC_DEBUG
266 log()->log ("DCP-o-matic built in debug mode.");
268 log()->log ("DCP-o-matic built in optimised mode.");
271 log()->log ("libdcp built in debug mode.");
273 log()->log ("libdcp built in optimised mode.");
276 #ifdef DCPOMATIC_WINDOWS
278 info.dwOSVersionInfoSize = sizeof (info);
279 GetVersionEx (&info);
280 log()->log (String::compose ("Windows version %1.%2.%3 SP %4", info.dwMajorVersion, info.dwMinorVersion, info.dwBuildNumber, info.szCSDVersion));
283 log()->log (String::compose ("CPU: %1, %2 processors", cpu_info(), boost::thread::hardware_concurrency ()));
284 list<pair<string, string> > const m = mount_info ();
285 for (list<pair<string, string> >::const_iterator i = m.begin(); i != m.end(); ++i) {
286 log()->log (String::compose ("Mount: %1 %2", i->first, i->second));
289 if (container() == 0) {
290 throw MissingSettingError (_("container"));
293 if (content().empty()) {
294 throw StringError (_("You must add some content to the DCP before creating it"));
297 if (dcp_content_type() == 0) {
298 throw MissingSettingError (_("content type"));
301 if (name().empty()) {
302 throw MissingSettingError (_("name"));
305 JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
308 /** Start a job to send our DCP to the configured TMS */
310 Film::send_dcp_to_tms ()
312 shared_ptr<Job> j (new SCPDCPJob (shared_from_this()));
313 JobManager::instance()->add (j);
316 /** Count the number of frames that have been encoded for this film.
317 * @return frame count.
320 Film::encoded_frames () const
322 if (container() == 0) {
327 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (info_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
329 boost::this_thread::interruption_point ();
335 shared_ptr<xmlpp::Document>
336 Film::metadata () const
340 shared_ptr<xmlpp::Document> doc (new xmlpp::Document);
341 xmlpp::Element* root = doc->create_root_node ("Metadata");
343 root->add_child("Version")->add_child_text (lexical_cast<string> (current_state_version));
344 root->add_child("Name")->add_child_text (_name);
345 root->add_child("UseDCIName")->add_child_text (_use_dci_name ? "1" : "0");
347 if (_dcp_content_type) {
348 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->dci_name ());
352 root->add_child("Container")->add_child_text (_container->id ());
355 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
356 root->add_child("Scaler")->add_child_text (_scaler->id ());
357 root->add_child("WithSubtitles")->add_child_text (_with_subtitles ? "1" : "0");
358 root->add_child("J2KBandwidth")->add_child_text (lexical_cast<string> (_j2k_bandwidth));
359 _dci_metadata.as_xml (root->add_child ("DCIMetadata"));
360 root->add_child("VideoFrameRate")->add_child_text (lexical_cast<string> (_video_frame_rate));
361 root->add_child("DCIDate")->add_child_text (boost::gregorian::to_iso_string (_dci_date));
362 root->add_child("AudioChannels")->add_child_text (lexical_cast<string> (_audio_channels));
363 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
364 root->add_child("SequenceVideo")->add_child_text (_sequence_video ? "1" : "0");
365 root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
366 root->add_child("Signed")->add_child_text (_signed ? "1" : "0");
367 root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
368 root->add_child("Key")->add_child_text (_key.hex ());
369 _playlist->as_xml (root->add_child ("Playlist"));
374 /** Write state to our `metadata' file */
376 Film::write_metadata () const
378 boost::filesystem::create_directories (directory ());
379 shared_ptr<xmlpp::Document> doc = metadata ();
380 doc->write_to_file_formatted (file("metadata.xml").string ());
384 /** Read state from our metadata file */
386 Film::read_metadata ()
390 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
391 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!"));
394 cxml::Document f ("Metadata");
395 f.read_file (file ("metadata.xml"));
397 _state_version = f.number_child<int> ("Version");
398 if (_state_version > current_state_version) {
399 throw StringError (_("This film was created with a newer version of DCP-o-matic, and it cannot be loaded into this version. Sorry!"));
402 _name = f.string_child ("Name");
403 _use_dci_name = f.bool_child ("UseDCIName");
406 optional<string> c = f.optional_string_child ("DCPContentType");
408 _dcp_content_type = DCPContentType::from_dci_name (c.get ());
413 optional<string> c = f.optional_string_child ("Container");
415 _container = Ratio::from_id (c.get ());
419 _resolution = string_to_resolution (f.string_child ("Resolution"));
420 _scaler = Scaler::from_id (f.string_child ("Scaler"));
421 _with_subtitles = f.bool_child ("WithSubtitles");
422 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
423 _dci_metadata = DCIMetadata (f.node_child ("DCIMetadata"));
424 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
425 _dci_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
426 _signed = f.optional_bool_child("Signed").get_value_or (true);
427 _encrypted = f.bool_child ("Encrypted");
428 _audio_channels = f.number_child<int> ("AudioChannels");
429 _sequence_video = f.bool_child ("SequenceVideo");
430 _three_d = f.bool_child ("ThreeD");
431 _interop = f.bool_child ("Interop");
432 _key = libdcp::Key (f.string_child ("Key"));
433 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version);
438 /** Given a directory name, return its full path within the Film's directory.
439 * The directory (and its parents) will be created if they do not exist.
441 boost::filesystem::path
442 Film::dir (boost::filesystem::path d) const
444 boost::filesystem::path p;
448 boost::filesystem::create_directories (p);
453 /** Given a file or directory name, return its full path within the Film's directory.
454 * Any required parent directories will be created.
456 boost::filesystem::path
457 Film::file (boost::filesystem::path f) const
459 boost::filesystem::path p;
463 boost::filesystem::create_directories (p.parent_path ());
468 /** @return a DCI-compliant name for a DCP of this film */
470 Film::dci_name (bool if_created_now) const
474 string fixed_name = to_upper_copy (name());
475 for (size_t i = 0; i < fixed_name.length(); ++i) {
476 if (fixed_name[i] == ' ') {
481 /* Spec is that the name part should be maximum 14 characters, as I understand it */
482 if (fixed_name.length() > 14) {
483 fixed_name = fixed_name.substr (0, 14);
488 if (dcp_content_type()) {
489 d << "_" << dcp_content_type()->dci_name();
490 d << "-" << dci_metadata().content_version;
497 if (video_frame_rate() != 24) {
498 d << "-" << video_frame_rate();
502 d << "_" << container()->dci_name();
505 DCIMetadata const dm = dci_metadata ();
507 if (!dm.audio_language.empty ()) {
508 d << "_" << dm.audio_language;
509 if (!dm.subtitle_language.empty()) {
510 d << "-" << dm.subtitle_language;
516 if (!dm.territory.empty ()) {
517 d << "_" << dm.territory;
518 if (!dm.rating.empty ()) {
519 d << "-" << dm.rating;
523 switch (audio_channels ()) {
544 d << "_" << resolution_to_string (_resolution);
546 if (!dm.studio.empty ()) {
547 d << "_" << dm.studio;
550 if (if_created_now) {
551 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
553 d << "_" << boost::gregorian::to_iso_string (_dci_date);
556 if (!dm.facility.empty ()) {
557 d << "_" << dm.facility;
560 if (!dm.package_type.empty ()) {
561 d << "_" << dm.package_type;
567 /** @return name to give the DCP */
569 Film::dcp_name (bool if_created_now) const
571 if (use_dci_name()) {
572 return dci_name (if_created_now);
580 Film::set_directory (boost::filesystem::path d)
587 Film::set_name (string n)
590 signal_changed (NAME);
594 Film::set_use_dci_name (bool u)
597 signal_changed (USE_DCI_NAME);
601 Film::set_dcp_content_type (DCPContentType const * t)
603 _dcp_content_type = t;
604 signal_changed (DCP_CONTENT_TYPE);
608 Film::set_container (Ratio const * c)
611 signal_changed (CONTAINER);
615 Film::set_resolution (Resolution r)
618 signal_changed (RESOLUTION);
622 Film::set_scaler (Scaler const * s)
625 signal_changed (SCALER);
629 Film::set_with_subtitles (bool w)
632 signal_changed (WITH_SUBTITLES);
636 Film::set_j2k_bandwidth (int b)
639 signal_changed (J2K_BANDWIDTH);
643 Film::set_dci_metadata (DCIMetadata m)
646 signal_changed (DCI_METADATA);
650 Film::set_video_frame_rate (int f)
652 _video_frame_rate = f;
653 signal_changed (VIDEO_FRAME_RATE);
657 Film::set_audio_channels (int c)
660 signal_changed (AUDIO_CHANNELS);
664 Film::set_three_d (bool t)
667 signal_changed (THREE_D);
671 Film::set_interop (bool i)
674 signal_changed (INTEROP);
678 Film::signal_changed (Property p)
684 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
686 case Film::VIDEO_FRAME_RATE:
687 case Film::SEQUENCE_VIDEO:
688 _playlist->maybe_sequence_video ();
695 ui_signaller->emit (boost::bind (boost::ref (Changed), p));
700 Film::set_dci_date_today ()
702 _dci_date = boost::gregorian::day_clock::local_day ();
705 boost::filesystem::path
706 Film::info_path (int f, Eyes e) const
708 boost::filesystem::path p;
713 s << setfill('0') << f;
715 if (e == EYES_LEFT) {
717 } else if (e == EYES_RIGHT) {
725 /* info_dir() will already have added any initial bit of the path,
726 so don't call file() on this.
731 boost::filesystem::path
732 Film::j2c_path (int f, Eyes e, bool t) const
734 boost::filesystem::path p;
736 p /= video_identifier ();
740 s << setfill('0') << f;
742 if (e == EYES_LEFT) {
744 } else if (e == EYES_RIGHT) {
758 /** @return List of subdirectories (not full paths) containing DCPs that can be successfully libdcp::DCP::read() */
759 list<boost::filesystem::path>
762 list<boost::filesystem::path> out;
764 boost::filesystem::path const dir = directory ();
765 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
767 boost::filesystem::is_directory (*i) &&
768 i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
772 libdcp::DCP dcp (*i);
774 out.push_back (i->path().leaf ());
785 Film::make_player () const
787 return shared_ptr<Player> (new Player (shared_from_this (), _playlist));
791 Film::set_signed (bool s)
794 signal_changed (SIGNED);
798 Film::set_encrypted (bool e)
801 signal_changed (ENCRYPTED);
805 Film::playlist () const
811 Film::content () const
813 return _playlist->content ();
817 Film::examine_and_add_content (shared_ptr<Content> c)
819 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
820 j->Finished.connect (bind (&Film::maybe_add_content, this, boost::weak_ptr<Job> (j), boost::weak_ptr<Content> (c)));
821 JobManager::instance()->add (j);
825 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
827 shared_ptr<Job> job = j.lock ();
828 if (!job || !job->finished_ok ()) {
832 shared_ptr<Content> content = c.lock ();
834 add_content (content);
839 Film::add_content (shared_ptr<Content> c)
841 /* Add video content after any existing content */
842 if (dynamic_pointer_cast<VideoContent> (c)) {
843 c->set_position (_playlist->video_end ());
850 Film::remove_content (shared_ptr<Content> c)
852 _playlist->remove (c);
856 Film::move_content_earlier (shared_ptr<Content> c)
858 _playlist->move_earlier (c);
862 Film::move_content_later (shared_ptr<Content> c)
864 _playlist->move_later (c);
868 Film::length () const
870 return _playlist->length ();
874 Film::has_subtitles () const
876 return _playlist->has_subtitles ();
880 Film::best_video_frame_rate () const
882 return _playlist->best_dcp_frame_rate ();
886 Film::playlist_content_changed (boost::weak_ptr<Content> c, int p)
888 if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
889 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
893 ui_signaller->emit (boost::bind (boost::ref (ContentChanged), c, p));
898 Film::playlist_changed ()
900 signal_changed (CONTENT);
904 Film::time_to_audio_frames (Time t) const
906 return divide_with_round (t * audio_frame_rate (), TIME_HZ);
910 Film::time_to_video_frames (Time t) const
912 return divide_with_round (t * video_frame_rate (), TIME_HZ);
916 Film::audio_frames_to_time (OutputAudioFrame f) const
918 return divide_with_round (f * TIME_HZ, audio_frame_rate ());
922 Film::video_frames_to_time (OutputVideoFrame f) const
924 return divide_with_round (f * TIME_HZ, video_frame_rate ());
928 Film::audio_frame_rate () const
935 Film::set_sequence_video (bool s)
938 _playlist->set_sequence_video (s);
939 signal_changed (SEQUENCE_VIDEO);
943 Film::full_frame () const
945 switch (_resolution) {
947 return libdcp::Size (2048, 1080);
949 return libdcp::Size (4096, 2160);
953 return libdcp::Size ();
958 shared_ptr<libdcp::Certificate> target,
959 boost::filesystem::path dcp_dir,
960 boost::posix_time::ptime from,
961 boost::posix_time::ptime until
964 shared_ptr<const Signer> signer = make_signer ();
966 libdcp::DCP dcp (dir (dcp_dir.string ()));
971 throw KDMError (_("Could not read DCP to make KDM for"));
974 time_t now = time (0);
975 struct tm* tm = localtime (&now);
976 string const issue_date = libdcp::tm_to_string (tm);
978 dcp.cpls().front()->set_mxf_keys (key ());
980 return libdcp::KDM (dcp.cpls().front(), signer, target, from, until, "DCP-o-matic", issue_date);
985 list<shared_ptr<Screen> > screens,
986 boost::filesystem::path dcp,
987 boost::posix_time::ptime from,
988 boost::posix_time::ptime until
991 list<libdcp::KDM> kdms;
993 for (list<shared_ptr<Screen> >::iterator i = screens.begin(); i != screens.end(); ++i) {
994 kdms.push_back (make_kdm ((*i)->certificate, dcp, from, until));
1000 /** @return The approximate disk space required to encode a DCP of this film with the
1001 * current settings, in bytes.
1004 Film::required_disk_space () const
1006 return uint64_t (j2k_bandwidth() / 8) * length() / TIME_HZ;
1009 /** This method checks the disk that the Film is on and tries to decide whether or not
1010 * there will be enough space to make a DCP for it. If so, true is returned; if not,
1011 * false is returned and required and availabe are filled in with the amount of disk space
1012 * required and available respectively (in Gb).
1014 * Note: the decision made by this method isn't, of course, 100% reliable.
1017 Film::should_be_enough_disk_space (double& required, double& available) const
1019 boost::filesystem::space_info s = boost::filesystem::space (internal_video_mxf_dir ());
1020 required = double (required_disk_space ()) / 1073741824.0f;
1021 available = double (s.available) / 1073741824.0f;
1022 return (available - required) > 1;