DriveWorks SDK Reference
4.0.0 Release
For Test and Development only

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) 2021 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 
47 #ifndef DW_SENSORS_CODECS_SENSORSERIALIZER_SENSORSERIALIZER_H_
48 #define DW_SENSORS_CODECS_SENSORSERIALIZER_SENSORSERIALIZER_H_
49 
50 #include <dw/core/Config.h>
51 #include <dw/core/base/Exports.h>
52 #include <dw/core/base/Types.h>
54 
55 #include <dw/sensors/Sensors.h>
57 
58 #include <dw/sensors/CodecHeader.h>
60 
62 
63 #ifdef __cplusplus
64 extern "C" {
65 #endif
66 
68 typedef struct dwSensorSerializerNewObject* dwSensorSerializerNewHandle_t;
69 
83 dwStatus dwSensorSerializerNew_initialize(dwSensorSerializerNewHandle_t* const serializer,
84  dwCodecHeaderHandle_t const codecHeader,
85  dwSerializerParams const* const serializerConfig,
86  dwContextHandle_t context);
87 
99 dwStatus dwSensorSerializerNew_release(dwSensorSerializerNewHandle_t const serializer);
100 
115 dwStatus dwSensorSerializerNew_serializeData(uint8_t const* const data, size_t size, dwTime_t timestamp,
116  dwSensorSerializerNewHandle_t const serializer);
117 
136 dwStatus dwSensorSerializerNew_serializeDataAsync(uint8_t const* const data, size_t size, dwTime_t timestamp,
137  dwSensorSerializerNewHandle_t const serializer);
138 
152  dwSensorSerializerNewHandle_t const serializer);
153 
167  dwSensorSerializerNewHandle_t const serializer);
168 
184 dwStatus dwSensorSerializerNew_start(dwSensorSerializerNewHandle_t const serializer);
185 
198 dwStatus dwSensorSerializerNew_stop(dwSensorSerializerNewHandle_t const serializer);
199 
200 #ifdef __cplusplus
201 }
202 #endif
203 
205 #endif // DW_SENSORS_CODECS_SENSORSERIALIZER_SENSORSERIALIZER_H_
NVIDIA DriveWorks API: Core Types
DW_API_PUBLIC dwStatus dwSensorSerializerNew_serializeCameraFrame(dwCameraFrameHandle_t const frame, dwSensorSerializerNewHandle_t const serializer)
Pushes a camera frame to the serializer.
struct dwCodecHeaderObject * dwCodecHeaderHandle_t
CodecHeader handle.
Definition: CodecHeader.h:60
NVIDIA DriveWorks API: Cameras
DW_API_PUBLIC dwStatus dwSensorSerializerNew_stop(dwSensorSerializerNewHandle_t const serializer)
Starts serialization of sensor.
NVIDIA DriveWorks API: Sensor Serializer
DW_API_PUBLIC dwStatus dwSensorSerializerNew_start(dwSensorSerializerNewHandle_t const serializer)
Starts serialization of sensor.
DW_API_PUBLIC dwStatus dwSensorSerializerNew_serializeCameraFrameAsync(dwCameraFrameHandle_t const frame, dwSensorSerializerNewHandle_t const serializer)
Pushes a camera frame to the serializer.
Holds the parameters for sensor serializer creation.
NVIDIA DriveWorks API: CodecHeader Method
DW_API_PUBLIC dwStatus dwSensorSerializerNew_release(dwSensorSerializerNewHandle_t const serializer)
Releases a sensor serializer.
struct dwSensorSerializerNewObject * dwSensorSerializerNewHandle_t
Handle representing a sensor serializer.
dwStatus
Status definition.
Definition: Status.h:180
NVIDIA DriveWorks API: Sensors
DW_API_PUBLIC dwStatus dwSensorSerializerNew_initialize(dwSensorSerializerNewHandle_t *const serializer, dwCodecHeaderHandle_t const codecHeader, dwSerializerParams const *const serializerConfig, dwContextHandle_t context)
Initializes a sensor serializer with the parameters provided.
int64_t dwTime_t
Specifies a timestamp unit, in microseconds.
Definition: Types.h:82
DW_API_PUBLIC dwStatus dwSensorSerializerNew_serializeDataAsync(uint8_t const *const data, size_t size, dwTime_t timestamp, dwSensorSerializerNewHandle_t const serializer)
Pushes data to the serializer.
struct dwCameraFrame * dwCameraFrameHandle_t
Handle to captured frame.
Definition: Camera.h:67
struct dwContextObject * dwContextHandle_t
Context handle.
Definition: Context.h:79
NVIDIA DriveWorks API: Core Methods
DW_API_PUBLIC dwStatus dwSensorSerializerNew_serializeData(uint8_t const *const data, size_t size, dwTime_t timestamp, dwSensorSerializerNewHandle_t const serializer)
Pushes data to the serializer.
#define DW_API_PUBLIC
Definition: Exports.h:54
NVIDIA DriveWorks API: Core Exports