NVIDIA DriveOS Linux NSR SDK API Reference

7.0.3.0 Release
CodecHeaderPlugin.h
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2022-2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3  * SPDX-License-Identifier: LicenseRef-NvidiaProprietary
4  *
5  * NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
6  * property and proprietary rights in and to this material, related
7  * documentation and any modifications thereto. Any use, reproduction,
8  * disclosure or distribution of this material and related documentation
9  * without an express license agreement from NVIDIA CORPORATION or
10  * its affiliates is strictly prohibited.
11  */
12 
20 #ifndef DW_SENSORS_CODECS_PLUGINS_CODECHEADERPLUGIN_H_
21 #define DW_SENSORS_CODECS_PLUGINS_CODECHEADERPLUGIN_H_
22 
23 #include <dw/core/base/Types.h>
24 #include <dw/core/base/Status.h>
25 #include <dw/core/context/Context.h>
26 
27 #include <dw/sensors/codecs/Codec.h>
28 #include "DecoderPlugin.h"
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 
36 
47 typedef dwStatus (*dwCodecHeaderPlugin_initializeHandle)(dwCodecHeaderPluginHandle_t* handle, void* const codecConfig, void* const params);
48 
58 
69 typedef dwStatus (*dwCodecHeaderPlugin_getCodecType)(char* const mimeType, const size_t size, dwCodecHeaderPluginHandle_t handle);
70 
81 
91 
103 typedef dwStatus (*dwCodecHeaderPlugin_getProperties)(void* const properties, size_t const size, dwCodecHeaderPluginHandle_t handle);
104 
115 typedef dwStatus (*dwCodecHeaderPlugin_getConfig)(void* config, size_t const configSize, dwCodecHeaderPluginHandle_t handle);
116 
128 typedef dwStatus (*dwCodecHeaderPlugin_save)(size_t* const dataSize, void* data, size_t const maxDataSize, dwCodecHeaderPluginHandle_t handle);
129 
140 typedef dwStatus (*dwCodecHeaderPlugin_canLoad)(void const* const data, size_t const dataSize);
141 
152 typedef dwStatus (*dwCodecHeaderPlugin_load)(dwCodecHeaderPluginHandle_t* handle, void const* const data, size_t const dataSize);
153 
166 
169 {
182 
183 #ifdef __cplusplus
184 }
185 #endif
186 
187 #endif // DW_SENSORS_CODECS_PLUGINS_CODECHEADERPLUGIN_H_
dwCodecHeaderPlugin_getMaxRawPacketSize
dwStatus(* dwCodecHeaderPlugin_getMaxRawPacketSize)(size_t *const size, dwCodecHeaderPluginHandle_t handle)
Get the max raw packet size of the CodecHeader.
Definition: CodecHeaderPlugin.h:90
dwCodecHeaderPluginFunctions::load
dwCodecHeaderPlugin_load load
function pointer of function used to load a serialized codec header.
Definition: CodecHeaderPlugin.h:179
ctx
DW_API_PUBLIC dwPointCloudRangeImageCreatorParams const *const const dwContextHandle_t ctx
Definition: PointCloudRangeImageCreator.h:293
dwCodecHeaderPluginFunctions::initializeDecoder
dwCodecHeaderPlugin_initializeDecoder initializeDecoder
function pointer of function used to initialize decoder.
Definition: CodecHeaderPlugin.h:180
dwCodecHeaderPlugin_canLoad
dwStatus(* dwCodecHeaderPlugin_canLoad)(void const *const data, size_t const dataSize)
Check if given data can be loaded.
Definition: CodecHeaderPlugin.h:140
dwCodecHeaderPlugin_save
dwStatus(* dwCodecHeaderPlugin_save)(size_t *const dataSize, void *data, size_t const maxDataSize, dwCodecHeaderPluginHandle_t handle)
Serializes the codec header.
Definition: CodecHeaderPlugin.h:128
dwCodecHeaderPluginFunctions::canLoad
dwCodecHeaderPlugin_canLoad canLoad
function pointer of function used to check if given data can be loaded.
Definition: CodecHeaderPlugin.h:178
dwCodecHeaderPlugin_initializeDecoder
dwStatus(* dwCodecHeaderPlugin_initializeDecoder)(dwDecoderPluginHandle_t *decoderHandle, dwDecoderPluginFunctions const **decoderFuncs, dwCodecHeaderPluginHandle_t handle, dwContextHandle_t ctx)
Initialize a new handle to the Decoder managed by the plugin module.
Definition: CodecHeaderPlugin.h:165
dwCodecHeaderPlugin_getProperties
dwStatus(* dwCodecHeaderPlugin_getProperties)(void *const properties, size_t const size, dwCodecHeaderPluginHandle_t handle)
Get the properties of the CodecHeader.
Definition: CodecHeaderPlugin.h:103
handle
const WFDCommitType const WFDHandle handle
Definition: wfdext.h:124
dwCodecHeaderPluginHandle_t
void * dwCodecHeaderPluginHandle_t
CodecHeader plugin handle.
Definition: CodecHeaderPlugin.h:35
dwMediaType
dwMediaType
Media Type for Codec.
Definition: Codec.h:47
dwCodecHeaderPlugin_getConfig
dwStatus(* dwCodecHeaderPlugin_getConfig)(void *config, size_t const configSize, dwCodecHeaderPluginHandle_t handle)
Get the config of the CodecHeader.
Definition: CodecHeaderPlugin.h:115
dwCodecHeaderPluginFunctions::getMaxRawPacketSize
dwCodecHeaderPlugin_getMaxRawPacketSize getMaxRawPacketSize
function pointer of function used to get the max raw packet size of the CodecHeader.
Definition: CodecHeaderPlugin.h:174
dwCodecHeaderPluginFunctions::getProperties
dwCodecHeaderPlugin_getProperties getProperties
function pointer of function used to get the properties of the CodecHeader.
Definition: CodecHeaderPlugin.h:175
dwDecoderPluginHandle_t
void * dwDecoderPluginHandle_t
Decoder plugin handle.
Definition: DecoderPlugin.h:32
dwCodecHeaderPluginFunctions::initializeHandle
dwCodecHeaderPlugin_initializeHandle initializeHandle
function pointer of initialize a new handle to the CodecHeader managed by the plugin module.
Definition: CodecHeaderPlugin.h:170
dwCodecHeaderPlugin_load
dwStatus(* dwCodecHeaderPlugin_load)(dwCodecHeaderPluginHandle_t *handle, void const *const data, size_t const dataSize)
Load a serialized codec header.
Definition: CodecHeaderPlugin.h:152
dwCodecHeaderPluginFunctions::getCodecType
dwCodecHeaderPlugin_getCodecType getCodecType
function pointer of function used to get codec type.
Definition: CodecHeaderPlugin.h:172
dwCodecHeaderPlugin_release
dwStatus(* dwCodecHeaderPlugin_release)(dwCodecHeaderPluginHandle_t handle)
Release a CodecHeader managed by the plugin module.
Definition: CodecHeaderPlugin.h:57
DecoderPlugin.h
dwCodecHeaderPlugin_initializeHandle
dwStatus(* dwCodecHeaderPlugin_initializeHandle)(dwCodecHeaderPluginHandle_t *handle, void *const codecConfig, void *const params)
Initialize a new handle to the CodecHeader managed by the plugin module.
Definition: CodecHeaderPlugin.h:47
dwDecoderPluginFunctions
Function Table exposing decoder plugin functions.
Definition: DecoderPlugin.h:81
dwCodecHeaderPluginFunctions
Function Table exposing plugin functions.
Definition: CodecHeaderPlugin.h:168
dwContextHandle_t
struct dwContextObject * dwContextHandle_t
Context handle.
Definition: Context.h:74
dwCodecHeaderPluginFunctions::save
dwCodecHeaderPlugin_save save
function pointer of function used to save.
Definition: CodecHeaderPlugin.h:177
dwCodecHeaderPlugin_getMediaType
dwStatus(* dwCodecHeaderPlugin_getMediaType)(dwMediaType *const mediaType, dwCodecHeaderPluginHandle_t handle)
Get the MediaType of the CodecHeader.
Definition: CodecHeaderPlugin.h:80
dwCodecHeaderPluginFunctions::getConfig
dwCodecHeaderPlugin_getConfig getConfig
function pointer of function used to get the config of the CodecHeader.
Definition: CodecHeaderPlugin.h:176
dwStatus
dwStatus
Status definition.
Definition: ErrorDefs.h:27
params
DW_API_PUBLIC dwPointCloudRangeImageCreatorParams const *const params
Definition: PointCloudRangeImageCreator.h:292
dwCodecHeaderPluginFunctions
struct dwCodecHeaderPluginFunctions dwCodecHeaderPluginFunctions
Function Table exposing plugin functions.
dwCodecHeaderPlugin_getCodecType
dwStatus(* dwCodecHeaderPlugin_getCodecType)(char *const mimeType, const size_t size, dwCodecHeaderPluginHandle_t handle)
Get the CodecType of the CodecHeader.
Definition: CodecHeaderPlugin.h:69
dwCodecHeaderPluginFunctions::release
dwCodecHeaderPlugin_release release
function pointer of release a CodecHeader managed by the plugin module.
Definition: CodecHeaderPlugin.h:171
dwCodecHeaderPluginFunctions::getMediaType
dwCodecHeaderPlugin_getMediaType getMediaType
function pointer of function used to get media type.
Definition: CodecHeaderPlugin.h:173