DriveWorks SDK Reference
5.16.65 Release
For Test and Development only

CodecHeaderPlugin.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) 2022-2023 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
38#ifndef DW_SENSORS_CODEC_CODECHEADERPLUGIN_H_
39#define DW_SENSORS_CODEC_CODECHEADERPLUGIN_H_
40
41#include <dw/core/base/Types.h>
42#include <dw/core/base/Status.h>
44
45#include <dw/sensors/Codec.h>
46#include <dw/sensors/codecs/DecoderPlugin.h>
47
48#ifdef __cplusplus
49extern "C" {
50#endif
51
54
65typedef dwStatus (*dwCodecHeaderPlugin_initializeHandle)(dwCodecHeaderPluginHandle_t* handle, void* const codecConfig, void* const params);
66
76
87typedef dwStatus (*dwCodecHeaderPlugin_getCodecType)(char* const mimeType, const size_t size, dwCodecHeaderPluginHandle_t handle);
88
99
109
121typedef dwStatus (*dwCodecHeaderPlugin_getProperties)(void* const properties, size_t const size, dwCodecHeaderPluginHandle_t handle);
122
133typedef dwStatus (*dwCodecHeaderPlugin_getConfig)(void* config, size_t const configSize, dwCodecHeaderPluginHandle_t handle);
134
146typedef dwStatus (*dwCodecHeaderPlugin_save)(size_t* const dataSize, void* data, size_t const maxDataSize, dwCodecHeaderPluginHandle_t handle);
147
158typedef dwStatus (*dwCodecHeaderPlugin_canLoad)(void const* const data, size_t const dataSize);
159
170typedef dwStatus (*dwCodecHeaderPlugin_load)(dwCodecHeaderPluginHandle_t* handle, void const* const data, size_t const dataSize);
171
183typedef dwStatus (*dwCodecHeaderPlugin_initializeDecoder)(dwDecoderPluginHandle_t* decoderHandle, dwDecoderPluginFunctions const** decoderFuncs, dwCodecHeaderPluginHandle_t handle, dwContextHandle_t ctx);
184
187{
200
201#ifdef __cplusplus
202}
203#endif
204
205#endif // DW_SENSORS_CODEC_CODECHEADERPLUGIN_H_
dwCodecHeaderPlugin_initializeDecoder initializeDecoder
function pointer of function used to initialize decoder.
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.
dwStatus(* dwCodecHeaderPlugin_getMediaType)(dwMediaType *const mediaType, dwCodecHeaderPluginHandle_t handle)
Get the MediaType of the CodecHeader.
dwCodecHeaderPlugin_release release
function pointer of release a CodecHeader managed by the plugin module..
dwCodecHeaderPlugin_getMediaType getMediaType
function pointer of function used to get media type.
dwCodecHeaderPlugin_save save
function pointer of function used to save.
void * dwCodecHeaderPluginHandle_t
CodecHeader plugin handle.
dwStatus(* dwCodecHeaderPlugin_getProperties)(void *const properties, size_t const size, dwCodecHeaderPluginHandle_t handle)
Get the properties of the CodecHeader.
dwCodecHeaderPlugin_load load
function pointer of function used to load a serialized codec header.
dwStatus(* dwCodecHeaderPlugin_load)(dwCodecHeaderPluginHandle_t *handle, void const *const data, size_t const dataSize)
Load a serialized codec header.
dwCodecHeaderPlugin_getMaxRawPacketSize getMaxRawPacketSize
function pointer of function used to get the max raw packet size of the CodecHeader.
dwStatus(* dwCodecHeaderPlugin_getMaxRawPacketSize)(size_t *const size, dwCodecHeaderPluginHandle_t handle)
Get the max raw packet size of the CodecHeader.
dwStatus(* dwCodecHeaderPlugin_release)(dwCodecHeaderPluginHandle_t handle)
Release a CodecHeader managed by the plugin module.
dwCodecHeaderPlugin_initializeHandle initializeHandle
function pointer of initialize a new handle to the CodecHeader managed by the plugin module.
dwStatus(* dwCodecHeaderPlugin_save)(size_t *const dataSize, void *data, size_t const maxDataSize, dwCodecHeaderPluginHandle_t handle)
Serializes the codec header.
dwCodecHeaderPlugin_getCodecType getCodecType
function pointer of function used to get codec type.
dwCodecHeaderPlugin_getConfig getConfig
function pointer of function used to get the config of the CodecHeader.
dwCodecHeaderPlugin_getProperties getProperties
function pointer of function used to get the properties of the CodecHeader.
dwCodecHeaderPlugin_canLoad canLoad
function pointer of function used to check if given data can be loaded.
dwStatus(* dwCodecHeaderPlugin_getCodecType)(char *const mimeType, const size_t size, dwCodecHeaderPluginHandle_t handle)
Get the CodecType of the CodecHeader.
dwStatus(* dwCodecHeaderPlugin_getConfig)(void *config, size_t const configSize, dwCodecHeaderPluginHandle_t handle)
Get the config of the CodecHeader.
dwStatus(* dwCodecHeaderPlugin_initializeHandle)(dwCodecHeaderPluginHandle_t *handle, void *const codecConfig, void *const params)
Initialize a new handle to the CodecHeader managed by the plugin module.
dwStatus(* dwCodecHeaderPlugin_canLoad)(void const *const data, size_t const dataSize)
Check if given data can be loaded.
Function Table exposing plugin functions.
NVIDIA DriveWorks API: Codec Methods
NVIDIA DriveWorks API: Core Methods
dwStatus
Status definition.
Definition: ErrorDefs.h:44
NVIDIA DriveWorks API: Core Status Methods
NVIDIA DriveWorks API: Core Types
dwMediaType
Media Type for Codec.
Definition: Codec.h:61
struct dwContextObject * dwContextHandle_t
Context handle.
Definition: Context.h:86