Base class for image filters processing a given bitmap in a pixelwise fashion. More...

#include <pixelwise_filter.h>

Inheritance diagram for Beatmup::Filters::PixelwiseFilter:

Public Member Functions
virtual	~PixelwiseFilter ()

virtual void	setInput (AbstractBitmap *input)

virtual void	setOutput (AbstractBitmap *output)

AbstractBitmap *	getInput ()

AbstractBitmap *	getOutput ()

ThreadIndex	getMaxThreads () const
	Gives the upper limint on the number of threads the task may be performed by. More...

Public Member Functions inherited from Beatmup::Object
virtual	~Object ()

Protected Member Functions
virtual void	apply (int x, int y, msize nPix, TaskThread &thread)=0
	Applies filtering to given pixel data. More...

virtual std::string	getGlslDeclarations () const
	Provides GLSL declarations used in the GLSL code. More...

virtual std::string	getGlslSourceCode () const =0
	Provides GLSL source code of the filter. More...

virtual void	setup (bool useGpu)
	A callback run every time before the filter is applied to the image. More...

virtual bool	process (TaskThread &thread) final
	Executes the task on CPU within a given thread. More...

virtual bool	processOnGPU (GraphicPipeline &gpu, TaskThread &thread) final
	Executes the task on GPU. More...

virtual void	beforeProcessing (ThreadIndex threadCount, ProcessingTarget target, GraphicPipeline *gpu)
	Instruction called before the task is executed. More...

virtual void	afterProcessing (ThreadIndex threadCount, GraphicPipeline *gpu, bool aborted)
	Instruction called after the task is executed. More...

virtual TaskDeviceRequirement	getUsedDevices () const final
	Communicates devices (CPU and/or GPU) the task is run on. More...

	PixelwiseFilter ()

Protected Attributes
AbstractBitmap *	inputBitmap

AbstractBitmap *	outputBitmap

ImageShader *	shader

Static Protected Attributes
static const std::string	GLSL_RGBA_INPUT

Additional Inherited Members
Public Types inherited from Beatmup::AbstractTask
enum class	TaskDeviceRequirement { CPU_ONLY , GPU_OR_CPU , GPU_ONLY }
	Specifies which device (CPU and/or GPU) is used to run the task. More...

Static Public Member Functions inherited from Beatmup::AbstractTask
static ThreadIndex	validThreadCount (int number)
	Valid thread count from a given integer value. More...

Private Member Functions inherited from Beatmup::BitmapContentLock
	BitmapContentLock ()

	~BitmapContentLock ()

void	readLock (GraphicPipeline gpu, AbstractBitmap bitmap, ProcessingTarget target)
	Locks content of a bitmap for reading using a specific processing target device. More...

void	writeLock (GraphicPipeline gpu, AbstractBitmap bitmap, ProcessingTarget target)
	Locks content of a bitmap for writing using a specific processing target device. More...

void	unlock (AbstractBitmap *bitmap)
	Drops a lock to the bitmap. More...

void	unlockAll ()
	Unlocks all the locked bitmaps unconditionally. More...

template<const ProcessingTarget target>
void	lock (GraphicPipeline gpu, AbstractBitmap input, AbstractBitmap *output)

void	lock (GraphicPipeline gpu, ProcessingTarget target, AbstractBitmap input, AbstractBitmap *output)

template<const ProcessingTarget target>
void	lock (GraphicPipeline gpu, std::initializer_list< AbstractBitmap > read, std::initializer_list< AbstractBitmap * > write)

template<typename ... Args>
void	unlock (AbstractBitmap *first, Args ... others)

Detailed Description

Base class for image filters processing a given bitmap in a pixelwise fashion.

Definition at line 33 of file pixelwise_filter.h.

Constructor & Destructor Documentation

◆ PixelwiseFilter()

Filters::PixelwiseFilter::PixelwiseFilter ( )

protected

Definition at line 27 of file pixelwise_filter.cpp.

                                         :
     inputBitmap(nullptr), outputBitmap(nullptr), shader(nullptr)
 {}

◆ ~PixelwiseFilter()

Filters::PixelwiseFilter::~PixelwiseFilter ( )

virtual

Definition at line 32 of file pixelwise_filter.cpp.

                                          {
     delete shader;
 }

Member Function Documentation

◆ apply()

virtual void Beatmup::Filters::PixelwiseFilter::apply	(	int	x,
		int	y,
		msize	nPix,
		TaskThread &	thread
	)

protectedpure virtual

Applies filtering to given pixel data.

Parameters

