Abstract Base Class for converter. More...
Public Member Functions | |
| Converter (MediaDevice *media) | |
| Construct a Converter instance. More... | |
| virtual int | loadConfiguration (const std::string &filename)=0 |
| Load converter configuration from file. More... | |
| virtual bool | isValid () const =0 |
| Check if the converter configuration is valid. More... | |
| virtual std::vector< PixelFormat > | formats (PixelFormat input)=0 |
| Retrieve the list of supported pixel formats for an input pixel format. More... | |
| virtual SizeRange | sizes (const Size &input)=0 |
| Retrieve the range of minimum and maximum output sizes for an input size. More... | |
| virtual std::tuple< unsigned int, unsigned int > | strideAndFrameSize (const PixelFormat &pixelFormat, const Size &size)=0 |
| Retrieve the output stride and frame size for an input configutation. More... | |
| virtual int | configure (const StreamConfiguration &inputCfg, const std::vector< std::reference_wrapper< StreamConfiguration >> &outputCfgs)=0 |
| Configure a set of output stream conversion from an input stream. More... | |
| virtual int | exportBuffers (const Stream *stream, unsigned int count, std::vector< std::unique_ptr< FrameBuffer >> *buffers)=0 |
| Export buffers from the converter device. More... | |
| virtual int | start ()=0 |
| Start the converter streaming operation. More... | |
| virtual void | stop ()=0 |
| Stop the converter streaming operation. | |
| virtual int | queueBuffers (FrameBuffer *input, const std::map< const Stream *, FrameBuffer *> &outputs)=0 |
| Queue buffers to converter device. More... | |
| const std::string & | deviceNode () const |
| The converter device node attribute accessor. More... | |
Public Attributes | |
| Signal< FrameBuffer * > | inputBufferReady |
| A signal emitted when the input frame buffer completes. | |
| Signal< FrameBuffer * > | outputBufferReady |
| A signal emitted on each frame buffer completion of the output queue. | |
Detailed Description
Abstract Base Class for converter.
The Converter class is an Abstract Base Class defining the interfaces of converter implementations.
Converters offer scaling and pixel format conversion services on an input stream. The converter can output multiple streams with individual conversion parameters from the same input stream.
Constructor & Destructor Documentation
◆ Converter()
| libcamera::Converter::Converter | ( | MediaDevice * | media | ) |
Construct a Converter instance.
- Parameters
-
[in] media The media device implementing the converter
This searches for the entity implementing the data streaming function in the media graph entities and use its device node as the converter device node.
Member Function Documentation
◆ configure()
|
pure virtual |
Configure a set of output stream conversion from an input stream.
- Parameters
-
[in] inputCfg Input stream configuration [out] outputCfgs A list of output stream configurations
- Returns
- 0 on success or a negative error code otherwise
Implemented in libcamera::V4L2M2MConverter.
◆ deviceNode()
|
inline |
The converter device node attribute accessor.
- Returns
- The converter device node string
◆ exportBuffers()
|
pure virtual |
Export buffers from the converter device.
- Parameters
-
[in] stream Output stream pointer exporting the buffers [in] count Number of buffers to allocate [out] buffers Vector to store allocated buffers
This function operates similarly to V4L2VideoDevice::exportBuffers() on the output stream indicated by the output.
- Returns
- The number of allocated buffers on success or a negative error code otherwise
Implemented in libcamera::V4L2M2MConverter.
◆ formats()
|
pure virtual |
Retrieve the list of supported pixel formats for an input pixel format.
- Parameters
-
[in] input Input pixel format to retrieve output pixel format list for
- Returns
- The list of supported output pixel formats
Implemented in libcamera::V4L2M2MConverter.
◆ isValid()
|
pure virtual |
Check if the converter configuration is valid.
- Returns
- True is the converter is valid, false otherwise
Implemented in libcamera::V4L2M2MConverter.
◆ loadConfiguration()
|
pure virtual |
Load converter configuration from file.
- Parameters
-
[in] filename The file name path
Load converter dependent configuration parameters to apply on the hardware.
- Returns
- 0 on success or a negative error code otherwise
◆ queueBuffers()
|
pure virtual |
Queue buffers to converter device.
- Parameters
-
[in] input The frame buffer to apply the conversion [out] outputs The container holding the output stream pointers and their respective frame buffer outputs.
This function queues the input frame buffer on the output streams of the outputs map key and retrieve the output frame buffer indicated by the buffer map value.
- Returns
- 0 on success or a negative error code otherwise
Implemented in libcamera::V4L2M2MConverter.
◆ sizes()
|
pure virtual |
Retrieve the range of minimum and maximum output sizes for an input size.
- Parameters
-
[in] input Input stream size to retrieve range for
- Returns
- A range of output image sizes
Implemented in libcamera::V4L2M2MConverter.
◆ start()
|
pure virtual |
Start the converter streaming operation.
- Returns
- 0 on success or a negative error code otherwise
Implemented in libcamera::V4L2M2MConverter.
◆ strideAndFrameSize()
|
pure virtual |
Retrieve the output stride and frame size for an input configutation.
- Parameters
-
[in] pixelFormat Input stream pixel format [in] size Input stream size
- Returns
- A tuple indicating the stride and frame size or an empty tuple on error
Implemented in libcamera::V4L2M2MConverter.
The documentation for this class was generated from the following files:
- include/libcamera/internal/converter.h
- src/libcamera/converter.cpp
