Jetson Linux API Reference

32.7.3 Release
SensorPrivateMetadata.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_SENSOR_PRIVATE_METADATA_H
37 #define _ARGUS_SENSOR_PRIVATE_METADATA_H
38 
39 namespace Argus
40 {
54 DEFINE_UUID(ExtensionName, EXT_SENSOR_PRIVATE_METADATA, 7acf4352,3a75,46e7,9af1,8d,71,da,83,15,23);
55 
56 namespace Ext
57 {
58 
66 DEFINE_UUID(InterfaceID, IID_SENSOR_PRIVATE_METADATA_CAPS, e492d2bf,5285,476e,94c5,ee,64,d5,3d,94,ef);
68 {
69 public:
70  static const InterfaceID& id() { return IID_SENSOR_PRIVATE_METADATA_CAPS; }
71 
75  virtual size_t getMetadataSize() const = 0;
76 
77 protected:
79 };
80 
88 DEFINE_UUID(InterfaceID, IID_SENSOR_PRIVATE_METADATA_REQUEST, 5c868b69,42f5,4ec9,9b93,44,11,c9,6c,02,e3);
90 {
91 public:
92  static const InterfaceID& id() { return IID_SENSOR_PRIVATE_METADATA_REQUEST; }
93 
98  virtual void setMetadataEnable(bool enable) = 0;
99 
103  virtual bool getMetadataEnable() const = 0;
104 
105 protected:
107 };
108 
116 DEFINE_UUID(InterfaceID, IID_SENSOR_PRIVATE_METADATA, 68cf6680,70d7,4b52,9a99,33,fb,65,81,a2,61);
118 {
119 public:
120  static const InterfaceID& id() { return IID_SENSOR_PRIVATE_METADATA; }
121 
125  virtual size_t getMetadataSize() const = 0;
126 
135  virtual Status getMetadata(void *dst, size_t size) const = 0;
136 
137 protected:
139 };
140 
141 } // namespace Ext
142 
143 } // namespace Argus
144 
145 #endif // _ARGUS_SENSOR_PRIVATE_METADATA_H
Argus::DEFINE_UUID
DEFINE_UUID(ExtensionName, EXT_BAYER_AVERAGE_MAP, 12c3de20, 64c5, 11e6, bdf4, 08, 00, 20, 0c, 9a, 66)
Argus::Ext::ISensorPrivateMetadataRequest
Definition: SensorPrivateMetadata.h:89
Argus::Ext::ISensorPrivateMetadata
Definition: SensorPrivateMetadata.h:117
Argus
Definition: BayerAverageMap.h:39
Argus::Interface
The top-level interface class.
Definition: Types.h:327
Argus::Ext::ISensorPrivateMetadataRequest::setMetadataEnable
virtual void setMetadataEnable(bool enable)=0
Enables the sensor private metadata, will only work if the sensor supports embedded metadata.
Argus::InterfaceID
A unique identifier for a libargus Interface.
Definition: Types.h:337
Argus::Ext::ISensorPrivateMetadataCaps
Definition: SensorPrivateMetadata.h:67
Argus::Ext::ISensorPrivateMetadata::id
static const InterfaceID & id()
Definition: SensorPrivateMetadata.h:120
Argus::Ext::ISensorPrivateMetadataRequest::~ISensorPrivateMetadataRequest
~ISensorPrivateMetadataRequest()
Definition: SensorPrivateMetadata.h:106
Argus::Ext::ISensorPrivateMetadata::~ISensorPrivateMetadata
~ISensorPrivateMetadata()
Definition: SensorPrivateMetadata.h:138
Argus::Ext::ISensorPrivateMetadata::getMetadata
virtual Status getMetadata(void *dst, size_t size) const =0
Copies back the metadata to the provided memory location.
Argus::Ext::ISensorPrivateMetadataCaps::~ISensorPrivateMetadataCaps
~ISensorPrivateMetadataCaps()
Definition: SensorPrivateMetadata.h:78
Argus::Ext::DEFINE_UUID
DEFINE_UUID(InterfaceID, IID_BAYER_AVERAGE_MAP_SETTINGS, 12c3de21, 64c5, 11e6, bdf4, 08, 00, 20, 0c, 9a, 66)
Argus::Ext::ISensorPrivateMetadataCaps::getMetadataSize
virtual size_t getMetadataSize() const =0
Returns the size in bytes of the private metadata.
Argus::Ext::ISensorPrivateMetadataRequest::getMetadataEnable
virtual bool getMetadataEnable() const =0
Returns if the metadata is enabled for this request.
Argus::Ext::ISensorPrivateMetadata::getMetadataSize
virtual size_t getMetadataSize() const =0
Returns the size of the embedded metadata.
Argus::Status
Status
Status values returned by API function calls.
Definition: Types.h:93
Argus::Ext::ISensorPrivateMetadataRequest::id
static const InterfaceID & id()
Definition: SensorPrivateMetadata.h:92
Argus::Ext::ISensorPrivateMetadataCaps::id
static const InterfaceID & id()
Definition: SensorPrivateMetadata.h:70