Merge branch 'master' into i18n
[dcpomatic.git] / src / lib / film.cc
index 1741d49e691269e79abf7079cdfd11a67fc9a4ec..600cdfa02165c0ac5da089ceeea67e5dbd75359d 100644 (file)
@@ -39,7 +39,6 @@
 #include "ab_transcode_job.h"
 #include "transcode_job.h"
 #include "scp_dcp_job.h"
-#include "make_dcp_job.h"
 #include "log.h"
 #include "options.h"
 #include "exceptions.h"
@@ -47,7 +46,6 @@
 #include "scaler.h"
 #include "decoder_factory.h"
 #include "config.h"
-#include "check_hashes_job.h"
 #include "version.h"
 #include "ui_signaller.h"
 #include "video_decoder.h"
@@ -65,7 +63,6 @@ using std::ofstream;
 using std::setfill;
 using std::min;
 using std::make_pair;
-using std::cout;
 using boost::shared_ptr;
 using boost::lexical_cast;
 using boost::to_upper_copy;
@@ -74,7 +71,7 @@ using boost::starts_with;
 using boost::optional;
 using libdcp::Size;
 
-int const Film::state_version = 2;
+int const Film::state_version = 3;
 
 /** Construct a Film object in a given directory, reading any metadata
  *  file that exists in that directory.  An exception will be thrown if
@@ -102,9 +99,12 @@ Film::Film (string d, bool must_exist)
        , _subtitle_scale (1)
        , _colour_lut (0)
        , _j2k_bandwidth (200000000)
+       , _dci_metadata (Config::instance()->default_dci_metadata ())
        , _frames_per_second (0)
        , _dirty (false)
 {
+       set_dci_date_today ();
+       
        /* Make state.directory a complete path without ..s (where possible)
           (Code swiped from Adam Bowen on stackoverflow)
        */
@@ -140,7 +140,6 @@ Film::Film (string d, bool must_exist)
        }
 
        _log = new FileLog (file ("log"));
-       set_dci_date_today ();
 }
 
 Film::Film (Film const & o)
@@ -158,7 +157,6 @@ Film::Film (Film const & o)
        , _scaler            (o._scaler)
        , _trim_start        (o._trim_start)
        , _trim_end          (o._trim_end)
-       , _reel_size         (o._reel_size)
        , _dcp_ab            (o._dcp_ab)
        , _content_audio_stream (o._content_audio_stream)
        , _external_audio    (o._external_audio)
@@ -172,13 +170,8 @@ Film::Film (Film const & o)
        , _subtitle_scale    (o._subtitle_scale)
        , _colour_lut        (o._colour_lut)
        , _j2k_bandwidth     (o._j2k_bandwidth)
-       , _audio_language    (o._audio_language)
-       , _subtitle_language (o._subtitle_language)
-       , _territory         (o._territory)
-       , _rating            (o._rating)
-       , _studio            (o._studio)
-       , _facility          (o._facility)
-       , _package_type      (o._package_type)
+       , _dci_metadata      (o._dci_metadata)
+       , _dci_date          (o._dci_date)
        , _size              (o._size)
        , _length            (o._length)
        , _dcp_intrinsic_duration (o._dcp_intrinsic_duration)
@@ -196,24 +189,14 @@ Film::~Film ()
 {
        delete _log;
 }
-         
-/** @return The path to the directory to write JPEG2000 files to */
+
 string
-Film::j2k_dir () const
+Film::video_state_identifier () const
 {
-       assert (format());
-
-       boost::filesystem::path p;
-
-       /* Start with j2c */
-       p /= "j2c";
+       assert (format ());
 
        pair<string, string> f = Filter::ffmpeg_strings (filters());
 
-       /* Write stuff to specify the filter / post-processing settings that are in use,
-          so that we don't get confused about J2K files generated using different
-          settings.
-       */
        stringstream s;
        s << format()->id()
          << "_" << content_digest()
@@ -223,29 +206,45 @@ Film::j2k_dir () const
          << "_" << j2k_bandwidth()
          << "_" << boost::lexical_cast<int> (colour_lut());
 
-       p /= s.str ();
-
-       /* Similarly for the A/B case */
        if (dcp_ab()) {
-               stringstream s;
                pair<string, string> fa = Filter::ffmpeg_strings (Config::instance()->reference_filters());
                s << "ab_" << Config::instance()->reference_scaler()->id() << "_" << fa.first << "_" << fa.second;
-               p /= s.str ();
        }
-       
+
+       return s.str ();
+}
+         
+/** @return The path to the directory to write video frame info files to */
+string
+Film::info_dir () const
+{
+       boost::filesystem::path p;
+       p /= "info";
+       p /= video_state_identifier ();
        return dir (p.string());
 }
 
