/*
- Copyright (C) 2012-2013 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2012-2014 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/filesystem.hpp>
#include <boost/algorithm/string.hpp>
#include <boost/lexical_cast.hpp>
-#include <boost/date_time.hpp>
#include <libxml++/libxml++.h>
#include <libcxml/cxml.h>
#include <dcp/signer_chain.h>
#include <dcp/cpl.h>
#include <dcp/signer.h>
#include <dcp/util.h>
-#include <dcp/kdm.h>
+#include <dcp/local_time.h>
+#include <dcp/raw_convert.h>
#include "film.h"
#include "job.h"
#include "util.h"
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 boost::is_any_of;
using dcp::Size;
using dcp::Signer;
+using dcp::raw_convert;
+using dcp::raw_convert;
+
+#define LOG_GENERAL(...) log()->log (String::compose (__VA_ARGS__), Log::TYPE_GENERAL);
+#define LOG_GENERAL_NC(...) log()->log (__VA_ARGS__, Log::TYPE_GENERAL);
/* 5 -> 6
* AudioMapping XML changed.
* Subtitle offset changed to subtitle y offset, and subtitle x offset added.
* 7 -> 8
* Use <Scale> tag in <VideoContent> rather than <Ratio>.
+ * 8 -> 9
+ * DCI -> ISDCF
+ *
+ * Bumped to 32 for 2.0 branch; some times are expressed in Times rather
+ * than frames now.
*/
-int const Film::current_state_version = 8;
+int const Film::current_state_version = 32;
/** Construct a Film object in a given directory.
*
Film::Film (boost::filesystem::path dir, bool log)
: _playlist (new Playlist)
- , _use_dci_name (true)
+ , _use_isdcf_name (true)
, _dcp_content_type (Config::instance()->default_dcp_content_type ())
, _container (Config::instance()->default_container ())
, _resolution (RESOLUTION_2K)
, _scaler (Scaler::from_id ("bicubic"))
- , _with_subtitles (false)
, _signed (true)
, _encrypted (false)
, _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
- , _dci_metadata (Config::instance()->default_dci_metadata ())
+ , _isdcf_metadata (Config::instance()->default_isdcf_metadata ())
, _video_frame_rate (24)
, _audio_channels (6)
, _three_d (false)
, _sequence_video (true)
, _interop (false)
+ , _burn_subtitles (false)
, _state_version (current_state_version)
, _dirty (false)
{
- set_dci_date_today ();
+ set_isdcf_date_today ();
_playlist->Changed.connect (bind (&Film::playlist_changed, this));
_playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2));
Film::video_identifier () const
{
assert (container ());
- LocaleGuard lg;
stringstream s;
+ s.imbue (std::locale::classic ());
+
s << container()->id()
<< "_" << resolution_to_string (_resolution)
<< "_" << _playlist->video_identifier()
s << "_S";
}
+ if (_burn_subtitles) {
+ s << "_B";
+ }
+
if (_three_d) {
s << "_3D";
}
return filename_safe_name() + "_audio.mxf";
}
+boost::filesystem::path
+Film::subtitle_xml_filename () const
+{
+ return filename_safe_name() + "_subtitle.xml";
+}
+
string
Film::filename_safe_name () const
{
}
boost::filesystem::path
-Film::audio_analysis_path (shared_ptr<const AudioContent> c) const
+Film::audio_analysis_dir () const
{
- boost::filesystem::path p = dir ("analysis");
- p /= c->digest();
- return p;
+ return dir ("analysis");
}
/** Add suitable Jobs to the JobManager to create a DCP for this Film */
void
Film::make_dcp ()
{
- set_dci_date_today ();
+ set_isdcf_date_today ();
if (dcp_name().find ("/") != string::npos) {
throw BadSettingError (_("name"), _("cannot contain slashes"));
}
-
- log()->log (String::compose ("DCP-o-matic %1 git %2 using %3", dcpomatic_version, dcpomatic_git_commit, dependency_version_summary()));
+
+ /* It seems to make sense to auto-save metadata here, since the make DCP may last
+ a long time, and crashes/power failures are moderately likely.
+ */
+ write_metadata ();
+
+ LOG_GENERAL ("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));
+ LOG_GENERAL ("Starting to make DCP on %1", buffer);
}
ContentList cl = content ();
for (ContentList::const_iterator i = cl.begin(); i != cl.end(); ++i) {
- log()->log (String::compose ("Content: %1", (*i)->technical_summary()));
+ LOG_GENERAL ("Content: %1", (*i)->technical_summary());
}
- 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()));
+ LOG_GENERAL ("DCP video rate %1 fps", video_frame_rate());
+ LOG_GENERAL ("%1 threads", Config::instance()->num_local_encoding_threads());
+ LOG_GENERAL ("J2K bandwidth %1", j2k_bandwidth());
#ifdef DCPOMATIC_DEBUG
- log()->log ("DCP-o-matic built in debug mode.");
+ LOG_GENERAL_NC ("DCP-o-matic built in debug mode.");
#else
- log()->log ("DCP-o-matic built in optimised mode.");
+ LOG_GENERAL_NC ("DCP-o-matic built in optimised mode.");
#endif
#ifdef LIBDCP_DEBUG
- log()->log ("libdcp built in debug mode.");
+ LOG_GENERAL_NC ("libdcp built in debug mode.");
#else
- log()->log ("libdcp built in optimised mode.");
+ LOG_GENERAL_NC ("libdcp built in optimised mode.");
#endif
#ifdef DCPOMATIC_WINDOWS
OSVERSIONINFO info;
info.dwOSVersionInfoSize = sizeof (info);
GetVersionEx (&info);
- log()->log (String::compose ("Windows version %1.%2.%3 SP %4", info.dwMajorVersion, info.dwMinorVersion, info.dwBuildNumber, info.szCSDVersion));
+ LOG_GENERAL ("Windows version %1.%2.%3 SP %4", info.dwMajorVersion, info.dwMinorVersion, info.dwBuildNumber, info.szCSDVersion);
#endif
- log()->log (String::compose ("CPU: %1, %2 processors", cpu_info(), boost::thread::hardware_concurrency ()));
+ LOG_GENERAL ("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));
+ LOG_GENERAL ("Mount: %1 %2", i->first, i->second);
}
if (container() == 0) {
shared_ptr<xmlpp::Document>
Film::metadata () const
{
- LocaleGuard lg;
-
shared_ptr<xmlpp::Document> doc (new xmlpp::Document);
xmlpp::Element* root = doc->create_root_node ("Metadata");
- root->add_child("Version")->add_child_text (lexical_cast<string> (current_state_version));
+ root->add_child("Version")->add_child_text (raw_convert<string> (current_state_version));
root->add_child("Name")->add_child_text (_name);
- root->add_child("UseDCIName")->add_child_text (_use_dci_name ? "1" : "0");
+ root->add_child("UseISDCFName")->add_child_text (_use_isdcf_name ? "1" : "0");
if (_dcp_content_type) {
- root->add_child("DCPContentType")->add_child_text (_dcp_content_type->dci_name ());
+ root->add_child("DCPContentType")->add_child_text (_dcp_content_type->isdcf_name ());
}
if (_container) {
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("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
+ _isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
+ root->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
+ root->add_child("ISDCFDate")->add_child_text (boost::gregorian::to_iso_string (_isdcf_date));
+ root->add_child("AudioChannels")->add_child_text (raw_convert<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");
root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
+ root->add_child("BurnSubtitles")->add_child_text (_burn_subtitles ? "1" : "0");
root->add_child("Signed")->add_child_text (_signed ? "1" : "0");
root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
root->add_child("Key")->add_child_text (_key.hex ());
_dirty = false;
}
-/** Read state from our metadata file */
-void
+/** Read state from our metadata file.
+ * @return Notes about things that the user should know about, or empty.
+ */
+list<string>
Film::read_metadata ()
{
- 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!"));
}
}
_name = f.string_child ("Name");
- _use_dci_name = f.bool_child ("UseDCIName");
+ if (_state_version >= 9) {
+ _use_isdcf_name = f.bool_child ("UseISDCFName");
+ _isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
+ _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("ISDCFDate"));
+ } else {
+ _use_isdcf_name = f.bool_child ("UseDCIName");
+ _isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
+ _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
+ }
{
optional<string> c = f.optional_string_child ("DCPContentType");
if (c) {
- _dcp_content_type = DCPContentType::from_dci_name (c.get ());
+ _dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
}
}
_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"));
_signed = f.optional_bool_child("Signed").get_value_or (true);
_encrypted = f.bool_child ("Encrypted");
_audio_channels = f.number_child<int> ("AudioChannels");
_sequence_video = f.bool_child ("SequenceVideo");
_three_d = f.bool_child ("ThreeD");
_interop = f.bool_child ("Interop");
+ if (_state_version >= 32) {
+ _burn_subtitles = f.bool_child ("BurnSubtitles");
+ }
_key = dcp::Key (f.string_child ("Key"));
- _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version);
+
+ list<string> notes;
+ /* This method is the only one that can return notes (so far) */
+ _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
_dirty = false;
+ return notes;
}
/** Given a directory name, return its full path within the Film's directory.
return p;
}
-/** @return a DCI-compliant name for a DCP of this film */
+/** @return a ISDCF-compliant name for a DCP of this film */
string
-Film::dci_name (bool if_created_now) const
+Film::isdcf_name (bool if_created_now) const
{
stringstream d;
- string fixed_name = to_upper_copy (name());
- for (size_t i = 0; i < fixed_name.length(); ++i) {
- if (fixed_name[i] == ' ') {
- fixed_name[i] = '-';
+ string raw_name = name ();
+
+ /* Split the raw name up into words */
+ vector<string> words;
+ split (words, raw_name, is_any_of (" "));
+
+ string fixed_name;
+
+ /* Add each word to fixed_name */
+ for (vector<string>::const_iterator i = words.begin(); i != words.end(); ++i) {
+ string w = *i;
+
+ /* First letter is always capitalised */
+ w[0] = toupper (w[0]);
+
+ /* Count caps in w */
+ size_t caps = 0;
+ for (size_t i = 0; i < w.size(); ++i) {
+ if (isupper (w[i])) {
+ ++caps;
+ }
+ }
+
+ /* If w is all caps make the rest of it lower case, otherwise
+ leave it alone.
+ */
+ if (caps == w.size ()) {
+ for (size_t i = 1; i < w.size(); ++i) {
+ w[i] = tolower (w[i]);
+ }
+ }
+
+ for (size_t i = 0; i < w.size(); ++i) {
+ fixed_name += w[i];
}
}
- /* Spec is that the name part should be maximum 14 characters, as I understand it */
if (fixed_name.length() > 14) {
fixed_name = fixed_name.substr (0, 14);
}
d << fixed_name;
if (dcp_content_type()) {
- d << "_" << dcp_content_type()->dci_name();
- d << "-" << dci_metadata().content_version;
+ d << "_" << dcp_content_type()->isdcf_name();
+ d << "-" << isdcf_metadata().content_version;
+ }
+
+ ISDCFMetadata const dm = isdcf_metadata ();
+
+ if (dm.temp_version) {
+ d << "-Temp";
+ }
+
+ if (dm.pre_release) {
+ d << "-Pre";
+ }
+
+ if (dm.red_band) {
+ d << "-RedBand";
+ }
+
+ if (!dm.chain.empty ()) {
+ d << "-" << dm.chain;
}
if (three_d ()) {
d << "-3D";
}
+ if (dm.two_d_version_of_three_d) {
+ d << "-2D";
+ }
+
+ if (!dm.mastered_luminance.empty ()) {
+ d << "-" << dm.mastered_luminance;
+ }
+
if (video_frame_rate() != 24) {
d << "-" << video_frame_rate();
}
-
+
if (container()) {
- d << "_" << container()->dci_name();
+ d << "_" << container()->isdcf_name();
}
- DCIMetadata const dm = dci_metadata ();
+ /* XXX: this only works for content which has been scaled to a given ratio,
+ and uses the first bit of content only.
+ */
+
+ /* The standard says we don't do this for trailers, for some strange reason */
+ if (dcp_content_type() && dcp_content_type()->libdcp_kind() != dcp::TRAILER) {
+ ContentList cl = content ();
+ Ratio const * content_ratio = 0;
+ for (ContentList::const_iterator i = cl.begin(); i != cl.end(); ++i) {
+ shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (*i);
+ if (vc && (content_ratio == 0 || vc->scale().ratio() != content_ratio)) {
+ content_ratio = vc->scale().ratio();
+ }
+ }
+
+ if (content_ratio && content_ratio != container()) {
+ d << "-" << content_ratio->isdcf_name();
+ }
+ }
if (!dm.audio_language.empty ()) {
d << "_" << dm.audio_language;
break;
}
- d << "_" << resolution_to_string (_resolution);
+ /* XXX: HI/VI */
+ d << "_" << resolution_to_string (_resolution);
+
if (!dm.studio.empty ()) {
d << "_" << dm.studio;
}
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);
+ d << "_" << boost::gregorian::to_iso_string (_isdcf_date);
}
if (!dm.facility.empty ()) {
d << "_" << dm.facility;
}
+ if (_interop) {
+ d << "_IOP";
+ } else {
+ d << "_SMPTE";
+ }
+
+ if (three_d ()) {
+ d << "-3D";
+ }
+
if (!dm.package_type.empty ()) {
d << "_" << dm.package_type;
}
string
Film::dcp_name (bool if_created_now) const
{
- if (use_dci_name()) {
- return dci_name (if_created_now);
+ if (use_isdcf_name()) {
+ return isdcf_name (if_created_now);
}
return name();
}
-
void
Film::set_directory (boost::filesystem::path d)
{
}
void
-Film::set_use_dci_name (bool u)
+Film::set_use_isdcf_name (bool u)
{
- _use_dci_name = u;
- signal_changed (USE_DCI_NAME);
+ _use_isdcf_name = u;
+ signal_changed (USE_ISDCF_NAME);
}
void
signal_changed (SCALER);
}
-void
-Film::set_with_subtitles (bool w)
-{
- _with_subtitles = w;
- signal_changed (WITH_SUBTITLES);
-}
-
void
Film::set_j2k_bandwidth (int b)
{
}
void
-Film::set_dci_metadata (DCIMetadata m)
+Film::set_isdcf_metadata (ISDCFMetadata m)
{
- _dci_metadata = m;
- signal_changed (DCI_METADATA);
+ _isdcf_metadata = m;
+ signal_changed (ISDCF_METADATA);
}
void
signal_changed (INTEROP);
}
+void
+Film::set_burn_subtitles (bool b)
+{
+ _burn_subtitles = b;
+ signal_changed (BURN_SUBTITLES);
+}
+
void
Film::signal_changed (Property p)
{
}
void
-Film::set_dci_date_today ()
+Film::set_isdcf_date_today ()
{
- _dci_date = boost::gregorian::day_clock::local_day ();
+ _isdcf_date = boost::gregorian::day_clock::local_day ();
}
boost::filesystem::path
return file (p);
}
-/** @return List of subdirectories (not full paths) containing DCPs that can be successfully dcp::DCP::read() */
-list<boost::filesystem::path>
-Film::dcps () const
+/** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs */
+vector<CPLSummary>
+Film::cpls () const
{
- list<boost::filesystem::path> out;
+ vector<CPLSummary> out;
boost::filesystem::path const dir = directory ();
for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
try {
dcp::DCP dcp (*i);
dcp.read ();
- out.push_back (i->path().leaf ());
+ out.push_back (
+ CPLSummary (
+ i->path().leaf().string(),
+ dcp.cpls().front()->id(),
+ dcp.cpls().front()->annotation_text(),
+ dcp.cpls().front()->file()
+ )
+ );
} catch (...) {
}
void
Film::examine_and_add_content (shared_ptr<Content> c)
{
+ if (dynamic_pointer_cast<FFmpegContent> (c)) {
+ run_ffprobe (c->path(0), file ("ffprobe.log"), _log);
+ }
+
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);
return _playlist->length ();
}
-bool
-Film::has_subtitles () const
-{
- return _playlist->has_subtitles ();
-}
-
int
Film::best_video_frame_rate () const
{
signal_changed (SEQUENCE_VIDEO);
}
+/** @return Size of the largest possible image in whatever resolution we are using */
dcp::Size
Film::full_frame () const
{
return dcp::Size ();
}
-dcp::KDM
+/** @return Size of the frame */
+dcp::Size
+Film::frame_size () const
+{
+ return fit_ratio_within (container()->ratio(), full_frame ());
+}
+
+dcp::EncryptedKDM
Film::make_kdm (
shared_ptr<dcp::Certificate> target,
- boost::filesystem::path dcp_dir,
- boost::posix_time::ptime from,
- boost::posix_time::ptime until
+ boost::filesystem::path cpl_file,
+ dcp::LocalTime from,
+ dcp::LocalTime until,
+ dcp::Formulation formulation
) const
{
- shared_ptr<const Signer> signer = make_signer ();
-
- dcp::DCP dcp (dir (dcp_dir.string ()));
-
- try {
- dcp.read ();
- } catch (...) {
- throw KDMError (_("Could not read DCP to make KDM for"));
- }
-
- time_t now = time (0);
- struct tm* tm = localtime (&now);
- string const issue_date = dcp::tm_to_string (tm);
-
- dcp.cpls().front()->set_mxf_keys (key ());
-
- return dcp::KDM (dcp.cpls().front(), signer, target, from, until, "DCP-o-matic", issue_date);
+ shared_ptr<const dcp::CPL> cpl (new dcp::CPL (cpl_file));
+ return dcp::DecryptedKDM (
+ cpl, from, until, "DCP-o-matic", cpl->content_title_text(), dcp::LocalTime().as_string()
+ ).encrypt (make_signer(), target, formulation);
}
-list<dcp::KDM>
+list<dcp::EncryptedKDM>
Film::make_kdms (
list<shared_ptr<Screen> > screens,
boost::filesystem::path dcp,
- boost::posix_time::ptime from,
- boost::posix_time::ptime until
+ dcp::LocalTime from,
+ dcp::LocalTime until,
+ dcp::Formulation formulation
) const
{
- list<dcp::KDM> kdms;
+ list<dcp::EncryptedKDM> kdms;
for (list<shared_ptr<Screen> >::iterator i = screens.begin(); i != screens.end(); ++i) {
- kdms.push_back (make_kdm ((*i)->certificate, dcp, from, until));
+ kdms.push_back (make_kdm ((*i)->certificate, dcp, from, until, formulation));
}
return kdms;