Various Doxygen fixes.
[dcpomatic.git] / src / lib / job.cc
index 6e2bc9f53bed706910be46e5414efd9e253c43fa..31f336b6565500633c5479e1d01ba85c155a927f 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
 #include "log.h"
 #include "compose.hpp"
 #include <dcp/exceptions.h>
+#include <sub/exceptions.h>
 #include <boost/thread.hpp>
 #include <boost/filesystem.hpp>
+#include <boost/foreach.hpp>
+#include <boost/date_time/posix_time/posix_time.hpp>
 #include <iostream>
 
 #include "i18n.h"
@@ -43,8 +46,8 @@ using boost::shared_ptr;
 using boost::optional;
 using boost::function;
 
-#define LOG_ERROR_NC(...) _film->log()->log (__VA_ARGS__, LogEntry::TYPE_ERROR);
-#define LOG_GENERAL(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
+#define LOG_ERROR_NC(...) if (_film) { _film->log()->log (__VA_ARGS__, LogEntry::TYPE_ERROR); }
+#define LOG_GENERAL(...) if (_film) { _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL); }
 
 /** @param film Associated film, or 0 */
 Job::Job (shared_ptr<const Film> film)
@@ -149,6 +152,17 @@ Job::run_wrapper ()
 
                set_state (FINISHED_CANCELLED);
 
+       } catch (sub::SubripError& e) {
+
+               string extra = "Error is near:\n";
+               BOOST_FOREACH (string i, e.context()) {
+                       extra += i + "\n";
+               }
+
+               set_error (e.what (), extra);
+               set_progress (1);
+               set_state (FINISHED_ERROR);
+
        } catch (std::bad_alloc& e) {
 
                set_error (_("Out of memory"), _("There was not enough memory to do this.  If you are running a 32-bit operating system try reducing the number of encoding threads in the General tab of Preferences."));
@@ -225,10 +239,17 @@ Job::finished_cancelled () const
 }
 
 bool
-Job::paused () const
+Job::paused_by_user () const
+{
+       boost::mutex::scoped_lock lm (_state_mutex);
+       return _state == PAUSED_BY_USER;
+}
+
+bool
+Job::paused_by_priority () const
 {
        boost::mutex::scoped_lock lm (_state_mutex);
-       return _state == PAUSED;
+       return _state == PAUSED_BY_PRIORITY;
 }
 
 /** Set the state of this job.
@@ -266,12 +287,28 @@ Job::elapsed_sub_time () const
        return time (0) - _sub_start_time;
 }
 
+/** Check to see if this job has been interrupted or paused */
+void
+Job::check_for_interruption_or_pause ()
+{
+       boost::this_thread::interruption_point ();
+
+       boost::mutex::scoped_lock lm (_state_mutex);
+       while (_state == PAUSED_BY_USER || _state == PAUSED_BY_PRIORITY) {
+               emit (boost::bind (boost::ref (Progress)));
+               _pause_changed.wait (lm);
+       }
+}
+
 /** Set the progress of the current part of the job.
  *  @param p Progress (from 0 to 1)
+ *  @param force Do not ignore this update, even if it hasn't been long since the last one.
  */
 void
 Job::set_progress (float p, bool force)
 {
+       check_for_interruption_or_pause ();
+
        if (!force) {
                /* Check for excessively frequent progress reporting */
                boost::mutex::scoped_lock lm (_progress_mutex);
@@ -293,18 +330,11 @@ Job::set_progress (float p, bool force)
 void
 Job::set_progress_common (optional<float> p)
 {
-       boost::mutex::scoped_lock lm (_progress_mutex);
-       _progress = p;
-       boost::this_thread::interruption_point ();
-
-       boost::mutex::scoped_lock lm2 (_state_mutex);
-       while (_state == PAUSED) {
-               _pause_changed.wait (lm2);
+       {
+               boost::mutex::scoped_lock lm (_progress_mutex);
+               _progress = p;
        }
 
-       lm.unlock ();
-       lm2.unlock ();
-
        emit (boost::bind (boost::ref (Progress)));
 }
 
@@ -345,7 +375,8 @@ Job::error_summary () const
 }
 
 /** Set the current error string.
- *  @param e New error string.
+ *  @param s New error string.
+ *  @param d New error detail string.
  */
 void
 Job::set_error (string s, string d)
@@ -365,6 +396,7 @@ Job::set_error (string s, string d)
 void
 Job::set_progress_unknown ()
 {
+       check_for_interruption_or_pause ();
        set_progress_common (optional<float> ());
 }
 
@@ -389,9 +421,22 @@ Job::status () const
                s += buffer;
 
                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");
+                       boost::posix_time::ptime now = boost::posix_time::second_clock::local_time();
+                       boost::posix_time::ptime finish = now + boost::posix_time::seconds(r);
+                       char finish_string[6];
+                       snprintf (finish_string, sizeof(finish_string), "%02d:%02d", finish.time_of_day().hours(), finish.time_of_day().minutes());
+                       string day;
+                       if (now.date() != finish.date()) {
+                               /// TRANSLATORS: the %1 in this string will be filled in with a day of the week
+                               /// to say what day a job will finish.
+                               day = String::compose (_(" on %1"), finish.date().day_of_week().as_long_string());
+                       }
+                       /// TRANSLATORS: "remaining; finishing at" here follows an amount of time that is remaining
+                       /// on an operation; after it is an estimated wall-clock completion time.
+                       s += String::compose(
+                               _("; %1 remaining; finishing at %2%3"),
+                               seconds_to_approximate_hms(r), finish_string, day
+                               );
                }
        } else if (finished_ok ()) {
                s = String::compose (_("OK (ran for %1)"), seconds_to_hms (_ran_for));
@@ -414,7 +459,8 @@ Job::json_status () const
                return N_("new");
        case RUNNING:
                return N_("running");
-       case PAUSED:
+       case PAUSED_BY_USER:
+       case PAUSED_BY_PRIORITY:
                return N_("paused");
        case FINISHED_OK:
                return N_("finished_ok");
@@ -445,7 +491,7 @@ Job::cancel ()
                return;
        }
 
-       if (paused ()) {
+       if (paused_by_user() || paused_by_priority()) {
                resume ();
        }
 
@@ -457,10 +503,19 @@ Job::cancel ()
 }
 
 void
-Job::pause ()
+Job::pause_by_user ()
+{
+       if (running ()) {
+               set_state (PAUSED_BY_USER);
+               _pause_changed.notify_all ();
+       }
+}
+
+void
+Job::pause_by_priority ()
 {
        if (running ()) {
-               set_state (PAUSED);
+               set_state (PAUSED_BY_PRIORITY);
                _pause_changed.notify_all ();
        }
 }
@@ -468,7 +523,7 @@ Job::pause ()
 void
 Job::resume ()
 {
-       if (paused ()) {
+       if (paused_by_user() || paused_by_priority()) {
                set_state (RUNNING);
                _pause_changed.notify_all ();
        }