-/** Add suitable Jobs to the JobManager to create a DCP for this Film.
- *  @param true to transcode, false to use the WAV and J2K files that are already there.
- */
+string
+Film::video_mxf_dir () const
+{
+       boost::filesystem::path p;
+       return dir ("video");
+}
+
+string
+Film::video_mxf_filename () const
+{
+       return video_state_identifier() + ".mxf";
+}
+
+/** Add suitable Jobs to the JobManager to create a DCP for this Film */
 void
-Film::make_dcp (bool transcode)
+Film::make_dcp ()
 {
        set_dci_date_today ();
        
        if (dcp_name().find ("/") != string::npos) {
-               throw BadSettingError ("name", "cannot contain slashes");
+               throw BadSettingError ("name", _("cannot contain slashes"));
        }
        
        log()->log (String::compose ("DVD-o-matic %1 git %2 using %3", dvdomatic_version, dvdomatic_git_commit, dependency_version_summary()));
@@ -297,16 +296,11 @@ Film::make_dcp (bool transcode)
 
        shared_ptr<Job> r;
 
-       if (transcode) {
-               if (dcp_ab()) {
-                       r = JobManager::instance()->add (shared_ptr<Job> (new ABTranscodeJob (shared_from_this(), od, shared_ptr<Job> ())));
-               } else {
-                       r = JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this(), od, shared_ptr<Job> ())));
-               }
+       if (dcp_ab()) {
+               r = JobManager::instance()->add (shared_ptr<Job> (new ABTranscodeJob (shared_from_this(), od)));
+       } else {
+               r = JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this(), od)));
        }
-
-       r = JobManager::instance()->add (shared_ptr<Job> (new CheckHashesJob (shared_from_this(), od, r)));
-       JobManager::instance()->add (shared_ptr<Job> (new MakeDCPJob (shared_from_this(), r)));
 }
 
 /** Start a job to examine our content file */
@@ -317,7 +311,7 @@ Film::examine_content ()
                return;
        }
 
-       _examine_content_job.reset (new ExamineContentJob (shared_from_this(), shared_ptr<Job> ()));
+       _examine_content_job.reset (new ExamineContentJob (shared_from_this()));
        _examine_content_job->Finished.connect (bind (&Film::examine_content_finished, this));
        JobManager::instance()->add (_examine_content_job);
 }
@@ -332,7 +326,7 @@ Film::examine_content_finished ()
 void
 Film::send_dcp_to_tms ()
 {
-       shared_ptr<Job> j (new SCPDCPJob (shared_from_this(), shared_ptr<Job> ()));
+       shared_ptr<Job> j (new SCPDCPJob (shared_from_this()));
        JobManager::instance()->add (j);
 }
 
@@ -347,7 +341,7 @@ Film::encoded_frames () const
        }
 
        int N = 0;
