libcamera: include/libcamera/internal/v4l2_subdevice.h Source File

libcamera v0.7.2 Supporting cameras in Linux since 2019

Loading...
Searching...
No Matches
v4l2_subdevice.h
Go to the documentation of this file.
1/* SPDX-License-Identifier: LGPL-2.1-or-later */
2/*
3 * Copyright (C) 2019, Google Inc.
4 *
5 * V4L2 Subdevice
6 */
7
8#pragma once
9
10#include <memory>
11#include <optional>
12#include <ostream>
13#include <stdint.h>
14#include <string>
15#include <vector>
16
17#include <linux/v4l2-subdev.h>
18
19#include <libcamera/base/class.h>
20#include <libcamera/base/log.h>
21#include <libcamera/base/regex.h>
22
23#include <libcamera/color_space.h>
24#include <libcamera/geometry.h>
25
26#include "libcamera/internal/formats.h"
27#include "libcamera/internal/media_object.h"
28#include "libcamera/internal/v4l2_device.h"
29
30namespace libcamera {
31
32class MediaDevice;
33
34 class MediaBusFormatInfo
35{
36public:
37 enum class Type {
38 Image,
39 Metadata,
40 EmbeddedData,
41 };
42
43 bool isValid() const { return code != 0; }
44
45 static const MediaBusFormatInfo &info(uint32_t code);
46
47 const char *name;
48 uint32_t code;
49 Type type;
50 unsigned int bitsPerPixel;
51 PixelFormatInfo::ColourEncoding colourEncoding;
52};
53
54 struct V4L2SubdeviceCapability final : v4l2_subdev_capability {
55 bool isReadOnly() const
56 {
57 return capabilities & V4L2_SUBDEV_CAP_RO_SUBDEV;
58 }
59 bool hasStreams() const
60 {
61 return capabilities & V4L2_SUBDEV_CAP_STREAMS;
62 }
63};
64
65 struct V4L2SubdeviceFormat {
66 uint32_t code;
67 Size size;
68 std::optional<ColorSpace> colorSpace;
69
70 std::string toString() const;
71};
72
73std::ostream &operator<<(std::ostream &out, const V4L2SubdeviceFormat &f);
74
75 class V4L2Subdevice : public V4L2Device
76{
77public:
78 using Formats = std::map<unsigned int, std::vector<SizeRange>>;
79
80 enum Whence {
81 TryFormat = V4L2_SUBDEV_FORMAT_TRY,
82 ActiveFormat = V4L2_SUBDEV_FORMAT_ACTIVE,
83 };
84
85 struct Stream {
86 Stream()
87 : pad(0), stream(0)
88 {
89 }
90
91 Stream(unsigned int p, unsigned int s)
92 : pad(p), stream(s)
93 {
94 }
95
96 unsigned int pad;
97 unsigned int stream;
98 };
99
100 struct Route {
101 Route()
102 : flags(0)
103 {
104 }
105
106 Route(const Stream &snk, const Stream &src, uint32_t f)
107 : sink(snk), source(src), flags(f)
108 {
109 }
110
111 Stream sink;
112 Stream source;
113 uint32_t flags;
114 };
115
116 using Routing = std::vector<Route>;
117
118 explicit V4L2Subdevice(const MediaEntity *entity);
119 ~V4L2Subdevice();
120
121 int open();
122
123 const MediaEntity *entity() const { return entity_; }
124
125 int getSelection(const Stream &stream, unsigned int target,
126 Rectangle *rect);
127 int getSelection(unsigned int pad, unsigned int target, Rectangle *rect)
128 {
129 return getSelection({ pad, 0 }, target, rect);
130 }
131 int setSelection(const Stream &stream, unsigned int target,
132 Rectangle *rect);
133 int setSelection(unsigned int pad, unsigned int target, Rectangle *rect)
134 {
135 return setSelection({ pad, 0 }, target, rect);
136 }
137
138 Formats formats(const Stream &stream);
139 Formats formats(unsigned int pad)
140 {
141 return formats({ pad, 0 });
142 }
143
144 int getFormat(const Stream &stream, V4L2SubdeviceFormat *format,
145 Whence whence = ActiveFormat);
146 int getFormat(unsigned int pad, V4L2SubdeviceFormat *format,
147 Whence whence = ActiveFormat)
148 {
149 return getFormat({ pad, 0 }, format, whence);
150 }
151 int setFormat(const Stream &stream, V4L2SubdeviceFormat *format,
152 Whence whence = ActiveFormat);
153 int setFormat(unsigned int pad, V4L2SubdeviceFormat *format,
154 Whence whence = ActiveFormat)
155 {
156 return setFormat({ pad, 0 }, format, whence);
157 }
158
159 int getRouting(Routing *routing, Whence whence = ActiveFormat);
160 int setRouting(Routing *routing, Whence whence = ActiveFormat);
161
162 const std::string &model();
163 const V4L2SubdeviceCapability &caps() const { return caps_; }
164
165 static std::unique_ptr<V4L2Subdevice>
166 fromEntityName(const MediaDevice *media, const std::string &entity);
167 static std::unique_ptr<V4L2Subdevice>
168 fromEntityName(const MediaDevice *media, const std::regex &entity);
169
170protected:
171 std::string logPrefix() const override;
172
173private:
174 LIBCAMERA_DISABLE_COPY(V4L2Subdevice)
175
176 std::optional<ColorSpace>
177 toColorSpace(const v4l2_mbus_framefmt &format) const;
178
179 std::vector<unsigned int> enumPadCodes(const Stream &stream);
180 std::vector<SizeRange> enumPadSizes(const Stream &stream,
181 unsigned int code);
182
183 int getRoutingLegacy(Routing *routing, Whence whence);
184 int setRoutingLegacy(Routing *routing, Whence whence);
185
186 const MediaEntity *entity_;
187
188 std::string model_;
189 struct V4L2SubdeviceCapability caps_;
190};
191
192bool operator==(const V4L2Subdevice::Stream &lhs, const V4L2Subdevice::Stream &rhs);
193static inline bool operator!=(const V4L2Subdevice::Stream &lhs,
194 const V4L2Subdevice::Stream &rhs)
195{
196 return !(lhs == rhs);
197}
198
199std::ostream &operator<<(std::ostream &out, const V4L2Subdevice::Stream &stream);
200std::ostream &operator<<(std::ostream &out, const V4L2Subdevice::Route &route);
201std::ostream &operator<<(std::ostream &out, const V4L2Subdevice::Routing &routing);
202
203} /* namespace libcamera */
class.h
Utilities to help constructing class interfaces.
LIBCAMERA_DISABLE_COPY
#define LIBCAMERA_DISABLE_COPY(klass)
Disable copy construction and assignment of the klass.
Definition class.h:27
libcamera::MediaBusFormatInfo
Information about media bus formats.
Definition v4l2_subdevice.h:35
libcamera::MediaBusFormatInfo::type
Type type
The media bus format type.
Definition v4l2_subdevice.h:49
libcamera::MediaBusFormatInfo::isValid
bool isValid() const
Check if the media bus format info is valid.
Definition v4l2_subdevice.h:43
libcamera::MediaBusFormatInfo::code
uint32_t code
The media bus format code described by this instance (MEDIA_BUS_FMT_*).
Definition v4l2_subdevice.h:48
libcamera::MediaBusFormatInfo::name
const char * name
The format name as a human-readable string, used as the text representation of the format.
Definition v4l2_subdevice.h:47
libcamera::MediaBusFormatInfo::bitsPerPixel
unsigned int bitsPerPixel
The average number of bits per pixel.
Definition v4l2_subdevice.h:50
libcamera::MediaBusFormatInfo::info
static const MediaBusFormatInfo & info(uint32_t code)
Retrieve information about a media bus format.
Definition v4l2_subdevice.cpp:824
libcamera::MediaBusFormatInfo::colourEncoding
PixelFormatInfo::ColourEncoding colourEncoding
The colour encoding type.
Definition v4l2_subdevice.h:51
libcamera::MediaBusFormatInfo::Type
Type
The format type.
Definition v4l2_subdevice.h:37
libcamera::MediaBusFormatInfo::Type::EmbeddedData
@ EmbeddedData
The format describes sensor embedded data.
Definition v4l2_subdevice.h:40
libcamera::MediaBusFormatInfo::Type::Image
@ Image
The format describes image data.
Definition v4l2_subdevice.h:38
libcamera::MediaBusFormatInfo::Type::Metadata
@ Metadata
The format describes generic metadata.
Definition v4l2_subdevice.h:39
libcamera::MediaDevice
The MediaDevice represents a Media Controller device with its full graph of connected objects.
Definition media_device.h:28
libcamera::MediaEntity
The MediaEntity represents an entity in the media graph.
Definition media_object.h:97
libcamera::PixelFormatInfo::ColourEncoding
ColourEncoding
The colour encoding type.
Definition formats.h:23
libcamera::Rectangle
Describe a rectangle's position and dimensions.
Definition geometry.h:247
libcamera::Size
Describe a two-dimensional size.
Definition geometry.h:51
libcamera::Stream
Video stream for a camera.
Definition stream.h:76
libcamera::V4L2Device::V4L2Device
V4L2Device(const std::string &deviceNode)
Construct a V4L2Device.
Definition v4l2_device.cpp:59
libcamera::V4L2Subdevice
A V4L2 subdevice as exposed by the Linux kernel.
Definition v4l2_subdevice.h:76
libcamera::V4L2Subdevice::fromEntityName
static std::unique_ptr< V4L2Subdevice > fromEntityName(const MediaDevice *media, const std::string &entity)
Create a new video subdevice instance from entity in media device media.
Definition v4l2_subdevice.cpp:1753
libcamera::V4L2Subdevice::open
int open()
Open a V4L2 subdevice.
Definition v4l2_subdevice.cpp:1125
libcamera::V4L2Subdevice::setSelection
int setSelection(unsigned int pad, unsigned int target, Rectangle *rect)
Set selection rectangle rect for target.
Definition v4l2_subdevice.h:133
libcamera::V4L2Subdevice::logPrefix
std::string logPrefix() const override
Retrieve a string to be prefixed to the log message.
Definition v4l2_subdevice.cpp:1781
libcamera::V4L2Subdevice::setRouting
int setRouting(Routing *routing, Whence whence=ActiveFormat)
Set a routing table on the V4L2 subdevice.
Definition v4l2_subdevice.cpp:1629
libcamera::V4L2Subdevice::getSelection
int getSelection(unsigned int pad, unsigned int target, Rectangle *rect)
Get selection rectangle rect for target.
Definition v4l2_subdevice.h:127
libcamera::V4L2Subdevice::setSelection
int setSelection(const Stream &stream, unsigned int target, Rectangle *rect)
Set selection rectangle rect for target.
Definition v4l2_subdevice.cpp:1227
libcamera::V4L2Subdevice::caps
const V4L2SubdeviceCapability & caps() const
Retrieve the subdevice V4L2 capabilities.
Definition v4l2_subdevice.h:163
libcamera::V4L2Subdevice::getSelection
int getSelection(const Stream &stream, unsigned int target, Rectangle *rect)
Get selection rectangle rect for target.
Definition v4l2_subdevice.cpp:1179
libcamera::V4L2Subdevice::Formats
std::map< unsigned int, std::vector< SizeRange > > Formats
A map of supported media bus formats to frame sizes.
Definition v4l2_subdevice.h:78
libcamera::V4L2Subdevice::Whence
Whence
Specify the type of format for getFormat() and setFormat() operations.
Definition v4l2_subdevice.h:80
libcamera::V4L2Subdevice::TryFormat
@ TryFormat
The format operation applies to TRY formats.
Definition v4l2_subdevice.h:81
libcamera::V4L2Subdevice::ActiveFormat
@ ActiveFormat
The format operation applies to ACTIVE formats.
Definition v4l2_subdevice.h:82
libcamera::V4L2Subdevice::formats
Formats formats(const Stream &stream)
Enumerate all media bus codes and frame sizes on a stream.
Definition v4l2_subdevice.cpp:1281
libcamera::V4L2Subdevice::setFormat
int setFormat(unsigned int pad, V4L2SubdeviceFormat *format, Whence whence=ActiveFormat)
Set an image format on one of the V4L2 subdevice pads.
Definition v4l2_subdevice.h:153
libcamera::V4L2Subdevice::entity
const MediaEntity * entity() const
Retrieve the media entity associated with the subdevice.
Definition v4l2_subdevice.h:123
libcamera::V4L2Subdevice::setFormat
int setFormat(const Stream &stream, V4L2SubdeviceFormat *format, Whence whence=ActiveFormat)
Set an image format on one of the V4L2 subdevice pads.
Definition v4l2_subdevice.cpp:1403
libcamera::V4L2Subdevice::model
const std::string & model()
Retrieve the model name of the device.
Definition v4l2_subdevice.cpp:1703
libcamera::V4L2Subdevice::V4L2Subdevice
V4L2Subdevice(const MediaEntity *entity)
Create a V4L2 subdevice from a MediaEntity using its device node path.
Definition v4l2_subdevice.cpp:1111
libcamera::V4L2Subdevice::getFormat
int getFormat(unsigned int pad, V4L2SubdeviceFormat *format, Whence whence=ActiveFormat)
Retrieve the image format set on one of the V4L2 subdevice pads.
Definition v4l2_subdevice.h:146
libcamera::V4L2Subdevice::Routing
std::vector< Route > Routing
V4L2 subdevice routing table.
Definition v4l2_subdevice.h:116
libcamera::V4L2Subdevice::getFormat
int getFormat(const Stream &stream, V4L2SubdeviceFormat *format, Whence whence=ActiveFormat)
Retrieve the image format set on one of the V4L2 subdevice streams.
Definition v4l2_subdevice.cpp:1356
libcamera::V4L2Subdevice::getRouting
int getRouting(Routing *routing, Whence whence=ActiveFormat)
Retrieve the subdevice's internal routing table.
Definition v4l2_subdevice.cpp:1539
libcamera::V4L2Subdevice::formats
Formats formats(unsigned int pad)
Enumerate all media bus codes and frame sizes on a pad.
Definition v4l2_subdevice.h:139
color_space.h
Class and enums to represent color spaces.
geometry.h
Data structures related to geometric objects.
formats.h
Types and helper functions to handle libcamera image formats.
log.h
Logging infrastructure.
media_object.h
Provides a class hierarchy that represents the media objects exposed by the Linux kernel Media Contro...
libcamera
Top-level libcamera namespace.
Definition backtrace.h:17
libcamera::operator<<
std::ostream & operator<<(std::ostream &out, const Point &p)
Insert a text representation of a Point into an output stream.
Definition geometry.cpp:93
libcamera::V4L2SubdeviceCapability
struct v4l2_subdev_capability object wrapper and helpers
Definition v4l2_subdevice.h:54
libcamera::V4L2SubdeviceCapability::hasStreams
bool hasStreams() const
Retrieve if a subdevice supports the V4L2 streams API.
Definition v4l2_subdevice.h:59
libcamera::V4L2SubdeviceCapability::isReadOnly
bool isReadOnly() const
Retrieve if a subdevice is registered as read-only.
Definition v4l2_subdevice.h:55
libcamera::V4L2SubdeviceFormat
The V4L2 sub-device image format and sizes.
Definition v4l2_subdevice.h:65
libcamera::V4L2SubdeviceFormat::size
Size size
The image size in pixels.
Definition v4l2_subdevice.h:67
libcamera::V4L2SubdeviceFormat::colorSpace
std::optional< ColorSpace > colorSpace
The color space of the pixels.
Definition v4l2_subdevice.h:68
libcamera::V4L2SubdeviceFormat::code
uint32_t code
The image format bus code.
Definition v4l2_subdevice.h:66
libcamera::V4L2SubdeviceFormat::toString
std::string toString() const
Assemble and return a string describing the format.
Definition v4l2_subdevice.cpp:920
libcamera::V4L2Subdevice::Route
V4L2 subdevice routing table entry.
Definition v4l2_subdevice.h:100
libcamera::V4L2Subdevice::Route::source
Stream source
The source stream of the route.
Definition v4l2_subdevice.h:112
libcamera::V4L2Subdevice::Route::flags
uint32_t flags
The route flags (V4L2_SUBDEV_ROUTE_FL_*).
Definition v4l2_subdevice.h:113
libcamera::V4L2Subdevice::Route::sink
Stream sink
The sink stream of the route.
Definition v4l2_subdevice.h:111
libcamera::V4L2Subdevice::Route::Route
Route()
Construct a Route with default streams.
Definition v4l2_subdevice.h:101
libcamera::V4L2Subdevice::Route::Route
Route(const Stream &snk, const Stream &src, uint32_t f)
Construct a Route from sink to source.
Definition v4l2_subdevice.h:106
libcamera::V4L2Subdevice::Stream
V4L2 subdevice stream.
Definition v4l2_subdevice.h:85
libcamera::V4L2Subdevice::Stream::Stream
Stream(unsigned int p, unsigned int s)
Construct a Stream with a given pad and stream number.
Definition v4l2_subdevice.h:91
libcamera::V4L2Subdevice::Stream::Stream
Stream()
Construct a Stream with pad and stream set to 0.
Definition v4l2_subdevice.h:86
libcamera::V4L2Subdevice::Stream::pad
unsigned int pad
The 0-indexed pad number.
Definition v4l2_subdevice.h:96
libcamera::V4L2Subdevice::Stream::stream
unsigned int stream
The stream number.
Definition v4l2_subdevice.h:97
v4l2_device.h
Common base for V4L2 devices and subdevices.