This class maintains queues of dirty frames sorted in the order of proximity to the last changed frame. It regenerates the frames emits the paintdevice for each of the frames. The m_changedFramesQueue list is given preference. More...

#include <KisStoryboardThumbnailRenderScheduler.h>

Inheritance diagram for KisStoryboardThumbnailRenderScheduler:

Public Slots
void	slotStartFrameRendering ()

Signals
void	sigFrameCancelled (int frame)

void	sigFrameCompleted (int frame, KisPaintDeviceSP dev)

Public Member Functions
void	cancelAllFrameRendering ()
	Cancels all frame rendering. Empties all queues and cancels the current rendering, if any.

void	cancelFrameRendering (int frame)
	Cancel rendering of a single frame.

	KisStoryboardThumbnailRenderScheduler (QObject *parent)

void	scheduleFrameForRegeneration (int frame, bool affected)
	Adds the frame to the list of "to be regenerated" frames.

void	setImage (KisImageSP image)
	Sets an image, the class takes an image, clones it and calls frame regeneration on the clone so do not pass cloned image explicitly. The image should be set only_once and not every time before scheduling a frame for regeneration. Setting an image cancels rendering of all previously scheduled frames.

	~KisStoryboardThumbnailRenderScheduler ()

Private Slots
void	slotFrameRegenerationCancelled (int frame)
	Emits `sigFrameCancelled(int)` and schedules the next frame for regeneration.

void	slotFrameRegenerationCompleted (int frame, KisPaintDeviceSP contents)
	Emits `sigFrameCompleted(int,KisPaintDeviceSP)` if the regeneration was complete and calls regeneration of the next frame in queue.

Private Member Functions
void	renderNextFrame ()
	Renders the next frame, either from affected or changed queue. Changed queue is given preference. It removes the frame from the queue right after calling `startFrameRegeneration()`

void	sortAffectedFrameQueue ()
	Sorts the `m_affectedFramesQueue` based on proximity to the last changed frame.

Private Attributes
QVector< int >	m_affectedFramesQueue

QVector< int >	m_changedFramesQueue

int	m_currentFrame

KisImageSP	m_image

KisAsyncStoryboardThumbnailRenderer *	m_renderer

Detailed Description

This class maintains queues of dirty frames sorted in the order of proximity to the last changed frame. It regenerates the frames emits the paintdevice for each of the frames. The m_changedFramesQueue list is given preference.

Definition at line 24 of file KisStoryboardThumbnailRenderScheduler.h.

Constructor & Destructor Documentation

◆ KisStoryboardThumbnailRenderScheduler()

KisStoryboardThumbnailRenderScheduler::KisStoryboardThumbnailRenderScheduler ( QObject * parent )

Definition at line 15 of file KisStoryboardThumbnailRenderScheduler.cpp.

    : QObject(parent)
    , m_renderer(new KisAsyncStoryboardThumbnailRenderer(this))
    , m_currentFrame(-1)
{
    //connect signals to the renderer.
    connect(m_renderer, SIGNAL(sigNotifyFrameCompleted(int,KisPaintDeviceSP)), this, SLOT(slotFrameRegenerationCompleted(int, KisPaintDeviceSP)));
    connect(m_renderer, SIGNAL(sigFrameCancelled(int, KisAsyncAnimationRendererBase::CancelReason)), this, SLOT(slotFrameRegenerationCancelled(int)));
}

References connect(), m_renderer, sigFrameCancelled(), slotFrameRegenerationCancelled(), and slotFrameRegenerationCompleted().

◆ ~KisStoryboardThumbnailRenderScheduler()

KisStoryboardThumbnailRenderScheduler::~KisStoryboardThumbnailRenderScheduler ( )

Definition at line 25 of file KisStoryboardThumbnailRenderScheduler.cpp.

{
    delete m_renderer;
}

References m_renderer.

Member Function Documentation

◆ cancelAllFrameRendering()

void KisStoryboardThumbnailRenderScheduler::cancelAllFrameRendering ( )

Cancels all frame rendering. Empties all queues and cancels the current rendering, if any.

Definition at line 62 of file KisStoryboardThumbnailRenderScheduler.cpp.

{
    m_affectedFramesQueue.clear();
    m_changedFramesQueue.clear();
    if (m_renderer->isActive()) {
        m_renderer->cancelCurrentFrameRendering(KisAsyncAnimationRendererBase::UserCancelled);
    }
    m_currentFrame = -1;
}

References KisAsyncAnimationRendererBase::cancelCurrentFrameRendering(), KisAsyncAnimationRendererBase::isActive(), m_affectedFramesQueue, m_changedFramesQueue, m_currentFrame, m_renderer, and KisAsyncAnimationRendererBase::UserCancelled.

