#include <KisAnimationRenderingOptions.h>

Public Types
enum	RenderMode { RENDER_FRAMES_ONLY , RENDER_VIDEO_ONLY , RENDER_FRAMES_AND_VIDEO }

Public Member Functions
void	fromProperties (KisPropertiesConfigurationSP config)

	KisAnimationRenderingOptions ()

RenderMode	renderMode () const

QString	resolveAbsoluteDocumentFilePath (const QString &documentPath) const

QString	resolveAbsoluteFramesDirectory () const

QString	resolveAbsoluteFramesDirectory (const QString &documentPath) const

QString	resolveAbsoluteVideoFilePath () const

QString	resolveAbsoluteVideoFilePath (const QString &documentPath) const

KisPropertiesConfigurationSP	toProperties () const

Public Attributes
QString	basename

QString	customFFMpegOptions

QString	directory

QString	ffmpegPath

int	firstFrame = 0

KisPropertiesConfigurationSP	frameExportConfig

QString	frameMimeType

int	frameRate = 25

int	height = 0

bool	includeAudio = false

QString	lastDocumentPath

int	lastFrame = 0

QString	scaleFilter

int	sequenceStart = 0

bool	shouldDeleteSequence = false

bool	shouldEncodeVideo = false

QString	videoFileName

QString	videoMimeType

bool	wantsOnlyUniqueFrameSequence = false

int	width = 0

Detailed Description

Definition at line 15 of file KisAnimationRenderingOptions.h.

Member Enumeration Documentation

◆ RenderMode

enum KisAnimationRenderingOptions::RenderMode

Enumerator
RENDER_FRAMES_ONLY
RENDER_VIDEO_ONLY
RENDER_FRAMES_AND_VIDEO

Definition at line 53 of file KisAnimationRenderingOptions.h.

                    {
        RENDER_FRAMES_ONLY,
        RENDER_VIDEO_ONLY,
        RENDER_FRAMES_AND_VIDEO
    };

Constructor & Destructor Documentation

◆ KisAnimationRenderingOptions()

KisAnimationRenderingOptions::KisAnimationRenderingOptions ( )

Definition at line 14 of file KisAnimationRenderingOptions.cpp.

    : videoMimeType("video/mp4"),
      frameMimeType("image/png"),
      basename("frame"),
      directory("")
{
 
}

Member Function Documentation

◆ fromProperties()

void KisAnimationRenderingOptions::fromProperties ( KisPropertiesConfigurationSP config )

Definition at line 100 of file KisAnimationRenderingOptions.cpp.

{
    basename = config->getPropertyLazy("basename", basename);
    lastDocumentPath = config->getPropertyLazy("last_document_path", "");
    directory = config->getPropertyLazy("directory", directory);
    firstFrame = config->getPropertyLazy("first_frame", 0);
    lastFrame = config->getPropertyLazy("last_frame", 0);
    sequenceStart = config->getPropertyLazy("sequence_start", 0);
    videoMimeType = config->getPropertyLazy("video_mimetype", videoMimeType);
    frameMimeType = config->getPropertyLazy("frame_mimetype", frameMimeType);
 
    shouldEncodeVideo = config->getPropertyLazy("encode_video", false);
    shouldDeleteSequence = config->getPropertyLazy("delete_sequence", false);
    wantsOnlyUniqueFrameSequence = config->getPropertyLazy("only_unique_frames", false);
 
    ffmpegPath = config->getPropertyLazy("ffmpeg_path", "");
    frameRate = config->getPropertyLazy("framerate", 25);
    height = config->getPropertyLazy("height", 0);
    width = config->getPropertyLazy("width", 0);
    includeAudio = config->getPropertyLazy("include_audio", true);
    videoFileName = config->getPropertyLazy("filename", "");
    customFFMpegOptions = config->getPropertyLazy("custom_ffmpeg_options", "");
 
    frameExportConfig = new KisPropertiesConfiguration();
    frameExportConfig->setPrefixedProperties("frame_export/", frameExportConfig);
 
}

References basename, customFFMpegOptions, directory, ffmpegPath, firstFrame, frameExportConfig, frameMimeType, frameRate, height, includeAudio, lastDocumentPath, lastFrame, sequenceStart, shouldDeleteSequence, shouldEncodeVideo, videoFileName, videoMimeType, wantsOnlyUniqueFrameSequence, and width.

◆ renderMode()

KisAnimationRenderingOptions::RenderMode KisAnimationRenderingOptions::renderMode ( ) const

Definition at line 57 of file KisAnimationRenderingOptions.cpp.

