Libargus API
Libargus Camera API
Main Page
Related Pages
Modules
Namespaces
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Macros
Groups
Pages
include
Argus
Ext
SensorPrivateMetadataClientBuffer.h
Go to the documentation of this file.
1
/*
2
* Copyright (c) 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
29
/**
30
* @file
31
* <b>Libargus Extension: Sensor Private Metadata Client Buffer API</b>
32
*
33
* @b Description: This file defines the SensorPrivateMetadataClientBuffer extension.
34
*/
35
36
#ifndef _ARGUS_SENSOR_PRIVATE_METADATA_CLIENT_BUFFER_H
37
#define _ARGUS_SENSOR_PRIVATE_METADATA_CLIENT_BUFFER_H
38
39
namespace
Argus
40
{
41
/**
42
* Adds accessors for set client buffer for sensor embedded metadata. Sensor embeds private info
43
* (for example PDAF data) in sensor metadata. Client using Ext::SensorPrivateMetadata API
44
* to obtain this meta data involves several memcpy. When sensor metadata size is large,
45
* this will cause high CPU usage and affect camera performance.
46
* ISensorPrivateMetadataClientBufferRequest allow client to set a client buffer and Argus write
47
* to it directly without extra memcpy.
48
* This is only supported in single process mode as in client-server (multiprocess) mode, client
49
* and server are in different process and their own address space.
50
*
51
* - Ext::ISensorPrivateMetadataClientBufferRequest: Sets client buffer for private metadata.
52
*
53
* @defgroup ArgusExtSensorPrivateMetadataClientBuffer Ext::SensorPrivateMetadataClientBuffer
54
* @ingroup ArgusExtensions
55
*/
56
DEFINE_UUID
(ExtensionName, EXT_SENSOR_PRIVATE_METADATA_CLIENT_BUFFER, 85cbb9b6,cd7f,4e8c,9462,9f,21,cd,a7,40,1c);
57
58
namespace
Ext
59
{
60
61
/**
62
* @class ISensorPrivateMetadataClientBufferRequest
63
*
64
* Interface used to set client buffer for sensor private metadata for a request
65
*
66
* @ingroup ArgusRequest ArgusExtSensorPrivateMetadataClientBuffer
67
*/
68
DEFINE_UUID
(InterfaceID, IID_SENSOR_PRIVATE_METADATA_CLIENT_BUFFER_REQUEST, 5c868b69,42f5,4ec9,9b93,44,11,c9,6c,02,e4);
69
class
ISensorPrivateMetadataClientBufferRequest
:
public
Interface
70
{
71
public
:
72
static
const
InterfaceID
&
id
() {
return
IID_SENSOR_PRIVATE_METADATA_CLIENT_BUFFER_REQUEST; }
73
74
/**
75
* Client allocate the metadata buffer and set the address of the buffer,
76
* Argus writes the sensor metadata directly to the buffer.
77
* This method is supported only in single process mode.
78
* @param[in] buf Specifies the address of client buffer.
79
* @param[in] size Specifies the size in bytes of the metadata buffer.
80
*/
81
virtual
Status
setClientMetadataBuffer
(
void
* buf,
size_t
size) = 0;
82
83
/**
84
* Returns if client metadata buffer is used for this request.
85
*/
86
virtual
bool
getClientMetadataBufferEnable
()
const
= 0;
87
88
protected
:
89
~ISensorPrivateMetadataClientBufferRequest
() {}
90
};
91
92
}
// namespace Ext
93
94
}
// namespace Argus
95
96
#endif // _ARGUS_SENSOR_PRIVATE_METADATA_CLIENT_BUFFER_H
Generated on Tue Mar 14 2023 14:59:53 for Libargus API by
1.8.1