Hand-apply 111f02f4fc8ace359a16aea1c88c2821bf3dde31 from master; improve progress...

[dcpomatic.git] / src / lib / job.cc

diff --git a/src/lib/job.cc b/src/lib/job.cc
index b543a043f0550cc176af9874834633dc678a9128..68aa6230abf150574c85a1b36084775b73c087f2 100644 (file)
--- a/src/lib/job.cc
+++ b/src/lib/job.cc
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -23,20 +23,24 @@
 
 #include <boost/thread.hpp>
 #include <boost/filesystem.hpp>
-#include <libdcp/exceptions.h>
+#include <dcp/exceptions.h>
 #include "job.h"
 #include "util.h"
 #include "cross.h"
 #include "ui_signaller.h"
 #include "exceptions.h"
+#include "film.h"
+#include "log.h"
 
 #include "i18n.h"
 
 using std::string;
 using std::list;
 using std::cout;
-using std::stringstream;
 using boost::shared_ptr;
+using boost::optional;
+
+#define LOG_ERROR_NC(...) _film->log()->log (__VA_ARGS__, Log::TYPE_ERROR);
 
 Job::Job (shared_ptr<const Film> f)
        : _film (f)
@@ -66,8 +70,8 @@ Job::run_wrapper ()
 
                run ();
 
-       } catch (libdcp::FileError& e) {
-               
+       } catch (dcp::FileError& e) {
+
                string m = String::compose (_("An error occurred whilst handling the file %1."), boost::filesystem::path (e.filename()).leaf());
 
                try {
@@ -108,7 +112,7 @@ Job::run_wrapper ()
 
                set_error (
                        e.what (),
-                       _("It is not known what caused this error.  The best idea is to report the problem to the DCP-o-matic mailing list (carl@dcpomatic.com)")
+                       string (_("It is not known what caused this error.")) + "  " + REPORT_PROBLEM
                        );
 
                set_progress (1);
@@ -118,7 +122,7 @@ Job::run_wrapper ()
 
                set_error (
                        _("Unknown error"),
-                       _("It is not known what caused this error.  The best idea is to report the problem to the DCP-o-matic mailing list (carl@dcpomatic.com)")
+                       string (_("It is not known what caused this error.")) + "  " + REPORT_PROBLEM
                        );
 
                set_progress (1);
@@ -187,7 +191,7 @@ void
 Job::set_state (State s)
 {
        bool finished = false;
-       
+
        {
                boost::mutex::scoped_lock lm (_state_mutex);
                _state = s;
@@ -201,7 +205,7 @@ Job::set_state (State s)
 
        if (finished && ui_signaller) {
                ui_signaller->emit (boost::bind (boost::ref (Finished)));
-       }
+       }       
 }
 
 /** @return DCPTime (in seconds) that this sub-job has been running */
@@ -221,7 +225,7 @@ Job::elapsed_time () const
 void
 Job::set_progress (float p, bool force)
 {
-       if (!force && fabs (p - progress()) < 0.01) {
+       if (!force && fabs (p - progress().get_value_or(0)) < 0.01) {
                /* Calm excessive progress reporting */
                return;
        }
@@ -230,8 +234,9 @@ Job::set_progress (float p, bool force)
        _progress = p;
        boost::this_thread::interruption_point ();
 
-       if (paused ()) {
-               dcpomatic_sleep (1);
+       boost::mutex::scoped_lock lm2 (_state_mutex);
+       while (_state == PAUSED) {
+               _pause_changed.wait (lm2);
        }
 
        if (ui_signaller) {
@@ -239,12 +244,12 @@ Job::set_progress (float p, bool force)
        }
 }
 
-/** @return fractional progress of this sub-job, or -1 if not known */
-float
+/** @return fractional progress of the current sub-job, if known */
+optional<float>
 Job::progress () const
 {
        boost::mutex::scoped_lock lm (_progress_mutex);
-       return _progress.get_value_or (-1);
+       return _progress;
 }
 
 void
@@ -279,6 +284,10 @@ Job::error_summary () const
 void
 Job::set_error (string s, string d)
 {
+       LOG_ERROR_NC (s);
+       LOG_ERROR_NC (d);
+       
+       _film->log()->log (String::compose ("Error in job: %1 (%2)", s, d), Log::TYPE_ERROR);
        boost::mutex::scoped_lock lm (_state_mutex);
        _error_summary = s;
        _error_details = d;
@@ -290,26 +299,32 @@ Job::set_progress_unknown ()
 {
        boost::mutex::scoped_lock lm (_progress_mutex);
        _progress.reset ();
+       lm.unlock ();
+
+       if (ui_signaller) {
+               ui_signaller->emit (boost::bind (boost::ref (Progress)));
+       }
 }
 
 /** @return Human-readable status of this job */
 string
 Job::status () const
 {
-       float const p = progress ();
+       optional<float> p = progress ();
        int const t = elapsed_time ();
        int const r = remaining_time ();
 
-       int pc = rint (p * 100);
-       if (pc == 100) {
-               /* 100% makes it sound like we've finished when we haven't */
-               pc = 99;
-       }
-
-       stringstream s;
-       if (!finished ()) {
+       SafeStringStream s;
+       if (!finished () && p) {
+               int pc = rint (p.get() * 100);
+               if (pc == 100) {
+                       /* 100% makes it sound like we've finished when we haven't */
+                       pc = 99;
+               }
+               
                s << pc << N_("%");
-               if (p >= 0 && t > 10 && r > 0) {
+               
+               if (t > 10 && r > 0) {
                        /// TRANSLATORS: remaining here follows an amount of time that is remaining
                        /// on an operation.
                        s << "; " << seconds_to_approximate_hms (r) << " " << _("remaining");
@@ -317,7 +332,11 @@ Job::status () const
        } else if (finished_ok ()) {
                s << String::compose (_("OK (ran for %1)"), seconds_to_hms (_ran_for));
        } else if (finished_in_error ()) {
-               s << String::compose (_("Error (%1)"), error_summary());
+               string es = error_summary ();
+               if (es.length() > 25) {
+                       es = es.substr (0, 25) + "...";
+               }
+               s << String::compose (_("Error (%1)"), es);
        } else if (finished_cancelled ()) {
                s << _("Cancelled");
        }
@@ -329,7 +348,11 @@ Job::status () const
 int
 Job::remaining_time () const
 {
-       return elapsed_time() / progress() - elapsed_time();
+       if (progress().get_value_or(0) == 0) {
+               return elapsed_time ();
+       }
+       
+       return elapsed_time() / progress().get() - elapsed_time();
 }
 
 void
@@ -348,6 +371,7 @@ Job::pause ()
 {
        if (running ()) {
                set_state (PAUSED);
+               _pause_changed.notify_all ();
        }
 }
 
@@ -356,5 +380,6 @@ Job::resume ()
 {
        if (paused ()) {
                set_state (RUNNING);
+               _pause_changed.notify_all ();
        }
 }