Class for debayering using an EGL Shader. More...

Inheritance diagram for libcamera::DebayerEGL:

[legend]

Collaboration diagram for libcamera::DebayerEGL:

[legend]

Public Member Functions
	DebayerEGL (std::unique_ptr< SwStatsCpu > stats, const GlobalConfiguration &configuration)
	Construct a DebayerEGL object.

int	configure (const StreamConfiguration &inputCfg, const std::vector< std::reference_wrapper< StreamConfiguration > > &outputCfgs, bool ccmEnabled)
	Configure the debayer object according to the passed in parameters.

Size	patternSize (PixelFormat inputFormat)
	Get the width and height at which the bayer pattern repeats.

std::vector< PixelFormat >	formats (PixelFormat input)
	Get the supported output formats.

std::tuple< unsigned int, unsigned int >	strideAndFrameSize (const PixelFormat &outputFormat, const Size &size)
	Get the stride and the frame size.

void	process (uint32_t frame, FrameBuffer input, FrameBuffer output, DebayerParams params)
	Process the bayer data into the requested format.

int	start ()
	Execute a start signal in the debayer object from workerthread context.

void	stop ()
	Stop the debayering process and perform cleanup.

const SharedFD &	getStatsFD ()
	Get the file descriptor for the statistics.

unsigned int	frameSize ()
	Get the output frame size.

SizeRange	sizes (PixelFormat inputFormat, const Size &inputSize)
	Get the supported output sizes for the given input format and size.

Public Member Functions inherited from libcamera::Debayer
	Debayer (const GlobalConfiguration &configuration)
	Construct a Debayer object.

unsigned int	frameSize ()
	Get the output frame size.

Public Member Functions inherited from libcamera::Object
	Object (Object *parent=nullptr)
	Construct an Object instance.

virtual	~Object ()
	Destroy an Object instance.

void	deleteLater ()
	Schedule deletion of the instance in the thread it belongs to.

void	postMessage (std::unique_ptr< Message > msg)
	Post a message to the object's thread.

template<typename T , typename R , typename... FuncArgs, typename... Args, std::enable_if_t< std::is_base_of< Object, T >::value > * = nullptr>
R	invokeMethod (R(T::*func)(FuncArgs...), ConnectionType type, Args &&... args)
	Invoke a method asynchronously on an Object instance.

Thread *	thread () const
	Retrieve the thread the object is bound to.

void	moveToThread (Thread *thread)
	Move the object and all its children to a different thread.

Object *	parent () const
	Retrieve the object's parent.

Additional Inherited Members
Public Attributes inherited from libcamera::Debayer
Signal< FrameBuffer * >	inputBufferReady
	Signals when the input buffer is ready.

Signal< FrameBuffer * >	outputBufferReady
	Signals when the output buffer is ready.

DebayerInputConfig	inputConfig_
	Input configuration parameters for the current debayer operation.

DebayerOutputConfig	outputConfig_
	Output configuration data for the debayered frame.

Size	outputSize_
	Output size object.

PixelFormat	inputPixelFormat_
	The incoming pixel format.

PixelFormat	outputPixelFormat_
	The output pixel format.

bool	swapRedBlueGains_
	Flag indicating whether red and blue channel gains should be swapped.

Benchmark	bench_
	Benchmarking utility instance for performance measurements.

Protected Member Functions inherited from libcamera::Debayer
void	dmaSyncBegin (std::vector< DmaSyncer > &dmaSyncers, FrameBuffer input, FrameBuffer output)
	Common CPU/GPU Dma Sync Buffer begin.

Protected Member Functions inherited from libcamera::Object
virtual void	message (Message *msg)
	Message handler for the object.

bool	assertThreadBound (const char *message)
	Check if the caller complies with thread-bound constraints.

Static Protected Member Functions inherited from libcamera::Debayer
static bool	isStandardBayerOrder (BayerFormat::Order order)
	Common method to validate standard 2x2 Bayer pattern of 2 Green, 1 Blue, 1 Red pixels.

Detailed Description

Class for debayering using an EGL Shader.

Implements an EGL shader based debayering solution.

Constructor & Destructor Documentation

◆ DebayerEGL()

libcamera::DebayerEGL::DebayerEGL	(	std::unique_ptr< SwStatsCpu >	stats,
		const GlobalConfiguration &	configuration
	)

