Jetson Linux API Reference

38.2 Release
CameraDevice.h
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2016-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3  * SPDX-License-Identifier: LicenseRef-NvidiaProprietary
4  *
5  * NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
6  * property and proprietary rights in and to this material, related
7  * documentation and any modifications thereto. Any use, reproduction,
8  * disclosure or distribution of this material and related documentation
9  * without an express license agreement from NVIDIA CORPORATION or
10  * its affiliates is strictly prohibited.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * * Redistributions of source code must retain the above copyright
16  * notice, this list of conditions and the following disclaimer.
17  * * Redistributions in binary form must reproduce the above copyright
18  * notice, this list of conditions and the following disclaimer in the
19  * documentation and/or other materials provided with the distribution.
20  * * Neither the name of NVIDIA CORPORATION nor the names of its
21  * contributors may be used to endorse or promote products derived
22  * from this software without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
25  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
27  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
28  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
29  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
30  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
31  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
32  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35  */
36 
44 #ifndef _ARGUS_CAMERA_DEVICE_H
45 #define _ARGUS_CAMERA_DEVICE_H
46 
47 namespace Argus
48 {
49 
63 {
64 protected:
66 };
67 
75 DEFINE_UUID(InterfaceID, IID_CAMERA_PROPERTIES, 436d2a73,c85b,4a29,bce5,15,60,6e,35,86,91);
77 {
78 public:
79  static const InterfaceID& id() { return IID_CAMERA_PROPERTIES; }
80 
87  virtual UUID getUUID() const = 0;
88 
92  virtual SensorPlacement getSensorPlacement() const = 0;
93 
100  virtual uint32_t getMaxAeRegions() const = 0;
101 
107  virtual Size2D<uint32_t> getMinAeRegionSize() const = 0;
108 
115  virtual uint32_t getMaxAwbRegions() const = 0;
116 
123  virtual uint32_t getMaxAfRegions() const = 0;
124 
133  virtual Status getBasicSensorModes(std::vector<SensorMode*>* modes) const = 0;
134 
146  virtual Status getAllSensorModes(std::vector<SensorMode*>* modes) const = 0;
147 
155  virtual Status getAperturePositions(std::vector<int32_t>* positions) const = 0;
156 
165  virtual Status getAvailableApertureFNumbers(std::vector<float>* fnumbers) const = 0;
166 
171  virtual Range<int32_t> getFocusPositionRange() const = 0;
172 
177  virtual Range<int32_t> getAperturePositionRange() const = 0;
178 
183  virtual Range<float> getApertureMotorSpeedRange() const = 0;
184 
188  virtual Range<float> getIspDigitalGainRange() const = 0;
189 
193  virtual Range<float> getExposureCompensationRange() const = 0;
194 
198  virtual const std::string& getModelName() const = 0;
199 
205  virtual const std::string& getModuleString() const = 0;
206 
207 protected:
209 };
210 
219 {
220 protected:
222 };
223 
231 DEFINE_UUID(InterfaceID, IID_SENSOR_MODE, e69015e0,db2a,11e5,a837,18,00,20,0c,9a,66);
232 class ISensorMode : public Interface
233 {
234 public:
235  static const InterfaceID& id() { return IID_SENSOR_MODE; }
236 
240  virtual Size2D<uint32_t> getResolution() const = 0;
241 
245  virtual Rectangle<uint32_t> getCrop() const = 0;
246 
250  virtual float getBinningFactor() const = 0;
251 
255  virtual Range<uint64_t> getExposureTimeRange() const = 0;
256 
264  virtual Range<float> getHdrRatioRange() const = 0;
265 
269  virtual Range<uint64_t> getFrameDurationRange() const = 0;
270 
274  virtual Range<float> getAnalogGainRange() const = 0;
275 
281  virtual uint32_t getInputBitDepth() const = 0;
282 
291  virtual uint32_t getOutputBitDepth() const = 0;
292 
298  virtual SensorModeType getSensorModeType() const = 0;
299 
303  virtual BayerPhase getBayerPhase() const = 0;
304 
308  virtual bool isBufferFormatSupported(Buffer* buffer) const = 0;
309 protected:
311 };
312 
313 } // namespace Argus
314 
315 #endif // _ARGUS_CAMERA_DEVICE_H
Argus::ICameraProperties::getAllSensorModes
virtual Status getAllSensorModes(std::vector< SensorMode * > *modes) const =0
Returns all the available sensor modes including the ones that have extensions.
Argus::ISensorMode::~ISensorMode
~ISensorMode()
Definition: CameraDevice.h:310
Argus::ICameraProperties::getModelName
virtual const std::string & getModelName() const =0
Returns the model name of the device.
Argus::ICameraProperties::getAvailableApertureFNumbers
virtual Status getAvailableApertureFNumbers(std::vector< float > *fnumbers) const =0
Returns all the available aperture f-numbers.
Argus::ICameraProperties::id
static const InterfaceID & id()
Definition: CameraDevice.h:79
Argus::DEFINE_UUID
DEFINE_UUID(ExtensionName, EXT_BAYER_AVERAGE_MAP, 12c3de20, 64c5, 11e6, bdf4, 08, 00, 20, 0c, 9a, 66)
Argus::ICameraProperties::getBasicSensorModes
virtual Status getBasicSensorModes(std::vector< SensorMode * > *modes) const =0
Returns only the basic available sensor modes that do not have an associated extension.
Argus::ISensorMode::getInputBitDepth
virtual uint32_t getInputBitDepth() const =0
Returns the bit depth of the image captured by the image sensor in the current mode.
Argus
Definition: BayerAverageMap.h:39
Argus::ICameraProperties::getIspDigitalGainRange
virtual Range< float > getIspDigitalGainRange() const =0
Returns the supported range of ISP digital gain.
Argus::ICameraProperties::getUUID
virtual UUID getUUID() const =0
Returns the camera UUID.
Argus::Size2D< uint32_t >
Argus::ISensorMode::getResolution
virtual Size2D< uint32_t > getResolution() const =0
Returns the image resolution, in pixels.
Argus::ICameraProperties::getMinAeRegionSize
virtual Size2D< uint32_t > getMinAeRegionSize() const =0
Returns the minimum size of resultant region required by AE.
Argus::Interface
The top-level interface class.
Definition: Types.h:374
Argus::ICameraProperties::~ICameraProperties
~ICameraProperties()
Definition: CameraDevice.h:208
Argus::Range
Range template class.
Definition: Types.h:826
Argus::Rectangle< uint32_t >
Argus::InterfaceID
A unique identifier for a libargus Interface.
Definition: Types.h:384
Argus::ISensorMode::getCrop
virtual Rectangle< uint32_t > getCrop() const =0
Returns the sensor crop region.
Argus::ISensorMode::getBayerPhase
virtual BayerPhase getBayerPhase() const =0
Describes the bayer phase of Bayer mode.
Argus::ICameraProperties
Definition: CameraDevice.h:76
Argus::ISensorMode::getOutputBitDepth
virtual uint32_t getOutputBitDepth() const =0
Returns the bit depth of the image returned from the image sensor in the current mode.
Argus::CameraDevice::~CameraDevice
~CameraDevice()
Definition: CameraDevice.h:65
Argus::InterfaceProvider
The base interface for a class that provides libargus Interfaces.
Definition: Types.h:405
Argus::ICameraProperties::getApertureMotorSpeedRange
virtual Range< float > getApertureMotorSpeedRange() const =0
Returns the valid range of aperture step positions per second.
Argus::UUID
A universally unique identifier.
Definition: UUID.h:51
Argus::ICameraProperties::getMaxAfRegions
virtual uint32_t getMaxAfRegions() const =0
Returns the maximum number of regions of interest supported by AF.
Argus::ISensorMode::getFrameDurationRange
virtual Range< uint64_t > getFrameDurationRange() const =0
Returns the supported frame duration range (in nanoseconds).
Argus::ICameraProperties::getFocusPositionRange
virtual Range< int32_t > getFocusPositionRange() const =0
Returns the valid range of focuser positions.
Argus::SensorMode::~SensorMode
~SensorMode()
Definition: CameraDevice.h:221
Argus::ISensorMode::isBufferFormatSupported
virtual bool isBufferFormatSupported(Buffer *buffer) const =0
Checks if the buffer provided is supported by the camera device.
Argus::ICameraProperties::getMaxAwbRegions
virtual uint32_t getMaxAwbRegions() const =0
Returns the maximum number of regions of interest supported by AWB.
Argus::ISensorMode::getBinningFactor
virtual float getBinningFactor() const =0
Returns the binning factor.
Argus::ICameraProperties::getAperturePositions
virtual Status getAperturePositions(std::vector< int32_t > *positions) const =0
Returns all the recommended aperture positions.
Argus::ISensorMode::getSensorModeType
virtual SensorModeType getSensorModeType() const =0
Describes the type of the sensor (Bayer, Yuv, etc.) and key modes of operation which are enabled in t...
Argus::Buffer
Definition: BufferStream.h:123
Argus::ICameraProperties::getExposureCompensationRange
virtual Range< float > getExposureCompensationRange() const =0
Returns the supported range of Exposure Compensation.
Argus::CameraDevice
Definition: CameraDevice.h:62
Argus::ICameraProperties::getModuleString
virtual const std::string & getModuleString() const =0
Returns the module string for the device.
Argus::ICameraProperties::getMaxAeRegions
virtual uint32_t getMaxAeRegions() const =0
Returns the maximum number of regions of interest supported by AE.
Argus::ICameraProperties::getAperturePositionRange
virtual Range< int32_t > getAperturePositionRange() const =0
Returns the valid range of aperture positions.
Argus::ISensorMode::id
static const InterfaceID & id()
Definition: CameraDevice.h:235
Argus::ISensorMode
Definition: CameraDevice.h:232
Argus::Status
Status
Status values returned by API function calls.
Definition: Types.h:98
Argus::ISensorMode::getHdrRatioRange
virtual Range< float > getHdrRatioRange() const =0
Returns the hdr ratio range, it is the ratio of long exposure vs short exposure.
Argus::ISensorMode::getAnalogGainRange
virtual Range< float > getAnalogGainRange() const =0
Returns the supported analog gain range.
Argus::SensorMode
Definition: CameraDevice.h:218
Argus::ICameraProperties::getSensorPlacement
virtual SensorPlacement getSensorPlacement() const =0
Returns the camera sensor placement position on the module.
Argus::ISensorMode::getExposureTimeRange
virtual Range< uint64_t > getExposureTimeRange() const =0
Returns the supported exposure time range (in nanoseconds).