Inheritance diagram for Digikam::FilterActionFilter:

Public Types
enum	State { Inactive , Scheduled , Running , Deactivating }

Public Slots
void	start ()

void	stop ()

void	wait ()

Signals
void	finished ()

void	finished (bool success)

void	progress (int progress)

void	started ()

void	starting ()

Public Member Functions
void	addFilterAction (const FilterAction &action)

void	addFilterActions (const QList< FilterAction > &actions)

QList< FilterAction >	appliedFilterActions () const

virtual void	cancelFilter ()

bool	completelyApplied () const

FilterAction	failedAction () const

int	failedActionIndex () const

QString	failedActionMessage () const

FilterAction	filterAction () override

	FilterActionFilter (QObject *const parent=nullptr)

QList< FilterAction >	filterActions () const

QString	filterIdentifier () const override

const QString &	filterName ()

int	filterVersion () const

DImg	getTargetImage ()

bool	isComplexAction () const

bool	isFinished () const

bool	isReproducible () const

bool	isRunning () const

bool	isSupported () const

QList< int >	multithreadedSteps (int stop, int start=0) const

virtual bool	parametersSuccessfullyRead () const

QThread::Priority	priority () const

void	readParameters (const FilterAction &) override

virtual QString	readParametersError (const FilterAction &actionThatFailed) const

void	setContinueOnError (bool cont)

void	setEmitSignals (bool emitThem)

void	setFilterAction (const FilterAction &action)

void	setFilterActions (const QList< FilterAction > &actions)

void	setFilterName (const QString &name)

void	setFilterVersion (int version)

void	setOriginalImage (const DImg &orgImage)

void	setPriority (QThread::Priority priority)

void	setupAndStartDirectly (const DImg &orgImage, DImgThreadedFilter *const master, int progressBegin=0, int progressEnd=100)

void	setupFilter (const DImg &orgImage)

virtual void	startFilter ()

virtual void	startFilterDirectly ()

State	state () const

virtual QList< int >	supportedVersions () const

	~FilterActionFilter () override

Protected Member Functions
virtual void	cleanupFilter ()

void	filterImage () override

virtual void	initFilter ()

void	initMaster ()

void	initSlave (DImgThreadedFilter *const master, int progressBegin=0, int progressEnd=100)

virtual int	modulateProgress (int progress)

void	postProgress (int progress)

virtual void	prepareDestImage ()

void	run () override

bool	runningFlag () const volatile

void	setSlave (DImgThreadedFilter *const slave)

void	shutDown ()

void	start (QMutexLocker &locker)

void	stop (QMutexLocker &locker)

QMutex *	threadMutex () const

void	wait (QMutexLocker &locker)

Protected Attributes
DImg	m_destImage

DImgThreadedFilter *	m_master

QString	m_name

DImg	m_orgImage

int	m_progressBegin

int	m_progressCurrent
	To prevent signals bombarding with progress indicator value in postProgress(). More...

int	m_progressSpan

DImgThreadedFilter *	m_slave

int	m_version

bool	m_wasCancelled

Member Enumeration Documentation

◆ State

enum Digikam::DynamicThread::State

inherited

Enumerator
Inactive
Scheduled
Running
Deactivating

Constructor & Destructor Documentation

◆ FilterActionFilter()

Digikam::FilterActionFilter::FilterActionFilter ( QObject *const parent = nullptr )

explicit

A meta-filter applying other filter according to a list of FilterActions

References Digikam::DImgThreadedFilter::initFilter().

◆ ~FilterActionFilter()

Digikam::FilterActionFilter::~FilterActionFilter ( )

override

Member Function Documentation

◆ addFilterAction()

void Digikam::FilterActionFilter::addFilterAction ( const FilterAction & action )

◆ addFilterActions()

void Digikam::FilterActionFilter::addFilterActions ( const QList< FilterAction > & actions )

◆ appliedFilterActions()

QList< FilterAction > Digikam::FilterActionFilter::appliedFilterActions ( ) const

Returns the list of applied filter actions. This is probably identical to filterActions, but it can differ in some situations:

if completelyApplied() is false, it will contain only the successful actions
the list is regenerated by the filters. If filterActions contains actions with an older version, still supported by the filter, the filter will now possibly return the newer, current version

◆ cancelFilter()

void Digikam::DImgThreadedFilter::cancelFilter ( )

virtualinherited

Cancel the threaded computation.

Reimplemented in Digikam::GreycstorationFilter.

References Digikam::DImgThreadedFilter::cleanupFilter(), Digikam::DynamicThread::isRunning(), Digikam::DImgThreadedFilter::m_slave, Digikam::DImgThreadedFilter::m_wasCancelled, Digikam::DynamicThread::stop(), and Digikam::DynamicThread::wait().

