Public Member Functions
bool	canRecord ()

QString	getPrefix ()

void	loadRelevantExportSettings ()

void	loadSettings ()

	Private (const RecorderExportSettings &es, RecorderDockerDock *q_ptr)

void	showWarning (const QString &hint)

void	updateComboResolution (quint32 width, quint32 height)

void	updateRecIndicator ()

void	updateRecordStatus (bool isRecording)

void	updateThreadUi ()

void	updateUiFormat ()

void	updateUiForRealTimeMode ()

void	updateWriterSettings ()

Public Attributes
QPointer< KisCanvas2 >	canvas

double	captureInterval = 0.

int	compression = 0

QMap< QString, bool >	enabledIds

QAction *	exportAction = nullptr

RecorderFormat	format = RecorderFormat::JPEG

QString	outputDirectory

bool	paused = true

QTimer	pausedTimer

QString	prefix

RecorderDockerDock *const	q

int	quality = 0

bool	realTimeCaptureMode = false

bool	recordAutomatically = false

bool	recordIsolateLayerMode = false

QAction *	recordToggleAction = nullptr

int	resolution = 0

QString	snapshotDirectory

QLabel *	statusBarLabel

QLabel *	statusBarWarningLabel

QPalette	threadsSliderPalette

QPalette	threadsSpinPalette

QScopedPointer< Ui::RecorderDocker >	ui

QTimer	warningTimer

RecorderWriterManager	writer

Detailed Description

Definition at line 65 of file recorderdocker_dock.cpp.

Constructor & Destructor Documentation

◆ Private()

RecorderDockerDock::Private::Private	(	const RecorderExportSettings &	es,
		RecorderDockerDock *	q_ptr )

inline

Definition at line 101 of file recorderdocker_dock.cpp.

        : q(q_ptr)
        , ui(new Ui::RecorderDocker())
        , writer(es)
        , statusBarLabel(new QLabel())
        , statusBarWarningLabel(new QLabel())
    {
        updateRecIndicator();
        statusBarWarningLabel->setPixmap(KisIconUtils::loadIcon("warning").pixmap(16, 16));
        statusBarWarningLabel->hide();
        warningTimer.setInterval(10000);
        warningTimer.setSingleShot(true);
        pausedTimer.setSingleShot(true);
        connect(&warningTimer, SIGNAL(timeout()), q, SLOT(onWarningTimeout()));
        connect(&pausedTimer, SIGNAL(timeout()), q, SLOT(onPausedTimeout()));
    }

References KisIconUtils::loadIcon(), RecorderDockerDock::onPausedTimeout(), RecorderDockerDock::onWarningTimeout(), pausedTimer, q, statusBarWarningLabel, updateRecIndicator(), and warningTimer.

Member Function Documentation

◆ canRecord()

bool RecorderDockerDock::Private::canRecord ( )

inline

Definition at line 120 of file recorderdocker_dock.cpp.

    {
        QSize imageSize = canvas->image()->size();
 
        // We always convert to RGBA8, so can assume 4 bytes/pixel
        quint64 totalSize = (quint64)imageSize.width() * (quint64)imageSize.height() * 4;
 
        return totalSize <= 2147483647;
    }

References canvas.

◆ getPrefix()

QString RecorderDockerDock::Private::getPrefix ( )

inline

Definition at line 250 of file recorderdocker_dock.cpp.

    {
        return !canvas ? ""
               : canvas->imageView()->document()->documentInfo()->aboutInfo("creation-date").remove(QRegularExpression("[^0-9]"));
    }

References canvas.

◆ loadRelevantExportSettings()

void RecorderDockerDock::Private::loadRelevantExportSettings ( )

inline

Definition at line 154 of file recorderdocker_dock.cpp.

    {
        RecorderExportConfig config(true);
        q->exportSettings->fps = config.fps();
    }

References RecorderDockerDock::exportSettings, RecorderExportConfig::fps(), RecorderExportSettings::fps, and q.

◆ loadSettings()

void RecorderDockerDock::Private::loadSettings ( )

inline

Definition at line 130 of file recorderdocker_dock.cpp.

    {
        RecorderConfig config(true);
        snapshotDirectory = config.snapshotDirectory();
#ifdef Q_OS_ANDROID
        fixInternalSnapshotDirectory();
#endif
        captureInterval = config.captureInterval();
        format = config.format();
        quality = config.quality();
        compression = config.compression();
        resolution = config.resolution();
        writer.recorderThreads.set(config.threads());
        realTimeCaptureMode = config.realTimeCaptureMode();
        if (realTimeCaptureMode) {
            q->exportSettings->lockFps = true;
            q->exportSettings->realTimeCaptureModeWasSet = true;
        }
        recordIsolateLayerMode = config.recordIsolateLayerMode();
        recordAutomatically = config.recordAutomatically();
 
        updateUiFormat();
    }

