NVIDIA DeepStream SDK API Reference

9.1 Release
sources/gst-plugins/gst-nvdspreprocess/nvdspreprocess_lib/nvdspreprocess_lib.h
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2021-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3  * SPDX-License-Identifier: Apache-2.0
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
33 #ifndef __NVDSPREPROCESS_LIB__
34 #define __NVDSPREPROCESS_LIB__
35 
36 #include "nvbufsurface.h"
37 #include "nvbufsurftransform.h"
38 #include "nvdspreprocess_interface.h"
39 
41 #define _PATH_MAX 4096
42 
44 #define NVDSPREPROCESS_USER_CONFIGS_PIXEL_NORMALIZATION_FACTOR "pixel-normalization-factor"
45 
47 #define NVDSPREPROCESS_USER_CONFIGS_MEAN_FILE "mean-file"
48 
50 #define NVDSPREPROCESS_USER_CONFIGS_OFFSETS "offsets"
51 
55 extern "C"
57  NvBufSurface *out_surf,
58  CustomTransformParams &params);
59 
63 extern "C"
65  NvBufSurface *out_surf,
66  CustomTransformParams &params);
67 
71 extern "C"
73  CustomTensorParams &tensorParam, NvDsPreProcessAcquirer *acquirer);
74 
78 extern "C"
80 
84 extern "C"
85 void deInitLib(CustomCtx *ctx);
86 
87 #endif
CustomInitParams
Custom Initialization parameter for custom library.
Definition: sources/gst-plugins/gst-nvdspreprocess/include/nvdspreprocess_interface.h:189
initLib
CustomCtx * initLib(CustomInitParams initparams)
custom library initialization function
NvBufSurface
Holds information about batched buffers.
Definition: sources/includes/nvbufsurface.h:597
NvDsPreProcessBatch
Holds information about the batch of frames to be inferred.
Definition: sources/gst-plugins/gst-nvdspreprocess/include/nvdspreprocess_interface.h:252
NvDsPreProcessStatus
NvDsPreProcessStatus
Enum for the status codes returned by NvDsPreProcessImpl.
Definition: sources/gst-plugins/gst-nvdspreprocess/include/nvdspreprocess_interface.h:54
CustomTransformParams
custom transformation parameter for calling nvbufsurftransform api for scaling and converting the ROI...
Definition: sources/gst-plugins/gst-nvdspreprocess/include/nvdspreprocess_interface.h:121
CustomAsyncTransformation
NvDsPreProcessStatus CustomAsyncTransformation(NvBufSurface *in_surf, NvBufSurface *out_surf, CustomTransformParams &params)
Custom Asynchronus group transformation function.
CustomTensorPreparation
NvDsPreProcessStatus CustomTensorPreparation(CustomCtx *ctx, NvDsPreProcessBatch *batch, NvDsPreProcessCustomBuf *&buf, CustomTensorParams &tensorParam, NvDsPreProcessAcquirer *acquirer)
Custom tensor preparation function for NCHW/NHWC network order.
deInitLib
void deInitLib(CustomCtx *ctx)
custom library deinitialization function
CustomTensorParams
Tensor params passed to custom library for tensor preparation.
Definition: sources/gst-plugins/gst-nvdspreprocess/include/nvdspreprocess_interface.h:178
NvDsPreProcessCustomBuf
Custom Buffer passed to the custom lib for preparing tensor.
Definition: sources/gst-plugins/gst-nvdspreprocess/include/nvdspreprocess_interface.h:204
NvDsPreProcessAcquirer
class for acquiring and releasing a buffer from tensor pool by custom lib.
Definition: sources/gst-plugins/gst-nvdspreprocess/include/nvdspreprocess_interface.h:214
CustomCtx
struct CustomCtx CustomCtx
Context for custom library.
Definition: sources/gst-plugins/gst-nvdspreprocess/include/nvdspreprocess_interface.h:49
CustomTransformation
NvDsPreProcessStatus CustomTransformation(NvBufSurface *in_surf, NvBufSurface *out_surf, CustomTransformParams &params)
Custom transformation function for group.