Referenced by DigikamBqmRestorationPlugin::RedEyeCorrection::cancel(), Digikam::GreycstorationFilter::cancelFilter(), Digikam::EditorToolThreaded::slotAbort(), Digikam::PreviewThreadWrapper::stopFilters(), Digikam::AntiVignettingFilter::~AntiVignettingFilter(), Digikam::AutoLevelsFilter::~AutoLevelsFilter(), Digikam::BCGFilter::~BCGFilter(), Digikam::BlurFilter::~BlurFilter(), Digikam::BlurFXFilter::~BlurFXFilter(), Digikam::BorderFilter::~BorderFilter(), Digikam::BWSepiaFilter::~BWSepiaFilter(), Digikam::CBFilter::~CBFilter(), Digikam::CharcoalFilter::~CharcoalFilter(), Digikam::ColorFXFilter::~ColorFXFilter(), Digikam::CurvesFilter::~CurvesFilter(), Digikam::DImgThreadedFilter::~DImgThreadedFilter(), Digikam::DistortionFXFilter::~DistortionFXFilter(), Digikam::EmbossFilter::~EmbossFilter(), Digikam::FilmFilter::~FilmFilter(), Digikam::FilmGrainFilter::~FilmGrainFilter(), Digikam::FreeRotationFilter::~FreeRotationFilter(), Digikam::HotPixelFixer::~HotPixelFixer(), Digikam::HSLFilter::~HSLFilter(), Digikam::IccTransformFilter::~IccTransformFilter(), Digikam::InfraredFilter::~InfraredFilter(), Digikam::InvertFilter::~InvertFilter(), Digikam::LensDistortionFilter::~LensDistortionFilter(), Digikam::LensFunFilter::~LensFunFilter(), Digikam::LevelsFilter::~LevelsFilter(), Digikam::LocalContrastFilter::~LocalContrastFilter(), Digikam::MixerFilter::~MixerFilter(), Digikam::NormalizeFilter::~NormalizeFilter(), Digikam::NRFilter::~NRFilter(), Digikam::OilPaintFilter::~OilPaintFilter(), Digikam::RainDropFilter::~RainDropFilter(), DigikamRawImportNativePlugin::RawPostProcessing::~RawPostProcessing(), Digikam::RawProcessingFilter::~RawProcessingFilter(), Digikam::RedEyeCorrectionFilter::~RedEyeCorrectionFilter(), Digikam::RefocusFilter::~RefocusFilter(), Digikam::SharpenFilter::~SharpenFilter(), Digikam::ShearFilter::~ShearFilter(), Digikam::StretchFilter::~StretchFilter(), Digikam::TextureFilter::~TextureFilter(), Digikam::TonalityFilter::~TonalityFilter(), Digikam::UnsharpMaskFilter::~UnsharpMaskFilter(), and Digikam::WBFilter::~WBFilter().

◆ cleanupFilter()

virtual void Digikam::DImgThreadedFilter::cleanupFilter ( )

inlineprotectedvirtualinherited

Clean up filter data if necessary, called by stopComputation() method. Override in subclass.

Referenced by Digikam::DImgThreadedFilter::cancelFilter().

◆ completelyApplied()

bool Digikam::FilterActionFilter::completelyApplied ( ) const

After the thread was run, you can find out if application was successful. A precondition is that at least isComplexAction() and isSupported() returns true. If all filters applied cleanly, completelyApplied() returns true. appliedActions() returns all applied actions, if completelyApplied(), the same as filterActions(). If not completelyApplied, failedAction() returns the action that failed, failedActionIndex its index in filterActions(), and failedActionMessage an optional error message. Note that finished(true) does not mean that completelyApplied() is also true.

◆ failedAction()

FilterAction Digikam::FilterActionFilter::failedAction ( ) const

◆ failedActionIndex()

int Digikam::FilterActionFilter::failedActionIndex ( ) const

◆ failedActionMessage()

QString Digikam::FilterActionFilter::failedActionMessage ( ) const

◆ filterAction()

FilterAction Digikam::FilterActionFilter::filterAction ( )

inlineoverridevirtual

These methods do not make sense here. Use filterActions.

Implements Digikam::DImgThreadedFilter.

◆ filterActions()

QList< FilterAction > Digikam::FilterActionFilter::filterActions ( ) const

◆ filterIdentifier()

QString Digikam::FilterActionFilter::filterIdentifier ( ) const

inlineoverridevirtual

Return the identifier for this filter in the image history.

Implements Digikam::DImgThreadedFilter.

◆ filterImage()

void Digikam::FilterActionFilter::filterImage ( )

overrideprotectedvirtual

Main image filter method. Override in subclass.

Implements Digikam::DImgThreadedFilter.

