SensorSerializer.h

Go to the documentation of this file.

// This code contains NVIDIA Confidential Information and is disclosed
// under the Mutual Non-Disclosure Agreement.
//
// 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 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. 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 products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA Corporation.
//
// Copyright (c) 2016-2020 NVIDIA Corporation. All rights reserved.
//
// NVIDIA Corporation and its licensors retain all intellectual property and proprietary
// rights in and to this software and related documentation and any modifications thereto.
// Any use, reproduction, disclosure or distribution of this software and related
// documentation without an express license agreement from NVIDIA Corporation is
// strictly prohibited.
//

#ifndef DW_SENSORS_SENSORSERIALIZER_H_
#define DW_SENSORS_SENSORSERIALIZER_H_

#include <dw/core/Config.h>
#include <dw/core/Exports.h>
#include <dw/core/Types.h>
#include <dw/core/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
{
    // FP: TODO(dwplc):
    // coverity[autosar_cpp14_a3_9_1_violation]
    const char* parameters;

    dwSensorSerializerOnDataFunc_t onData;

    void* userData;
} dwSerializerParams;

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

DW_API_PUBLIC
dwStatus dwSensorSerializer_release(dwSensorSerializerHandle_t serializer);

DW_API_PUBLIC
dwStatus dwSensorSerializer_attachTo(dwSensorSerializerHandle_t serializer,
                                     dwSensorSerializerHandle_t masterSerializer);

DW_API_PUBLIC
dwStatus dwSensorSerializer_isAttached(bool* isAttached, dwSensorSerializerHandle_t serializer);

DW_API_PUBLIC
dwStatus dwSensorSerializer_detachFrom(dwSensorSerializerHandle_t serializer,
                                       dwSensorSerializerHandle_t masterSerializer);

DW_API_PUBLIC
dwStatus dwSensorSerializer_start(dwSensorSerializerHandle_t serializer);

DW_API_PUBLIC
dwStatus dwSensorSerializer_stop(dwSensorSerializerHandle_t serializer);

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

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

DW_API_PUBLIC
dwStatus
dwSensorSerializer_serializeCameraFrame(dwCameraFrameHandle_t frame,
                                        dwSensorSerializerHandle_t serializer);

DW_API_PUBLIC
dwStatus dwSensorSerializer_serializeCameraFrameAsync(dwCameraFrameHandle_t frame,
                                                      dwSensorSerializerHandle_t serializer);

#ifdef __cplusplus
}
#endif

#endif // DW_SENSORS_SENSORSERIALIZER_H_