References RecorderConfig::captureInterval(), captureInterval, RecorderConfig::compression(), compression, RecorderDockerDock::exportSettings, RecorderConfig::format(), format, RecorderExportSettings::lockFps, q, RecorderConfig::quality(), quality, RecorderConfig::realTimeCaptureMode(), realTimeCaptureMode, RecorderExportSettings::realTimeCaptureModeWasSet, RecorderConfig::recordAutomatically(), recordAutomatically, RecorderWriterManager::recorderThreads, RecorderConfig::recordIsolateLayerMode(), recordIsolateLayerMode, RecorderConfig::resolution(), resolution, ThreadCounter::set(), RecorderConfig::snapshotDirectory(), snapshotDirectory, RecorderConfig::threads(), updateUiFormat(), and writer.

◆ showWarning()

void RecorderDockerDock::Private::showWarning ( const QString & hint )

inline

Definition at line 347 of file recorderdocker_dock.cpp.

                                          {
        if (statusBarWarningLabel->isHidden()) {
            statusBarWarningLabel->setToolTip(hint);
            statusBarWarningLabel->show();
            warningTimer.start();
        }
    }

References statusBarWarningLabel, and warningTimer.

◆ updateComboResolution()

void RecorderDockerDock::Private::updateComboResolution	(	quint32	width,
		quint32	height )

inline

Definition at line 256 of file recorderdocker_dock.cpp.

    {
        const QStringList titles = {
            i18nc("Use original resolution for the frames when recording the canvas", "Original"),
            i18nc("Use the resolution two times smaller than the original resolution for the frames when recording the canvas", "Half"),
            i18nc("Use the resolution four times smaller than the original resolution for the frames when recording the canvas", "Quarter")
        };
 
        QStringList items;
        for (int index = 0, len = titles.length(); index < len; ++index) {
            int divider = 1 << index;
            items += QString("%1 (%2x%3)").arg(titles[index])
                    .arg((width / divider) & ~1)
                    .arg((height / divider) & ~1);
        }
        QSignalBlocker blocker(ui->comboResolution);
        const int currentIndex = ui->comboResolution->currentIndex();
        ui->comboResolution->clear();
        ui->comboResolution->addItems(items);
        ui->comboResolution->setCurrentIndex(currentIndex);
    }

References ui.

◆ updateRecIndicator()

void RecorderDockerDock::Private::updateRecIndicator ( )

inline

Definition at line 314 of file recorderdocker_dock.cpp.

    {
        auto threads = writer.recorderThreads.get();
        auto threadsInUse = writer.recorderThreads.getUsed();
        QString label("<font style='letter-spacing:-4px'>");
        QString activeColor;
        QString inactiveColor;
        for (unsigned int threadNr = 1; threadNr <= ThreadSystemValue::MaxThreadCount ; threadNr++)
        {
            if (threadNr > threads) {
                activeColor = inactiveColorGray;
                inactiveColor = inactiveColorGray;
            } else if (threadNr > ThreadSystemValue::MaxRecordThreadCount) {
                activeColor = activeColorRed;
                inactiveColor = inactiveColorRed;
            } else if (threadNr > ThreadSystemValue::IdealRecordThreadCount) {
                activeColor = activeColorOrange;
                inactiveColor = inactiveColorOrange;
            } else {
                activeColor = activeColorGreen;
                inactiveColor = inactiveColorGreen;
            }
            label.append(QString("<font%1>▍</font>")
                             .arg(threadNr <= threadsInUse ? activeColor : inactiveColor));
        }
        // don't remove empty <font></font> tag else label will jump a few pixels around
        label.append(QString("</font><font> %1 </font><font%2>●</font>")
                         .arg(i18nc("Recording symbol", "REC"))
                         .arg(paused ? "" : activeColorRed));
        statusBarLabel->setText(label);
        statusBarLabel->setToolTip(paused ? i18n("Recorder is paused") : QString(i18n("Active recording with %1 of %2 available threads")).arg(threadsInUse).arg(threads));
    }

