Merge master.
[dcpomatic.git] / src / lib / film.cc
index d218524f467c8828e51c6dbe79339a3b571a98f3..cc80f5bc2d8be73bf40f60b99a136a963f0f582e 100644 (file)
 #include <boost/date_time.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 <dcp/signer_chain.h>
+#include <dcp/cpl.h>
+#include <dcp/signer.h>
+#include <dcp/util.h>
+#include <dcp/kdm.h>
 #include "film.h"
 #include "job.h"
 #include "util.h"
@@ -64,8 +64,6 @@ using std::multimap;
 using std::pair;
 using std::map;
 using std::vector;
-using std::ifstream;
-using std::ofstream;
 using std::setfill;
 using std::min;
 using std::make_pair;
@@ -80,17 +78,24 @@ using boost::to_upper_copy;
 using boost::ends_with;
 using boost::starts_with;
 using boost::optional;
-using libdcp::Size;
-using libdcp::Signer;
-
-int const Film::state_version = 4;
+using dcp::Size;
+using dcp::Signer;
+
+/* 5 -> 6
+ * AudioMapping XML changed.
+ * 6 -> 7
+ * Subtitle offset changed to subtitle y offset, and subtitle x offset added.
+ * 7 -> 8
+ * Use <Scale> tag in <VideoContent> rather than <Ratio>.
+ */
+int const Film::current_state_version = 8;
 
 /** Construct a Film object in a given directory.
  *
  *  @param dir Film directory.
  */
 
-Film::Film (boost::filesystem::path dir)
+Film::Film (boost::filesystem::path dir, bool log)
        : _playlist (new Playlist)
        , _use_dci_name (true)
        , _dcp_content_type (Config::instance()->default_dcp_content_type ())
@@ -98,14 +103,16 @@ Film::Film (boost::filesystem::path dir)
        , _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 ())
        , _video_frame_rate (24)
-       , _audio_channels (MAX_AUDIO_CHANNELS)
+       , _audio_channels (6)
        , _three_d (false)
        , _sequence_video (true)
        , _interop (false)
+       , _state_version (current_state_version)
        , _dirty (false)
 {
        set_dci_date_today ();
@@ -131,8 +138,12 @@ Film::Film (boost::filesystem::path dir)
                }
        }
 
-       set_directory (result.string ());
-       _log.reset (new FileLog (file ("log")));
+       set_directory (result);
+       if (log) {
+               _log.reset (new FileLog (file ("log")));
+       } else {
+               _log.reset (new NullLog);
+       }
 
        _playlist->set_sequence_video (_sequence_video);
 }
@@ -151,6 +162,12 @@ Film::video_identifier () const
          << "_" << scaler()->id()
          << "_" << j2k_bandwidth();
 
+       if (encrypted ()) {
+               s << "_E";
+       } else {
+               s << "_P";
+       }
+
        if (_interop) {
                s << "_I";
        } else {
@@ -165,34 +182,34 @@ Film::video_identifier () const
 }
          
 /** @return The path to the directory to write video frame info files to */
-string
+boost::filesystem::path
 Film::info_dir () const
 {
        boost::filesystem::path p;
        p /= "info";
        p /= video_identifier ();
-       return dir (p.string());
+       return dir (p);
 }
 
-string
+boost::filesystem::path
 Film::internal_video_mxf_dir () const
 {
        return dir ("video");
 }
 
-string
+boost::filesystem::path
 Film::internal_video_mxf_filename () const
 {
        return video_identifier() + ".mxf";
 }
 
-string
+boost::filesystem::path
 Film::video_mxf_filename () const
 {
        return filename_safe_name() + "_video.mxf";
 }
 
