KisAsyncAnimationFramesSaveDialog Class Reference

#include <KisAsyncAnimationFramesSaveDialog.h>

Inheritance diagram for KisAsyncAnimationFramesSaveDialog:

Classes
struct	Private

Public Member Functions
QList< int >	getUniqueFrames () const
	KisAsyncAnimationFramesSaveDialog (KisImageSP image, const KisTimeSpan &range, const QString &baseFilename, int startNumberingAt, bool onlyNeedsUniqueFrames, KisPropertiesConfigurationSP exportConfiguration)
Result	regenerateRange (KisViewManager *viewManager) override
	start generation of frames and (if not in batch mode) show the dialog
QStringList	savedFiles () const
QString	savedFilesMask () const
QString	savedFilesMaskWildcard () const
QStringList	savedUniqueFiles () const
	~KisAsyncAnimationFramesSaveDialog ()
Public Member Functions inherited from KisAsyncAnimationRenderDialogBase
bool	batchMode () const
	KisAsyncAnimationRenderDialogBase (const QString &actionTitle, KisImageSP image, int busyWait=200)
	construct and initialize the dialog
KisRegion	regionOfInterest () const
void	setBatchMode (bool value)
	setting batch mode to true will prevent any dialogs or message boxes from showing on screen. Please take it into account that using batch mode prevents some potentially dangerous recovery execution paths (e.g. delete the existing frames in the destination folder). In such case the rendering will be stopped with RenderFailed result.
void	setRegionOfInterest (const KisRegion &roi)
virtual	~KisAsyncAnimationRenderDialogBase ()

Protected Member Functions
QList< int >	calcDirtyFrames () const override
	returns a list of frames that should be regenerated by the dialog
KisAsyncAnimationRendererBase *	createRenderer (KisImageSP image) override
	create a renderer object linked to image
void	initializeRendererForFrame (KisAsyncAnimationRendererBase *renderer, KisImageSP image, int frame) override

Private Attributes
const QScopedPointer< Private >	m_d

Additional Inherited Members
Public Types inherited from KisAsyncAnimationRenderDialogBase
enum	Result { RenderComplete , RenderCancelled , RenderFailed , RenderTimedOut }

Detailed Description

Definition at line 14 of file KisAsyncAnimationFramesSaveDialog.h.

Constructor & Destructor Documentation

KisAsyncAnimationFramesSaveDialog()

KisAsyncAnimationFramesSaveDialog::KisAsyncAnimationFramesSaveDialog	(	KisImageSP	image,
		const KisTimeSpan &	range,
		const QString &	baseFilename,
		int	startNumberingAt,
		bool	onlyNeedsUniqueFrames,
		KisPropertiesConfigurationSP	exportConfiguration )

Definition at line 58 of file KisAsyncAnimationFramesSaveDialog.cpp.

    : KisAsyncAnimationRenderDialogBase(i18n("Saving frames..."), originalImage, 0),
      m_d(new Private(originalImage, range, baseFilename, qMax(startNumberingAt - range.start(), range.start() * -1), onlyNeedsUniqueFrames, exportConfiguration))
{
 
 
}

~KisAsyncAnimationFramesSaveDialog()

KisAsyncAnimationFramesSaveDialog::~KisAsyncAnimationFramesSaveDialog

(

)

Definition at line 71 of file KisAsyncAnimationFramesSaveDialog.cpp.

{
}

Member Function Documentation

calcDirtyFrames()

QList< int > KisAsyncAnimationFramesSaveDialog::calcDirtyFrames ( ) const

overrideprotectedvirtual

returns a list of frames that should be regenerated by the dialog

Called by the dialog in the very beginning of regenerateRange()

Implements KisAsyncAnimationRenderDialogBase.

Definition at line 175 of file KisAsyncAnimationFramesSaveDialog.cpp.

{
    QList<int> result;
    for (int frame = m_d->range.start(); frame <= m_d->range.end(); frame++) {
        KisTimeSpan heldFrameTimeRange = KisTimeSpan::calculateIdenticalFramesRecursive(m_d->originalImage->root(), frame);
 
        if (!m_d->onlyNeedsUniqueFrames) {
            // Clamp holds that begin before the rendered range onto it
            heldFrameTimeRange &= m_d->range;
        }
 
        KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(heldFrameTimeRange.isValid(), result);
 
        result.append(heldFrameTimeRange.start());
 
        if (heldFrameTimeRange.isInfinite()) {
            break;
        } else {
            frame = heldFrameTimeRange.end();
        }
    }
    return result;
}

