Krita's base animation playback engine for producing image frame changes and associated audio. More...

#include <KisPlaybackEngine.h>

Inheritance diagram for KisPlaybackEngine:

Classes
struct	PlaybackStats

struct	Private

Public Slots
bool	dropFrames () const

virtual void	firstFrame ()

virtual bool	isMute ()=0

virtual void	lastFrame ()

virtual void	nextFrame ()

virtual void	nextKeyframe ()

virtual void	nextMatchingKeyframe ()

virtual void	nextUnfilteredKeyframe ()

virtual void	pause ()

virtual void	play ()

virtual PlaybackStats	playbackStatistics () const =0

virtual void	playPause ()

virtual void	previousFrame ()

virtual void	previousKeyframe ()

virtual void	previousMatchingKeyframe ()
	previousMatchingKeyframe && nextMatchingKeyframe Navigate to the next keyframe that has the same color-label as the current keyframe. Useful to quickly navigate to user-specified 'similar' keyframes. E.g. Contact points in an animation might have a specific color to specify importance and be quickly swapped between.

virtual void	previousUnfilteredKeyframe ()
	previousUnfilteredKeyframe && nextUnfilteredKeyframe Navigate to keyframes based on the current onion skin filtration. This lets users easily navigate to the next visible "onion-skinned" keyframe on the active layer.

virtual void	seek (int frameIndex, SeekOptionFlags options=SEEK_FINALIZE\|SEEK_PUSH_AUDIO)=0

virtual void	setDropFramesMode (bool value)

virtual void	setMute (bool val)=0

virtual void	stop ()

virtual bool	supportsAudio ()=0

virtual bool	supportsVariablePlaybackSpeed ()=0

Signals
void	sigDropFramesModeChanged (bool value)

Public Member Functions
	KisPlaybackEngine (QObject *parent=nullptr)

	~KisPlaybackEngine ()

Public Member Functions inherited from KoCanvasObserverBase
	KoCanvasObserverBase ()

KoCanvasBase *	observedCanvas () const

virtual QString	observerName ()

void	setObservedCanvas (KoCanvasBase *canvas)

void	unsetObservedCanvas ()

virtual	~KoCanvasObserverBase ()

Protected Slots
virtual void	setCanvas (KoCanvasBase *p_canvas) override

virtual void	unsetCanvas () override

Protected Member Functions
class KisCanvas2 *	activeCanvas () const

int	frameWrap (int frame, int startFrame, int endFrame)

Protected Member Functions inherited from KoCanvasObserverBase
virtual void	setCanvas (KoCanvasBase *canvas)=0

virtual void	unsetCanvas ()=0

Private Member Functions
void	moveActiveFrameBy (int frames)
	Move the active frame of the animation player forwards or backwards by some number of frames.

void	nextKeyframeWithColor (const QSet< int > &validColors)

void	nextKeyframeWithColor (int color)

void	previousKeyframeWithColor (const QSet< int > &validColors)

void	previousKeyframeWithColor (int color)

Private Attributes
QScopedPointer< Private >	m_d

Detailed Description

Krita's base animation playback engine for producing image frame changes and associated audio.

Krita stores a main playback engine in KisPart (a singleton) to be used by the active document's canvas. It can be thought of as being just below the GUI layer of Krita's animation system, responding to various GUI events, controlling transport controls (play, stop, next, etc.), and generally driving the playback of animation within Krita.

It's implemented by KisPlaybackEngineQT and KisPlaybackEngineMLT, one of which is typically selected at compile time depending on available dependencies. Specific implementations may or may not support certain features (audio, speed, dropping frames, etc.) and have other different characteristics.

Definition at line 42 of file KisPlaybackEngine.h.

Constructor & Destructor Documentation

◆ KisPlaybackEngine()

KisPlaybackEngine::KisPlaybackEngine ( QObject * parent = nullptr )

