KisCanvasAnimationState Class Reference

The KisCanvasAnimationState class stores all of the canvas-specific animation state. More...

#include <KisCanvasAnimationState.h>

Inheritance diagram for KisCanvasAnimationState:

Classes
struct	Private

Public Slots
void	showFrame (int frame, bool finalize=false)

Signals
void	sigAudioLevelChanged (qreal value)
void	sigCancelPlayback ()
void	sigFrameChanged ()
void	sigPlaybackMediaChanged ()
void	sigPlaybackSpeedChanged (qreal value)
void	sigPlaybackStateChanged (PlaybackState state)
void	sigPlaybackStatisticsUpdated ()

Public Member Functions
qreal	currentVolume ()
class KisFrameDisplayProxy *	displayProxy ()
	KisCanvasAnimationState (KisCanvas2 *canvas)
boost::optional< QFileInfo >	mediaInfo ()
	Get the media file info associated with this canvas, if available.
boost::optional< int >	playbackOrigin ()
	Get the animation frame to return to (for this canvas) when playback is stopped, if available.
qreal	playbackSpeed () const
PlaybackState	playbackState ()
void	setPlaybackSpeed (qreal value)
void	setPlaybackState (PlaybackState state)
	setPlaybackState changes the animation playback state for this canvas. KisPlaybackEngine should respond to changes in state while canvas is active, and use appropriate state when a new canvas is made active.
void	setupAudioTracks ()
	Sets up the audio tracks for a given animation. (The only reason this is public is because we have to defer this until after canvas construction.)
	~KisCanvasAnimationState () override

Private Member Functions
KisTimeSpan	activePlaybackRange ()

Private Attributes
QScopedPointer< Private >	m_d

Detailed Description

The KisCanvasAnimationState class stores all of the canvas-specific animation state.

Krita drives animation using a single KisPlaybackEngine instance (found in KisPart). However, there is some data that we want/need to store per-canvas (typically per-document). This might include the frame where playback started, audio volume, or anything else that we may need to persist between canvas changes.

Definition at line 38 of file KisCanvasAnimationState.h.

Constructor & Destructor Documentation

KisCanvasAnimationState()

KisCanvasAnimationState::KisCanvasAnimationState

(

KisCanvas2 *

canvas

)

Definition at line 236 of file KisCanvasAnimationState.cpp.

    : QObject(canvas)
    , m_d(new Private(canvas))
{
    setPlaybackState(STOPPED);
 
    // Handle image-internal frame change case...
    connect(m_d->displayProxy.data(), SIGNAL(sigFrameChange()), this, SIGNAL(sigFrameChanged()));
 
    // Grow to new playback range when new frames added (configurable)...
    connect(m_d->canvas->image()->animationInterface(), &KisImageAnimationInterface::sigKeyframeAdded, this, [this](const KisKeyframeChannel*, int time){
        if (m_d->canvas && m_d->canvas->image()) {
            KisImageAnimationInterface* animInterface = m_d->canvas->image()->animationInterface();
            KisConfig cfg(true);
            if (animInterface && cfg.adaptivePlaybackRange()) {
                KisTimeSpan desiredPlaybackRange = animInterface->documentPlaybackRange();
                desiredPlaybackRange.include(time);
                animInterface->setDocumentRange(desiredPlaybackRange);
            }
        }
    });
 
    connect(m_d->canvas->imageView()->document(), &KisDocument::sigAudioTracksChanged, this, &KisCanvasAnimationState::setupAudioTracks);
    connect(m_d->canvas->imageView()->document(), &KisDocument::sigAudioLevelChanged, this, &KisCanvasAnimationState::sigAudioLevelChanged);
    connect(&m_d->m_statsTimer, SIGNAL(timeout()), this, SIGNAL(sigPlaybackStatisticsUpdated()));
}

References connect(), m_d, setPlaybackState(), sigFrameChanged(), KisImageAnimationInterface::sigKeyframeAdded(), and STOPPED.

~KisCanvasAnimationState()

KisCanvasAnimationState::~KisCanvasAnimationState ( )

override

Definition at line 263 of file KisCanvasAnimationState.cpp.

{
}

Member Function Documentation

activePlaybackRange()

KisTimeSpan KisCanvasAnimationState::activePlaybackRange ( )

private

Definition at line 348 of file KisCanvasAnimationState.cpp.

{
    if (!m_d->canvas || !m_d->canvas->image()) {
        return KisTimeSpan::infinite(0);
    }
 
    const KisImageAnimationInterface *animation = m_d->canvas->image()->animationInterface();
    return animation->activePlaybackRange();
}

References KisImageAnimationInterface::activePlaybackRange(), KisImage::animationInterface(), KisImageAnimationInterface::image(), KisTimeSpan::infinite(), and m_d.

currentVolume()

qreal KisCanvasAnimationState::currentVolume

(

)

Definition at line 281 of file KisCanvasAnimationState.cpp.

{
    if (m_d->canvas && m_d->canvas->imageView() && m_d->canvas->imageView()->document()) {
        return m_d->canvas->imageView()->document()->getAudioLevel();
    } else {
        return 0.0;
    }
}

References m_d.

displayProxy()

KisFrameDisplayProxy * KisCanvasAnimationState::displayProxy

(

)

Definition at line 299 of file KisCanvasAnimationState.cpp.

{
    return m_d->displayProxy.data();
}

References m_d.

mediaInfo()

boost::optional< QFileInfo > KisCanvasAnimationState::mediaInfo

(

)

Get the media file info associated with this canvas, if available.

Definition at line 272 of file KisCanvasAnimationState.cpp.

{
    if (m_d->media) {
        return boost::optional<QFileInfo>(*m_d->media);
    } else {
        return boost::none;
    }
}

