Merge master.
[dcpomatic.git] / src / lib / film.cc
index 609003bbae7f2f632c1d190da567b70ce6133e18..26810992175d8da91065dfc4052d7da424afa0a2 100644 (file)
 #include <algorithm>
 #include <fstream>
 #include <cstdlib>
-#include <sstream>
 #include <iomanip>
 #include <unistd.h>
 #include <boost/filesystem.hpp>
 #include <boost/algorithm/string.hpp>
-#include <boost/date_time.hpp>
+#include <boost/lexical_cast.hpp>
 #include <libxml++/libxml++.h>
 #include <libcxml/cxml.h>
-#include <libdcp/signer_chain.h>
-#include <libdcp/cpl.h>
-#include <libdcp/signer.h>
-#include <libdcp/util.h>
-#include <libdcp/kdm.h>
-#include <libdcp/raw_convert.h>
+#include <dcp/cpl.h>
+#include <dcp/signer.h>
+#include <dcp/util.h>
+#include <dcp/local_time.h>
+#include <dcp/raw_convert.h>
 #include "film.h"
 #include "job.h"
 #include "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 libdcp::Size;
-using libdcp::Signer;
-using libdcp::raw_convert;
+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);
@@ -92,8 +92,13 @@ using libdcp::raw_convert;
  * 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.
  */
-int const Film::current_state_version = 9;
+int const Film::current_state_version = 32;
 
 /** Construct a Film object in a given directory.
  *
@@ -107,7 +112,6 @@ Film::Film (boost::filesystem::path dir, bool log)
        , _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 ())
@@ -117,6 +121,7 @@ Film::Film (boost::filesystem::path dir, bool log)
        , _three_d (false)
        , _sequence_video (true)
        , _interop (false)
+       , _burn_subtitles (false)
        , _state_version (current_state_version)
        , _dirty (false)
 {
@@ -158,7 +163,7 @@ Film::video_identifier () const
 {
        assert (container ());
 
-       stringstream s;
+       SafeStringStream s;
        s.imbue (std::locale::classic ());
        
        s << container()->id()
@@ -180,12 +185,12 @@ Film::video_identifier () const
                s << "_S";
        }
 
-       if (_three_d) {
-               s << "_3D";
+       if (_burn_subtitles) {
+               s << "_B";
        }
 
-       if (_with_subtitles) {
-               s << "_WS";
+       if (_three_d) {
+               s << "_3D";
        }
 
        return s.str ();
@@ -225,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
 {
@@ -367,7 +378,6 @@ 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));
        _isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
        root->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
@@ -376,6 +386,7 @@ Film::metadata () const
        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 ());
@@ -439,7 +450,6 @@ 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");
        _video_frame_rate = f.number_child<int> ("VideoFrameRate");
        _signed = f.optional_bool_child("Signed").get_value_or (true);
@@ -448,7 +458,10 @@ Film::read_metadata ()
        _sequence_video = f.bool_child ("SequenceVideo");
        _three_d = f.bool_child ("ThreeD");
        _interop = f.bool_child ("Interop");
-       _key = libdcp::Key (f.string_child ("Key"));
+       if (_state_version >= 32) {
+               _burn_subtitles = f.bool_child ("BurnSubtitles");
+       }
+       _key = dcp::Key (f.string_child ("Key"));
 
        list<string> notes;
        /* This method is the only one that can return notes (so far) */
@@ -492,19 +505,42 @@ Film::file (boost::filesystem::path f) const
 string
 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;
