SensorPlugin.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2023-2024 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_SENSORLIVE_SENSORPLUGIN_H
#define DW_SENSORS_SENSORLIVE_SENSORPLUGIN_H
 
#include <dw/core/base/Types.h>
#include <dw/core/context/Context.h>
 
#include <dw/sensors/common/SensorTypes.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef void* dwSensorPluginSensorHandle_t;
 
typedef dwStatus (*dwSensorPlugin_initializeHandle)(dwSensorPluginSensorHandle_t* handle,
                                                    char const* params, dwContextHandle_t ctx);
 
typedef dwStatus (*dwSensorPlugin_release)(dwSensorPluginSensorHandle_t handle);
 
typedef dwStatus (*dwSensorPlugin_start)(dwSensorPluginSensorHandle_t handle);
 
typedef dwStatus (*dwSensorPlugin_stop)(dwSensorPluginSensorHandle_t handle);
 
typedef dwStatus (*dwSensorPlugin_reset)(dwSensorPluginSensorHandle_t handle);
 
typedef dwStatus (*dwSensorPlugin_readRawData)(uint8_t const** data, size_t* size, dwTime_t* timestamp,
                                               dwTime_t timeout_us, dwSensorPluginSensorHandle_t handle);
 
typedef dwStatus (*dwSensorPlugin_returnRawData)(uint8_t const* data, dwSensorPluginSensorHandle_t handle);
 
#define SENSOR_PLUGIN_COMMON_FUNCTIONS                \
    dwSensorPlugin_initializeHandle initializeHandle; \
    dwSensorPlugin_release release;                   \
    dwSensorPlugin_start start;                       \
    dwSensorPlugin_stop stop;                         \
    dwSensorPlugin_reset reset;                       \
    dwSensorPlugin_readRawData readRawData;           \
    dwSensorPlugin_returnRawData returnRawData
 
typedef struct dwSensorPluginFunctions
{
    SENSOR_PLUGIN_COMMON_FUNCTIONS;
} dwSensorPluginFunctions;
 
DW_API_PUBLIC
dwStatus dwSAL_registerSensorPlugin(dwSensorType sensorType, char const* codecMimeType,
                                    void const* funcTable, dwSALHandle_t const sal);
 
#ifdef __cplusplus
}
#endif
 
#endif // DW_SENSORS_SENSORLIVE_SENSORPLUGIN_H