oak-team/oak-editor
3
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

task: massively simplified task system

Browse Source 
Made various changes and fixes to the task system:

- Tasks are built around QtConcurrent rather than QThread. Reduces
  code complexity significantly.
- Task error reporting is now streamlined in both TaskManager and
  TaskDialog.
- Moved ProjectImport/Save/LoadManager to the app/task folder
This commit is contained in:
itsmattkc
2020-05-19 02:44:32 +10:00
parent c4b0a53174
commit b9cd83eff1
49 changed files with 864 additions and 1332 deletions
Download Patch File Download Diff File Expand all files Collapse all files
app/dialog/export/export.cpp
+18 -186
View File
@@ -31,21 +31,18 @@
#include <QStandardPaths>
#include "core.h"
#include "dialog/task/task.h"
#include "project/item/sequence/sequence.h"
#include "project/project.h"
#include "render/backend/exportparams.h"
#include "render/pixelformat.h"
#include "ui/icons/icons.h"
#include "window/mainwindow/mainwindow.h"
OLIVE_NAMESPACE_ENTER
ExportDialog::ExportDialog(ViewerOutput *viewer_node, QWidget *parent) :
QDialog(parent),
viewer_node_(viewer_node),
previously_selected_format_(0),
exporter_(nullptr),
cancelled_(false)
previously_selected_format_(0)
{
QHBoxLayout* layout = new QHBoxLayout(this);
@@ -53,11 +50,7 @@ ExportDialog::ExportDialog(ViewerOutput *viewer_node, QWidget *parent) :
splitter->setChildrenCollapsible(false);
layout->addWidget(splitter);
QWidget* outer_preferences_area = new QWidget();
QVBoxLayout* outer_preferences_layout = new QVBoxLayout(outer_preferences_area);
preferences_area_ = new QWidget();
outer_preferences_layout->addWidget(preferences_area_);
QGridLayout* preferences_layout = new QGridLayout(preferences_area_);
preferences_layout->setMargin(0);
@@ -142,44 +135,17 @@ ExportDialog::ExportDialog(ViewerOutput *viewer_node, QWidget *parent) :
preferences_tabs->addTab(audio_area, tr("Audio"));
preferences_layout->addWidget(preferences_tabs, row, 0, 1, 4);
QHBoxLayout* progress_bar_layout = new QHBoxLayout();
progress_bar_layout->setMargin(0);
outer_preferences_layout->addLayout(progress_bar_layout);
progress_bar_ = new QProgressBar();
progress_bar_->setEnabled(false);
progress_bar_->setValue(0);
progress_bar_layout->addWidget(progress_bar_);
export_cancel_btn_ = new QPushButton();
export_cancel_btn_->setIcon(icon::Error);
export_cancel_btn_->setEnabled(false);
connect(export_cancel_btn_, &QPushButton::clicked, this, &ExportDialog::CancelExport);
progress_bar_layout->addWidget(export_cancel_btn_);
QHBoxLayout* time_label_layout = new QHBoxLayout();
time_label_layout->setMargin(0);
outer_preferences_layout->addLayout(time_label_layout);
elapsed_label_ = new QLabel();
elapsed_label_->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
time_label_layout->addWidget(elapsed_label_);
remaining_label_ = new QLabel();
remaining_label_->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
time_label_layout->addWidget(remaining_label_);
UpdateTimeLabels();
row++;
buttons_ = new QDialogButtonBox();
buttons_->setCenterButtons(true);
buttons_->addButton(tr("Export"), QDialogButtonBox::AcceptRole);
buttons_->addButton(QDialogButtonBox::Cancel);
connect(buttons_, SIGNAL(accepted()), this, SLOT(accept()));
connect(buttons_, SIGNAL(rejected()), this, SLOT(reject()));
outer_preferences_layout->addWidget(buttons_);
connect(buttons_, &QDialogButtonBox::accepted, this, &ExportDialog::accept);
connect(buttons_, &QDialogButtonBox::rejected, this, &ExportDialog::reject);
preferences_layout->addWidget(buttons_, row, 0, 1, 4);
splitter->addWidget(outer_preferences_area);
splitter->addWidget(preferences_area_);
QWidget* preview_area = new QWidget();
QVBoxLayout* preview_layout = new QVBoxLayout(preview_area);
@@ -190,7 +156,6 @@ ExportDialog::ExportDialog(ViewerOutput *viewer_node, QWidget *parent) :
splitter->addWidget(preview_area);
// Set default filename
// FIXME: Use Sequence name and project filename to construct this
SetDefaultFilename();
// Set up available export formats
@@ -227,9 +192,6 @@ ExportDialog::ExportDialog(ViewerOutput *viewer_node, QWidget *parent) :
preview_viewer_->ConnectViewerNode(viewer_node_);
preview_viewer_->SetColorMenuEnabled(false);
preview_viewer_->SetColorTransform(video_tab_->CurrentOCIOColorSpace());
progress_timer_.setInterval(1000);
connect(&progress_timer_, &QTimer::timeout, this, &ExportDialog::UpdateTimeLabels);
}
void ExportDialog::accept()
@@ -314,46 +276,13 @@ void ExportDialog::accept()
}
}
// Set up export parameters
exporter_ = new Exporter(viewer_node_, color_manager_, GenerateParams());
connect(exporter_, &Exporter::ExportEnded, this, &ExportDialog::ExporterIsDone);
connect(exporter_, &Exporter::ProgressChanged, this, &ExportDialog::ProgressUpdated);
#ifdef Q_OS_WINDOWS
Core::instance()->main_window()->SetTaskbarButtonState(TBPF_NORMAL);
#endif
export_start_ = QDateTime::currentMSecsSinceEpoch();
flt_progress_ = 0;
progress_timer_.start();
QMetaObject::invokeMethod(exporter_, "StartExporting", Qt::QueuedConnection);
SetUIElementsEnabled(false);
ExportTask* task = new ExportTask(viewer_node_, color_manager_, GenerateParams());
TaskDialog* td = new TaskDialog(task, tr("Export"), this);
td->open();
}
void ExportDialog::closeEvent(QCloseEvent *e)
{
if (exporter_) {
QMessageBox b(this);
b.setIcon(QMessageBox::Question);
b.setWindowModality(Qt::WindowModal);
b.setWindowTitle(tr("Still Exporting"));
b.setText(tr("This sequence is still being exported. Do you wish to cancel it?"));
b.addButton(QMessageBox::Yes);
b.addButton(QMessageBox::No);
if (b.exec() == QMessageBox::Yes) {
CancelExport();
} else {
e->ignore();
return;
}
}
preview_viewer_->ConnectViewerNode(nullptr);
QDialog::closeEvent(e);
@@ -548,17 +477,6 @@ void ExportDialog::SetDefaultFilename()
filename_edit_->setText(file_location);
}
void ExportDialog::SetUIElementsEnabled(bool enabled)
{
preferences_area_->setEnabled(enabled);
buttons_->setEnabled(enabled);
progress_bar_->setEnabled(!enabled);
export_cancel_btn_->setEnabled(!enabled);
elapsed_label_->setEnabled(!enabled);
remaining_label_->setEnabled(!enabled);
}
int ExportDialog::AlignEvenNumber(double d)
{
return qCeil(d * 0.5) * 2;
@@ -607,40 +525,6 @@ ExportParams ExportDialog::GenerateParams() const
return params;
}
void ExportDialog::UpdateTimeLabels()
{
qint64 elapsed, remaining;
if (exporter_) {
elapsed = QDateTime::currentMSecsSinceEpoch() - export_start_;
if (flt_progress_ > 0) {
remaining = qRound64((1.0 - flt_progress_) * static_cast<double>(elapsed) / flt_progress_);
} else {
remaining = 0;
}
} else {
elapsed = 0;
remaining = 0;
}
elapsed_label_->setText(tr("Elapsed: %1").arg(TimeToString(elapsed)));
remaining_label_->setText(tr("Remaining: %1").arg(TimeToString(remaining)));
}
void ExportDialog::ProgressUpdated(double p)
{
int i_prog = qRound(100.0 * p);
progress_bar_->setValue(i_prog);
#ifdef Q_OS_WINDOWS
UpdateTaskbarProgress(i_prog);
#endif
flt_progress_ = p;
}
QString ExportDialog::TimeToString(int64_t ms)
{
int64_t total_seconds = ms / 1000;
@@ -659,66 +543,14 @@ void ExportDialog::UpdateViewerDimensions()
preview_viewer_->SetOverrideSize(static_cast<int>(video_tab_->width_slider()->GetValue()),
static_cast<int>(video_tab_->height_slider()->GetValue()));
preview_viewer_->SetMatrix(Exporter::GenerateMatrix(static_cast<ExportParams::VideoScalingMethod>(video_tab_->scaling_method_combobox()->currentData().toInt()),
viewer_node_->video_params().width(),
viewer_node_->video_params().height(),
static_cast<int>(video_tab_->width_slider()->GetValue()),
static_cast<int>(video_tab_->height_slider()->GetValue())));
QMatrix4x4 transform =
ExportParams::GenerateMatrix(static_cast<ExportParams::VideoScalingMethod>(video_tab_->scaling_method_combobox()->currentData().toInt()),
viewer_node_->video_params().width(),
viewer_node_->video_params().height(),
static_cast<int>(video_tab_->width_slider()->GetValue()),
static_cast<int>(video_tab_->height_slider()->GetValue()));
preview_viewer_->SetMatrix(transform);
}
void ExportDialog::ExporterIsDone()
{
progress_timer_.stop();
if (exporter_->GetExportStatus()) {
QMessageBox b(this);
b.setIcon(QMessageBox::Information);
b.setWindowModality(Qt::WindowModal);
b.setWindowTitle(tr("Export Status"));
b.setText(tr("Export completed successfully."));
b.addButton(QMessageBox::Ok);
b.exec();
QDialog::accept();
} else {
if (!cancelled_) {
#ifdef Q_OS_WINDOWS
Core::instance()->main_window()->SetTaskbarButtonState(TBPF_ERROR);
#endif
QMessageBox b(this);
b.setIcon(QMessageBox::Critical);
b.setWindowModality(Qt::WindowModal);
b.setWindowTitle(tr("Export Status"));
b.setText(tr("Export failed: %1").arg(exporter_->GetExportError()));
b.addButton(QMessageBox::Ok);
b.exec();
}
SetUIElementsEnabled(true);
}
exporter_ = nullptr;
cancelled_ = false;
#ifdef Q_OS_WINDOWS
Core::instance()->main_window()->SetTaskbarButtonState(TBPF_NOPROGRESS);
#endif
}
void ExportDialog::CancelExport()
{
if (exporter_) {
cancelled_ = true;
exporter_->Cancel();
}
}
#ifdef Q_OS_WINDOWS
void ExportDialog::UpdateTaskbarProgress(int progress)
{
Core::instance()->main_window()->SetTaskbarButtonProgress(progress, 100);
}
#endif
OLIVE_NAMESPACE_EXIT
app/dialog/export/export.h
+1 -28
View File
@@ -31,7 +31,7 @@
#include "exportcodec.h"
#include "exportformat.h"
#include "exportvideotab.h"
#include "render/backend/exporter.h"
#include "task/export/export.h"
#include "widget/viewer/viewer.h"
OLIVE_NAMESPACE_ENTER
@@ -53,8 +53,6 @@ private:
void LoadPresets();
void SetDefaultFilename();
void SetUIElementsEnabled(bool enabled);
static int AlignEvenNumber(double d);
ExportParams GenerateParams() const;
@@ -75,8 +73,6 @@ private:
QLineEdit* filename_edit_;
QComboBox* format_combobox_;
Exporter* exporter_;
ExportVideoTab* video_tab_;
ExportAudioTab* audio_tab_;
@@ -84,19 +80,8 @@ private:
ColorManager* color_manager_;
QProgressBar* progress_bar_;
QTimer progress_timer_;
QLabel* elapsed_label_;
QLabel* remaining_label_;
qint64 export_start_;
double flt_progress_;
QWidget* preferences_area_;
QDialogButtonBox* buttons_;
QPushButton* export_cancel_btn_;
bool cancelled_;
enum Format {
kFormatDNxHD,
@@ -138,18 +123,6 @@ private slots:
void UpdateViewerDimensions();
void ExporterIsDone();
void CancelExport();
void UpdateTimeLabels();
void ProgressUpdated(double p);
#ifdef Q_OS_WINDOWS
void UpdateTaskbarProgress(int progress);
#endif
};
OLIVE_NAMESPACE_EXIT
app/dialog/export/exportadvancedvideodialog.h
-1
View File
@@ -3,7 +3,6 @@
#include <QDialog>
#include "render/backend/exportparams.h"
#include "widget/slider/integerslider.h"
OLIVE_NAMESPACE_ENTER
app/dialog/export/exportvideotab.cpp
+1 -1
View File
@@ -28,8 +28,8 @@
#include "core.h"
#include "exportadvancedvideodialog.h"
#include "render/backend/exportparams.h"
#include "render/colormanager.h"
#include "task/export/exportparams.h"
OLIVE_NAMESPACE_ENTER
app/dialog/progress/progress.cpp
+40
View File
@@ -21,9 +21,12 @@
#include "progress.h"
#include <QLabel>
#include <QMessageBox>
#include <QPushButton>
#include <QVBoxLayout>
#include "window/mainwindow/mainwindow.h"
OLIVE_NAMESPACE_ENTER
ProgressDialog::ProgressDialog(const QString& message, const QString& title, QWidget *parent) :
@@ -56,9 +59,46 @@ ProgressDialog::ProgressDialog(const QString& message, const QString& title, QWi
cancel_layout->addStretch();
}
void ProgressDialog::showEvent(QShowEvent *e)
{
QDialog::showEvent(e);
#ifdef Q_OS_WINDOWS
Core::instance()->main_window()->SetTaskbarButtonState(TBPF_NORMAL);
#endif
}
void ProgressDialog::closeEvent(QCloseEvent *e)
{
QDialog::closeEvent(e);
#ifdef Q_OS_WINDOWS
Core::instance()->main_window()->SetTaskbarButtonState(TBPF_NOPROGRESS);
#endif
}
void ProgressDialog::SetProgress(int value)
{
bar_->setValue(value);
#ifdef Q_OS_WINDOWS
Core::instance()->main_window()->SetTaskbarButtonProgress(value, 100);
#endif
}
void ProgressDialog::ShowErrorMessage(const QString &title, const QString &message)
{
#ifdef Q_OS_WINDOWS
Core::instance()->main_window()->SetTaskbarButtonState(TBPF_ERROR);
#endif
QMessageBox b(this);
b.setIcon(QMessageBox::Critical);
b.setWindowModality(Qt::WindowModal);
b.setWindowTitle(title);
b.setText(message);
b.addButton(QMessageBox::Ok);
b.exec();
}
OLIVE_NAMESPACE_EXIT
app/dialog/progress/progress.h
+8
View File
@@ -34,12 +34,20 @@ class ProgressDialog : public QDialog
public:
ProgressDialog(const QString &message, const QString &title, QWidget* parent = nullptr);
protected:
virtual void showEvent(QShowEvent* e) override;
virtual void closeEvent(QCloseEvent *) override;
public slots:
void SetProgress(int value);
signals:
void Cancelled();
protected:
void ShowErrorMessage(const QString& title, const QString& message);
private:
QProgressBar* bar_;
app/dialog/task/task.cpp
+32 -39
View File
@@ -20,76 +20,69 @@
#include "task.h"
#include <QMessageBox>
#include <QThread>
#include <QtConcurrent/QtConcurrent>
OLIVE_NAMESPACE_ENTER
TaskDialog::TaskDialog(Task* task, const QString& title, QWidget *parent) :
ProgressDialog(task->GetTitle(), title, parent),
task_(task),
task_failed_(false)
destroy_on_close_(true)
{
thread_ = new QThread();
// Clear task when this dialog is destroyed
task_->setParent(this);
// Connect the save manager progress signal to the progress bar update on the dialog
connect(task_, &Task::ProgressChanged, this, &TaskDialog::SetProgress, Qt::QueuedConnection);
// Connect error reporting
connect(task_, &Task::Failed, this, &TaskDialog::TaskFailed, Qt::QueuedConnection);
// Connect cancel signal (must be a direct connection or it'll be queued after the task has already finished)
// Connect cancel signal (must be a direct connection or it'll be queued after the task has
// already finished)
connect(this, &TaskDialog::Cancelled, task_, &Task::Cancel, Qt::DirectConnection);
// Connect cleanup functions (ensure everything new'd in this function is deleteLater'd)
connect(task_, &Task::Finished, this, &TaskDialog::close, Qt::QueuedConnection);
// When task is finished, signal thread to quit
connect(task_, &Task::Finished, thread_, &QThread::quit, Qt::QueuedConnection);
// When thread has quit, delete both task and thread
connect(thread_, &QThread::finished, task_, &Task::deleteLater, Qt::QueuedConnection);
connect(thread_, &QThread::finished, thread_, &QThread::deleteLater, Qt::QueuedConnection);
}
void TaskDialog::showEvent(QShowEvent *e)
{
QDialog::showEvent(e);
ProgressDialog::showEvent(e);
// Create a separate thread to run this task in
thread_->start();
// Create watcher for when the task finishes
QFutureWatcher<bool>* task_watcher = new QFutureWatcher<bool>();
// Move the task to this thread
task_->moveToThread(thread_);
// Listen for when the task finishes
connect(task_watcher, &QFutureWatcher<bool>::finished,
this, &TaskDialog::TaskFinished, Qt::QueuedConnection);
// Start the task
QMetaObject::invokeMethod(task_, "Start", Qt::QueuedConnection);
// Run task in another thread with QtConcurrent
task_watcher->setFuture(QtConcurrent::run(task_, &Task::Run));
}
void TaskDialog::closeEvent(QCloseEvent *e)
{
// Show error if the task failed
if (!task_->IsCancelled() && task_failed_) {
QMessageBox::critical(this,
tr("Error"),
task_error_,
QMessageBox::Ok);
}
// Cancel task if it is running
task_->Cancel();
// Standard close function
QDialog::closeEvent(e);
ProgressDialog::closeEvent(e);
// Clean up this dialog (FIXME: Is this necessary?)
deleteLater();
// Clean up this task and dialog
if (destroy_on_close_) {
deleteLater();
}
}
void TaskDialog::TaskFailed(const QString &s)
void TaskDialog::TaskFinished()
{
task_failed_ = true;
task_error_ = s;
QFutureWatcher<bool>* task_watcher = static_cast<QFutureWatcher<bool>*>(sender());
if (task_watcher->result()) {
emit TaskSucceeded(task_);
} else {
ShowErrorMessage(tr("Task Failed"), task_->GetError());
emit TaskFailed(task_);
}
task_watcher->deleteLater();
close();
}
OLIVE_NAMESPACE_EXIT
app/dialog/task/task.h
+32 -5
View File
@@ -30,23 +30,50 @@ class TaskDialog : public ProgressDialog
{
Q_OBJECT
public:
/**
* @brief TaskDialog Constructor
*
* Creates a TaskDialog. The TaskDialog takes ownership of the Task and will destroy it on close.
* Connect to the Task::Succeeded() if you want to retrieve information from the task before it
* gets destroyed.
*/
TaskDialog(Task *task, const QString &title, QWidget* parent = nullptr);
/**
* @brief Set whether TaskDialog should destroy itself (and the task) when it's closed
*
* This is TRUE by default.
*/
void SetDestroyOnClose(bool e)
{
destroy_on_close_ = e;
}
/**
* @brief Returns this dialog's task
*/
Task* GetTask() const
{
return task_;
}
protected:
virtual void showEvent(QShowEvent* e) override;
virtual void closeEvent(QCloseEvent* e) override;
signals:
void TaskSucceeded(Task* task);
void TaskFailed(Task* task);
private:
Task* task_;
QThread* thread_;
bool task_failed_;
QString task_error_;
bool destroy_on_close_;
private slots:
void TaskFailed(const QString& s);
void TaskFinished();
};