-       bool cap_next = true;
-       for (size_t i = 0; i < raw_name.length(); ++i) {
-               if (raw_name[i] == ' ') {
-                       cap_next = true;
-               } else if (cap_next) {
-                       fixed_name += toupper (raw_name[i]);
-                       cap_next = false;
-               } else {
-                       fixed_name += tolower (raw_name[i]);
+       
+       /* 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];
                }
        }
 
@@ -557,18 +593,22 @@ Film::isdcf_name (bool if_created_now) const
                d << "_" << container()->isdcf_name();
        }
 
-       /* XXX: this only works for content which has been scaled to a given ratio,
-          and uses the first bit of content only.
-       */
+       /* 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() != libdcp::TRAILER) {
+       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) {
+               for (ContentList::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 (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;
                        }
                }
                
@@ -660,7 +700,6 @@ Film::dcp_name (bool if_created_now) const
        return name();
 }
 
-
 void
 Film::set_directory (boost::filesystem::path d)
 {
@@ -710,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)
 {
@@ -759,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)
 {
@@ -793,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;
 
@@ -820,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;
 
@@ -840,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
 {
@@ -854,11 +893,14 @@ Film::cpls () const
                        ) {
 
                        try {
-                               libdcp::DCP dcp (*i);
+                               dcp::DCP dcp (*i);
                                dcp.read ();
                                out.push_back (
                                        CPLSummary (
-                                               i->path().leaf().string(), dcp.cpls().front()->id(), dcp.cpls().front()->name(), dcp.cpls().front()->filename()
+                                               i->path().leaf().string(),
+                                               dcp.cpls().front()->id(),
+                                               dcp.cpls().front()->annotation_text(),
+                                               dcp.cpls().front()->file()
                                                )
                                        );
                        } catch (...) {
@@ -902,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)
 {
@@ -957,22 +1006,22 @@ Film::move_content_later (shared_ptr<Content> c)
        _playlist->move_later (c);
 }
 
-Time
+DCPTime
 Film::length () const
 {
        return _playlist->length ();
 }
 
-bool
-Film::has_subtitles () const
+int
+Film::best_video_frame_rate () const
 {
-       return _playlist->has_subtitles ();
+       return _playlist->best_dcp_frame_rate ();
 }
 
-OutputVideoFrame
-Film::best_video_frame_rate () const
+FrameRateChange
+Film::active_frame_rate_change (DCPTime t) const
 {
-       return _playlist->best_dcp_frame_rate ();
+       return _playlist->active_frame_rate_change (t, video_frame_rate ());
 }
 
 void
@@ -993,31 +1042,7 @@ Film::playlist_changed ()
        signal_changed (CONTENT);
 }      
 
-OutputAudioFrame
-Film::time_to_audio_frames (Time t) const
-{
-       return divide_with_round (t * audio_frame_rate (), TIME_HZ);
-}
-
-OutputVideoFrame
-Film::time_to_video_frames (Time t) const
-{
-       return divide_with_round (t * video_frame_rate (), TIME_HZ);
-}
-
-Time
-Film::audio_frames_to_time (OutputAudioFrame f) const
-{
-       return divide_with_round (f * TIME_HZ, audio_frame_rate ());
-}
-
-Time
-Film::video_frames_to_time (OutputVideoFrame f) const
-{
-       return divide_with_round (f * TIME_HZ, video_frame_rate ());
-}
-
-OutputAudioFrame
+int
 Film::audio_frame_rate () const
 {
        /* XXX */
@@ -1033,59 +1058,62 @@ Film::set_sequence_video (bool s)
 }
 
 /** @return Size of the largest possible image in whatever resolution we are using */
-libdcp::Size
+dcp::Size
 Film::full_frame () const
 {
        switch (_resolution) {
        case RESOLUTION_2K:
-               return libdcp::Size (2048, 1080);
+               return dcp::Size (2048, 1080);
        case RESOLUTION_4K:
-               return libdcp::Size (4096, 2160);
+               return dcp::Size (4096, 2160);
        }
 
        assert (false);
-       return libdcp::Size ();
+       return dcp::Size ();
 }
 
 /** @return Size of the frame */
-libdcp::Size
+dcp::Size
 Film::frame_size () const
 {
-       return fit_ratio_within (container()->ratio(), full_frame ());
+       return fit_ratio_within (container()->ratio(), full_frame (), 1);
 }
 
-/** @param from KDM from time in local time.
- *  @param to KDM to time in local time.
- */
-libdcp::KDM
+dcp::EncryptedKDM
 Film::make_kdm (
-       shared_ptr<libdcp::Certificate> target,
+       dcp::Certificate target,
        boost::filesystem::path cpl_file,
-       boost::posix_time::ptime from,
-       boost::posix_time::ptime until
+       dcp::LocalTime from,
+       dcp::LocalTime until,
+       dcp::Formulation formulation
        ) const
 {
-       shared_ptr<const Signer> signer = make_signer ();
-
-       time_t now = time (0);
-       struct tm* tm = localtime (&now);
-       string const issue_date = libdcp::tm_to_string (tm);
+       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 libdcp::KDM (cpl_file, signer, target, key (), from, until, "DCP-o-matic", issue_date);
+       return dcp::DecryptedKDM (
+               cpl, key(), from, until, "DCP-o-matic", cpl->content_title_text(), dcp::LocalTime().as_string()
+               ).encrypt (signer, target, formulation);
 }
 
-list<libdcp::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<libdcp::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));
+               if ((*i)->certificate) {
+                       kdms.push_back (make_kdm ((*i)->certificate.get(), dcp, from, until, formulation));
+               }
        }
 
        return kdms;
@@ -1097,7 +1125,7 @@ Film::make_kdms (
 uint64_t
 Film::required_disk_space () const
 {
-       return uint64_t (j2k_bandwidth() / 8) * length() / TIME_HZ;
+       return uint64_t (j2k_bandwidth() / 8) * length().seconds();
 }
 
 /** This method checks the disk that the Film is on and tries to decide whether or not
@@ -1115,10 +1143,3 @@ Film::should_be_enough_disk_space (double& required, double& available) const
        available = double (s.available) / 1073741824.0f;
        return (available - required) > 1;
 }
-
-FrameRateChange
-Film::active_frame_rate_change (Time t) const
-{
-       return _playlist->active_frame_rate_change (t, video_frame_rate ());
-}
-