KisMediaEncoderRunnable Class Reference

#include <KisMediaEncoderWrapper.h>

Inheritance diagram for KisMediaEncoderRunnable:

Classes
class	Frame

Public Slots
void	slotHandleCancelRequested ()

Signals
void	sigCancelled ()
void	sigCompleted ()
void	sigFailed (const QString &errorMessage)
void	sigProgressUpdated (int frameNo)
void	sigStarted ()

Public Member Functions
void	run () override

Protected Types
enum class	EncodeResult { Completed , Cancelled , Failed }

Protected Member Functions
virtual EncodeResult	encode (QString &outErrorMessage)=0
bool	isCancelled () const
	KisMediaEncoderRunnable (const KisMediaEncoderWrapperSettings &settings, QObject *parent)
bool	nextFrame (Frame &outFrame)
void	rewindFrames ()
void	setOutputFrameNoMultiplier (double outputFrameNoMultiplier)
const KisMediaEncoderWrapperSettings	settings ()

Private Member Functions
EncodeResult	prepareAndEncode (QString &outErrorMessage)

Private Attributes
bool	m_cancel = false
int	m_inputFileIndex = 0
double	m_inputTime = 0.0
bool	m_needsLingerAfter = true
bool	m_needsPreviewBefore = true
double	m_outputFrameNo = 0.0
double	m_outputFrameNoMultiplier = 1.0
KisMediaEncoderWrapperSettings	m_settings

Detailed Description

Definition at line 62 of file KisMediaEncoderWrapper.h.

Member Enumeration Documentation

EncodeResult

enum class KisMediaEncoderRunnable::EncodeResult

strongprotected

Enumerator
Completed
Cancelled
Failed

Definition at line 80 of file KisMediaEncoderWrapper.h.

                            {
        Completed,
        Cancelled,
        Failed,
    };

Constructor & Destructor Documentation

KisMediaEncoderRunnable()

KisMediaEncoderRunnable::KisMediaEncoderRunnable ( const KisMediaEncoderWrapperSettings & settings, QObject * parent )

protected

Definition at line 66 of file KisMediaEncoderWrapper.cpp.

    : QObject(parent)
    , m_settings(settings)
{
}

Member Function Documentation

encode()

virtual EncodeResult KisMediaEncoderRunnable::encode ( QString & outErrorMessage )

protectedpure virtual

Implemented in KisAndroidMediaEncoderRunnable, and KisLibavMediaEncoderRunnable.

isCancelled()

bool KisMediaEncoderRunnable::isCancelled ( ) const

inlineprotected

Definition at line 121 of file KisMediaEncoderWrapper.h.

    {
        return m_cancel;
    }

References m_cancel.

nextFrame()

bool KisMediaEncoderRunnable::nextFrame ( Frame & outFrame )

protected

Definition at line 72 of file KisMediaEncoderWrapper.cpp.

{
    int inputFileCount = m_settings.inputFiles.size();
    if (inputFileCount == 0) {
        return false;
    }
 
    int lastIndex = inputFileCount - 1;
    if (m_needsPreviewBefore) {
        m_needsPreviewBefore = false;
        int seconds = m_settings.firstFrameSec;
        if (seconds > 0) {
            outFrame = Frame(m_settings.inputFiles[lastIndex], seconds * m_settings.outputFps);
            return true;
        }
    }
 
    double inputFrameDuration = 1.0 / double(m_settings.inputFps);
    double outputFrameDuration = 1.0 / double(m_settings.outputFps);
    while (m_inputFileIndex < inputFileCount) {
        int fileIndex = m_inputFileIndex;
        ++m_inputFileIndex;
 
        int instances = 0;
        double nextInputTime = double(m_inputFileIndex) * inputFrameDuration;
        while (m_inputTime < nextInputTime) {
            ++instances;
            m_inputTime += outputFrameDuration;
        }
 
        if (instances != 0) {
            // GIF must spin through the input frames twice, once to generate a
            // palette and then again to actually render the animated image. It
            // sets the multiplier to 0.5 so that the progress bar shows values
            // that make sense for the user, rather than reaching 100% halfway.
            m_outputFrameNo += double(instances) * m_outputFrameNoMultiplier;
            Q_EMIT sigProgressUpdated(int(m_outputFrameNo));
 
            // If we're on the last frame, we can append the linger time.
            if (fileIndex == lastIndex && m_needsLingerAfter) {
                m_needsLingerAfter = false;
                instances += qMax(0, m_settings.lastFrameSec) * m_settings.outputFps;
            }
 
            outFrame = Frame(m_settings.inputFiles[fileIndex], instances);
            return true;
        }
    }
 
    if (m_needsLingerAfter) {
        m_needsLingerAfter = false;
        int seconds = m_settings.lastFrameSec;
        if (seconds > 0) {
            outFrame = Frame(m_settings.inputFiles[lastIndex], seconds * m_settings.outputFps);
            return true;
        }
    }
 
    return false;
}