Definition at line 34 of file KisPlaybackEngine.cpp.

    : QObject(parent)
    , m_d(new Private)
{
    KisConfig cfg(true);
    m_d->dropFramesMode = cfg.animationDropFrames();
}

References KisConfig::animationDropFrames(), and m_d.

◆ ~KisPlaybackEngine()

KisPlaybackEngine::~KisPlaybackEngine ( )

Definition at line 42 of file KisPlaybackEngine.cpp.

43{

44}

Member Function Documentation

◆ activeCanvas()

KisCanvas2 * KisPlaybackEngine::activeCanvas ( ) const

protected

Definition at line 290 of file KisPlaybackEngine.cpp.

{
    return m_d->activeCanvas;
}

References m_d.

◆ dropFrames

bool KisPlaybackEngine::dropFrames ( ) const

slot

Definition at line 271 of file KisPlaybackEngine.cpp.

{
    return m_d->dropFramesMode;
}

References m_d.

◆ firstFrame

void KisPlaybackEngine::firstFrame ( )

virtualslot

Definition at line 177 of file KisPlaybackEngine.cpp.

{
    if (!m_d->activeCanvas) return;
    KisCanvasAnimationState *animationState = m_d->activeCanvas->animationState();
    KIS_SAFE_ASSERT_RECOVER_RETURN(animationState);
    KisImageAnimationInterface *animInterface = m_d->activeCanvas->image()->animationInterface();
 
    const int startFrame = animInterface->activePlaybackRange().start();
 
    if (animationState->playbackState() != STOPPED) {
        stop();
    }
 
    seek(startFrame, SEEK_FINALIZE | SEEK_PUSH_AUDIO);
}

References KisImageAnimationInterface::activePlaybackRange(), KisImage::animationInterface(), KisImageAnimationInterface::image(), KIS_SAFE_ASSERT_RECOVER_RETURN, m_d, KisCanvasAnimationState::playbackState(), seek(), SEEK_FINALIZE, SEEK_PUSH_AUDIO, KisTimeSpan::start(), stop(), and STOPPED.

◆ frameWrap()

int KisPlaybackEngine::frameWrap	(	int	frame,
		int	startFrame,
		int	endFrame )

protected

Definition at line 276 of file KisPlaybackEngine.cpp.

{
    // Since Krita has always considered the end frame as inclusive, we need
    // to make sure our wrap method respects that as well.
    const int inclusiveEndFrame = endFrame + 1;
    frame = ((frame - startFrame) % (inclusiveEndFrame - startFrame)) + startFrame;
 
    if (frame - startFrame < 0) {
        frame += (inclusiveEndFrame - startFrame);
    }
 
    return frame;
}

◆ isMute

virtual bool KisPlaybackEngine::isMute ( )

pure virtualslot

Implemented in KisPlaybackEngineQT.

◆ lastFrame

void KisPlaybackEngine::lastFrame ( )

virtualslot

Definition at line 193 of file KisPlaybackEngine.cpp.

{
    if (!m_d->activeCanvas) return;
    KisCanvasAnimationState *animationState = m_d->activeCanvas->animationState();
    KIS_SAFE_ASSERT_RECOVER_RETURN(animationState);
    KisImageAnimationInterface *animInterface = m_d->activeCanvas->image()->animationInterface();
 
    const int endFrame = animInterface->activePlaybackRange().end();
 
    if (animationState->playbackState() != STOPPED) {
        stop();
    }
 
    seek(endFrame, SEEK_FINALIZE | SEEK_PUSH_AUDIO);
}

References KisImageAnimationInterface::activePlaybackRange(), KisImage::animationInterface(), KisTimeSpan::end(), KisImageAnimationInterface::image(), KIS_SAFE_ASSERT_RECOVER_RETURN, m_d, KisCanvasAnimationState::playbackState(), seek(), SEEK_FINALIZE, SEEK_PUSH_AUDIO, stop(), and STOPPED.

◆ moveActiveFrameBy()