References ThreadCounter::get(), ThreadCounter::getUsed(), ThreadSystemValue::IdealRecordThreadCount, ThreadSystemValue::MaxRecordThreadCount, ThreadSystemValue::MaxThreadCount, paused, RecorderWriterManager::recorderThreads, statusBarLabel, and writer.

◆ updateRecordStatus()

void RecorderDockerDock::Private::updateRecordStatus ( bool isRecording )

inline

Definition at line 278 of file recorderdocker_dock.cpp.

    {
        recordToggleAction->setChecked(isRecording);
        recordToggleAction->setEnabled(true);
 
        QSignalBlocker blocker(ui->buttonRecordToggle);
        ui->buttonRecordToggle->setChecked(isRecording);
        ui->buttonRecordToggle->setIcon(KisIconUtils::loadIcon(isRecording ? "media-playback-stop" : "media-record"));
        ui->buttonRecordToggle->setText(isRecording ? i18nc("Stop recording the canvas", "Stop")
                                        : i18nc("Start recording the canvas", "Record"));
 
        if (canRecord()) {
            ui->buttonRecordToggle->setEnabled(true);
            ui->buttonRecordToggle->setToolTip("");
        } else {
            ui->buttonRecordToggle->setEnabled(false);
            ui->buttonRecordToggle->setToolTip(i18n("Image too large to be recorded"));
        }
        ui->widgetSettings->setEnabled(!isRecording);
 
        statusBarLabel->setVisible(isRecording);
 
        if (!canvas)
            return;
 
        KisStatusBar *statusBar = canvas->viewManager()->statusBar();
        if (isRecording) {
            statusBar->addExtraWidget(statusBarWarningLabel);
            statusBar->addExtraWidget(statusBarLabel);
            updateRecIndicator();
        } else {
            statusBar->removeExtraWidget(statusBarWarningLabel);
            statusBar->removeExtraWidget(statusBarLabel);
        }
    }

References KisStatusBar::addExtraWidget(), canRecord(), canvas, KisIconUtils::loadIcon(), recordToggleAction, KisStatusBar::removeExtraWidget(), statusBarLabel, statusBarWarningLabel, ui, and updateRecIndicator().

◆ updateThreadUi()

void RecorderDockerDock::Private::updateThreadUi ( )

inline

Definition at line 355 of file recorderdocker_dock.cpp.

    {
        QString toolTipText;
        auto threads = writer.recorderThreads.get();
        if (threads > ThreadSystemValue::MaxRecordThreadCount) {
            // Number of threads exceeds ideal thread count
            // -> switch color of threads slider and spin wheel to red
            QPalette pal;
            pal.setColor(QPalette::Text, textColorRed);
            pal.setColor(QPalette::Button, buttonColorRed);
            ui->spinThreads->setPalette(pal);
            ui->sliderThreads->setPalette(pal);
            toolTipText = QString(
                i18n("Set the number of recording threads.\nThe number of threads exceeds the ideal max number of your hardware setup.\nPlease be aware, that a number greater than %1 probably won't give you any performance boost.")
                    .arg(ThreadSystemValue::MaxRecordThreadCount));
        } else if (threads > ThreadSystemValue::IdealRecordThreadCount) {
            // Number of threads exceeds ideal recorder thread count
            // -> switch color of threads slider and spin wheel to orange
            QPalette pal;
            pal.setColor(QPalette::Text, textColorOrange);
            pal.setColor(QPalette::Button, buttonColorOrange);
            ui->spinThreads->setPalette(pal);
            ui->sliderThreads->setPalette(pal);
            toolTipText = QString(
                i18n("Set the number of recording threads.\nAccording to your hardware setup you should record with no more than %1 threads.\nYou can play around with one or two more threads, but keep an eye on your overall system performance.")
                    .arg(ThreadSystemValue::IdealRecordThreadCount));
        } else {
            ui->spinThreads->setPalette(threadsSpinPalette);
            ui->sliderThreads->setPalette(threadsSliderPalette);
            toolTipText = i18n("Set the number of threads to be used for recording.");
        }
        ui->spinThreads->setToolTip(toolTipText);
        ui->sliderThreads->setToolTip(toolTipText);
    }

References ThreadCounter::get(), ThreadSystemValue::IdealRecordThreadCount, ThreadSystemValue::MaxRecordThreadCount, RecorderWriterManager::recorderThreads, threadsSliderPalette, threadsSpinPalette, ui, and writer.

◆ updateUiFormat()

void RecorderDockerDock::Private::updateUiFormat ( )

inline