-string
+boost::filesystem::path
 Film::audio_mxf_filename () const
 {
        return filename_safe_name() + "_audio.mxf";
@@ -215,11 +232,9 @@ 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 */
@@ -257,6 +272,14 @@ Film::make_dcp ()
 #else
        log()->log ("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));
+#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) {
@@ -309,22 +332,15 @@ Film::encoded_frames () const
        return N;
 }
 
-/** Write state to our `metadata' file */
-void
-Film::write_metadata () const
+shared_ptr<xmlpp::Document>
+Film::metadata () const
 {
-       if (!boost::filesystem::exists (directory())) {
-               boost::filesystem::create_directory (directory());
-       }
-       
        LocaleGuard lg;
 
-       boost::filesystem::create_directories (directory());
+       shared_ptr<xmlpp::Document> doc (new xmlpp::Document);
+       xmlpp::Element* root = doc->create_root_node ("Metadata");
 
-       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("Version")->add_child_text (lexical_cast<string> (current_state_version));
        root->add_child("Name")->add_child_text (_name);
        root->add_child("UseDCIName")->add_child_text (_use_dci_name ? "1" : "0");
 
@@ -347,17 +363,28 @@ Film::write_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("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 ());
        _playlist->as_xml (root->add_child ("Playlist"));
 
-       doc.write_to_file_formatted (file ("metadata.xml"));
-       
-       _dirty = false;
+       return doc;
 }
 
-/** Read state from our metadata file */
+/** Write state to our `metadata' file */
 void
+Film::write_metadata () const
+{
+       boost::filesystem::create_directories (directory ());
+       shared_ptr<xmlpp::Document> doc = metadata ();
+       doc->write_to_file_formatted (file("metadata.xml").string ());
+       _dirty = false;
+}
+
+/** 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;
@@ -368,6 +395,11 @@ Film::read_metadata ()
 
        cxml::Document f ("Metadata");
        f.read_file (file ("metadata.xml"));
+
+       _state_version = f.number_child<int> ("Version");
+       if (_state_version > current_state_version) {
+               throw StringError (_("This film was created with a newer version of DCP-o-matic, and it cannot be loaded into this version.  Sorry!"));
+       }
        
        _name = f.string_child ("Name");
        _use_dci_name = f.bool_child ("UseDCIName");
@@ -393,22 +425,27 @@ Film::read_metadata ()
        _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");
-       _key = libdcp::Key (f.string_child ("Key"));
-       _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"));
+       _key = dcp::Key (f.string_child ("Key"));
+
+       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.
  *  The directory (and its parents) will be created if they do not exist.
  */
-string
-Film::dir (string d) const
+boost::filesystem::path
+Film::dir (boost::filesystem::path d) const
 {
        boost::filesystem::path p;
        p /= _directory;
@@ -416,14 +453,14 @@ Film::dir (string d) const
        
        boost::filesystem::create_directories (p);
        
-       return p.string ();
+       return p;
 }
 
 /** Given a file or directory name, return its full path within the Film's directory.
  *  Any required parent directories will be created.
  */
-string
-Film::file (string f) const
+boost::filesystem::path
+Film::file (boost::filesystem::path f) const
 {
        boost::filesystem::path p;
        p /= _directory;
@@ -431,7 +468,7 @@ Film::file (string f) const
 
        boost::filesystem::create_directories (p.parent_path ());
        
-       return p.string ();
+       return p;
 }
 
 /** @return a DCI-compliant name for a DCP of this film */
@@ -475,7 +512,7 @@ Film::dci_name (bool if_created_now) const
 
        if (!dm.audio_language.empty ()) {
                d << "_" << dm.audio_language;
-               if (!dm.subtitle_language.empty() && with_subtitles()) {
+               if (!dm.subtitle_language.empty()) {
                        d << "-" << dm.subtitle_language;
                } else {
                        d << "-XX";
@@ -546,7 +583,7 @@ Film::dcp_name (bool if_created_now) const
 
 
 void
-Film::set_directory (string d)
+Film::set_directory (boost::filesystem::path d)
 {
        _directory = d;
        _dirty = true;
@@ -671,7 +708,7 @@ Film::set_dci_date_today ()
        _dci_date = boost::gregorian::day_clock::local_day ();
 }
 
-string
+boost::filesystem::path
 Film::info_path (int f, Eyes e) const
 {
        boost::filesystem::path p;
@@ -694,10 +731,10 @@ Film::info_path (int f, Eyes e) const
        /* info_dir() will already have added any initial bit of the path,
           so don't call file() on this.
        */
-       return p.string ();
+       return p;
 }
 
-string
+boost::filesystem::path
 Film::j2c_path (int f, Eyes e, bool t) const
 {
        boost::filesystem::path p;
@@ -721,25 +758,33 @@ Film::j2c_path (int f, Eyes e, bool t) const
        }
 
        p /= s.str();
-       return file (p.string ());
+       return file (p);
 }
 
-/** Make an educated guess as to whether we have a complete DCP
- *  or not.
- *  @return true if we do.
- */
-
-bool
-Film::have_dcp () const
+/** @return List of subdirectories (not full paths) containing DCPs that can be successfully dcp::DCP::read() */
+list<boost::filesystem::path>
+Film::dcps () const
 {
-       try {
-               libdcp::DCP dcp (dir (dcp_name()));
-               dcp.read ();
-       } catch (...) {
-               return false;
-       }
+       list<boost::filesystem::path> out;
+       
+       boost::filesystem::path const dir = directory ();
+       for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
+               if (
+                       boost::filesystem::is_directory (*i) &&
+                       i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
+                       ) {
+
+                       try {
+                               dcp::DCP dcp (*i);
+                               dcp.read ();
+                               out.push_back (i->path().leaf ());
+                       } catch (...) {
 
-       return true;
+                       }
+               }
+       }
+       
+       return out;
 }
 
 shared_ptr<Player>
@@ -748,6 +793,13 @@ Film::make_player () const
        return shared_ptr<Player> (new Player (shared_from_this (), _playlist));
 }
 
+void
+Film::set_signed (bool s)
+{
+       _signed = s;
+       signal_changed (SIGNED);
+}
+
 void
 Film::set_encrypted (bool e)
 {
@@ -806,7 +858,19 @@ Film::remove_content (shared_ptr<Content> c)
        _playlist->remove (c);
 }
 
-Time
+void
+Film::move_content_earlier (shared_ptr<Content> c)
+{
+       _playlist->move_earlier (c);
+}
+
+void
+Film::move_content_later (shared_ptr<Content> c)
+{
+       _playlist->move_later (c);
+}
+
+DCPTime
 Film::length () const
 {
        return _playlist->length ();
@@ -818,12 +882,18 @@ Film::has_subtitles () const
        return _playlist->has_subtitles ();
 }
 
-OutputVideoFrame
+int
 Film::best_video_frame_rate () const
 {
        return _playlist->best_dcp_frame_rate ();
 }
 
+FrameRateChange
+Film::active_frame_rate_change (DCPTime t) const
+{
+       return _playlist->active_frame_rate_change (t, video_frame_rate ());
+}
+
 void
 Film::playlist_content_changed (boost::weak_ptr<Content> c, int p)
 {
@@ -842,31 +912,7 @@ Film::playlist_changed ()
        signal_changed (CONTENT);
 }      
 
-OutputAudioFrame
-Film::time_to_audio_frames (Time t) const
-{
-       return t * audio_frame_rate () / TIME_HZ;
-}
-
-OutputVideoFrame
-Film::time_to_video_frames (Time t) const
-{
-       return t * video_frame_rate () / TIME_HZ;
-}
-
-Time
-Film::audio_frames_to_time (OutputAudioFrame f) const
-{
-       return f * TIME_HZ / audio_frame_rate ();
-}
-
-Time
-Film::video_frames_to_time (OutputVideoFrame f) const
-{
-       return f * TIME_HZ / video_frame_rate ();
-}
-
-OutputAudioFrame
+int
 Film::audio_frame_rate () const
 {
        /* XXX */
@@ -881,96 +927,93 @@ Film::set_sequence_video (bool s)
        signal_changed (SEQUENCE_VIDEO);
 }
 
-libdcp::Size
+/** @return Size of the largest possible image in whatever resolution we are using */
+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 ();
 }
 
-void
-Film::make_kdms (
-       list<shared_ptr<Screen> > screens,
+/** @return Size of the frame */
+dcp::Size
+Film::frame_size () const
+{
+       return fit_ratio_within (container()->ratio(), full_frame ());
+}
+
+dcp::KDM
+Film::make_kdm (
+       shared_ptr<dcp::Certificate> target,
+       boost::filesystem::path dcp_dir,
        boost::posix_time::ptime from,
-       boost::posix_time::ptime until,
-       string directory
+       boost::posix_time::ptime until
        ) const
 {
-       boost::filesystem::path const sd = Config::instance()->signer_chain_directory ();
-       if (boost::filesystem::is_empty (sd)) {
-               libdcp::make_signer_chain (sd);
-       }
-
-       libdcp::CertificateChain chain;
-
-       {
-               boost::filesystem::path p (sd);
-               p /= "ca.self-signed.pem";
-               chain.add (shared_ptr<libdcp::Certificate> (new libdcp::Certificate (p)));
-       }
-
-       {
-               boost::filesystem::path p (sd);
-               p /= "intermediate.signed.pem";
-               chain.add (shared_ptr<libdcp::Certificate> (new libdcp::Certificate (p)));
-       }
+       shared_ptr<const Signer> signer = make_signer ();
 
-       {
-               boost::filesystem::path p (sd);
-               p /= "leaf.signed.pem";
-               chain.add (shared_ptr<libdcp::Certificate> (new libdcp::Certificate (p)));
-       }
-
-       boost::filesystem::path signer_key (sd);
-       signer_key /= "leaf.key";
-
-       shared_ptr<const Signer> signer (new Signer (chain, signer_key));
-
-       /* Find the DCP to make the KDM for */
-       string const dir = this->directory ();
-       list<boost::filesystem::path> dcps;
-       for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
-               if (boost::filesystem::is_directory (*i) && i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info") {
-                       dcps.push_back (i->path());
-               }
+       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);
+}
 
-       if (dcps.empty()) {
-               throw KDMError (_("Could not find DCP to make KDM for"));
-       } else if (dcps.size() > 1) {
-               throw KDMError (_("More than one possible DCP to make KDM for"));
-       }
+list<dcp::KDM>
+Film::make_kdms (
+       list<shared_ptr<Screen> > screens,
+       boost::filesystem::path dcp,
+       boost::posix_time::ptime from,
+       boost::posix_time::ptime until
+       ) const
+{
+       list<dcp::KDM> kdms;
 
        for (list<shared_ptr<Screen> >::iterator i = screens.begin(); i != screens.end(); ++i) {
+               kdms.push_back (make_kdm ((*i)->certificate, dcp, from, until));
+       }
 
-               libdcp::DCP dcp (dcps.front ());
-
-               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 = libdcp::tm_to_string (tm);
+       return kdms;
+}
 
-               dcp.cpls().front()->set_mxf_keys (key ());
-               
-               libdcp::KDM kdm (
-                       dcp.cpls().front(), signer, (*i)->certificate, from, until, "DCP-o-matic", issue_date
-                       );
+/** @return The approximate disk space required to encode a DCP of this film with the
+ *  current settings, in bytes.
+ */
+uint64_t
+Film::required_disk_space () const
+{
+       return uint64_t (j2k_bandwidth() / 8) * length().seconds();
+}
 
-               boost::filesystem::path out = directory;
-               out /= tidy_for_filename ((*i)->cinema->name) + "_" + tidy_for_filename ((*i)->name) + ".kdm.xml";
-               kdm.as_xml (out);
-       }
+/** This method checks the disk that the Film is on and tries to decide whether or not
+ *  there will be enough space to make a DCP for it.  If so, true is returned; if not,
+ *  false is returned and required and availabe are filled in with the amount of disk space
+ *  required and available respectively (in Gb).
+ *
+ *  Note: the decision made by this method isn't, of course, 100% reliable.
+ */
+bool
+Film::should_be_enough_disk_space (double& required, double& available) const
+{
+       boost::filesystem::space_info s = boost::filesystem::space (internal_video_mxf_dir ());
+       required = double (required_disk_space ()) / 1073741824.0f;
+       available = double (s.available) / 1073741824.0f;
+       return (available - required) > 1;
 }
-