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>
37 #include "job_manager.h"
38 #include "transcode_job.h"
39 #include "scp_dcp_job.h"
41 #include "exceptions.h"
42 #include "examine_content_job.h"
46 #include "ui_signaller.h"
49 #include "dcp_content_type.h"
56 using std::stringstream;
69 using boost::shared_ptr;
70 using boost::weak_ptr;
71 using boost::lexical_cast;
72 using boost::dynamic_pointer_cast;
73 using boost::to_upper_copy;
74 using boost::ends_with;
75 using boost::starts_with;
76 using boost::optional;
79 int const Film::state_version = 4;
81 /** Construct a Film object in a given directory.
83 * @param d Film directory.
87 : _playlist (new Playlist)
88 , _use_dci_name (true)
89 , _dcp_content_type (Config::instance()->default_dcp_content_type ())
90 , _container (Config::instance()->default_container ())
91 , _resolution (RESOLUTION_2K)
92 , _scaler (Scaler::from_id ("bicubic"))
93 , _with_subtitles (false)
94 , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
95 , _dci_metadata (Config::instance()->default_dci_metadata ())
96 , _video_frame_rate (24)
97 , _audio_channels (MAX_AUDIO_CHANNELS)
99 , _sequence_video (true)
102 set_dci_date_today ();
104 _playlist->Changed.connect (bind (&Film::playlist_changed, this));
105 _playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2));
107 /* Make state.directory a complete path without ..s (where possible)
108 (Code swiped from Adam Bowen on stackoverflow)
111 boost::filesystem::path p (boost::filesystem::system_complete (d));
112 boost::filesystem::path result;
113 for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
115 if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
118 result = result.parent_path ();
120 } else if (*i != ".") {
125 set_directory (result.string ());
126 _log.reset (new FileLog (file ("log")));
128 _playlist->set_sequence_video (_sequence_video);
132 Film::video_identifier () const
134 assert (container ());
138 s << container()->id()
139 << "_" << resolution_to_string (_resolution)
140 << "_" << _playlist->video_identifier()
141 << "_" << _video_frame_rate
142 << "_" << scaler()->id()
143 << "_" << j2k_bandwidth();
152 /** @return The path to the directory to write video frame info files to */
154 Film::info_dir () const
156 boost::filesystem::path p;
158 p /= video_identifier ();
159 return dir (p.string());
163 Film::internal_video_mxf_dir () const
165 return dir ("video");
169 Film::internal_video_mxf_filename () const
171 return video_identifier() + ".mxf";
175 Film::video_mxf_filename () const
177 return filename_safe_name() + "_video.mxf";
181 Film::audio_mxf_filename () const
183 return filename_safe_name() + "_audio.mxf";
187 Film::filename_safe_name () const
189 string const n = name ();
191 for (size_t i = 0; i < n.length(); ++i) {
192 if (isalnum (n[i])) {
202 boost::filesystem::path
203 Film::audio_analysis_path (shared_ptr<const AudioContent> c) const
205 boost::filesystem::path p = dir ("analysis");
210 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
214 set_dci_date_today ();
216 if (dcp_name().find ("/") != string::npos) {
217 throw BadSettingError (_("name"), _("cannot contain slashes"));
220 log()->log (String::compose ("DCP-o-matic %1 git %2 using %3", dcpomatic_version, dcpomatic_git_commit, dependency_version_summary()));
224 gethostname (buffer, sizeof (buffer));
225 log()->log (String::compose ("Starting to make DCP on %1", buffer));
228 ContentList cl = content ();
229 for (ContentList::const_iterator i = cl.begin(); i != cl.end(); ++i) {
230 log()->log (String::compose ("Content: %1", (*i)->technical_summary()));
232 log()->log (String::compose ("DCP video rate %1 fps", video_frame_rate()));
233 log()->log (String::compose ("%1 threads", Config::instance()->num_local_encoding_threads()));
234 log()->log (String::compose ("J2K bandwidth %1", j2k_bandwidth()));
235 #ifdef DCPOMATIC_DEBUG
236 log()->log ("DCP-o-matic built in debug mode.");
238 log()->log ("DCP-o-matic built in optimised mode.");
241 log()->log ("libdcp built in debug mode.");
243 log()->log ("libdcp built in optimised mode.");
245 log()->log (String::compose ("CPU: %1, %2 processors", cpu_info(), boost::thread::hardware_concurrency ()));
246 list<pair<string, string> > const m = mount_info ();
247 for (list<pair<string, string> >::const_iterator i = m.begin(); i != m.end(); ++i) {
248 log()->log (String::compose ("Mount: %1 %2", i->first, i->second));
251 if (container() == 0) {
252 throw MissingSettingError (_("container"));
255 if (content().empty()) {
256 throw StringError (_("You must add some content to the DCP before creating it"));
259 if (dcp_content_type() == 0) {
260 throw MissingSettingError (_("content type"));
263 if (name().empty()) {
264 throw MissingSettingError (_("name"));
267 JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
270 /** Start a job to send our DCP to the configured TMS */
272 Film::send_dcp_to_tms ()
274 shared_ptr<Job> j (new SCPDCPJob (shared_from_this()));
275 JobManager::instance()->add (j);
278 /** Count the number of frames that have been encoded for this film.
279 * @return frame count.
282 Film::encoded_frames () const
284 if (container() == 0) {
289 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (info_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
291 boost::this_thread::interruption_point ();
297 /** Write state to our `metadata' file */
299 Film::write_metadata () const
301 if (!boost::filesystem::exists (directory())) {
302 boost::filesystem::create_directory (directory());
305 boost::mutex::scoped_lock lm (_state_mutex);
308 boost::filesystem::create_directories (directory());
311 xmlpp::Element* root = doc.create_root_node ("Metadata");
313 root->add_child("Version")->add_child_text (lexical_cast<string> (state_version));
314 root->add_child("Name")->add_child_text (_name);
315 root->add_child("UseDCIName")->add_child_text (_use_dci_name ? "1" : "0");
317 if (_dcp_content_type) {
318 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->dci_name ());
322 root->add_child("Container")->add_child_text (_container->id ());
325 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
326 root->add_child("Scaler")->add_child_text (_scaler->id ());
327 root->add_child("WithSubtitles")->add_child_text (_with_subtitles ? "1" : "0");
328 root->add_child("J2KBandwidth")->add_child_text (lexical_cast<string> (_j2k_bandwidth));
329 _dci_metadata.as_xml (root->add_child ("DCIMetadata"));
330 root->add_child("VideoFrameRate")->add_child_text (lexical_cast<string> (_video_frame_rate));
331 root->add_child("DCIDate")->add_child_text (boost::gregorian::to_iso_string (_dci_date));
332 root->add_child("AudioChannels")->add_child_text (lexical_cast<string> (_audio_channels));
333 root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
334 root->add_child("SequenceVideo")->add_child_text (_sequence_video ? "1" : "0");
335 _playlist->as_xml (root->add_child ("Playlist"));
337 doc.write_to_file_formatted (file ("metadata.xml"));
342 /** Read state from our metadata file */
344 Film::read_metadata ()
346 boost::mutex::scoped_lock lm (_state_mutex);
349 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
350 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!"));
353 cxml::File f (file ("metadata.xml"), "Metadata");
355 _name = f.string_child ("Name");
356 _use_dci_name = f.bool_child ("UseDCIName");
359 optional<string> c = f.optional_string_child ("DCPContentType");
361 _dcp_content_type = DCPContentType::from_dci_name (c.get ());
366 optional<string> c = f.optional_string_child ("Container");
368 _container = Ratio::from_id (c.get ());
372 _resolution = string_to_resolution (f.string_child ("Resolution"));
373 _scaler = Scaler::from_id (f.string_child ("Scaler"));
374 _with_subtitles = f.bool_child ("WithSubtitles");
375 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
376 _dci_metadata = DCIMetadata (f.node_child ("DCIMetadata"));
377 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
378 _dci_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
379 _audio_channels = f.number_child<int> ("AudioChannels");
380 _sequence_video = f.bool_child ("SequenceVideo");
381 _three_d = f.bool_child ("ThreeD");
383 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"));
388 /** Given a directory name, return its full path within the Film's directory.
389 * The directory (and its parents) will be created if they do not exist.
392 Film::dir (string d) const
394 boost::mutex::scoped_lock lm (_directory_mutex);
396 boost::filesystem::path p;
400 boost::filesystem::create_directories (p);
405 /** Given a file or directory name, return its full path within the Film's directory.
406 * _directory_mutex must not be locked on entry.
407 * Any required parent directories will be created.
410 Film::file (string f) const
412 boost::mutex::scoped_lock lm (_directory_mutex);
414 boost::filesystem::path p;
418 boost::filesystem::create_directories (p.parent_path ());
423 /** @return a DCI-compliant name for a DCP of this film */
425 Film::dci_name (bool if_created_now) const
429 string fixed_name = to_upper_copy (name());
430 for (size_t i = 0; i < fixed_name.length(); ++i) {
431 if (fixed_name[i] == ' ') {
436 /* Spec is that the name part should be maximum 14 characters, as I understand it */
437 if (fixed_name.length() > 14) {
438 fixed_name = fixed_name.substr (0, 14);
443 if (dcp_content_type()) {
444 d << "_" << dcp_content_type()->dci_name();
451 if (video_frame_rate() != 24) {
452 d << "-" << video_frame_rate();
456 d << "_" << container()->dci_name();
459 DCIMetadata const dm = dci_metadata ();
461 if (!dm.audio_language.empty ()) {
462 d << "_" << dm.audio_language;
463 if (!dm.subtitle_language.empty() && with_subtitles()) {
464 d << "-" << dm.subtitle_language;
470 if (!dm.territory.empty ()) {
471 d << "_" << dm.territory;
472 if (!dm.rating.empty ()) {
473 d << "-" << dm.rating;
477 switch (audio_channels ()) {
498 d << "_" << resolution_to_string (_resolution);
500 if (!dm.studio.empty ()) {
501 d << "_" << dm.studio;
504 if (if_created_now) {
505 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
507 d << "_" << boost::gregorian::to_iso_string (_dci_date);
510 if (!dm.facility.empty ()) {
511 d << "_" << dm.facility;
514 if (!dm.package_type.empty ()) {
515 d << "_" << dm.package_type;
521 /** @return name to give the DCP */
523 Film::dcp_name (bool if_created_now) const
525 if (use_dci_name()) {
526 return dci_name (if_created_now);
534 Film::set_directory (string d)
536 boost::mutex::scoped_lock lm (_state_mutex);
542 Film::set_name (string n)
545 boost::mutex::scoped_lock lm (_state_mutex);
548 signal_changed (NAME);
552 Film::set_use_dci_name (bool u)
555 boost::mutex::scoped_lock lm (_state_mutex);
558 signal_changed (USE_DCI_NAME);
562 Film::set_dcp_content_type (DCPContentType const * t)
565 boost::mutex::scoped_lock lm (_state_mutex);
566 _dcp_content_type = t;
568 signal_changed (DCP_CONTENT_TYPE);
572 Film::set_container (Ratio const * c)
575 boost::mutex::scoped_lock lm (_state_mutex);
578 signal_changed (CONTAINER);
582 Film::set_resolution (Resolution r)
585 boost::mutex::scoped_lock lm (_state_mutex);
588 signal_changed (RESOLUTION);
592 Film::set_scaler (Scaler const * s)
595 boost::mutex::scoped_lock lm (_state_mutex);
598 signal_changed (SCALER);
602 Film::set_with_subtitles (bool w)
605 boost::mutex::scoped_lock lm (_state_mutex);
608 signal_changed (WITH_SUBTITLES);
612 Film::set_j2k_bandwidth (int b)
615 boost::mutex::scoped_lock lm (_state_mutex);
618 signal_changed (J2K_BANDWIDTH);
622 Film::set_dci_metadata (DCIMetadata m)
625 boost::mutex::scoped_lock lm (_state_mutex);
628 signal_changed (DCI_METADATA);
632 Film::set_video_frame_rate (int f)
635 boost::mutex::scoped_lock lm (_state_mutex);
636 _video_frame_rate = f;
638 signal_changed (VIDEO_FRAME_RATE);
642 Film::set_audio_channels (int c)
645 boost::mutex::scoped_lock lm (_state_mutex);
648 signal_changed (AUDIO_CHANNELS);
652 Film::set_three_d (bool t)
655 boost::mutex::scoped_lock lm (_state_mutex);
658 signal_changed (THREE_D);
662 Film::signal_changed (Property p)
665 boost::mutex::scoped_lock lm (_state_mutex);
671 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
673 case Film::VIDEO_FRAME_RATE:
674 case Film::SEQUENCE_VIDEO:
675 _playlist->maybe_sequence_video ();
682 ui_signaller->emit (boost::bind (boost::ref (Changed), p));
687 Film::set_dci_date_today ()
689 _dci_date = boost::gregorian::day_clock::local_day ();
693 Film::info_path (int f, Eyes e) const
695 boost::filesystem::path p;
700 s << setfill('0') << f;
702 if (e == EYES_LEFT) {
704 } else if (e == EYES_RIGHT) {
712 /* info_dir() will already have added any initial bit of the path,
713 so don't call file() on this.
719 Film::j2c_path (int f, Eyes e, bool t) const
721 boost::filesystem::path p;
723 p /= video_identifier ();
727 s << setfill('0') << f;
729 if (e == EYES_LEFT) {
731 } else if (e == EYES_RIGHT) {
742 return file (p.string ());
745 /** Make an educated guess as to whether we have a complete DCP
747 * @return true if we do.
751 Film::have_dcp () const
754 libdcp::DCP dcp (dir (dcp_name()));
764 Film::make_player () const
766 return shared_ptr<Player> (new Player (shared_from_this (), _playlist));
770 Film::playlist () const
772 boost::mutex::scoped_lock lm (_state_mutex);
777 Film::content () const
779 return _playlist->content ();
783 Film::examine_and_add_content (shared_ptr<Content> c)
785 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
786 j->Finished.connect (bind (&Film::maybe_add_content, this, boost::weak_ptr<Job> (j), boost::weak_ptr<Content> (c)));
787 JobManager::instance()->add (j);
791 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
793 shared_ptr<Job> job = j.lock ();
794 if (!job || !job->finished_ok ()) {
798 shared_ptr<Content> content = c.lock ();
800 add_content (content);
805 Film::add_content (shared_ptr<Content> c)
807 /* Add video content after any existing content */
808 if (dynamic_pointer_cast<VideoContent> (c)) {
809 c->set_position (_playlist->video_end ());
816 Film::remove_content (shared_ptr<Content> c)
818 _playlist->remove (c);
822 Film::length () const
824 return _playlist->length ();
828 Film::has_subtitles () const
830 return _playlist->has_subtitles ();
834 Film::best_video_frame_rate () const
836 return _playlist->best_dcp_frame_rate ();
840 Film::playlist_content_changed (boost::weak_ptr<Content> c, int p)
842 if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
843 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
847 ui_signaller->emit (boost::bind (boost::ref (ContentChanged), c, p));
852 Film::playlist_changed ()
854 signal_changed (CONTENT);
858 Film::time_to_audio_frames (Time t) const
860 return t * audio_frame_rate () / TIME_HZ;
864 Film::time_to_video_frames (Time t) const
866 return t * video_frame_rate () / TIME_HZ;
870 Film::audio_frames_to_time (OutputAudioFrame f) const
872 return f * TIME_HZ / audio_frame_rate ();
876 Film::video_frames_to_time (OutputVideoFrame f) const
878 return f * TIME_HZ / video_frame_rate ();
882 Film::audio_frame_rate () const
889 Film::set_sequence_video (bool s)
892 boost::mutex::scoped_lock lm (_state_mutex);
894 _playlist->set_sequence_video (s);
897 signal_changed (SEQUENCE_VIDEO);
901 Film::full_frame () const
903 switch (_resolution) {
905 return libdcp::Size (2048, 1080);
907 return libdcp::Size (4096, 2160);
911 return libdcp::Size ();