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 (Config::instance()->default_j2k_bandwidth ())
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"));
131 Film::video_identifier () const
133 assert (container ());
137 s << container()->id()
138 << "_" << _playlist->video_identifier()
139 << "_" << _dcp_video_frame_rate
140 << "_" << scaler()->id()
141 << "_" << j2k_bandwidth();
146 /** @return The path to the directory to write video frame info files to */
148 Film::info_dir () const
150 boost::filesystem::path p;
152 p /= video_identifier ();
153 return dir (p.string());
157 Film::internal_video_mxf_dir () const
159 return dir ("video");
163 Film::internal_video_mxf_filename () const
165 return video_identifier() + ".mxf";
169 Film::dcp_video_mxf_filename () const
171 return filename_safe_name() + "_video.mxf";
175 Film::dcp_audio_mxf_filename () const
177 return filename_safe_name() + "_audio.mxf";
181 Film::filename_safe_name () const
183 string const n = name ();
185 for (size_t i = 0; i < n.length(); ++i) {
186 if (isalnum (n[i])) {
196 boost::filesystem::path
197 Film::audio_analysis_path (shared_ptr<const AudioContent> c) const
199 boost::filesystem::path p = dir ("analysis");
204 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
208 set_dci_date_today ();
210 if (dcp_name().find ("/") != string::npos) {
211 throw BadSettingError (_("name"), _("cannot contain slashes"));
214 log()->log (String::compose ("DCP-o-matic %1 git %2 using %3", dcpomatic_version, dcpomatic_git_commit, dependency_version_summary()));
218 gethostname (buffer, sizeof (buffer));
219 log()->log (String::compose ("Starting to make DCP on %1", buffer));
222 // log()->log (String::compose ("Content is %1; type %2", content_path(), (content_type() == STILL ? _("still") : _("video"))));
224 // log()->log (String::compose ("Content length %1", length().get()));
226 // log()->log (String::compose ("Content digest %1", content_digest()));
227 // log()->log (String::compose ("Content at %1 fps, DCP at %2 fps", source_frame_rate(), dcp_frame_rate()));
228 log()->log (String::compose ("%1 threads", Config::instance()->num_local_encoding_threads()));
229 log()->log (String::compose ("J2K bandwidth %1", j2k_bandwidth()));
230 #ifdef DCPOMATIC_DEBUG
231 log()->log ("DCP-o-matic built in debug mode.");
233 log()->log ("DCP-o-matic built in optimised mode.");
236 log()->log ("libdcp built in debug mode.");
238 log()->log ("libdcp built in optimised mode.");
240 pair<string, int> const c = cpu_info ();
241 log()->log (String::compose ("CPU: %1, %2 processors", c.first, c.second));
242 list<pair<string, string> > const m = mount_info ();
243 for (list<pair<string, string> >::const_iterator i = m.begin(); i != m.end(); ++i) {
244 log()->log (String::compose ("Mount: %1 %2", i->first, i->second));
247 if (container() == 0) {
248 throw MissingSettingError (_("container"));
251 if (_playlist->content().empty ()) {
252 throw StringError (_("You must add some content to the DCP before creating it"));
255 if (dcp_content_type() == 0) {
256 throw MissingSettingError (_("content type"));
259 if (name().empty()) {
260 throw MissingSettingError (_("name"));
263 JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
266 /** Start a job to send our DCP to the configured TMS */
268 Film::send_dcp_to_tms ()
270 shared_ptr<Job> j (new SCPDCPJob (shared_from_this()));
271 JobManager::instance()->add (j);
274 /** Count the number of frames that have been encoded for this film.
275 * @return frame count.
278 Film::encoded_frames () const
280 if (container() == 0) {
285 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (info_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
287 boost::this_thread::interruption_point ();
293 /** Write state to our `metadata' file */
295 Film::write_metadata () const
297 if (!boost::filesystem::exists (directory())) {
298 boost::filesystem::create_directory (directory());
301 boost::mutex::scoped_lock lm (_state_mutex);
304 boost::filesystem::create_directories (directory());
307 xmlpp::Element* root = doc.create_root_node ("Metadata");
309 root->add_child("Version")->add_child_text (lexical_cast<string> (state_version));
310 root->add_child("Name")->add_child_text (_name);
311 root->add_child("UseDCIName")->add_child_text (_use_dci_name ? "1" : "0");
313 if (_dcp_content_type) {
314 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->dci_name ());
318 root->add_child("Container")->add_child_text (_container->id ());
321 root->add_child("Scaler")->add_child_text (_scaler->id ());
322 root->add_child("WithSubtitles")->add_child_text (_with_subtitles ? "1" : "0");
323 root->add_child("J2KBandwidth")->add_child_text (lexical_cast<string> (_j2k_bandwidth));
324 _dci_metadata.as_xml (root->add_child ("DCIMetadata"));
325 root->add_child("DCPVideoFrameRate")->add_child_text (lexical_cast<string> (_dcp_video_frame_rate));
326 root->add_child("DCIDate")->add_child_text (boost::gregorian::to_iso_string (_dci_date));
327 root->add_child("DCPAudioChannels")->add_child_text (lexical_cast<string> (_dcp_audio_channels));
328 _playlist->as_xml (root->add_child ("Playlist"));
330 doc.write_to_file_formatted (file ("metadata.xml"));
335 /** Read state from our metadata file */
337 Film::read_metadata ()
339 boost::mutex::scoped_lock lm (_state_mutex);
342 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
343 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!"));
346 cxml::File f (file ("metadata.xml"), "Metadata");
348 _name = f.string_child ("Name");
349 _use_dci_name = f.bool_child ("UseDCIName");
352 optional<string> c = f.optional_string_child ("DCPContentType");
354 _dcp_content_type = DCPContentType::from_dci_name (c.get ());
359 optional<string> c = f.optional_string_child ("Container");
361 _container = Ratio::from_id (c.get ());
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()) {
446 d << "-" << dm.subtitle_language;
452 if (!dm.territory.empty ()) {
453 d << "_" << dm.territory;
454 if (!dm.rating.empty ()) {
455 d << "-" << dm.rating;
461 if (!dm.studio.empty ()) {
462 d << "_" << dm.studio;
465 if (if_created_now) {
466 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
468 d << "_" << boost::gregorian::to_iso_string (_dci_date);
471 if (!dm.facility.empty ()) {
472 d << "_" << dm.facility;
475 if (!dm.package_type.empty ()) {
476 d << "_" << dm.package_type;
482 /** @return name to give the DCP */
484 Film::dcp_name (bool if_created_now) const
486 if (use_dci_name()) {
487 return dci_name (if_created_now);
495 Film::set_directory (string d)
497 boost::mutex::scoped_lock lm (_state_mutex);
503 Film::set_name (string n)
506 boost::mutex::scoped_lock lm (_state_mutex);
509 signal_changed (NAME);
513 Film::set_use_dci_name (bool u)
516 boost::mutex::scoped_lock lm (_state_mutex);
519 signal_changed (USE_DCI_NAME);
523 Film::set_dcp_content_type (DCPContentType const * t)
526 boost::mutex::scoped_lock lm (_state_mutex);
527 _dcp_content_type = t;
529 signal_changed (DCP_CONTENT_TYPE);
533 Film::set_container (Ratio const * c)
536 boost::mutex::scoped_lock lm (_state_mutex);
539 signal_changed (CONTAINER);
543 Film::set_scaler (Scaler const * s)
546 boost::mutex::scoped_lock lm (_state_mutex);
549 signal_changed (SCALER);
553 Film::set_with_subtitles (bool w)
556 boost::mutex::scoped_lock lm (_state_mutex);
559 signal_changed (WITH_SUBTITLES);
563 Film::set_j2k_bandwidth (int b)
566 boost::mutex::scoped_lock lm (_state_mutex);
569 signal_changed (J2K_BANDWIDTH);
573 Film::set_dci_metadata (DCIMetadata m)
576 boost::mutex::scoped_lock lm (_state_mutex);
579 signal_changed (DCI_METADATA);
583 Film::set_dcp_video_frame_rate (int f)
586 boost::mutex::scoped_lock lm (_state_mutex);
587 _dcp_video_frame_rate = f;
589 signal_changed (DCP_VIDEO_FRAME_RATE);
593 Film::set_dcp_audio_channels (int c)
596 boost::mutex::scoped_lock lm (_state_mutex);
597 _dcp_audio_channels = c;
599 signal_changed (DCP_AUDIO_CHANNELS);
603 Film::signal_changed (Property p)
606 boost::mutex::scoped_lock lm (_state_mutex);
612 set_dcp_video_frame_rate (_playlist->best_dcp_frame_rate ());
614 case Film::DCP_VIDEO_FRAME_RATE:
615 _playlist->maybe_sequence_video ();
622 ui_signaller->emit (boost::bind (boost::ref (Changed), p));
627 Film::set_dci_date_today ()
629 _dci_date = boost::gregorian::day_clock::local_day ();
633 Film::info_path (int f) const
635 boost::filesystem::path p;
640 s << setfill('0') << f << ".md5";
644 /* info_dir() will already have added any initial bit of the path,
645 so don't call file() on this.
651 Film::j2c_path (int f, bool t) const
653 boost::filesystem::path p;
655 p /= video_identifier ();
659 s << setfill('0') << f << ".j2c";
666 return file (p.string ());
669 /** Make an educated guess as to whether we have a complete DCP
671 * @return true if we do.
675 Film::have_dcp () const
678 libdcp::DCP dcp (dir (dcp_name()));
688 Film::make_player () const
690 return shared_ptr<Player> (new Player (shared_from_this (), _playlist));
694 Film::playlist () const
696 boost::mutex::scoped_lock lm (_state_mutex);
700 Playlist::ContentList
701 Film::content () const
703 return _playlist->content ();
707 Film::examine_and_add_content (shared_ptr<Content> c)
709 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
710 j->Finished.connect (bind (&Film::add_content_weak, this, boost::weak_ptr<Content> (c)));
711 JobManager::instance()->add (j);
715 Film::add_content_weak (weak_ptr<Content> c)
717 shared_ptr<Content> content = c.lock ();
719 add_content (content);
724 Film::add_content (shared_ptr<Content> c)
726 /* Add video content after any existing content */
727 if (dynamic_pointer_cast<VideoContent> (c)) {
728 c->set_start (_playlist->video_end ());
735 Film::remove_content (shared_ptr<Content> c)
737 _playlist->remove (c);
741 Film::length () const
743 return _playlist->length ();
747 Film::has_subtitles () const
749 return _playlist->has_subtitles ();
753 Film::best_dcp_video_frame_rate () const
755 return _playlist->best_dcp_frame_rate ();
759 Film::playlist_content_changed (boost::weak_ptr<Content> c, int p)
761 if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
762 set_dcp_video_frame_rate (_playlist->best_dcp_frame_rate ());
766 ui_signaller->emit (boost::bind (boost::ref (ContentChanged), c, p));
771 Film::playlist_changed ()
773 signal_changed (CONTENT);
779 return _playlist->loop ();
783 Film::set_loop (int c)
785 _playlist->set_loop (c);
789 Film::time_to_audio_frames (Time t) const
791 return t * dcp_audio_frame_rate () / TIME_HZ;
795 Film::time_to_video_frames (Time t) const
797 return t * dcp_video_frame_rate () / TIME_HZ;
801 Film::audio_frames_to_time (OutputAudioFrame f) const
803 return f * TIME_HZ / dcp_audio_frame_rate ();
807 Film::video_frames_to_time (OutputVideoFrame f) const
809 return f * TIME_HZ / dcp_video_frame_rate ();
813 Film::dcp_audio_frame_rate () const
820 Film::set_sequence_video (bool s)
822 _playlist->set_sequence_video (s);
826 Film::full_frame () const
828 return libdcp::Size (2048, 1080);