◆ cancelFrameRendering()

void KisStoryboardThumbnailRenderScheduler::cancelFrameRendering ( int frame )

Cancel rendering of a single frame.

Parameters

frame The frame whose rendering is to be cancelled.

Definition at line 72 of file KisStoryboardThumbnailRenderScheduler.cpp.

{
    if (frame < 0) {
        return;
    }
    if (m_renderer->isActive() && frame == m_currentFrame) {
        m_renderer->cancelCurrentFrameRendering(KisAsyncAnimationRendererBase::UserCancelled);
        m_currentFrame = -1;
    }
    else if (m_changedFramesQueue.contains(frame)) {
        m_changedFramesQueue.removeAll(frame);
    }
    else if (m_affectedFramesQueue.contains(frame)) {
        m_affectedFramesQueue.removeAll(frame);
    }
}

References KisAsyncAnimationRendererBase::cancelCurrentFrameRendering(), KisAsyncAnimationRendererBase::isActive(), m_affectedFramesQueue, m_changedFramesQueue, m_currentFrame, m_renderer, and KisAsyncAnimationRendererBase::UserCancelled.

◆ renderNextFrame()

void KisStoryboardThumbnailRenderScheduler::renderNextFrame ( )

private

Renders the next frame, either from affected or changed queue. Changed queue is given preference. It removes the frame from the queue right after calling startFrameRegeneration()

Definition at line 122 of file KisStoryboardThumbnailRenderScheduler.cpp.

{
    if (!m_image || !m_image->isIdle()) {
        return;
    }
 
    if (m_changedFramesQueue.isEmpty() && m_affectedFramesQueue.isEmpty()) {
        return;
    }
 
    if (m_image->animationInterface()->backgroundFrameGenerationBlocked()) {
        return;
    }
 
    KisImageSP image = m_image->clone(false);
    KIS_SAFE_ASSERT_RECOVER_RETURN(image);
 
    int frame = !m_changedFramesQueue.isEmpty() ? m_changedFramesQueue.takeFirst() : m_affectedFramesQueue.takeFirst();;
 
    KisLockFrameGenerationLock lock(image->animationInterface());
 
    m_renderer->startFrameRegeneration(image, frame, KisAsyncAnimationRendererBase::None, std::move(lock));
    m_currentFrame = frame;
}

References KisImage::animationInterface(), KisImageAnimationInterface::backgroundFrameGenerationBlocked(), KisImage::clone(), KisImage::isIdle(), KIS_SAFE_ASSERT_RECOVER_RETURN, m_affectedFramesQueue, m_changedFramesQueue, m_currentFrame, m_image, m_renderer, KisAsyncAnimationRendererBase::None, and KisAsyncAnimationRendererBase::startFrameRegeneration().

◆ scheduleFrameForRegeneration()

void KisStoryboardThumbnailRenderScheduler::scheduleFrameForRegeneration	(	int	frame,
		bool	affected )

Adds the frame to the list of "to be regenerated" frames.

Parameters

frame	To be regenerated frame
affected	Denotes whether this frame was directly changed or affected by changes made to other keyframes.

Definition at line 39 of file KisStoryboardThumbnailRenderScheduler.cpp.

{
    if (affected && m_affectedFramesQueue.contains(frame)) {
        return;
    }
    else if (affected && !m_changedFramesQueue.contains(frame)) {
        m_affectedFramesQueue.prepend(frame);
    }
    else {
        if (m_changedFramesQueue.contains(frame)) {
            int framePos = m_changedFramesQueue.indexOf(frame);
            if (framePos == 0) {
                return;
            }
            m_changedFramesQueue.move(framePos, 0);
        }
        else {
            m_changedFramesQueue.prepend(frame);
        }
        sortAffectedFrameQueue();
    }
}

References m_affectedFramesQueue, m_changedFramesQueue, and sortAffectedFrameQueue().

◆ setImage()

void KisStoryboardThumbnailRenderScheduler::setImage ( KisImageSP image )

Sets an image, the class takes an image, clones it and calls frame regeneration on the clone so do not pass cloned image explicitly. The image should be set only_once and not every time before scheduling a frame for regeneration. Setting an image cancels rendering of all previously scheduled frames.

Parameters

image Image whose frames are to be rendered.

Definition at line 30 of file KisStoryboardThumbnailRenderScheduler.cpp.

{
    if (m_image == image) {
        return;
    }
    cancelAllFrameRendering();
    m_image = image;
}

References cancelAllFrameRendering(), and m_image.

◆ sigFrameCancelled

