Types.h

Go to the documentation of this file.

/*
 * Copyright 2019-2024 NVIDIA Corporation. All rights reserved.
 *
 * NOTICE TO LICENSEE:
 *
 * This source code and/or documentation ("Licensed Deliverables") are
 * subject to NVIDIA intellectual property rights under U.S. and
 * international Copyright laws.
 *
 * These Licensed Deliverables contained herein is PROPRIETARY and
 * CONFIDENTIAL to NVIDIA and is being provided under the terms and
 * conditions of a form of NVIDIA software license agreement by and
 * between NVIDIA and Licensee ("License Agreement") or electronically
 * accepted by Licensee. Notwithstanding any terms or conditions to
 * the contrary in the License Agreement, reproduction or disclosure
 * of the Licensed Deliverables to any third party without the express
 * written consent of NVIDIA is prohibited.
 *
 * NOTWITHSTANDING ANY TERMS OR CONDITIONS TO THE CONTRARY IN THE
 * LICENSE AGREEMENT, NVIDIA MAKES NO REPRESENTATION ABOUT THE
 * SUITABILITY OF THESE LICENSED DELIVERABLES FOR ANY PURPOSE. IT IS
 * PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED WARRANTY OF ANY KIND.
 * NVIDIA DISCLAIMS ALL WARRANTIES WITH REGARD TO THESE LICENSED
 * DELIVERABLES, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY,
 * NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE.
 * NOTWITHSTANDING ANY TERMS OR CONDITIONS TO THE CONTRARY IN THE
 * LICENSE AGREEMENT, IN NO EVENT SHALL NVIDIA BE LIABLE FOR ANY
 * SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, OR ANY
 * DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
 * WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
 * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
 * OF THESE LICENSED DELIVERABLES.
 *
 * U.S. Government End Users. These Licensed Deliverables are a
 * "commercial item" as that term is defined at 48 C.F.R. 2.101 (OCT
 * 1995), consisting of "commercial computer software" and "commercial
 * computer software documentation" as such terms are used in 48
 * C.F.R. 12.212 (SEPT 1995) and is provided to the U.S. Government
 * only as a commercial end item. Consistent with 48 C.F.R.12.212 and
 * 48 C.F.R. 227.7202-1 through 227.7202-4 (JUNE 1995), all
 * U.S. Government End Users acquire the Licensed Deliverables with
 * only those rights set forth herein.
 *
 * Any use of the Licensed Deliverables in individual and commercial
 * software must include, in the user documentation and internal
 * comments to the code, the above Disclaimer and U.S. Government End
 * Users Notice.
 */
 
#ifndef NV_VPI_TYPES_H
#define NV_VPI_TYPES_H
 
#include "ImageFormat.h"
#include "Interpolation.h"
#include "PixelType.h"
#include "Status.h"
#include "Version.h"
 
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum
{
    VPI_BACKEND_CPU     = (1ULL << 0), 
    VPI_BACKEND_CUDA    = (1ULL << 1), 
    VPI_BACKEND_PVA     = (1ULL << 2), 
    VPI_BACKEND_VIC     = (1ULL << 3), 
    VPI_BACKEND_NVENC   = (1ULL << 4), 
    VPI_BACKEND_OFA     = (1ULL << 5), 
    VPI_BACKEND_INVALID = (1ULL << 15) 
} VPIBackend;
 
#define VPI_BACKEND_TEGRA (VPI_BACKEND_VIC | VPI_BACKEND_NVENC | VPI_BACKEND_OFA)
 
#define VPI_BACKEND_MASK ((VPI_BACKEND_INVALID << 1) - 1)
 
#define VPI_BACKEND_ALL \
    (VPI_BACKEND_CPU | VPI_BACKEND_CUDA | VPI_BACKEND_PVA | VPI_BACKEND_VIC | VPI_BACKEND_NVENC | VPI_BACKEND_OFA)
 
#define VPI_EXCLUSIVE_STREAM_ACCESS (1ULL << 16)
 
#define VPI_RESTRICT_MEM_USAGE (1ULL << 17)
 
#define VPI_REQUIRE_BACKENDS (1ULL << 18)
 
typedef void (*VPIParallelTask)(int taskId, int threadId, void *vpiData);
 
typedef void (*VPIParallelForCallback)(VPIParallelTask task, int taskCount, void *vpiData, void *userData);
 
typedef struct
{
    int maxThreads;
 
    VPIParallelForCallback callback;
 
    void *userData;
} VPIParallelForConfig;
 
typedef void *VPINativeThreadHandle;
 
typedef struct VPIArrayImpl *VPIArray;
 
typedef struct VPIContextImpl *VPIContext;
 
typedef struct VPIEventImpl *VPIEvent;
 
typedef struct VPIStreamImpl *VPIStream;
 
typedef struct VPIImageImpl *VPIImage;
 
typedef struct VPIPyramidImpl *VPIPyramid;
 
typedef struct VPIPayloadImpl *VPIPayload;
 
typedef enum
{
    VPI_BORDER_ZERO = 0, 
    VPI_BORDER_CLAMP,    
    VPI_BORDER_REFLECT,  
    VPI_BORDER_MIRROR,   
    VPI_BORDER_LIMITED,  
    VPI_BORDER_INVALID,  
} VPIBorderExtension;
 
typedef enum
{
    VPI_CONVERSION_CLAMP = 0,
 
    VPI_CONVERSION_CAST,
 
    VPI_CONVERSION_INVALID = 255,
} VPIConversionPolicy;
 