x	Horizontal position of the first pixel in image
y	Vertical position of the first pixel in image
nPix	Number of pixels to process
thread	Calling thread descriptor

Implemented in Beatmup::Filters::Sepia, and Beatmup::Filters::ColorMatrix.

◆ getGlslDeclarations()

std::string Filters::PixelwiseFilter::getGlslDeclarations ( ) const

protectedvirtual

Provides GLSL declarations used in the GLSL code.

Reimplemented in Beatmup::Filters::ColorMatrix.

Definition at line 119 of file pixelwise_filter.cpp.

                                                             {
     return "";
 }

◆ getGlslSourceCode()

virtual std::string Beatmup::Filters::PixelwiseFilter::getGlslSourceCode ( ) const

protectedpure virtual

Provides GLSL source code of the filter.

Implemented in Beatmup::Filters::Sepia, and Beatmup::Filters::ColorMatrix.

◆ setup()

void Filters::PixelwiseFilter::setup ( bool useGpu )

protectedvirtual

A callback run every time before the filter is applied to the image.

Parameters

useGpu If true, the filter will be run on GPU.

Reimplemented in Beatmup::Filters::ColorMatrix.

Definition at line 124 of file pixelwise_filter.cpp.

                                               {
     // nothing to do by default
 }

◆ process()

bool Filters::PixelwiseFilter::process ( TaskThread & thread )

finalprotectedvirtual

Executes the task on CPU within a given thread.

Generally called by multiple threads.

Parameters

thread associated task execution context

Returns: true if the execution is finished correctly, false otherwise

Implements Beatmup::AbstractTask.

Definition at line 92 of file pixelwise_filter.cpp.

                                                        {
     // each thread receives a single part of bitmap to deal with
     const int w = inputBitmap->getWidth();
     const msize
         nPix = w * inputBitmap->getHeight(),
         start = nPix * thread.currentThread() / thread.numThreads(),
         stop  = nPix * (1 + thread.currentThread()) / thread.numThreads();
  
     apply((int)(start % w), (int)(start / w), stop - start, thread);
     return true;
 }

◆ processOnGPU()

bool Filters::PixelwiseFilter::processOnGPU	(	GraphicPipeline &	gpu,
		TaskThread &	thread
	)

finalprotectedvirtual

Executes the task on GPU.

Parameters

gpu	graphic pipeline instance
thread	associated task execution context

Returns: true if the execution is finished correctly, false otherwise

Reimplemented from Beatmup::AbstractTask.

Definition at line 105 of file pixelwise_filter.cpp.

                                                                                   {
     shader->prepare(gpu, inputBitmap, outputBitmap);
     shader->process(gpu);
     return true;
 }

◆ beforeProcessing()

void Filters::PixelwiseFilter::beforeProcessing	(	ThreadIndex	threadCount,
		ProcessingTarget	target,
		GraphicPipeline *	gpu
	)

protectedvirtual

Instruction called before the task is executed.

Parameters

threadCount	Number of threads used to perform the task
target	Device used to perform the task
gpu	A graphic pipeline instance; may be null.

Reimplemented from Beatmup::AbstractTask.

Definition at line 45 of file pixelwise_filter.cpp.

                                                                                                                     {
     NullTaskInput::check(inputBitmap, "input bitmap");
     NullTaskInput::check(outputBitmap, "output bitmap");
     RuntimeError::check(
         inputBitmap->getWidth() == outputBitmap->getWidth() &&
         inputBitmap->getHeight() <= outputBitmap->getHeight(),
         "Incompatible input and output bitmaps sizes");
  
     // use GPU is available and the input bitmap is up to date on GPU
     const bool useGpu = (target == ProcessingTarget::GPU && inputBitmap->isUpToDate(ProcessingTarget::GPU));
  
     // deferred shader preparation
     if (useGpu) {
         RuntimeError::check(inputBitmap->getContext() == outputBitmap->getContext(),
             "Input and output bitmaps are not attached to the same context");
         if (shader && !shader->usesContext(inputBitmap->getContext())) {
             delete shader;
             shader = nullptr;
         }
         if (!shader) {
             shader = new ImageShader(inputBitmap->getContext());
             shader->setSourceCode(ImageShader::CODE_HEADER + 
                 getGlslDeclarations() + "\n" +
                 "void main() {" +
                 "lowp vec4 " +GLSL_RGBA_INPUT+ " = texture2D(" +
                         ImageShader::INPUT_IMAGE_ID + ", " +
                         Beatmup::GL::RenderingPrograms::TEXTURE_COORDINATES_ID +
                     ");\n" +
                     getGlslSourceCode() +
                 "}"
             );
         }
     }
  
     // lock bitmaps content
     lock(gpu, useGpu ? ProcessingTarget::GPU : ProcessingTarget::CPU, inputBitmap, outputBitmap);
  
     // setup
     setup(useGpu);
 }

