libcamera v0.3.2+99-1230f78d
Supporting cameras in Linux since 2019
converter.h
Go to the documentation of this file.
1/* SPDX-License-Identifier: LGPL-2.1-or-later */
2/*
3 * Copyright (C) 2020, Laurent Pinchart
4 * Copyright 2022 NXP
5 *
6 * Generic format converter interface
7 */
8
9#pragma once
10
11#include <functional>
12#include <initializer_list>
13#include <map>
14#include <memory>
15#include <string>
16#include <tuple>
17#include <utility>
18#include <vector>
19
23
24#include <libcamera/geometry.h>
25
26namespace libcamera {
27
28class FrameBuffer;
29class MediaDevice;
30class PixelFormat;
31class Stream;
32struct StreamConfiguration;
33
35{
36public:
37 enum class Feature {
38 None = 0,
39 InputCrop = (1 << 0),
40 };
41
43
45 virtual ~Converter();
46
47 virtual int loadConfiguration(const std::string &filename) = 0;
48
49 virtual bool isValid() const = 0;
50
51 virtual std::vector<PixelFormat> formats(PixelFormat input) = 0;
52 virtual SizeRange sizes(const Size &input) = 0;
53
54 virtual std::tuple<unsigned int, unsigned int>
55 strideAndFrameSize(const PixelFormat &pixelFormat, const Size &size) = 0;
56
57 virtual int configure(const StreamConfiguration &inputCfg,
58 const std::vector<std::reference_wrapper<StreamConfiguration>> &outputCfgs) = 0;
59 virtual int exportBuffers(const Stream *stream, unsigned int count,
60 std::vector<std::unique_ptr<FrameBuffer>> *buffers) = 0;
61
62 virtual int start() = 0;
63 virtual void stop() = 0;
64
65 virtual int queueBuffers(FrameBuffer *input,
66 const std::map<const Stream *, FrameBuffer *> &outputs) = 0;
67
68 virtual int setInputCrop(const Stream *stream, Rectangle *rect) = 0;
69 virtual std::pair<Rectangle, Rectangle> inputCropBounds(const Stream *stream) = 0;
70
73
74 const std::string &deviceNode() const { return deviceNode_; }
75
76 Features features() const { return features_; }
77
78protected:
80
81private:
82 std::string deviceNode_;
83};
84
86{
87public:
88 ConverterFactoryBase(const std::string name, std::initializer_list<std::string> compatibles);
89 virtual ~ConverterFactoryBase() = default;
90
91 const std::vector<std::string> &compatibles() const { return compatibles_; }
92
93 static std::unique_ptr<Converter> create(MediaDevice *media);
94 static std::vector<ConverterFactoryBase *> &factories();
95 static std::vector<std::string> names();
96
97private:
99
100 static void registerType(ConverterFactoryBase *factory);
101
102 virtual std::unique_ptr<Converter> createInstance(MediaDevice *media) const = 0;
103
104 std::string name_;
105 std::vector<std::string> compatibles_;
106};
107
108template<typename _Converter>
110{
111public:
112 ConverterFactory(const char *name, std::initializer_list<std::string> compatibles)
114 {
115 }
116
117 std::unique_ptr<Converter> createInstance(MediaDevice *media) const override
118 {
119 return std::make_unique<_Converter>(media);
120 }
121};
122
123#define REGISTER_CONVERTER(name, converter, compatibles) \
124 static ConverterFactory<converter> global_##converter##Factory(name, compatibles);
125
126} /* namespace libcamera */
Utilities to help constructing class interfaces.
#define LIBCAMERA_DISABLE_COPY_AND_MOVE(klass)
Disable copy and move construction and assignment of the klass.
Base class for converter factories.
Definition: converter.h:86
static std::vector< ConverterFactoryBase * > & factories()
Retrieve the list of all converter factories.
Definition: converter.cpp:339
ConverterFactoryBase(const std::string name, std::initializer_list< std::string > compatibles)
Construct a converter factory base.
Definition: converter.cpp:254
static std::unique_ptr< Converter > create(MediaDevice *media)
Create an instance of the converter corresponding to the media device.
Definition: converter.cpp:275
const std::vector< std::string > & compatibles() const
Definition: converter.h:91
static std::vector< std::string > names()
Retrieve the list of all converter factory names.
Definition: converter.cpp:319
Registration of ConverterFactory classes and creation of instances.
Definition: converter.h:110
std::unique_ptr< Converter > createInstance(MediaDevice *media) const override
Create an instance of the Converter corresponding to the factory.
Definition: converter.h:117
ConverterFactory(const char *name, std::initializer_list< std::string > compatibles)
Construct a converter factory.
Definition: converter.h:112
Abstract Base Class for converter.
Definition: converter.h:35
const std::string & deviceNode() const
The converter device node attribute accessor.
Definition: converter.h:74
Signal< FrameBuffer * > outputBufferReady
A signal emitted on each frame buffer completion of the output queue.
Definition: converter.h:72
virtual void stop()=0
Stop the converter streaming operation.
virtual bool isValid() const =0
Check if the converter configuration is valid.
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.
virtual int loadConfiguration(const std::string &filename)=0
Load converter configuration from file.
virtual std::vector< PixelFormat > formats(PixelFormat input)=0
Retrieve the list of supported pixel formats for an input pixel format.
virtual int exportBuffers(const Stream *stream, unsigned int count, std::vector< std::unique_ptr< FrameBuffer > > *buffers)=0
Export buffers from the converter device.
Converter(MediaDevice *media, Features features=Feature::None)
Construct a Converter instance.
Definition: converter.cpp:61
virtual int start()=0
Start the converter streaming operation.
virtual int queueBuffers(FrameBuffer *input, const std::map< const Stream *, FrameBuffer * > &outputs)=0
Queue buffers to converter device.
Features features() const
Retrieve the features supported by the converter.
Definition: converter.h:76
Feature
Specify the features supported by the converter.
Definition: converter.h:37
@ None
No extra features supported by the converter.
virtual int setInputCrop(const Stream *stream, Rectangle *rect)=0
Set the crop rectangle rect for stream.
Features features_
Stores the features supported by the converter.
Definition: converter.h:79
Signal< FrameBuffer * > inputBufferReady
A signal emitted when the input frame buffer completes.
Definition: converter.h:71
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.
virtual std::pair< Rectangle, Rectangle > inputCropBounds(const Stream *stream)=0
Retrieve the crop bounds for stream.
virtual SizeRange sizes(const Size &input)=0
Retrieve the range of minimum and maximum output sizes for an input size.
Frame buffer data and its associated dynamic metadata.
Definition: framebuffer.h:49
The MediaDevice represents a Media Controller device with its full graph of connected objects.
Definition: media_device.h:25
libcamera image pixel format
Definition: pixel_format.h:17
Describe a rectangle's position and dimensions.
Definition: geometry.h:243
Generic signal and slot communication mechanism.
Definition: signal.h:39
Describe a range of sizes.
Definition: geometry.h:201
Describe a two-dimensional size.
Definition: geometry.h:53
Video stream for a camera.
Definition: stream.h:74
Enum-based bit fields.
Data structures related to geometric objects.
Top-level libcamera namespace.
Definition: backtrace.h:17
Signal & slot implementation.
Configuration parameters for a stream.
Definition: stream.h:40