Rename SafeStringStream -> locked_stringstream. Bump deps for removal of stringstream.
[dcpomatic.git] / src / lib / job.cc
index 42d6160c773b4f744fcabaa8576063093795041c..585e8fb0d29ace1bdf905fe9ab5fdab691a20fcc 100644 (file)
@@ -1,19 +1,20 @@
 /*
     Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
@@ -42,7 +43,8 @@ using boost::shared_ptr;
 using boost::optional;
 using boost::function;
 
-#define LOG_ERROR_NC(...) _film->log()->log (__VA_ARGS__, Log::TYPE_ERROR);
+#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);
 
 /** @param film Associated film, or 0 */
 Job::Job (shared_ptr<const Film> film)
@@ -50,6 +52,7 @@ Job::Job (shared_ptr<const Film> film)
        , _thread (0)
        , _state (NEW)
        , _start_time (0)
+       , _sub_start_time (0)
        , _progress (0)
        , _ran_for (0)
 {
@@ -60,8 +63,14 @@ Job::~Job ()
 {
        if (_thread) {
                _thread->interrupt ();
-               DCPOMATIC_ASSERT (_thread->joinable ());
-               _thread->join ();
+               /* We can't use DCPOMATIC_ASSERT here as it may throw an exception */
+               if (_thread->joinable ()) {
+                       try {
+                               _thread->join ();
+                       } catch (...) {
+                               /* Too late to do anything about this */
+                       }
+               }
        }
 
        delete _thread;
@@ -73,6 +82,7 @@ Job::start ()
 {
        set_state (RUNNING);
        _start_time = time (0);
+       _sub_start_time = time (0);
        _thread = new boost::thread (boost::bind (&Job::run_wrapper, this));
 }
 
@@ -106,7 +116,10 @@ Job::run_wrapper ()
 
                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())
+                       String::compose (
+                               _("DCP-o-matic could not open the file %1.  Perhaps it does not exist or is in an unexpected format."),
+                               boost::filesystem::absolute (e.file()).string()
+                               )
                        );
 
                set_progress (1);
@@ -117,7 +130,10 @@ Job::run_wrapper ()
                if (e.code() == boost::system::errc::no_such_file_or_directory) {
                        set_error (
                                String::compose (_("Could not open %1"), e.path1().string ()),
-                               String::compose (_("DCP-o-matic could not open the file %1.  Perhaps it does not exist or is in an unexpected format."), e.path1().string())
+                               String::compose (
+                                       _("DCP-o-matic could not open the file %1.  Perhaps it does not exist or is in an unexpected format."),
+                                       boost::filesystem::absolute (e.path1()).string()
+                                       )
                                );
                } else {
                        set_error (
@@ -228,7 +244,7 @@ Job::set_state (State s)
                _state = s;
 
                if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
-                       _ran_for = elapsed_time ();
+                       _ran_for = time(0) - _start_time;
                        finished = true;
                        _sub_name.clear ();
                }
@@ -241,13 +257,13 @@ Job::set_state (State s)
 
 /** @return DCPTime (in seconds) that this sub-job has been running */
 int
-Job::elapsed_time () const
+Job::elapsed_sub_time () const
 {
-       if (_start_time == 0) {
+       if (_sub_start_time == 0) {
                return 0;
        }
 
-       return time (0) - _start_time;
+       return time (0) - _sub_start_time;
 }
 
 /** Set the progress of the current part of the job.
@@ -256,9 +272,19 @@ Job::elapsed_time () const
 void
 Job::set_progress (float p, bool force)
 {
-       if (!force && fabs (p - progress().get_value_or(0)) < 0.01) {
-               /* Calm excessive progress reporting */
-               return;
+       if (!force) {
+               /* Check for excessively frequent progress reporting */
+               boost::mutex::scoped_lock lm (_progress_mutex);
+               struct timeval now;
+               gettimeofday (&now, 0);
+               if (_last_progress_update && _last_progress_update->tv_sec > 0) {
+                       double const elapsed = (now.tv_sec + now.tv_usec / 1000000.0)
+                               - (_last_progress_update->tv_sec + _last_progress_update->tv_usec / 1000000.0);
+                       if (elapsed < 0.5) {
+                               return;
+                       }
+               }
+               _last_progress_update = now;
        }
 
        set_progress_common (p);
@@ -295,10 +321,12 @@ Job::sub (string n)
 {
        {
                boost::mutex::scoped_lock lm (_progress_mutex);
+               LOG_GENERAL ("Sub-job %1 starting", n);
                _sub_name = n;
        }
 
        set_progress (0, true);
+       _sub_start_time = time (0);
 }
 
 string
@@ -325,7 +353,7 @@ Job::set_error (string s, string d)
        if (_film) {
                LOG_ERROR_NC (s);
                LOG_ERROR_NC (d);
-               _film->log()->log (String::compose ("Error in job: %1 (%2)", s, d), Log::TYPE_ERROR);
+               _film->log()->log (String::compose ("Error in job: %1 (%2)", s, d), LogEntry::TYPE_ERROR);
        }
 
        boost::mutex::scoped_lock lm (_state_mutex);
@@ -345,10 +373,10 @@ string
 Job::status () const
 {
        optional<float> p = progress ();
-       int const t = elapsed_time ();
+       int const t = elapsed_sub_time ();
        int const r = remaining_time ();
 
-       SafeStringStream s;
+       locked_stringstream s;
        if (!finished () && p) {
                int pc = lrintf (p.get() * 100);
                if (pc == 100) {
@@ -402,10 +430,10 @@ int
 Job::remaining_time () const
 {
        if (progress().get_value_or(0) == 0) {
-               return elapsed_time ();
+               return elapsed_sub_time ();
        }
 
-       return elapsed_time() / progress().get() - elapsed_time();
+       return elapsed_sub_time() / progress().get() - elapsed_sub_time();
 }
 
 void