Definition at line 160 of file recorderdocker_dock.cpp.

                          {
        int index = 0;
        QString title;
        QString hint;
        int minValue = 0;
        int maxValue = 0;
        QString suffix;
        int factor = 0;
        switch (format) {
            case RecorderFormat::JPEG:
                index = 0;
                title = i18nc("Title for label. JPEG Quality level", "Quality:");
                hint = i18nc("@tooltip", "Greater value will produce a larger file and a better quality. Doesn't affect CPU consumption.\nValues lower than 50 are not recommended due to high artifacts.");
                minValue = 1;
                maxValue = 100;
                suffix = "%";
                factor = quality;
                break;
            case RecorderFormat::PNG:
                index = 1;
                title = i18nc("Title for label. PNG Compression level", "Compression:");
                hint = i18nc("@tooltip", "Greater value will produce a smaller file but will require more from your CPU. Doesn't affect quality.\nCompression set to 0 is not recommended due to high disk space consumption.\nValues above 3 are not recommended due to high performance impact.");
                minValue = 0;
                maxValue = 5;
                suffix = "";
                factor = compression;
                break;
        }
 
        ui->comboFormat->setCurrentIndex(index);
        ui->labelQuality->setText(title);
        ui->spinQuality->setToolTip(hint);
        QSignalBlocker blocker(ui->spinQuality);
        ui->spinQuality->setMinimum(minValue);
        ui->spinQuality->setMaximum(maxValue);
        ui->spinQuality->setValue(factor);
        ui->spinQuality->setSuffix(suffix);
    }

References compression, format, JPEG, PNG, quality, and ui.

◆ updateUiForRealTimeMode()

void RecorderDockerDock::Private::updateUiForRealTimeMode ( )

inline

Definition at line 199 of file recorderdocker_dock.cpp.

                                   {
        QString title;
        double minValue = 0;
        double maxValue = 0;
        double value = 0;
        int decimals = 0;
        QString suffix;
        QSignalBlocker blocker(ui->spinRate);
 
        if (realTimeCaptureMode) {
                title = i18nc("Title for label. Video frames per second", "Video FPS:");
                minValue = 1;
                maxValue = 60;
                decimals = 0;
                value = q->exportSettings->fps;
                suffix = "";
                disconnect(ui->spinRate, SIGNAL(valueChanged(double)), q, SLOT(onCaptureIntervalChanged(double)));
                connect(ui->spinRate, SIGNAL(valueChanged(double)), q, SLOT(onVideoFPSChanged(double)));
        } else {
                title = i18nc("Title for label. Capture rate", "Capture interval:");
                minValue = 0.10;
                maxValue = 100.0;
                decimals = 1;
                value = captureInterval;
                suffix = " sec.";
                disconnect(ui->spinRate, SIGNAL(valueChanged(double)), q, SLOT(onVideoFPSChanged(double)));
                connect(ui->spinRate, SIGNAL(valueChanged(double)), q, SLOT(onCaptureIntervalChanged(double)));
        }
 
        ui->labelRate->setText(title);
        ui->spinRate->setDecimals(decimals);
        ui->spinRate->setMinimum(minValue);
        ui->spinRate->setMaximum(maxValue);
        ui->spinRate->setSuffix(suffix);
        ui->spinRate->setValue(value);
    }

References captureInterval, RecorderDockerDock::exportSettings, RecorderExportSettings::fps, RecorderDockerDock::onCaptureIntervalChanged(), RecorderDockerDock::onVideoFPSChanged(), q, realTimeCaptureMode, ui, and value().

◆ updateWriterSettings()

void RecorderDockerDock::Private::updateWriterSettings ( )

inline

Definition at line 236 of file recorderdocker_dock.cpp.

    {
        outputDirectory = snapshotDirectory % QDir::separator() % prefix % QDir::separator();
        writer.setup({
            outputDirectory,
            format,
            quality,
            compression,
            resolution,
            captureInterval,
            recordIsolateLayerMode,
            realTimeCaptureMode});
    }

References captureInterval, compression, format, outputDirectory, prefix, quality, realTimeCaptureMode, recordIsolateLayerMode, resolution, RecorderWriterManager::setup(), snapshotDirectory, and writer.

Member Data Documentation

◆ canvas

QPointer<KisCanvas2> RecorderDockerDock::Private::canvas

Definition at line 72 of file recorderdocker_dock.cpp.

◆ captureInterval

double RecorderDockerDock::Private::captureInterval = 0.

Definition at line 81 of file recorderdocker_dock.cpp.

◆ compression

int RecorderDockerDock::Private::compression = 0