◆ afterProcessing()

void Filters::PixelwiseFilter::afterProcessing	(	ThreadIndex	threadCount,
		GraphicPipeline *	gpu,
		bool	aborted
	)

protectedvirtual

Instruction called after the task is executed.

Parameters

threadCount	Number of threads used to perform the task
gpu	GPU to be used to execute the task; may be null.
aborted	`true` if the task was aborted

Reimplemented from Beatmup::AbstractTask.

Definition at line 87 of file pixelwise_filter.cpp.

                                                                                                         {
     unlock(inputBitmap, outputBitmap);
 }

◆ getUsedDevices()

AbstractTask::TaskDeviceRequirement Filters::PixelwiseFilter::getUsedDevices ( ) const

finalprotectedvirtual

Communicates devices (CPU and/or GPU) the task is run on.

Reimplemented from Beatmup::AbstractTask.

Definition at line 112 of file pixelwise_filter.cpp.

                                                                                {
     NullTaskInput::check(inputBitmap, "input bitmap");
     return  inputBitmap->isUpToDate(ProcessingTarget::GPU) ?
         TaskDeviceRequirement::GPU_ONLY : TaskDeviceRequirement::CPU_ONLY;
 }

◆ setInput()

virtual void Beatmup::Filters::PixelwiseFilter::setInput ( AbstractBitmap * input )

inlinevirtual

Definition at line 75 of file pixelwise_filter.h.

75 { this->inputBitmap = input; }

◆ setOutput()

virtual void Beatmup::Filters::PixelwiseFilter::setOutput ( AbstractBitmap * output )

inlinevirtual

Definition at line 76 of file pixelwise_filter.h.

76 { this->outputBitmap = output; }

◆ getInput()

AbstractBitmap* Beatmup::Filters::PixelwiseFilter::getInput ( )

inline

Definition at line 78 of file pixelwise_filter.h.

78 { return inputBitmap; }

◆ getOutput()

AbstractBitmap* Beatmup::Filters::PixelwiseFilter::getOutput ( )

inline

Definition at line 79 of file pixelwise_filter.h.

79 { return outputBitmap; }

◆ getMaxThreads()

ThreadIndex Filters::PixelwiseFilter::getMaxThreads ( ) const

virtual

Gives the upper limint on the number of threads the task may be performed by.

The actual number of threads running a specific task may be less or equal to the returned value, depending on the number of workers in ThreadPool running the task.

Reimplemented from Beatmup::AbstractTask.

Definition at line 37 of file pixelwise_filter.cpp.

                                                         {
     NullTaskInput::check(inputBitmap, "input bitmap");
     // if there are few pixels, do not use many threads
     static const int MIN_PIXEL_COUNT_PER_THREAD = 64;
     return AbstractTask::validThreadCount(inputBitmap->getWidth() * inputBitmap->getHeight() / MIN_PIXEL_COUNT_PER_THREAD);
 }

Member Data Documentation

◆ GLSL_RGBA_INPUT

const std::string Filters::PixelwiseFilter::GLSL_RGBA_INPUT

staticprotected

Definition at line 35 of file pixelwise_filter.h.

◆ inputBitmap

AbstractBitmap* Beatmup::Filters::PixelwiseFilter::inputBitmap

protected

Definition at line 37 of file pixelwise_filter.h.

◆ outputBitmap

AbstractBitmap * Beatmup::Filters::PixelwiseFilter::outputBitmap

protected

Definition at line 37 of file pixelwise_filter.h.

◆ shader

ImageShader* Beatmup::Filters::PixelwiseFilter::shader

protected

Definition at line 38 of file pixelwise_filter.h.

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

core/filters/pixelwise_filter.h
core/filters/pixelwise_filter.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PixelwiseFilter()

◆ ~PixelwiseFilter()

Member Function Documentation

◆ apply()

◆ getGlslDeclarations()

◆ getGlslSourceCode()

◆ setup()

◆ process()

◆ processOnGPU()

◆ beforeProcessing()

◆ afterProcessing()

◆ getUsedDevices()

◆ setInput()

◆ setOutput()

◆ getInput()

◆ getOutput()

◆ getMaxThreads()

Member Data Documentation

◆ GLSL_RGBA_INPUT

◆ inputBitmap

◆ outputBitmap

◆ shader