Merge master.
[dcpomatic.git] / src / lib / job.cc
index 18df40878f8feafae345fa64786be06d51e0ecaf..e48daa4109bbfb935fdc1f532a0d6947c9a276f9 100644 (file)
@@ -23,7 +23,7 @@
 
 #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"
@@ -34,6 +34,7 @@
 
 using std::string;
 using std::list;
+using std::cout;
 using std::stringstream;
 using boost::shared_ptr;
 
@@ -42,10 +43,10 @@ Job::Job (shared_ptr<const Film> f)
        , _thread (0)
        , _state (NEW)
        , _start_time (0)
-       , _progress_unknown (false)
+       , _progress (0)
        , _ran_for (0)
 {
-       descend (1);
+
 }
 
 /** Start the job in a separate thread, returning immediately */
@@ -65,10 +66,7 @@ Job::run_wrapper ()
 
                run ();
 
-       } catch (libdcp::FileError& e) {
-               
-               set_progress (1);
-               set_state (FINISHED_ERROR);
+       } catch (dcp::FileError& e) {
                
                string m = String::compose (_("An error occurred whilst handling the file %1."), boost::filesystem::path (e.filename()).leaf());
 
@@ -83,39 +81,48 @@ Job::run_wrapper ()
                }
 
                set_error (e.what(), m);
-
-       } catch (OpenFileError& e) {
-
                set_progress (1);
                set_state (FINISHED_ERROR);
+               
+       } catch (OpenFileError& e) {
 
                set_error (
                        String::compose (_("Could not open %1"), e.file().string()),
                        String::compose (_("DCP-o-matic could not open the file %1.  Perhaps it does not exist or is in an unexpected format."), e.file().string())
                        );
 
+               set_progress (1);
+               set_state (FINISHED_ERROR);
+
        } catch (boost::thread_interrupted &) {
 
                set_state (FINISHED_CANCELLED);
-               
-       } catch (std::exception& e) {
 
+       } catch (std::bad_alloc& e) {
+
+               set_error (_("Out of memory"), _("There was not enough memory to do this."));
                set_progress (1);
                set_state (FINISHED_ERROR);
+               
+       } catch (std::exception& e) {
+
                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 (dcpomatic@carlh.net)")
+                       _("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)")
                        );
 
-       } catch (...) {
-
                set_progress (1);
                set_state (FINISHED_ERROR);
+               
+       } catch (...) {
+
                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 (dcpomatic@carlh.net)")
+                       _("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)")
                        );
 
+               set_progress (1);
+               set_state (FINISHED_ERROR);
        }
 }
 
@@ -179,18 +186,25 @@ Job::paused () const
 void
 Job::set_state (State s)
 {
-       boost::mutex::scoped_lock lm (_state_mutex);
-       _state = s;
+       bool finished = false;
+
+       {
+               boost::mutex::scoped_lock lm (_state_mutex);
+               _state = s;
 
-       if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
-               _ran_for = elapsed_time ();
-               if (ui_signaller) {
-                       ui_signaller->emit (boost::bind (boost::ref (Finished)));
+               if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
+                       _ran_for = elapsed_time ();
+                       finished = true;
+                       _sub_name.clear ();
                }
        }
+
+       if (finished && ui_signaller) {
+               ui_signaller->emit (boost::bind (boost::ref (Finished)));
+       }       
 }
 
-/** @return Time (in seconds) that this job has been running */
+/** @return DCPTime (in seconds) that this sub-job has been running */
 int
 Job::elapsed_time () const
 {
@@ -205,11 +219,15 @@ Job::elapsed_time () const
  *  @param p Progress (from 0 to 1)
  */
 void
-Job::set_progress (float p)
+Job::set_progress (float p, bool force)
 {
+       if (!force && fabs (p - progress()) < 0.01) {
+               /* Calm excessive progress reporting */
+               return;
+       }
+
        boost::mutex::scoped_lock lm (_progress_mutex);
-       _progress_unknown = false;
-       _stack.back().normalised = p;
+       _progress = p;
        boost::this_thread::interruption_point ();
 
        if (paused ()) {
@@ -221,54 +239,23 @@ Job::set_progress (float p)
        }
 }
 
-/** @return fractional overall progress, or -1 if not known */
+/** @return fractional progress of the current sub-job, or -1 if not known */
 float
-Job::overall_progress () const
+Job::progress () const
 {
        boost::mutex::scoped_lock lm (_progress_mutex);
-       if (_progress_unknown) {
-               return -1;
-       }
-
-       float overall = 0;
-       float factor = 1;
-       for (list<Level>::const_iterator i = _stack.begin(); i != _stack.end(); ++i) {
-               factor *= i->allocation;
-               overall += i->normalised * factor;
-       }
-
-       if (overall > 1) {
-               overall = 1;
-       }
-       
-       return overall;
+       return _progress.get_value_or (-1);
 }
 
-/** Ascend up one level in terms of progress reporting; see descend() */
 void
-Job::ascend ()
+Job::sub (string n)
 {
-       boost::mutex::scoped_lock lm (_progress_mutex);
+       {
+               boost::mutex::scoped_lock lm (_progress_mutex);
+               _sub_name = n;
+       }
        
-       assert (!_stack.empty ());
-       float const a = _stack.back().allocation;
-       _stack.pop_back ();
-       _stack.back().normalised += a;
-}
-
-/** Descend down one level in terms of progress reporting; e.g. if
- *  there is a task which is split up into N subtasks, each of which
- *  report their progress from 0 to 100%, call descend() before executing
- *  each subtask, and ascend() afterwards to ensure that overall progress
- *  is reported correctly.
- *
- *  @param a Fraction (from 0 to 1) of the current task to allocate to the subtask.
- */
-void
-Job::descend (float a)
-{
-       boost::mutex::scoped_lock lm (_progress_mutex);
-       _stack.push_back (Level (a));
+       set_progress (0, true);
 }
 
 string
@@ -302,14 +289,14 @@ void
 Job::set_progress_unknown ()
 {
        boost::mutex::scoped_lock lm (_progress_mutex);
-       _progress_unknown = true;
+       _progress.reset ();
 }
 
 /** @return Human-readable status of this job */
 string
 Job::status () const
 {
-       float const p = overall_progress ();
+       float const p = progress ();
        int const t = elapsed_time ();
        int const r = remaining_time ();
 
@@ -338,11 +325,34 @@ Job::status () const
        return s.str ();
 }
 
-/** @return An estimate of the remaining time for this job, in seconds */
+string
+Job::json_status () const
+{
+       boost::mutex::scoped_lock lm (_state_mutex);
+
+       switch (_state) {
+       case NEW:
+               return N_("new");
+       case RUNNING:
+               return N_("running");
+       case PAUSED:
+               return N_("paused");
+       case FINISHED_OK:
+               return N_("finished_ok");
+       case FINISHED_ERROR:
+               return N_("finished_error");
+       case FINISHED_CANCELLED:
+               return N_("finished_cancelled");
+       }
+
+       return "";
+}
+
+/** @return An estimate of the remaining time for this sub-job, in seconds */
 int
 Job::remaining_time () const
 {
-       return elapsed_time() / overall_progress() - elapsed_time();
+       return elapsed_time() / progress() - elapsed_time();
 }
 
 void