void KisPlaybackEngine::moveActiveFrameBy ( int frames )

private

Move the active frame of the animation player forwards or backwards by some number of frames.

Parameters

The	signed number of frames to move. Negative frames move backwards in time (left on a left-to-right system).

Definition at line 333 of file KisPlaybackEngine.cpp.

{
    if (!m_d->activeCanvas) return;
    KisCanvasAnimationState *animationState = m_d->activeCanvas->animationState();
    KIS_SAFE_ASSERT_RECOVER_RETURN(animationState);
    KisImageAnimationInterface *animInterface = m_d->activeCanvas->image()->animationInterface();
 
    int frame = animationState->displayProxy()->activeFrame() + frames;
 
    const int startFrame = animInterface->activePlaybackRange().start();
    const int endFrame = animInterface->activePlaybackRange().end();
 
    frame = frameWrap(frame, startFrame, endFrame);
 
    KIS_SAFE_ASSERT_RECOVER_RETURN(frame >= 0);
 
    if (animationState->playbackState() != STOPPED) {
        stop();
    }
 
    seek(frame, SEEK_FINALIZE | SEEK_PUSH_AUDIO);
}

References KisFrameDisplayProxy::activeFrame(), KisImageAnimationInterface::activePlaybackRange(), KisImage::animationInterface(), KisCanvasAnimationState::displayProxy(), KisTimeSpan::end(), frameWrap(), KisImageAnimationInterface::image(), KIS_SAFE_ASSERT_RECOVER_RETURN, m_d, KisCanvasAnimationState::playbackState(), seek(), SEEK_FINALIZE, SEEK_PUSH_AUDIO, KisTimeSpan::start(), stop(), and STOPPED.

◆ nextFrame

void KisPlaybackEngine::nextFrame ( )

virtualslot

Definition at line 98 of file KisPlaybackEngine.cpp.

{
    moveActiveFrameBy(1);
}

References moveActiveFrameBy().

◆ nextKeyframe

void KisPlaybackEngine::nextKeyframe ( )

virtualslot

Definition at line 134 of file KisPlaybackEngine.cpp.

{
    if (!m_d->activeCanvas) return;
    KisCanvasAnimationState *animationState = m_d->activeCanvas->animationState();
    KIS_SAFE_ASSERT_RECOVER_RETURN(animationState);
 
    KisNodeSP node = m_d->activeCanvas->viewManager()->activeNode();
    if (!node) return;
 
    KisKeyframeChannel *keyframes =
        node->getKeyframeChannel(KisKeyframeChannel::Raster.id());
    if (!keyframes) return;
 
    int currentTime = animationState->displayProxy()->activeFrame();
 
    int destinationTime = -1;
    if (keyframes->activeKeyframeAt(currentTime)) {
        destinationTime = keyframes->nextKeyframeTime(currentTime);
    }
 
    if (keyframes->keyframeAt(destinationTime)) {
        // Jump to next key...
        if (animationState->playbackState() != STOPPED) {
            stop();
        }
 
        seek(destinationTime, SEEK_FINALIZE | SEEK_PUSH_AUDIO);
    } else {
        // Jump ahead by estimated timing...
        const int activeKeyTime = keyframes->activeKeyframeTime(currentTime);
        const int previousKeyTime = keyframes->previousKeyframeTime(activeKeyTime);
 
        if (previousKeyTime != -1) {
            if (animationState->playbackState() != STOPPED) {
                stop();
            }
 
            const int timing = activeKeyTime - previousKeyTime;
            seek(currentTime + timing, SEEK_FINALIZE | SEEK_PUSH_AUDIO);
        }
    }
}

