Multimedia API Reference

November 16, 2016 | 24.2.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, 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 
37 #ifndef _ARGUS_CAMERA_DEVICE_H
38 #define _ARGUS_CAMERA_DEVICE_H
39 
53 namespace Argus
54 {
55 
66 {
67 protected:
69 };
70 
76 DEFINE_UUID(InterfaceID, IID_CAMERA_PROPERTIES, 436d2a73,c85b,4a29,bce5,15,60,6e,35,86,91);
77 
79 {
80 public:
81  static const InterfaceID& id() { return IID_CAMERA_PROPERTIES; }
82 
87  virtual UUID getUUID() const = 0;
88 
95  virtual uint32_t getMaxAeRegions() const = 0;
96 
103  virtual uint32_t getMaxAwbRegions() const = 0;
104 
111  virtual Status getSensorModes(std::vector<SensorMode*>* modes) const = 0;
112 
117  virtual Range<int32_t> getFocusPositionRange() const = 0;
118 
122  virtual Range<float> getLensApertureRange() const = 0;
123 
124 protected:
126 };
127 
134 {
135 protected:
137 };
138 
144 DEFINE_UUID(InterfaceID, IID_SENSOR_MODE, e69015e0,db2a,11e5,a837,18,00,20,0c,9a,66);
145 
146 class ISensorMode : public Interface
147 {
148 public:
149  static const InterfaceID& id() { return IID_SENSOR_MODE; }
150 
154  virtual Size getResolution() const = 0;
155 
159  virtual Range<uint64_t> getExposureTimeRange() const = 0;
160 
164  virtual Range<uint64_t> getFrameDurationRange() const = 0;
165 
169  virtual Range<float> getAnalogGainRange() const = 0;
170 
176  virtual uint32_t getInputBitDepth() const = 0;
177 
186  virtual uint32_t getOutputBitDepth() const = 0;
187 
194  virtual SensorModeType getSensorModeType() const = 0;
195 
196 
197 
198 protected:
200 };
201 
202 } // namespace Argus
204 #endif // _ARGUS_CAMERA_DEVICE_H
virtual Range< float > getAnalogGainRange() const =0
Returns the supported analog gain range.
The base interface for a class that provides libargus interfaces.
Definition: Types.h:343
static const InterfaceID & id()
Definition: CameraDevice.h:81
Status
Status values returned by API function calls.
Definition: Types.h:220
virtual UUID getUUID() const =0
Returns the camera UUID.
The top-level interface class.
Definition: Types.h:312
UUID.
Definition: UUID.h:60
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).
A templatized class to hold a min/max range of values.
Definition: Types.h:462
An interface to retrieve the properties of a SensorMode.
Definition: CameraDevice.h:146
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:149
DEFINE_UUID(ExtensionName, EXT_BAYER_SHARPNESS_MAP, 7d5e0470, 4ea6, 11e6, bdf4, 08, 00, 20, 0c, 9a, 66)
The Ext::BayerSharpnessMap extension adds internally-generated sharpness metrics to CaptureMetadata r...
An object representing the sensor mode of a CameraDevice.
Definition: CameraDevice.h:133
virtual Size getResolution() const =0
Returns the image resolution, in pixels.
virtual Range< int32_t > getFocusPositionRange() const =0
Returns the valid range of focuser positions.
virtual Status getSensorModes(std::vector< SensorMode * > *modes) const =0
Returns the available sensor modes.
Contains an object representing a single camera device.
Definition: CameraDevice.h:65
virtual uint32_t getMaxAwbRegions() const =0
Returns the maximum number of regions of interest supported by AWB.
A unique identifier for an libargus Interface.
Definition: Types.h:322
Aggregates width and height in a single structure.
Definition: Types.h:505
An interface to retrieve the properties of a CameraDevice.
Definition: CameraDevice.h:78
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.