2 Copyright (C) 2012 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 , _dcp_video_frame_rate (24)
97 , _dcp_audio_channels (MAX_AUDIO_CHANNELS)
100 set_dci_date_today ();
102 _playlist->Changed.connect (bind (&Film::playlist_changed, this));
103 _playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2));
105 /* Make state.directory a complete path without ..s (where possible)
106 (Code swiped from Adam Bowen on stackoverflow)
109 boost::filesystem::path p (boost::filesystem::system_complete (d));
110 boost::filesystem::path result;
111 for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
113 if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
116 result = result.parent_path ();
118 } else if (*i != ".") {
123 set_directory (result.string ());
124 _log.reset (new FileLog ("log"));
128 Film::video_identifier () const
130 assert (container ());
134 s << container()->id()
135 << "_" << resolution_to_string (_resolution)
136 << "_" << _playlist->video_identifier()
137 << "_" << _dcp_video_frame_rate
138 << "_" << scaler()->id()
139 << "_" << j2k_bandwidth();
144 /** @return The path to the directory to write video frame info files to */
146 Film::info_dir () const
148 boost::filesystem::path p;
150 p /= video_identifier ();
151 return dir (p.string());
155 Film::internal_video_mxf_dir () const
157 return dir ("video");
161 Film::internal_video_mxf_filename () const
163 return video_identifier() + ".mxf";
167 Film::dcp_video_mxf_filename () const
169 return filename_safe_name() + "_video.mxf";
173 Film::dcp_audio_mxf_filename () const
175 return filename_safe_name() + "_audio.mxf";
179 Film::filename_safe_name () const
181 string const n = name ();
183 for (size_t i = 0; i < n.length(); ++i) {
184 if (isalnum (n[i])) {
194 boost::filesystem::path
195 Film::audio_analysis_path (shared_ptr<const AudioContent> c) const
197 boost::filesystem::path p = dir ("analysis");
202 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
206 set_dci_date_today ();
208 if (dcp_name().find ("/") != string::npos) {
209 throw BadSettingError (_("name"), _("cannot contain slashes"));
212 log()->log (String::compose ("DCP-o-matic %1 git %2 using %3", dcpomatic_version, dcpomatic_git_commit, dependency_version_summary()));
216 gethostname (buffer, sizeof (buffer));
217 log()->log (String::compose ("Starting to make DCP on %1", buffer));
220 // log()->log (String::compose ("Content is %1; type %2", content_path(), (content_type() == STILL ? _("still") : _("video"))));
222 // log()->log (String::compose ("Content length %1", length().get()));
224 // log()->log (String::compose ("Content digest %1", content_digest()));
225 // log()->log (String::compose ("Content at %1 fps, DCP at %2 fps", source_frame_rate(), dcp_frame_rate()));
226 log()->log (String::compose ("%1 threads", Config::instance()->num_local_encoding_threads()));
227 log()->log (String::compose ("J2K bandwidth %1", j2k_bandwidth()));
228 #ifdef DCPOMATIC_DEBUG
229 log()->log ("DCP-o-matic built in debug mode.");
231 log()->log ("DCP-o-matic built in optimised mode.");
234 log()->log ("libdcp built in debug mode.");
236 log()->log ("libdcp built in optimised mode.");
238 pair<string, int> const c = cpu_info ();
239 log()->log (String::compose ("CPU: %1, %2 processors", c.first, c.second));
240 list<pair<string, string> > const m = mount_info ();
241 for (list<pair<string, string> >::const_iterator i = m.begin(); i != m.end(); ++i) {
242 log()->log (String::compose ("Mount: %1 %2", i->first, i->second));
245 if (container() == 0) {
246 throw MissingSettingError (_("container"));
249 if (_playlist->content().empty ()) {
250 throw StringError (_("You must add some content to the DCP before creating it"));
253 if (dcp_content_type() == 0) {
254 throw MissingSettingError (_("content type"));
257 if (name().empty()) {
258 throw MissingSettingError (_("name"));
261 JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
264 /** Start a job to send our DCP to the configured TMS */
266 Film::send_dcp_to_tms ()
268 shared_ptr<Job> j (new SCPDCPJob (shared_from_this()));
269 JobManager::instance()->add (j);
272 /** Count the number of frames that have been encoded for this film.
273 * @return frame count.
276 Film::encoded_frames () const
278 if (container() == 0) {
283 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (info_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
285 boost::this_thread::interruption_point ();
291 /** Write state to our `metadata' file */
293 Film::write_metadata () const
295 if (!boost::filesystem::exists (directory())) {
296 boost::filesystem::create_directory (directory());
299 boost::mutex::scoped_lock lm (_state_mutex);
302 boost::filesystem::create_directories (directory());
305 xmlpp::Element* root = doc.create_root_node ("Metadata");
307 root->add_child("Version")->add_child_text (lexical_cast<string> (state_version));
308 root->add_child("Name")->add_child_text (_name);
309 root->add_child("UseDCIName")->add_child_text (_use_dci_name ? "1" : "0");
311 if (_dcp_content_type) {
312 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->dci_name ());
316 root->add_child("Container")->add_child_text (_container->id ());
319 root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
320 root->add_child("Scaler")->add_child_text (_scaler->id ());
321 root->add_child("WithSubtitles")->add_child_text (_with_subtitles ? "1" : "0");
322 root->add_child("J2KBandwidth")->add_child_text (lexical_cast<string> (_j2k_bandwidth));
323 _dci_metadata.as_xml (root->add_child ("DCIMetadata"));
324 root->add_child("DCPVideoFrameRate")->add_child_text (lexical_cast<string> (_dcp_video_frame_rate));
325 root->add_child("DCIDate")->add_child_text (boost::gregorian::to_iso_string (_dci_date));
326 root->add_child("DCPAudioChannels")->add_child_text (lexical_cast<string> (_dcp_audio_channels));
327 _playlist->as_xml (root->add_child ("Playlist"));
329 doc.write_to_file_formatted (file ("metadata.xml"));
334 /** Read state from our metadata file */
336 Film::read_metadata ()
338 boost::mutex::scoped_lock lm (_state_mutex);
341 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
342 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!"));
345 cxml::File f (file ("metadata.xml"), "Metadata");
347 _name = f.string_child ("Name");
348 _use_dci_name = f.bool_child ("UseDCIName");
351 optional<string> c = f.optional_string_child ("DCPContentType");
353 _dcp_content_type = DCPContentType::from_dci_name (c.get ());
358 optional<string> c = f.optional_string_child ("Container");
360 _container = Ratio::from_id (c.get ());
364 _resolution = string_to_resolution (f.string_child ("Resolution"));
365 _scaler = Scaler::from_id (f.string_child ("Scaler"));
366 _with_subtitles = f.bool_child ("WithSubtitles");
367 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
368 _dci_metadata = DCIMetadata (f.node_child ("DCIMetadata"));
369 _dcp_video_frame_rate = f.number_child<int> ("DCPVideoFrameRate");
370 _dci_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
371 _dcp_audio_channels = f.number_child<int> ("DCPAudioChannels");
373 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"));
378 /** Given a directory name, return its full path within the Film's directory.
379 * The directory (and its parents) will be created if they do not exist.
382 Film::dir (string d) const
384 boost::mutex::scoped_lock lm (_directory_mutex);
386 boost::filesystem::path p;
390 boost::filesystem::create_directories (p);
395 /** Given a file or directory name, return its full path within the Film's directory.
396 * _directory_mutex must not be locked on entry.
397 * Any required parent directories will be created.
400 Film::file (string f) const
402 boost::mutex::scoped_lock lm (_directory_mutex);
404 boost::filesystem::path p;
408 boost::filesystem::create_directories (p.parent_path ());
413 /** @return a DCI-compliant name for a DCP of this film */
415 Film::dci_name (bool if_created_now) const
419 string fixed_name = to_upper_copy (name());
420 for (size_t i = 0; i < fixed_name.length(); ++i) {
421 if (fixed_name[i] == ' ') {
426 /* Spec is that the name part should be maximum 14 characters, as I understand it */
427 if (fixed_name.length() > 14) {
428 fixed_name = fixed_name.substr (0, 14);
433 if (dcp_content_type()) {
434 d << "_" << dcp_content_type()->dci_name();
438 d << "_" << container()->dci_name();
441 DCIMetadata const dm = dci_metadata ();
443 if (!dm.audio_language.empty ()) {
444 d << "_" << dm.audio_language;
445 if (!dm.subtitle_language.empty() && with_subtitles()) {
446 d << "-" << dm.subtitle_language;
452 if (!dm.territory.empty ()) {
453 d << "_" << dm.territory;
454 if (!dm.rating.empty ()) {
455 d << "-" << dm.rating;
459 switch (dcp_audio_channels ()) {
480 d << "_" << resolution_to_string (_resolution);
482 if (!dm.studio.empty ()) {
483 d << "_" << dm.studio;
486 if (if_created_now) {
487 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
489 d << "_" << boost::gregorian::to_iso_string (_dci_date);
492 if (!dm.facility.empty ()) {
493 d << "_" << dm.facility;
496 if (!dm.package_type.empty ()) {
497 d << "_" << dm.package_type;
503 /** @return name to give the DCP */
505 Film::dcp_name (bool if_created_now) const
507 if (use_dci_name()) {
508 return dci_name (if_created_now);
516 Film::set_directory (string d)
518 boost::mutex::scoped_lock lm (_state_mutex);
524 Film::set_name (string n)
527 boost::mutex::scoped_lock lm (_state_mutex);
530 signal_changed (NAME);
534 Film::set_use_dci_name (bool u)
537 boost::mutex::scoped_lock lm (_state_mutex);
540 signal_changed (USE_DCI_NAME);
544 Film::set_dcp_content_type (DCPContentType const * t)
547 boost::mutex::scoped_lock lm (_state_mutex);
548 _dcp_content_type = t;
550 signal_changed (DCP_CONTENT_TYPE);
554 Film::set_container (Ratio const * c)
557 boost::mutex::scoped_lock lm (_state_mutex);
560 signal_changed (CONTAINER);
564 Film::set_resolution (Resolution r)
567 boost::mutex::scoped_lock lm (_state_mutex);
570 signal_changed (RESOLUTION);
574 Film::set_scaler (Scaler const * s)
577 boost::mutex::scoped_lock lm (_state_mutex);
580 signal_changed (SCALER);
584 Film::set_with_subtitles (bool w)
587 boost::mutex::scoped_lock lm (_state_mutex);
590 signal_changed (WITH_SUBTITLES);
594 Film::set_j2k_bandwidth (int b)
597 boost::mutex::scoped_lock lm (_state_mutex);
600 signal_changed (J2K_BANDWIDTH);
604 Film::set_dci_metadata (DCIMetadata m)
607 boost::mutex::scoped_lock lm (_state_mutex);
610 signal_changed (DCI_METADATA);
614 Film::set_dcp_video_frame_rate (int f)
617 boost::mutex::scoped_lock lm (_state_mutex);
618 _dcp_video_frame_rate = f;
620 signal_changed (DCP_VIDEO_FRAME_RATE);
624 Film::set_dcp_audio_channels (int c)
627 boost::mutex::scoped_lock lm (_state_mutex);
628 _dcp_audio_channels = c;
630 signal_changed (DCP_AUDIO_CHANNELS);
634 Film::signal_changed (Property p)
637 boost::mutex::scoped_lock lm (_state_mutex);
643 set_dcp_video_frame_rate (_playlist->best_dcp_frame_rate ());
645 case Film::DCP_VIDEO_FRAME_RATE:
646 _playlist->maybe_sequence_video ();
653 ui_signaller->emit (boost::bind (boost::ref (Changed), p));
658 Film::set_dci_date_today ()
660 _dci_date = boost::gregorian::day_clock::local_day ();
664 Film::info_path (int f) const
666 boost::filesystem::path p;
671 s << setfill('0') << f << ".md5";
675 /* info_dir() will already have added any initial bit of the path,
676 so don't call file() on this.
682 Film::j2c_path (int f, bool t) const
684 boost::filesystem::path p;
686 p /= video_identifier ();
690 s << setfill('0') << f << ".j2c";
697 return file (p.string ());
700 /** Make an educated guess as to whether we have a complete DCP
702 * @return true if we do.
706 Film::have_dcp () const
709 libdcp::DCP dcp (dir (dcp_name()));
719 Film::make_player () const
721 return shared_ptr<Player> (new Player (shared_from_this (), _playlist));
725 Film::playlist () const
727 boost::mutex::scoped_lock lm (_state_mutex);
731 Playlist::ContentList
732 Film::content () const
734 return _playlist->content ();
738 Film::examine_and_add_content (shared_ptr<Content> c)
740 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
741 j->Finished.connect (bind (&Film::add_content_weak, this, boost::weak_ptr<Content> (c)));
742 JobManager::instance()->add (j);
746 Film::add_content_weak (weak_ptr<Content> c)
748 shared_ptr<Content> content = c.lock ();
750 add_content (content);
755 Film::add_content (shared_ptr<Content> c)
757 /* Add video content after any existing content */
758 if (dynamic_pointer_cast<VideoContent> (c)) {
759 c->set_start (_playlist->video_end ());
766 Film::remove_content (shared_ptr<Content> c)
768 _playlist->remove (c);
772 Film::length () const
774 return _playlist->length ();
778 Film::has_subtitles () const
780 return _playlist->has_subtitles ();
784 Film::best_dcp_video_frame_rate () const
786 return _playlist->best_dcp_frame_rate ();
790 Film::playlist_content_changed (boost::weak_ptr<Content> c, int p)
792 if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
793 set_dcp_video_frame_rate (_playlist->best_dcp_frame_rate ());
797 ui_signaller->emit (boost::bind (boost::ref (ContentChanged), c, p));
802 Film::playlist_changed ()
804 signal_changed (CONTENT);
810 return _playlist->loop ();
814 Film::set_loop (int c)
816 _playlist->set_loop (c);
820 Film::time_to_audio_frames (Time t) const
822 return t * dcp_audio_frame_rate () / TIME_HZ;
826 Film::time_to_video_frames (Time t) const
828 return t * dcp_video_frame_rate () / TIME_HZ;
832 Film::audio_frames_to_time (OutputAudioFrame f) const
834 return f * TIME_HZ / dcp_audio_frame_rate ();
838 Film::video_frames_to_time (OutputVideoFrame f) const
840 return f * TIME_HZ / dcp_video_frame_rate ();
844 Film::dcp_audio_frame_rate () const
851 Film::set_sequence_video (bool s)
853 _playlist->set_sequence_video (s);
857 Film::full_frame () const
859 switch (_resolution) {
861 return libdcp::Size (2048, 1080);
863 return libdcp::Size (4096, 2160);
867 return libdcp::Size ();