References KisFrameDisplayProxy::activeFrame(), KisKeyframeChannel::activeKeyframeAt(), KisKeyframeChannel::activeKeyframeTime(), KisCanvasAnimationState::displayProxy(), KisBaseNode::getKeyframeChannel(), KisKeyframeChannel::keyframeAt(), KIS_SAFE_ASSERT_RECOVER_RETURN, m_d, KisKeyframeChannel::nextKeyframeTime(), KisCanvasAnimationState::playbackState(), KisKeyframeChannel::previousKeyframeTime(), KisKeyframeChannel::Raster, seek(), SEEK_FINALIZE, SEEK_PUSH_AUDIO, stop(), and STOPPED.

◆ nextKeyframeWithColor() [1/2]

void KisPlaybackEngine::nextKeyframeWithColor ( const QSet< int > & validColors )

private

Definition at line 363 of file KisPlaybackEngine.cpp.

{
    if (!m_d->activeCanvas) return;
    KisCanvasAnimationState *animationState = m_d->activeCanvas->animationState();
    KIS_SAFE_ASSERT_RECOVER_RETURN(animationState);
 
    KisNodeSP node = m_d->activeCanvas->viewManager()->activeNode();
    if (!node) return;
 
    KisKeyframeChannel *keyframes =
        node->getKeyframeChannel(KisKeyframeChannel::Raster.id());
    if (!keyframes) return;
 
    int time = animationState->displayProxy()->activeFrame();
 
    if (!keyframes->activeKeyframeAt(time)) {
        return;
    }
 
    int destinationTime = keyframes->activeKeyframeTime(time);
    while ( keyframes->keyframeAt(destinationTime) &&
            ((destinationTime == time) ||
            !validColors.contains(keyframes->keyframeAt(destinationTime)->colorLabel()))) {
 
        destinationTime = keyframes->nextKeyframeTime(destinationTime);
    }
 
    if (keyframes->keyframeAt(destinationTime)) {
        if (animationState->playbackState() != STOPPED) {
            stop();
        }
 
        seek(destinationTime, SEEK_FINALIZE | SEEK_PUSH_AUDIO);
    }
}

References KisFrameDisplayProxy::activeFrame(), KisKeyframeChannel::activeKeyframeAt(), KisKeyframeChannel::activeKeyframeTime(), KisCanvasAnimationState::displayProxy(), KisBaseNode::getKeyframeChannel(), KisKeyframeChannel::keyframeAt(), KIS_SAFE_ASSERT_RECOVER_RETURN, m_d, KisKeyframeChannel::nextKeyframeTime(), KisCanvasAnimationState::playbackState(), KisKeyframeChannel::Raster, seek(), SEEK_FINALIZE, SEEK_PUSH_AUDIO, stop(), and STOPPED.

◆ nextKeyframeWithColor() [2/2]

void KisPlaybackEngine::nextKeyframeWithColor ( int color )

private

Definition at line 356 of file KisPlaybackEngine.cpp.

{
    QSet<int> validColors;
    validColors.insert(color);
    nextKeyframeWithColor(validColors);
}

References nextKeyframeWithColor().

◆ nextMatchingKeyframe

void KisPlaybackEngine::nextMatchingKeyframe ( )

virtualslot

Definition at line 230 of file KisPlaybackEngine.cpp.

{
    if (!m_d->activeCanvas) return;
    KisCanvasAnimationState *animationState = m_d->activeCanvas->animationState();
    KIS_SAFE_ASSERT_RECOVER_RETURN(animationState);
 
    KisNodeSP node = m_d->activeCanvas->viewManager()->activeNode();
    if (!node) return;
 
    KisKeyframeChannel *keyframes =
        node->getKeyframeChannel(KisKeyframeChannel::Raster.id());
    if (!keyframes) return;
 
    int time = animationState->displayProxy()->activeFrame();
 
    if (!keyframes->activeKeyframeAt(time)) {
        return;
    }
 
    int destinationTime = keyframes->activeKeyframeTime(time);
    nextKeyframeWithColor(keyframes->keyframeAt(destinationTime)->colorLabel());
}