{
    if (shouldDeleteSequence) {
        KIS_SAFE_ASSERT_RECOVER_NOOP(shouldEncodeVideo);
        return RENDER_VIDEO_ONLY;
    } else if (!shouldEncodeVideo) {
        KIS_SAFE_ASSERT_RECOVER_NOOP(!shouldDeleteSequence);
        return RENDER_FRAMES_ONLY;
    } else {
        return RENDER_FRAMES_AND_VIDEO;
    }
}

References KIS_SAFE_ASSERT_RECOVER_NOOP, RENDER_FRAMES_AND_VIDEO, RENDER_FRAMES_ONLY, RENDER_VIDEO_ONLY, shouldDeleteSequence, and shouldEncodeVideo.

◆ resolveAbsoluteDocumentFilePath()

QString KisAnimationRenderingOptions::resolveAbsoluteDocumentFilePath ( const QString & documentPath ) const

Definition at line 23 of file KisAnimationRenderingOptions.cpp.

{
    return
        !documentPath.isEmpty() ?
        documentPath :
        QStandardPaths::writableLocation(QStandardPaths::PicturesLocation);
}

◆ resolveAbsoluteFramesDirectory() [1/2]

QString KisAnimationRenderingOptions::resolveAbsoluteFramesDirectory ( ) const

Definition at line 52 of file KisAnimationRenderingOptions.cpp.

{
    return resolveAbsoluteFramesDirectory(lastDocumentPath);
}

References lastDocumentPath, and resolveAbsoluteFramesDirectory().

◆ resolveAbsoluteFramesDirectory() [2/2]

QString KisAnimationRenderingOptions::resolveAbsoluteFramesDirectory ( const QString & documentPath ) const

Definition at line 37 of file KisAnimationRenderingOptions.cpp.

{
    if (renderMode() == RENDER_VIDEO_ONLY) {
        return QFileInfo(resolveAbsoluteVideoFilePath()).absolutePath();
    }
 
    const QString basePath = resolveAbsoluteDocumentFilePath(documentPath);
    return KritaUtils::resolveAbsoluteFilePath(basePath, directory);
}

References directory, RENDER_VIDEO_ONLY, renderMode(), resolveAbsoluteDocumentFilePath(), KritaUtils::resolveAbsoluteFilePath(), and resolveAbsoluteVideoFilePath().

◆ resolveAbsoluteVideoFilePath() [1/2]

QString KisAnimationRenderingOptions::resolveAbsoluteVideoFilePath ( ) const

Definition at line 47 of file KisAnimationRenderingOptions.cpp.

{
    return resolveAbsoluteVideoFilePath(lastDocumentPath);
}

References lastDocumentPath, and resolveAbsoluteVideoFilePath().

◆ resolveAbsoluteVideoFilePath() [2/2]

QString KisAnimationRenderingOptions::resolveAbsoluteVideoFilePath ( const QString & documentPath ) const

Definition at line 31 of file KisAnimationRenderingOptions.cpp.

{
    const QString basePath = resolveAbsoluteDocumentFilePath(documentPath);
    return KritaUtils::resolveAbsoluteFilePath(basePath, videoFileName);
}

References resolveAbsoluteDocumentFilePath(), KritaUtils::resolveAbsoluteFilePath(), and videoFileName.

◆ toProperties()

KisPropertiesConfigurationSP KisAnimationRenderingOptions::toProperties ( ) const

Definition at line 70 of file KisAnimationRenderingOptions.cpp.

{
    KisPropertiesConfigurationSP config = new KisPropertiesConfiguration();
 
    config->setProperty("basename", basename);
    config->setProperty("last_document_path", lastDocumentPath);
    config->setProperty("directory", directory);
    config->setProperty("first_frame", firstFrame);
    config->setProperty("last_frame", lastFrame);
    config->setProperty("sequence_start", sequenceStart);
    config->setProperty("video_mimetype", videoMimeType);
    config->setProperty("frame_mimetype", frameMimeType);
 
    config->setProperty("encode_video", shouldEncodeVideo);
    config->setProperty("delete_sequence", shouldDeleteSequence);
    config->setProperty("only_unique_frames", wantsOnlyUniqueFrameSequence);
 
    config->setProperty("ffmpeg_path", ffmpegPath);
    config->setProperty("framerate", frameRate);
    config->setProperty("height", height);
    config->setProperty("width", width);
    config->setProperty("include_audio", includeAudio);
    config->setProperty("filename", videoFileName);
    config->setProperty("custom_ffmpeg_options", customFFMpegOptions);
 
    config->setPrefixedProperties("frame_export/", frameExportConfig);
 
    return config;
}