Libargus API
Libargus Camera API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
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 
29 /**
30  * @file
31  * <b>Libargus Extension: Sensor Private Metadata API</b>
32  *
33  * @b Description: This file defines the SensorPrivateMetadata extension.
34  */
35 
36 #ifndef _ARGUS_SENSOR_PRIVATE_METADATA_H
37 #define _ARGUS_SENSOR_PRIVATE_METADATA_H
38 
39 namespace Argus
40 {
41 /**
42  * Adds accessors for sensor embedded metadata. This data is metadata that the sensor embeds
43  * inside the frame, the type and formating of which depends on the sensor. It is up to the
44  * user to correctly parse the data based on the specifics of the sensor used.
45  *
46  * - Ext::ISensorPrivateMetadataCaps: Determines whether a device is capable of
47  * private metadata output.
48  * - Ext::ISensorPrivateMetadataRequest: Enables private metadata output from a capture request.
49  * - Ext::ISensorPrivateMetadata: Accesses the sensor private metadata.
50  *
51  * @defgroup ArgusExtSensorPrivateMetadata Ext::SensorPrivateMetadata
52  * @ingroup ArgusExtensions
53  */
54 DEFINE_UUID(ExtensionName, EXT_SENSOR_PRIVATE_METADATA, 7acf4352,3a75,46e7,9af1,8d,71,da,83,15,23);
55 
56 namespace Ext
57 {
58 
59 /**
60  * @class ISensorPrivateMetadataCaps
61  *
62  * Interface used to query the availability and size in bytes of sensor private metadata.
63  *
64  * @ingroup ArgusCameraDevice ArgusExtSensorPrivateMetadata
65  */
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 
72  /**
73  * Returns the size in bytes of the private metadata.
74  */
75  virtual size_t getMetadataSize() const = 0;
76 
77 protected:
79 };
80 
81 /**
82  * @class ISensorPrivateMetadataRequest
83  *
84  * Interface used enable the output of sensor private metadata for a request.
85  *
86  * @ingroup ArgusRequest ArgusExtSensorPrivateMetadata
87  */
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 
94  /**
95  * Enables the sensor private metadata, will only work if the sensor supports embedded metadata.
96  * @param[in] enable whether to output embedded metadata.
97  */
98  virtual void setMetadataEnable(bool enable) = 0;
99 
100  /**
101  * Returns if the metadata is enabled for this request.
102  */
103  virtual bool getMetadataEnable() const = 0;
104 
105 protected:
107 };
108 
109 /**
110  * @class ISensorPrivateMetadata
111  *
112  * Interface used to access sensor private metadata.
113  *
114  * @ingroup ArgusCaptureMetadata ArgusExtSensorPrivateMetadata
115  */
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 
122  /**
123  * Returns the size of the embedded metadata.
124  */
125  virtual size_t getMetadataSize() const = 0;
126 
127  /**
128  * Copies back the metadata to the provided memory location.
129  * If the size of @a dst is smaller than the total size of the metadata, only the first
130  * bytes up to size are copied.
131  * @param [in,out] dst The pointer to the location where the data will be copied.
132  * The caller is responsible for allocating and managing the memory.
133  * @param [in] size The size of the destination.
134  */
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