KisMediaEncoderWrapper Class Reference

#include <KisMediaEncoderWrapper.h>

Inheritance diagram for KisMediaEncoderWrapper:

Signals
void	sigCancelRequested ()
void	sigFinished ()
void	sigFinishedWithError (QString message)
void	sigProgressUpdated (int frameNo)
void	sigStarted ()

Public Member Functions
	KisMediaEncoderWrapper (QObject *parent=nullptr)
void	reset ()
KisImportExportErrorCode	start (const KisMediaEncoderWrapperSettings &settings, bool batchMode)
void	startNonBlocking (const KisMediaEncoderWrapperSettings &settings)
	~KisMediaEncoderWrapper () override

Static Public Member Functions
static KisMediaEncoderFormat *	getFormatByKey (const QString &key)
static const QVector< KisMediaEncoderFormat * > &	getSupportedFormats ()

Static Private Member Functions
static KisMediaEncoderRunnable *	makeSupportedRunnable (const KisMediaEncoderWrapperSettings &settings)

Private Attributes
QPointer< KisMediaEncoderRunnable >	m_runnable

Detailed Description

Definition at line 147 of file KisMediaEncoderWrapper.h.

Constructor & Destructor Documentation

KisMediaEncoderWrapper()

KisMediaEncoderWrapper::KisMediaEncoderWrapper ( QObject * parent = nullptr )

explicit

Definition at line 156 of file KisMediaEncoderWrapper.cpp.

    : QObject(parent)
{
}

~KisMediaEncoderWrapper()

KisMediaEncoderWrapper::~KisMediaEncoderWrapper ( )

override

Definition at line 161 of file KisMediaEncoderWrapper.cpp.

{
    reset();
}

References reset().

Member Function Documentation

getFormatByKey()

KisMediaEncoderFormat * KisMediaEncoderWrapper::getFormatByKey ( const QString & key )

static

Definition at line 312 of file KisMediaEncoderWrapper.cpp.

{
    for (KisMediaEncoderFormat *format : getSupportedFormats()) {
        if (format->key() == key) {
            return format;
        }
    }
    return nullptr;
}

References getSupportedFormats().

getSupportedFormats()

const QVector< KisMediaEncoderFormat * > & KisMediaEncoderWrapper::getSupportedFormats ( )

static

Definition at line 299 of file KisMediaEncoderWrapper.cpp.

{
    static QVector<KisMediaEncoderFormat *> *supportedFormats;
    if (!supportedFormats) {
        supportedFormats = new QVector<KisMediaEncoderFormat *>();
#ifdef Q_OS_ANDROID
        KisAndroidMediaEncoderRunnable::getSupportedFormats(*supportedFormats);
#endif
        KisLibavMediaEncoderRunnable::getSupportedFormats(*supportedFormats);
    }
    return *supportedFormats;
}

References KisAndroidMediaEncoderRunnable::getSupportedFormats(), and KisLibavMediaEncoderRunnable::getSupportedFormats().

makeSupportedRunnable()

KisMediaEncoderRunnable * KisMediaEncoderWrapper::makeSupportedRunnable ( const KisMediaEncoderWrapperSettings & settings )

staticprivate

Definition at line 322 of file KisMediaEncoderWrapper.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(settings.format, nullptr);
 
#ifdef Q_OS_ANDROID
    {
        KisAndroidMediaEncoderRunnable *androidRunnable = KisAndroidMediaEncoderRunnable::create(settings);
        if (androidRunnable) {
            return androidRunnable;
        }
    }
#endif
    {
        KisLibavMediaEncoderRunnable *libavRunnable = KisLibavMediaEncoderRunnable::create(settings);
        if (libavRunnable) {
            return libavRunnable;
        }
    }
 
    return nullptr;
}

References KisAndroidMediaEncoderRunnable::create(), KisLibavMediaEncoderRunnable::create(), KisMediaEncoderWrapperSettings::format, and KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE.

reset()

void KisMediaEncoderWrapper::reset

(

)

Definition at line 289 of file KisMediaEncoderWrapper.cpp.

{
    KisMediaEncoderRunnable *runnable = m_runnable.data();
    if (runnable) {
        m_runnable.clear();
        Q_EMIT sigCancelRequested();
        disconnect(runnable);
    }
}

References m_runnable, and sigCancelRequested().

sigCancelRequested

void KisMediaEncoderWrapper::sigCancelRequested ( )

signal

sigFinished

void KisMediaEncoderWrapper::sigFinished ( )

signal

sigFinishedWithError

void KisMediaEncoderWrapper::sigFinishedWithError ( QString message )

signal

sigProgressUpdated

void KisMediaEncoderWrapper::sigProgressUpdated ( int frameNo )

signal

sigStarted

void KisMediaEncoderWrapper::sigStarted ( )

signal

start()

KisImportExportErrorCode KisMediaEncoderWrapper::start	(	const KisMediaEncoderWrapperSettings &	settings,
		bool	batchMode )

Definition at line 166 of file KisMediaEncoderWrapper.cpp.

