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 "transcoder.h"
40 #include "job_manager.h"
41 #include "ab_transcode_job.h"
42 #include "transcode_job.h"
43 #include "scp_dcp_job.h"
45 #include "exceptions.h"
46 #include "examine_content_job.h"
50 #include "ui_signaller.h"
51 #include "video_decoder.h"
52 #include "audio_decoder.h"
53 #include "sndfile_decoder.h"
54 #include "analyse_audio_job.h"
56 #include "ffmpeg_content.h"
57 #include "imagemagick_content.h"
58 #include "sndfile_content.h"
63 using std::stringstream;
75 using boost::shared_ptr;
76 using boost::lexical_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, reading any metadata
86 * file that exists in that directory. An exception will be thrown if
87 * must_exist is true and the specified directory does not exist.
89 * @param d Film directory.
90 * @param must_exist true to throw an exception if does not exist.
93 Film::Film (string d, bool must_exist)
94 : _use_dci_name (true)
95 , _trust_content_headers (true)
96 , _dcp_content_type (0)
98 , _scaler (Scaler::from_id ("bicubic"))
104 , _with_subtitles (false)
105 , _subtitle_offset (0)
106 , _subtitle_scale (1)
108 , _j2k_bandwidth (200000000)
109 , _dci_metadata (Config::instance()->default_dci_metadata ())
110 , _dcp_frame_rate (0)
113 set_dci_date_today ();
115 /* Make state.directory a complete path without ..s (where possible)
116 (Code swiped from Adam Bowen on stackoverflow)
119 boost::filesystem::path p (boost::filesystem::system_complete (d));
120 boost::filesystem::path result;
121 for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
123 if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
126 result = result.parent_path ();
128 } else if (*i != ".") {
133 set_directory (result.string ());
135 if (!boost::filesystem::exists (directory())) {
137 throw OpenFileError (directory());
139 boost::filesystem::create_directory (directory());
147 _log.reset (new FileLog (file ("log")));
150 Film::Film (Film const & o)
151 : boost::enable_shared_from_this<Film> (o)
152 /* note: the copied film shares the original's log */
154 , _directory (o._directory)
156 , _use_dci_name (o._use_dci_name)
157 , _trust_content_headers (o._trust_content_headers)
158 , _dcp_content_type (o._dcp_content_type)
159 , _format (o._format)
161 , _filters (o._filters)
162 , _scaler (o._scaler)
163 , _trim_start (o._trim_start)
164 , _trim_end (o._trim_end)
166 , _audio_gain (o._audio_gain)
167 , _audio_delay (o._audio_delay)
168 , _with_subtitles (o._with_subtitles)
169 , _subtitle_offset (o._subtitle_offset)
170 , _subtitle_scale (o._subtitle_scale)
171 , _colour_lut (o._colour_lut)
172 , _j2k_bandwidth (o._j2k_bandwidth)
173 , _dci_metadata (o._dci_metadata)
174 , _dci_date (o._dci_date)
175 , _dcp_frame_rate (o._dcp_frame_rate)
187 Film::video_state_identifier () const
195 pair<string, string> f = Filter::ffmpeg_strings (filters());
199 << "_" << content_digest()
200 << "_" << crop().left << "_" << crop().right << "_" << crop().top << "_" << crop().bottom
201 << "_" << _dcp_frame_rate
202 << "_" << f.first << "_" << f.second
203 << "_" << scaler()->id()
204 << "_" << j2k_bandwidth()
205 << "_" << boost::lexical_cast<int> (colour_lut());
208 pair<string, string> fa = Filter::ffmpeg_strings (Config::instance()->reference_filters());
209 s << "ab_" << Config::instance()->reference_scaler()->id() << "_" << fa.first << "_" << fa.second;
216 /** @return The path to the directory to write video frame info files to */
218 Film::info_dir () const
220 boost::filesystem::path p;
222 p /= video_state_identifier ();
223 return dir (p.string());
227 Film::video_mxf_dir () const
229 boost::filesystem::path p;
230 return dir ("video");
234 Film::video_mxf_filename () const
236 return video_state_identifier() + ".mxf";
240 Film::audio_analysis_path () const
242 boost::filesystem::path p;
244 p /= "XXX";//content_digest();
245 return file (p.string ());
248 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
252 set_dci_date_today ();
254 if (dcp_name().find ("/") != string::npos) {
255 throw BadSettingError (_("name"), _("cannot contain slashes"));
258 log()->log (String::compose ("DVD-o-matic %1 git %2 using %3", dvdomatic_version, dvdomatic_git_commit, dependency_version_summary()));
262 gethostname (buffer, sizeof (buffer));
263 log()->log (String::compose ("Starting to make DCP on %1", buffer));
266 // log()->log (String::compose ("Content is %1; type %2", content_path(), (content_type() == STILL ? _("still") : _("video"))));
268 // log()->log (String::compose ("Content length %1", length().get()));
270 // log()->log (String::compose ("Content digest %1", content_digest()));
271 // log()->log (String::compose ("Content at %1 fps, DCP at %2 fps", source_frame_rate(), dcp_frame_rate()));
272 log()->log (String::compose ("%1 threads", Config::instance()->num_local_encoding_threads()));
273 log()->log (String::compose ("J2K bandwidth %1", j2k_bandwidth()));
274 #ifdef DVDOMATIC_DEBUG
275 log()->log ("DVD-o-matic built in debug mode.");
277 log()->log ("DVD-o-matic built in optimised mode.");
280 log()->log ("libdcp built in debug mode.");
282 log()->log ("libdcp built in optimised mode.");
284 pair<string, int> const c = cpu_info ();
285 log()->log (String::compose ("CPU: %1, %2 processors", c.first, c.second));
288 throw MissingSettingError (_("format"));
291 if (content().empty ()) {
292 throw MissingSettingError (_("content"));
295 if (dcp_content_type() == 0) {
296 throw MissingSettingError (_("content type"));
299 if (name().empty()) {
300 throw MissingSettingError (_("name"));
306 r = JobManager::instance()->add (shared_ptr<Job> (new ABTranscodeJob (shared_from_this())));
308 r = JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
312 /** Start a job to analyse the audio of our content file */
314 Film::analyse_audio ()
316 if (_analyse_audio_job) {
320 _analyse_audio_job.reset (new AnalyseAudioJob (shared_from_this()));
321 _analyse_audio_job->Finished.connect (bind (&Film::analyse_audio_finished, this));
322 JobManager::instance()->add (_analyse_audio_job);
325 /** Start a job to examine a piece of content */
327 Film::examine_content (shared_ptr<Content> c)
329 shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c, trust_content_headers ()));
330 j->Finished.connect (bind (&Film::examine_content_finished, this));
331 JobManager::instance()->add (j);
335 Film::analyse_audio_finished ()
339 if (_analyse_audio_job->finished_ok ()) {
340 AudioAnalysisSucceeded ();
343 _analyse_audio_job.reset ();
347 Film::examine_content_finished ()
352 /** Start a job to send our DCP to the configured TMS */
354 Film::send_dcp_to_tms ()
356 shared_ptr<Job> j (new SCPDCPJob (shared_from_this()));
357 JobManager::instance()->add (j);
360 /** Count the number of frames that have been encoded for this film.
361 * @return frame count.
364 Film::encoded_frames () const
371 for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (info_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
373 boost::this_thread::interruption_point ();
379 /** Write state to our `metadata' file */
381 Film::write_metadata () const
383 ContentList the_content = content ();
385 boost::mutex::scoped_lock lm (_state_mutex);
387 boost::filesystem::create_directories (directory());
390 xmlpp::Element* root = doc.create_root_node ("Metadata");
392 root->add_child("Version")->add_child_text (boost::lexical_cast<string> (state_version));
393 root->add_child("Name")->add_child_text (_name);
394 root->add_child("UseDCIName")->add_child_text (_use_dci_name ? "1" : "0");
395 root->add_child("TrustContentHeaders")->add_child_text (_trust_content_headers ? "1" : "0");
396 if (_dcp_content_type) {
397 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->dci_name ());
400 root->add_child("Format")->add_child_text (_format->id ());
402 root->add_child("LeftCrop")->add_child_text (boost::lexical_cast<string> (_crop.left));
403 root->add_child("RightCrop")->add_child_text (boost::lexical_cast<string> (_crop.right));
404 root->add_child("TopCrop")->add_child_text (boost::lexical_cast<string> (_crop.top));
405 root->add_child("BottomCrop")->add_child_text (boost::lexical_cast<string> (_crop.bottom));
407 for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
408 root->add_child("Filter")->add_child_text ((*i)->id ());
411 root->add_child("Scaler")->add_child_text (_scaler->id ());
412 root->add_child("TrimStart")->add_child_text (boost::lexical_cast<string> (_trim_start));
413 root->add_child("TrimEnd")->add_child_text (boost::lexical_cast<string> (_trim_end));
414 root->add_child("AB")->add_child_text (_ab ? "1" : "0");
415 root->add_child("AudioGain")->add_child_text (boost::lexical_cast<string> (_audio_gain));
416 root->add_child("AudioDelay")->add_child_text (boost::lexical_cast<string> (_audio_delay));
417 root->add_child("WithSubtitles")->add_child_text (_with_subtitles ? "1" : "0");
418 root->add_child("SubtitleOffset")->add_child_text (boost::lexical_cast<string> (_subtitle_offset));
419 root->add_child("SubtitleScale")->add_child_text (boost::lexical_cast<string> (_subtitle_scale));
420 root->add_child("ColourLUT")->add_child_text (boost::lexical_cast<string> (_colour_lut));
421 root->add_child("J2KBandwidth")->add_child_text (boost::lexical_cast<string> (_j2k_bandwidth));
422 _dci_metadata.as_xml (root->add_child ("DCIMetadata"));
423 root->add_child("DCIDate")->add_child_text (boost::gregorian::to_iso_string (_dci_date));
424 root->add_child("DCPFrameRate")->add_child_text (boost::lexical_cast<string> (_dcp_frame_rate));
426 for (ContentList::iterator i = the_content.begin(); i != the_content.end(); ++i) {
427 (*i)->as_xml (root->add_child ("Content"));
430 doc.write_to_file_formatted (file ("metadata.xml"));
435 /** Read state from our metadata file */
437 Film::read_metadata ()
439 boost::mutex::scoped_lock lm (_state_mutex);
441 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
442 throw StringError (_("This film was created with an older version of DVD-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!"));
445 cxml::File f (file ("metadata.xml"), "Metadata");
447 _name = f.string_child ("Name");
448 _use_dci_name = f.bool_child ("UseDCIName");
449 _trust_content_headers = f.bool_child ("TrustContentHeaders");
452 optional<string> c = f.optional_string_child ("DCPContentType");
454 _dcp_content_type = DCPContentType::from_dci_name (c.get ());
459 optional<string> c = f.optional_string_child ("Format");
461 _format = Format::from_id (c.get ());
465 _crop.left = f.number_child<int> ("CropLeft");
466 _crop.right = f.number_child<int> ("CropRight");
467 _crop.top = f.number_child<int> ("CropTop");
468 _crop.bottom = f.number_child<int> ("CropBottom");
471 list<shared_ptr<cxml::Node> > c = f.node_children ("Filter");
472 for (list<shared_ptr<cxml::Node> >::iterator i = c.begin(); i != c.end(); ++i) {
473 _filters.push_back (Filter::from_id ((*i)->content ()));
477 _scaler = Scaler::from_id (f.string_child ("Scaler"));
478 _trim_start = f.number_child<int> ("TrimStart");
479 _trim_end = f.number_child<int> ("TrimEnd");
480 _ab = f.bool_child ("AB");
481 _audio_gain = f.number_child<float> ("AudioGain");
482 _audio_delay = f.number_child<int> ("AudioDelay");
483 _with_subtitles = f.bool_child ("WithSubtitles");
484 _subtitle_offset = f.number_child<float> ("SubtitleOffset");
485 _subtitle_scale = f.number_child<float> ("SubtitleScale");
486 _colour_lut = f.number_child<int> ("ColourLUT");
487 _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
488 _dci_metadata = DCIMetadata (f.node_child ("DCIMetadata"));
489 _dci_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
490 _dcp_frame_rate = f.number_child<int> ("DCPFrameRate");
492 list<shared_ptr<cxml::Node> > c = f.node_children ("Content");
493 for (list<shared_ptr<cxml::Node> >::iterator i = c.begin(); i != c.end(); ++i) {
495 string const type = (*i)->string_child ("Type");
497 if (type == "FFmpeg") {
498 _content.push_back (shared_ptr<Content> (new FFmpegContent (*i)));
499 } else if (type == "ImageMagick") {
500 _content.push_back (shared_ptr<Content> (new ImageMagickContent (*i)));
501 } else if (type == "Sndfile") {
502 _content.push_back (shared_ptr<Content> (new SndfileContent (*i)));
510 Film::cropped_size (libdcp::Size s) const
512 boost::mutex::scoped_lock lm (_state_mutex);
513 s.width -= _crop.left + _crop.right;
514 s.height -= _crop.top + _crop.bottom;
518 /** Given a directory name, return its full path within the Film's directory.
519 * The directory (and its parents) will be created if they do not exist.
522 Film::dir (string d) const
524 boost::mutex::scoped_lock lm (_directory_mutex);
526 boost::filesystem::path p;
530 boost::filesystem::create_directories (p);
535 /** Given a file or directory name, return its full path within the Film's directory.
536 * _directory_mutex must not be locked on entry.
537 * Any required parent directories will be created.
540 Film::file (string f) const
542 boost::mutex::scoped_lock lm (_directory_mutex);
544 boost::filesystem::path p;
548 boost::filesystem::create_directories (p.parent_path ());
553 /** @return The sampling rate that we will resample the audio to */
555 Film::target_audio_sample_rate () const
557 /* XXX: how often is this method called? */
559 boost::shared_ptr<Playlist> p = playlist ();
560 if (p->has_audio ()) {
564 /* Resample to a DCI-approved sample rate */
565 double t = dcp_audio_sample_rate (p->audio_frame_rate());
567 FrameRateConversion frc (p->video_frame_rate(), dcp_frame_rate());
569 /* Compensate if the DCP is being run at a different frame rate
570 to the source; that is, if the video is run such that it will
571 look different in the DCP compared to the source (slower or faster).
572 skip/repeat doesn't come into effect here.
575 if (frc.change_speed) {
576 t *= p->video_frame_rate() * frc.factor() / dcp_frame_rate();
582 /** @return a DCI-compliant name for a DCP of this film */
584 Film::dci_name (bool if_created_now) const
588 string fixed_name = to_upper_copy (name());
589 for (size_t i = 0; i < fixed_name.length(); ++i) {
590 if (fixed_name[i] == ' ') {
595 /* Spec is that the name part should be maximum 14 characters, as I understand it */
596 if (fixed_name.length() > 14) {
597 fixed_name = fixed_name.substr (0, 14);
602 if (dcp_content_type()) {
603 d << "_" << dcp_content_type()->dci_name();
607 d << "_" << format()->dci_name();
610 DCIMetadata const dm = dci_metadata ();
612 if (!dm.audio_language.empty ()) {
613 d << "_" << dm.audio_language;
614 if (!dm.subtitle_language.empty()) {
615 d << "-" << dm.subtitle_language;
621 if (!dm.territory.empty ()) {
622 d << "_" << dm.territory;
623 if (!dm.rating.empty ()) {
624 d << "-" << dm.rating;
646 if (!dm.studio.empty ()) {
647 d << "_" << dm.studio;
650 if (if_created_now) {
651 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
653 d << "_" << boost::gregorian::to_iso_string (_dci_date);
656 if (!dm.facility.empty ()) {
657 d << "_" << dm.facility;
660 if (!dm.package_type.empty ()) {
661 d << "_" << dm.package_type;
667 /** @return name to give the DCP */
669 Film::dcp_name (bool if_created_now) const
671 if (use_dci_name()) {
672 return dci_name (if_created_now);
680 Film::set_directory (string d)
682 boost::mutex::scoped_lock lm (_state_mutex);
688 Film::set_name (string n)
691 boost::mutex::scoped_lock lm (_state_mutex);
694 signal_changed (NAME);
698 Film::set_use_dci_name (bool u)
701 boost::mutex::scoped_lock lm (_state_mutex);
704 signal_changed (USE_DCI_NAME);
708 Film::set_trust_content_headers (bool t)
711 boost::mutex::scoped_lock lm (_state_mutex);
712 _trust_content_headers = t;
715 signal_changed (TRUST_CONTENT_HEADERS);
717 if (!_trust_content_headers && !content().empty()) {
718 /* We just said that we don't trust the content's header */
720 // examine_content ();
725 Film::set_dcp_content_type (DCPContentType const * t)
728 boost::mutex::scoped_lock lm (_state_mutex);
729 _dcp_content_type = t;
731 signal_changed (DCP_CONTENT_TYPE);
735 Film::set_format (Format const * f)
738 boost::mutex::scoped_lock lm (_state_mutex);
741 signal_changed (FORMAT);
745 Film::set_crop (Crop c)
748 boost::mutex::scoped_lock lm (_state_mutex);
751 signal_changed (CROP);
755 Film::set_left_crop (int c)
758 boost::mutex::scoped_lock lm (_state_mutex);
760 if (_crop.left == c) {
766 signal_changed (CROP);
770 Film::set_right_crop (int c)
773 boost::mutex::scoped_lock lm (_state_mutex);
774 if (_crop.right == c) {
780 signal_changed (CROP);
784 Film::set_top_crop (int c)
787 boost::mutex::scoped_lock lm (_state_mutex);
788 if (_crop.top == c) {
794 signal_changed (CROP);
798 Film::set_bottom_crop (int c)
801 boost::mutex::scoped_lock lm (_state_mutex);
802 if (_crop.bottom == c) {
808 signal_changed (CROP);
812 Film::set_filters (vector<Filter const *> f)
815 boost::mutex::scoped_lock lm (_state_mutex);
818 signal_changed (FILTERS);
822 Film::set_scaler (Scaler const * s)
825 boost::mutex::scoped_lock lm (_state_mutex);
828 signal_changed (SCALER);
832 Film::set_trim_start (int t)
835 boost::mutex::scoped_lock lm (_state_mutex);
838 signal_changed (TRIM_START);
842 Film::set_trim_end (int t)
845 boost::mutex::scoped_lock lm (_state_mutex);
848 signal_changed (TRIM_END);
852 Film::set_ab (bool a)
855 boost::mutex::scoped_lock lm (_state_mutex);
862 Film::set_audio_gain (float g)
865 boost::mutex::scoped_lock lm (_state_mutex);
868 signal_changed (AUDIO_GAIN);
872 Film::set_audio_delay (int d)
875 boost::mutex::scoped_lock lm (_state_mutex);
878 signal_changed (AUDIO_DELAY);
882 Film::set_with_subtitles (bool w)
885 boost::mutex::scoped_lock lm (_state_mutex);
888 signal_changed (WITH_SUBTITLES);
892 Film::set_subtitle_offset (int o)
895 boost::mutex::scoped_lock lm (_state_mutex);
896 _subtitle_offset = o;
898 signal_changed (SUBTITLE_OFFSET);
902 Film::set_subtitle_scale (float s)
905 boost::mutex::scoped_lock lm (_state_mutex);
908 signal_changed (SUBTITLE_SCALE);
912 Film::set_colour_lut (int i)
915 boost::mutex::scoped_lock lm (_state_mutex);
918 signal_changed (COLOUR_LUT);
922 Film::set_j2k_bandwidth (int b)
925 boost::mutex::scoped_lock lm (_state_mutex);
928 signal_changed (J2K_BANDWIDTH);
932 Film::set_dci_metadata (DCIMetadata m)
935 boost::mutex::scoped_lock lm (_state_mutex);
938 signal_changed (DCI_METADATA);
943 Film::set_dcp_frame_rate (int f)
946 boost::mutex::scoped_lock lm (_state_mutex);
949 signal_changed (DCP_FRAME_RATE);
953 Film::signal_changed (Property p)
956 boost::mutex::scoped_lock lm (_state_mutex);
961 ui_signaller->emit (boost::bind (boost::ref (Changed), p));
966 Film::set_dci_date_today ()
968 _dci_date = boost::gregorian::day_clock::local_day ();
972 Film::info_path (int f) const
974 boost::filesystem::path p;
979 s << setfill('0') << f << ".md5";
983 /* info_dir() will already have added any initial bit of the path,
984 so don't call file() on this.
990 Film::j2c_path (int f, bool t) const
992 boost::filesystem::path p;
994 p /= video_state_identifier ();
998 s << setfill('0') << f << ".j2c";
1005 return file (p.string ());
1008 /** Make an educated guess as to whether we have a complete DCP
1010 * @return true if we do.
1014 Film::have_dcp () const
1017 libdcp::DCP dcp (dir (dcp_name()));
1026 shared_ptr<Playlist>
1027 Film::playlist () const
1029 boost::mutex::scoped_lock lm (_state_mutex);
1030 return shared_ptr<Playlist> (new Playlist (shared_from_this (), _content));
1034 Film::add_content (shared_ptr<Content> c)
1037 boost::mutex::scoped_lock lm (_state_mutex);
1038 _content.push_back (c);
1041 signal_changed (CONTENT);
1043 examine_content (c);