KisPlaybackEngineMLT::StopAndResume Struct Reference

The StopAndResumeConsumer struct is used to encapsulate optional stop-and-then-resume behavior of a consumer. Using RAII, we can stop a consumer at construction and simply resume it when it exits scope. More...

Public Member Functions
	StopAndResume (KisPlaybackEngineMLT::Private *p_d, bool requireFullRestart=false)
	~StopAndResume ()

Private Attributes
Private *	m_d

Detailed Description

The StopAndResumeConsumer struct is used to encapsulate optional stop-and-then-resume behavior of a consumer. Using RAII, we can stop a consumer at construction and simply resume it when it exits scope.

Definition at line 289 of file KisPlaybackEngineMLT.cpp.

Constructor & Destructor Documentation

StopAndResume()

KisPlaybackEngineMLT::StopAndResume::StopAndResume ( KisPlaybackEngineMLT::Private * p_d, bool requireFullRestart = false )

inlineexplicit

Definition at line 291 of file KisPlaybackEngineMLT.cpp.

        : m_d(p_d)
    {
        KIS_ASSERT(p_d);
 
 
        {
            QMutexLocker l(&m_d->frameWaitingInterface.renderingControlMutex);
            m_d->frameWaitingInterface.renderingAllowed = false;
            m_d->frameWaitingInterface.renderingWaitCondition.wakeAll();
        }
 
        m_d->pushConsumer->stop();
        m_d->pushConsumer->purge();
        m_d->pullConsumer->stop();
        m_d->pullConsumer->purge();
        m_d->pullConsumer->disconnect_all_producers();
 
        if (requireFullRestart) {
            m_d->cleanupConsumers();
        }
    }

References KisPlaybackEngineMLT::Private::cleanupConsumers(), KisPlaybackEngineMLT::Private::frameWaitingInterface, KIS_ASSERT, m_d, KisPlaybackEngineMLT::Private::pullConsumer, KisPlaybackEngineMLT::Private::pushConsumer, KisPlaybackEngineMLT::FrameWaitingInterface::renderingAllowed, KisPlaybackEngineMLT::FrameWaitingInterface::renderingControlMutex, and KisPlaybackEngineMLT::FrameWaitingInterface::renderingWaitCondition.

~StopAndResume()

KisPlaybackEngineMLT::StopAndResume::~StopAndResume ( )

inline

Make sure that all producer properties are initialized before the consumers start pulling stuff from the producer. Otherwise we can get a race condition with the consumer's read-ahead thread.

Definition at line 314 of file KisPlaybackEngineMLT.cpp.

                     {
        KIS_ASSERT(m_d);
        if (!m_d->pushConsumer || !m_d->pullConsumer) {
            m_d->initializeConsumers();
        }
 
        if (m_d->activeCanvas()) {
            KisCanvasAnimationState* animationState = m_d->activeCanvas()->animationState();
            KIS_SAFE_ASSERT_RECOVER_RETURN(animationState);
 
            {
                QMutexLocker l(&m_d->frameWaitingInterface.renderingControlMutex);
                m_d->frameWaitingInterface.renderingAllowed = true;
                m_d->frameWaitingInterface.waitingForFrame = false;
 
                m_d->frameWaitingInterface.renderingWaitCondition.wakeAll();
            }
 
            m_d->frameStats.reset();
 
            {
                KisImageAnimationInterface* animInterface = m_d->activeCanvas()->image()->animationInterface();
                m_d->activeProducer()->set("start_frame", animInterface->activePlaybackRange().start());
                m_d->activeProducer()->set("end_frame", animInterface->activePlaybackRange().end());
                m_d->activeProducer()->set("speed", m_d->playbackSpeed);
                const int shouldLimit = m_d->activePlaybackMode() == PLAYBACK_PUSH ? 0 : 1;
                m_d->activeProducer()->set("limit_enabled", shouldLimit);
            }
 
            if (m_d->activePlaybackMode() == PLAYBACK_PUSH) {
                m_d->pushConsumer->set("volume", m_d->mute ? 0.0 : animationState->currentVolume());
                m_d->pushConsumer->start();
            } else {
                m_d->pullConsumer->connect_producer(*m_d->activeProducer());
                m_d->pullConsumer->set("volume", m_d->mute ? 0.0 : animationState->currentVolume());
                m_d->pullConsumer->set("real_time", m_d->dropFrames() ? 1 : 0);
                m_d->pullConsumer->start();
            }
        }
    }

References KisPlaybackEngineMLT::Private::activeCanvas(), KisPlaybackEngineMLT::Private::activePlaybackMode(), KisImageAnimationInterface::activePlaybackRange(), KisPlaybackEngineMLT::Private::activeProducer(), KisImage::animationInterface(), KisCanvas2::animationState(), KisCanvasAnimationState::currentVolume(), KisPlaybackEngineMLT::Private::dropFrames(), KisTimeSpan::end(), KisPlaybackEngineMLT::Private::frameStats, KisPlaybackEngineMLT::Private::frameWaitingInterface, KisCanvas2::image(), KisPlaybackEngineMLT::Private::initializeConsumers(), KIS_ASSERT, KIS_SAFE_ASSERT_RECOVER_RETURN, m_d, KisPlaybackEngineMLT::Private::mute, PLAYBACK_PUSH, KisPlaybackEngineMLT::Private::playbackSpeed, KisPlaybackEngineMLT::Private::pullConsumer, KisPlaybackEngineMLT::Private::pushConsumer, KisPlaybackEngineMLT::FrameWaitingInterface::renderingAllowed, KisPlaybackEngineMLT::FrameWaitingInterface::renderingControlMutex, KisPlaybackEngineMLT::FrameWaitingInterface::renderingWaitCondition, KisTimeSpan::start(), and KisPlaybackEngineMLT::FrameWaitingInterface::waitingForFrame.

Member Data Documentation

m_d

Private* KisPlaybackEngineMLT::StopAndResume::m_d

private

Definition at line 362 of file KisPlaybackEngineMLT.cpp.

---

The documentation for this struct was generated from the following file:

• libs/ui/KisPlaybackEngineMLT.cpp