Merge master.
[dcpomatic.git] / src / lib / film.cc
index 09d939957d26b5d42b0804c8acd0ef10cec38d04..14735d1b1048be4fa5c507e1fcf2f968eb4f6800 100644 (file)
 #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/signer_chain.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"
@@ -77,9 +77,12 @@ 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 dcp::Size;
+using dcp::Signer;
+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.
@@ -87,8 +90,13 @@ using libdcp::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
+ *
+ * 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.
  *
@@ -97,7 +105,7 @@ int const Film::current_state_version = 8;
 
 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)
@@ -106,7 +114,7 @@ Film::Film (boost::filesystem::path dir, bool log)
        , _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)
@@ -115,7 +123,7 @@ Film::Film (boost::filesystem::path dir, bool log)
        , _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));
@@ -179,6 +187,10 @@ Film::video_identifier () const
                s << "_3D";
        }
 
+       if (_with_subtitles) {
+               s << "_WS";
+       }
+
        return s.str ();
 }
          
@@ -242,7 +254,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"));
@@ -253,43 +265,43 @@ Film::make_dcp ()
         */
        write_metadata ();
 
-       log()->log (String::compose ("DCP-o-matic %1 git %2 using %3", dcpomatic_version, dcpomatic_git_commit, dependency_version_summary()));
+       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) {
@@ -346,10 +358,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) {
@@ -360,9 +372,9 @@ Film::metadata () const
        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");
@@ -404,12 +416,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 ());
                }
        }
 
@@ -424,16 +444,14 @@ Film::read_metadata ()
        _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");
-       _key = libdcp::Key (f.string_child ("Key"));
+       _key = dcp::Key (f.string_child ("Key"));
 
        list<string> notes;
        /* This method is the only one that can return notes (so far) */
@@ -473,20 +491,26 @@ 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;
 
-       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 ();
+       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]);
                }
        }
 
-       /* 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);
        }
@@ -494,23 +518,67 @@ 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 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;
@@ -549,8 +617,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;
        }
@@ -558,13 +628,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;
        }
@@ -576,8 +656,8 @@ 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();
@@ -599,10 +679,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
@@ -648,10 +728,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
@@ -705,9 +785,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
@@ -763,11 +843,11 @@ Film::j2c_path (int f, Eyes e, bool t) const
        return file (p);
 }
 
-/** @return List of subdirectories (not full paths) containing DCPs that can be successfully libdcp::DCP::read() */
-list<boost::filesystem::path>
-Film::dcps () const
+/** Find all the DCPs in our directory that can be libdcp::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) {
@@ -777,9 +857,16 @@ Film::dcps () const
                        ) {
 
                        try {
-                               libdcp::DCP dcp (*i);
+                               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 (...) {
 
                        }
@@ -876,7 +963,7 @@ Film::move_content_later (shared_ptr<Content> c)
        _playlist->move_later (c);
 }
 
-Time
+DCPTime
 Film::length () const
 {
        return _playlist->length ();
@@ -888,12 +975,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)
 {
@@ -912,31 +1005,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 */
@@ -952,63 +1021,50 @@ 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 ());
 }
 
-libdcp::KDM
+dcp::EncryptedKDM
 Film::make_kdm (
-       shared_ptr<libdcp::Certificate> target,
-       boost::filesystem::path dcp_dir,
-       boost::posix_time::ptime from,
-       boost::posix_time::ptime until
+       shared_ptr<dcp::Certificate> target,
+       boost::filesystem::path cpl_file,
+       dcp::LocalTime from,
+       dcp::LocalTime until
        ) const
 {
-       shared_ptr<const Signer> signer = make_signer ();
-
-       libdcp::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 = libdcp::tm_to_string (tm);
-       
-       dcp.cpls().front()->set_mxf_keys (key ());
-       
-       return libdcp::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);
 }
 
-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
        ) 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));
@@ -1023,7 +1079,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