The workers run in separate threads meaning if any significant change is made (e.g. parameters changing, or even closing the program), these workers may still be mid-render. This is particularly problematic when closing since the nodes a worker is rendering may be deleted mid-render. Render backends now have a function that pauses the main thread (but starts a second event loop so the UI isn't frozen) until the worker threads are all finished. This way, massive changes can be made safely without race conditions.
151 lines
3.0 KiB
C++
151 lines
3.0 KiB
C++
#ifndef RENDERBACKEND_H
|
|
#define RENDERBACKEND_H
|
|
|
|
#include <QLinkedList>
|
|
|
|
#include "common/constructors.h"
|
|
#include "dialog/rendercancel/rendercancel.h"
|
|
#include "decodercache.h"
|
|
#include "node/graph.h"
|
|
#include "node/output/viewer/viewer.h"
|
|
#include "renderworker.h"
|
|
|
|
class RenderBackend : public QObject
|
|
{
|
|
Q_OBJECT
|
|
public:
|
|
RenderBackend(QObject* parent = nullptr);
|
|
|
|
bool Init();
|
|
|
|
void Close();
|
|
|
|
const QString& GetError() const;
|
|
|
|
void SetViewerNode(ViewerOutput* viewer_node);
|
|
|
|
bool IsInitiated();
|
|
|
|
ViewerOutput* viewer_node() const;
|
|
|
|
void CancelQueue();
|
|
|
|
public slots:
|
|
void InvalidateCache(const rational &start_range, const rational &end_range);
|
|
|
|
bool Compile();
|
|
|
|
void Decompile();
|
|
|
|
signals:
|
|
void QueueComplete();
|
|
|
|
protected:
|
|
void RegenerateCacheID();
|
|
|
|
virtual bool InitInternal() = 0;
|
|
|
|
virtual void CloseInternal() = 0;
|
|
|
|
virtual bool CompileInternal() = 0;
|
|
|
|
virtual void DecompileInternal() = 0;
|
|
|
|
virtual bool CanRender();
|
|
|
|
virtual TimeRange PopNextFrameFromQueue();
|
|
|
|
rational GetSequenceLength();
|
|
|
|
const QVector<QThread*>& threads();
|
|
|
|
/**
|
|
* @brief Internal function for generating the cache ID
|
|
*/
|
|
virtual bool GenerateCacheIDInternal(QCryptographicHash& hash) = 0;
|
|
|
|
virtual void InvalidateCacheInternal(const rational &start_range, const rational &end_range);
|
|
|
|
virtual void CacheIDChangedEvent(const QString& id);
|
|
|
|
void SetError(const QString& error);
|
|
|
|
virtual void ConnectViewer(ViewerOutput* node);
|
|
virtual void DisconnectViewer(ViewerOutput* node);
|
|
|
|
/**
|
|
* @brief Function called when there are frames in the queue to cache
|
|
*
|
|
* This function is NOT thread-safe and should only be called in the main thread.
|
|
*/
|
|
void CacheNext();
|
|
|
|
void InitWorkers();
|
|
|
|
virtual NodeInput* GetDependentInput() = 0;
|
|
|
|
virtual void ConnectWorkerToThis(RenderWorker* worker) = 0;
|
|
|
|
bool ViewerIsConnected() const;
|
|
|
|
const QString& cache_id() const;
|
|
|
|
void QueueValueUpdate();
|
|
|
|
bool AllProcessorsAreAvailable() const;
|
|
bool WorkerIsBusy(RenderWorker* worker) const;
|
|
void SetWorkerBusyState(RenderWorker* worker, bool busy);
|
|
|
|
TimeRangeList cache_queue_;
|
|
|
|
QVector<RenderWorker*> processors_;
|
|
|
|
bool compiled_;
|
|
|
|
QHash<TimeRange, qint64> render_job_info_;
|
|
|
|
protected slots:
|
|
void QueueRecompile();
|
|
|
|
private:
|
|
/**
|
|
* @brief Internal list of RenderProcessThreads
|
|
*/
|
|
QVector<QThread*> threads_;
|
|
|
|
/**
|
|
* @brief Internal variable that contains whether the Renderer has started or not
|
|
*/
|
|
bool started_;
|
|
|
|
/**
|
|
* @brief Internal reference to attached viewer node
|
|
*/
|
|
ViewerOutput* viewer_node_;
|
|
|
|
/**
|
|
* @brief Internal reference to the copied viewer node we made in the compilation process
|
|
*/
|
|
ViewerOutput* copied_viewer_node_;
|
|
|
|
/**
|
|
* @brief Error string that can be set in SetError() to handle failures
|
|
*/
|
|
QString error_;
|
|
|
|
QString cache_id_;
|
|
|
|
QList<Node*> source_node_list_;
|
|
NodeGraph copied_graph_;
|
|
|
|
bool recompile_queued_;
|
|
bool input_update_queued_;
|
|
|
|
QVector<bool> processor_busy_state_;
|
|
|
|
RenderCancelDialog* cancel_dialog_;
|
|
|
|
};
|
|
|
|
#endif // RENDERBACKEND_H
|