libcamera  v0.1.0
Supporting cameras in Linux since 2019
camera_sensor.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  * camera_sensor.h - A camera sensor
6  */
7 
8 #pragma once
9 
10 #include <memory>
11 #include <string>
12 #include <vector>
13 
14 #include <libcamera/base/class.h>
15 #include <libcamera/base/log.h>
16 
17 #include <libcamera/control_ids.h>
18 #include <libcamera/controls.h>
19 #include <libcamera/geometry.h>
20 #include <libcamera/transform.h>
21 
23 
26 
27 namespace libcamera {
28 
29 class BayerFormat;
30 class CameraLens;
31 class MediaEntity;
32 
33 struct CameraSensorProperties;
34 
35 class CameraSensor : protected Loggable
36 {
37 public:
38  explicit CameraSensor(const MediaEntity *entity);
39  ~CameraSensor();
40 
41  int init();
42 
43  const std::string &model() const { return model_; }
44  const std::string &id() const { return id_; }
45  const MediaEntity *entity() const { return entity_; }
46  const std::vector<unsigned int> &mbusCodes() const { return mbusCodes_; }
47  std::vector<Size> sizes(unsigned int mbusCode) const;
48  Size resolution() const;
49  const std::vector<controls::draft::TestPatternModeEnum> &testPatternModes() const
50  {
51  return testPatternModes_;
52  }
54 
55  V4L2SubdeviceFormat getFormat(const std::vector<unsigned int> &mbusCodes,
56  const Size &size) const;
57  int setFormat(V4L2SubdeviceFormat *format,
58  Transform transform = Transform::Identity);
59  int tryFormat(V4L2SubdeviceFormat *format) const;
60 
61  const ControlInfoMap &controls() const;
62  ControlList getControls(const std::vector<uint32_t> &ids);
63  int setControls(ControlList *ctrls);
64 
65  V4L2Subdevice *device() { return subdev_.get(); }
66 
67  const ControlList &properties() const { return properties_; }
68  int sensorInfo(IPACameraSensorInfo *info) const;
69 
70  void updateControlInfo();
71 
72  CameraLens *focusLens() { return focusLens_.get(); }
73 
74  Transform validateTransform(Transform *transform) const;
75 
76 protected:
77  std::string logPrefix() const override;
78 
79 private:
81 
82  int generateId();
83  int validateSensorDriver();
84  void initVimcDefaultProperties();
85  void initStaticProperties();
86  void initTestPatternModes();
87  int initProperties();
88  int applyTestPatternMode(controls::draft::TestPatternModeEnum mode);
89  int discoverAncillaryDevices();
90 
91  const MediaEntity *entity_;
92  std::unique_ptr<V4L2Subdevice> subdev_;
93  unsigned int pad_;
94 
95  const CameraSensorProperties *staticProps_;
96 
97  std::string model_;
98  std::string id_;
99 
100  V4L2Subdevice::Formats formats_;
101  std::vector<unsigned int> mbusCodes_;
102  std::vector<Size> sizes_;
103  std::vector<controls::draft::TestPatternModeEnum> testPatternModes_;
104  controls::draft::TestPatternModeEnum testPatternMode_;
105 
106  Size pixelArraySize_;
107  Rectangle activeArea_;
108  const BayerFormat *bayerFormat_;
109  bool supportFlips_;
110 
111  ControlList properties_;
112 
113  std::unique_ptr<CameraLens> focusLens_;
114 };
115 
116 } /* namespace libcamera */
controls.h
Framework to manage controls related to an object.
v4l2_subdevice.h
V4L2 Subdevice API.
libcamera::CameraSensor::validateTransform
Transform validateTransform(Transform *transform) const
Validate a transform request against the sensor capabilities.
Definition: camera_sensor.cpp:1039
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:57
class.h
Utilities to help constructing class interfaces.
geometry.h
Data structures related to geometric objects.
libcamera::CameraSensor::getControls
ControlList getControls(const std::vector< uint32_t > &ids)
Read V4L2 controls from the sensor.
Definition: camera_sensor.cpp:859
libcamera::IPACameraSensorInfo
Report the image sensor characteristics.
Definition: core_ipa_interface.h:24
LIBCAMERA_DISABLE_COPY
#define LIBCAMERA_DISABLE_COPY(klass)
Disable copy construction and assignment of the klass.
libcamera::CameraSensor::updateControlInfo
void updateControlInfo()
Update the sensor's ControlInfoMap in case they have changed.
Definition: camera_sensor.cpp:1004
libcamera::CameraSensor::init
int init()
Initialize the camera sensor instance.
Definition: camera_sensor.cpp:78
libcamera::Transform
Transform
Enum to represent a 2D plane transform.
Definition: transform.h:14
libcamera::Rectangle
Describe a rectangle's position and dimensions.
Definition: geometry.h:243
libcamera
Top-level libcamera namespace.
Definition: backtrace.h:17
control_ids.h
Camera control identifiers.
libcamera::ControlList
Associate a list of ControlId with their values for an object.
Definition: controls.h:350
libcamera::CameraSensor::sizes
std::vector< Size > sizes(unsigned int mbusCode) const
Retrieve the supported frame sizes for a media bus code.
Definition: camera_sensor.cpp:587
libcamera::CameraSensor::model
const std::string & model() const
Retrieve the sensor model name.
Definition: camera_sensor.h:43
libcamera::BayerFormat
Class to represent a raw image Bayer format.
Definition: bayer_format.h:23
libcamera::CameraSensor::properties
const ControlList & properties() const
Retrieve the camera sensor properties.
Definition: camera_sensor.h:67
libcamera::CameraSensor::CameraSensor
CameraSensor(const MediaEntity *entity)
Construct a CameraSensor.
Definition: camera_sensor.cpp:56
libcamera::CameraSensor::controls
const ControlInfoMap & controls() const
Retrieve the supported V4L2 controls and their information.
Definition: camera_sensor.cpp:836
libcamera::CameraSensor::resolution
Size resolution() const
Retrieve the camera sensor resolution.
Definition: camera_sensor.cpp:617
libcamera::Loggable
Base class to support log message extensions.
Definition: log.h:91
libcamera::ControlInfoMap
A map of ControlId to ControlInfo.
Definition: controls.h:306
libcamera::CameraSensorProperties
Database of camera sensor properties.
Definition: camera_sensor_properties.h:18
libcamera::CameraSensor::setFormat
int setFormat(V4L2SubdeviceFormat *format, Transform transform=Transform::Identity)
Set the sensor output format.
Definition: camera_sensor.cpp:783
libcamera::V4L2Subdevice
A V4L2 subdevice as exposed by the Linux kernel.
Definition: v4l2_subdevice.h:55
libcamera::CameraSensor::tryFormat
int tryFormat(V4L2SubdeviceFormat *format) const
Try the sensor output format.
Definition: camera_sensor.cpp:819
libcamera::CameraSensor::setControls
int setControls(ControlList *ctrls)
Write V4L2 controls to the sensor.
Definition: camera_sensor.cpp:889
libcamera::CameraSensor::id
const std::string & id() const
Retrieve the sensor ID.
Definition: camera_sensor.h:44
libcamera::V4L2SubdeviceFormat
The V4L2 sub-device image format and sizes.
Definition: v4l2_subdevice.h:43
libcamera::CameraSensor::testPatternModes
const std::vector< controls::draft::TestPatternModeEnum > & testPatternModes() const
Retrieve all the supported test pattern modes of the camera sensor The test pattern mode values corre...
Definition: camera_sensor.h:49
log.h
Logging infrastructure.
libcamera::CameraSensor::getFormat
V4L2SubdeviceFormat getFormat(const std::vector< unsigned int > &mbusCodes, const Size &size) const
Retrieve the best sensor format for a desired output.
Definition: camera_sensor.cpp:716
libcamera::controls::draft::TestPatternModeEnum
TestPatternModeEnum
Supported TestPatternMode values.
Definition: control_ids.h:249
core_ipa_interface.h
libcamera structs for IPAs
libcamera::CameraSensor
A camera sensor based on V4L2 subdevices.
Definition: camera_sensor.h:36
libcamera::Size
Describe a two-dimensional size.
Definition: geometry.h:53
libcamera::CameraLens
A camera lens based on V4L2 subdevices.
Definition: camera_lens.h:23
libcamera::CameraSensor::device
V4L2Subdevice * device()
Retrieve the camera sensor device.
Definition: camera_sensor.h:65
transform.h
Enum to represent and manipulate 2D plane transforms.
libcamera::CameraSensor::entity
const MediaEntity * entity() const
Retrieve the sensor media entity.
Definition: camera_sensor.h:45
formats.h
Types and helper functions to handle libcamera image formats.
libcamera::CameraSensor::logPrefix
std::string logPrefix() const override
Retrieve a string to be prefixed to the log message.
Definition: camera_sensor.cpp:1093
libcamera::CameraSensor::setTestPatternMode
int setTestPatternMode(controls::draft::TestPatternModeEnum mode)
Set the test pattern mode for the camera sensor.
Definition: camera_sensor.cpp:638
libcamera::CameraSensor::~CameraSensor
~CameraSensor()
Destroy a CameraSensor.
Definition: camera_sensor.cpp:66
libcamera::CameraSensor::sensorInfo
int sensorInfo(IPACameraSensorInfo *info) const
Assemble and return the camera sensor info.
Definition: camera_sensor.cpp:925
libcamera::CameraSensor::focusLens
CameraLens * focusLens()
Retrieve the focus lens controller.
Definition: camera_sensor.h:72
libcamera::MediaEntity
The MediaEntity represents an entity in the media graph.
Definition: media_object.h:89
libcamera::CameraSensor::mbusCodes
const std::vector< unsigned int > & mbusCodes() const
Retrieve the media bus codes supported by the camera sensor.
Definition: camera_sensor.h:46