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)
98 , _j2k_bandwidth (200000000)
99 , _dci_metadata (Config::instance()->default_dci_metadata ())
100 , _dcp_video_frame_rate (24)
101 , _dcp_audio_channels (MAX_AUDIO_CHANNELS)
104 set_dci_date_today ();
106 _playlist->Changed.connect (bind (&Film::playlist_changed, this));
107 _playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2));
109 /* Make state.directory a complete path without ..s (where possible)
110 (Code swiped from Adam Bowen on stackoverflow)
113 boost::filesystem::path p (boost::filesystem::system_complete (d));
114 boost::filesystem::path result;
115 for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
117 if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
120 result = result.parent_path ();
122 } else if (*i != ".") {
127 set_directory (result.string ());
128 _log.reset (new FileLog ("log"));
131 Film::Film (Film const & o)
132 : boost::enable_shared_from_this<Film> (o)
133 /* note: the copied film shares the original's log */
135 , _playlist (new Playlist (o._playlist))
136 , _directory (o._directory)
138 , _use_dci_name (o._use_dci_name)
139 , _dcp_content_type (o._dcp_content_type)
140 , _container (o._container)
141 , _scaler (o._scaler)
142 , _with_subtitles (o._with_subtitles)
143 , _colour_lut (o._colour_lut)
144 , _j2k_bandwidth (o._j2k_bandwidth)
145 , _dci_metadata (o._dci_metadata)
146 , _dcp_video_frame_rate (o._dcp_video_frame_rate)
147 , _dci_date (o._dci_date)
150 _playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2));
154 Film::video_state_identifier () const
156 assert (container ());
160 s << container()->id()
161 << "_" << _playlist->video_digest()
162 << "_" << _dcp_video_frame_rate
163 << "_" << scaler()->id()
164 << "_" << j2k_bandwidth()
165 << "_" << lexical_cast<int> (colour_lut());
170 /** @return The path to the directory to write video frame info files to */
172 Film::info_dir () const
174 boost::filesystem::path p;
176 p /= video_state_identifier ();
177 return dir (p.string());
181 Film::internal_video_mxf_dir () const
183 return dir ("video");
187 Film::internal_video_mxf_filename () const
189 return video_state_identifier() + ".mxf";
193 Film::dcp_video_mxf_filename () const
195 return filename_safe_name() + "_video.mxf";
199 Film::dcp_audio_mxf_filename () const
201 return filename_safe_name() + "_audio.mxf";
205 Film::filename_safe_name () const
207 string const n = name ();
209 for (size_t i = 0; i < n.length(); ++i) {
210 if (isalnum (n[i])) {
220 boost::filesystem::path
221 Film::audio_analysis_path (shared_ptr<const AudioContent> c) const
223 boost::filesystem::path p = dir ("analysis");
228 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
232 set_dci_date_today ();
234 if (dcp_name().find ("/") != string::npos) {
235 throw BadSettingError (_("name"), _("cannot contain slashes"));
238 log()->log (String::compose ("DCP-o-matic %1 git %2 using %3", dcpomatic_version, dcpomatic_git_commit, dependency_version_summary()));
242 gethostname (buffer, sizeof (buffer));
243 log()->log (String::compose ("Starting to make DCP on %1", buffer));
246 // log()->log (String::compose ("Content is %1; type %2", content_path(), (content_type() == STILL ? _("still") : _("video"))));
248 // log()->log (String::compose ("Content length %1", length().get()));
250 // log()->log (String::compose ("Content digest %1", content_digest()));
251 // log()->log (String::compose ("Content at %1 fps, DCP at %2 fps", source_frame_rate(), dcp_frame_rate()));
252 log()->log (String::compose ("%1 threads", Config::instance()->num_local_encoding_threads()));
253 log()->log (String::compose ("J2K bandwidth %1", j2k_bandwidth()));
254 #ifdef DCPOMATIC_DEBUG
255 log()->log ("DCP-o-matic built in debug mode.");
257 log()->log ("DCP-o-matic built in optimised mode.");
260 log()->log ("libdcp built in debug mode.");
262 log()->log ("libdcp built in optimised mode.");
264 pair<string, int> const c = cpu_info ();
265 log()->log (String::compose ("CPU: %1, %2 processors", c.first, c.second));
266 list<pair<string, string> > const m = mount_info ();
267 for (list<pair<string, string> >::const_iterator i = m.begin(); i != m.end(); ++i) {
268 log()->log (String::compose ("Mount: %1 %2", i->first, i->second));
271 if (container() == 0) {
272 throw MissingSettingError (_("container"));
275 if (_playlist->content().empty ()) {
276 throw StringError (_("You must add some content to the DCP before creating it"));
279 if (dcp_content_type() == 0) {
280 throw MissingSettingError (_("content type"));
283 if (name().empty()) {
284 throw MissingSettingError (_("name"));
287 JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
290 /** Start a job to send our DCP to the configured TMS */
292 Film::send_dcp_to_tms ()
294 shared_ptr<Job> j (new SCPDCPJob (shared_from_this()));
295 JobManager::instance()->add (j);
298 /** Count the number of frames that have been encoded for this film.
299 * @return frame count.
302 Film::encoded_frames () const
304 if (container() == 0) {
309 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (info_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
311 boost::this_thread::interruption_point ();
317 /** Write state to our `metadata' file */
319 Film::write_metadata () const
321 if (!boost::filesystem::exists (directory())) {
322 boost::filesystem::create_directory (directory());
325 boost::mutex::scoped_lock lm (_state_mutex);
328 boost::filesystem::create_directories (directory());
331 xmlpp::Element* root = doc.create_root_node ("Metadata");
333 root->add_child("Version")->add_child_text (lexical_cast<string> (state_version));
334 root->add_child("Name")->add_child_text (_name);
335 root->add_child("UseDCIName")->add_child_text (_use_dci_name ? "1" : "0");
337 if (_dcp_content_type) {
338 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->dci_name ());
342 root->add_child("Container")->add_child_text (_container->id ());
345 root->add_child("Scaler")->add_child_text (_scaler->id ());
346 root->add_child("WithSubtitles")->add_child_text (_with_subtitles ? "1" : "0");
347 root->add_child("ColourLUT")->add_child_text (lexical_cast<string> (_colour_lut));
348 root->add_child("J2KBandwidth")->add_child_text (lexical_cast<string> (_j2k_bandwidth));
349 _dci_metadata.as_xml (root->add_child ("DCIMetadata"));
350 root->add_child("DCPVideoFrameRate")->add_child_text (lexical_cast<string> (_dcp_video_frame_rate));
351 root->add_child("DCIDate")->add_child_text (boost::gregorian::to_iso_string (_dci_date));
352 root->add_child("DCPAudioChannels")->add_child_text (lexical_cast<string> (_dcp_audio_channels));
353 _playlist->as_xml (root->add_child ("Playlist"));
355 doc.write_to_file_formatted (file ("metadata.xml"));
360 /** Read state from our metadata file */
362 Film::read_metadata ()
364 boost::mutex::scoped_lock lm (_state_mutex);
367 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
368 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!"));
371 cxml::File f (file ("metadata.xml"), "Metadata");
373 _name = f.string_child ("Name");
374 _use_dci_name = f.bool_child ("UseDCIName");
377 optional<string> c = f.optional_string_child ("DCPContentType");
379 _dcp_content_type = DCPContentType::from_dci_name (c.get ());
384 optional<string> c = f.optional_string_child ("Container");
386 _container = Ratio::from_id (c.get ());
390 _scaler = Scaler::from_id (f.string_child ("Scaler"));
391 _with_subtitles = f.bool_child ("WithSubtitles");
392 _colour_lut = f.number_child<int> ("ColourLUT");
393 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
394 _dci_metadata = DCIMetadata (f.node_child ("DCIMetadata"));
395 _dcp_video_frame_rate = f.number_child<int> ("DCPVideoFrameRate");
396 _dci_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
397 _dcp_audio_channels = f.number_child<int> ("DCPAudioChannels");
399 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"));
404 /** Given a directory name, return its full path within the Film's directory.
405 * The directory (and its parents) will be created if they do not exist.
408 Film::dir (string d) const
410 boost::mutex::scoped_lock lm (_directory_mutex);
412 boost::filesystem::path p;
416 boost::filesystem::create_directories (p);
421 /** Given a file or directory name, return its full path within the Film's directory.
422 * _directory_mutex must not be locked on entry.
423 * Any required parent directories will be created.
426 Film::file (string f) const
428 boost::mutex::scoped_lock lm (_directory_mutex);
430 boost::filesystem::path p;
434 boost::filesystem::create_directories (p.parent_path ());
439 /** @return a DCI-compliant name for a DCP of this film */
441 Film::dci_name (bool if_created_now) const
445 string fixed_name = to_upper_copy (name());
446 for (size_t i = 0; i < fixed_name.length(); ++i) {
447 if (fixed_name[i] == ' ') {
452 /* Spec is that the name part should be maximum 14 characters, as I understand it */
453 if (fixed_name.length() > 14) {
454 fixed_name = fixed_name.substr (0, 14);
459 if (dcp_content_type()) {
460 d << "_" << dcp_content_type()->dci_name();
464 d << "_" << container()->dci_name();
467 DCIMetadata const dm = dci_metadata ();
469 if (!dm.audio_language.empty ()) {
470 d << "_" << dm.audio_language;
471 if (!dm.subtitle_language.empty()) {
472 d << "-" << dm.subtitle_language;
478 if (!dm.territory.empty ()) {
479 d << "_" << dm.territory;
480 if (!dm.rating.empty ()) {
481 d << "-" << dm.rating;
487 if (!dm.studio.empty ()) {
488 d << "_" << dm.studio;
491 if (if_created_now) {
492 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
494 d << "_" << boost::gregorian::to_iso_string (_dci_date);
497 if (!dm.facility.empty ()) {
498 d << "_" << dm.facility;
501 if (!dm.package_type.empty ()) {
502 d << "_" << dm.package_type;
508 /** @return name to give the DCP */
510 Film::dcp_name (bool if_created_now) const
512 if (use_dci_name()) {
513 return dci_name (if_created_now);
521 Film::set_directory (string d)
523 boost::mutex::scoped_lock lm (_state_mutex);
529 Film::set_name (string n)
532 boost::mutex::scoped_lock lm (_state_mutex);
535 signal_changed (NAME);
539 Film::set_use_dci_name (bool u)
542 boost::mutex::scoped_lock lm (_state_mutex);
545 signal_changed (USE_DCI_NAME);
549 Film::set_dcp_content_type (DCPContentType const * t)
552 boost::mutex::scoped_lock lm (_state_mutex);
553 _dcp_content_type = t;
555 signal_changed (DCP_CONTENT_TYPE);
559 Film::set_container (Ratio const * c)
562 boost::mutex::scoped_lock lm (_state_mutex);
565 signal_changed (CONTAINER);
569 Film::set_scaler (Scaler const * s)
572 boost::mutex::scoped_lock lm (_state_mutex);
575 signal_changed (SCALER);
579 Film::set_with_subtitles (bool w)
582 boost::mutex::scoped_lock lm (_state_mutex);
585 signal_changed (WITH_SUBTITLES);
589 Film::set_colour_lut (int i)
592 boost::mutex::scoped_lock lm (_state_mutex);
595 signal_changed (COLOUR_LUT);
599 Film::set_j2k_bandwidth (int b)
602 boost::mutex::scoped_lock lm (_state_mutex);
605 signal_changed (J2K_BANDWIDTH);
609 Film::set_dci_metadata (DCIMetadata m)
612 boost::mutex::scoped_lock lm (_state_mutex);
615 signal_changed (DCI_METADATA);
619 Film::set_dcp_video_frame_rate (int f)
622 boost::mutex::scoped_lock lm (_state_mutex);
623 _dcp_video_frame_rate = f;
625 signal_changed (DCP_VIDEO_FRAME_RATE);
629 Film::signal_changed (Property p)
632 boost::mutex::scoped_lock lm (_state_mutex);
638 set_dcp_video_frame_rate (_playlist->best_dcp_frame_rate ());
645 ui_signaller->emit (boost::bind (boost::ref (Changed), p));
650 Film::set_dci_date_today ()
652 _dci_date = boost::gregorian::day_clock::local_day ();
656 Film::info_path (int f) const
658 boost::filesystem::path p;
663 s << setfill('0') << f << ".md5";
667 /* info_dir() will already have added any initial bit of the path,
668 so don't call file() on this.
674 Film::j2c_path (int f, bool t) const
676 boost::filesystem::path p;
678 p /= video_state_identifier ();
682 s << setfill('0') << f << ".j2c";
689 return file (p.string ());
692 /** Make an educated guess as to whether we have a complete DCP
694 * @return true if we do.
698 Film::have_dcp () const
701 libdcp::DCP dcp (dir (dcp_name()));
711 Film::player () const
713 return shared_ptr<Player> (new Player (shared_from_this (), _playlist));
717 Film::playlist () const
719 boost::mutex::scoped_lock lm (_state_mutex);
723 Playlist::ContentList
724 Film::content () const
726 return _playlist->content ();
730 Film::examine_and_add_content (shared_ptr<Content> c)
732 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
733 j->Finished.connect (bind (&Film::add_content_weak, this, boost::weak_ptr<Content> (c)));
734 JobManager::instance()->add (j);
738 Film::add_content_weak (weak_ptr<Content> c)
740 shared_ptr<Content> content = c.lock ();
742 add_content (content);
747 Film::add_content (shared_ptr<Content> c)
749 /* Add video content after any existing content */
750 if (dynamic_pointer_cast<VideoContent> (c)) {
751 c->set_start (_playlist->video_end ());
758 Film::remove_content (shared_ptr<Content> c)
760 _playlist->remove (c);
764 Film::length () const
766 return _playlist->length ();
770 Film::has_subtitles () const
772 return _playlist->has_subtitles ();
776 Film::best_dcp_video_frame_rate () const
778 return _playlist->best_dcp_frame_rate ();
782 Film::playlist_content_changed (boost::weak_ptr<Content> c, int p)
784 if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
785 set_dcp_video_frame_rate (_playlist->best_dcp_frame_rate ());
789 ui_signaller->emit (boost::bind (boost::ref (ContentChanged), c, p));
794 Film::playlist_changed ()
796 signal_changed (CONTENT);
802 return _playlist->loop ();
806 Film::set_loop (int c)
808 _playlist->set_loop (c);
812 Film::time_to_audio_frames (Time t) const
814 return t * dcp_audio_frame_rate () / TIME_HZ;
818 Film::time_to_video_frames (Time t) const
820 return t * dcp_video_frame_rate () / TIME_HZ;
824 Film::audio_frames_to_time (OutputAudioFrame f) const
826 return f * TIME_HZ / dcp_audio_frame_rate ();
830 Film::video_frames_to_time (OutputVideoFrame f) const
832 return f * TIME_HZ / dcp_video_frame_rate ();
836 Film::dcp_audio_frame_rate () const
843 Film::set_sequence_video (bool s)
845 _playlist->set_sequence_video (s);
849 Film::full_frame () const
851 return libdcp::Size (2048, 1080);