Merge master.
[dcpomatic.git] / src / lib / film.cc
index 25730ae1cbe8bff7e07da16c6eced81e099c7c79..26810992175d8da91065dfc4052d7da424afa0a2 100644 (file)
@@ -22,7 +22,6 @@
 #include <algorithm>
 #include <fstream>
 #include <cstdlib>
-#include <sstream>
 #include <iomanip>
 #include <unistd.h>
 #include <boost/filesystem.hpp>
@@ -30,7 +29,6 @@
 #include <boost/lexical_cast.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 "ratio.h"
 #include "cross.h"
 #include "cinema.h"
+#include "safe_stringstream.h"
 
 #include "i18n.h"
 
 using std::string;
-using std::stringstream;
 using std::multimap;
 using std::pair;
 using std::map;
@@ -77,9 +75,11 @@ 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);
@@ -90,6 +90,10 @@ using dcp::raw_convert;
  * 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
+ * 9 -> 10
+ * Subtitle X and Y scale.
  *
  * Bumped to 32 for 2.0 branch; some times are expressed in Times rather
  * than frames now.
@@ -103,25 +107,25 @@ int const Film::current_state_version = 32;
 
 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));
@@ -159,7 +163,7 @@ Film::video_identifier () const
 {
        assert (container ());
 
-       stringstream s;
+       SafeStringStream s;
        s.imbue (std::locale::classic ());
        
        s << container()->id()
@@ -181,6 +185,10 @@ Film::video_identifier () const
                s << "_S";
        }
 
+       if (_burn_subtitles) {
+               s << "_B";
+       }
+
        if (_three_d) {
                s << "_3D";
        }
@@ -222,6 +230,12 @@ Film::audio_mxf_filename () const
        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
 {
@@ -248,7 +262,7 @@ Film::audio_analysis_dir () const
 void
 Film::make_dcp ()
 {
-       set_dci_date_today ();
+       set_isdcf_date_today ();
        
        if (dcp_name().find ("/") != string::npos) {
                throw BadSettingError (_("name"), _("cannot contain slashes"));
@@ -352,10 +366,10 @@ Film::metadata () const
 
        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) {
@@ -364,15 +378,15 @@ Film::metadata () const
 
        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 (raw_convert<string> (_j2k_bandwidth));
-       _dci_metadata.as_xml (root->add_child ("DCIMetadata"));
+       _isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
        root->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
-       root->add_child("DCIDate")->add_child_text (boost::gregorian::to_iso_string (_dci_date));
+       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 ());
@@ -410,12 +424,20 @@ Film::read_metadata ()
        }
        
        _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 ());
                }
        }
 
@@ -428,17 +450,17 @@ Film::read_metadata ()
 
        _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"));
 
        list<string> notes;
@@ -479,20 +501,49 @@ Film::file (boost::filesystem::path f) const
        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;
+       SafeStringStream d;
+
+       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]);
+                       }
+               }
 
-       string fixed_name = to_upper_copy (name());
-       for (size_t i = 0; i < fixed_name.length(); ++i) {
-               if (fixed_name[i] == ' ') {
-                       fixed_name[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);
        }
@@ -500,23 +551,71 @@ Film::dci_name (bool if_created_now) const
        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 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::iterator i = cl.begin(); i != cl.end(); ++i) {
+                       shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (*i);
+                       if (vc) {
+                               /* Here's the first piece of video content */
+                               if (vc->scale().ratio ()) {
+                                       content_ratio = vc->scale().ratio ();
+                               } else {
+                                       content_ratio = Ratio::from_ratio (vc->video_size().ratio ());
+                               }
+                               break;
+                       }
+               }
+               
+               if (content_ratio && content_ratio != container()) {
+                       d << "-" << content_ratio->isdcf_name();
+               }
+       }
 
        if (!dm.audio_language.empty ()) {
                d << "_" << dm.audio_language;
@@ -555,8 +654,10 @@ Film::dci_name (bool if_created_now) const
                break;
        }
 
-       d << "_" << resolution_to_string (_resolution);
+       /* XXX: HI/VI */
 
+       d << "_" << resolution_to_string (_resolution);
+       
        if (!dm.studio.empty ()) {
                d << "_" << dm.studio;
        }
