build: split the engine into liboakengine.so; worker drops the UI entirely

Physical split: app/{audio,cli,codec,common,config,node,pluginSupport, render,task,timeline,undo,tool,shaders} plus coreengine, version and ui/icons+colorcoding move to a new top-level engine/ tree, built as liboakengine.so (shared). The render backends (oakgl/oakvulkan) move with it and link the engine library instead of embedding a static render-core subset (libolive-rendercore is gone). - oak-render-worker now links liboakengine instead of the whole libolive-editor object set: 336MB -> 2.9MB, no Qt Widgets UI - the editor links liboakengine for the engine and keeps only UI objects in libolive-editor - install/packaging: GNUInstallDirs libdir on Linux, bundle copy on macOS, oakengine.dll staged for NSIS, AppImage validation entry - fix backend lookup for the new layout: DynamicRenderer searched ../app but backends now live in engine/; a stale pre-split liboakgl in the build tree got dlopened instead, re-initialized and later destroyed the interposed engine statics (full-suite segfault at DialogSequenceParameterTab, found via gdb watchpoint)
2026-07-20 03:23:28 +08:00
parent 026ff94b5e
commit 28c4426236
604 changed files with 243 additions and 172 deletions
@@ -0,0 +1,188 @@
+/***
+
+  Olive - Non-Linear Video Editor
+  Copyright (C) 2022 Olive Team
+  Modifications Copyright (C) 2025 mikesolar
+
+  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 3 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, see <http://www.gnu.org/licenses/>.
+
+***/
+
+#ifndef OAK_TASK_H
+#define OAK_TASK_H
+
+#include <memory>
+#include <QDateTime>
+#include <QDebug>
+#include <QObject>
+
+#include "common/cancelableobject.h"
+
+namespace olive
+{
+
+/**
+ * @brief A base class for background tasks running in Olive.
+ *
+ * Tasks are multithreaded by design (i.e. they will always spawn
+ * a new thread and run in it).
+ *
+ * To subclass your own Task, override Action() and return TRUE on success or FALSE on failure. Note that a Task can
+ * provide a "negative" output and still have succeeded. For example, the ProbeTask's role is to determine whether a
+ * certain media file can be used in Olive. Even if the probe *fails* to find a Decoder for this file, the Task itself
+ * has *succeeded* at discovering this. A failure of ProbeTask would indicate a catastrophic failure meaning it was
+ * unable to determine anything about the file.
+ *
+ * Tasks should be used with the TaskManager which will manage starting and deleting them. It'll also only start as
+ * many Tasks as there are threads on the system as to not overload them.
+ *
+ * Tasks support "dependency tasks", i.e. a Task that should be complete before another Task begins.
+ */
+class Task : public QObject, public CancelableObject {
+	Q_OBJECT
+public:
+	/**
+   * @brief Task Constructor
+   */
+	Task()
+		: title_(tr("Task"))
+		, error_(tr("Unknown error"))
+		, start_time_(0)
+	{
+	}
+
+	/**
+   * @brief Retrieve the current title of this Task
+   */
+	const QString &get_title() const
+	{
+		return title_;
+	}
+
+	/**
+   * @brief Returns the error that occurred if Run() returns false
+   */
+	const QString &get_error() const
+	{
+		return error_;
+	}
+
+	const qint64 &get_start_time() const
+	{
+		return start_time_;
+	}
+
+public slots:
+	/**
+   * @brief Run this task
+   *
+   * @return True if the task completed successfully, false if not.
+   *
+   * \see GetError() if this returns false.
+   */
+	bool start()
+	{
+		start_time_ = QDateTime::currentMSecsSinceEpoch();
+		emit started(start_time_);
+
+		bool ret = run();
+
+		// Print how long this task took for debugging purposes
+		qDebug() << this << "took"
+				 << (QDateTime::currentMSecsSinceEpoch() - start_time_);
+
+		emit finished(this, ret);
+
+		return ret;
+	}
+
+	/**
+   * @brief Reset state so that Run() can be called again.
+   *
+   * Override this if your class holds any persistent state that should be cleared/modified before
+   * it's safe for Run() to run again.
+   */
+	virtual void reset()
+	{
+	}
+
+	/**
+   * @brief Cancel the Task
+   *
+   * Sends a signal to the Task to stop as soon as possible. Always call this directly or connect
+   * with Qt::DirectConnection, or else it'll be queued *after* the task has already finished.
+   */
+	void Cancel()
+	{
+		CancelableObject::cancel();
+	}
+
+protected:
+	virtual bool run() = 0;
+
+	/**
+   * @brief Set the error message
+   *
+   * It is recommended to use this if your Action() function ever returns FALSE to tell the user why the failure
+   * occurred.
+   */
+	void set_error(const QString &s)
+	{
+		error_ = s;
+	}
+
+	/**
+   * @brief Set the Task title
+   *
+   * Used in the UI Task Manager to distinguish Tasks from each other. Generally this should be set in the constructor
+   * and shouldn't need to change during the life of the Task. To show an error message, it's recommended to use
+   * set_error() instead.
+   */
+	void set_title(const QString &s)
+	{
+		title_ = s;
+	}
+
+signals:
+	void started(qint64 start_time);
+
+	/**
+   * @brief Signal emitted whenever progress is made
+   *
+   * Emit this throughout Action() to update any attached ProgressBars on the progress of this Task.
+   *
+   * @param p
+   *
+   * A progress value between 0.0 and 1.0.
+   */
+	void progress_changed(double d);
+
+	/**
+   * @brief Emitted when task is finished
+   *
+   * Do NOT delete immediately after this signal, call deleteLater() instead.
+   */
+	void finished(Task *task, bool succeeded);
+
+private:
+	QString title_;
+
+	QString error_;
+
+	qint64 start_time_;
+};
+
+}
+
+#endif // OAK_TASK_H