References m_d.

playbackOrigin()

boost::optional< int > KisCanvasAnimationState::playbackOrigin

(

)

Get the animation frame to return to (for this canvas) when playback is stopped, if available.

Definition at line 290 of file KisCanvasAnimationState.cpp.

{
    if (m_d->playbackEnvironment) {
        return boost::optional<int>(m_d->playbackEnvironment->originFrame());
    } else {
        return boost::none;
    }
}

References m_d.

playbackSpeed()

qreal KisCanvasAnimationState::playbackSpeed

(

)

const

Definition at line 312 of file KisCanvasAnimationState.cpp.

{
    return m_d->playbackSpeed;
}

References m_d.

playbackState()

PlaybackState KisCanvasAnimationState::playbackState

(

)

Definition at line 267 of file KisCanvasAnimationState.cpp.

{
    return m_d->state;
}

References m_d.

setPlaybackSpeed()

void KisCanvasAnimationState::setPlaybackSpeed

(

qreal

value

)

Definition at line 304 of file KisCanvasAnimationState.cpp.

{
    if (!qFuzzyCompare(value, m_d->playbackSpeed)) {
        m_d->playbackSpeed = value;
        Q_EMIT sigPlaybackSpeedChanged(value);
    }
}

References m_d, qFuzzyCompare(), sigPlaybackSpeedChanged(), and value().

setPlaybackState()

void KisCanvasAnimationState::setPlaybackState

(

PlaybackState

state

)

setPlaybackState changes the animation playback state for this canvas. KisPlaybackEngine should respond to changes in state while canvas is active, and use appropriate state when a new canvas is made active.

Definition at line 358 of file KisCanvasAnimationState.cpp.

{
    if (m_d->state != p_state) {
        m_d->state = p_state;
        if (m_d->state == PLAYING) {
            if (m_d->playbackEnvironment) {
                m_d->playbackEnvironment->prepare(); // re-prepare
            } else {
                m_d->playbackEnvironment.reset(new CanvasPlaybackEnvironment(m_d->displayProxy->activeFrame(), m_d->canvas, this));
 
                connect(m_d->playbackEnvironment.data(), SIGNAL(sigPlaybackStatisticsUpdated()),
                        this, SIGNAL(sigPlaybackStatisticsUpdated()));
            }
 
            m_d->m_statsTimer.start();
            Q_EMIT sigPlaybackStatisticsUpdated();
        } else {
            if (m_d->state == STOPPED) {
                m_d->playbackEnvironment.reset();
            } else if(m_d->playbackEnvironment) {
                m_d->playbackEnvironment->restore();
            }
 
            m_d->m_statsTimer.stop();
            Q_EMIT sigPlaybackStatisticsUpdated();
        }
 
        Q_EMIT sigPlaybackStateChanged(m_d->state);
    }
}

References connect(), m_d, PLAYING, sigPlaybackStateChanged(), sigPlaybackStatisticsUpdated(), and STOPPED.

setupAudioTracks()

void KisCanvasAnimationState::setupAudioTracks

(

)

Sets up the audio tracks for a given animation. (The only reason this is public is because we have to defer this until after canvas construction.)

Definition at line 317 of file KisCanvasAnimationState.cpp.

{
    if (!m_d->canvas || !m_d->canvas->imageView()) {
        return;
    }
 
    KisDocument* doc = m_d->canvas->imageView()->document();
    if (doc) {
        QVector<QFileInfo> files = doc->getAudioTracks();
 
        if (doc->getAudioTracks().isEmpty()) {
            m_d->media.reset();
        } else {
            //Only get first file for now and make that a producer...
            QFileInfo toLoad = files.first();
            KIS_SAFE_ASSERT_RECOVER_RETURN(toLoad.exists());
            m_d->media.reset(new QFileInfo(toLoad));
 
            // Once media is attached we upgrade to the MLT-based playbackEngine...
            KisPart::instance()->upgradeToPlaybackEngineMLT(m_d->canvas);
        }
 
        Q_EMIT sigPlaybackMediaChanged();
    }
}

References Private::canvas, KisDocument::getAudioTracks(), KisCanvas2::imageView(), KisPart::instance(), KIS_SAFE_ASSERT_RECOVER_RETURN, m_d, sigPlaybackMediaChanged(), and KisPart::upgradeToPlaybackEngineMLT().

showFrame

void KisCanvasAnimationState::showFrame ( int frame, bool finalize = false )

slot

Definition at line 343 of file KisCanvasAnimationState.cpp.

{
    m_d->displayProxy->displayFrame(frame, finalize);
}

References m_d.

sigAudioLevelChanged

void KisCanvasAnimationState::sigAudioLevelChanged ( qreal value )

signal

sigCancelPlayback

void KisCanvasAnimationState::sigCancelPlayback ( )

signal

sigFrameChanged

void KisCanvasAnimationState::sigFrameChanged ( )

signal

sigPlaybackMediaChanged

void KisCanvasAnimationState::sigPlaybackMediaChanged ( )

signal

sigPlaybackSpeedChanged

void KisCanvasAnimationState::sigPlaybackSpeedChanged ( qreal value )

signal

sigPlaybackStateChanged

void KisCanvasAnimationState::sigPlaybackStateChanged ( PlaybackState state )

signal

sigPlaybackStatisticsUpdated

void KisCanvasAnimationState::sigPlaybackStatisticsUpdated ( )

signal

Member Data Documentation

m_d

QScopedPointer<Private> KisCanvasAnimationState::m_d

private

Definition at line 93 of file KisCanvasAnimationState.h.

---

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

• libs/ui/canvas/KisCanvasAnimationState.h
• libs/ui/canvas/KisCanvasAnimationState.cpp