void KisStoryboardThumbnailRenderScheduler::sigFrameCancelled ( int frame )

signal

◆ sigFrameCompleted

void KisStoryboardThumbnailRenderScheduler::sigFrameCompleted	(	int	frame,
		KisPaintDeviceSP	dev )

signal

◆ slotFrameRegenerationCancelled

void KisStoryboardThumbnailRenderScheduler::slotFrameRegenerationCancelled ( int frame )

privateslot

Emits sigFrameCancelled(int) and schedules the next frame for regeneration.

Definition at line 104 of file KisStoryboardThumbnailRenderScheduler.cpp.

{
    Q_EMIT sigFrameCancelled(frame);
    renderNextFrame();
}

References renderNextFrame(), and sigFrameCancelled().

◆ slotFrameRegenerationCompleted

void KisStoryboardThumbnailRenderScheduler::slotFrameRegenerationCompleted	(	int	frame,
		KisPaintDeviceSP	contents )

privateslot

Emits sigFrameCompleted(int,KisPaintDeviceSP) if the regeneration was complete and calls regeneration of the next frame in queue.

Definition at line 98 of file KisStoryboardThumbnailRenderScheduler.cpp.

{
    Q_EMIT sigFrameCompleted(frame, contents);
    renderNextFrame();
}

References renderNextFrame(), and sigFrameCompleted().

◆ slotStartFrameRendering

void KisStoryboardThumbnailRenderScheduler::slotStartFrameRendering ( )

slot

Definition at line 89 of file KisStoryboardThumbnailRenderScheduler.cpp.

{
    //if the renderer is idle start rendering the frames in queues
    if (!m_renderer->isActive()) {
        renderNextFrame();
    }
}

References KisAsyncAnimationRendererBase::isActive(), m_renderer, and renderNextFrame().

◆ sortAffectedFrameQueue()

void KisStoryboardThumbnailRenderScheduler::sortAffectedFrameQueue ( )

private

Sorts the m_affectedFramesQueue based on proximity to the last changed frame.

Definition at line 110 of file KisStoryboardThumbnailRenderScheduler.cpp.

{
    int lastChangedFrame = m_changedFramesQueue[0];
 
    //sort the affected queue based on proximity to the last changed frame.
    std::sort(m_affectedFramesQueue.begin(), m_affectedFramesQueue.end(),
                [lastChangedFrame](const int &arg1, const int &arg2)
                {
                    return std::abs(arg1 - lastChangedFrame) < std::abs(arg2 - lastChangedFrame);
                });
}

References m_affectedFramesQueue, and m_changedFramesQueue.

Member Data Documentation

◆ m_affectedFramesQueue

QVector<int> KisStoryboardThumbnailRenderScheduler::m_affectedFramesQueue

private

Definition at line 90 of file KisStoryboardThumbnailRenderScheduler.h.

◆ m_changedFramesQueue

QVector<int> KisStoryboardThumbnailRenderScheduler::m_changedFramesQueue

private

Definition at line 89 of file KisStoryboardThumbnailRenderScheduler.h.

◆ m_currentFrame

int KisStoryboardThumbnailRenderScheduler::m_currentFrame

private

Definition at line 93 of file KisStoryboardThumbnailRenderScheduler.h.

◆ m_image

KisImageSP KisStoryboardThumbnailRenderScheduler::m_image

private

Definition at line 92 of file KisStoryboardThumbnailRenderScheduler.h.

◆ m_renderer

KisAsyncStoryboardThumbnailRenderer* KisStoryboardThumbnailRenderScheduler::m_renderer

private

Definition at line 91 of file KisStoryboardThumbnailRenderScheduler.h.

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

plugins/dockers/storyboarddocker/KisStoryboardThumbnailRenderScheduler.h
plugins/dockers/storyboarddocker/KisStoryboardThumbnailRenderScheduler.cpp

Public Slots

Signals

Public Member Functions

Private Slots

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ KisStoryboardThumbnailRenderScheduler()

◆ ~KisStoryboardThumbnailRenderScheduler()

Member Function Documentation

◆ cancelAllFrameRendering()

◆ cancelFrameRendering()

◆ renderNextFrame()

◆ scheduleFrameForRegeneration()

◆ setImage()

◆ sigFrameCancelled

◆ sigFrameCompleted

◆ slotFrameRegenerationCancelled

◆ slotFrameRegenerationCompleted

◆ slotStartFrameRendering

◆ sortAffectedFrameQueue()

Member Data Documentation

◆ m_affectedFramesQueue

◆ m_changedFramesQueue

◆ m_currentFrame

◆ m_image

◆ m_renderer