1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
|
/* SPDX-License-Identifier: LGPL-2.1-or-later */
/*
* Copyright (C) 2019, Google Inc.
* Copyright (C) 2020, Raspberry Pi Ltd
*
* v4l2_pixelformat.cpp - V4L2 Pixel Format
*/
#include "libcamera/internal/v4l2_pixelformat.h"
#include <ctype.h>
#include <map>
#include <string.h>
#include <libcamera/base/log.h>
#include <libcamera/formats.h>
#include <libcamera/pixel_format.h>
#include "libcamera/internal/formats.h"
/**
* \file v4l2_pixelformat.h
* \brief V4L2 Pixel Format
*/
namespace libcamera {
LOG_DECLARE_CATEGORY(V4L2)
/**
* \class V4L2PixelFormat
* \brief V4L2 pixel format FourCC wrapper
*
* The V4L2PixelFormat class describes the pixel format of a V4L2 buffer. It
* wraps the V4L2 numerical FourCC, and shall be used in all APIs that deal with
* V4L2 pixel formats. Its purpose is to prevent unintentional confusion of
* V4L2 and DRM FourCCs in code by catching implicit conversion attempts at
* compile time.
*
* To achieve this goal, construction of a V4L2PixelFormat from an integer value
* is explicit. To retrieve the integer value of a V4L2PixelFormat, both the
* explicit value() and implicit uint32_t conversion operators may be used.
*/
namespace {
const std::map<V4L2PixelFormat, V4L2PixelFormat::Info> vpf2pf{
/* RGB formats. */
{ V4L2PixelFormat(V4L2_PIX_FMT_RGB565),
{ formats::RGB565, "16-bit RGB 5-6-5" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_RGB565X),
{ formats::RGB565_BE, "16-bit RGB 5-6-5 BE" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_RGB24),
{ formats::BGR888, "24-bit RGB 8-8-8" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_BGR24),
{ formats::RGB888, "24-bit BGR 8-8-8" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_XBGR32),
{ formats::XRGB8888, "32-bit BGRX 8-8-8-8" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_XRGB32),
{ formats::BGRX8888, "32-bit XRGB 8-8-8-8" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_RGBX32),
{ formats::XBGR8888, "32-bit RGBX 8-8-8-8" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_BGRX32),
{ formats::RGBX8888, "32-bit XBGR 8-8-8-8" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_RGBA32),
{ formats::ABGR8888, "32-bit RGBA 8-8-8-8" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_ABGR32),
{ formats::ARGB8888, "32-bit BGRA 8-8-8-8" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_ARGB32),
{ formats::BGRA8888, "32-bit ARGB 8-8-8-8" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_BGRA32),
{ formats::RGBA8888, "32-bit ABGR 8-8-8-8" } },
/* YUV packed formats. */
{ V4L2PixelFormat(V4L2_PIX_FMT_YUYV),
{ formats::YUYV, "YUYV 4:2:2" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_YVYU),
{ formats::YVYU, "YVYU 4:2:2" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_UYVY),
{ formats::UYVY, "UYVY 4:2:2" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_VYUY),
{ formats::VYUY, "VYUY 4:2:2" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_YUVA32),
{ formats::AVUY8888, "32-bit YUVA 8-8-8-8" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_YUVX32),
{ formats::XVUY8888, "32-bit YUVX 8-8-8-8" } },
/* YUV planar formats. */
{ V4L2PixelFormat(V4L2_PIX_FMT_NV16),
{ formats::NV16, "Y/CbCr 4:2:2" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_NV16M),
{ formats::NV16, "Y/CbCr 4:2:2 (N-C)" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_NV61),
{ formats::NV61, "Y/CrCb 4:2:2" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_NV61M),
{ formats::NV61, "Y/CrCb 4:2:2 (N-C)" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_NV12),
{ formats::NV12, "Y/CbCr 4:2:0" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_NV12M),
{ formats::NV12, "Y/CbCr 4:2:0 (N-C)" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_NV21),
{ formats::NV21, "Y/CrCb 4:2:0" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_NV21M),
{ formats::NV21, "Y/CrCb 4:2:0 (N-C)" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_NV24),
{ formats::NV24, "Y/CbCr 4:4:4" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_NV42),
{ formats::NV42, "Y/CrCb 4:4:4" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_YUV420),
{ formats::YUV420, "Planar YUV 4:2:0" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_YUV420M),
{ formats::YUV420, "Planar YUV 4:2:0 (N-C)" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_YVU420),
{ formats::YVU420, "Planar YVU 4:2:0" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_YVU420M),
{ formats::YVU420, "Planar YVU 4:2:0 (N-C)" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_YUV422P),
{ formats::YUV422, "Planar YUV 4:2:2" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_YUV422M),
{ formats::YUV422, "Planar YUV 4:2:2 (N-C)" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_YVU422M),
{ formats::YVU422, "Planar YVU 4:2:2 (N-C)" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_YUV444M),
{ formats::YUV444, "Planar YUV 4:4:4 (N-C)" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_YVU444M),
{ formats::YVU444, "Planar YVU 4:4:4 (N-C)" } },
/* Greyscale formats. */
{ V4L2PixelFormat(V4L2_PIX_FMT_GREY),
{ formats::R8, "8-bit Greyscale" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_Y10),
{ formats::R10, "10-bit Greyscale" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_Y10P),
{ formats::R10_CSI2P, "10-bit Greyscale Packed" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_Y12),
{ formats::R12, "12-bit Greyscale" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_Y16),
{ formats::R16, "16-bit Greyscale" } },
/* Bayer formats. */
{ V4L2PixelFormat(V4L2_PIX_FMT_SBGGR8),
{ formats::SBGGR8, "8-bit Bayer BGBG/GRGR" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_SGBRG8),
{ formats::SGBRG8, "8-bit Bayer GBGB/RGRG" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_SGRBG8),
{ formats::SGRBG8, "8-bit Bayer GRGR/BGBG" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_SRGGB8),
{ formats::SRGGB8, "8-bit Bayer RGRG/GBGB" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_SBGGR10),
{ formats::SBGGR10, "10-bit Bayer BGBG/GRGR" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_SGBRG10),
{ formats::SGBRG10, "10-bit Bayer GBGB/RGRG" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_SGRBG10),
{ formats::SGRBG10, "10-bit Bayer GRGR/BGBG" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_SRGGB10),
{ formats::SRGGB10, "10-bit Bayer RGRG/GBGB" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_SBGGR10P),
{ formats::SBGGR10_CSI2P, "10-bit Bayer BGBG/GRGR Packed" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_SGBRG10P),
{ formats::SGBRG10_CSI2P, "10-bit Bayer GBGB/RGRG Packed" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_SGRBG10P),
{ formats::SGRBG10_CSI2P, "10-bit Bayer GRGR/BGBG Packed" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_SRGGB10P),
{ formats::SRGGB10_CSI2P, "10-bit Bayer RGRG/GBGB Packed" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_SBGGR12),
{ formats::SBGGR12, "12-bit Bayer BGBG/GRGR" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_SGBRG12),
{ formats::SGBRG12, "12-bit Bayer GBGB/RGRG" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_SGRBG12),
{ formats::SGRBG12, "12-bit Bayer GRGR/BGBG" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_SRGGB12),
{ formats::SRGGB12, "12-bit Bayer RGRG/GBGB" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_SBGGR12P),
{ formats::SBGGR12_CSI2P, "12-bit Bayer BGBG/GRGR Packed" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_SGBRG12P),
{ formats::SGBRG12_CSI2P, "12-bit Bayer GBGB/RGRG Packed" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_SGRBG12P),
{ formats::SGRBG12_CSI2P, "12-bit Bayer GRGR/BGBG Packed" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_SRGGB12P),
{ formats::SRGGB12_CSI2P, "12-bit Bayer RGRG/GBGB Packed" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_SBGGR14),
{ formats::SBGGR14, "14-bit Bayer BGBG/GRGR" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_SGBRG14),
{ formats::SGBRG14, "14-bit Bayer GBGB/RGRG" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_SGRBG14),
{ formats::SGRBG14, "14-bit Bayer GRGR/BGBG" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_SRGGB14),
{ formats::SRGGB14, "14-bit Bayer RGRG/GBGB" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_SBGGR14P),
{ formats::SBGGR14_CSI2P, "14-bit Bayer BGBG/GRGR Packed" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_SGBRG14P),
{ formats::SGBRG14_CSI2P, "14-bit Bayer GBGB/RGRG Packed" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_SGRBG14P),
{ formats::SGRBG14_CSI2P, "14-bit Bayer GRGR/BGBG Packed" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_SRGGB14P),
{ formats::SRGGB14_CSI2P, "14-bit Bayer RGRG/GBGB Packed" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_SBGGR16),
{ formats::SBGGR16, "16-bit Bayer BGBG/GRGR" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_SGBRG16),
{ formats::SGBRG16, "16-bit Bayer GBGB/RGRG" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_SGRBG16),
{ formats::SGRBG16, "16-bit Bayer GRGR/BGBG" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_SRGGB16),
{ formats::SRGGB16, "16-bit Bayer RGRG/GBGB" } },
/* Compressed formats. */
{ V4L2PixelFormat(V4L2_PIX_FMT_MJPEG),
{ formats::MJPEG, "Motion-JPEG" } },
{ V4L2PixelFormat(V4L2_PIX_FMT_JPEG),
{ formats::MJPEG, "JPEG JFIF" } },
};
} /* namespace */
/**
* \struct V4L2PixelFormat::Info
* \brief Information about a V4L2 pixel format
*
* \var V4L2PixelFormat::Info::format
* \brief The corresponding libcamera PixelFormat
*
* \sa PixelFormat
*
* \var V4L2PixelFormat::Info::description
* \brief The human-readable description of the V4L2 pixel format
*/
/**
* \fn V4L2PixelFormat::V4L2PixelFormat()
* \brief Construct a V4L2PixelFormat with an invalid format
*
* V4L2PixelFormat instances constructed with the default constructor are
* invalid, calling the isValid() function returns false.
*/
/**
* \fn V4L2PixelFormat::V4L2PixelFormat(uint32_t fourcc)
* \brief Construct a V4L2PixelFormat from a FourCC value
* \param[in] fourcc The pixel format FourCC numerical value
*/
/**
* \fn bool V4L2PixelFormat::isValid() const
* \brief Check if the pixel format is valid
*
* V4L2PixelFormat instances constructed with the default constructor are
* invalid. Instances constructed with a FourCC defined in the V4L2 API are
* valid. The behaviour is undefined otherwise.
*
* \return True if the pixel format is valid, false otherwise
*/
/**
* \fn uint32_t V4L2PixelFormat::fourcc() const
* \brief Retrieve the pixel format FourCC numerical value
* \return The pixel format FourCC numerical value
*/
/**
* \fn V4L2PixelFormat::operator uint32_t() const
* \brief Convert to the pixel format FourCC numerical value
* \return The pixel format FourCC numerical value
*/
/**
* \brief Assemble and return a string describing the pixel format
* \return A string describing the pixel format
*/
std::string V4L2PixelFormat::toString() const
{
if (fourcc_ == 0)
return "<INVALID>";
char ss[8] = { static_cast<char>(fourcc_ & 0x7f),
static_cast<char>((fourcc_ >> 8) & 0x7f),
static_cast<char>((fourcc_ >> 16) & 0x7f),
static_cast<char>((fourcc_ >> 24) & 0x7f) };
for (unsigned int i = 0; i < 4; i++) {
if (!isprint(ss[i]))
ss[i] = '.';
}
if (fourcc_ & (1 << 31))
strcat(ss, "-BE");
return ss;
}
/**
* \brief Retrieve the V4L2 description for the format
*
* The description matches the value used by the kernel, as would be reported
* by the VIDIOC_ENUM_FMT ioctl.
*
* \return The V4L2 description corresponding to the V4L2 format, or a
* placeholder description if not found
*/
const char *V4L2PixelFormat::description() const
{
const auto iter = vpf2pf.find(*this);
if (iter == vpf2pf.end()) {
LOG(V4L2, Warning)
<< "Unsupported V4L2 pixel format "
<< toString();
return "Unsupported format";
}
return iter->second.description;
}
/**
* \brief Convert the V4L2 pixel format to the corresponding PixelFormat
* \param[in] warn When true, log a warning message if the V4L2 pixel format
* isn't known
*
* Users of this function might try to convert a V4L2PixelFormat to a
* PixelFormat just to check if the format is supported or not. In that case,
* they can suppress the warning message by setting the \a warn argument to
* false to not pollute the log with unnecessary messages.
*
* \return The PixelFormat corresponding to the V4L2 pixel format
*/
PixelFormat V4L2PixelFormat::toPixelFormat(bool warn) const
{
const auto iter = vpf2pf.find(*this);
if (iter == vpf2pf.end()) {
if (warn)
LOG(V4L2, Warning) << "Unsupported V4L2 pixel format "
<< toString();
return PixelFormat();
}
return iter->second.format;
}
/**
* \brief Retrieve the list of V4L2PixelFormat associated with \a pixelFormat
* \param[in] pixelFormat The PixelFormat to convert
*
* Multiple V4L2 formats may exist for one PixelFormat as V4L2 defines separate
* 4CCs for contiguous and non-contiguous versions of the same image format.
*
* \return The list of V4L2PixelFormat corresponding to \a pixelFormat
*/
const std::vector<V4L2PixelFormat> &
V4L2PixelFormat::fromPixelFormat(const PixelFormat &pixelFormat)
{
static const std::vector<V4L2PixelFormat> empty;
const PixelFormatInfo &info = PixelFormatInfo::info(pixelFormat);
if (!info.isValid())
return empty;
return info.v4l2Formats;
}
/**
* \brief Insert a text representation of a V4L2PixelFormat into an output
* stream
* \param[in] out The output stream
* \param[in] f The V4L2PixelFormat
* \return The output stream \a out
*/
std::ostream &operator<<(std::ostream &out, const V4L2PixelFormat &f)
{
out << f.toString();
return out;
}
} /* namespace libcamera */
|
