Increase frequency of progres updates on long jobs (#900).

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

diff --git a/src/lib/job.cc b/src/lib/job.cc
index 87e4fb3d370c783a99802eaf8dcc09e5e3a2af1c..0699c532c0fa4c69582bf954efa194b9b1ebcce4 100644 (file)
--- a/src/lib/job.cc
+++ b/src/lib/job.cc
@@ -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/>.
 
 */
 
@@ -31,6 +32,7 @@
 #include <dcp/exceptions.h>
 #include <boost/thread.hpp>
 #include <boost/filesystem.hpp>
+#include <iostream>
 
 #include "i18n.h"
 
@@ -39,9 +41,12 @@ using std::list;
 using std::cout;
 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)
        : _film (film)
        , _thread (0)
@@ -53,6 +58,23 @@ Job::Job (shared_ptr<const Film> film)
 
 }
 
+Job::~Job ()
+{
+       if (_thread) {
+               _thread->interrupt ();
+               /* 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;
+}
+
 /** Start the job in a separate thread, returning immediately */
 void
 Job::start ()
@@ -92,7 +114,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);
@@ -103,7 +128,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 (
@@ -121,7 +149,7 @@ Job::run_wrapper ()
 
        } catch (std::bad_alloc& e) {
 
-               set_error (_("Out of memory"), _("There was not enough memory to do this."));
+               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."));
                set_progress (1);
                set_state (FINISHED_ERROR);
 
@@ -242,9 +270,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);
@@ -281,6 +319,7 @@ Job::sub (string n)
 {
        {
                boost::mutex::scoped_lock lm (_progress_mutex);
+               LOG_GENERAL ("Sub-job %1 starting", n);
                _sub_name = n;
        }
 
@@ -308,10 +347,12 @@ Job::error_summary () const
 void
 Job::set_error (string s, string d)
 {
-       LOG_ERROR_NC (s);
-       LOG_ERROR_NC (d);
+       if (_film) {
+               LOG_ERROR_NC (s);
+               LOG_ERROR_NC (d);
+               _film->log()->log (String::compose ("Error in job: %1 (%2)", s, d), LogEntry::TYPE_ERROR);
+       }
 
-       _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;
@@ -404,7 +445,10 @@ Job::cancel ()
        }
 
        _thread->interrupt ();
+       DCPOMATIC_ASSERT (_thread->joinable ());
        _thread->join ();
+       delete _thread;
+       _thread = 0;
 }
 
 void
@@ -424,3 +468,14 @@ Job::resume ()
                _pause_changed.notify_all ();
        }
 }
+
+void
+Job::when_finished (boost::signals2::connection& connection, function<void()> finished)
+{
+       boost::mutex::scoped_lock lm (_state_mutex);
+       if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
+               finished ();
+       } else {
+               connection = Finished.connect (finished);
+       }
+}