References Digikam::DImgBuiltinFilter::apply(), Digikam::DImgBuiltinFilter::filterAction(), Digikam::FilterAction::identifier(), Digikam::DImgFilterManager::instance(), Digikam::FilterAction::isNull(), Digikam::DImgBuiltinFilter::isSupported(), Digikam::DImgBuiltinFilter::isValid(), Digikam::DImgThreadedFilter::m_destImage, Digikam::DImgThreadedFilter::m_orgImage, Digikam::DImgThreadedFilter::postProgress(), Digikam::DImgThreadedFilter::progress(), and Digikam::FilterAction::version().

◆ filterName()

const QString& Digikam::DImgThreadedFilter::filterName ( )

inlineinherited

◆ filterVersion()

int Digikam::DImgThreadedFilter::filterVersion ( ) const

inherited

References Digikam::DImgThreadedFilter::m_version.

◆ finished [1/2]

void Digikam::DynamicThread::finished ( )

signalinherited

Referenced by Digikam::ThumbnailImageCatcher::Private::harvest(), Digikam::DImgThreadedFilter::startFilter(), and Digikam::DImgThreadedFilter::startFilterDirectly().

◆ finished [2/2]

void Digikam::DImgThreadedFilter::finished ( bool success )

signalinherited

Emitted when the computation has completed.

Parameters

success True if computation finished without interruption on valid data False if the thread was canceled, or no data is available.

◆ getTargetImage()

DImg Digikam::DImgThreadedFilter::getTargetImage ( )

inlineinherited

Referenced by Digikam::BatchTool::applyFilter(), Digikam::BatchTool::applyFilterChangedProperties(), and DigikamEditorProfileConversionToolPlugin::ProfileConversionTool::fastConversion().

◆ initFilter()

void Digikam::DImgThreadedFilter::initFilter ( )

protectedvirtualinherited

Start filter operation before threaded method. Must be called by your constructor.

References Digikam::DImgThreadedFilter::m_master, Digikam::DImgThreadedFilter::prepareDestImage(), and Digikam::DImgThreadedFilter::startFilterDirectly().

Referenced by Digikam::AntiVignettingFilter::AntiVignettingFilter(), Digikam::AutoExpoFilter::AutoExpoFilter(), Digikam::AutoLevelsFilter::AutoLevelsFilter(), Digikam::BCGFilter::BCGFilter(), Digikam::BlurFilter::BlurFilter(), Digikam::BlurFXFilter::BlurFXFilter(), Digikam::BorderFilter::BorderFilter(), Digikam::BWSepiaFilter::BWSepiaFilter(), Digikam::CBFilter::CBFilter(), Digikam::CharcoalFilter::CharcoalFilter(), Digikam::ColorFXFilter::ColorFXFilter(), Digikam::ContentAwareFilter::ContentAwareFilter(), Digikam::CurvesFilter::CurvesFilter(), Digikam::DistortionFXFilter::DistortionFXFilter(), Digikam::EmbossFilter::EmbossFilter(), Digikam::EqualizeFilter::EqualizeFilter(), Digikam::FilmFilter::FilmFilter(), Digikam::FilmGrainFilter::FilmGrainFilter(), FilterActionFilter(), Digikam::FreeRotationFilter::FreeRotationFilter(), Digikam::HotPixelFixer::HotPixelFixer(), Digikam::HSLFilter::HSLFilter(), Digikam::IccTransformFilter::IccTransformFilter(), Digikam::InfraredFilter::InfraredFilter(), Digikam::InvertFilter::InvertFilter(), Digikam::LensDistortionFilter::LensDistortionFilter(), Digikam::LensFunFilter::LensFunFilter(), Digikam::LevelsFilter::LevelsFilter(), Digikam::LocalContrastFilter::LocalContrastFilter(), Digikam::MixerFilter::MixerFilter(), Digikam::NormalizeFilter::NormalizeFilter(), Digikam::NRFilter::NRFilter(), Digikam::OilPaintFilter::OilPaintFilter(), Digikam::RainDropFilter::RainDropFilter(), DigikamRawImportNativePlugin::RawPostProcessing::RawPostProcessing(), Digikam::RawProcessingFilter::RawProcessingFilter(), Digikam::RedEyeCorrectionFilter::RedEyeCorrectionFilter(), Digikam::RefocusFilter::RefocusFilter(), Digikam::DImgThreadedFilter::setupFilter(), Digikam::SharpenFilter::SharpenFilter(), Digikam::ShearFilter::ShearFilter(), Digikam::StretchFilter::StretchFilter(), Digikam::TextureFilter::TextureFilter(), Digikam::TonalityFilter::TonalityFilter(), Digikam::UnsharpMaskFilter::UnsharpMaskFilter(), and Digikam::WBFilter::WBFilter().

◆ initMaster()

void Digikam::DImgThreadedFilter::initMaster ( )

