L4T Multimedia API Reference

31.1 Release

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
CameraDevice.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016-2017, 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 
77  virtual UUID getUUID() const = 0;
78 
85  virtual uint32_t getMaxAeRegions() const = 0;
86 
93  virtual uint32_t getMaxAwbRegions() const = 0;
94 
103  virtual Status getBasicSensorModes(std::vector<SensorMode*>* modes) const = 0;
104 
116  virtual Status getAllSensorModes(std::vector<SensorMode*>* modes) const = 0;
117 
122  virtual Range<int32_t> getFocusPositionRange() const = 0;
123 
127  virtual Range<float> getLensApertureRange() const = 0;
128 
132  virtual Range<float> getIspDigitalGainRange() const = 0;
133 
137  virtual Range<float> getExposureCompensationRange() const = 0;
138 
139 protected:
141 };
142 
151 {
152 protected:
154 };
155 
163 DEFINE_UUID(InterfaceID, IID_SENSOR_MODE, e69015e0,db2a,11e5,a837,18,00,20,0c,9a,66);
164 class ISensorMode : public Interface
165 {
166 public:
167  static const InterfaceID& id() { return IID_SENSOR_MODE; }
168 
172  virtual Size2D<uint32_t> getResolution() const = 0;
173 
177  virtual Range<uint64_t> getExposureTimeRange() const = 0;
178 
182  virtual Range<uint64_t> getFrameDurationRange() const = 0;
183 
187  virtual Range<float> getAnalogGainRange() const = 0;
188 
194  virtual uint32_t getInputBitDepth() const = 0;
195 
204  virtual uint32_t getOutputBitDepth() const = 0;
205 
211  virtual SensorModeType getSensorModeType() const = 0;
212 
216  virtual bool isBufferFormatSupported(Buffer* buffer) const = 0;
217 protected:
219 };
220 
221 } // namespace Argus
222 
223 #endif // _ARGUS_CAMERA_DEVICE_H
virtual Range< float > getAnalogGainRange() const =0
Returns the supported analog gain range.
virtual Status getBasicSensorModes(std::vector< SensorMode * > *modes) const =0
Returns only the basic available sensor modes that do not have an associated extension.
The base interface for a class that provides libargus Interfaces.
Definition: Types.h:321
DEFINE_UUID(ExtensionName, EXT_BAYER_AVERAGE_MAP, 12c3de20, 64c5, 11e6, bdf4, 08, 00, 20, 0c, 9a, 66)
static const InterfaceID & id()
Definition: CameraDevice.h:71
virtual Status getAllSensorModes(std::vector< SensorMode * > *modes) const =0
Returns all the available sensor modes including the ones that have extensions.
Status
Status values returned by API function calls.
Definition: Types.h:93
virtual bool isBufferFormatSupported(Buffer *buffer) const =0
Checks if the buffer provided is supported by the camera device.
virtual UUID getUUID() const =0
Returns the camera UUID.
The top-level interface class.
Definition: Types.h:290
virtual Range< float > getIspDigitalGainRange() const =0
Returns the supported range of ISP digital gain.
A universally unique identifier.
Definition: UUID.h:50
virtual uint32_t getOutputBitDepth() const =0
Returns the bit depth of the image returned from the image sensor in the current mode.
virtual uint32_t getInputBitDepth() const =0
Returns the bit depth of the image captured by the image sensor in the current mode.
virtual Range< uint64_t > getExposureTimeRange() const =0
Returns the supported exposure time range (in nanoseconds).
Interface to the core properties of a SensorMode.
Definition: CameraDevice.h:164
virtual SensorModeType getSensorModeType() const =0
Describes the type of the sensor (Bayer, Yuv, etc.) and key modes of operation which are enabled in t...
virtual Range< uint64_t > getFrameDurationRange() const =0
Returns the supported frame duration range (in nanoseconds).
static const InterfaceID & id()
Definition: CameraDevice.h:167
virtual Size2D< uint32_t > getResolution() const =0
Returns the image resolution, in pixels.
virtual Range< int32_t > getFocusPositionRange() const =0
Returns the valid range of focuser positions.
virtual uint32_t getMaxAwbRegions() const =0
Returns the maximum number of regions of interest supported by AWB.
Range template class.
Definition: Types.h:710
A unique identifier for a libargus Interface.
Definition: Types.h:300
Interface to the core CameraDevice properties.
Definition: CameraDevice.h:68
virtual Range< float > getExposureCompensationRange() const =0
Returns the supported range of Exposure Compensation.
virtual uint32_t getMaxAeRegions() const =0
Returns the maximum number of regions of interest supported by AE.
virtual Range< float > getLensApertureRange() const =0
Returns the supported aperture range.