References KisFrameDisplayProxy::activeFrame(), KisKeyframeChannel::activeKeyframeAt(), KisKeyframeChannel::activeKeyframeTime(), KisCanvasAnimationState::displayProxy(), KisBaseNode::getKeyframeChannel(), KisKeyframeChannel::keyframeAt(), KIS_SAFE_ASSERT_RECOVER_RETURN, m_d, nextKeyframeWithColor(), and KisKeyframeChannel::Raster.

◆ nextUnfilteredKeyframe

void KisPlaybackEngine::nextUnfilteredKeyframe ( )

virtualslot

Definition at line 258 of file KisPlaybackEngine.cpp.

{
    nextKeyframeWithColor(KisOnionSkinCompositor::instance()->colorLabelFilter());
}

References KisOnionSkinCompositor::instance(), and nextKeyframeWithColor().

◆ pause

void KisPlaybackEngine::pause ( )

virtualslot

Definition at line 52 of file KisPlaybackEngine.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_RETURN(activeCanvas() && activeCanvas()->animationState());
    KisCanvasAnimationState* animationState = activeCanvas()->animationState();
 
    animationState->setPlaybackState(PAUSED);
 
    seek(animationState->displayProxy()->activeFrame(), SEEK_FINALIZE);
}

References activeCanvas(), KisFrameDisplayProxy::activeFrame(), KisCanvas2::animationState(), KisCanvasAnimationState::displayProxy(), KIS_SAFE_ASSERT_RECOVER_RETURN, PAUSED, seek(), SEEK_FINALIZE, and KisCanvasAnimationState::setPlaybackState().

◆ play

void KisPlaybackEngine::play ( )

virtualslot

Definition at line 46 of file KisPlaybackEngine.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_RETURN(activeCanvas() && activeCanvas()->animationState());
    activeCanvas()->animationState()->setPlaybackState(PLAYING);
}

References activeCanvas(), KisCanvas2::animationState(), KIS_SAFE_ASSERT_RECOVER_RETURN, PLAYING, and KisCanvasAnimationState::setPlaybackState().

◆ playbackStatistics

virtual PlaybackStats KisPlaybackEngine::playbackStatistics ( ) const

pure virtualslot

Implemented in KisPlaybackEngineQT.

◆ playPause

void KisPlaybackEngine::playPause ( )

virtualslot

Definition at line 62 of file KisPlaybackEngine.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_RETURN(activeCanvas() && activeCanvas()->animationState());
    KisCanvasAnimationState* animationState = activeCanvas()->animationState();
 
    if (animationState->playbackState() == PLAYING) {
        pause();  
    } else {
        play();
    }
}

References activeCanvas(), KisCanvas2::animationState(), KIS_SAFE_ASSERT_RECOVER_RETURN, pause(), play(), KisCanvasAnimationState::playbackState(), and PLAYING.

◆ previousFrame

void KisPlaybackEngine::previousFrame ( )

virtualslot

Definition at line 93 of file KisPlaybackEngine.cpp.

{
    moveActiveFrameBy(-1);
}

References moveActiveFrameBy().

◆ previousKeyframe

void KisPlaybackEngine::previousKeyframe ( )

virtualslot

Definition at line 103 of file KisPlaybackEngine.cpp.

{
    if (!m_d->activeCanvas) return;
    KisCanvasAnimationState *animationState = m_d->activeCanvas->animationState();
    KIS_SAFE_ASSERT_RECOVER_RETURN(animationState);
 
    KisNodeSP node = m_d->activeCanvas->viewManager()->activeNode();
    if (!node) return;
 
    KisKeyframeChannel *keyframes =
        node->getKeyframeChannel(KisKeyframeChannel::Raster.id());
    if (!keyframes) return;
 
    int currentFrame = animationState->displayProxy()->activeFrame();
 
    int destinationTime = -1;
    if (!keyframes->keyframeAt(currentFrame)) {
        destinationTime = keyframes->activeKeyframeTime(currentFrame);
    } else {
        destinationTime = keyframes->previousKeyframeTime(currentFrame);
    }
 
    if (keyframes->keyframeAt(destinationTime)) {
        if (animationState->playbackState() != STOPPED) {
            stop();
        }
 
        seek(destinationTime, SEEK_FINALIZE | SEEK_PUSH_AUDIO);
    }
}

