Types.h

Go to the documentation of this file.

/*
 * Copyright 2019 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 <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define VPI_BACKEND_DISABLE_PVA (0x01)  
#define VPI_BACKEND_DISABLE_CPU (0x02)  
#define VPI_BACKEND_DISABLE_CUDA (0x04) 
#define VPI_BACKEND_ONLY_PVA \
    (VPI_BACKEND_DISABLE_CUDA | VPI_BACKEND_DISABLE_CPU) 
#define VPI_BACKEND_ONLY_CPU \
    (VPI_BACKEND_DISABLE_PVA | VPI_BACKEND_DISABLE_CUDA) 
#define VPI_BACKEND_ONLY_CUDA \
    (VPI_BACKEND_DISABLE_PVA | VPI_BACKEND_DISABLE_CPU) 
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_IMAGE_TYPE_INVALID = 0, 
    VPI_IMAGE_TYPE_U8,          
    VPI_IMAGE_TYPE_S8,          
    VPI_IMAGE_TYPE_U16,         
    VPI_IMAGE_TYPE_S16,         
    VPI_IMAGE_TYPE_NV12,        
    VPI_IMAGE_TYPE_RGB8,        
    VPI_IMAGE_TYPE_RGBA8,       
    VPI_IMAGE_TYPE_F32,         
    VPI_IMAGE_TYPE_2F32,        
    VPI_IMAGE_TYPE_BGR8,        
    VPI_IMAGE_TYPE_BGRA8,       
    VPI_IMAGE_TYPE_Y8     = VPI_IMAGE_TYPE_U8,
    VPI_IMAGE_TYPE_Y8I    = VPI_IMAGE_TYPE_S8,
    VPI_IMAGE_TYPE_Y16    = VPI_IMAGE_TYPE_U16,
    VPI_IMAGE_TYPE_Y16I   = VPI_IMAGE_TYPE_S16,
    VPI_IMAGE_TYPE_1C_F32 = VPI_IMAGE_TYPE_F32,
    VPI_IMAGE_TYPE_2C_F32 = VPI_IMAGE_TYPE_2F32
} VPIImageType;
 
typedef enum
{
    VPI_PIXEL_TYPE_DEFAULT = 0, 
    VPI_PIXEL_TYPE_INVALID,     
    VPI_PIXEL_TYPE_U8,          
    VPI_PIXEL_TYPE_S8,          
    VPI_PIXEL_TYPE_U16,         
    VPI_PIXEL_TYPE_S16,         
    VPI_PIXEL_TYPE_2U8,         
    VPI_PIXEL_TYPE_3U8,         
    VPI_PIXEL_TYPE_4U8,         
    VPI_PIXEL_TYPE_F32,         
    VPI_PIXEL_TYPE_2F32,        
    VPI_PIXEL_TYPE_1C_U8  = VPI_PIXEL_TYPE_U8,
    VPI_PIXEL_TYPE_1C_S8  = VPI_PIXEL_TYPE_S8,
    VPI_PIXEL_TYPE_1C_U16 = VPI_PIXEL_TYPE_U16,
    VPI_PIXEL_TYPE_1C_S16 = VPI_PIXEL_TYPE_S16,
    VPI_PIXEL_TYPE_2C_U8  = VPI_PIXEL_TYPE_2U8,
    VPI_PIXEL_TYPE_3C_U8  = VPI_PIXEL_TYPE_3U8,
    VPI_PIXEL_TYPE_4C_U8  = VPI_PIXEL_TYPE_4U8,
    VPI_PIXEL_TYPE_1C_F32 = VPI_PIXEL_TYPE_F32,
    VPI_PIXEL_TYPE_2C_F32 = VPI_PIXEL_TYPE_2F32
} VPIPixelType;
 
typedef enum
{
    VPI_BOUNDARY_COND_ZERO, 
    VPI_BOUNDARY_COND_CLAMP 
} VPIBoundaryCond;
 
typedef enum
{
    VPI_ARRAY_TYPE_INVALID = 0,              
    VPI_ARRAY_TYPE_S8,                       
    VPI_ARRAY_TYPE_U8,                       
    VPI_ARRAY_TYPE_S16,                      
    VPI_ARRAY_TYPE_U16,                      
    VPI_ARRAY_TYPE_U32,                      
    VPI_ARRAY_TYPE_KEYPOINT,                 
    VPI_ARRAY_TYPE_HOMOGRAPHY_TRANSFORM_2D,  
    VPI_ARRAY_TYPE_KLT_TRACKED_BOUNDING_BOX, 
} VPIArrayType;
 
typedef enum
{
    VPI_INTERP_NEAREST,
 
    VPI_INTERP_LINEAR_PRECISE,
 
    VPI_INTERP_LINEAR_FAST,
 
    VPI_INTERP_LINEAR = VPI_INTERP_LINEAR_FAST,
 
    VPI_INTERP_CATMULL_ROM_PRECISE,
 
    VPI_INTERP_CATMULL_ROM_FAST,
 
    VPI_INTERP_CATMULL_ROM = VPI_INTERP_CATMULL_ROM_FAST
} VPIInterpolationType;
 
typedef enum
{
    VPI_CONVERSION_INVALID = 0,
 
    VPI_CONVERSION_CAST,
 
    VPI_CONVERSION_CLAMP
} VPIConversionPolicy;
 
typedef struct
{
    float x, 
        y;   
} VPIKeypoint;
 
typedef struct
{
    float mat3[3][3]; 
} VPIHomographyTransform2D;
 
typedef struct
{
    VPIHomographyTransform2D xform; 
    float width,                    
        height;                     
} VPIBoundingBox;
 
typedef struct
{
    VPIBoundingBox bbox;
 
    uint8_t trackingStatus;
 
    uint8_t templateStatus;
 
    uint8_t reserved1, reserved2;
} VPIKLTTrackedBoundingBox;
 
typedef enum
{
    VPI_LOCK_READ = 1,
 
    VPI_LOCK_WRITE = 2,
 
    VPI_LOCK_READ_WRITE = 3
} VPILockMode;
 
typedef enum
{
    VPI_SUCCESS = 0,                
    VPI_ERROR_NOT_IMPLEMENTED,      
    VPI_ERROR_INVALID_ARGUMENT,     
    VPI_ERROR_INVALID_IMAGE_TYPE,   
    VPI_ERROR_INVALID_ARRAY_TYPE,   
    VPI_ERROR_INVALID_PYRAMID_TYPE, 
    VPI_ERROR_INVALID_PAYLOAD_TYPE, 
    VPI_ERROR_INVALID_OPERATION,    
    VPI_ERROR_INVALID_CONTEXT,      
    VPI_ERROR_DEVICE,               
    VPI_ERROR_NOT_READY,            
    VPI_ERROR_BUFFER_LOCKED,        
    VPI_ERROR_OUT_OF_MEMORY,        
    VPI_ERROR_INTERNAL              
} VPIStatus;
 
typedef VPIStatus (*VPIUserFunction)(void *);
 
typedef enum
{
    VPI_DEVICE_TYPE_INVALID, 
    VPI_DEVICE_TYPE_CPU,     
    VPI_DEVICE_TYPE_CUDA,    
    VPI_DEVICE_TYPE_PVA      
} VPIDeviceType;
 
#ifdef __cplusplus
}
#endif
 
#endif // NV_VPI_TYPES_H