protectedinherited

References Digikam::DImgThreadedFilter::m_master, Digikam::DImgThreadedFilter::m_progressBegin, Digikam::DImgThreadedFilter::m_progressCurrent, Digikam::DImgThreadedFilter::m_progressSpan, and Digikam::DImgThreadedFilter::m_slave.

Referenced by Digikam::DImgThreadedFilter::DImgThreadedFilter().

◆ initSlave()

void Digikam::DImgThreadedFilter::initSlave	(	DImgThreadedFilter *const	master,
		int	progressBegin = `0`,
		int	progressEnd = `100`
	)

protectedinherited

Initialize the filter for use as a slave - reroutes progress info to master. Note: Computation will be started from setupFilter().

References Digikam::DImgThreadedFilter::m_master, Digikam::DImgThreadedFilter::m_progressBegin, Digikam::DImgThreadedFilter::m_progressCurrent, Digikam::DImgThreadedFilter::m_progressSpan, Digikam::DImgThreadedFilter::m_slave, and Digikam::DImgThreadedFilter::setSlave().

Referenced by Digikam::DImgThreadedFilter::DImgThreadedFilter(), Digikam::RawProcessingFilter::setObserver(), and Digikam::DImgThreadedFilter::setupAndStartDirectly().

◆ isComplexAction()

bool Digikam::FilterActionFilter::isComplexAction ( ) const

Returns true if all FilterActions are reproducible or are ComplexFilters. That means the identical result may not be reproducible, but a sufficiently similar result may be available and apply will probably complete.

References Digikam::FilterAction::category(), Digikam::FilterAction::ComplexFilter, Digikam::FilterAction::isNull(), and Digikam::FilterAction::ReproducibleFilter.

◆ isFinished()

bool Digikam::DynamicThread::isFinished ( ) const

inherited

References Digikam::DynamicThread::Inactive.

◆ isReproducible()

bool Digikam::FilterActionFilter::isReproducible ( ) const

Returns true if all FilterActions are reproducible

References Digikam::FilterAction::category(), Digikam::FilterAction::isNull(), and Digikam::FilterAction::ReproducibleFilter.

◆ isRunning()

bool Digikam::DynamicThread::isRunning ( ) const

inherited

References Digikam::DynamicThread::Deactivating, Digikam::DynamicThread::Running, and Digikam::DynamicThread::Scheduled.

Referenced by Digikam::DImgThreadedFilter::cancelFilter(), and Digikam::ImageHistogram::isCalculating().

◆ isSupported()

bool Digikam::FilterActionFilter::isSupported ( ) const

Returns true if all actions are supported.

References Digikam::FilterAction::identifier(), Digikam::DImgFilterManager::instance(), Digikam::FilterAction::isNull(), Digikam::DImgFilterManager::isSupported(), and Digikam::FilterAction::version().

◆ modulateProgress()

int Digikam::DImgThreadedFilter::modulateProgress ( int progress )

protectedvirtualinherited

This method modulates the progress value from the 0..100 span to the span of this slave. Called by postProgress if master is not null.

References Digikam::DImgThreadedFilter::m_progressBegin, Digikam::DImgThreadedFilter::m_progressSpan, and Digikam::DImgThreadedFilter::progress().

Referenced by Digikam::DImgThreadedFilter::postProgress(), and Digikam::RawProcessingFilter::postProgress().

◆ multithreadedSteps()

QList< int > Digikam::DImgThreadedFilter::multithreadedSteps	(	int	stop,
		int	start = `0`
	)		const

inherited

This method return a list of steps to process parallelized operation in filter using QtConcurrents API. Usually, start and stop are rows or columns from image to process. By default, whole image will be processed and start value is 0. In this case stop will be last row or column to process. Between range [start,stop], this method will divide by equal steps depending of number of CPU cores available. To be sure that all values will be processed, in case of CPU core division give rest, the last step compensate the difference. See Blur filter loop implementation for example to see how to use this method with QtConcurrents API.

References Digikam::DynamicThread::start(), and Digikam::DynamicThread::stop().

◆ parametersSuccessfullyRead()

bool Digikam::DImgThreadedFilter::parametersSuccessfullyRead ( ) const

virtualinherited

Optional: error handling for readParameters. When readParameters() has been called, this method will return true if the call was successful, and false if not. If returning false, readParametersError() will give an error message. The default implementation always returns success. You only need to reimplement when a filter is likely to fail in a different environment, e.g. depending on availability of installed files. These methods have an undefined return value if readParameters() was not called previously.

Reimplemented in Digikam::IccTransformFilter.

◆ postProgress()

void Digikam::DImgThreadedFilter::postProgress ( int progress )

protectedinherited

Emit progress info.

