add finite state machine to control/manage transport state

[ardour.git] / libs / ardour / ardour / export_status.h

diff --git a/libs/ardour/ardour/export_status.h b/libs/ardour/ardour/export_status.h
index 5a50777f946e088bef948af23934729c5459340b..7f36e60e061301209a31ffd8b6c54050d448ad19 100644 (file)
--- a/libs/ardour/ardour/export_status.h
+++ b/libs/ardour/ardour/export_status.h
@@ -1,29 +1,32 @@
 /*
-    Copyright (C) 2008 Paul Davis
-    Author: Sakari Bergen
-
-    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
-    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,
-    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.
-
-*/
+ * Copyright (C) 2008-2012 Sakari Bergen <sakari.bergen@beatwaves.net>
+ * Copyright (C) 2008-2017 Paul Davis <paul@linuxaudiosystems.com>
+ * Copyright (C) 2008 Nick Mainsbridge <mainsbridge@gmail.com>
+ * Copyright (C) 2009-2012 David Robillard <d@drobilla.net>
+ * Copyright (C) 2016-2019 Robin Gareus <robin@gareus.org>
+ *
+ * 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
+ * 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,
+ * 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.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
 
 #ifndef __ardour_export_status_h__
 #define __ardour_export_status_h__
 
-#include <list>
 #include <stdint.h>
 
+#include "ardour/libardour_visibility.h"
+#include "ardour/export_analysis.h"
 #include "ardour/types.h"
 
 #include "pbd/signals.h"
@@ -31,44 +34,63 @@
 namespace ARDOUR
 {
 
-struct ExportStatus {
-
+class LIBARDOUR_API ExportStatus {
+  public:
        ExportStatus ();
        void init ();
 
        /* Status info */
 
        volatile bool           stop;
-       volatile bool           running;
 
-       PBD::Signal0<void>      Aborting;
        void abort (bool error_occurred = false);
        bool aborted () const { return _aborted; }
        bool errors () const { return _errors; }
+       bool running () const { return _running; }
 
-       PBD::Signal0<void>      Finished;
-       void finish ();
-       bool finished () const { return _finished; }
+       void set_running (bool r) {
+               assert (!_run_lock.trylock()); // must hold lock
+               _running = r;
+       }
+       Glib::Threads::Mutex& lock () { return _run_lock; }
+
+       PBD::Signal1<void,TransportRequestSource> Finished;
+       void finish (TransportRequestSource);
+
+       void cleanup ();
 
        /* Progress info */
 
-       volatile float          progress;
-       volatile bool           normalizing;
+       volatile enum Progress {
+               Exporting,
+               Normalizing,
+               Encoding,
+               Tagging,
+               Uploading,
+               Command }
+                               active_job;
 
        volatile uint32_t       total_timespans;
        volatile uint32_t       timespan;
+       std::string             timespan_name;
+
+       volatile samplecnt_t    total_samples;
+       volatile samplecnt_t    processed_samples;
+
+       volatile samplecnt_t    total_samples_current_timespan;
+       volatile samplecnt_t    processed_samples_current_timespan;
 
-       volatile framecnt_t     total_frames;
-       volatile framecnt_t     processed_frames;
+       volatile uint32_t       total_postprocessing_cycles;
+       volatile uint32_t       current_postprocessing_cycle;
 
-       volatile uint32_t       total_normalize_cycles;
-       volatile uint32_t       current_normalize_cycle;
+       AnalysisResults         result_map;
 
   private:
        volatile bool          _aborted;
        volatile bool          _errors;
-       volatile bool          _finished;
+       volatile bool          _running;
 
+       Glib::Threads::Mutex   _run_lock;
 };
 
 } // namespace ARDOUR