References KisTimeSpan::calculateIdenticalFramesRecursive(), KisTimeSpan::end(), KisTimeSpan::isInfinite(), KisTimeSpan::isValid(), KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, m_d, and KisTimeSpan::start().

createRenderer()

KisAsyncAnimationRendererBase * KisAsyncAnimationFramesSaveDialog::createRenderer ( KisImageSP image )

overrideprotectedvirtual

create a renderer object linked to image

Renderer are special objects that connect to the individual image signals, react on them and fetch the final frames data

See also

KisAsyncAnimationRendererBase

Implements KisAsyncAnimationRenderDialogBase.

Definition at line 199 of file KisAsyncAnimationFramesSaveDialog.cpp.

{
    return new KisAsyncAnimationFramesSavingRenderer(image,
                                                     m_d->filenamePrefix,
                                                     m_d->filenameSuffix,
                                                     m_d->outputMimeType,
                                                     m_d->range,
                                                     m_d->sequenceNumberingOffset,
                                                     m_d->onlyNeedsUniqueFrames,
                                                     m_d->exportConfiguration);
}

References m_d.

getUniqueFrames()

QList< int > KisAsyncAnimationFramesSaveDialog::getUniqueFrames

(

)

const

Definition at line 258 of file KisAsyncAnimationFramesSaveDialog.cpp.

{
    return this->calcDirtyFrames();
}

References calcDirtyFrames().

initializeRendererForFrame()

void KisAsyncAnimationFramesSaveDialog::initializeRendererForFrame ( KisAsyncAnimationRendererBase * renderer, KisImageSP image, int frame )

overrideprotectedvirtual

Implements KisAsyncAnimationRenderDialogBase.

Definition at line 211 of file KisAsyncAnimationFramesSaveDialog.cpp.

{
    Q_UNUSED(renderer);
    Q_UNUSED(image);
    Q_UNUSED(frame);
}

regenerateRange()

KisAsyncAnimationRenderDialogBase::Result KisAsyncAnimationFramesSaveDialog::regenerateRange ( KisViewManager * viewManager )

overridevirtual

start generation of frames and (if not in batch mode) show the dialog

The link to view manager is used to barrier lock with visual feedback in the end of the operation

Since this method can be called from the places where no view manager is available, we need this manually crafted ugly construction to "try-lock-cancel" the image.

Reimplemented from KisAsyncAnimationRenderDialogBase.

Definition at line 75 of file KisAsyncAnimationFramesSaveDialog.cpp.

{
    QString dirPath;
    QString fileWildcard;
#ifdef Q_OS_ANDROID
    // QFileInfo can't manage to manipulate content URIs on Android, most
    // functions either just hand you the entire input or an empty string, so
    // we have to do the name mangling by hand.
    {
        QString wildcardPath = savedFilesMaskWildcard();
        int lastSlashIndex = wildcardPath.lastIndexOf(QChar('/'));
        KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(lastSlashIndex != -1, RenderFailed);
        dirPath = wildcardPath.mid(0, lastSlashIndex);
        fileWildcard = wildcardPath.mid(lastSlashIndex + 1);
    }
#else
    {
        QFileInfo fileInfo(savedFilesMaskWildcard());
        dirPath = fileInfo.absolutePath();
        fileWildcard = fileInfo.fileName();
    }
#endif
    QDir dir(dirPath);
 
    // On Android, directory existence checks are unreliable and creating
    // directories is not allowed. We'll just have to take what we're given and
    // hope that works out for us.
#ifndef Q_OS_ANDROID
    if (!dir.exists()) {
        dir.mkpath(dirPath);
    }
    KIS_SAFE_ASSERT_RECOVER_NOOP(dir.exists());
#endif
 
    // Check for overwrite. (Batch mode always overwrites.)
    QStringList preexistingFileNames = dir.entryList({ fileWildcard });
    if (!preexistingFileNames.isEmpty() && !batchMode()) {
        QStringList truncatedList = preexistingFileNames;
 
        while (truncatedList.size() > 3) {
            truncatedList.takeLast();
        }
 
        QString exampleFiles = truncatedList.join(", ");
        if (truncatedList.size() != preexistingFileNames.size()) {
            exampleFiles += QString(", ...");
        }
 
        QMessageBox::StandardButton result =
                QMessageBox::warning(qApp->activeWindow(),
                                     i18n("Delete old frames?"),
                                     i18n("Frames with the same naming "
                                          "scheme exist in the destination "
                                          "directory. They are going to be "
                                          "deleted, continue?\n\n"
                                          "Directory: %1\n"
                                          "Files: %2",
                                          dirPath, exampleFiles),
                                     QMessageBox::Yes | QMessageBox::No,
                                     QMessageBox::No);
 
        if (result == QMessageBox::No) {
            return RenderCancelled;
        }
    }
 
    // Remove any preexisting files.
    Q_FOREACH (const QString &file, preexistingFileNames) {
        if (!dir.remove(file)) {
            if (!batchMode()) {
                QMessageBox::critical(qApp->activeWindow(),
                                      i18n("Failed to delete"),
                                      i18n("Failed to delete an old frame file:\n\n"
                                           "%1\n\n"
                                           "Rendering cancelled.", dir.absoluteFilePath(file)));
            }
 
            qWarning() << "WARNING: KisAsyncAnimFramesSaveDialog: Failed to delete old frame file(s):" << dir.absoluteFilePath(file);
            return RenderFailed;
        }
    }
 
    // Save new frame files.
    KisAsyncAnimationRenderDialogBase::Result renderingResult = KisAsyncAnimationRenderDialogBase::regenerateRange(viewManager);
 
    // If we cancel rendering or fail rendering process,
    // lets clean up any files that may have been created
    // to keep the next render from having artifacts.
    preexistingFileNames = savedFiles();
    if (renderingResult != RenderComplete) {
        Q_FOREACH (const QString &file, preexistingFileNames) {
            if (dir.exists(file)) {
                (void)dir.remove(file);
            }
        }
    }
 
    return renderingResult;
}