References Digikam::DImgThreadedFilter::m_master, Digikam::DImgThreadedFilter::m_progressCurrent, Digikam::DImgThreadedFilter::modulateProgress(), Digikam::DImgThreadedFilter::postProgress(), and Digikam::DImgThreadedFilter::progress().

Referenced by filterImage(), Digikam::DImgThreadedFilter::postProgress(), Digikam::RawProcessingFilter::postProgress(), Digikam::ContentAwareFilter::progressCallback(), Digikam::IccTransformFilter::progressInfo(), Digikam::NREstimate::startAnalyse(), and Digikam::AutoCrop::startAnalyse().

◆ prepareDestImage()

void Digikam::DImgThreadedFilter::prepareDestImage ( )

protectedvirtualinherited

References Digikam::DImg::hasAlpha(), Digikam::DImg::height, Digikam::DImg::isNull(), Digikam::DImgThreadedFilter::m_destImage, Digikam::DImgThreadedFilter::m_orgImage, Digikam::DImg::reset(), Digikam::DImg::sixteenBit, and Digikam::DImg::width.

Referenced by Digikam::DImgThreadedFilter::initFilter().

◆ priority()

QThread::Priority Digikam::DynamicThread::priority ( ) const

inherited

Referenced by Digikam::DynamicThread::setPriority().

◆ progress

void Digikam::DImgThreadedFilter::progress ( int progress )

signalinherited

Emitted when progress info from the calculation is available.

Referenced by filterImage(), Digikam::DImgThreadedFilter::modulateProgress(), Digikam::DImgThreadedFilter::postProgress(), Digikam::ContentAwareFilter::progressCallback(), and Digikam::IccTransformFilter::progressInfo().

◆ readParameters()

void Digikam::FilterActionFilter::readParameters ( const FilterAction & )

inlineoverridevirtual

Implements Digikam::DImgThreadedFilter.

◆ readParametersError()

QString Digikam::DImgThreadedFilter::readParametersError ( const FilterAction & actionThatFailed ) const

virtualinherited

Reimplemented in Digikam::IccTransformFilter.

◆ run()

void Digikam::DImgThreadedFilter::run ( )

overrideprotectedvirtualinherited

List of threaded operations by filter.

Implements Digikam::DynamicThread.

References Digikam::DImgThreadedFilter::startFilterDirectly().

◆ runningFlag()

bool Digikam::DynamicThread::runningFlag ( ) const volatile

protectedinherited

In you run() method, you shall regularly check for runningFlag() and cleanup and return if false.

Referenced by Digikam::ImageHistogram::calculate(), Digikam::RawProcessingFilter::continueQuery(), Digikam::LoadSaveThread::run(), Digikam::ScanStateFilter::run(), and Digikam::NREstimate::startAnalyse().

◆ setContinueOnError()

void Digikam::FilterActionFilter::setContinueOnError ( bool cont )

Per default, the filter will stop when it encounters an unsupported action. If you want it to continue, set this to true. Only the last occurred error will then be reported.

◆ setEmitSignals()

void Digikam::DynamicThread::setEmitSignals ( bool emitThem )

inherited

◆ setFilterAction()

void Digikam::FilterActionFilter::setFilterAction ( const FilterAction & action )

◆ setFilterActions()

void Digikam::FilterActionFilter::setFilterActions ( const QList< FilterAction > & actions )

Set - or add to existing list - the given filter actions

◆ setFilterName()

void Digikam::DImgThreadedFilter::setFilterName ( const QString & name )

inherited

References Digikam::DImgThreadedFilter::m_name.

Referenced by Digikam::DImgThreadedFilter::DImgThreadedFilter(), and DigikamRawImportNativePlugin::RawPostProcessing::RawPostProcessing().

◆ setFilterVersion()

void Digikam::DImgThreadedFilter::setFilterVersion ( int version )

inherited