typedef struct
{
    float x;      
    float y;      
    float octave; 
    float layer;  
} VPIPyramidalKeypointF32;
 
typedef struct
{
    float x; 
    float y; 
} VPIKeypointF32;
 
typedef struct
{
    uint32_t x; 
    uint32_t y; 
} VPIKeypointU32;
 
typedef enum
{
    VPI_CORNER_SCORE_HARRIS = 0, 
    VPI_CORNER_SCORE_FAST   = 1  
} VPICornerScore;
 
#define VPI_BRIEF_DESCRIPTOR_ARRAY_LENGTH 32
 
#define VPI_BRIEF_DESCRIPTOR_BIT_WIDTH (VPI_BRIEF_DESCRIPTOR_ARRAY_LENGTH * 8)
 
typedef struct
{
    uint8_t data[VPI_BRIEF_DESCRIPTOR_ARRAY_LENGTH];
} VPIBriefDescriptor;
 
typedef struct
{
    float mat3[3][3]; 
} VPIHomographyTransform2D;
 
typedef struct
{
    VPIHomographyTransform2D xform; 
    float width,                    
        height;                     
} VPIBoundingBox;
 
typedef struct
{
    float left;   
    float top;    
    float width;  
    float height; 
} VPIAxisAlignedBoundingBoxF32;
 
typedef enum
{
    VPI_TRACKING_STATE_LOST = 0,
 
    VPI_TRACKING_STATE_NEW,
 
    VPI_TRACKING_STATE_TRACKED,
 
    VPI_TRACKING_STATE_SHADOW_TRACKED,
} VPITrackingState;
 
typedef struct
{
    VPIBoundingBox bbox;
 
    int8_t trackingStatus;
 
    int8_t templateStatus;
 
    uint8_t reserved1, reserved2;
} VPIKLTTrackedBoundingBox;
 
typedef struct
{
    VPIAxisAlignedBoundingBoxF32 bbox;
 
    VPITrackingState state;
 
    int32_t seqIndex;
 
    float filterLR;
 
    float filterChannelWeightsLR;
 
    void *userData;
} VPIDCFTrackedBoundingBox;
 
typedef struct
{
    float mean[4];
 
    float covariance[4][4];
 
    int32_t pixelCount;
 
    float sum[4];
 
} VPIStats;
 
#define VPI_MAX_MATCHES_PER_DESCRIPTOR (3)
 
typedef struct
{
    int refIndex[VPI_MAX_MATCHES_PER_DESCRIPTOR];
 
    float distance[VPI_MAX_MATCHES_PER_DESCRIPTOR];
 
} VPIMatches;
 
typedef struct VPIRectangleIRec
{
    int32_t x, y;          /*< Rectangle origin position (x, y). */
    int32_t width, height; /*< Rectangle size dimensions (width, height). */
} VPIRectangleI;
 
typedef enum
{
    VPI_OPTICAL_FLOW_QUALITY_LOW,
 
    VPI_OPTICAL_FLOW_QUALITY_MEDIUM,
 
    VPI_OPTICAL_FLOW_QUALITY_HIGH
} VPIOpticalFlowQuality;
 
typedef enum
{
    VPI_LOCK_READ = 1,
 
    VPI_LOCK_WRITE = 2,
 
    VPI_LOCK_READ_WRITE = 3
} VPILockMode;
 
#define VPI_TERMINATION_CRITERIA_ITERATIONS (1u << 0) 
#define VPI_TERMINATION_CRITERIA_EPSILON (1u << 1)    
typedef float VPICameraIntrinsic[2][3];
 
typedef float VPICameraExtrinsic[3][4];
 
typedef float VPIPerspectiveTransform[3][3];
 
typedef enum
{
    VPI_EVENT_STATE_NOT_SIGNALED,
 
    VPI_EVENT_STATE_SIGNALED
 
} VPIEventState;
 
typedef enum
{
    VPI_FLIP_HORIZ = 1U << 0,
 
    VPI_FLIP_VERT = 1U << 1,
 
    VPI_FLIP_BOTH = VPI_FLIP_HORIZ | VPI_FLIP_VERT
 
} VPIFlipMode;
 
typedef enum
{
    VPI_NORM_L1,
 
    VPI_NORM_L2,
 
    VPI_NORM_HAMMING
 
} VPINormType;
 
typedef enum
{
    VPI_GRADIENT_SOBEL,
 
    VPI_GRADIENT_BLUR_PREWITT
} VPIGradientMethod;
 
#define VPI_STAT_PIXEL_COUNT (1U << 0)
 
#define VPI_STAT_SUM (1U << 1)
 
#define VPI_STAT_MEAN ((1U << 2) | VPI_STAT_SUM | VPI_STAT_PIXEL_COUNT)
 
#define VPI_STAT_VARIANCE ((1U << 3) | VPI_STAT_MEAN)
 
#define VPI_STAT_COVARIANCE ((1U << 4) | VPI_STAT_VARIANCE)
 
typedef struct
{
    uint16_t id;
    int16_t correctedBits;
    float decisionMargin;
    VPIHomographyTransform2D homography;
    VPIKeypointF32 center;
    VPIKeypointF32 corners[4];
} VPIAprilTagDetection;
 
typedef struct
{
    float transform[3][4];
    float error;
} VPIPose;
 
#ifdef __cplusplus
}
#endif
 
#endif /* NV_VPI_TYPES_H */