References KisFrameDisplayProxy::activeFrame(), KisKeyframeChannel::activeKeyframeTime(), KisCanvasAnimationState::displayProxy(), KisBaseNode::getKeyframeChannel(), KisKeyframeChannel::keyframeAt(), KIS_SAFE_ASSERT_RECOVER_RETURN, m_d, KisCanvasAnimationState::playbackState(), KisKeyframeChannel::previousKeyframeTime(), KisKeyframeChannel::Raster, seek(), SEEK_FINALIZE, SEEK_PUSH_AUDIO, stop(), and STOPPED.

◆ previousKeyframeWithColor() [1/2]

void KisPlaybackEngine::previousKeyframeWithColor ( const QSet< int > & validColors )

private

Definition at line 406 of file KisPlaybackEngine.cpp.

{
    if (!m_d->activeCanvas) return;
    KisCanvasAnimationState *animationState = m_d->activeCanvas->animationState();
    KIS_SAFE_ASSERT_RECOVER_RETURN(animationState);
 
    KisNodeSP node = m_d->activeCanvas->viewManager()->activeNode();
    if (!node) return;
 
    KisKeyframeChannel *keyframes =
        node->getKeyframeChannel(KisKeyframeChannel::Raster.id());
    if (!keyframes) return;
 
    int time = animationState->displayProxy()->activeFrame();
 
    int destinationTime = keyframes->activeKeyframeTime(time);
    while (keyframes->keyframeAt(destinationTime) &&
           ((destinationTime == time) ||
           !validColors.contains(keyframes->keyframeAt(destinationTime)->colorLabel()))) {
 
        destinationTime = keyframes->previousKeyframeTime(destinationTime);
    }
 
    if (keyframes->keyframeAt(destinationTime)) {
        if (animationState->playbackState() != STOPPED) {
            stop();
        }
 
        seek(destinationTime, SEEK_FINALIZE | SEEK_PUSH_AUDIO);
    }
}

References KisFrameDisplayProxy::activeFrame(), KisKeyframeChannel::activeKeyframeTime(), KisCanvasAnimationState::displayProxy(), KisBaseNode::getKeyframeChannel(), KisKeyframeChannel::keyframeAt(), KIS_SAFE_ASSERT_RECOVER_RETURN, m_d, KisCanvasAnimationState::playbackState(), KisKeyframeChannel::previousKeyframeTime(), KisKeyframeChannel::Raster, seek(), SEEK_FINALIZE, SEEK_PUSH_AUDIO, stop(), and STOPPED.

◆ previousKeyframeWithColor() [2/2]

void KisPlaybackEngine::previousKeyframeWithColor ( int color )

private

Definition at line 399 of file KisPlaybackEngine.cpp.

{
    QSet<int> validColors;
    validColors.insert(color);
    previousKeyframeWithColor(validColors);
}

References previousKeyframeWithColor().

◆ previousMatchingKeyframe

void KisPlaybackEngine::previousMatchingKeyframe ( )

virtualslot

previousMatchingKeyframe && nextMatchingKeyframe Navigate to the next keyframe that has the same color-label as the current keyframe. Useful to quickly navigate to user-specified 'similar' keyframes. E.g. Contact points in an animation might have a specific color to specify importance and be quickly swapped between.

Definition at line 209 of file KisPlaybackEngine.cpp.