Replaying a filter action: Set the filter version. A filter may implement different versions, to preserve image history when the algorithm is changed. Any value set here must be contained in supportedVersions, otherwise this call will be ignored. Default value is 1. (Note: If you intend to record a filter action, please look at FilterAction's m_version)

References Digikam::DImgThreadedFilter::m_version, and Digikam::DImgThreadedFilter::supportedVersions().

◆ setOriginalImage()

void Digikam::DImgThreadedFilter::setOriginalImage ( const DImg & orgImage )

inherited

References Digikam::DImgThreadedFilter::m_orgImage.

Referenced by Digikam::AutoCrop::AutoCrop(), Digikam::DImgThreadedFilter::DImgThreadedFilter(), Digikam::GreycstorationFilter::GreycstorationFilter(), Digikam::NREstimate::NREstimate(), DigikamRawImportNativePlugin::RawPostProcessing::RawPostProcessing(), and Digikam::DImgThreadedFilter::setupFilter().

◆ setPriority()

void Digikam::DynamicThread::setPriority ( QThread::Priority priority )

inherited

Sets the priority for this dynamic thread. Can be set anytime. If the thread is currently not running, the priority will be set when it is run next time. When you set QThread::InheritPriority (default), the priority is not changed but inherited from the thread pool.

References Digikam::DynamicThread::priority().

Referenced by Digikam::FacePipeline::Private::applyPriority(), and Digikam::FacePipeline::Private::createThumbnailLoadThread().

◆ setSlave()

void Digikam::DImgThreadedFilter::setSlave ( DImgThreadedFilter *const slave )

protectedinherited

Inform the master that there is currently a slave. At destruction of the slave, call with slave=0.

References Digikam::DImgThreadedFilter::m_slave.

Referenced by Digikam::DImgThreadedFilter::initSlave(), and Digikam::DImgThreadedFilter::~DImgThreadedFilter().

◆ setupAndStartDirectly()

void Digikam::DImgThreadedFilter::setupAndStartDirectly	(	const DImg &	orgImage,
		DImgThreadedFilter *const	master,
		int	progressBegin = `0`,
		int	progressEnd = `100`
	)

inherited

Initializes the filter for use as a slave and directly starts computation (in-thread)

References Digikam::DImgThreadedFilter::initSlave(), and Digikam::DImgThreadedFilter::setupFilter().

◆ setupFilter()

void Digikam::DImgThreadedFilter::setupFilter ( const DImg & orgImage )

inherited

You need to call this and then start filter of you used the constructor not setting an original image. The original image's data will not be copied.

References Digikam::DImgThreadedFilter::initFilter(), and Digikam::DImgThreadedFilter::setOriginalImage().

Referenced by DigikamRAWDImgPlugin::DImgRAWLoader::postProcess(), and Digikam::DImgThreadedFilter::setupAndStartDirectly().

◆ shutDown()

void Digikam::DynamicThread::shutDown ( )

protectedinherited

If you are deleting data in your destructor which is accessed from the thread, do one of the following from your destructor to guarantee a safe shutdown: 1) Call this method 2) Call stop() and wait(), knowing that nothing will call start() anymore after this 3) Be sure the thread will never be running at destruction. Note: This irrevocably stops this object. Note: It is not sufficient that your parent class does this. Calling this method, or providing one of the above mentioned equivalent guarantees, must be done by every single last class in the hierarchy with an implemented destructor deleting data. (the base class destructor is always called after the derived class)

References Digikam::DynamicThread::stop(), and Digikam::DynamicThread::wait().

Referenced by Digikam::ManagedLoadSaveThread::shutDown(), Digikam::DynamicThread::~DynamicThread(), and Digikam::LoadSaveThread::~LoadSaveThread().

◆ start [1/2]

void Digikam::DynamicThread::start ( )

slotinherited

Referenced by Digikam::ImageHistogram::calculateInThread(), Digikam::FacePreviewLoader::checkRestart(), Digikam::ImageHistogram::getCount(), Digikam::ImageHistogram::getMaximum(), Digikam::ImageHistogram::getMean(), Digikam::ImageHistogram::getMedian(), Digikam::ImageHistogram::getStdDev(), Digikam::LoadSaveThread::load(), Digikam::ManagedLoadSaveThread::load(), Digikam::ManagedLoadSaveThread::loadThumbnail(), Digikam::DImgThreadedFilter::multithreadedSteps(), Digikam::ManagedLoadSaveThread::preloadThumbnail(), Digikam::ManagedLoadSaveThread::preloadThumbnailGroup(), Digikam::ManagedLoadSaveThread::prependThumbnailGroup(), Digikam::ScanStateFilter::process(), Digikam::LoadSaveThread::save(), Digikam::ManagedLoadSaveThread::save(), and Digikam::DImgThreadedFilter::startFilter().

◆ start() [2/2]

void Digikam::DynamicThread::start ( QMutexLocker & locker )

protectedinherited

Doing the same as start(), stop() and wait above, provide it with a locked QMutexLocker on mutex(). Note the start() will unlock and relock for scheduling once, after state change.

References Digikam::ThreadManager::instance(), and Digikam::ThreadManager::schedule().

◆ started

void Digikam::DImgThreadedFilter::started ( )

signalinherited

This signal is emitted when image data is available and the computation has started.

Referenced by Digikam::DImgThreadedFilter::startFilterDirectly().

◆ startFilter()

void Digikam::DImgThreadedFilter::startFilter ( )

virtualinherited

Start the threaded computation.

References Digikam::DynamicThread::finished(), Digikam::DImg::height, Digikam::DImgThreadedFilter::m_name, Digikam::DImgThreadedFilter::m_orgImage, Digikam::DynamicThread::start(), and Digikam::DImg::width.

