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

libcamera v0.3.2 Supporting cameras in Linux since 2019

Loading...
Searching...
No Matches
bayer_format.h
Go to the documentation of this file.
1/* SPDX-License-Identifier: LGPL-2.1-or-later */
2/*
3 * Copyright (C) 2020, Raspberry Pi Ltd
4 *
5 * Bayer Pixel Format
6 */
7
8#pragma once
9
10#include <ostream>
11#include <stdint.h>
12#include <string>
13
14#include <libcamera/pixel_format.h>
15
16#include "libcamera/internal/v4l2_pixelformat.h"
17
18namespace libcamera {
19
20enum class Transform;
21
22 class BayerFormat
23{
24public:
25 enum Order : uint8_t {
26 BGGR = 0,
27 GBRG = 1,
28 GRBG = 2,
29 RGGB = 3,
30 MONO = 4
31 };
32
33 enum class Packing : uint16_t {
34 None = 0,
35 CSI2 = 1,
36 IPU3 = 2,
37 PISP1 = 3,
38 PISP2 = 4,
39 };
40
41 constexpr BayerFormat()
42 : order(Order::BGGR), bitDepth(0), packing(Packing::None)
43 {
44 }
45
46 constexpr BayerFormat(Order o, uint8_t b, Packing p)
47 : order(o), bitDepth(b), packing(p)
48 {
49 }
50
51 static const BayerFormat &fromMbusCode(unsigned int mbusCode);
52 bool isValid() const { return bitDepth != 0; }
53
54 std::string toString() const;
55
56 V4L2PixelFormat toV4L2PixelFormat() const;
57 static BayerFormat fromV4L2PixelFormat(V4L2PixelFormat v4l2Format);
58 PixelFormat toPixelFormat() const;
59 static BayerFormat fromPixelFormat(PixelFormat format);
60 BayerFormat transform(Transform t) const;
61
62 Order order;
63 uint8_t bitDepth;
64
65 Packing packing;
66};
67
68bool operator==(const BayerFormat &lhs, const BayerFormat &rhs);
69static inline bool operator!=(const BayerFormat &lhs, const BayerFormat &rhs)
70{
71 return !(lhs == rhs);
72}
73
74std::ostream &operator<<(std::ostream &out, const BayerFormat &f);
75
76} /* namespace libcamera */
libcamera::BayerFormat
Class to represent a raw image Bayer format.
Definition bayer_format.h:23
libcamera::BayerFormat::fromV4L2PixelFormat
static BayerFormat fromV4L2PixelFormat(V4L2PixelFormat v4l2Format)
Convert v4l2Format to the corresponding BayerFormat.
Definition bayer_format.cpp:355
libcamera::BayerFormat::Packing
Packing
Different types of packing that can be applied to a BayerFormat.
Definition bayer_format.h:33
libcamera::BayerFormat::Packing::PISP1
@ PISP1
Format uses PISP mode 1 compression.
libcamera::BayerFormat::Packing::PISP2
@ PISP2
Format uses PISP mode 2 compression.
libcamera::BayerFormat::Packing::CSI2
@ CSI2
Format uses MIPI CSI-2 style packing.
libcamera::BayerFormat::Packing::None
@ None
No packing.
libcamera::BayerFormat::Packing::IPU3
@ IPU3
Format uses IPU3 style packing.
libcamera::BayerFormat::bitDepth
uint8_t bitDepth
The bit depth of the samples in the Bayer pattern.
Definition bayer_format.h:63
libcamera::BayerFormat::packing
Packing packing
Any packing scheme applied to this BayerFormat.
Definition bayer_format.h:65
libcamera::BayerFormat::order
Order order
The order of the colour channels in the Bayer pattern.
Definition bayer_format.h:62
libcamera::BayerFormat::isValid
bool isValid() const
Return whether a BayerFormat is valid.
Definition bayer_format.h:52
libcamera::BayerFormat::Order
Order
The order of the colour channels in the Bayer pattern.
Definition bayer_format.h:25
libcamera::BayerFormat::BGGR
@ BGGR
B then G on the first row, G then R on the second row.
Definition bayer_format.h:26
libcamera::BayerFormat::GRBG
@ GRBG
G then R on the first row, B then G on the second row.
Definition bayer_format.h:28
libcamera::BayerFormat::GBRG
@ GBRG
G then B on the first row, R then G on the second row.
Definition bayer_format.h:27
libcamera::BayerFormat::RGGB
@ RGGB
R then G on the first row, G then B on the second row.
Definition bayer_format.h:29
libcamera::BayerFormat::MONO
@ MONO
Monochrome image data, there is no colour filter array.
Definition bayer_format.h:30
libcamera::BayerFormat::toV4L2PixelFormat
V4L2PixelFormat toV4L2PixelFormat() const
Convert a BayerFormat into the corresponding V4L2PixelFormat.
Definition bayer_format.cpp:341
libcamera::BayerFormat::fromMbusCode
static const BayerFormat & fromMbusCode(unsigned int mbusCode)
Retrieve the BayerFormat associated with a media bus code.
Definition bayer_format.cpp:255
libcamera::BayerFormat::toPixelFormat
PixelFormat toPixelFormat() const
Convert a BayerFormat into the corresponding PixelFormat.
Definition bayer_format.cpp:371
libcamera::BayerFormat::BayerFormat
constexpr BayerFormat(Order o, uint8_t b, Packing p)
Construct a BayerFormat from explicit values.
Definition bayer_format.h:46
libcamera::BayerFormat::toString
std::string toString() const
Assemble and return a readable string representation of the BayerFormat.
Definition bayer_format.cpp:276
libcamera::BayerFormat::transform
BayerFormat transform(Transform t) const
Apply a transform to this BayerFormat.
Definition bayer_format.cpp:413
libcamera::BayerFormat::fromPixelFormat
static BayerFormat fromPixelFormat(PixelFormat format)
Convert a PixelFormat into the corresponding BayerFormat.
Definition bayer_format.cpp:384
libcamera::BayerFormat::BayerFormat
constexpr BayerFormat()
Construct an empty (and invalid) BayerFormat.
Definition bayer_format.h:41
libcamera::PixelFormat
libcamera image pixel format
Definition pixel_format.h:17
libcamera::V4L2PixelFormat
V4L2 pixel format FourCC wrapper.
Definition v4l2_pixelformat.h:24
libcamera
Top-level libcamera namespace.
Definition backtrace.h:17
libcamera::Transform
Transform
Enum to represent a 2D plane transform.
Definition transform.h:14
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:91
libcamera::operator==
bool operator==(const ColorSpace &lhs, const ColorSpace &rhs)
Compare color spaces for equality.
Definition color_space.cpp:506
pixel_format.h
libcamera pixel format
v4l2_pixelformat.h
V4L2 Pixel Format.