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 , _subtitle_offset (0)
100 , _j2k_bandwidth (200000000)
101 , _dci_metadata (Config::instance()->default_dci_metadata ())
102 , _dcp_video_frame_rate (24)
103 , _dcp_audio_channels (MAX_AUDIO_CHANNELS)
104 , _minimum_audio_channels (0)
107 set_dci_date_today ();
109 _playlist->Changed.connect (bind (&Film::playlist_changed, this));
110 _playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2));
112 /* Make state.directory a complete path without ..s (where possible)
113 (Code swiped from Adam Bowen on stackoverflow)
116 boost::filesystem::path p (boost::filesystem::system_complete (d));
117 boost::filesystem::path result;
118 for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
120 if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
123 result = result.parent_path ();
125 } else if (*i != ".") {
130 set_directory (result.string ());
131 _log.reset (new FileLog ("log"));
134 Film::Film (Film const & o)
135 : boost::enable_shared_from_this<Film> (o)
136 /* note: the copied film shares the original's log */
138 , _playlist (new Playlist (o._playlist))
139 , _directory (o._directory)
141 , _use_dci_name (o._use_dci_name)
142 , _dcp_content_type (o._dcp_content_type)
143 , _container (o._container)
144 , _scaler (o._scaler)
145 , _with_subtitles (o._with_subtitles)
146 , _subtitle_offset (o._subtitle_offset)
147 , _subtitle_scale (o._subtitle_scale)
148 , _colour_lut (o._colour_lut)
149 , _j2k_bandwidth (o._j2k_bandwidth)
150 , _dci_metadata (o._dci_metadata)
151 , _dcp_video_frame_rate (o._dcp_video_frame_rate)
152 , _dci_date (o._dci_date)
153 , _minimum_audio_channels (o._minimum_audio_channels)
156 _playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2));
160 Film::video_state_identifier () const
162 assert (container ());
166 s << container()->id()
167 << "_" << _playlist->video_digest()
168 << "_" << _dcp_video_frame_rate
169 << "_" << scaler()->id()
170 << "_" << j2k_bandwidth()
171 << "_" << lexical_cast<int> (colour_lut());
176 /** @return The path to the directory to write video frame info files to */
178 Film::info_dir () const
180 boost::filesystem::path p;
182 p /= video_state_identifier ();
183 return dir (p.string());
187 Film::internal_video_mxf_dir () const
189 return dir ("video");
193 Film::internal_video_mxf_filename () const
195 return video_state_identifier() + ".mxf";
199 Film::dcp_video_mxf_filename () const
201 return filename_safe_name() + "_video.mxf";
205 Film::dcp_audio_mxf_filename () const
207 return filename_safe_name() + "_audio.mxf";
211 Film::filename_safe_name () const
213 string const n = name ();
215 for (size_t i = 0; i < n.length(); ++i) {
216 if (isalnum (n[i])) {
226 boost::filesystem::path
227 Film::audio_analysis_path (shared_ptr<const AudioContent> c) const
229 boost::filesystem::path p = dir ("analysis");
234 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
238 set_dci_date_today ();
240 if (dcp_name().find ("/") != string::npos) {
241 throw BadSettingError (_("name"), _("cannot contain slashes"));
244 log()->log (String::compose ("DCP-o-matic %1 git %2 using %3", dcpomatic_version, dcpomatic_git_commit, dependency_version_summary()));
248 gethostname (buffer, sizeof (buffer));
249 log()->log (String::compose ("Starting to make DCP on %1", buffer));
252 // log()->log (String::compose ("Content is %1; type %2", content_path(), (content_type() == STILL ? _("still") : _("video"))));
254 // log()->log (String::compose ("Content length %1", length().get()));
256 // log()->log (String::compose ("Content digest %1", content_digest()));
257 // log()->log (String::compose ("Content at %1 fps, DCP at %2 fps", source_frame_rate(), dcp_frame_rate()));
258 log()->log (String::compose ("%1 threads", Config::instance()->num_local_encoding_threads()));
259 log()->log (String::compose ("J2K bandwidth %1", j2k_bandwidth()));
260 #ifdef DCPOMATIC_DEBUG
261 log()->log ("DCP-o-matic built in debug mode.");
263 log()->log ("DCP-o-matic built in optimised mode.");
266 log()->log ("libdcp built in debug mode.");
268 log()->log ("libdcp built in optimised mode.");
270 pair<string, int> const c = cpu_info ();
271 log()->log (String::compose ("CPU: %1, %2 processors", c.first, c.second));
272 list<pair<string, string> > const m = mount_info ();
273 for (list<pair<string, string> >::const_iterator i = m.begin(); i != m.end(); ++i) {
274 log()->log (String::compose ("Mount: %1 %2", i->first, i->second));
277 if (container() == 0) {
278 throw MissingSettingError (_("container"));
281 if (_playlist->content().empty ()) {
282 throw StringError (_("You must add some content to the DCP before creating it"));
285 if (dcp_content_type() == 0) {
286 throw MissingSettingError (_("content type"));
289 if (name().empty()) {
290 throw MissingSettingError (_("name"));
293 JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
296 /** Start a job to send our DCP to the configured TMS */
298 Film::send_dcp_to_tms ()
300 shared_ptr<Job> j (new SCPDCPJob (shared_from_this()));
301 JobManager::instance()->add (j);
304 /** Count the number of frames that have been encoded for this film.
305 * @return frame count.
308 Film::encoded_frames () const
310 if (container() == 0) {
315 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (info_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
317 boost::this_thread::interruption_point ();
323 /** Write state to our `metadata' file */
325 Film::write_metadata () const
327 if (!boost::filesystem::exists (directory())) {
328 boost::filesystem::create_directory (directory());
331 boost::mutex::scoped_lock lm (_state_mutex);
334 boost::filesystem::create_directories (directory());
337 xmlpp::Element* root = doc.create_root_node ("Metadata");
339 root->add_child("Version")->add_child_text (lexical_cast<string> (state_version));
340 root->add_child("Name")->add_child_text (_name);
341 root->add_child("UseDCIName")->add_child_text (_use_dci_name ? "1" : "0");
343 if (_dcp_content_type) {
344 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->dci_name ());
348 root->add_child("Container")->add_child_text (_container->id ());
351 root->add_child("Scaler")->add_child_text (_scaler->id ());
352 root->add_child("WithSubtitles")->add_child_text (_with_subtitles ? "1" : "0");
353 root->add_child("SubtitleOffset")->add_child_text (lexical_cast<string> (_subtitle_offset));
354 root->add_child("SubtitleScale")->add_child_text (lexical_cast<string> (_subtitle_scale));
355 root->add_child("ColourLUT")->add_child_text (lexical_cast<string> (_colour_lut));
356 root->add_child("J2KBandwidth")->add_child_text (lexical_cast<string> (_j2k_bandwidth));
357 _dci_metadata.as_xml (root->add_child ("DCIMetadata"));
358 root->add_child("DCPVideoFrameRate")->add_child_text (lexical_cast<string> (_dcp_video_frame_rate));
359 root->add_child("DCIDate")->add_child_text (boost::gregorian::to_iso_string (_dci_date));
360 root->add_child("DCPAudioChannels")->add_child_text (lexical_cast<string> (_dcp_audio_channels));
361 root->add_child("MinimumAudioChannels")->add_child_text (lexical_cast<string> (_minimum_audio_channels));
362 _playlist->as_xml (root->add_child ("Playlist"));
364 doc.write_to_file_formatted (file ("metadata.xml"));
369 /** Read state from our metadata file */
371 Film::read_metadata ()
373 boost::mutex::scoped_lock lm (_state_mutex);
376 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
377 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!"));
380 cxml::File f (file ("metadata.xml"), "Metadata");
382 _name = f.string_child ("Name");
383 _use_dci_name = f.bool_child ("UseDCIName");
386 optional<string> c = f.optional_string_child ("DCPContentType");
388 _dcp_content_type = DCPContentType::from_dci_name (c.get ());
393 optional<string> c = f.optional_string_child ("Container");
395 _container = Ratio::from_id (c.get ());
399 _scaler = Scaler::from_id (f.string_child ("Scaler"));
400 _with_subtitles = f.bool_child ("WithSubtitles");
401 _subtitle_offset = f.number_child<float> ("SubtitleOffset");
402 _subtitle_scale = f.number_child<float> ("SubtitleScale");
403 _colour_lut = f.number_child<int> ("ColourLUT");
404 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
405 _dci_metadata = DCIMetadata (f.node_child ("DCIMetadata"));
406 _dcp_video_frame_rate = f.number_child<int> ("DCPVideoFrameRate");
407 _dci_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
408 _dcp_audio_channels = f.number_child<int> ("DCPAudioChannels");
409 _minimum_audio_channels = f.number_child<int> ("MinimumAudioChannels");
411 _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"));
416 /** Given a directory name, return its full path within the Film's directory.
417 * The directory (and its parents) will be created if they do not exist.
420 Film::dir (string d) const
422 boost::mutex::scoped_lock lm (_directory_mutex);
424 boost::filesystem::path p;
428 boost::filesystem::create_directories (p);
433 /** Given a file or directory name, return its full path within the Film's directory.
434 * _directory_mutex must not be locked on entry.
435 * Any required parent directories will be created.
438 Film::file (string f) const
440 boost::mutex::scoped_lock lm (_directory_mutex);
442 boost::filesystem::path p;
446 boost::filesystem::create_directories (p.parent_path ());
451 /** @return a DCI-compliant name for a DCP of this film */
453 Film::dci_name (bool if_created_now) const
457 string fixed_name = to_upper_copy (name());
458 for (size_t i = 0; i < fixed_name.length(); ++i) {
459 if (fixed_name[i] == ' ') {
464 /* Spec is that the name part should be maximum 14 characters, as I understand it */
465 if (fixed_name.length() > 14) {
466 fixed_name = fixed_name.substr (0, 14);
471 if (dcp_content_type()) {
472 d << "_" << dcp_content_type()->dci_name();
476 d << "_" << container()->dci_name();
479 DCIMetadata const dm = dci_metadata ();
481 if (!dm.audio_language.empty ()) {
482 d << "_" << dm.audio_language;
483 if (!dm.subtitle_language.empty()) {
484 d << "-" << dm.subtitle_language;
490 if (!dm.territory.empty ()) {
491 d << "_" << dm.territory;
492 if (!dm.rating.empty ()) {
493 d << "-" << dm.rating;
499 if (!dm.studio.empty ()) {
500 d << "_" << dm.studio;
503 if (if_created_now) {
504 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
506 d << "_" << boost::gregorian::to_iso_string (_dci_date);
509 if (!dm.facility.empty ()) {
510 d << "_" << dm.facility;
513 if (!dm.package_type.empty ()) {
514 d << "_" << dm.package_type;
520 /** @return name to give the DCP */
522 Film::dcp_name (bool if_created_now) const
524 if (use_dci_name()) {
525 return dci_name (if_created_now);
533 Film::set_directory (string d)
535 boost::mutex::scoped_lock lm (_state_mutex);
541 Film::set_name (string n)
544 boost::mutex::scoped_lock lm (_state_mutex);
547 signal_changed (NAME);
551 Film::set_use_dci_name (bool u)
554 boost::mutex::scoped_lock lm (_state_mutex);
557 signal_changed (USE_DCI_NAME);
561 Film::set_dcp_content_type (DCPContentType const * t)
564 boost::mutex::scoped_lock lm (_state_mutex);
565 _dcp_content_type = t;
567 signal_changed (DCP_CONTENT_TYPE);
571 Film::set_container (Ratio const * c)
574 boost::mutex::scoped_lock lm (_state_mutex);
577 signal_changed (CONTAINER);
581 Film::set_scaler (Scaler const * s)
584 boost::mutex::scoped_lock lm (_state_mutex);
587 signal_changed (SCALER);
591 Film::set_with_subtitles (bool w)
594 boost::mutex::scoped_lock lm (_state_mutex);
597 signal_changed (WITH_SUBTITLES);
601 Film::set_subtitle_offset (int o)
604 boost::mutex::scoped_lock lm (_state_mutex);
605 _subtitle_offset = o;
607 signal_changed (SUBTITLE_OFFSET);
611 Film::set_subtitle_scale (float s)
614 boost::mutex::scoped_lock lm (_state_mutex);
617 signal_changed (SUBTITLE_SCALE);
621 Film::set_colour_lut (int i)
624 boost::mutex::scoped_lock lm (_state_mutex);
627 signal_changed (COLOUR_LUT);
631 Film::set_j2k_bandwidth (int b)
634 boost::mutex::scoped_lock lm (_state_mutex);
637 signal_changed (J2K_BANDWIDTH);
641 Film::set_dci_metadata (DCIMetadata m)
644 boost::mutex::scoped_lock lm (_state_mutex);
647 signal_changed (DCI_METADATA);
652 Film::set_minimum_audio_channels (int c)
655 boost::mutex::scoped_lock lm (_state_mutex);
656 _minimum_audio_channels = c;
658 signal_changed (MINIMUM_AUDIO_CHANNELS);
662 Film::set_dcp_video_frame_rate (int f)
665 boost::mutex::scoped_lock lm (_state_mutex);
666 _dcp_video_frame_rate = f;
668 signal_changed (DCP_VIDEO_FRAME_RATE);
672 Film::signal_changed (Property p)
675 boost::mutex::scoped_lock lm (_state_mutex);
681 set_dcp_video_frame_rate (_playlist->best_dcp_frame_rate ());
688 ui_signaller->emit (boost::bind (boost::ref (Changed), p));
693 Film::set_dci_date_today ()
695 _dci_date = boost::gregorian::day_clock::local_day ();
699 Film::info_path (int f) const
701 boost::filesystem::path p;
706 s << setfill('0') << f << ".md5";
710 /* info_dir() will already have added any initial bit of the path,
711 so don't call file() on this.
717 Film::j2c_path (int f, bool t) const
719 boost::filesystem::path p;
721 p /= video_state_identifier ();
725 s << setfill('0') << f << ".j2c";
732 return file (p.string ());
735 /** Make an educated guess as to whether we have a complete DCP
737 * @return true if we do.
741 Film::have_dcp () const
744 libdcp::DCP dcp (dir (dcp_name()));
754 Film::player () const
756 return shared_ptr<Player> (new Player (shared_from_this (), _playlist));
760 Film::playlist () const
762 boost::mutex::scoped_lock lm (_state_mutex);
766 Playlist::ContentList
767 Film::content () const
769 return _playlist->content ();
773 Film::examine_and_add_content (shared_ptr<Content> c)
775 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
776 j->Finished.connect (bind (&Film::add_content_weak, this, boost::weak_ptr<Content> (c)));
777 JobManager::instance()->add (j);
781 Film::add_content_weak (weak_ptr<Content> c)
783 shared_ptr<Content> content = c.lock ();
785 add_content (content);
790 Film::add_content (shared_ptr<Content> c)
792 /* Add video content after any existing content */
793 if (dynamic_pointer_cast<VideoContent> (c)) {
794 c->set_start (_playlist->video_end ());
801 Film::remove_content (shared_ptr<Content> c)
803 _playlist->remove (c);
807 Film::length () const
809 return _playlist->length ();
813 Film::has_subtitles () const
815 return _playlist->has_subtitles ();
819 Film::best_dcp_video_frame_rate () const
821 return _playlist->best_dcp_frame_rate ();
825 Film::playlist_content_changed (boost::weak_ptr<Content> c, int p)
827 if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
828 set_dcp_video_frame_rate (_playlist->best_dcp_frame_rate ());
832 ui_signaller->emit (boost::bind (boost::ref (ContentChanged), c, p));
837 Film::playlist_changed ()
839 signal_changed (CONTENT);
845 return _playlist->loop ();
849 Film::set_loop (int c)
851 _playlist->set_loop (c);
855 Film::time_to_audio_frames (Time t) const
857 return t * dcp_audio_frame_rate () / TIME_HZ;
861 Film::time_to_video_frames (Time t) const
863 return t * dcp_video_frame_rate () / TIME_HZ;
867 Film::audio_frames_to_time (OutputAudioFrame f) const
869 return f * TIME_HZ / dcp_audio_frame_rate ();
873 Film::video_frames_to_time (OutputVideoFrame f) const
875 return f * TIME_HZ / dcp_video_frame_rate ();
879 Film::dcp_audio_frame_rate () const
886 Film::set_sequence_video (bool s)
888 _playlist->set_sequence_video (s);
892 Film::full_frame () const
894 return libdcp::Size (2048, 1080);