blob: 0e0da3f0df0779a7e25c978075928d04227a7839 [file] [log] [blame]
/* SPDX-License-Identifier: LGPL-2.1-or-later */
/*
* Copyright (C) 2019, Google Inc.
* Copyright (C) 2020, Raspberry Pi (Trading) 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_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" } },
/* 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)" } },
/* 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_Y12),
{ formats::R12, "12-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_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" } },
};
} /* 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
* \return The PixelFormat corresponding to the V4L2 pixel format
*/
PixelFormat V4L2PixelFormat::toPixelFormat() const
{
const auto iter = vpf2pf.find(*this);
if (iter == vpf2pf.end()) {
LOG(V4L2, Warning)
<< "Unsupported V4L2 pixel format "
<< toString();
return PixelFormat();
}
return iter->second.format;
}
/**
* \brief Convert \a pixelFormat to its corresponding V4L2PixelFormat
* \param[in] pixelFormat The PixelFormat to convert
* \param[in] multiplanar V4L2 Multiplanar API support flag
*
* Multiple V4L2 formats may exist for one PixelFormat when the format uses
* multiple planes, as V4L2 defines separate 4CCs for contiguous and separate
* planes formats. Set the \a multiplanar parameter to false to select a format
* with contiguous planes, or to true to select a format with non-contiguous
* planes.
*
* \return The V4L2PixelFormat corresponding to \a pixelFormat
*/
V4L2PixelFormat V4L2PixelFormat::fromPixelFormat(const PixelFormat &pixelFormat,
bool multiplanar)
{
const PixelFormatInfo &info = PixelFormatInfo::info(pixelFormat);
if (!info.isValid())
return V4L2PixelFormat();
return multiplanar ? info.v4l2Formats.multi : info.v4l2Formats.single;
}
} /* namespace libcamera */