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 %2 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 pair<string, int> const c = cpu_info ();
246 log()->log (String::compose ("CPU: %1, %2 processors", c.first, c.second));
247 list<pair<string, string> > const m = mount_info ();
248 for (list<pair<string, string> >::const_iterator i = m.begin(); i != m.end(); ++i) {
249 log()->log (String::compose ("Mount: %1 %2", i->first, i->second));
252 if (container() == 0) {
253 throw MissingSettingError (_("container"));
256 if (content().empty()) {
257 throw StringError (_("You must add some content to the DCP before creating it"));
260 if (dcp_content_type() == 0) {
261 throw MissingSettingError (_("content type"));
264 if (name().empty()) {
265 throw MissingSettingError (_("name"));
268 JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
271 /** Start a job to send our DCP to the configured TMS */
273 Film::send_dcp_to_tms ()
275 shared_ptr<Job> j (new SCPDCPJob (shared_from_this()));
276 JobManager::instance()->add (j);
279 /** Count the number of frames that have been encoded for this film.
280 * @return frame count.
283 Film::encoded_frames () const
285 if (container() == 0) {
290 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (info_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
292 boost::this_thread::interruption_point ();
298 /** Write state to our `metadata' file */
300 Film::write_metadata () const
302 if (!boost::filesystem::exists (directory())) {
303 boost::filesystem::create_directory (directory());
306 boost::mutex::scoped_lock lm (_state_mutex);
309 boost::filesystem::create_directories (directory());
312 xmlpp::Element* root = doc.create_root_node ("Metadata");
314 root->add_child("Version")->add_child_text (lexical_cast<string> (state_version));
315 root->add_child("Name")->add_child_text (_name);
316 root->add_child("UseDCIName")->add_child_text (_use_dci_name ? "1" : "0");
318 if (_dcp_content_type) {
319 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->dci_name ());
323 root->add_child("Container")->add_child_text (_container->id ());
326 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
327 root->add_child("Scaler")->add_child_text (_scaler->id ());
328 root->add_child("WithSubtitles")->add_child_text (_with_subtitles ? "1" : "0");
329 root->add_child("J2KBandwidth")->add_child_text (lexical_cast<string> (_j2k_bandwidth));
330 _dci_metadata.as_xml (root->add_child ("DCIMetadata"));
331 root->add_child("VideoFrameRate")->add_child_text (lexical_cast<string> (_video_frame_rate));
332 root->add_child("DCIDate")->add_child_text (boost::gregorian::to_iso_string (_dci_date));
333 root->add_child("AudioChannels")->add_child_text (lexical_cast<string> (_audio_channels));
334 root->add_child("3D")->add_child_text (_three_d ? "1" : "0");
335 root->add_child("SequenceVideo")->add_child_text (_sequence_video ? "1" : "0");
336 _playlist->as_xml (root->add_child ("Playlist"));
338 doc.write_to_file_formatted (file ("metadata.xml"));
343 /** Read state from our metadata file */
345 Film::read_metadata ()
347 boost::mutex::scoped_lock lm (_state_mutex);
350 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
351 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!"));
354 cxml::File f (file ("metadata.xml"), "Metadata");
356 _name = f.string_child ("Name");
357 _use_dci_name = f.bool_child ("UseDCIName");
360 optional<string> c = f.optional_string_child ("DCPContentType");
362 _dcp_content_type = DCPContentType::from_dci_name (c.get ());
367 optional<string> c = f.optional_string_child ("Container");
369 _container = Ratio::from_id (c.get ());
373 _resolution = string_to_resolution (f.string_child ("Resolution"));
374 _scaler = Scaler::from_id (f.string_child ("Scaler"));
375 _with_subtitles = f.bool_child ("WithSubtitles");
376 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
377 _dci_metadata = DCIMetadata (f.node_child ("DCIMetadata"));
378 _video_frame_rate = f.number_child<int> ("VideoFrameRate");
379 _dci_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
380 _audio_channels = f.number_child<int> ("AudioChannels");
381 _sequence_video = f.bool_child ("SequenceVideo");
382 _three_d = f.bool_child ("3D");
384 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"));
389 /** Given a directory name, return its full path within the Film's directory.
390 * The directory (and its parents) will be created if they do not exist.
393 Film::dir (string d) const
395 boost::mutex::scoped_lock lm (_directory_mutex);
397 boost::filesystem::path p;
401 boost::filesystem::create_directories (p);
406 /** Given a file or directory name, return its full path within the Film's directory.
407 * _directory_mutex must not be locked on entry.
408 * Any required parent directories will be created.
411 Film::file (string f) const
413 boost::mutex::scoped_lock lm (_directory_mutex);
415 boost::filesystem::path p;
419 boost::filesystem::create_directories (p.parent_path ());
424 /** @return a DCI-compliant name for a DCP of this film */
426 Film::dci_name (bool if_created_now) const
430 string fixed_name = to_upper_copy (name());
431 for (size_t i = 0; i < fixed_name.length(); ++i) {
432 if (fixed_name[i] == ' ') {
437 /* Spec is that the name part should be maximum 14 characters, as I understand it */
438 if (fixed_name.length() > 14) {
439 fixed_name = fixed_name.substr (0, 14);
444 if (dcp_content_type()) {
445 d << "_" << dcp_content_type()->dci_name();
452 if (video_frame_rate() != 24) {
453 d << "-" << video_frame_rate();
457 d << "_" << container()->dci_name();
460 DCIMetadata const dm = dci_metadata ();
462 if (!dm.audio_language.empty ()) {
463 d << "_" << dm.audio_language;
464 if (!dm.subtitle_language.empty() && with_subtitles()) {
465 d << "-" << dm.subtitle_language;
471 if (!dm.territory.empty ()) {
472 d << "_" << dm.territory;
473 if (!dm.rating.empty ()) {
474 d << "-" << dm.rating;
478 switch (audio_channels ()) {
499 d << "_" << resolution_to_string (_resolution);
501 if (!dm.studio.empty ()) {
502 d << "_" << dm.studio;
505 if (if_created_now) {
506 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
508 d << "_" << boost::gregorian::to_iso_string (_dci_date);
511 if (!dm.facility.empty ()) {
512 d << "_" << dm.facility;
515 if (!dm.package_type.empty ()) {
516 d << "_" << dm.package_type;
522 /** @return name to give the DCP */
524 Film::dcp_name (bool if_created_now) const
526 if (use_dci_name()) {
527 return dci_name (if_created_now);
535 Film::set_directory (string d)
537 boost::mutex::scoped_lock lm (_state_mutex);
543 Film::set_name (string n)
546 boost::mutex::scoped_lock lm (_state_mutex);
549 signal_changed (NAME);
553 Film::set_use_dci_name (bool u)
556 boost::mutex::scoped_lock lm (_state_mutex);
559 signal_changed (USE_DCI_NAME);
563 Film::set_dcp_content_type (DCPContentType const * t)
566 boost::mutex::scoped_lock lm (_state_mutex);
567 _dcp_content_type = t;
569 signal_changed (DCP_CONTENT_TYPE);
573 Film::set_container (Ratio const * c)
576 boost::mutex::scoped_lock lm (_state_mutex);
579 signal_changed (CONTAINER);
583 Film::set_resolution (Resolution r)
586 boost::mutex::scoped_lock lm (_state_mutex);
589 signal_changed (RESOLUTION);
593 Film::set_scaler (Scaler const * s)
596 boost::mutex::scoped_lock lm (_state_mutex);
599 signal_changed (SCALER);
603 Film::set_with_subtitles (bool w)
606 boost::mutex::scoped_lock lm (_state_mutex);
609 signal_changed (WITH_SUBTITLES);
613 Film::set_j2k_bandwidth (int b)
616 boost::mutex::scoped_lock lm (_state_mutex);
619 signal_changed (J2K_BANDWIDTH);
623 Film::set_dci_metadata (DCIMetadata m)
626 boost::mutex::scoped_lock lm (_state_mutex);
629 signal_changed (DCI_METADATA);
633 Film::set_video_frame_rate (int f)
636 boost::mutex::scoped_lock lm (_state_mutex);
637 _video_frame_rate = f;
639 signal_changed (VIDEO_FRAME_RATE);
643 Film::set_audio_channels (int c)
646 boost::mutex::scoped_lock lm (_state_mutex);
649 signal_changed (AUDIO_CHANNELS);
653 Film::set_three_d (bool t)
656 boost::mutex::scoped_lock lm (_state_mutex);
659 signal_changed (THREE_D);
663 Film::signal_changed (Property p)
666 boost::mutex::scoped_lock lm (_state_mutex);
672 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
674 case Film::VIDEO_FRAME_RATE:
675 case Film::SEQUENCE_VIDEO:
676 _playlist->maybe_sequence_video ();
683 ui_signaller->emit (boost::bind (boost::ref (Changed), p));
688 Film::set_dci_date_today ()
690 _dci_date = boost::gregorian::day_clock::local_day ();
694 Film::info_path (int f, Eyes e) const
696 boost::filesystem::path p;
701 s << setfill('0') << f;
703 if (e == EYES_LEFT) {
705 } else if (e == EYES_RIGHT) {
713 /* info_dir() will already have added any initial bit of the path,
714 so don't call file() on this.
720 Film::j2c_path (int f, Eyes e, bool t) const
722 boost::filesystem::path p;
724 p /= video_identifier ();
728 s << setfill('0') << f;
730 if (e == EYES_LEFT) {
732 } else if (e == EYES_RIGHT) {
743 return file (p.string ());
746 /** Make an educated guess as to whether we have a complete DCP
748 * @return true if we do.
752 Film::have_dcp () const
755 libdcp::DCP dcp (dir (dcp_name()));
765 Film::make_player () const
767 return shared_ptr<Player> (new Player (shared_from_this (), _playlist));
771 Film::playlist () const
773 boost::mutex::scoped_lock lm (_state_mutex);
778 Film::content () const
780 return _playlist->content ();
784 Film::examine_and_add_content (shared_ptr<Content> c)
786 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
787 j->Finished.connect (bind (&Film::maybe_add_content, this, boost::weak_ptr<Job> (j), boost::weak_ptr<Content> (c)));
788 JobManager::instance()->add (j);
792 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
794 shared_ptr<Job> job = j.lock ();
795 if (!job || !job->finished_ok ()) {
799 shared_ptr<Content> content = c.lock ();
801 add_content (content);
806 Film::add_content (shared_ptr<Content> c)
808 /* Add video content after any existing content */
809 if (dynamic_pointer_cast<VideoContent> (c)) {
810 c->set_start (_playlist->video_end ());
817 Film::remove_content (shared_ptr<Content> c)
819 _playlist->remove (c);
823 Film::length () const
825 return _playlist->length ();
829 Film::has_subtitles () const
831 return _playlist->has_subtitles ();
835 Film::best_video_frame_rate () const
837 return _playlist->best_dcp_frame_rate ();
841 Film::playlist_content_changed (boost::weak_ptr<Content> c, int p)
843 if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
844 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
848 ui_signaller->emit (boost::bind (boost::ref (ContentChanged), c, p));
853 Film::playlist_changed ()
855 signal_changed (CONTENT);
859 Film::time_to_audio_frames (Time t) const
861 return t * audio_frame_rate () / TIME_HZ;
865 Film::time_to_video_frames (Time t) const
867 return t * video_frame_rate () / TIME_HZ;
871 Film::audio_frames_to_time (OutputAudioFrame f) const
873 return f * TIME_HZ / audio_frame_rate ();
877 Film::video_frames_to_time (OutputVideoFrame f) const
879 return f * TIME_HZ / video_frame_rate ();
883 Film::audio_frame_rate () const
890 Film::set_sequence_video (bool s)
893 boost::mutex::scoped_lock lm (_state_mutex);
895 _playlist->set_sequence_video (s);
898 signal_changed (SEQUENCE_VIDEO);
902 Film::full_frame () const
904 switch (_resolution) {
906 return libdcp::Size (2048, 1080);
908 return libdcp::Size (4096, 2160);
912 return libdcp::Size ();