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>
38 #include "job_manager.h"
39 #include "transcode_job.h"
40 #include "scp_dcp_job.h"
42 #include "exceptions.h"
43 #include "examine_content_job.h"
47 #include "ui_signaller.h"
50 #include "ffmpeg_content.h"
51 #include "imagemagick_content.h"
52 #include "sndfile_content.h"
53 #include "dcp_content_type.h"
60 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;
83 int const Film::state_version = 4;
85 /** Construct a Film object in a given directory.
87 * @param d Film directory.
91 : _playlist (new Playlist)
92 , _use_dci_name (true)
93 , _dcp_content_type (Config::instance()->default_dcp_content_type ())
94 , _container (Config::instance()->default_container ())
95 , _scaler (Scaler::from_id ("bicubic"))
96 , _with_subtitles (false)
97 , _j2k_bandwidth (200000000)
98 , _dci_metadata (Config::instance()->default_dci_metadata ())
99 , _dcp_video_frame_rate (24)
100 , _dcp_audio_channels (MAX_AUDIO_CHANNELS)
103 set_dci_date_today ();
105 _playlist->Changed.connect (bind (&Film::playlist_changed, this));
106 _playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2));
108 /* Make state.directory a complete path without ..s (where possible)
109 (Code swiped from Adam Bowen on stackoverflow)
112 boost::filesystem::path p (boost::filesystem::system_complete (d));
113 boost::filesystem::path result;
114 for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
116 if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
119 result = result.parent_path ();
121 } else if (*i != ".") {
126 set_directory (result.string ());
127 _log.reset (new FileLog ("log"));
130 Film::Film (Film const & o)
131 : boost::enable_shared_from_this<Film> (o)
132 /* note: the copied film shares the original's log */
134 , _playlist (new Playlist (o._playlist))
135 , _directory (o._directory)
137 , _use_dci_name (o._use_dci_name)
138 , _dcp_content_type (o._dcp_content_type)
139 , _container (o._container)
140 , _scaler (o._scaler)
141 , _with_subtitles (o._with_subtitles)
142 , _j2k_bandwidth (o._j2k_bandwidth)
143 , _dci_metadata (o._dci_metadata)
144 , _dcp_video_frame_rate (o._dcp_video_frame_rate)
145 , _dci_date (o._dci_date)
148 _playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2));
152 Film::video_identifier () const
154 assert (container ());
158 s << container()->id()
159 << "_" << _playlist->video_identifier()
160 << "_" << _dcp_video_frame_rate
161 << "_" << scaler()->id()
162 << "_" << j2k_bandwidth();
167 /** @return The path to the directory to write video frame info files to */
169 Film::info_dir () const
171 boost::filesystem::path p;
173 p /= video_identifier ();
174 return dir (p.string());
178 Film::internal_video_mxf_dir () const
180 return dir ("video");
184 Film::internal_video_mxf_filename () const
186 return video_identifier() + ".mxf";
190 Film::dcp_video_mxf_filename () const
192 return filename_safe_name() + "_video.mxf";
196 Film::dcp_audio_mxf_filename () const
198 return filename_safe_name() + "_audio.mxf";
202 Film::filename_safe_name () const
204 string const n = name ();
206 for (size_t i = 0; i < n.length(); ++i) {
207 if (isalnum (n[i])) {
217 boost::filesystem::path
218 Film::audio_analysis_path (shared_ptr<const AudioContent> c) const
220 boost::filesystem::path p = dir ("analysis");
225 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
229 set_dci_date_today ();
231 if (dcp_name().find ("/") != string::npos) {
232 throw BadSettingError (_("name"), _("cannot contain slashes"));
235 log()->log (String::compose ("DCP-o-matic %1 git %2 using %3", dcpomatic_version, dcpomatic_git_commit, dependency_version_summary()));
239 gethostname (buffer, sizeof (buffer));
240 log()->log (String::compose ("Starting to make DCP on %1", buffer));
243 // log()->log (String::compose ("Content is %1; type %2", content_path(), (content_type() == STILL ? _("still") : _("video"))));
245 // log()->log (String::compose ("Content length %1", length().get()));
247 // log()->log (String::compose ("Content digest %1", content_digest()));
248 // log()->log (String::compose ("Content at %1 fps, DCP at %2 fps", source_frame_rate(), dcp_frame_rate()));
249 log()->log (String::compose ("%1 threads", Config::instance()->num_local_encoding_threads()));
250 log()->log (String::compose ("J2K bandwidth %1", j2k_bandwidth()));
251 #ifdef DCPOMATIC_DEBUG
252 log()->log ("DCP-o-matic built in debug mode.");
254 log()->log ("DCP-o-matic built in optimised mode.");
257 log()->log ("libdcp built in debug mode.");
259 log()->log ("libdcp built in optimised mode.");
261 pair<string, int> const c = cpu_info ();
262 log()->log (String::compose ("CPU: %1, %2 processors", c.first, c.second));
263 list<pair<string, string> > const m = mount_info ();
264 for (list<pair<string, string> >::const_iterator i = m.begin(); i != m.end(); ++i) {
265 log()->log (String::compose ("Mount: %1 %2", i->first, i->second));
268 if (container() == 0) {
269 throw MissingSettingError (_("container"));
272 if (_playlist->content().empty ()) {
273 throw StringError (_("You must add some content to the DCP before creating it"));
276 if (dcp_content_type() == 0) {
277 throw MissingSettingError (_("content type"));
280 if (name().empty()) {
281 throw MissingSettingError (_("name"));
284 JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
287 /** Start a job to send our DCP to the configured TMS */
289 Film::send_dcp_to_tms ()
291 shared_ptr<Job> j (new SCPDCPJob (shared_from_this()));
292 JobManager::instance()->add (j);
295 /** Count the number of frames that have been encoded for this film.
296 * @return frame count.
299 Film::encoded_frames () const
301 if (container() == 0) {
306 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (info_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
308 boost::this_thread::interruption_point ();
314 /** Write state to our `metadata' file */
316 Film::write_metadata () const
318 if (!boost::filesystem::exists (directory())) {
319 boost::filesystem::create_directory (directory());
322 boost::mutex::scoped_lock lm (_state_mutex);
325 boost::filesystem::create_directories (directory());
328 xmlpp::Element* root = doc.create_root_node ("Metadata");
330 root->add_child("Version")->add_child_text (lexical_cast<string> (state_version));
331 root->add_child("Name")->add_child_text (_name);
332 root->add_child("UseDCIName")->add_child_text (_use_dci_name ? "1" : "0");
334 if (_dcp_content_type) {
335 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->dci_name ());
339 root->add_child("Container")->add_child_text (_container->id ());
342 root->add_child("Scaler")->add_child_text (_scaler->id ());
343 root->add_child("WithSubtitles")->add_child_text (_with_subtitles ? "1" : "0");
344 root->add_child("J2KBandwidth")->add_child_text (lexical_cast<string> (_j2k_bandwidth));
345 _dci_metadata.as_xml (root->add_child ("DCIMetadata"));
346 root->add_child("DCPVideoFrameRate")->add_child_text (lexical_cast<string> (_dcp_video_frame_rate));
347 root->add_child("DCIDate")->add_child_text (boost::gregorian::to_iso_string (_dci_date));
348 root->add_child("DCPAudioChannels")->add_child_text (lexical_cast<string> (_dcp_audio_channels));
349 _playlist->as_xml (root->add_child ("Playlist"));
351 doc.write_to_file_formatted (file ("metadata.xml"));
356 /** Read state from our metadata file */
358 Film::read_metadata ()
360 boost::mutex::scoped_lock lm (_state_mutex);
363 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
364 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!"));
367 cxml::File f (file ("metadata.xml"), "Metadata");
369 _name = f.string_child ("Name");
370 _use_dci_name = f.bool_child ("UseDCIName");
373 optional<string> c = f.optional_string_child ("DCPContentType");
375 _dcp_content_type = DCPContentType::from_dci_name (c.get ());
380 optional<string> c = f.optional_string_child ("Container");
382 _container = Ratio::from_id (c.get ());
386 _scaler = Scaler::from_id (f.string_child ("Scaler"));
387 _with_subtitles = f.bool_child ("WithSubtitles");
388 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
389 _dci_metadata = DCIMetadata (f.node_child ("DCIMetadata"));
390 _dcp_video_frame_rate = f.number_child<int> ("DCPVideoFrameRate");
391 _dci_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
392 _dcp_audio_channels = f.number_child<int> ("DCPAudioChannels");
394 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"));
399 /** Given a directory name, return its full path within the Film's directory.
400 * The directory (and its parents) will be created if they do not exist.
403 Film::dir (string d) const
405 boost::mutex::scoped_lock lm (_directory_mutex);
407 boost::filesystem::path p;
411 boost::filesystem::create_directories (p);
416 /** Given a file or directory name, return its full path within the Film's directory.
417 * _directory_mutex must not be locked on entry.
418 * Any required parent directories will be created.
421 Film::file (string f) const
423 boost::mutex::scoped_lock lm (_directory_mutex);
425 boost::filesystem::path p;
429 boost::filesystem::create_directories (p.parent_path ());
434 /** @return a DCI-compliant name for a DCP of this film */
436 Film::dci_name (bool if_created_now) const
440 string fixed_name = to_upper_copy (name());
441 for (size_t i = 0; i < fixed_name.length(); ++i) {
442 if (fixed_name[i] == ' ') {
447 /* Spec is that the name part should be maximum 14 characters, as I understand it */
448 if (fixed_name.length() > 14) {
449 fixed_name = fixed_name.substr (0, 14);
454 if (dcp_content_type()) {
455 d << "_" << dcp_content_type()->dci_name();
459 d << "_" << container()->dci_name();
462 DCIMetadata const dm = dci_metadata ();
464 if (!dm.audio_language.empty ()) {
465 d << "_" << dm.audio_language;
466 if (!dm.subtitle_language.empty()) {
467 d << "-" << dm.subtitle_language;
473 if (!dm.territory.empty ()) {
474 d << "_" << dm.territory;
475 if (!dm.rating.empty ()) {
476 d << "-" << dm.rating;
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_scaler (Scaler const * s)
567 boost::mutex::scoped_lock lm (_state_mutex);
570 signal_changed (SCALER);
574 Film::set_with_subtitles (bool w)
577 boost::mutex::scoped_lock lm (_state_mutex);
580 signal_changed (WITH_SUBTITLES);
584 Film::set_j2k_bandwidth (int b)
587 boost::mutex::scoped_lock lm (_state_mutex);
590 signal_changed (J2K_BANDWIDTH);
594 Film::set_dci_metadata (DCIMetadata m)
597 boost::mutex::scoped_lock lm (_state_mutex);
600 signal_changed (DCI_METADATA);
604 Film::set_dcp_video_frame_rate (int f)
607 boost::mutex::scoped_lock lm (_state_mutex);
608 _dcp_video_frame_rate = f;
610 signal_changed (DCP_VIDEO_FRAME_RATE);
614 Film::set_dcp_audio_channels (int c)
617 boost::mutex::scoped_lock lm (_state_mutex);
618 _dcp_audio_channels = c;
620 signal_changed (DCP_AUDIO_CHANNELS);
624 Film::signal_changed (Property p)
627 boost::mutex::scoped_lock lm (_state_mutex);
633 set_dcp_video_frame_rate (_playlist->best_dcp_frame_rate ());
640 ui_signaller->emit (boost::bind (boost::ref (Changed), p));
645 Film::set_dci_date_today ()
647 _dci_date = boost::gregorian::day_clock::local_day ();
651 Film::info_path (int f) const
653 boost::filesystem::path p;
658 s << setfill('0') << f << ".md5";
662 /* info_dir() will already have added any initial bit of the path,
663 so don't call file() on this.
669 Film::j2c_path (int f, bool t) const
671 boost::filesystem::path p;
673 p /= video_identifier ();
677 s << setfill('0') << f << ".j2c";
684 return file (p.string ());
687 /** Make an educated guess as to whether we have a complete DCP
689 * @return true if we do.
693 Film::have_dcp () const
696 libdcp::DCP dcp (dir (dcp_name()));
706 Film::player () const
708 return shared_ptr<Player> (new Player (shared_from_this (), _playlist));
712 Film::playlist () const
714 boost::mutex::scoped_lock lm (_state_mutex);
718 Playlist::ContentList
719 Film::content () const
721 return _playlist->content ();
725 Film::examine_and_add_content (shared_ptr<Content> c)
727 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
728 j->Finished.connect (bind (&Film::add_content_weak, this, boost::weak_ptr<Content> (c)));
729 JobManager::instance()->add (j);
733 Film::add_content_weak (weak_ptr<Content> c)
735 shared_ptr<Content> content = c.lock ();
737 add_content (content);
742 Film::add_content (shared_ptr<Content> c)
744 /* Add video content after any existing content */
745 if (dynamic_pointer_cast<VideoContent> (c)) {
746 c->set_start (_playlist->video_end ());
753 Film::remove_content (shared_ptr<Content> c)
755 _playlist->remove (c);
759 Film::length () const
761 return _playlist->length ();
765 Film::has_subtitles () const
767 return _playlist->has_subtitles ();
771 Film::best_dcp_video_frame_rate () const
773 return _playlist->best_dcp_frame_rate ();
777 Film::playlist_content_changed (boost::weak_ptr<Content> c, int p)
779 if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
780 set_dcp_video_frame_rate (_playlist->best_dcp_frame_rate ());
784 ui_signaller->emit (boost::bind (boost::ref (ContentChanged), c, p));
789 Film::playlist_changed ()
791 signal_changed (CONTENT);
797 return _playlist->loop ();
801 Film::set_loop (int c)
803 _playlist->set_loop (c);
807 Film::time_to_audio_frames (Time t) const
809 return t * dcp_audio_frame_rate () / TIME_HZ;
813 Film::time_to_video_frames (Time t) const
815 return t * dcp_video_frame_rate () / TIME_HZ;
819 Film::audio_frames_to_time (OutputAudioFrame f) const
821 return f * TIME_HZ / dcp_audio_frame_rate ();
825 Film::video_frames_to_time (OutputVideoFrame f) const
827 return f * TIME_HZ / dcp_video_frame_rate ();
831 Film::dcp_audio_frame_rate () const
838 Film::set_sequence_video (bool s)
840 _playlist->set_sequence_video (s);
844 Film::full_frame () const
846 return libdcp::Size (2048, 1080);