DriveWorks SDK Reference
5.10.90 Release
For Test and Development only

SensorSerializer.h
Go to the documentation of this file.
1
2//
3// Notice
4// ALL NVIDIA DESIGN SPECIFICATIONS AND CODE ("MATERIALS") ARE PROVIDED "AS IS" NVIDIA MAKES
5// NO REPRESENTATIONS, WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
6// THE MATERIALS, AND EXPRESSLY DISCLAIMS ANY IMPLIED WARRANTIES OF NONINFRINGEMENT,
7// MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
8//
9// NVIDIA CORPORATION & AFFILIATES assumes no responsibility for the consequences of use of such
10// information or for any infringement of patents or other rights of third parties that may
11// result from its use. No license is granted by implication or otherwise under any patent
12// or patent rights of NVIDIA CORPORATION & AFFILIATES. No third party distribution is allowed unless
13// expressly authorized by NVIDIA. Details are subject to change without notice.
14// This code supersedes and replaces all information previously supplied.
15// NVIDIA CORPORATION & AFFILIATES products are not authorized for use as critical
16// components in life support devices or systems without express written approval of
17// NVIDIA CORPORATION & AFFILIATES.
18//
19// SPDX-FileCopyrightText: Copyright (c) 2016-2022 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
20// SPDX-License-Identifier: LicenseRef-NvidiaProprietary
21//
22// NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
23// property and proprietary rights in and to this material, related
24// documentation and any modifications thereto. Any use, reproduction,
25// disclosure or distribution of this material and related documentation
26// without an express license agreement from NVIDIA CORPORATION or
27// its affiliates is strictly prohibited.
28//
30
47#ifndef DW_SENSORS_SENSORSERIALIZER_H_
48#define DW_SENSORS_SENSORSERIALIZER_H_
49
50#include <dw/core/base/Config.h>
52#include <dw/core/base/Types.h>
54
55#include <dw/sensors/Sensors.h>
57
58#ifdef __cplusplus
59extern "C" {
60#endif
61
68typedef void (*dwSensorSerializerOnDataFunc_t)(const uint8_t* data, size_t size, void* userData);
69
71typedef struct dwSensorSerializerObject* dwSensorSerializerHandle_t;
72
75typedef struct dwSerializerParams
76{
100 const char8_t* parameters;
101
104
106 void* userData;
108
129 dwSerializerParams const* const params,
130 dwSensorHandle_t const sensor);
131
150
169DW_DEPRECATED("This API is deprecated and will be removed in the next major release")
171 dwSensorSerializerHandle_t const masterSerializer);
172
185DW_DEPRECATED("This API is deprecated and will be removed in the next major release")
186dwStatus dwSensorSerializer_isAttached(bool* const isAttached, dwSensorSerializerHandle_t const serializer);
187
209DW_DEPRECATED("This API is deprecated and will be removed in the next major release")
211 dwSensorSerializerHandle_t const masterSerializer);
212
229
243
258dwStatus dwSensorSerializer_serializeData(uint8_t const* const data, size_t const size,
259 dwSensorSerializerHandle_t const serializer);
260
278dwStatus dwSensorSerializer_serializeDataAsync(uint8_t const* const data, size_t const size,
279 dwSensorSerializerHandle_t const serializer);
280
296 dwSensorSerializerHandle_t const serializer);
297
311 dwSensorSerializerHandle_t const serializer);
312
313#ifdef __cplusplus
314}
315#endif
316
318#endif // DW_SENSORS_SENSORSERIALIZER_H_
NVIDIA DriveWorks API: Cameras
NVIDIA DriveWorks API: Core Methods
NVIDIA DriveWorks API: Sensors
NVIDIA DriveWorks API: Core Types
NVIDIA DriveWorks API: Core Exports
struct dwCameraFrame * dwCameraFrameHandle_t
Handle to captured frame.
Definition: Camera.h:73
#define DW_DEPRECATED(msg)
Definition: Exports.h:66
#define DW_API_PUBLIC
Definition: Exports.h:54
dwStatus
Status definition.
Definition: Status.h:173
const char8_t * parameters
Array for additional parameters provided to sensor serializer creation.
dwSensorSerializerOnDataFunc_t onData
Callback executed by the serializer on new data available.
void * userData
User data to be passed to the callback.
DW_API_PUBLIC dwStatus dwSensorSerializer_initialize(dwSensorSerializerHandle_t *const serializer, dwSerializerParams const *const params, dwSensorHandle_t const sensor)
Initializes a sensor serializer with the parameters provided.
DW_API_PUBLIC dwStatus dwSensorSerializer_detachFrom(dwSensorSerializerHandle_t const serializer, dwSensorSerializerHandle_t const masterSerializer)
This method detaches the serializer previously attached with dwSensorSerializer_attachTo().
DW_API_PUBLIC dwStatus dwSensorSerializer_serializeCameraFrame(dwCameraFrameHandle_t const frame, dwSensorSerializerHandle_t const serializer)
Pushes a camera frame to the serializer.This method must only be used if 'dwSensorSerializer_start' i...
DW_API_PUBLIC dwStatus dwSensorSerializer_serializeData(uint8_t const *const data, size_t const size, dwSensorSerializerHandle_t const serializer)
Pushes data to the serializer.
DW_API_PUBLIC dwStatus dwSensorSerializer_start(dwSensorSerializerHandle_t const serializer)
Starts serialization of sensor.
DW_API_PUBLIC dwStatus dwSensorSerializer_stop(dwSensorSerializerHandle_t const serializer)
Starts serialization of sensor.
DW_API_PUBLIC dwStatus dwSensorSerializer_release(dwSensorSerializerHandle_t const serializer)
Releases a sensor serializer.
DW_API_PUBLIC dwStatus dwSensorSerializer_isAttached(bool *const isAttached, dwSensorSerializerHandle_t const serializer)
Query method to check whether the serializer is attached to another.
DW_API_PUBLIC dwStatus dwSensorSerializer_serializeCameraFrameAsync(dwCameraFrameHandle_t const frame, dwSensorSerializerHandle_t const serializer)
Pushes a camera frame to the 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_serializeDataAsync(uint8_t const *const data, size_t const size, dwSensorSerializerHandle_t const serializer)
Pushes data to the serializer.
struct dwSensorSerializerObject * dwSensorSerializerHandle_t
Handle representing a sensor serializer.
DW_API_PUBLIC dwStatus dwSensorSerializer_attachTo(dwSensorSerializerHandle_t const serializer, dwSensorSerializerHandle_t const masterSerializer)
Starts and stops serialization of a sensor with a master serializer.
Holds the parameters for sensor serializer creation.
struct dwSensorObject * dwSensorHandle_t
Handle representing a sensor.
Definition: Sensors.h:86