DriveWorks SDK Reference
5.16.65 Release
For Test and Development only

CodecHeader.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) 2016-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
46#ifndef DW_SENSORS_CODEC_CODECHEADER_H_
47#define DW_SENSORS_CODEC_CODECHEADER_H_
48
49#include <dw/core/base/Types.h>
50#include <dw/core/base/Status.h>
52
53#include <dw/sensors/Codec.h>
55
56#ifdef __cplusplus
57extern "C" {
58#endif
59
61typedef struct dwCodecHeaderObject* dwCodecHeaderHandle_t;
62
64typedef struct dwCodecHeaderObject const* dwCodecHeaderConstHandle_t;
65
79DW_DEPRECATED("dwCodecType deprecated. use dwCodecHeader_createNew instead")
81
97dwStatus dwCodecHeader_createNew(dwCodecHeaderHandle_t* handle, char8_t const* codecMimeType, void* codecConfig, void* params, dwContextHandle_t context);
98
108
121
133dwStatus dwCodecHeader_getCodecTypeNew(char8_t* type, const size_t size, dwCodecHeaderConstHandle_t const handle);
134
146
159dwStatus dwCodecHeader_getConfig(void* config, size_t configSize, dwMediaType mediaType, dwCodecHeaderConstHandle_t handle);
160
173dwStatus dwCodecHeader_save(size_t* const dataSize, void* data, size_t const maxDataSize, dwCodecHeaderConstHandle_t const handle);
174
187dwStatus dwCodecHeader_load(dwCodecHeaderHandle_t* const handle, void* const data, size_t const dataSize, dwContextHandle_t context);
188
198
211dwStatus dwCodecHeader_register(char const* codecMimeType, dwCodecHeaderPluginFunctions const* const funcTable, dwContextHandle_t ctx);
212
213#ifdef __cplusplus
214}
215#endif
216
218#endif // DW_SENSORS_CODEC_CODECHEADER_H_
NVIDIA DriveWorks API: CodecHeader Plugin Interface
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
dwStatus dwCodecHeader_save(size_t *const dataSize, void *data, size_t const maxDataSize, dwCodecHeaderConstHandle_t const handle)
Serializes the codec header into JSON string.
struct dwCodecHeaderObject * dwCodecHeaderHandle_t
CodecHeader handle.
Definition: CodecHeader.h:61
dwStatus dwCodecHeader_getCodecTypeNew(char8_t *type, const size_t size, dwCodecHeaderConstHandle_t const handle)
Get the specified codec MIME type in a codec header.
dwStatus dwCodecHeader_register(char const *codecMimeType, dwCodecHeaderPluginFunctions const *const funcTable, dwContextHandle_t ctx)
Register CodecHeader plugin with associated codec MIME type.
dwStatus dwCodecHeader_load(dwCodecHeaderHandle_t *const handle, void *const data, size_t const dataSize, dwContextHandle_t context)
Load a serialized codec header from JSON string.
dwStatus dwCodecHeader_getMediaType(dwMediaType *const type, dwCodecHeaderConstHandle_t const handle)
Get the specified dwMediaType in a codec header.
dwStatus dwCodecHeader_getCodecType(dwCodecType *const type, dwCodecHeaderConstHandle_t const handle)
Get the specified dwCodecType in a codec header.
dwStatus dwCodecHeader_getConfig(void *config, size_t configSize, dwMediaType mediaType, dwCodecHeaderConstHandle_t handle)
Get the specified dwCodecConfig* in a codec header.
dwStatus dwCodecHeader_release(dwCodecHeaderHandle_t const handle)
Release resources associated with codec header.
dwStatus dwCodecHeader_destroy(dwCodecHeaderHandle_t handle)
Destroy a previously allocated codec header.
struct dwCodecHeaderObject const * dwCodecHeaderConstHandle_t
CodecHeader handle.
Definition: CodecHeader.h:64
dwStatus dwCodecHeader_createNew(dwCodecHeaderHandle_t *handle, char8_t const *codecMimeType, void *codecConfig, void *params, dwContextHandle_t context)
Create a new codec header with the specified codec MIME type.
dwStatus dwCodecHeader_create(dwCodecHeaderHandle_t *handle, dwCodecType type, void *codecConfig)
Create a new codec header with the specified dwCodecType.
dwCodecType
Codec Type.
Definition: Codec.h:76
dwMediaType
Media Type for Codec.
Definition: Codec.h:61
struct dwContextObject * dwContextHandle_t
Context handle.
Definition: Context.h:86
#define DW_DEPRECATED(msg)
Definition: Exports.h:68