-       for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (j2k_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
+       for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (info_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
                ++N;
                boost::this_thread::interruption_point ();
        }
@@ -377,7 +371,7 @@ Film::write_metadata () const
        f << "content " << _content << "\n";
        f << "trust_content_header " << (_trust_content_header ? "1" : "0") << "\n";
        if (_dcp_content_type) {
-               f << "dcp_content_type " << _dcp_content_type->pretty_name () << "\n";
+               f << "dcp_content_type " << _dcp_content_type->dci_name () << "\n";
        }
        if (_format) {
                f << "format " << _format->as_metadata () << "\n";
@@ -392,9 +386,6 @@ Film::write_metadata () const
        f << "scaler " << _scaler->id () << "\n";
        f << "trim_start " << _trim_start << "\n";
        f << "trim_end " << _trim_end << "\n";
-       if (_reel_size) {
-               f << "reel_size " << _reel_size.get() << "\n";
-       }
        f << "dcp_ab " << (_dcp_ab ? "1" : "0") << "\n";
        if (_content_audio_stream) {
                f << "selected_content_audio_stream " << _content_audio_stream->to_string() << "\n";
@@ -414,14 +405,8 @@ Film::write_metadata () const
        f << "subtitle_scale " << _subtitle_scale << "\n";
        f << "colour_lut " << _colour_lut << "\n";
        f << "j2k_bandwidth " << _j2k_bandwidth << "\n";
-       f << "audio_language " << _audio_language << "\n";
-       f << "subtitle_language " << _subtitle_language << "\n";
-       f << "territory " << _territory << "\n";
-       f << "rating " << _rating << "\n";
-       f << "studio " << _studio << "\n";
-       f << "facility " << _facility << "\n";
-       f << "package_type " << _package_type << "\n";
-
+       _dci_metadata.write (f);
+       f << "dci_date " << boost::gregorian::to_iso_string (_dci_date) << "\n";
        f << "width " << _size.width << "\n";
        f << "height " << _size.height << "\n";
        f << "length " << _length.get_value_or(0) << "\n";
@@ -462,7 +447,7 @@ Film::read_metadata ()
 
        ifstream f (file ("metadata").c_str());
        if (!f.good()) {
-               throw OpenFileError (file("metadata"));
+               throw OpenFileError (file ("metadata"));
        }
        
        multimap<string, string> kv = read_key_value (f);
@@ -491,7 +476,11 @@ Film::read_metadata ()
                } else if (k == "trust_content_header") {
                        _trust_content_header = (v == "1");
                } else if (k == "dcp_content_type") {
-                       _dcp_content_type = DCPContentType::from_pretty_name (v);
+                       if (version < 3) {
+                               _dcp_content_type = DCPContentType::from_pretty_name (v);
+                       } else {
+                               _dcp_content_type = DCPContentType::from_dci_name (v);
+                       }
                } else if (k == "format") {
                        _format = Format::from_metadata (v);
                } else if (k == "left_crop") {
@@ -506,12 +495,10 @@ Film::read_metadata ()
                        _filters.push_back (Filter::from_id (v));
                } else if (k == "scaler") {
                        _scaler = Scaler::from_id (v);
-               } else if ( ((!version || version < 2) && k == "trim_start") || k == "trim_start") {
+               } else if ( ((!version || version < 2) && k == "dcp_trim_start") || k == "trim_start") {
                        _trim_start = atoi (v.c_str ());
-               } else if ( ((!version || version < 2) && k == "trim_end") || k == "trim_end") {
+               } else if ( ((!version || version < 2) && k == "dcp_trim_end") || k == "trim_end") {
                        _trim_end = atoi (v.c_str ());
-               } else if (k == "reel_size") {
-                       _reel_size = boost::lexical_cast<uint64_t> (v);
                } else if (k == "dcp_ab") {
                        _dcp_ab = (v == "1");
                } else if (k == "selected_content_audio_stream" || (!version && k == "selected_audio_stream")) {
@@ -546,21 +533,11 @@ Film::read_metadata ()
                        _colour_lut = atoi (v.c_str ());
                } else if (k == "j2k_bandwidth") {
                        _j2k_bandwidth = atoi (v.c_str ());
-               } else if (k == "audio_language") {
-                       _audio_language = v;
-               } else if (k == "subtitle_language") {
-                       _subtitle_language = v;
-               } else if (k == "territory") {
-                       _territory = v;
-               } else if (k == "rating") {
-                       _rating = v;
-               } else if (k == "studio") {
-                       _studio = v;
-               } else if (k == "facility") {
-                       _facility = v;
-               } else if (k == "package_type") {
-                       _package_type = v;
+               } else if (k == "dci_date") {
+                       _dci_date = boost::gregorian::from_undelimited_string (v);
                }
+
+               _dci_metadata.read (k, v);
                
                /* Cached stuff */
                if (k == "width") {
@@ -612,8 +589,8 @@ Film::read_metadata ()
        _dirty = false;
 }
 
-Size
-Film::cropped_size (Size s) const
+libdcp::Size
+Film::cropped_size (libdcp::Size s) const
 {
        boost::mutex::scoped_lock lm (_state_mutex);
        s.width -= _crop.left + _crop.right;
@@ -628,23 +605,31 @@ string
 Film::dir (string d) const
 {
        boost::mutex::scoped_lock lm (_directory_mutex);
+       
        boost::filesystem::path p;
        p /= _directory;
        p /= d;
+       
        boost::filesystem::create_directories (p);
+       
        return p.string ();
 }
 
 /** Given a file or directory name, return its full path within the Film's directory.
  *  _directory_mutex must not be locked on entry.
+ *  Any required parent directories will be created.
  */
 string
 Film::file (string f) const
 {
        boost::mutex::scoped_lock lm (_directory_mutex);
+
        boost::filesystem::path p;
        p /= _directory;
        p /= f;
+
+       boost::filesystem::create_directories (p.parent_path ());
+       
        return p.string ();
 }
 
@@ -711,7 +696,7 @@ Film::still_duration_in_frames () const
 
 /** @return a DCI-compliant name for a DCP of this film */
 string
-Film::dci_name () const
+Film::dci_name (bool if_created_now) const
 {
        stringstream d;
 
@@ -737,10 +722,12 @@ Film::dci_name () const
                d << format()->dci_name() << "_";
        }
 
-       if (!audio_language().empty ()) {
-               d << audio_language();
-               if (!subtitle_language().empty() && with_subtitles()) {
-                       d << "-" << subtitle_language();
+       DCIMetadata const dm = dci_metadata ();
+
+       if (!dm.audio_language.empty ()) {
+               d << dm.audio_language;
+               if (!dm.subtitle_language.empty() && with_subtitles()) {
+                       d << "-" << dm.subtitle_language;
                } else {
                        d << "-XX";
                }
@@ -748,10 +735,10 @@ Film::dci_name () const
                d << "_";
        }
 
-       if (!territory().empty ()) {
-               d << territory();
-               if (!rating().empty ()) {
-                       d << "-" << rating();
+       if (!dm.territory.empty ()) {
+               d << dm.territory;
+               if (!dm.rating.empty ()) {
+                       d << "-" << dm.rating;
                }
                d << "_";
        }
@@ -773,18 +760,22 @@ Film::dci_name () const
 
        d << "2K_";
 
-       if (!studio().empty ()) {
-               d << studio() << "_";
+       if (!dm.studio.empty ()) {
+               d << dm.studio << "_";
        }
 
-       d << boost::gregorian::to_iso_string (_dci_date) << "_";
+       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) << "_";
+       }
 
-       if (!facility().empty ()) {
-               d << facility() << "_";
+       if (!dm.facility.empty ()) {
+               d << dm.facility << "_";
        }
 
-       if (!package_type().empty ()) {
-               d << package_type();
+       if (!dm.package_type.empty ()) {
+               d << dm.package_type;
        }
 
        return d.str ();
@@ -792,10 +783,10 @@ Film::dci_name () const
 
 /** @return name to give the DCP */
 string
-Film::dcp_name () const
+Film::dcp_name (bool if_created_now) const
 {
        if (use_dci_name()) {
-               return dci_name ();
+               return dci_name (if_created_now);
        }
 
        return name();
@@ -835,16 +826,8 @@ Film::set_content (string c)
 {
        string check = directory ();
 
-#if BOOST_FILESYSTEM_VERSION == 3
        boost::filesystem::path slash ("/");
        string platform_slash = slash.make_preferred().string ();
-#else
-#ifdef DVDOMATIC_WINDOWS
-       string platform_slash = "\\";
-#else
-       string platform_slash = "/";
-#endif
-#endif 
 
        if (!ends_with (check, platform_slash)) {
                check += platform_slash;
@@ -878,7 +861,7 @@ Film::set_content (string c)
        */
 
        try {
-               Decoders d = decoder_factory (shared_from_this(), DecodeOptions(), 0);
+               Decoders d = decoder_factory (shared_from_this(), DecodeOptions());
                
                set_size (d.video->native_size ());
                set_frames_per_second (d.video->frames_per_second ());
@@ -1072,26 +1055,6 @@ Film::set_trim_end (int t)
        signal_changed (TRIM_END);
 }
 
-void
-Film::set_reel_size (uint64_t s)
-{
-       {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               _reel_size = s;
-       }
-       signal_changed (REEL_SIZE);
-}
-
-void
-Film::unset_reel_size ()
-{
-       {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               _reel_size = boost::optional<uint64_t> ();
-       }
-       signal_changed (REEL_SIZE);
-}
-
 void
 Film::set_dcp_ab (bool a)
 {
@@ -1120,7 +1083,7 @@ Film::set_external_audio (vector<string> a)
                _external_audio = a;
        }
 
-       shared_ptr<ExternalAudioDecoder> decoder (new ExternalAudioDecoder (shared_from_this(), DecodeOptions(), 0));
+       shared_ptr<ExternalAudioDecoder> decoder (new ExternalAudioDecoder (shared_from_this(), DecodeOptions()));
        if (decoder->audio_stream()) {
                _external_audio_stream = decoder->audio_stream ();
        }
@@ -1230,77 +1193,17 @@ Film::set_j2k_bandwidth (int b)
 }
 
 void
-Film::set_audio_language (string l)
+Film::set_dci_metadata (DCIMetadata m)
 {
        {
                boost::mutex::scoped_lock lm (_state_mutex);
-               _audio_language = l;
+               _dci_metadata = m;
        }
        signal_changed (DCI_METADATA);
 }
 
 void
-Film::set_subtitle_language (string l)
-{
-       {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               _subtitle_language = l;
-       }
-       signal_changed (DCI_METADATA);
-}
-
-void
-Film::set_territory (string t)
-{
-       {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               _territory = t;
-       }
-       signal_changed (DCI_METADATA);
-}
-
-void
-Film::set_rating (string r)
-{
-       {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               _rating = r;
-       }
-       signal_changed (DCI_METADATA);
-}
-
-void
-Film::set_studio (string s)
-{
-       {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               _studio = s;
-       }
-       signal_changed (DCI_METADATA);
-}
-
-void
-Film::set_facility (string f)
-{
-       {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               _facility = f;
-       }
-       signal_changed (DCI_METADATA);
-}
-
-void
-Film::set_package_type (string p)
-{
-       {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               _package_type = p;
-       }
-       signal_changed (DCI_METADATA);
-}
-
-void
-Film::set_size (Size s)
+Film::set_size (libdcp::Size s)
 {
        {
                boost::mutex::scoped_lock lm (_state_mutex);
@@ -1419,44 +1322,57 @@ Film::audio_stream () const
        return _external_audio_stream;
 }
 
-/** @param f DCP frame index.
- *  @param t true to return a temporary file path, otherwise a permanent one.
- *  @return The path to write this video frame to.
- */
 string
-Film::frame_out_path (int f, bool t) const
+Film::info_path (int f) const
 {
+       boost::filesystem::path p;
+       p /= info_dir ();
+
        stringstream s;
-       s << j2k_dir() << "/";
        s.width (8);
-       s << std::setfill('0') << f << ".j2c";
+       s << setfill('0') << f << ".md5";
 
-       if (t) {
-               s << ".tmp";
-       }
+       p /= s.str();
 
-       return s.str ();
+       /* info_dir() will already have added any initial bit of the path,
+          so don't call file() on this.
+       */
+       return p.string ();
 }
 
 string
-Film::hash_out_path (int f, bool t) const
+Film::j2c_path (int f, bool t) const
 {
-       return frame_out_path (f, t) + ".md5";
-}
+       boost::filesystem::path p;
+       p /= "j2c";
+       p /= video_state_identifier ();
 
-/** @param c Audio channel index.
- *  @param t true to return a temporary file path, otherwise a permanent one.
- *  @return The path to write this audio file to.
- */
-string
-Film::multichannel_audio_out_path (int c, bool t) const
-{
        stringstream s;
-       s << dir ("wavs") << "/" << (c + 1) << ".wav";
+       s.width (8);
+       s << setfill('0') << f << ".j2c";
+
        if (t) {
                s << ".tmp";
        }
-       
-       return s.str ();
+
+       p /= s.str();
+       return file (p.string ());
 }
 
+/** Make an educated guess as to whether we have a complete DCP
+ *  or not.
+ *  @return true if we do.
+ */
+
+bool
+Film::have_dcp () const
+{
+       try {
+               libdcp::DCP dcp (dir (dcp_name()));
+               dcp.read ();
+       } catch (...) {
+               return false;
+       }
+
+       return true;
+}