Construct a DebayerEGL object.

Parameters

[in]	stats	Statistics processing object
[in]	configuration	Global configuration reference

Member Function Documentation

◆ configure()

int libcamera::DebayerEGL::configure	(	const StreamConfiguration &	inputCfg,
		const std::vector< std::reference_wrapper< StreamConfiguration > > &	outputCfgs,
		bool	ccmEnabled
	)

virtual

Configure the debayer object according to the passed in parameters.

Parameters

[in]	inputCfg	The input configuration
[in]	outputCfgs	The output configurations
[in]	ccmEnabled	Whether a color correction matrix is applied

Returns: 0 on success, a negative errno on failure

Implements libcamera::Debayer.

◆ formats()

std::vector< PixelFormat > libcamera::DebayerEGL::formats ( PixelFormat inputFormat )

virtual

Get the supported output formats.

Parameters

[in] inputFormat The input format

Returns: All supported output formats or an empty vector if there are none

Implements libcamera::Debayer.

◆ frameSize()

unsigned int libcamera::DebayerEGL::frameSize ( )

Get the output frame size.

Returns: The output frame size

◆ getStatsFD()

const SharedFD & libcamera::DebayerEGL::getStatsFD ( )

inlinevirtual

Get the file descriptor for the statistics.

This file descriptor provides access to the output statistics buffer associated with the current debayering process.

Returns: The file descriptor pointing to the statistics data

Implements libcamera::Debayer.

◆ patternSize()

Size libcamera::DebayerEGL::patternSize ( PixelFormat inputFormat )

virtual

Get the width and height at which the bayer pattern repeats.

Parameters

[in] inputFormat The input format

Valid sizes are: 2x2, 4x2 or 4x4.

Returns: Pattern size or an empty size for unsupported inputFormats

Implements libcamera::Debayer.

◆ process()

void libcamera::DebayerEGL::process	(	uint32_t	frame,
		FrameBuffer *	input,
		FrameBuffer *	output,
		DebayerParams	params
	)

virtual

Process the bayer data into the requested format.

Parameters

[in]	frame	The frame number
[in]	input	The input buffer
[in]	output	The output buffer
[in]	params	The parameters to be used in debayering

Note: DebayerParams is passed by value deliberately so that a copy is passed when this is run in another thread by invokeMethod().

Implements libcamera::Debayer.

◆ sizes()

SizeRange libcamera::DebayerEGL::sizes	(	PixelFormat	inputFormat,
		const Size &	inputSize
	)

virtual

Get the supported output sizes for the given input format and size.

Parameters

[in]	inputFormat	The input format
[in]	inputSize	The input size

Returns: The valid size ranges or an empty range if there are none

Implements libcamera::Debayer.

◆ start()

int libcamera::DebayerEGL::start ( )

virtual

Execute a start signal in the debayer object from workerthread context.

The start() method is invoked so that a Debayer object can initialise internal variables or data. It is called from the software_isp::start method.

This method is particularly useful with DebayerEGL as it allows for the initialisation of the EGL stack after configure in a thread-safe manner.

Reimplemented from libcamera::Debayer.

◆ stop()

void libcamera::DebayerEGL::stop ( )

virtual

Stop the debayering process and perform cleanup.

The stop() method is invoked as the logically corollary of start(). Debayer::stop() will be called by software_isp::stop() allowing for any cleanup which should happend with stop().

The stop method similar to start() is useful for DebayerEGL as it allows for cleanup of EGL context and/or data that happens in DebayerEGL::start.

Reimplemented from libcamera::Debayer.

◆ strideAndFrameSize()

std::tuple< unsigned int, unsigned int > libcamera::DebayerEGL::strideAndFrameSize	(	const PixelFormat &	outputFormat,
		const Size &	size
	)

virtual

Get the stride and the frame size.

Parameters

[in]	outputFormat	The output format
[in]	size	The output size

Returns: A tuple of the stride and the frame size, or a tuple with 0,0 if there is no valid output config

Implements libcamera::Debayer.

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

src/libcamera/software_isp/debayer_egl.h
src/libcamera/software_isp/debayer_egl.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DebayerEGL()

Member Function Documentation

◆ configure()

◆ formats()

◆ frameSize()

◆ getStatsFD()

◆ patternSize()

◆ process()

◆ sizes()

◆ start()

◆ stop()

◆ strideAndFrameSize()