{
    reset();
 
    KisMediaEncoderRunnable *runnable = makeSupportedRunnable(settings);
    KisImportExportErrorCode errorCode(ImportExportCodes::InternalError);
    if (runnable) {
        connect(
            runnable,
            &KisMediaEncoderRunnable::sigCompleted,
            this,
            [&errorCode] {
                errorCode = KisImportExportErrorCode(ImportExportCodes::OK);
            },
            Qt::DirectConnection);
        connect(
            runnable,
            &KisMediaEncoderRunnable::sigCancelled,
            this,
            [&errorCode] {
                errorCode = KisImportExportErrorCode(ImportExportCodes::Cancelled);
            },
            Qt::DirectConnection);
        connect(
            runnable,
            &KisMediaEncoderRunnable::sigFailed,
            this,
            [&errorCode](const QString &errorMessage) {
                errorCode = KisImportExportErrorCode(errorMessage);
            },
            Qt::DirectConnection);
        connect(this,
                &KisMediaEncoderWrapper::sigCancelRequested,
                runnable,
                &KisMediaEncoderRunnable::slotHandleCancelRequested,
                Qt::DirectConnection);
 
        QProgressDialog *progressDlg;
        if (batchMode) {
            progressDlg = nullptr;
        } else {
            progressDlg = new QProgressDialog;
            progressDlg->setLabelText(i18n("Rendering animation..."));
            connect(
                runnable,
                &KisMediaEncoderRunnable::sigProgressUpdated,
                this,
                [progressDlg, frameCount = settings.inputFiles.size()](int frameNo) {
                    int progress;
                    if (frameNo < 0) {
                        progress = 0;
                    } else if (frameNo >= frameCount) {
                        progress = 100;
                    } else {
                        progress = qRound(qreal(frameNo) / qreal(frameCount) * 100.0);
                    }
                    progressDlg->setValue(progress);
                    QCoreApplication::processEvents();
                },
                Qt::DirectConnection);
            connect(progressDlg,
                    &QProgressDialog::canceled,
                    this,
                    &KisMediaEncoderWrapper::sigCancelRequested,
                    Qt::DirectConnection);
            progressDlg->show();
            QCoreApplication::processEvents();
        }
 
        m_runnable = runnable;
        runnable->run();
        delete runnable;
        delete progressDlg;
    }
    return errorCode;
}

References ImportExportCodes::Cancelled, KisMediaEncoderWrapperSettings::inputFiles, ImportExportCodes::InternalError, m_runnable, makeSupportedRunnable(), ImportExportCodes::OK, reset(), KisMediaEncoderRunnable::run(), KisMediaEncoderRunnable::sigCancelled(), sigCancelRequested(), KisMediaEncoderRunnable::sigCompleted(), KisMediaEncoderRunnable::sigFailed(), KisMediaEncoderRunnable::sigProgressUpdated(), and KisMediaEncoderRunnable::slotHandleCancelRequested().

startNonBlocking()

void KisMediaEncoderWrapper::startNonBlocking

(

const KisMediaEncoderWrapperSettings &

settings

)

Definition at line 243 of file KisMediaEncoderWrapper.cpp.

{
    reset();
 
    KisMediaEncoderRunnable *runnable = makeSupportedRunnable(settings);
    if (runnable) {
        connect(runnable,
                &KisMediaEncoderRunnable::sigStarted,
                this,
                &KisMediaEncoderWrapper::sigStarted,
                Qt::QueuedConnection);
        connect(runnable,
                &KisMediaEncoderRunnable::sigCompleted,
                this,
                &KisMediaEncoderWrapper::sigFinished,
                Qt::QueuedConnection);
        connect(runnable,
                &KisMediaEncoderRunnable::sigCancelled,
                this,
                &KisMediaEncoderWrapper::sigFinished,
                Qt::QueuedConnection);
        connect(runnable,
                &KisMediaEncoderRunnable::sigFailed,
                this,
                &KisMediaEncoderWrapper::sigFinishedWithError,
                Qt::QueuedConnection);
        connect(runnable,
                &KisMediaEncoderRunnable::sigProgressUpdated,
                this,
                &KisMediaEncoderWrapper::sigProgressUpdated,
                Qt::QueuedConnection);
        connect(this,
                &KisMediaEncoderWrapper::sigCancelRequested,
                runnable,
                &KisMediaEncoderRunnable::slotHandleCancelRequested,
                Qt::QueuedConnection);
 
        m_runnable = runnable;
        runnable->setAutoDelete(true);
        QThreadPool::globalInstance()->start(runnable);
 
    } else {
        Q_EMIT sigFinishedWithError(i18n("No encoder for the selected format found"));
    }
}

References m_runnable, makeSupportedRunnable(), reset(), KisMediaEncoderRunnable::sigCancelled(), sigCancelRequested(), KisMediaEncoderRunnable::sigCompleted(), KisMediaEncoderRunnable::sigFailed(), sigFinished(), sigFinishedWithError(), KisMediaEncoderRunnable::sigProgressUpdated(), sigProgressUpdated(), KisMediaEncoderRunnable::sigStarted(), sigStarted(), and KisMediaEncoderRunnable::slotHandleCancelRequested().

Member Data Documentation

m_runnable

QPointer<KisMediaEncoderRunnable> KisMediaEncoderWrapper::m_runnable

private

Definition at line 172 of file KisMediaEncoderWrapper.h.

---

The documentation for this class was generated from the following files:

• libs/ui/animation/KisMediaEncoderWrapper.h
• libs/ui/animation/KisMediaEncoderWrapper.cpp