SensorSerializer.h

Go to the documentation of this file.

//
// Notice
// ALL NVIDIA DESIGN SPECIFICATIONS AND CODE ("MATERIALS") ARE PROVIDED "AS IS" NVIDIA MAKES
// NO REPRESENTATIONS, WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
// THE MATERIALS, AND EXPRESSLY DISCLAIMS ANY IMPLIED WARRANTIES OF NONINFRINGEMENT,
// MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
//
// NVIDIA CORPORATION & AFFILIATES assumes no responsibility for the consequences of use of such
// information or for any infringement of patents or other rights of third parties that may
// result from its use. No license is granted by implication or otherwise under any patent
// or patent rights of NVIDIA CORPORATION & AFFILIATES. No third party distribution is allowed unless
// expressly authorized by NVIDIA. Details are subject to change without notice.
// This code supersedes and replaces all information previously supplied.
// NVIDIA CORPORATION & AFFILIATES products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA CORPORATION & AFFILIATES.
//
// SPDX-FileCopyrightText: Copyright (c) 2016-2021 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: LicenseRef-NvidiaProprietary
//
// NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
// property and proprietary rights in and to this material, related
// documentation and any modifications thereto. Any use, reproduction,
// disclosure or distribution of this material and related documentation
// without an express license agreement from NVIDIA CORPORATION or
// its affiliates is strictly prohibited.
//

#ifndef DW_SENSORS_SENSORSERIALIZER_H_
#define DW_SENSORS_SENSORSERIALIZER_H_

#include <dw/core/Config.h>
#include <dw/core/base/Exports.h>
#include <dw/core/base/Types.h>
#include <dw/core/context/Context.h>

#include <dw/sensors/Sensors.h>
#include <dw/sensors/camera/Camera.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef void (*dwSensorSerializerOnDataFunc_t)(const uint8_t* data, size_t size, void* userData);

typedef struct dwSensorSerializerObject* dwSensorSerializerHandle_t;

typedef struct dwSerializerParams
{
    const char8_t* parameters;

    dwSensorSerializerOnDataFunc_t onData;

    void* userData;
} dwSerializerParams;

DW_API_PUBLIC
dwStatus dwSensorSerializer_initialize(dwSensorSerializerHandle_t* const serializer,
                                       dwSerializerParams const* const params,
                                       dwSensorHandle_t const sensor);

DW_API_PUBLIC
dwStatus dwSensorSerializer_release(dwSensorSerializerHandle_t const serializer);

DW_API_PUBLIC
DW_DEPRECATED("This API is deprecated and will be removed in the next major release")
dwStatus dwSensorSerializer_attachTo(dwSensorSerializerHandle_t const serializer,
                                     dwSensorSerializerHandle_t const masterSerializer);

DW_API_PUBLIC
DW_DEPRECATED("This API is deprecated and will be removed in the next major release")
dwStatus dwSensorSerializer_isAttached(bool* const isAttached, dwSensorSerializerHandle_t const serializer);

DW_API_PUBLIC
DW_DEPRECATED("This API is deprecated and will be removed in the next major release")
dwStatus dwSensorSerializer_detachFrom(dwSensorSerializerHandle_t const serializer,
                                       dwSensorSerializerHandle_t const masterSerializer);

DW_API_PUBLIC
dwStatus dwSensorSerializer_start(dwSensorSerializerHandle_t const serializer);

DW_API_PUBLIC
dwStatus dwSensorSerializer_stop(dwSensorSerializerHandle_t const serializer);

DW_API_PUBLIC
dwStatus dwSensorSerializer_serializeData(uint8_t const* const data, size_t const size,
                                          dwSensorSerializerHandle_t const serializer);

DW_API_PUBLIC
dwStatus dwSensorSerializer_serializeDataAsync(uint8_t const* const data, size_t const size,
                                               dwSensorSerializerHandle_t const serializer);

DW_API_PUBLIC
dwStatus
dwSensorSerializer_serializeCameraFrame(dwCameraFrameHandle_t const frame,
                                        dwSensorSerializerHandle_t const serializer);

DW_API_PUBLIC
dwStatus dwSensorSerializer_serializeCameraFrameAsync(dwCameraFrameHandle_t const frame,
                                                      dwSensorSerializerHandle_t const serializer);

#ifdef __cplusplus
}
#endif

#endif // DW_SENSORS_SENSORSERIALIZER_H_