/*
- Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2012-2013 Carl Hetherington <cth@carlh.net>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
#include <boost/algorithm/string.hpp>
#include <boost/lexical_cast.hpp>
#include <boost/date_time.hpp>
+#include <libxml++/libxml++.h>
+#include <libcxml/cxml.h>
#include "film.h"
-#include "format.h"
-#include "imagemagick_encoder.h"
#include "job.h"
-#include "filter.h"
-#include "transcoder.h"
#include "util.h"
#include "job_manager.h"
-#include "ab_transcode_job.h"
#include "transcode_job.h"
#include "scp_dcp_job.h"
-#include "copy_from_dvd_job.h"
-#include "make_dcp_job.h"
#include "log.h"
-#include "options.h"
#include "exceptions.h"
#include "examine_content_job.h"
#include "scaler.h"
-#include "decoder_factory.h"
#include "config.h"
-#include "check_hashes_job.h"
#include "version.h"
#include "ui_signaller.h"
+#include "playlist.h"
+#include "player.h"
+#include "dcp_content_type.h"
+#include "ratio.h"
+#include "cross.h"
+
+#include "i18n.h"
using std::string;
using std::stringstream;
using std::setfill;
using std::min;
using std::make_pair;
+using std::endl;
+using std::cout;
+using std::list;
using boost::shared_ptr;
+using boost::weak_ptr;
using boost::lexical_cast;
+using boost::dynamic_pointer_cast;
using boost::to_upper_copy;
using boost::ends_with;
using boost::starts_with;
+using boost::optional;
+using libdcp::Size;
+
+int const Film::state_version = 4;
-/** Construct a Film object in a given directory, reading any metadata
- * file that exists in that directory. An exception will be thrown if
- * must_exist is true and the specified directory does not exist.
+/** Construct a Film object in a given directory.
*
* @param d Film directory.
- * @param must_exist true to throw an exception if does not exist.
*/
-Film::Film (string d, bool must_exist)
- : _use_dci_name (false)
- , _dcp_content_type (0)
- , _format (0)
+Film::Film (string d)
+ : _playlist (new Playlist)
+ , _use_dci_name (true)
+ , _dcp_content_type (Config::instance()->default_dcp_content_type ())
+ , _container (Config::instance()->default_container ())
+ , _resolution (RESOLUTION_2K)
, _scaler (Scaler::from_id ("bicubic"))
- , _dcp_trim_start (0)
- , _dcp_trim_end (0)
- , _dcp_ab (false)
- , _audio_stream (-1)
- , _audio_gain (0)
- , _audio_delay (0)
- , _still_duration (10)
- , _subtitle_stream (-1)
, _with_subtitles (false)
- , _subtitle_offset (0)
- , _subtitle_scale (1)
- , _audio_sample_rate (0)
- , _has_subtitles (false)
- , _frames_per_second (0)
+ , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
+ , _dci_metadata (Config::instance()->default_dci_metadata ())
+ , _video_frame_rate (24)
+ , _audio_channels (MAX_AUDIO_CHANNELS)
+ , _three_d (false)
+ , _sequence_video (true)
, _dirty (false)
{
+ set_dci_date_today ();
+
+ _playlist->Changed.connect (bind (&Film::playlist_changed, this));
+ _playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2));
+
/* Make state.directory a complete path without ..s (where possible)
(Code swiped from Adam Bowen on stackoverflow)
*/
}
set_directory (result.string ());
-
- if (!boost::filesystem::exists (directory())) {
- if (must_exist) {
- throw OpenFileError (directory());
- } else {
- boost::filesystem::create_directory (directory());
- }
- }
+ _log.reset (new FileLog (file ("log")));
- read_metadata ();
-
- _log = new FileLog (file ("log"));
- set_dci_date_today ();
+ _playlist->set_sequence_video (_sequence_video);
}
-Film::Film (Film const & o)
- : _log (0)
- , _directory (o._directory)
- , _name (o._name)
- , _use_dci_name (o._use_dci_name)
- , _content (o._content)
- , _dcp_content_type (o._dcp_content_type)
- , _format (o._format)
- , _crop (o._crop)
- , _filters (o._filters)
- , _scaler (o._scaler)
- , _dcp_trim_start (o._dcp_trim_start)
- , _dcp_trim_end (o._dcp_trim_end)
- , _dcp_ab (o._dcp_ab)
- , _audio_stream (o._audio_stream)
- , _audio_gain (o._audio_gain)
- , _audio_delay (o._audio_delay)
- , _still_duration (o._still_duration)
- , _subtitle_stream (o._subtitle_stream)
- , _with_subtitles (o._with_subtitles)
- , _subtitle_offset (o._subtitle_offset)
- , _subtitle_scale (o._subtitle_scale)
- , _audio_language (o._audio_language)
- , _subtitle_language (o._subtitle_language)
- , _territory (o._territory)
- , _rating (o._rating)
- , _studio (o._studio)
- , _facility (o._facility)
- , _package_type (o._package_type)
- , _thumbs (o._thumbs)
- , _size (o._size)
- , _length (o._length)
- , _audio_sample_rate (o._audio_sample_rate)
- , _content_digest (o._content_digest)
- , _has_subtitles (o._has_subtitles)
- , _audio_streams (o._audio_streams)
- , _subtitle_streams (o._subtitle_streams)
- , _frames_per_second (o._frames_per_second)
- , _dirty (o._dirty)
+string
+Film::video_identifier () const
{
+ assert (container ());
+ LocaleGuard lg;
-}
+ stringstream s;
+ s << container()->id()
+ << "_" << resolution_to_string (_resolution)
+ << "_" << _playlist->video_identifier()
+ << "_" << _video_frame_rate
+ << "_" << scaler()->id()
+ << "_" << j2k_bandwidth();
-Film::~Film ()
-{
- delete _log;
+ if (_three_d) {
+ s << "_3D";
+ }
+
+ return s.str ();
}
-/** @return The path to the directory to write JPEG2000 files to */
+/** @return The path to the directory to write video frame info files to */
string
-Film::j2k_dir () const
+Film::info_dir () const
{
- assert (format());
-
boost::filesystem::path p;
+ p /= "info";
+ p /= video_identifier ();
+ return dir (p.string());
+}
- /* Start with j2c */
- p /= "j2c";
+string
+Film::internal_video_mxf_dir () const
+{
+ return dir ("video");
+}
- pair<string, string> f = Filter::ffmpeg_strings (filters());
+string
+Film::internal_video_mxf_filename () const
+{
+ return video_identifier() + ".mxf";
+}
- /* Write stuff to specify the filter / post-processing settings that are in use,
- so that we don't get confused about J2K files generated using different
- settings.
- */
- stringstream s;
- s << format()->id()
- << "_" << content_digest()
- << "_" << crop().left << "_" << crop().right << "_" << crop().top << "_" << crop().bottom
- << "_" << f.first << "_" << f.second
- << "_" << scaler()->id();
-
- p /= s.str ();
-
- /* Similarly for the A/B case */
- if (dcp_ab()) {
- stringstream s;
- pair<string, string> fa = Filter::ffmpeg_strings (Config::instance()->reference_filters());
- s << "ab_" << Config::instance()->reference_scaler()->id() << "_" << fa.first << "_" << fa.second;
- p /= s.str ();
+string
+Film::video_mxf_filename () const
+{
+ return filename_safe_name() + "_video.mxf";
+}
+
+string
+Film::audio_mxf_filename () const
+{
+ return filename_safe_name() + "_audio.mxf";
+}
+
+string
+Film::filename_safe_name () const
+{
+ string const n = name ();
+ string o;
+ for (size_t i = 0; i < n.length(); ++i) {
+ if (isalnum (n[i])) {
+ o += n[i];
+ } else {
+ o += "_";
+ }
}
-
- return dir (p.string());
+
+ return o;
}
-/** Add suitable Jobs to the JobManager to create a DCP for this Film.
- * @param true to transcode, false to use the WAV and J2K files that are already there.
- */
+boost::filesystem::path
+Film::audio_analysis_path (shared_ptr<const AudioContent> c) const
+{
+ boost::filesystem::path p = dir ("analysis");
+ p /= c->digest();
+ return p;
+}
+
+/** Add suitable Jobs to the JobManager to create a DCP for this Film */
void
-Film::make_dcp (bool transcode)
+Film::make_dcp ()
{
set_dci_date_today ();
if (dcp_name().find ("/") != string::npos) {
- throw BadSettingError ("name", "cannot contain slashes");
+ throw BadSettingError (_("name"), _("cannot contain slashes"));
}
- log()->log (String::compose ("DVD-o-matic %1 git %2 using %3", dvdomatic_version, dvdomatic_git_commit, dependency_version_summary()));
+ log()->log (String::compose ("DCP-o-matic %1 git %2 using %3", dcpomatic_version, dcpomatic_git_commit, dependency_version_summary()));
{
char buffer[128];
gethostname (buffer, sizeof (buffer));
log()->log (String::compose ("Starting to make DCP on %1", buffer));
}
-
- if (format() == 0) {
- throw MissingSettingError ("format");
- }
- if (content().empty ()) {
- throw MissingSettingError ("content");
+ ContentList cl = content ();
+ for (ContentList::const_iterator i = cl.begin(); i != cl.end(); ++i) {
+ log()->log (String::compose ("Content: %1", (*i)->technical_summary()));
}
-
- if (dcp_content_type() == 0) {
- throw MissingSettingError ("content type");
- }
-
- if (name().empty()) {
- throw MissingSettingError ("name");
+ log()->log (String::compose ("DCP video rate %1 fps", video_frame_rate()));
+ log()->log (String::compose ("%1 threads", Config::instance()->num_local_encoding_threads()));
+ log()->log (String::compose ("J2K bandwidth %1", j2k_bandwidth()));
+#ifdef DCPOMATIC_DEBUG
+ log()->log ("DCP-o-matic built in debug mode.");
+#else
+ log()->log ("DCP-o-matic built in optimised mode.");
+#endif
+#ifdef LIBDCP_DEBUG
+ log()->log ("libdcp built in debug mode.");
+#else
+ log()->log ("libdcp built in optimised mode.");
+#endif
+ log()->log (String::compose ("CPU: %1, %2 processors", cpu_info(), boost::thread::hardware_concurrency ()));
+ list<pair<string, string> > const m = mount_info ();
+ for (list<pair<string, string> >::const_iterator i = m.begin(); i != m.end(); ++i) {
+ log()->log (String::compose ("Mount: %1 %2", i->first, i->second));
}
-
- shared_ptr<Options> o (new Options (j2k_dir(), ".j2c", dir ("wavs")));
- o->out_size = format()->dcp_size ();
- o->padding = format()->dcp_padding (shared_from_this ());
- o->ratio = format()->ratio_as_float (shared_from_this ());
- if (dcp_length ()) {
- o->video_decode_range = make_pair (dcp_trim_start(), dcp_trim_start() + dcp_length().get());
- o->audio_decode_range = make_pair (
- video_frames_to_audio_frames (o->video_decode_range.get().first, audio_sample_rate(), frames_per_second()),
- video_frames_to_audio_frames (o->video_decode_range.get().second, audio_sample_rate(), frames_per_second())
- );
-
+
+ if (container() == 0) {
+ throw MissingSettingError (_("container"));
}
- o->decode_subtitles = with_subtitles ();
- o->decode_video_skip = dcp_frame_rate (frames_per_second()).skip;
- shared_ptr<Job> r;
-
- if (transcode) {
- if (dcp_ab()) {
- r = JobManager::instance()->add (shared_ptr<Job> (new ABTranscodeJob (shared_from_this(), o, shared_ptr<Job> ())));
- } else {
- r = JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this(), o, shared_ptr<Job> ())));
- }
+ if (content().empty()) {
+ throw StringError (_("You must add some content to the DCP before creating it"));
}
- r = JobManager::instance()->add (shared_ptr<Job> (new CheckHashesJob (shared_from_this(), o, r)));
- JobManager::instance()->add (shared_ptr<Job> (new MakeDCPJob (shared_from_this(), o, r)));
-}
-
-/** Start a job to examine our content file */
-void
-Film::examine_content ()
-{
- if (_examine_content_job) {
- return;
+ if (dcp_content_type() == 0) {
+ throw MissingSettingError (_("content type"));
}
- set_thumbs (vector<SourceFrame> ());
- boost::filesystem::remove_all (dir ("thumbs"));
-
- /* This call will recreate the directory */
- dir ("thumbs");
-
- _examine_content_job.reset (new ExamineContentJob (shared_from_this(), shared_ptr<Job> ()));
- _examine_content_job->Finished.connect (bind (&Film::examine_content_finished, this));
- JobManager::instance()->add (_examine_content_job);
-}
-
-void
-Film::examine_content_finished ()
-{
- _examine_content_job.reset ();
-}
-
-/** @return full paths to any audio files that this Film has */
-vector<string>
-Film::audio_files () const
-{
- vector<string> f;
- for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (dir("wavs")); i != boost::filesystem::directory_iterator(); ++i) {
- f.push_back (i->path().string ());
+ if (name().empty()) {
+ throw MissingSettingError (_("name"));
}
- return f;
+ JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
}
/** Start a job to send our DCP to the configured TMS */
void
Film::send_dcp_to_tms ()
{
- shared_ptr<Job> j (new SCPDCPJob (shared_from_this(), shared_ptr<Job> ()));
- JobManager::instance()->add (j);
-}
-
-void
-Film::copy_from_dvd ()
-{
- shared_ptr<Job> j (new CopyFromDVDJob (shared_from_this(), shared_ptr<Job> ()));
+ shared_ptr<Job> j (new SCPDCPJob (shared_from_this()));
JobManager::instance()->add (j);
}
int
Film::encoded_frames () const
{
- if (format() == 0) {
+ if (container() == 0) {
return 0;
}
int N = 0;
- for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (j2k_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
+ for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (info_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
++N;
boost::this_thread::interruption_point ();
}
return N;
}
-/** Return the filename of a subtitle image if one exists for a given thumb index.
- * @param Thumbnail index.
- * @return Position of the image within the source frame, and the image filename, if one exists.
- * Otherwise the filename will be empty.
- */
-pair<Position, string>
-Film::thumb_subtitle (int n) const
-{
- string sub_file = thumb_base(n) + ".sub";
- if (!boost::filesystem::exists (sub_file)) {
- return pair<Position, string> ();
- }
-
- pair<Position, string> sub;
-
- ifstream f (sub_file.c_str ());
- multimap<string, string> kv = read_key_value (f);
- for (map<string, string>::const_iterator i = kv.begin(); i != kv.end(); ++i) {
- if (i->first == "x") {
- sub.first.x = lexical_cast<int> (i->second);
- } else if (i->first == "y") {
- sub.first.y = lexical_cast<int> (i->second);
- sub.second = String::compose ("%1.sub.png", thumb_base(n));
- }
- }
-
- return sub;
-}
-
/** Write state to our `metadata' file */
void
Film::write_metadata () const
{
+ if (!boost::filesystem::exists (directory())) {
+ boost::filesystem::create_directory (directory());
+ }
+
boost::mutex::scoped_lock lm (_state_mutex);
+ LocaleGuard lg;
boost::filesystem::create_directories (directory());
- string const m = file ("metadata");
- ofstream f (m.c_str ());
- if (!f.good ()) {
- throw CreateFileError (m);
- }
+ xmlpp::Document doc;
+ xmlpp::Element* root = doc.create_root_node ("Metadata");
+
+ root->add_child("Version")->add_child_text (lexical_cast<string> (state_version));
+ root->add_child("Name")->add_child_text (_name);
+ root->add_child("UseDCIName")->add_child_text (_use_dci_name ? "1" : "0");
- /* User stuff */
- f << "name " << _name << "\n";
- f << "use_dci_name " << _use_dci_name << "\n";
- f << "content " << _content << "\n";
if (_dcp_content_type) {
- f << "dcp_content_type " << _dcp_content_type->pretty_name () << "\n";
- }
- if (_format) {
- f << "format " << _format->as_metadata () << "\n";
- }
- f << "left_crop " << _crop.left << "\n";
- f << "right_crop " << _crop.right << "\n";
- f << "top_crop " << _crop.top << "\n";
- f << "bottom_crop " << _crop.bottom << "\n";
- for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
- f << "filter " << (*i)->id () << "\n";
- }
- f << "scaler " << _scaler->id () << "\n";
- f << "dcp_trim_start " << _dcp_trim_start << "\n";
- f << "dcp_trim_end " << _dcp_trim_end << "\n";
- f << "dcp_ab " << (_dcp_ab ? "1" : "0") << "\n";
- f << "selected_audio_stream " << _audio_stream << "\n";
- f << "audio_gain " << _audio_gain << "\n";
- f << "audio_delay " << _audio_delay << "\n";
- f << "still_duration " << _still_duration << "\n";
- f << "selected_subtitle_stream " << _subtitle_stream << "\n";
- f << "with_subtitles " << _with_subtitles << "\n";
- f << "subtitle_offset " << _subtitle_offset << "\n";
- f << "subtitle_scale " << _subtitle_scale << "\n";
- f << "audio_language " << _audio_language << "\n";
- f << "subtitle_language " << _subtitle_language << "\n";
- f << "territory " << _territory << "\n";
- f << "rating " << _rating << "\n";
- f << "studio " << _studio << "\n";
- f << "facility " << _facility << "\n";
- f << "package_type " << _package_type << "\n";
-
- /* Cached stuff; this is information about our content; we could
- look it up each time, but that's slow.
- */
- for (vector<SourceFrame>::const_iterator i = _thumbs.begin(); i != _thumbs.end(); ++i) {
- f << "thumb " << *i << "\n";
- }
- f << "width " << _size.width << "\n";
- f << "height " << _size.height << "\n";
- f << "length " << _length.get_value_or(0) << "\n";
- f << "audio_sample_rate " << _audio_sample_rate << "\n";
- f << "content_digest " << _content_digest << "\n";
- f << "has_subtitles " << _has_subtitles << "\n";
-
- for (vector<AudioStream>::const_iterator i = _audio_streams.begin(); i != _audio_streams.end(); ++i) {
- f << "audio_stream " << i->to_string () << "\n";
+ root->add_child("DCPContentType")->add_child_text (_dcp_content_type->dci_name ());
}
- for (vector<SubtitleStream>::const_iterator i = _subtitle_streams.begin(); i != _subtitle_streams.end(); ++i) {
- f << "subtitle_stream " << i->to_string () << "\n";
+ if (_container) {
+ root->add_child("Container")->add_child_text (_container->id ());
}
- f << "frames_per_second " << _frames_per_second << "\n";
+ root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
+ root->add_child("Scaler")->add_child_text (_scaler->id ());
+ root->add_child("WithSubtitles")->add_child_text (_with_subtitles ? "1" : "0");
+ root->add_child("J2KBandwidth")->add_child_text (lexical_cast<string> (_j2k_bandwidth));
+ _dci_metadata.as_xml (root->add_child ("DCIMetadata"));
+ root->add_child("VideoFrameRate")->add_child_text (lexical_cast<string> (_video_frame_rate));
+ root->add_child("DCIDate")->add_child_text (boost::gregorian::to_iso_string (_dci_date));
+ root->add_child("AudioChannels")->add_child_text (lexical_cast<string> (_audio_channels));
+ root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
+ root->add_child("SequenceVideo")->add_child_text (_sequence_video ? "1" : "0");
+ _playlist->as_xml (root->add_child ("Playlist"));
+
+ doc.write_to_file_formatted (file ("metadata.xml"));
_dirty = false;
}
Film::read_metadata ()
{
boost::mutex::scoped_lock lm (_state_mutex);
-
- ifstream f (file ("metadata").c_str());
- multimap<string, string> kv = read_key_value (f);
- for (multimap<string, string>::const_iterator i = kv.begin(); i != kv.end(); ++i) {
- string const k = i->first;
- string const v = i->second;
-
- /* User-specified stuff */
- if (k == "name") {
- _name = v;
- } else if (k == "use_dci_name") {
- _use_dci_name = (v == "1");
- } else if (k == "content") {
- _content = v;
- } else if (k == "dcp_content_type") {
- _dcp_content_type = DCPContentType::from_pretty_name (v);
- } else if (k == "format") {
- _format = Format::from_metadata (v);
- } else if (k == "left_crop") {
- _crop.left = atoi (v.c_str ());
- } else if (k == "right_crop") {
- _crop.right = atoi (v.c_str ());
- } else if (k == "top_crop") {
- _crop.top = atoi (v.c_str ());
- } else if (k == "bottom_crop") {
- _crop.bottom = atoi (v.c_str ());
- } else if (k == "filter") {
- _filters.push_back (Filter::from_id (v));
- } else if (k == "scaler") {
- _scaler = Scaler::from_id (v);
- } else if (k == "dcp_trim_start") {
- _dcp_trim_start = atoi (v.c_str ());
- } else if (k == "dcp_trim_end") {
- _dcp_trim_end = atoi (v.c_str ());
- } else if (k == "dcp_ab") {
- _dcp_ab = (v == "1");
- } else if (k == "selected_audio_stream") {
- _audio_stream = atoi (v.c_str ());
- } else if (k == "audio_gain") {
- _audio_gain = atof (v.c_str ());
- } else if (k == "audio_delay") {
- _audio_delay = atoi (v.c_str ());
- } else if (k == "still_duration") {
- _still_duration = atoi (v.c_str ());
- } else if (k == "selected_subtitle_stream") {
- _subtitle_stream = atoi (v.c_str ());
- } else if (k == "with_subtitles") {
- _with_subtitles = (v == "1");
- } else if (k == "subtitle_offset") {
- _subtitle_offset = atoi (v.c_str ());
- } else if (k == "subtitle_scale") {
- _subtitle_scale = atof (v.c_str ());
- } else if (k == "audio_language") {
- _audio_language = v;
- } else if (k == "subtitle_language") {
- _subtitle_language = v;
- } else if (k == "territory") {
- _territory = v;
- } else if (k == "rating") {
- _rating = v;
- } else if (k == "studio") {
- _studio = v;
- } else if (k == "facility") {
- _facility = v;
- } else if (k == "package_type") {
- _package_type = v;
- }
-
- /* Cached stuff */
- if (k == "thumb") {
- int const n = atoi (v.c_str ());
- /* Only add it to the list if it still exists */
- if (boost::filesystem::exists (thumb_file_for_frame (n))) {
- _thumbs.push_back (n);
- }
- } else if (k == "width") {
- _size.width = atoi (v.c_str ());
- } else if (k == "height") {
- _size.height = atoi (v.c_str ());
- } else if (k == "length") {
- int const vv = atoi (v.c_str ());
- if (vv) {
- _length = vv;
- }
- } else if (k == "audio_sample_rate") {
- _audio_sample_rate = atoi (v.c_str ());
- } else if (k == "content_digest") {
- _content_digest = v;
- } else if (k == "has_subtitles") {
- _has_subtitles = (v == "1");
- } else if (k == "audio_stream") {
- _audio_streams.push_back (AudioStream (v));
- } else if (k == "subtitle_stream") {
- _subtitle_streams.push_back (SubtitleStream (v));
- } else if (k == "frames_per_second") {
- _frames_per_second = atof (v.c_str ());
- }
+ LocaleGuard lg;
+
+ if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
+ 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!"));
}
-
- _dirty = false;
-}
-/** @param n A thumb index.
- * @return The path to the thumb's image file.
- */
-string
-Film::thumb_file (int n) const
-{
- return thumb_file_for_frame (thumb_frame (n));
-}
+ cxml::File f (file ("metadata.xml"), "Metadata");
+
+ _name = f.string_child ("Name");
+ _use_dci_name = f.bool_child ("UseDCIName");
-/** @param n A frame index within the Film's source.
- * @return The path to the thumb's image file for this frame;
- * we assume that it exists.
- */
-string
-Film::thumb_file_for_frame (SourceFrame n) const
-{
- return thumb_base_for_frame(n) + ".png";
-}
+ {
+ optional<string> c = f.optional_string_child ("DCPContentType");
+ if (c) {
+ _dcp_content_type = DCPContentType::from_dci_name (c.get ());
+ }
+ }
-/** @param n Thumb index.
- * Must not be called with the _state_mutex locked.
- */
-string
-Film::thumb_base (int n) const
-{
- return thumb_base_for_frame (thumb_frame (n));
-}
+ {
+ optional<string> c = f.optional_string_child ("Container");
+ if (c) {
+ _container = Ratio::from_id (c.get ());
+ }
+ }
-string
-Film::thumb_base_for_frame (SourceFrame n) const
-{
- stringstream s;
- s.width (8);
- s << setfill('0') << n;
-
- boost::filesystem::path p;
- p /= dir ("thumbs");
- p /= s.str ();
-
- return p.string ();
-}
+ _resolution = string_to_resolution (f.string_child ("Resolution"));
+ _scaler = Scaler::from_id (f.string_child ("Scaler"));
+ _with_subtitles = f.bool_child ("WithSubtitles");
+ _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
+ _dci_metadata = DCIMetadata (f.node_child ("DCIMetadata"));
+ _video_frame_rate = f.number_child<int> ("VideoFrameRate");
+ _dci_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
+ _audio_channels = f.number_child<int> ("AudioChannels");
+ _sequence_video = f.bool_child ("SequenceVideo");
+ _three_d = f.bool_child ("ThreeD");
-/** @param n A thumb index.
- * @return The frame within the Film's source that it is for.
- *
- * Must not be called with the _state_mutex locked.
- */
-SourceFrame
-Film::thumb_frame (int n) const
-{
- boost::mutex::scoped_lock lm (_state_mutex);
- assert (n < int (_thumbs.size ()));
- return _thumbs[n];
-}
+ _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"));
-Size
-Film::cropped_size (Size s) const
-{
- boost::mutex::scoped_lock lm (_state_mutex);
- s.width -= _crop.left + _crop.right;
- s.height -= _crop.top + _crop.bottom;
- return s;
+ _dirty = false;
}
/** Given a directory name, return its full path within the Film's directory.
Film::dir (string d) const
{
boost::mutex::scoped_lock lm (_directory_mutex);
+
boost::filesystem::path p;
p /= _directory;
p /= d;
+
boost::filesystem::create_directories (p);
+
return p.string ();
}
/** Given a file or directory name, return its full path within the Film's directory.
* _directory_mutex must not be locked on entry.
+ * Any required parent directories will be created.
*/
string
Film::file (string f) const
{
boost::mutex::scoped_lock lm (_directory_mutex);
+
boost::filesystem::path p;
p /= _directory;
p /= f;
- return p.string ();
-}
-/** @return full path of the content (actual video) file
- * of the Film.
- */
-string
-Film::content_path () const
-{
- boost::mutex::scoped_lock lm (_state_mutex);
- if (boost::filesystem::path(_content).has_root_directory ()) {
- return _content;
- }
-
- return file (_content);
-}
-
-ContentType
-Film::content_type () const
-{
-#if BOOST_FILESYSTEM_VERSION == 3
- string ext = boost::filesystem::path(_content).extension().string();
-#else
- string ext = boost::filesystem::path(_content).extension();
-#endif
-
- transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
+ boost::filesystem::create_directories (p.parent_path ());
- if (ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" || ext == ".png") {
- return STILL;
- }
-
- return VIDEO;
-}
-
-/** @return The sampling rate that we will resample the audio to */
-int
-Film::target_audio_sample_rate () const
-{
- /* Resample to a DCI-approved sample rate */
- double t = dcp_audio_sample_rate (audio_sample_rate());
-
- DCPFrameRate dfr = dcp_frame_rate (frames_per_second ());
-
- /* Compensate for the fact that video will be rounded to the
- nearest integer number of frames per second.
- */
- if (dfr.run_fast) {
- t *= _frames_per_second * dfr.skip / dfr.frames_per_second;
- }
-
- return rint (t);
-}
-
-boost::optional<SourceFrame>
-Film::dcp_length () const
-{
- if (!length()) {
- return boost::optional<SourceFrame> ();
- }
-
- return length().get() - dcp_trim_start() - dcp_trim_end();
+ return p.string ();
}
/** @return a DCI-compliant name for a DCP of this film */
string
-Film::dci_name () const
+Film::dci_name (bool if_created_now) const
{
- boost::mutex::scoped_lock lm (_state_mutex);
-
stringstream d;
- string fixed_name = to_upper_copy (_name);
+ string fixed_name = to_upper_copy (name());
for (size_t i = 0; i < fixed_name.length(); ++i) {
if (fixed_name[i] == ' ') {
fixed_name[i] = '-';
fixed_name = fixed_name.substr (0, 14);
}
- d << fixed_name << "_";
+ d << fixed_name;
- if (_dcp_content_type) {
- d << _dcp_content_type->dci_name() << "_";
+ if (dcp_content_type()) {
+ d << "_" << dcp_content_type()->dci_name();
+ }
+
+ if (three_d ()) {
+ d << "-3D";
}
- if (_format) {
- d << _format->dci_name() << "_";
+ if (video_frame_rate() != 24) {
+ d << "-" << video_frame_rate();
}
- if (!_audio_language.empty ()) {
- d << _audio_language;
- if (!_subtitle_language.empty() && _with_subtitles) {
- d << "-" << _subtitle_language;
+ if (container()) {
+ d << "_" << container()->dci_name();
+ }
+
+ DCIMetadata const dm = dci_metadata ();
+
+ if (!dm.audio_language.empty ()) {
+ d << "_" << dm.audio_language;
+ if (!dm.subtitle_language.empty() && with_subtitles()) {
+ d << "-" << dm.subtitle_language;
} else {
d << "-XX";
}
-
- d << "_";
}
- if (!_territory.empty ()) {
- d << _territory;
- if (!_rating.empty ()) {
- d << "-" << _rating;
+ if (!dm.territory.empty ()) {
+ d << "_" << dm.territory;
+ if (!dm.rating.empty ()) {
+ d << "-" << dm.rating;
}
- d << "_";
}
- if (_audio_stream != -1) {
- switch (_audio_streams[_audio_stream].channels()) {
- case 1:
- d << "10_";
- break;
- case 2:
- d << "20_";
- break;
- case 6:
- d << "51_";
- break;
- case 8:
- d << "71_";
- break;
- }
+ switch (audio_channels ()) {
+ case 1:
+ d << "_10";
+ break;
+ case 2:
+ d << "_20";
+ break;
+ case 3:
+ d << "_30";
+ break;
+ case 4:
+ d << "_40";
+ break;
+ case 5:
+ d << "_50";
+ break;
+ case 6:
+ d << "_51";
+ break;
}
- d << "2K_";
+ d << "_" << resolution_to_string (_resolution);
- if (!_studio.empty ()) {
- d << _studio << "_";
+ if (!dm.studio.empty ()) {
+ d << "_" << dm.studio;
}
- d << boost::gregorian::to_iso_string (_dci_date) << "_";
+ if (if_created_now) {
+ d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
+ } else {
+ d << "_" << boost::gregorian::to_iso_string (_dci_date);
+ }
- if (!_facility.empty ()) {
- d << _facility << "_";
+ if (!dm.facility.empty ()) {
+ d << "_" << dm.facility;
}
- if (!_package_type.empty ()) {
- d << _package_type;
+ if (!dm.package_type.empty ()) {
+ d << "_" << dm.package_type;
}
return d.str ();
/** @return name to give the DCP */
string
-Film::dcp_name () const
+Film::dcp_name (bool if_created_now) const
{
if (use_dci_name()) {
- return dci_name ();
+ return dci_name (if_created_now);
}
return name();
signal_changed (USE_DCI_NAME);
}
-void
-Film::set_content (string c)
-{
- string check = directory ();
-
-#if BOOST_FILESYSTEM_VERSION == 3
- boost::filesystem::path slash ("/");
- string platform_slash = slash.make_preferred().string ();
-#else
-#ifdef DVDOMATIC_WINDOWS
- string platform_slash = "\\";
-#else
- string platform_slash = "/";
-#endif
-#endif
-
- if (!ends_with (check, platform_slash)) {
- check += platform_slash;
- }
-
- if (boost::filesystem::path(c).has_root_directory () && starts_with (c, check)) {
- c = c.substr (_directory.length() + 1);
- }
-
- string old_content;
-
- {
- boost::mutex::scoped_lock lm (_state_mutex);
- if (c == _content) {
- return;
- }
-
- old_content = _content;
- _content = c;
- }
-
- /* Create a temporary decoder so that we can get information
- about the content.
- */
-
- try {
- shared_ptr<Options> o (new Options ("", "", ""));
- o->out_size = Size (1024, 1024);
-
- shared_ptr<Decoder> d = decoder_factory (shared_from_this(), o, 0);
-
- set_size (d->native_size ());
- set_frames_per_second (d->frames_per_second ());
- set_audio_sample_rate (d->audio_sample_rate ());
- set_has_subtitles (d->has_subtitles ());
- set_audio_streams (d->audio_streams ());
- set_subtitle_streams (d->subtitle_streams ());
- set_audio_stream (audio_streams().empty() ? -1 : 0);
- set_subtitle_stream (subtitle_streams().empty() ? -1 : 0);
-
- {
- boost::mutex::scoped_lock lm (_state_mutex);
- _content = c;
- }
-
- signal_changed (CONTENT);
-
- set_content_digest (md5_digest (content_path ()));
-
- examine_content ();
-
- } catch (...) {
-
- boost::mutex::scoped_lock lm (_state_mutex);
- _content = old_content;
- throw;
-
- }
-}
-
void
Film::set_dcp_content_type (DCPContentType const * t)
{
}
void
-Film::set_format (Format const * f)
+Film::set_container (Ratio const * c)
{
{
boost::mutex::scoped_lock lm (_state_mutex);
- _format = f;
+ _container = c;
}
- signal_changed (FORMAT);
+ signal_changed (CONTAINER);
}
void
-Film::set_crop (Crop c)
+Film::set_resolution (Resolution r)
{
{
boost::mutex::scoped_lock lm (_state_mutex);
- _crop = c;
+ _resolution = r;
}
- signal_changed (CROP);
+ signal_changed (RESOLUTION);
}
void
-Film::set_left_crop (int c)
+Film::set_scaler (Scaler const * s)
{
{
boost::mutex::scoped_lock lm (_state_mutex);
-
- if (_crop.left == c) {
- return;
- }
-
- _crop.left = c;
+ _scaler = s;
}
- signal_changed (CROP);
+ signal_changed (SCALER);
}
void
-Film::set_right_crop (int c)
+Film::set_with_subtitles (bool w)
{
{
boost::mutex::scoped_lock lm (_state_mutex);
- if (_crop.right == c) {
- return;
- }
-
- _crop.right = c;
+ _with_subtitles = w;
}
- signal_changed (CROP);
+ signal_changed (WITH_SUBTITLES);
}
void
-Film::set_top_crop (int c)
+Film::set_j2k_bandwidth (int b)
{
{
boost::mutex::scoped_lock lm (_state_mutex);
- if (_crop.top == c) {
- return;
- }
-
- _crop.top = c;
+ _j2k_bandwidth = b;
}
- signal_changed (CROP);
+ signal_changed (J2K_BANDWIDTH);
}
void
-Film::set_bottom_crop (int c)
+Film::set_dci_metadata (DCIMetadata m)
{
{
boost::mutex::scoped_lock lm (_state_mutex);
- if (_crop.bottom == c) {
- return;
- }
-
- _crop.bottom = c;
+ _dci_metadata = m;
}
- signal_changed (CROP);
+ signal_changed (DCI_METADATA);
}
void
-Film::set_filters (vector<Filter const *> f)
+Film::set_video_frame_rate (int f)
{
{
boost::mutex::scoped_lock lm (_state_mutex);
- _filters = f;
+ _video_frame_rate = f;
}
- signal_changed (FILTERS);
+ signal_changed (VIDEO_FRAME_RATE);
}
void
-Film::set_scaler (Scaler const * s)
+Film::set_audio_channels (int c)
{
{
boost::mutex::scoped_lock lm (_state_mutex);
- _scaler = s;
+ _audio_channels = c;
}
- signal_changed (SCALER);
+ signal_changed (AUDIO_CHANNELS);
}
void
-Film::set_dcp_trim_start (int t)
+Film::set_three_d (bool t)
{
{
boost::mutex::scoped_lock lm (_state_mutex);
- _dcp_trim_start = t;
+ _three_d = t;
}
- signal_changed (DCP_TRIM_START);
+ signal_changed (THREE_D);
}
void
-Film::set_dcp_trim_end (int t)
+Film::signal_changed (Property p)
{
{
boost::mutex::scoped_lock lm (_state_mutex);
- _dcp_trim_end = t;
+ _dirty = true;
}
- signal_changed (DCP_TRIM_END);
-}
-void
-Film::set_dcp_ab (bool a)
-{
- {
- boost::mutex::scoped_lock lm (_state_mutex);
- _dcp_ab = a;
+ switch (p) {
+ case Film::CONTENT:
+ set_video_frame_rate (_playlist->best_dcp_frame_rate ());
+ break;
+ case Film::VIDEO_FRAME_RATE:
+ case Film::SEQUENCE_VIDEO:
+ _playlist->maybe_sequence_video ();
+ break;
+ default:
+ break;
}
- signal_changed (DCP_AB);
-}
-void
-Film::set_audio_stream (int s)
-{
- {
- boost::mutex::scoped_lock lm (_state_mutex);
- _audio_stream = s;
+ if (ui_signaller) {
+ ui_signaller->emit (boost::bind (boost::ref (Changed), p));
}
- signal_changed (AUDIO_STREAM);
}
void
-Film::set_audio_gain (float g)
+Film::set_dci_date_today ()
{
- {
- boost::mutex::scoped_lock lm (_state_mutex);
- _audio_gain = g;
- }
- signal_changed (AUDIO_GAIN);
+ _dci_date = boost::gregorian::day_clock::local_day ();
}
-void
-Film::set_audio_delay (int d)
+string
+Film::info_path (int f, Eyes e) const
{
- {
- boost::mutex::scoped_lock lm (_state_mutex);
- _audio_delay = d;
- }
- signal_changed (AUDIO_DELAY);
-}
+ boost::filesystem::path p;
+ p /= info_dir ();
-void
-Film::set_still_duration (int d)
-{
- {
- boost::mutex::scoped_lock lm (_state_mutex);
- _still_duration = d;
+ stringstream s;
+ s.width (8);
+ s << setfill('0') << f;
+
+ if (e == EYES_LEFT) {
+ s << ".L";
+ } else if (e == EYES_RIGHT) {
+ s << ".R";
}
- signal_changed (STILL_DURATION);
+
+ s << ".md5";
+
+ p /= s.str();
+
+ /* info_dir() will already have added any initial bit of the path,
+ so don't call file() on this.
+ */
+ return p.string ();
}
-void
-Film::set_subtitle_stream (int s)
+string
+Film::j2c_path (int f, Eyes e, bool t) const
{
- {
- boost::mutex::scoped_lock lm (_state_mutex);
- _subtitle_stream = s;
+ boost::filesystem::path p;
+ p /= "j2c";
+ p /= video_identifier ();
+
+ stringstream s;
+ s.width (8);
+ s << setfill('0') << f;
+
+ if (e == EYES_LEFT) {
+ s << ".L";
+ } else if (e == EYES_RIGHT) {
+ s << ".R";
}
- signal_changed (SUBTITLE_STREAM);
-}
+
+ s << ".j2c";
-void
-Film::set_with_subtitles (bool w)
-{
- {
- boost::mutex::scoped_lock lm (_state_mutex);
- _with_subtitles = w;
+ if (t) {
+ s << ".tmp";
}
- signal_changed (WITH_SUBTITLES);
+
+ p /= s.str();
+ return file (p.string ());
}
-void
-Film::set_subtitle_offset (int o)
+/** Make an educated guess as to whether we have a complete DCP
+ * or not.
+ * @return true if we do.
+ */
+
+bool
+Film::have_dcp () const
{
- {
- boost::mutex::scoped_lock lm (_state_mutex);
- _subtitle_offset = o;
+ try {
+ libdcp::DCP dcp (dir (dcp_name()));
+ dcp.read ();
+ } catch (...) {
+ return false;
}
- signal_changed (SUBTITLE_OFFSET);
+
+ return true;
}
-void
-Film::set_subtitle_scale (float s)
+shared_ptr<Player>
+Film::make_player () const
{
- {
- boost::mutex::scoped_lock lm (_state_mutex);
- _subtitle_scale = s;
- }
- signal_changed (SUBTITLE_SCALE);
+ return shared_ptr<Player> (new Player (shared_from_this (), _playlist));
}
-void
-Film::set_audio_language (string l)
+shared_ptr<Playlist>
+Film::playlist () const
{
- {
- boost::mutex::scoped_lock lm (_state_mutex);
- _audio_language = l;
- }
- signal_changed (DCI_METADATA);
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _playlist;
}
-void
-Film::set_subtitle_language (string l)
+ContentList
+Film::content () const
{
- {
- boost::mutex::scoped_lock lm (_state_mutex);
- _subtitle_language = l;
- }
- signal_changed (DCI_METADATA);
+ return _playlist->content ();
}
void
-Film::set_territory (string t)
+Film::examine_and_add_content (shared_ptr<Content> c)
{
- {
- boost::mutex::scoped_lock lm (_state_mutex);
- _territory = t;
- }
- signal_changed (DCI_METADATA);
+ shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
+ j->Finished.connect (bind (&Film::maybe_add_content, this, boost::weak_ptr<Job> (j), boost::weak_ptr<Content> (c)));
+ JobManager::instance()->add (j);
}
void
-Film::set_rating (string r)
+Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
{
- {
- boost::mutex::scoped_lock lm (_state_mutex);
- _rating = r;
+ shared_ptr<Job> job = j.lock ();
+ if (!job || !job->finished_ok ()) {
+ return;
+ }
+
+ shared_ptr<Content> content = c.lock ();
+ if (content) {
+ add_content (content);
}
- signal_changed (DCI_METADATA);
}
void
-Film::set_studio (string s)
+Film::add_content (shared_ptr<Content> c)
{
- {
- boost::mutex::scoped_lock lm (_state_mutex);
- _studio = s;
+ /* Add video content after any existing content */
+ if (dynamic_pointer_cast<VideoContent> (c)) {
+ c->set_start (_playlist->video_end ());
}
- signal_changed (DCI_METADATA);
+
+ _playlist->add (c);
}
void
-Film::set_facility (string f)
+Film::remove_content (shared_ptr<Content> c)
{
- {
- boost::mutex::scoped_lock lm (_state_mutex);
- _facility = f;
- }
- signal_changed (DCI_METADATA);
+ _playlist->remove (c);
}
-void
-Film::set_package_type (string p)
+Time
+Film::length () const
{
- {
- boost::mutex::scoped_lock lm (_state_mutex);
- _package_type = p;
- }
- signal_changed (DCI_METADATA);
+ return _playlist->length ();
}
-void
-Film::set_thumbs (vector<SourceFrame> t)
+bool
+Film::has_subtitles () const
{
- {
- boost::mutex::scoped_lock lm (_state_mutex);
- _thumbs = t;
- }
- signal_changed (THUMBS);
+ return _playlist->has_subtitles ();
}
-void
-Film::set_size (Size s)
+OutputVideoFrame
+Film::best_video_frame_rate () const
{
- {
- boost::mutex::scoped_lock lm (_state_mutex);
- _size = s;
- }
- signal_changed (SIZE);
+ return _playlist->best_dcp_frame_rate ();
}
void
-Film::set_length (SourceFrame l)
+Film::playlist_content_changed (boost::weak_ptr<Content> c, int p)
{
- {
- boost::mutex::scoped_lock lm (_state_mutex);
- _length = l;
+ if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
+ set_video_frame_rate (_playlist->best_dcp_frame_rate ());
+ }
+
+ if (ui_signaller) {
+ ui_signaller->emit (boost::bind (boost::ref (ContentChanged), c, p));
}
- signal_changed (LENGTH);
}
void
-Film::unset_length ()
+Film::playlist_changed ()
{
- {
- boost::mutex::scoped_lock lm (_state_mutex);
- _length = boost::none;
- }
- signal_changed (LENGTH);
+ signal_changed (CONTENT);
}
-void
-Film::set_audio_sample_rate (int r)
+OutputAudioFrame
+Film::time_to_audio_frames (Time t) const
{
- {
- boost::mutex::scoped_lock lm (_state_mutex);
- _audio_sample_rate = r;
- }
- signal_changed (AUDIO_SAMPLE_RATE);
+ return t * audio_frame_rate () / TIME_HZ;
}
-void
-Film::set_content_digest (string d)
+OutputVideoFrame
+Film::time_to_video_frames (Time t) const
{
- {
- boost::mutex::scoped_lock lm (_state_mutex);
- _content_digest = d;
- }
- _dirty = true;
+ return t * video_frame_rate () / TIME_HZ;
}
-void
-Film::set_has_subtitles (bool s)
+Time
+Film::audio_frames_to_time (OutputAudioFrame f) const
{
- {
- boost::mutex::scoped_lock lm (_state_mutex);
- _has_subtitles = s;
- }
- signal_changed (HAS_SUBTITLES);
+ return f * TIME_HZ / audio_frame_rate ();
}
-void
-Film::set_audio_streams (vector<AudioStream> s)
+Time
+Film::video_frames_to_time (OutputVideoFrame f) const
{
- {
- boost::mutex::scoped_lock lm (_state_mutex);
- _audio_streams = s;
- }
- _dirty = true;
+ return f * TIME_HZ / video_frame_rate ();
}
-void
-Film::set_subtitle_streams (vector<SubtitleStream> s)
+OutputAudioFrame
+Film::audio_frame_rate () const
{
- {
- boost::mutex::scoped_lock lm (_state_mutex);
- _subtitle_streams = s;
- }
- _dirty = true;
+ /* XXX */
+ return 48000;
}
void
-Film::set_frames_per_second (float f)
+Film::set_sequence_video (bool s)
{
{
boost::mutex::scoped_lock lm (_state_mutex);
- _frames_per_second = f;
+ _sequence_video = s;
+ _playlist->set_sequence_video (s);
}
- signal_changed (FRAMES_PER_SECOND);
-}
-void
-Film::signal_changed (Property p)
-{
- {
- boost::mutex::scoped_lock lm (_state_mutex);
- _dirty = true;
- }
-
- if (ui_signaller) {
- ui_signaller->emit (boost::bind (boost::ref (Changed), p));
- }
+ signal_changed (SEQUENCE_VIDEO);
}
-int
-Film::audio_channels () const
+libdcp::Size
+Film::full_frame () const
{
- boost::mutex::scoped_lock lm (_state_mutex);
- if (_audio_stream == -1) {
- return 0;
+ switch (_resolution) {
+ case RESOLUTION_2K:
+ return libdcp::Size (2048, 1080);
+ case RESOLUTION_4K:
+ return libdcp::Size (4096, 2160);
}
-
- return _audio_streams[_audio_stream].channels ();
-}
-void
-Film::set_dci_date_today ()
-{
- _dci_date = boost::gregorian::day_clock::local_day ();
+ assert (false);
+ return libdcp::Size ();
}
-