Jetson Linux API Reference

35.5.0 Release
CameraDevice.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016-2020, NVIDIA CORPORATION. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * * Redistributions of source code must retain the above copyright
8  * notice, this list of conditions and the following disclaimer.
9  * * Redistributions in binary form must reproduce the above copyright
10  * notice, this list of conditions and the following disclaimer in the
11  * documentation and/or other materials provided with the distribution.
12  * * Neither the name of NVIDIA CORPORATION nor the names of its
13  * contributors may be used to endorse or promote products derived
14  * from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
20  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
21  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
22  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
23  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
24  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28 
36 #ifndef _ARGUS_CAMERA_DEVICE_H
37 #define _ARGUS_CAMERA_DEVICE_H
38 
39 namespace Argus
40 {
41 
55 {
56 protected:
58 };
59 
67 DEFINE_UUID(InterfaceID, IID_CAMERA_PROPERTIES, 436d2a73,c85b,4a29,bce5,15,60,6e,35,86,91);
69 {
70 public:
71  static const InterfaceID& id() { return IID_CAMERA_PROPERTIES; }
72 
79  virtual UUID getUUID() const = 0;
80 
84  virtual SensorPlacement getSensorPlacement() const = 0;
85 
92  virtual uint32_t getMaxAeRegions() const = 0;
93 
99  virtual Size2D<uint32_t> getMinAeRegionSize() const = 0;
100 
107  virtual uint32_t getMaxAwbRegions() const = 0;
108 
115  virtual uint32_t getMaxAfRegions() const = 0;
116 
125  virtual Status getBasicSensorModes(std::vector<SensorMode*>* modes) const = 0;
126 
138  virtual Status getAllSensorModes(std::vector<SensorMode*>* modes) const = 0;
139 
147  virtual Status getAperturePositions(std::vector<int32_t>* positions) const = 0;
148 
157  virtual Status getAvailableApertureFNumbers(std::vector<float>* fnumbers) const = 0;
158 
163  virtual Range<int32_t> getFocusPositionRange() const = 0;
164 
169  virtual Range<int32_t> getAperturePositionRange() const = 0;
170 
175  virtual Range<float> getApertureMotorSpeedRange() const = 0;
176 
180  virtual Range<float> getIspDigitalGainRange() const = 0;
181 
185  virtual Range<float> getExposureCompensationRange() const = 0;
186 
190  virtual const std::string& getModelName() const = 0;
191 
197  virtual const std::string& getModuleString() const = 0;
198 
199 protected:
201 };
202 
211 {
212 protected:
214 };
215 
223 DEFINE_UUID(InterfaceID, IID_SENSOR_MODE, e69015e0,db2a,11e5,a837,18,00,20,0c,9a,66);
224 class ISensorMode : public Interface
225 {
226 public:
227  static const InterfaceID& id() { return IID_SENSOR_MODE; }
228 
232  virtual Size2D<uint32_t> getResolution() const = 0;
233 
237  virtual Range<uint64_t> getExposureTimeRange() const = 0;
238 
246  virtual Range<float> getHdrRatioRange() const = 0;
247 
251  virtual Range<uint64_t> getFrameDurationRange() const = 0;
252 
256  virtual Range<float> getAnalogGainRange() const = 0;
257 
263  virtual uint32_t getInputBitDepth() const = 0;
264 
273  virtual uint32_t getOutputBitDepth() const = 0;
274 
280  virtual SensorModeType getSensorModeType() const = 0;
281 
285  virtual BayerPhase getBayerPhase() const = 0;
286 
290  virtual bool isBufferFormatSupported(Buffer* buffer) const = 0;
291 protected:
293 };
294 
295 } // namespace Argus
296 
297 #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:292
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:71
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:351
Argus::ICameraProperties::~ICameraProperties
~ICameraProperties()
Definition: CameraDevice.h:200
Argus::Range
Range template class.
Definition: Types.h:803
Argus::InterfaceID
A unique identifier for a libargus Interface.
Definition: Types.h:361
Argus::ISensorMode::getBayerPhase
virtual BayerPhase getBayerPhase() const =0
Describes the bayer phase of Bayer mode.
Argus::ICameraProperties
Definition: CameraDevice.h:68
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:57
Argus::InterfaceProvider
The base interface for a class that provides libargus Interfaces.
Definition: Types.h:382
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:50
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:213
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::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:54
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:227
Argus::ISensorMode
Definition: CameraDevice.h:224
Argus::Status
Status
Status values returned by API function calls.
Definition: Types.h:97
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:210
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).