{
    if (!m_d->activeCanvas) return;
    KisCanvasAnimationState *animationState = m_d->activeCanvas->animationState();
    KIS_SAFE_ASSERT_RECOVER_RETURN(animationState);
 
    KisNodeSP node = m_d->activeCanvas->viewManager()->activeNode();
    if (!node) return;
 
    KisKeyframeChannel *keyframes =
        node->getKeyframeChannel(KisKeyframeChannel::Raster.id());
    if (!keyframes) return;
 
    int time = animationState->displayProxy()->activeFrame();
 
    KisKeyframeSP currentKeyframe = keyframes->keyframeAt(time);
    int destinationTime = keyframes->activeKeyframeTime(time);
    const int desiredColor = currentKeyframe ? currentKeyframe->colorLabel() : keyframes->keyframeAt(destinationTime)->colorLabel();
    previousKeyframeWithColor(desiredColor);
}

References KisFrameDisplayProxy::activeFrame(), KisKeyframeChannel::activeKeyframeTime(), KisCanvasAnimationState::displayProxy(), KisBaseNode::getKeyframeChannel(), KisKeyframeChannel::keyframeAt(), KIS_SAFE_ASSERT_RECOVER_RETURN, m_d, previousKeyframeWithColor(), and KisKeyframeChannel::Raster.

◆ previousUnfilteredKeyframe

void KisPlaybackEngine::previousUnfilteredKeyframe ( )

virtualslot

previousUnfilteredKeyframe && nextUnfilteredKeyframe Navigate to keyframes based on the current onion skin filtration. This lets users easily navigate to the next visible "onion-skinned" keyframe on the active layer.

Definition at line 253 of file KisPlaybackEngine.cpp.

{
    previousKeyframeWithColor(KisOnionSkinCompositor::instance()->colorLabelFilter());
}

References KisOnionSkinCompositor::instance(), and previousKeyframeWithColor().

◆ seek

virtual void KisPlaybackEngine::seek	(	int	frameIndex,
		SeekOptionFlags	options = SEEK_FINALIZE\|SEEK_PUSH_AUDIO )

pure virtualslot

Implemented in KisPlaybackEngineQT.

◆ setCanvas

void KisPlaybackEngine::setCanvas ( KoCanvasBase * p_canvas )

overrideprotectedvirtualslot

TODO: This forced updates causes image recalculation on every document switch, which is weird and even causes some crashes on closing many documents at once (which is a separate bug it seems). Why document switch should forcefully regeneare the canvas?

Reimplemented in KisPlaybackEngineQT.

Definition at line 295 of file KisPlaybackEngine.cpp.

{
    if (m_d->activeCanvas) {
        KisCanvasAnimationState* animState = m_d->activeCanvas->animationState();
        KIS_SAFE_ASSERT_RECOVER_RETURN(animState);
 
        animState->disconnect(this);
    }
 
    KisCanvas2* canvas = dynamic_cast<KisCanvas2*>(p_canvas);
    m_d->activeCanvas = canvas;
 
    if (m_d->activeCanvas) {
        KisCanvasAnimationState* animState = m_d->activeCanvas->animationState();
        KIS_SAFE_ASSERT_RECOVER_RETURN(animState);
 
        connect(animState, &KisCanvasAnimationState::sigCancelPlayback,
                this, &KisPlaybackEngine::stop);
 
//        KisImageAnimationInterface* animInterface = m_d->activeCanvas->image()->animationInterface();
//        KisFrameDisplayProxy* displayProxy = animState->displayProxy();
//        if (animState->playbackState() != PLAYING) {
//            displayProxy->displayFrame(animInterface->currentTime(), false);
//        }
    }
}

References connect(), KIS_SAFE_ASSERT_RECOVER_RETURN, m_d, KisCanvasAnimationState::sigCancelPlayback(), and stop().

◆ setDropFramesMode

void KisPlaybackEngine::setDropFramesMode ( bool value )

virtualslot

Reimplemented in KisPlaybackEngineQT.

Definition at line 263 of file KisPlaybackEngine.cpp.

{
    if (value != m_d->dropFramesMode) {
        m_d->dropFramesMode = value;
        Q_EMIT sigDropFramesModeChanged(value);
    }
}

References m_d, sigDropFramesModeChanged(), and value().

◆ setMute