Referenced by Digikam::PreviewThreadWrapper::startFilters().

◆ startFilterDirectly()

void Digikam::DImgThreadedFilter::startFilterDirectly ( )

virtualinherited

Start computation of this filter, directly in this thread.

References Digikam::DImgThreadedFilter::filterImage(), Digikam::DynamicThread::finished(), Digikam::DImg::height, Digikam::DImgThreadedFilter::m_name, Digikam::DImgThreadedFilter::m_orgImage, Digikam::DImgThreadedFilter::m_wasCancelled, Digikam::DImgThreadedFilter::started(), and Digikam::DImg::width.

Referenced by Digikam::BatchTool::applyFilter(), Digikam::BatchTool::applyFilterChangedProperties(), DigikamEditorProfileConversionToolPlugin::ProfileConversionTool::fastConversion(), Digikam::DImgThreadedFilter::initFilter(), DigikamRAWDImgPlugin::DImgRAWLoader::postProcess(), and Digikam::DImgThreadedFilter::run().

◆ starting

void Digikam::DynamicThread::starting ( )

signalinherited

Emitted if emitSignals is enabled

◆ state()

DynamicThread::State Digikam::DynamicThread::state ( ) const

inherited

Referenced by Digikam::ThumbnailImageCatcher::Private::harvest(), and Digikam::ThumbnailImageCatcher::Private::reset().

◆ stop [1/2]

void Digikam::DynamicThread::stop ( )

slotinherited

Stop computation, sets the running flag to false.

Referenced by Digikam::WBFilter::autoExposureAdjustement(), Digikam::DImgThreadedFilter::cancelFilter(), Digikam::DImgThreadedFilter::multithreadedSteps(), Digikam::LoadSaveThread::run(), Digikam::ScanStateFilter::run(), Digikam::DynamicThread::shutDown(), Digikam::FacePreviewLoader::slotImageLoaded(), Digikam::FacePipeline::Private::stop(), and Digikam::ImageHistogram::stopCalculation().

◆ stop() [2/2]

void Digikam::DynamicThread::stop ( QMutexLocker & locker )

protectedinherited

◆ supportedVersions()

QList< int > Digikam::DImgThreadedFilter::supportedVersions ( ) const

virtualinherited

Referenced by Digikam::DImgThreadedFilter::setFilterVersion().

◆ threadMutex()

QMutex * Digikam::DynamicThread::threadMutex ( ) const

protectedinherited

This is the non-recursive mutex used to protect state variables and waiting in this class. You can use it if you want to protect your memory in the same scope as calling start, stop or wait, then using the QMutexLocker variants below. Note that when you have locked this mutex, you must use these variants, as the mutex is non-recursive.

◆ wait [1/2]

void Digikam::DynamicThread::wait ( )

slotinherited

Waits until the thread finishes. Typically, call stop() before.

Referenced by Digikam::DImgThreadedFilter::cancelFilter(), Digikam::ThumbnailLoadThread::cleanUp(), Digikam::DynamicThread::shutDown(), Digikam::FacePreviewLoader::slotImageLoaded(), Digikam::ImageHistogram::stopCalculation(), and Digikam::FacePipeline::Private::wait().

◆ wait() [2/2]

void Digikam::DynamicThread::wait ( QMutexLocker & locker )

protectedinherited

Member Data Documentation

◆ m_destImage

DImg Digikam::DImgThreadedFilter::m_destImage

protectedinherited

Output image data.

Referenced by Digikam::CBFilter::CBFilter(), Digikam::CurvesFilter::CurvesFilter(), filterImage(), Digikam::IccTransformFilter::filterImage(), Digikam::RawProcessingFilter::filterImage(), Digikam::WBFilter::filterImage(), Digikam::InvertFilter::InvertFilter(), Digikam::LevelsFilter::LevelsFilter(), Digikam::DImgThreadedFilter::prepareDestImage(), Digikam::GreycstorationFilter::setup(), and Digikam::SharpenFilter::SharpenFilter().

◆ m_master

DImgThreadedFilter* Digikam::DImgThreadedFilter::m_master

protectedinherited

The master of this slave filter. Progress info will be routed to this one.

Referenced by Digikam::DImgThreadedFilter::initFilter(), Digikam::DImgThreadedFilter::initMaster(), Digikam::DImgThreadedFilter::initSlave(), Digikam::DImgThreadedFilter::postProgress(), and Digikam::DImgThreadedFilter::~DImgThreadedFilter().

◆ m_name

QString Digikam::DImgThreadedFilter::m_name

protectedinherited

Filter name.

Referenced by Digikam::DImgThreadedFilter::setFilterName(), Digikam::DImgThreadedFilter::startFilter(), and Digikam::DImgThreadedFilter::startFilterDirectly().