References KisMediaEncoderWrapperSettings::firstFrameSec, KisMediaEncoderWrapperSettings::inputFiles, KisMediaEncoderWrapperSettings::inputFps, KisMediaEncoderWrapperSettings::lastFrameSec, m_inputFileIndex, m_inputTime, m_needsLingerAfter, m_needsPreviewBefore, m_outputFrameNo, m_outputFrameNoMultiplier, m_settings, KisMediaEncoderWrapperSettings::outputFps, and sigProgressUpdated().

prepareAndEncode()

KisMediaEncoderRunnable::EncodeResult KisMediaEncoderRunnable::prepareAndEncode ( QString & outErrorMessage )

private

Definition at line 141 of file KisMediaEncoderWrapper.cpp.

{
    if (m_cancel) {
        return EncodeResult::Cancelled;
    }
 
    if (m_settings.inputFiles.isEmpty()) {
        outErrorMessage = i18n("No frame files found");
        return EncodeResult::Failed;
    }
 
    m_inputFileIndex = 0;
    return encode(outErrorMessage);
}

References Cancelled, encode(), Failed, KisMediaEncoderWrapperSettings::inputFiles, m_cancel, m_inputFileIndex, and m_settings.

rewindFrames()

void KisMediaEncoderRunnable::rewindFrames ( )

protected

Definition at line 133 of file KisMediaEncoderWrapper.cpp.

{
    m_inputTime = 0;
    m_inputFileIndex = 0;
    m_needsPreviewBefore = true;
    m_needsLingerAfter = true;
}

References m_inputFileIndex, m_inputTime, m_needsLingerAfter, and m_needsPreviewBefore.

run()

void KisMediaEncoderRunnable::run ( )

override

Definition at line 32 of file KisMediaEncoderWrapper.cpp.

{
    Q_EMIT sigStarted();
    QString errorMessage;
    EncodeResult result = prepareAndEncode(errorMessage);
    if (result == EncodeResult::Completed) {
        Q_EMIT sigCompleted();
    } else if (result == EncodeResult::Cancelled) {
        Q_EMIT sigCancelled();
    } else {
        Q_EMIT sigFailed(errorMessage);
    }
}

References Cancelled, Completed, prepareAndEncode(), sigCancelled(), sigCompleted(), sigFailed(), and sigStarted().

setOutputFrameNoMultiplier()

void KisMediaEncoderRunnable::setOutputFrameNoMultiplier ( double outputFrameNoMultiplier )

inlineprotected

Definition at line 126 of file KisMediaEncoderWrapper.h.

    {
        m_outputFrameNoMultiplier = outputFrameNoMultiplier;
    }

References m_outputFrameNoMultiplier.

settings()

const KisMediaEncoderWrapperSettings KisMediaEncoderRunnable::settings ( )

inlineprotected

Definition at line 116 of file KisMediaEncoderWrapper.h.

    {
        return m_settings;
    }

References m_settings.

sigCancelled

void KisMediaEncoderRunnable::sigCancelled ( )

signal

sigCompleted

void KisMediaEncoderRunnable::sigCompleted ( )

signal

sigFailed

void KisMediaEncoderRunnable::sigFailed ( const QString & errorMessage )

signal

sigProgressUpdated

void KisMediaEncoderRunnable::sigProgressUpdated ( int frameNo )

signal

sigStarted

void KisMediaEncoderRunnable::sigStarted ( )

signal

slotHandleCancelRequested

void KisMediaEncoderRunnable::slotHandleCancelRequested ( )

slot

Definition at line 27 of file KisMediaEncoderWrapper.cpp.

{
    m_cancel = true;
}

References m_cancel.

Member Data Documentation

m_cancel

bool KisMediaEncoderRunnable::m_cancel = false

private

Definition at line 144 of file KisMediaEncoderWrapper.h.

m_inputFileIndex

int KisMediaEncoderRunnable::m_inputFileIndex = 0

private

Definition at line 139 of file KisMediaEncoderWrapper.h.

m_inputTime

double KisMediaEncoderRunnable::m_inputTime = 0.0

private

Definition at line 138 of file KisMediaEncoderWrapper.h.

m_needsLingerAfter

bool KisMediaEncoderRunnable::m_needsLingerAfter = true

private

Definition at line 143 of file KisMediaEncoderWrapper.h.

m_needsPreviewBefore

bool KisMediaEncoderRunnable::m_needsPreviewBefore = true

private

Definition at line 142 of file KisMediaEncoderWrapper.h.

m_outputFrameNo

double KisMediaEncoderRunnable::m_outputFrameNo = 0.0

private

Definition at line 140 of file KisMediaEncoderWrapper.h.

m_outputFrameNoMultiplier

double KisMediaEncoderRunnable::m_outputFrameNoMultiplier = 1.0

private

Definition at line 141 of file KisMediaEncoderWrapper.h.

m_settings

KisMediaEncoderWrapperSettings KisMediaEncoderRunnable::m_settings

private

Definition at line 137 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