References KisAsyncAnimationRenderDialogBase::batchMode(), KIS_SAFE_ASSERT_RECOVER_NOOP, KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, KisAsyncAnimationRenderDialogBase::regenerateRange(), KisAsyncAnimationRenderDialogBase::RenderCancelled, KisAsyncAnimationRenderDialogBase::RenderComplete, KisAsyncAnimationRenderDialogBase::RenderFailed, savedFiles(), savedFilesMaskWildcard(), and void().

savedFiles()

QStringList KisAsyncAnimationFramesSaveDialog::savedFiles

(

)

const

Definition at line 228 of file KisAsyncAnimationFramesSaveDialog.cpp.

{
    QStringList files;
 
    for (int i = m_d->range.start(); i <= m_d->range.end(); i++) {
        const int num = m_d->sequenceNumberingOffset + i;
        QString name = QString("%1").arg(num, 4, 10, QChar('0'));
        name = m_d->filenamePrefix + name + m_d->filenameSuffix;
        files.append(QFileInfo(name).fileName());
    }
 
    return files;
}

References m_d.

savedFilesMask()

QString KisAsyncAnimationFramesSaveDialog::savedFilesMask

(

)

const

Definition at line 218 of file KisAsyncAnimationFramesSaveDialog.cpp.

{
    return m_d->filenamePrefix + "%04d" + m_d->filenameSuffix;
}

References m_d.

savedFilesMaskWildcard()

QString KisAsyncAnimationFramesSaveDialog::savedFilesMaskWildcard

(

)

const

Definition at line 223 of file KisAsyncAnimationFramesSaveDialog.cpp.

{
    return m_d->filenamePrefix + "????" + m_d->filenameSuffix;
}

References m_d.

savedUniqueFiles()

QStringList KisAsyncAnimationFramesSaveDialog::savedUniqueFiles

(

)

const

Definition at line 242 of file KisAsyncAnimationFramesSaveDialog.cpp.

{
    QStringList files;
 
    const QList<int> frames = calcDirtyFrames();
 
    Q_FOREACH (int frame, frames) {
        const int num = m_d->sequenceNumberingOffset + frame;
        QString name = QString("%1").arg(num, 4, 10, QChar('0'));
        name = m_d->filenamePrefix + name + m_d->filenameSuffix;
        files.append(QFileInfo(name).fileName());
    }
 
    return files;
}

References calcDirtyFrames(), and m_d.

Member Data Documentation

m_d

const QScopedPointer<Private> KisAsyncAnimationFramesSaveDialog::m_d

private

Definition at line 43 of file KisAsyncAnimationFramesSaveDialog.h.

---

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

• libs/ui/dialogs/KisAsyncAnimationFramesSaveDialog.h
• libs/ui/dialogs/KisAsyncAnimationFramesSaveDialog.cpp