@@ -564,13 +665,23 @@ Film::dci_name (bool if_created_now) const
        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;
        }
@@ -582,14 +693,13 @@ Film::dci_name (bool if_created_now) const
 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)
 {
@@ -605,10 +715,10 @@ Film::set_name (string n)
 }
 
 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
@@ -639,13 +749,6 @@ Film::set_scaler (Scaler const * s)
        signal_changed (SCALER);
 }
 
-void
-Film::set_with_subtitles (bool w)
-{
-       _with_subtitles = w;
-       signal_changed (WITH_SUBTITLES);
-}
-
 void
 Film::set_j2k_bandwidth (int b)
 {
@@ -654,10 +757,10 @@ 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
@@ -688,6 +791,13 @@ Film::set_interop (bool i)
        signal_changed (INTEROP);
 }
 
+void
+Film::set_burn_subtitles (bool b)
+{
+       _burn_subtitles = b;
+       signal_changed (BURN_SUBTITLES);
+}
+
 void
 Film::signal_changed (Property p)
 {
@@ -711,9 +821,9 @@ 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
@@ -722,7 +832,7 @@ Film::info_path (int f, Eyes e) const
        boost::filesystem::path p;
        p /= info_dir ();
 
-       stringstream s;
+       SafeStringStream s;
        s.width (8);
        s << setfill('0') << f;
 
@@ -749,7 +859,7 @@ Film::j2c_path (int f, Eyes e, bool t) const
        p /= "j2c";
        p /= video_identifier ();
 
-       stringstream s;
+       SafeStringStream s;
        s.width (8);
        s << setfill('0') << f;
 
@@ -769,7 +879,7 @@ Film::j2c_path (int f, Eyes e, bool t) const
        return file (p);
 }
 
-/** Find all the DCPs in our directory that can be libdcp::DCP::read() and return details of their CPLs */
+/** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs */
 vector<CPLSummary>
 Film::cpls () const
 {
@@ -834,6 +944,13 @@ Film::content () const
        return _playlist->content ();
 }
 
+void
+Film::examine_content (shared_ptr<Content> c)
+{
+       shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
+       JobManager::instance()->add (j);
+}
+
 void
 Film::examine_and_add_content (shared_ptr<Content> c)
 {
@@ -895,12 +1012,6 @@ Film::length () const
        return _playlist->length ();
 }
 
-bool
-Film::has_subtitles () const
-{
-       return _playlist->has_subtitles ();
-}
-
 int
 Film::best_video_frame_rate () const
 {
@@ -965,21 +1076,27 @@ Film::full_frame () const
 dcp::Size
 Film::frame_size () const
 {
-       return fit_ratio_within (container()->ratio(), full_frame ());
+       return fit_ratio_within (container()->ratio(), full_frame (), 1);
 }
 
 dcp::EncryptedKDM
 Film::make_kdm (
-       shared_ptr<dcp::Certificate> target,
+       dcp::Certificate target,
        boost::filesystem::path cpl_file,
        dcp::LocalTime from,
-       dcp::LocalTime until
+       dcp::LocalTime until,
+       dcp::Formulation formulation
        ) const
 {
        shared_ptr<const dcp::CPL> cpl (new dcp::CPL (cpl_file));
+       shared_ptr<const dcp::Signer> signer = Config::instance()->signer();
+       if (!signer->valid ()) {
+               throw InvalidSignerError ();
+       }
+       
        return dcp::DecryptedKDM (
-               cpl, from, until, "DCP-o-matic", cpl->content_title_text(), dcp::LocalTime().as_string()
-               ).encrypt (make_signer(), target);
+               cpl, key(), from, until, "DCP-o-matic", cpl->content_title_text(), dcp::LocalTime().as_string()
+               ).encrypt (signer, target, formulation);
 }
 
 list<dcp::EncryptedKDM>
@@ -987,13 +1104,16 @@ Film::make_kdms (
        list<shared_ptr<Screen> > screens,
        boost::filesystem::path dcp,
        dcp::LocalTime from,
-       dcp::LocalTime until
+       dcp::LocalTime until,
+       dcp::Formulation formulation
        ) const
 {
        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));
+               if ((*i)->certificate) {
+                       kdms.push_back (make_kdm ((*i)->certificate.get(), dcp, from, until, formulation));
+               }
        }
 
        return kdms;