◆ m_orgImage

DImg Digikam::DImgThreadedFilter::m_orgImage

protectedinherited

Copy of original Image data.

Referenced by Digikam::ContentAwareFilter::ContentAwareFilter(), filterImage(), Digikam::IccTransformFilter::filterImage(), Digikam::RawProcessingFilter::filterImage(), Digikam::WBFilter::filterImage(), Digikam::DImgThreadedFilter::prepareDestImage(), Digikam::DImgThreadedFilter::setOriginalImage(), Digikam::GreycstorationFilter::setup(), Digikam::NREstimate::startAnalyse(), Digikam::AutoCrop::startAnalyse(), Digikam::DImgThreadedFilter::startFilter(), and Digikam::DImgThreadedFilter::startFilterDirectly().

◆ m_progressBegin

int Digikam::DImgThreadedFilter::m_progressBegin

protectedinherited

The progress span that a slave filter uses in the parent filter's progress.

Referenced by Digikam::DImgThreadedFilter::initMaster(), Digikam::DImgThreadedFilter::initSlave(), and Digikam::DImgThreadedFilter::modulateProgress().

◆ m_progressCurrent

int Digikam::DImgThreadedFilter::m_progressCurrent

protectedinherited

To prevent signals bombarding with progress indicator value in postProgress().

Referenced by Digikam::DImgThreadedFilter::initMaster(), Digikam::DImgThreadedFilter::initSlave(), and Digikam::DImgThreadedFilter::postProgress().

◆ m_progressSpan

int Digikam::DImgThreadedFilter::m_progressSpan

protectedinherited

Referenced by Digikam::DImgThreadedFilter::initMaster(), Digikam::DImgThreadedFilter::initSlave(), and Digikam::DImgThreadedFilter::modulateProgress().

◆ m_slave

DImgThreadedFilter* Digikam::DImgThreadedFilter::m_slave

protectedinherited

The current slave. Any filter might want to use another filter while processing.

Referenced by Digikam::DImgThreadedFilter::cancelFilter(), Digikam::DImgThreadedFilter::initMaster(), Digikam::DImgThreadedFilter::initSlave(), and Digikam::DImgThreadedFilter::setSlave().

◆ m_version

int Digikam::DImgThreadedFilter::m_version

protectedinherited

Referenced by Digikam::DImgThreadedFilter::filterVersion(), and Digikam::DImgThreadedFilter::setFilterVersion().

◆ m_wasCancelled

bool Digikam::DImgThreadedFilter::m_wasCancelled

protectedinherited

Referenced by Digikam::DImgThreadedFilter::cancelFilter(), and Digikam::DImgThreadedFilter::startFilterDirectly().

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

core/libs/dimg/filters/filteractionfilter.h
core/libs/dimg/filters/filteractionfilter.cpp

Public Types

Public Slots

Signals

Public Member Functions

Protected Member Functions

Protected Attributes

Member Enumeration Documentation

◆ State

Constructor & Destructor Documentation

◆ FilterActionFilter()

◆ ~FilterActionFilter()

Member Function Documentation

◆ addFilterAction()

◆ addFilterActions()

◆ appliedFilterActions()

◆ cancelFilter()

◆ cleanupFilter()

◆ completelyApplied()

◆ failedAction()

◆ failedActionIndex()

◆ failedActionMessage()

◆ filterAction()

◆ filterActions()

◆ filterIdentifier()

◆ filterImage()

◆ filterName()

◆ filterVersion()

◆ finished [1/2]

◆ finished [2/2]

◆ getTargetImage()

◆ initFilter()

◆ initMaster()

◆ initSlave()

◆ isComplexAction()

◆ isFinished()

◆ isReproducible()

◆ isRunning()

◆ isSupported()

◆ modulateProgress()

◆ multithreadedSteps()

◆ parametersSuccessfullyRead()

◆ postProgress()

◆ prepareDestImage()

◆ priority()

◆ progress

◆ readParameters()

◆ readParametersError()

◆ run()

◆ runningFlag()

◆ setContinueOnError()

◆ setEmitSignals()

◆ setFilterAction()

◆ setFilterActions()

◆ setFilterName()

◆ setFilterVersion()

◆ setOriginalImage()

◆ setPriority()

◆ setSlave()

◆ setupAndStartDirectly()

◆ setupFilter()

◆ shutDown()

◆ start [1/2]

◆ start() [2/2]

◆ started

◆ startFilter()

◆ startFilterDirectly()

◆ starting

◆ state()

◆ stop [1/2]

◆ stop() [2/2]

◆ supportedVersions()

◆ threadMutex()

◆ wait [1/2]

◆ wait() [2/2]

Member Data Documentation

◆ m_destImage

◆ m_master

◆ m_name

◆ m_orgImage

◆ m_progressBegin