Definition at line 84 of file recorderdocker_dock.cpp.

◆ enabledIds

QMap<QString, bool> RecorderDockerDock::Private::enabledIds

Definition at line 99 of file recorderdocker_dock.cpp.

◆ exportAction

QAction* RecorderDockerDock::Private::exportAction = nullptr

Definition at line 76 of file recorderdocker_dock.cpp.

◆ format

RecorderFormat RecorderDockerDock::Private::format = RecorderFormat::JPEG

Definition at line 82 of file recorderdocker_dock.cpp.

◆ outputDirectory

QString RecorderDockerDock::Private::outputDirectory

Definition at line 80 of file recorderdocker_dock.cpp.

◆ paused

bool RecorderDockerDock::Private::paused = true

Definition at line 89 of file recorderdocker_dock.cpp.

◆ pausedTimer

QTimer RecorderDockerDock::Private::pausedTimer

Definition at line 93 of file recorderdocker_dock.cpp.

◆ prefix

QString RecorderDockerDock::Private::prefix

Definition at line 79 of file recorderdocker_dock.cpp.

◆ q

RecorderDockerDock* const RecorderDockerDock::Private::q

Definition at line 68 of file recorderdocker_dock.cpp.

◆ quality

int RecorderDockerDock::Private::quality = 0

Definition at line 83 of file recorderdocker_dock.cpp.

◆ realTimeCaptureMode

bool RecorderDockerDock::Private::realTimeCaptureMode = false

Definition at line 86 of file recorderdocker_dock.cpp.

◆ recordAutomatically

bool RecorderDockerDock::Private::recordAutomatically = false

Definition at line 88 of file recorderdocker_dock.cpp.

◆ recordIsolateLayerMode

bool RecorderDockerDock::Private::recordIsolateLayerMode = false

Definition at line 87 of file recorderdocker_dock.cpp.

◆ recordToggleAction

QAction* RecorderDockerDock::Private::recordToggleAction = nullptr

Definition at line 75 of file recorderdocker_dock.cpp.

◆ resolution

int RecorderDockerDock::Private::resolution = 0

Definition at line 85 of file recorderdocker_dock.cpp.

◆ snapshotDirectory

QString RecorderDockerDock::Private::snapshotDirectory

Definition at line 78 of file recorderdocker_dock.cpp.

◆ statusBarLabel

QLabel* RecorderDockerDock::Private::statusBarLabel

Definition at line 96 of file recorderdocker_dock.cpp.

◆ statusBarWarningLabel

QLabel* RecorderDockerDock::Private::statusBarWarningLabel

Definition at line 97 of file recorderdocker_dock.cpp.

◆ threadsSliderPalette

QPalette RecorderDockerDock::Private::threadsSliderPalette

Definition at line 70 of file recorderdocker_dock.cpp.

◆ threadsSpinPalette

QPalette RecorderDockerDock::Private::threadsSpinPalette

Definition at line 71 of file recorderdocker_dock.cpp.

◆ ui

QScopedPointer<Ui::RecorderDocker> RecorderDockerDock::Private::ui

Definition at line 69 of file recorderdocker_dock.cpp.

◆ warningTimer

QTimer RecorderDockerDock::Private::warningTimer

Definition at line 94 of file recorderdocker_dock.cpp.

◆ writer

RecorderWriterManager RecorderDockerDock::Private::writer

Definition at line 73 of file recorderdocker_dock.cpp.

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

plugins/dockers/recorder/recorderdocker_dock.cpp

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Private()

Member Function Documentation

◆ canRecord()

◆ getPrefix()

◆ loadRelevantExportSettings()

◆ loadSettings()

◆ showWarning()

◆ updateComboResolution()

◆ updateRecIndicator()

◆ updateRecordStatus()

◆ updateThreadUi()

◆ updateUiFormat()

◆ updateUiForRealTimeMode()

◆ updateWriterSettings()

Member Data Documentation

◆ canvas

◆ captureInterval

◆ compression

◆ enabledIds

◆ exportAction

◆ format

◆ outputDirectory

◆ paused

◆ pausedTimer

◆ prefix

◆ q

◆ quality

◆ realTimeCaptureMode

◆ recordAutomatically

◆ recordIsolateLayerMode

◆ recordToggleAction

◆ resolution

◆ snapshotDirectory

◆ statusBarLabel

◆ statusBarWarningLabel

◆ threadsSliderPalette

◆ threadsSpinPalette

◆ ui

◆ warningTimer

◆ writer