virtual void KisPlaybackEngine::setMute ( bool val )

pure virtualslot

Implemented in KisPlaybackEngineQT.

◆ sigDropFramesModeChanged

void KisPlaybackEngine::sigDropFramesModeChanged ( bool value )

signal

◆ stop

void KisPlaybackEngine::stop ( )

virtualslot

Definition at line 74 of file KisPlaybackEngine.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_RETURN(activeCanvas() && activeCanvas()->animationState());
    KisCanvasAnimationState* animationState = activeCanvas()->animationState();
 
    if (animationState->playbackState() != STOPPED) {
        const boost::optional<int> origin = animationState->playbackOrigin();
        animationState->setPlaybackState(STOPPED);
        if (origin.has_value()) {
            seek(origin.value(), SEEK_FINALIZE);
        }
    } else if (animationState->displayProxy()->activeFrame() != 0) {
        KisImageAnimationInterface* ai = activeCanvas()->image()->animationInterface();
        KIS_SAFE_ASSERT_RECOVER_RETURN(ai);
        const int firstFrame = ai->documentPlaybackRange().start();
        seek(firstFrame, SEEK_FINALIZE | SEEK_PUSH_AUDIO);
    }
}

References activeCanvas(), KisFrameDisplayProxy::activeFrame(), KisImage::animationInterface(), KisCanvas2::animationState(), KisCanvasAnimationState::displayProxy(), KisImageAnimationInterface::documentPlaybackRange(), firstFrame(), KisCanvas2::image(), KIS_SAFE_ASSERT_RECOVER_RETURN, KisCanvasAnimationState::playbackOrigin(), KisCanvasAnimationState::playbackState(), seek(), SEEK_FINALIZE, SEEK_PUSH_AUDIO, KisCanvasAnimationState::setPlaybackState(), KisTimeSpan::start(), and STOPPED.

◆ supportsAudio

virtual bool KisPlaybackEngine::supportsAudio ( )

pure virtualslot

Implemented in KisPlaybackEngineQT.

◆ supportsVariablePlaybackSpeed

virtual bool KisPlaybackEngine::supportsVariablePlaybackSpeed ( )

pure virtualslot

Implemented in KisPlaybackEngineQT.

◆ unsetCanvas

void KisPlaybackEngine::unsetCanvas ( )

overrideprotectedvirtualslot

Reimplemented in KisPlaybackEngineQT.

Definition at line 328 of file KisPlaybackEngine.cpp.

{
    m_d->activeCanvas = nullptr;
}

References m_d.

Member Data Documentation

◆ m_d

QScopedPointer<Private> KisPlaybackEngine::m_d

private

Definition at line 127 of file KisPlaybackEngine.h.

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

libs/ui/KisPlaybackEngine.h
libs/ui/KisPlaybackEngine.cpp

Classes

Public Slots

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ KisPlaybackEngine()

◆ ~KisPlaybackEngine()

Member Function Documentation

◆ activeCanvas()

◆ dropFrames

◆ firstFrame

◆ frameWrap()

◆ isMute

◆ lastFrame

◆ moveActiveFrameBy()

◆ nextFrame

◆ nextKeyframe

◆ nextKeyframeWithColor() [1/2]

◆ nextKeyframeWithColor() [2/2]

◆ nextMatchingKeyframe

◆ nextUnfilteredKeyframe

◆ pause

◆ play

◆ playbackStatistics

◆ playPause

◆ previousFrame

◆ previousKeyframe

◆ previousKeyframeWithColor() [1/2]

◆ previousKeyframeWithColor() [2/2]

◆ previousMatchingKeyframe

◆ previousUnfilteredKeyframe

◆ seek

◆ setCanvas

◆ setDropFramesMode

◆ setMute

◆ sigDropFramesModeChanged

◆ stop

◆ supportsAudio

◆ supportsVariablePlaybackSpeed

◆ unsetCanvas

Member Data Documentation

◆ m_d