DriveWorks SDK Reference

| 0.6.67 Release

SensorSerializer.h
Go to the documentation of this file.
1 // This code contains NVIDIA Confidential Information and is disclosed
3 // under the Mutual Non-Disclosure Agreement.
4 //
5 // Notice
6 // ALL NVIDIA DESIGN SPECIFICATIONS AND CODE ("MATERIALS") ARE PROVIDED "AS IS" NVIDIA MAKES
7 // NO REPRESENTATIONS, WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
8 // THE MATERIALS, AND EXPRESSLY DISCLAIMS ANY IMPLIED WARRANTIES OF NONINFRINGEMENT,
9 // MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
10 //
11 // NVIDIA Corporation assumes no responsibility for the consequences of use of such
12 // information or for any infringement of patents or other rights of third parties that may
13 // result from its use. No license is granted by implication or otherwise under any patent
14 // or patent rights of NVIDIA Corporation. No third party distribution is allowed unless
15 // expressly authorized by NVIDIA. Details are subject to change without notice.
16 // This code supersedes and replaces all information previously supplied.
17 // NVIDIA Corporation products are not authorized for use as critical
18 // components in life support devices or systems without express written approval of
19 // NVIDIA Corporation.
20 //
21 // Copyright (c) 2016 NVIDIA Corporation. All rights reserved.
22 //
23 // NVIDIA Corporation and its licensors retain all intellectual property and proprietary
24 // rights in and to this software and related documentation and any modifications thereto.
25 // Any use, reproduction, disclosure or distribution of this software and related
26 // documentation without an express license agreement from NVIDIA Corporation is
27 // strictly prohibited.
28 //
30 
46 #ifndef DW_SENSORS_SENSORSERIALIZER_H__
47 #define DW_SENSORS_SENSORSERIALIZER_H__
48 
49 #include <dw/core/Config.h>
50 #include <dw/core/Exports.h>
51 #include <dw/core/Types.h>
52 #include <dw/core/Context.h>
53 
54 #include <dw/sensors/Sensors.h>
56 
57 #ifdef __cplusplus
58 extern "C" {
59 #endif
60 
66 typedef void (*dwSensorSerializerOnDataFunc_t)(const uint8_t *data, size_t size, void *userData);
67 
69 typedef struct dwSensorSerializerObject *dwSensorSerializerHandle_t;
70 
73 typedef struct dwSerializerParams {
97  const char *parameters;
98 
101 
103  void *userData;
105 
127 dwStatus dwSensorSerializer_initialize(dwSensorSerializerHandle_t *serializer,
128  const dwSerializerParams *params, dwSensorHandle_t sensor);
129 
147 dwStatus dwSensorSerializer_release(dwSensorSerializerHandle_t *serializer);
148 
167 dwStatus dwSensorSerializer_attachTo(dwSensorSerializerHandle_t serializer,
168  dwSensorSerializerHandle_t masterSerializer);
169 
182 dwStatus dwSensorSerializer_isAttached(dwBool *isAttached, dwSensorSerializerHandle_t serializer);
183 
205 dwStatus dwSensorSerializer_detachFrom(dwSensorSerializerHandle_t serializer,
206  dwSensorSerializerHandle_t masterSerializer);
207 
223 dwStatus dwSensorSerializer_start(dwSensorSerializerHandle_t serializer);
224 
237 dwStatus dwSensorSerializer_stop(dwSensorSerializerHandle_t serializer);
238 
253 dwStatus dwSensorSerializer_serializeData(const uint8_t *data, size_t size,
254  dwSensorSerializerHandle_t serializer);
255 
272 dwStatus dwSensorSerializer_serializeDataAsync(const uint8_t *data, size_t size,
273  dwSensorSerializerHandle_t serializer);
274 
288 dwStatus
290  dwSensorSerializerHandle_t serializer);
291 
305  dwSensorSerializerHandle_t serializer);
306 
307 
308 #ifdef __cplusplus
309 }
310 #endif
311 
313 #endif // DW_SENSORS_SENSORSERIALIZER_H__
DW_API_PUBLIC dwStatus dwSensorSerializer_initialize(dwSensorSerializerHandle_t *serializer, const dwSerializerParams *params, dwSensorHandle_t sensor)
Initializes a sensor serializer with the parameters provided.
NVIDIA DriveWorks API: Core Types
const char * parameters
Array for additional parameters provided to sensor serializer creation.
struct dwSensorSerializerObject * dwSensorSerializerHandle_t
Handle representing a sensor serializer.
dwSensorSerializerOnDataFunc_t onData
Callback executed by the serializer on new data available.
NVIDIA DriveWorks API: Core Methods
Holds the parameters for sensor serializer creation.
DW_API_PUBLIC dwStatus dwSensorSerializer_release(dwSensorSerializerHandle_t *serializer)
Releases a sensor serializer.
void(* dwSensorSerializerOnDataFunc_t)(const uint8_t *data, size_t size, void *userData)
Callback type for getting data from sensor serializer.
DW_API_PUBLIC dwStatus dwSensorSerializer_detachFrom(dwSensorSerializerHandle_t serializer, dwSensorSerializerHandle_t masterSerializer)
This method detaches the serializer previously attached with dwSensorSerializer_attachTo().
DW_API_PUBLIC dwStatus dwSensorSerializer_start(dwSensorSerializerHandle_t serializer)
Starts serialization of sensor.
NVIDIA DriveWorks API: Core Exports
DW_API_PUBLIC dwStatus dwSensorSerializer_attachTo(dwSensorSerializerHandle_t serializer, dwSensorSerializerHandle_t masterSerializer)
Starts and stops serialization of a sensor with a master serializer.
struct dwSensorObject * dwSensorHandle_t
Handle representing a sensor.
Definition: Sensors.h:80
dwStatus
Status definition.
Definition: Status.h:167
NVIDIA DriveWorks API: Sensors
DW_API_PUBLIC dwStatus dwSensorSerializer_serializeCameraFrame(dwCameraFrameHandle_t frame, dwSensorSerializerHandle_t serializer)
Pushes a camera frame to the serializer.This method must only be used if dwSensorSerializer_start is ...
DW_API_PUBLIC dwStatus dwSensorSerializer_isAttached(dwBool *isAttached, dwSensorSerializerHandle_t serializer)
Query method to check whether the serializer is attached to another.
DW_API_PUBLIC dwStatus dwSensorSerializer_stop(dwSensorSerializerHandle_t serializer)
Starts serialization of sensor.
void * userData
User data to be passed to the callback.
DW_API_PUBLIC dwStatus dwSensorSerializer_serializeDataAsync(const uint8_t *data, size_t size, dwSensorSerializerHandle_t serializer)
Pushes data to the serializer.
DW_API_PUBLIC dwStatus dwSensorSerializer_serializeData(const uint8_t *data, size_t size, dwSensorSerializerHandle_t serializer)
Pushes data to the serializer.
uint8_t dwBool
Definition: Types.h:79
NVIDIA DriveWorks API: Cameras
struct dwCameraFrame * dwCameraFrameHandle_t
Handle to captured frame.
Definition: Camera.h:62
DW_API_PUBLIC dwStatus dwSensorSerializer_serializeCameraFrameAsync(dwCameraFrameHandle_t frame, dwSensorSerializerHandle_t serializer)
Pushes a camera frame to the serializer.
#define DW_API_PUBLIC
Definition: Exports.h:76