NVIDIA DRIVE OS Linux API Reference

5.1.3.0 Release

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Vision Programming Interface

Detailed Description

The NvMedia Vision Programming Interface (VPI) API contains NvMedia functions for accessing the Computer Vision (CV) hardware accelerated algorithms.

Data Structures

struct  NvMediaVPIPoint2Df
 Holds 2D floating point definition. More...
 
struct  NvMediaVPIPoint2DFrac
 Holds 2D point fractional representation. More...
 
struct  NvMediaVPIAABB
 Axis Aligned Bounding Box. More...
 
struct  NvMediaVPI2DTransform
 3x3 transform matrix. More...
 
struct  NvMediaVPITranslationWithScale
 Translation with Scale parameters. More...
 
struct  NvMediaVPIBoundingBoxWithTransform
 Holds bounding box definition. More...
 
struct  NvMediaVPIStereoPostprocessParams
 Holds stereo postprocess parameters. More...
 
struct  NvMediaVPIStereoPreprocessParams
 Holds stereo preprocessing parameters. More...
 
struct  NvMediaVPIGetKeyPointsHarrisParams
 Holds Harris keypoint parameters. More...
 
struct  NvMediaVPIGetSparseFlowPyrLKParams
 NvMediaVPIGetSparseFlowPyrLKParams. More...
 
struct  NvMediaVPIKLTParams
 Holds the KLT parameters. More...
 

Macros

#define NVMEDIA_VPI_VERSION_MAJOR   2
 Major version number. More...
 
#define NVMEDIA_VPI_VERSION_MINOR   3
 Minor version number. More...
 
#define NVMEDIA_VPI_MAX_QUEUED_TASKS   64
 Maximum number of tasks that can be queued. More...
 

Typedefs

typedef struct NvMediaVPI NvMediaVPI
 Holds an opaque object representing NvMediaVPI. More...
 
typedef struct
NvMediaVPIProcessStereoDescriptor 
NvMediaVPIProcessStereoDescriptor
 NvMediaVPIProcessStereo descriptor. More...
 
typedef struct
NvMediaVPIConvertMVDescriptor 
NvMediaVPIConvertMVDescriptor
 NvMediaVPIConvertMV descriptor. More...
 
typedef struct
NvMediaVPIStereoPostprocessDescriptor 
NvMediaVPIStereoPostprocessDescriptor
 NvMediaVPISteroPostprocess descriptor. More...
 
typedef struct
NvMediaVPIStereoPreprocessDescriptor 
NvMediaVPIStereoPreprocessDescriptor
 NvMediaVPISteroPreprocess descriptor. More...
 
typedef struct
NvMediaVPIGetKeyPointsHarrisDescriptor 
NvMediaVPIGetKeyPointsHarrisDescriptor
 
typedef struct
NvMediaVPIGetKeyPointsFastDescriptor 
NvMediaVPIGetKeyPointsFastDescriptor
 
typedef struct
NvMediaVPIGetSparseFlowPyrLKDescriptor 
NvMediaVPIGetSparseFlowPyrLKDescriptor
 NvMediaVPISparseFlowPyr descriptor. More...
 
typedef struct
NvMediaVPIKLTDescriptor 
NvMediaVPIKLTDescriptor
 NvMediaVPIKLTDescriptor descriptor. More...
 
typedef enum NvMediaVPIKltTrackType NvMediaVPIKltTrackType
 Specifies the types of KLT Tracking. More...
 
typedef struct
NvMediaVPIConvolveImageSeparableDescriptor 
NvMediaVPIConvolveImageSeparableDescriptor
 NvMediaVPIConvolveImageSeparableDescriptor. More...
 

Enumerations

enum  NvMediaVPIArrayType {
  NVMEDIA_VPI_ARRAY_TYPE_KEYPOINT = 0,
  NVMEDIA_VPI_ARRAY_TYPE_BBOX_XFORM = 1,
  NVMEDIA_VPI_ARRAY_TYPE_TRANSFORM = 2,
  NVMEDIA_VPI_ARRAY_NUM_TYPES = 3
}
 Defines the different types of VPI-specific arrays. More...
 
enum  NvMediaVPIOFSTOutputType {
  NVMEDIA_VPI_STEREO_DISPARITY = 0,
  NVMEDIA_VPI_MV,
  NVMEDIA_VPI_MV_HINTS
}
 Specifies the types of output for Optical Flow/Stereo Disparity processing. More...
 
enum  NvMediaVPINonMaxSuppressionType { NVMEDIA_VPI_2D_GRID_8x8_CELL_NO_MIN_DISTANCE = 0 }
 Specifies types of post-process non-maximum suppression. More...
 
enum  NvMediaVPIHarrisGradientFilterType {
  NVMEDIA_VPI_HARRIS_FILTER_TYPE_DEFAULT = 0,
  NVMEDIA_VPI_HARRIS_FILTER_TYPE_USER
}
 Specifies types of filters used in the Harris corner detector. More...
 
enum  NvMediaVPITerminationCriterion {
  NVMEDIA_VPI_TERMINATION_CRITERION_ITERATIONS = 0,
  NVMEDIA_VPI_TERMINATION_CRITERION_EPSILON,
  NVMEDIA_VPI_TERMINATION_CRITERION_BOTH
}
 Specifies the conditions that cause the Lucas-Kanade Feature Tracker to be terminated. More...
 
enum  NvMediaVPIKltTrackType { NVMEDIA_VPI_KLT_INVERSE_COMPOSITIONAL = 0 }
 Specifies the types of KLT Tracking. More...
 

Functions

NvMediaStatus NvMediaVPIGetNumEngines (uint32_t *numEngines)
 Returns the number of HW engines accessible. More...
 
NvMediaStatus NvMediaVPIGetVersion (NvMediaVersion *version)
 Returns version information for the NvMediaVPI library. More...
 
NvMediaVPINvMediaVPICreate (const uint32_t Id, const uint32_t maxQueuedTasks)
 Creates an NvMediaVPI object. More...
 
NvMediaStatus NvMediaVPIDestroy (NvMediaVPI *vpi)
 Destroys an Vision Programming Interface object created by NvMediaVPICreate(). More...
 
NvMediaStatus NvMediaVPIFlush (NvMediaVPI *vpi)
 Flushes all queued operations. More...
 
NvMediaStatus NvMediaVPIImageRegister (NvMediaVPI *vpi, NvMediaImage *image)
 Registers an image for use with an NvMediaVPI function. More...
 
NvMediaStatus NvMediaVPIImageUnregister (NvMediaVPI *vpi, NvMediaImage *image)
 Unregisters an image after use. More...
 
NvMediaStatus NvMediaVPIArrayRegister (NvMediaVPI *vpi, NvMediaArray *array)
 Registers an array for use with an NvMediaVPI function. More...
 
NvMediaStatus NvMediaVPIArrayUnregister (NvMediaVPI *vpi, NvMediaArray *array)
 Unregisters an array after use. More...
 
NvMediaStatus NvMediaVPIScratchpadRegister (NvMediaVPI *vpi, NvMediaCVScratchpad *scratchpad)
 Registers scratchpad memory for use with an NvMediaVPI function. More...
 
NvMediaStatus NvMediaVPIScratchpadUnregister (NvMediaVPI *vpi, NvMediaCVScratchpad *scratchpad)
 Unregisters scratchpad memory after use. More...
 
NvMediaArrayNvMediaVPIArrayCreate (NvMediaDevice *device, NvMediaVPIArrayType type, uint32_t numElements, const NvMediaArrayAllocAttr *attrs, uint32_t numAttrs)
 Creates an NvMediaArray for a VPI-specific element type. More...
 
NvMediaStatus NvMediaVPIPyramidRegister (NvMediaVPI *vpi, NvMediaImagePyramid *pyramid)
 Registers a pyramid for use with an NvMediaVPI function. More...
 
NvMediaStatus NvMediaVPIPyramidUnregister (NvMediaVPI *vpi, NvMediaImagePyramid *pyramid)
 Unregisters a pyramid after use. More...
 
NvMediaVPIProcessStereoDescriptorNvMediaVPICreateProcessStereoPairDescriptor (NvMediaVPI *vpi, const uint32_t width, const uint32_t height, const NvMediaVPIOFSTOutputType outputType)
 Creates NvMediaVPIProcessStereoDescriptor. More...
 
NvMediaStatus NvMediaVPIProcessStereoPairDesc (NvMediaVPI *vpi, NvMediaVPIProcessStereoDescriptor *descriptor, NvMediaImage *left, NvMediaImage *right, NvMediaImage *output)
 Queues an operation to process a stereo image pair. More...
 
NvMediaVPIConvertMVDescriptorNvMediaVPICreateConvertMVDescriptor (NvMediaVPI *vpi, const uint32_t width, const uint32_t height, const NvMediaSurfaceType type, const float strength, const float scale)
 Creates an NvMediaVPIConvertMVDescriptor. More...
 
NvMediaStatus NvMediaVPIConvertMVDesc (NvMediaVPI *vpi, NvMediaVPIConvertMVDescriptor *descriptor, NvMediaImage *inputMVImage, NvMediaImage *inputColor, NvMediaImage *output, const NvMediaVPIOFSTOutputType outputType)
 Converts or refines a motion vector image. More...
 
NvMediaVPIStereoPostprocessDescriptorNvMediaVPICreateStereoPostprocessDescriptor (NvMediaVPI *vpi, const uint32_t width, const uint32_t height, const float scale)
 Creates an NvMediaVPIStereoPostprocessDescriptor. More...
 
NvMediaStatus NvMediaVPIStereoPostprocessDesc (NvMediaVPI *vpi, NvMediaVPIStereoPostprocessDescriptor *descriptor, NvMediaVPIStereoPostprocessParams *params, NvMediaImage *disparityInput, NvMediaImage *confidenceInput, NvMediaImage *disparityOutput, NvMediaImage *confidenceOutput)
 Performs stereo postprocessing to refine a disparity image. More...
 
NvMediaVPIStereoPreprocessDescriptorNvMediaVPICreateStereoPreprocessDescriptor (NvMediaVPI *vpi, const uint32_t width, const uint32_t height, const NvMediaVPIOFSTOutputType outputType)
 Creates an NvMediaVPIStereoPreprocessDescriptor. More...
 
NvMediaStatus NvMediaVPIStereoPreprocessDesc (NvMediaVPI *vpi, NvMediaVPIStereoPreprocessDescriptor *descriptor, NvMediaVPIStereoPreprocessParams *params, NvMediaArray *confidenceTable, NvMediaImage *leftImage, NvMediaImage *rightImage, NvMediaImage *output0, NvMediaImage *output1)
 Performs stereo preprocessing to produce a disparity image or motion vector hints. More...
 
NvMediaVPIGetKeyPointsHarrisDescriptorNvMediaVPICreateGetKeyPointsHarrisDescriptor (NvMediaVPI *vpi, const uint32_t width, const uint32_t height, const NvMediaVPINonMaxSuppressionType nonMaxSuppressionType)
 Creates a pointer to a NvMediaVPIGetKeyPointsHarrisDescriptor. More...
 
NvMediaStatus NvMediaVPIGetKeyPointsHarrisDesc (NvMediaVPI *vpi, NvMediaVPIGetKeyPointsHarrisDescriptor *descriptor, const NvMediaVPIGetKeyPointsHarrisParams *params, NvMediaImage *input, NvMediaImage *mask, NvMediaArray *trackedKeypoints, NvMediaArray *trackedScores, NvMediaArray *keypoints, NvMediaArray *scores)
 Queues an operation to get Harris keypoints throughout an image. More...
 
NvMediaVPIGetKeyPointsFastDescriptorNvMediaVPICreateGetKeyPointsFastDescriptor (NvMediaVPI *vpi, const uint32_t width, const uint32_t height, const NvMediaSurfaceType type)
 Creates a pointer to an NvMediaVPIGetKeyPointsFastDescriptor. More...
 
NvMediaStatus NvMediaVPIGetKeyPointsFastDesc (NvMediaVPI *vpi, NvMediaVPIGetKeyPointsFastDescriptor *descriptor, NvMediaImage *input, const uint32_t strengthThresh, const NvMediaBool nonmaxSupression, NvMediaArray *keypoints, NvMediaArray *scores)
 Queues an operation to get FAST keypoints throughout an image. More...
 
NvMediaVPIGetSparseFlowPyrLKDescriptorNvMediaVPICreateGetSparseFlowPyrLKDescriptor (NvMediaVPI *vpi, const NvMediaVPIGetSparseFlowPyrLKParams *params)
 Creates a pointer to an NvMediaVPIGetSparseFlowPyrLKDescriptor. More...
 
NvMediaStatus NvMediaVPIGetSparseFlowPyrLKDesc (NvMediaVPI *vpi, NvMediaVPIGetSparseFlowPyrLKDescriptor *descriptor, const NvMediaVPIGetSparseFlowPyrLKParams *params, NvMediaImagePyramid *oldImages, NvMediaImagePyramid *newImages, NvMediaArray *oldPoints, NvMediaArray *newPoints, NvMediaArray *newStatus)
 Queues an operation to track features in a pyramid. More...
 
NvMediaVPIKLTDescriptorNvMediaVPICreateKLTDescriptor (NvMediaVPI *vpi, const uint32_t width, const uint32_t height, const NvMediaSurfaceType type)
 Creates a pointer to the NvMediaVPIKLTDescriptor. More...
 
NvMediaStatus NvMediaVPIKLTDesc (NvMediaVPI *vpi, NvMediaVPIKLTDescriptor *descriptor, const NvMediaVPIKLTParams *params, NvMediaImage *referenceImage, NvMediaImage *templateImage, NvMediaArray *inputBoxList, NvMediaArray *predictedBoxList, NvMediaArray *outputBoxList, NvMediaArray *estimationList)
 Queues an operation to run the Kanade Lucas Tomasi (KLT) tracking algorithm. More...
 
NvMediaStatus NvMediaVPIGetScratchpadSize (void *descriptor, uint32_t *scratchpadSizeBytes)
 Returns the size of scratchpad memory required for operations that support an NvMediaCVScratchpad based scratchpad. More...
 
NvMediaStatus NvMediaVPIKLTFastDesc (NvMediaVPI *vpi, NvMediaVPIKLTDescriptor *descriptor, NvMediaCVScratchpad *scratchpad, const NvMediaVPIKLTParams *params, NvMediaImage *referenceImage, NvMediaImage *templateImage, NvMediaArray *inputBoxList, NvMediaArray *predictedBoxList, NvMediaArray *outputBoxList, NvMediaArray *estimationList)
 Queues an operation to run the Kanade Lucas Tomasi (KLT) tracking algorithm. More...
 
NvMediaStatus NvMediaVPIGetImagePyramid (NvMediaVPI *vpi, NvMediaImage *input, NvMediaImagePyramid *output)
 Queues an operation to generate a Gaussian pyramid from an input image. More...
 
NvMediaStatus NvMediaVPIConvolveImage (NvMediaVPI *vpi, NvMediaImage *input, const float *kernelData, const uint32_t kernelWidth, const uint32_t kernelHeight, NvMediaImage *output)
 Queues an operation to convolve an input image with a client-supplied convolution matrix. More...
 
NvMediaVPIConvolveImageSeparableDescriptorNvMediaVPICreateConvolveImageSeparableDescriptor (NvMediaVPI *vpi, NvMediaSurfaceType type, const float *kernelX, const uint32_t kernelXSize, const float *kernelY, const uint32_t kernelYSize)
 Creates a pointer to the NvMediaVPIConvolveImageSeparableDescriptor. More...
 
NvMediaStatus NvMediaVPIConvolveImageSeparable (NvMediaVPI *vpi, NvMediaImage *input, const float *kernelX, const uint32_t kernelXSize, const float *kernelY, const uint32_t kernelYSize, NvMediaImage *output)
 Queues an operation to convolve an image with a 2D kernel, using separable convolution. More...
 
NvMediaStatus NvMediaVPIFilterImageBox (NvMediaVPI *vpi, NvMediaImage *input, const uint32_t windowWidth, const uint32_t windowHeight, NvMediaImage *output)
 Queues an operation to compute a generic box filter window of the input image. More...
 
NvMediaStatus NvMediaVPIArrayGetPoint2Df (NvMediaArray *array, const uint32_t startIndex, const uint32_t numElements, NvMediaVPIPoint2Df *destPtr)
 Helper function; converts an NvMediaArray of type NVMEDIA_VPI_ARRAY_TYPE_KEYPOINT type to an array of type NvMediaVPIPoint2Df. More...
 
NvMediaStatus NvMediaVPIArrayUpdatePoint2Df (NvMediaVPIPoint2Df *inputPtr, const uint32_t startIndex, const uint32_t numElements, NvMediaArray *destArray)
 Helper function; converts an array of type NvMediaVPIPoint2Df to an NvMediaArray of type NVMEDIA_VPI_ARRAY_TYPE_KEYPOINT. More...
 
NvMediaStatus NvMediaVPIArrayGetAABB (NvMediaArray *array, const uint32_t startIndex, const uint32_t numElements, NvMediaVPIAABB *destPtr)
 Helper function; converts an NvMediaArray of type NVMEDIA_VPI_ARRAY_TYPE_BBOX_XFORM type to an array of type NvMediaVPIAABB. More...
 
NvMediaStatus NvMediaVPIArrayUpdateAABB (NvMediaVPIAABB *inputPtr, const uint32_t startIndex, const uint32_t numElements, NvMediaArray *destArray)
 Helper function; converts an array of type NvMediaVPIAABB to an NvMediaArray of type NVMEDIA_VPI_ARRAY_TYPE_BBOX_XFORM. More...
 
NvMediaStatus NvMediaVPIArrayGetBoundingBoxWithTransform (NvMediaArray *array, const uint32_t startIndex, const uint32_t numElements, NvMediaVPIBoundingBoxWithTransform *destPtr)
 Helper function; converts an NvMediaArray of type NVMEDIA_VPI_ARRAY_TYPE_BBOX_XFORM type to an array of type NvMediaVPIBoundingBoxWithTransform. More...
 
NvMediaStatus NvMediaVPIArrayUpdateBoundingBoxWithTransform (NvMediaVPIBoundingBoxWithTransform *inputPtr, const uint32_t startIndex, const uint32_t numElements, NvMediaArray *destArray)
 Helper function; converts an array of type NvMediaVPIBoundingBoxWithTransform to an NvMediaArray of type NVMEDIA_VPI_ARRAY_TYPE_BBOX_XFORM. More...
 
NvMediaStatus NvMediaVPIArrayGetTranslationWithScale (NvMediaArray *array, const uint32_t startIndex, const uint32_t numElements, NvMediaVPITranslationWithScale *destPtr)
 Helper function; converts an NvMediaArray of type NVMEDIA_VPI_ARRAY_TYPE_TRANSFORM to an array of type NvMediaVPITranslationWithScale. More...
 
NvMediaStatus NvMediaVPIArrayUpdateTranslationWithScale (NvMediaVPITranslationWithScale *inputPtr, const uint32_t startIndex, const uint32_t numElements, NvMediaArray *destArray)
 Helper function; converts an array of type NvMediaVPITranslationWithScale to an NvMediaArray of type NVMEDIA_VPI_ARRAY_TYPE_TRANSFORM. More...
 
NvMediaStatus NvMediaVPIArrayGet2DTransform (NvMediaArray *array, const uint32_t startIndex, const uint32_t numElements, NvMediaVPI2DTransform *destPtr)
 Helper function; converts an NvMediaArray of type NVMEDIA_VPI_ARRAY_TYPE_TRANSFORM type to an array of type NvMediaVPI2DTransform. More...
 
NvMediaStatus NvMediaVPIArrayUpdate2DTransform (NvMediaVPI2DTransform *inputPtr, const uint32_t startIndex, const uint32_t numElements, NvMediaArray *destArray)
 Helper function; converts an array of NvMediaVPI2DTransform to NvMediaArray of NVMEDIA_VPI_ARRAY_TYPE_TRANSFORM type. More...
 
NvMediaStatus NvMediaVPIDestroyDescriptor (NvMediaVPI *vpi, void *descriptor)
 Destroys an NvMediaVPI function descriptor. More...
 

Macro Definition Documentation

#define NVMEDIA_VPI_MAX_QUEUED_TASKS   64

Maximum number of tasks that can be queued.

Used by NvMediaVPICreate().

Definition at line 47 of file nvmedia_vpi.h.

#define NVMEDIA_VPI_VERSION_MAJOR   2

Major version number.

Definition at line 41 of file nvmedia_vpi.h.

#define NVMEDIA_VPI_VERSION_MINOR   3

Minor version number.

Definition at line 43 of file nvmedia_vpi.h.

Typedef Documentation

typedef struct NvMediaVPI NvMediaVPI

Holds an opaque object representing NvMediaVPI.

Definition at line 52 of file nvmedia_vpi.h.

NvMediaVPIConvertMV descriptor.

Definition at line 454 of file nvmedia_vpi.h.

NvMediaVPIConvolveImageSeparableDescriptor.

Definition at line 1238 of file nvmedia_vpi.h.

NvMediaVPISparseFlowPyr descriptor.

Definition at line 919 of file nvmedia_vpi.h.

NvMediaVPIKLTDescriptor descriptor.

Definition at line 981 of file nvmedia_vpi.h.

Specifies the types of KLT Tracking.

NvMediaVPIProcessStereo descriptor.

Definition at line 386 of file nvmedia_vpi.h.

NvMediaVPISteroPostprocess descriptor.

Definition at line 524 of file nvmedia_vpi.h.

NvMediaVPISteroPreprocess descriptor.

Definition at line 596 of file nvmedia_vpi.h.

Enumeration Type Documentation

Defines the different types of VPI-specific arrays.

Enumerator
NVMEDIA_VPI_ARRAY_TYPE_KEYPOINT 

Keypoint type.

NVMEDIA_VPI_ARRAY_TYPE_BBOX_XFORM 

Bounding Box with Transform type.

NVMEDIA_VPI_ARRAY_TYPE_TRANSFORM 

Transform type.

NVMEDIA_VPI_ARRAY_NUM_TYPES 

Number of types.

Definition at line 56 of file nvmedia_vpi.h.

Specifies types of filters used in the Harris corner detector.

Enumerator
NVMEDIA_VPI_HARRIS_FILTER_TYPE_DEFAULT 

Built-in normalized separable Sobel filter.

NVMEDIA_VPI_HARRIS_FILTER_TYPE_USER 

User-supplied separable gradient filter.

The filter is automatically normalized.

Definition at line 699 of file nvmedia_vpi.h.

Specifies the types of KLT Tracking.

Enumerator
NVMEDIA_VPI_KLT_INVERSE_COMPOSITIONAL 

Specifies Inverse Compositional tracking type.

Definition at line 1002 of file nvmedia_vpi.h.

Specifies types of post-process non-maximum suppression.

Enumerator
NVMEDIA_VPI_2D_GRID_8x8_CELL_NO_MIN_DISTANCE 

Definition at line 691 of file nvmedia_vpi.h.

Specifies the types of output for Optical Flow/Stereo Disparity processing.

Enumerator
NVMEDIA_VPI_STEREO_DISPARITY 

Disparity relative to reference.

NVMEDIA_VPI_MV 

Absolute motion vector output.

NVMEDIA_VPI_MV_HINTS 

Motion vector hints for the NVENC hardware engine, which performs video encoding.

When this type is used with processStereoPair(), the output holds data of type NvMediaEncodeExternalMEHint.

Definition at line 392 of file nvmedia_vpi.h.

Specifies the conditions that cause the Lucas-Kanade Feature Tracker to be terminated.

Enumerator
NVMEDIA_VPI_TERMINATION_CRITERION_ITERATIONS 

Specifies termination by the number of iterations.

NVMEDIA_VPI_TERMINATION_CRITERION_EPSILON 

Specifies termination by matching the value against epsilon.

NVMEDIA_VPI_TERMINATION_CRITERION_BOTH 

Specifies termination by iterations or epsilon, whichever happens first.

Definition at line 884 of file nvmedia_vpi.h.

Function Documentation

NvMediaArray* NvMediaVPIArrayCreate ( NvMediaDevice device,
NvMediaVPIArrayType  type,
uint32_t  numElements,
const NvMediaArrayAllocAttr attrs,
uint32_t  numAttrs 
)

Creates an NvMediaArray for a VPI-specific element type.

Parameters
[in]deviceHandle to the NvMedia device obtained by calling NvMediaDeviceCreate().
[in]typeType of array to be created.
[in]numElementsNumber of elements in the array.
[in]attrsA pointer to an array of allocation attributes.
[in]numAttrsNumber of allocation elelments in attrs.
Returns
Handle to the array, or NULL if unsuccessful.
NvMediaStatus NvMediaVPIArrayGet2DTransform ( NvMediaArray array,
const uint32_t  startIndex,
const uint32_t  numElements,
NvMediaVPI2DTransform destPtr 
)

Helper function; converts an NvMediaArray of type NVMEDIA_VPI_ARRAY_TYPE_TRANSFORM type to an array of type NvMediaVPI2DTransform.

Parameters
[in]arrayA pointer to the input NvMediaArray. The array must be created by a call to NvMediaVPIArrayCreate().
[in]startIndexIndex offset (number of elements) into array.
[in]numElementsNumber of elements to write to destination.
[out]destPtrA pointer to a location in which to write the output array.
Returns
Status indicator. Possible values are:
NvMediaStatus NvMediaVPIArrayGetAABB ( NvMediaArray array,
const uint32_t  startIndex,
const uint32_t  numElements,
NvMediaVPIAABB destPtr 
)

Helper function; converts an NvMediaArray of type NVMEDIA_VPI_ARRAY_TYPE_BBOX_XFORM type to an array of type NvMediaVPIAABB.

Parameters
[in]arrayA pointer to an input NvMediaArray. The array must be created with NvMediaVPIArrayCreate().
[in]startIndexIndex offset (number of elements) into array.
[in]numElementsNumber of elements to write to destination.
[out]destPtrA pointer to the location at which to write the output array.
Returns
Status indicator. Possible values are:
NvMediaStatus NvMediaVPIArrayGetBoundingBoxWithTransform ( NvMediaArray array,
const uint32_t  startIndex,
const uint32_t  numElements,
NvMediaVPIBoundingBoxWithTransform destPtr 
)

Helper function; converts an NvMediaArray of type NVMEDIA_VPI_ARRAY_TYPE_BBOX_XFORM type to an array of type NvMediaVPIBoundingBoxWithTransform.

Parameters
[in]arrayA pointer to the input NvMediaArray. The array must be created by a call to NvMediaVPIArrayCreate().
[in]startIndexIndex offset (number of elements) into array.
[in]numElementsNumber of elements to write to destination.
[out]destPtrA pointer to a location in which to write the output array.
Returns
Status indicator. Possible values are:
NvMediaStatus NvMediaVPIArrayGetPoint2Df ( NvMediaArray array,
const uint32_t  startIndex,
const uint32_t  numElements,
NvMediaVPIPoint2Df destPtr 
)

Helper function; converts an NvMediaArray of type NVMEDIA_VPI_ARRAY_TYPE_KEYPOINT type to an array of type NvMediaVPIPoint2Df.

Parameters
[in]arrayA pointer to the input NvMediaArray. The array must be created with NvMediaVPIArrayCreate().
[in]startIndexIndex offset (number of elements) into the array. Currently 0 (zero) is the only value supported.
[in]numElementsNumber of elements to write to the destination.
[out]destPtrA pointer to the location where the output array is to be written.
Returns
Status indicator. Possible values are:
NvMediaStatus NvMediaVPIArrayGetTranslationWithScale ( NvMediaArray array,
const uint32_t  startIndex,
const uint32_t  numElements,
NvMediaVPITranslationWithScale destPtr 
)

Helper function; converts an NvMediaArray of type NVMEDIA_VPI_ARRAY_TYPE_TRANSFORM to an array of type NvMediaVPITranslationWithScale.

Parameters
[in]arrayA pointer to the input NvMediaArray. The array must be created by a call to NvMediaVPIArrayCreate().
[in]startIndexIndex offset (number of elements) into array.
[in]numElementsNumber of elements to write to destination.
[out]destPtrA pointer to a location at which to write the output array.
Returns
Status indicator. Possible values are:
NvMediaStatus NvMediaVPIArrayRegister ( NvMediaVPI vpi,
NvMediaArray array 
)

Registers an array for use with an NvMediaVPI function.

Parameters
[in]vpiA pointer to the Vision Programming Interface returned by NvMediaVPICreate().
[in]arrayA pointer to array to be registered.
Returns
Status indicator. Possible values are:
NvMediaStatus NvMediaVPIArrayUnregister ( NvMediaVPI vpi,
NvMediaArray array 
)

Unregisters an array after use.

Parameters
[in]vpiA pointer to the Vision Programming Interface returned by NvMediaVPICreate().
[in]arrayA pointer to array to be unregistered.
Returns
Status indicator. Possible values are:
NvMediaStatus NvMediaVPIArrayUpdate2DTransform ( NvMediaVPI2DTransform inputPtr,
const uint32_t  startIndex,
const uint32_t  numElements,
NvMediaArray destArray 
)

Helper function; converts an array of NvMediaVPI2DTransform to NvMediaArray of NVMEDIA_VPI_ARRAY_TYPE_TRANSFORM type.

Parameters
[in]inputPtrA pointer to the input array.
[in]startIndexIndex offset (number of elements) into array.
[in]numElementsNumber of elements to write to destination.
[out]destArrayA pointer to output NvMediaArray. destArray must be created by a call to NvMediaVPIArrayCreate().
Returns
Status indicator. Possible values are:
NvMediaStatus NvMediaVPIArrayUpdateAABB ( NvMediaVPIAABB inputPtr,
const uint32_t  startIndex,
const uint32_t  numElements,
NvMediaArray destArray 
)

Helper function; converts an array of type NvMediaVPIAABB to an NvMediaArray of type NVMEDIA_VPI_ARRAY_TYPE_BBOX_XFORM.

Parameters
[in]inputPtrA pointer to the input array.
[in]startIndexIndex offset (number of elements) into the destination array.
[in]numElementsNumber of elements to write to the destination.
[out]destArrayA pointer to the output NvMediaArray. destArray must be created by a call to NvMediaVPIArrayCreate().
Returns
Status indicator. Possible values are:
NvMediaStatus NvMediaVPIArrayUpdateBoundingBoxWithTransform ( NvMediaVPIBoundingBoxWithTransform inputPtr,
const uint32_t  startIndex,
const uint32_t  numElements,
NvMediaArray destArray 
)

Helper function; converts an array of type NvMediaVPIBoundingBoxWithTransform to an NvMediaArray of type NVMEDIA_VPI_ARRAY_TYPE_BBOX_XFORM.

Parameters
[in]inputPtrA pointer to the input array.
[in]startIndexIndex offset (number of elements) into destination array.
[in]numElementsNumber of elements to write to the destination.
[out]destArrayA pointer to an output NvMediaArray. destArray must be created by a call to NvMediaVPIArrayCreate().
Returns
Status indicator. Possible values are:
NvMediaStatus NvMediaVPIArrayUpdatePoint2Df ( NvMediaVPIPoint2Df inputPtr,
const uint32_t  startIndex,
const uint32_t  numElements,
NvMediaArray destArray 
)

Helper function; converts an array of type NvMediaVPIPoint2Df to an NvMediaArray of type NVMEDIA_VPI_ARRAY_TYPE_KEYPOINT.

Parameters
[in]inputPtrA pointer to the input array.
[in]startIndexIndex offset (number of elements) into the destination array.
[in]numElementsNumber of elements to write to the destination.
[out]destArrayA pointer to the output NvMediaArray. destArray must be created by a call to NvMediaVPIArrayCreate() with type set to NVMEDIA_VPI_ARRAY_TYPE_KEYPOINT.
Returns
Status indicator. Possible values are:
NvMediaStatus NvMediaVPIArrayUpdateTranslationWithScale ( NvMediaVPITranslationWithScale inputPtr,
const uint32_t  startIndex,
const uint32_t  numElements,
NvMediaArray destArray 
)

Helper function; converts an array of type NvMediaVPITranslationWithScale to an NvMediaArray of type NVMEDIA_VPI_ARRAY_TYPE_TRANSFORM.

Parameters
[in]inputPtrA pointer to the input array.
[in]startIndexIndex offset (number of elements) into destination array.
[in]numElementsNumber of elements to write to destination.
[out]destArrayA pointer to the output NvMediaArray. destArray must be created by a call to NvMediaVPIArrayCreate().
Returns
Status indicator. Possible values are:
NvMediaStatus NvMediaVPIConvertMVDesc ( NvMediaVPI vpi,
NvMediaVPIConvertMVDescriptor descriptor,
NvMediaImage inputMVImage,
NvMediaImage inputColor,
NvMediaImage output,
const NvMediaVPIOFSTOutputType  outputType 
)

Converts or refines a motion vector image.

The processing done on the image depends on the outputType parameter:

NvMediaStatus NvMediaVPIConvolveImage ( NvMediaVPI vpi,
NvMediaImage input,
const float *  kernelData,
const uint32_t  kernelWidth,
const uint32_t  kernelHeight,
NvMediaImage output 
)

Queues an operation to convolve an input image with a client-supplied convolution matrix.

Note
NvMediaVPIFlush() must be called to actually flush the queue to the engine.
Parameters
[in]vpiA pointer to the Vision Programming Interface object returned by NvMediaVPICreate().
[in]inputA pointer to an NvMediaImage image.
[in]kernelDataA pointer to the convolution kernel coefficients.
[in]kernelWidthConvolution kernel width.
[in]kernelHeightConvolution kernel height.
[out]outputA pointer to an NvMediaImage image.
Returns
Status indicator. Possible values are:
NvMediaStatus NvMediaVPIConvolveImageSeparable ( NvMediaVPI vpi,
NvMediaImage input,
const float *  kernelX,
const uint32_t  kernelXSize,
const float *  kernelY,
const uint32_t  kernelYSize,
NvMediaImage output 
)

Queues an operation to convolve an image with a 2D kernel, using separable convolution.

Note
NvMediaVPIFlush() must be called to actually flush the queue to the engine.
Parameters
[in]vpiA pointer to the Vision Programming Interface object returned by NvMediaVPICreate().
[in]inputA pointer to an NvMediaImage image.
[in]kernelXA pointer to the x convolution kernel coefficients.
[in]kernelXSizeSize of the x convolution kernel.
[in]kernelYA pointer to the y convolution kernel coefficients.
[in]kernelYSizeSize of the y convolution kernel.
[in]outputA pointer to an NvMediaImage image.
Returns
Status indicator. Possible values are:
NvMediaVPI* NvMediaVPICreate ( const uint32_t  Id,
const uint32_t  maxQueuedTasks 
)

Creates an NvMediaVPI object.

Parameters
[in]IdEngine ID. Must be less than the value returned by NvMediaVPIGetNumEngines().
[in]maxQueuedTasksNumber of simultaneous tasks that can be submitted to an instance at a time, before NvMediaVPIFlush must be called. maxQueuedTasks is clamped between 1 and NVMEDIA_VPI_MAX_QUEUED_TASKS.
Returns
A pointer to an Vision Programming Interface if successful, or NULL otherwise.
NvMediaVPIConvertMVDescriptor* NvMediaVPICreateConvertMVDescriptor ( NvMediaVPI vpi,
const uint32_t  width,
const uint32_t  height,
const NvMediaSurfaceType  type,
const float  strength,
const float  scale 
)

Creates an NvMediaVPIConvertMVDescriptor.

Parameters
[in]vpiA pointer to the Vision Programming Interface object returned by NvMediaVPICreate().
[in]widthWidth of the input depth image.
[in]heightHeight of the input depth image.
[in]typeNvMediaSurfaceType of the input depth image.
[in]strengthSmoothing strength: a value in the range (0.0,1.0).
[in]scaleScale factor.
Returns
A pointer to the NvMediaVPIConvertMVDescriptor.
NvMediaVPIConvolveImageSeparableDescriptor* NvMediaVPICreateConvolveImageSeparableDescriptor ( NvMediaVPI vpi,
NvMediaSurfaceType  type,
const float *  kernelX,
const uint32_t  kernelXSize,
const float *  kernelY,
const uint32_t  kernelYSize 
)

Creates a pointer to the NvMediaVPIConvolveImageSeparableDescriptor.

Parameters
[in]vpiA pointer to the Vision Programming Interface object returned by NvMediaVPICreate().
[in]typeNvMediaSurfaceType of the input image.
[in]kernelXA pointer to the x convolution kernel coefficients.
[in]kernelXSizeSize of the x convolution kernel.
[in]kernelYA pointer to the y convolution kernel coefficients.
[in]kernelYSizeSize of the y convolution kernel.
Returns
A pointer to the NvMediaVPIConvolveImageSeparableDescriptor.
NvMediaVPIGetKeyPointsFastDescriptor* NvMediaVPICreateGetKeyPointsFastDescriptor ( NvMediaVPI vpi,
const uint32_t  width,
const uint32_t  height,
const NvMediaSurfaceType  type 
)

Creates a pointer to an NvMediaVPIGetKeyPointsFastDescriptor.

Parameters
[in]vpiA pointer to the Vision Programming Interface object returned by NvMediaVPICreate().
[in]widthWidth of the input image.
[in]heightHeight of the input image.
[in]typeNvMediaSurfaceType of the input image.
Returns
A pointer to the NvMediaVPIGetKeyPointsFastDescriptor.
NvMediaVPIGetKeyPointsHarrisDescriptor* NvMediaVPICreateGetKeyPointsHarrisDescriptor ( NvMediaVPI vpi,
const uint32_t  width,
const uint32_t  height,
const NvMediaVPINonMaxSuppressionType  nonMaxSuppressionType 
)

Creates a pointer to a NvMediaVPIGetKeyPointsHarrisDescriptor.

Parameters
[in]vpiA pointer to the Vision Programming Interface returned by NvMediaVPICreate().
[in]widthInput image width.
[in]heightInput image height.
[in]nonMaxSuppressionTypePost-process non-maximum suppression type.
Returns
A pointer to the NvMediaVPIGetKeyPointsHarrisDescriptor.
NvMediaVPIGetSparseFlowPyrLKDescriptor* NvMediaVPICreateGetSparseFlowPyrLKDescriptor ( NvMediaVPI vpi,
const NvMediaVPIGetSparseFlowPyrLKParams params 
)

Creates a pointer to an NvMediaVPIGetSparseFlowPyrLKDescriptor.

Parameters
[in]vpiA pointer to an Vision Programming Interface object returned by NvMediaVPICreate().
[in]paramsA pointer to an NvMediaVPIGetSparseFlowPyrLKParams.
Returns
A pointer to an NvMediaVPIGetSparseFlowPyrLKDescriptor.
NvMediaVPIKLTDescriptor* NvMediaVPICreateKLTDescriptor ( NvMediaVPI vpi,
const uint32_t  width,
const uint32_t  height,
const NvMediaSurfaceType  type 
)

Creates a pointer to the NvMediaVPIKLTDescriptor.

Parameters
[in]vpiA pointer to a Vision Programming Interface object returned by NvMediaVPICreate().
[in]widthWidth of the input image.
[in]heightHeight of the input image.
[in]typeNvMediaSurfaceType of the input image.
Returns
A pointer to the NvMediaVPIKLTDescriptor.
NvMediaVPIProcessStereoDescriptor* NvMediaVPICreateProcessStereoPairDescriptor ( NvMediaVPI vpi,
const uint32_t  width,
const uint32_t  height,
const NvMediaVPIOFSTOutputType  outputType 
)

Creates NvMediaVPIProcessStereoDescriptor.

Parameters
[in]vpiA pointer to the Vision Programming Interface object returned by NvMediaVPICreate().
[in]widthWidth of the input images.
[in]heightHeight of the input images.
[in]outputTypeNvMediaVPIOFSTOutputType for type of output.
Returns
A pointer to the NvMediaVPIProcessStereoDescriptor.
NvMediaVPIStereoPostprocessDescriptor* NvMediaVPICreateStereoPostprocessDescriptor ( NvMediaVPI vpi,
const uint32_t  width,
const uint32_t  height,
const float  scale 
)

Creates an NvMediaVPIStereoPostprocessDescriptor.

Parameters
[in]vpiA pointer to the Vision Programming Interface returned by NvMediaVPICreate().
[in]widthWidth of the input disparity image.
[in]heightHeight of the input disparity image.
[in]scaleUpsample scale factor. Must be 1.0 or 4.0.
Returns
A pointer to the NvMediaVPIStereoPostprocessDescriptor.
NvMediaVPIStereoPreprocessDescriptor* NvMediaVPICreateStereoPreprocessDescriptor ( NvMediaVPI vpi,
const uint32_t  width,
const uint32_t  height,
const NvMediaVPIOFSTOutputType  outputType 
)

Creates an NvMediaVPIStereoPreprocessDescriptor.

Parameters
[in]vpiA pointer to the Vision Programming Interface returned by NvMediaVPICreate().
[in]widthWidth of the input disparity image.
[in]heightHeight of the input disparity image.
[in]outputTypeAn NvMediaVPIOFSTOutputType specifying the type of output.
Returns
A pointer to the NvMediaVPIStereoPreprocessDescriptor.
NvMediaStatus NvMediaVPIDestroy ( NvMediaVPI vpi)

Destroys an Vision Programming Interface object created by NvMediaVPICreate().

Parameters
[in]vpiA pointer to the object to be destroyed.
Returns
Status indicator. Possible values are:
NvMediaStatus NvMediaVPIDestroyDescriptor ( NvMediaVPI vpi,
void *  descriptor 
)

Destroys an NvMediaVPI function descriptor.

Parameters
[in]vpiA pointer to an Vision Programming Interface object returned by NvMediaVPICreate().
[in]descriptorA pointer to an NvMediaVPI function descriptor.
Returns
Status indicator. Possible values are:
NvMediaStatus NvMediaVPIFilterImageBox ( NvMediaVPI vpi,
NvMediaImage input,
const uint32_t  windowWidth,
const uint32_t  windowHeight,
NvMediaImage output 
)

Queues an operation to compute a generic box filter window of the input image.

Note
NvMediaVPIFlush() must be called to actually flush the queue to the engine.
Parameters
[in]vpiA pointer to the Vision Programming Interface object returned by NvMediaVPICreate().
[in]inputA pointer to an NvMediaImage image.
[in]windowWidthWindow width.
[in]windowHeightWindow height.
[in]outputA pointer to an NvMediaImage image.
Returns
Status indicator. Possible values are:
NvMediaStatus NvMediaVPIFlush ( NvMediaVPI vpi)

Flushes all queued operations.

Parameters
[in]vpiA pointer to the Vision Programming Interface returned by NvMediaVPICreate().
Returns
Status indicator. Possible values are:
NvMediaStatus NvMediaVPIGetImagePyramid ( NvMediaVPI vpi,
NvMediaImage input,
NvMediaImagePyramid output 
)

Queues an operation to generate a Gaussian pyramid from an input image.

Note
NvMediaVPIFlush() must be called to actually flush the queue to the engine.
Parameters
[in]vpiA pointer to the Vision Programming Interface object returned by NvMediaVPICreate().
[in]inputA pointer to an NvMediaImage image. The image may be the same NvMediaImage as is returned by NvMediaImagePyramidGetImageForLevel(output, 0), thereby saving a copy operation of the input to the output.
[out]outputA pointer to an NvMediaImagePyramid.
Returns
Status indicator. Possible values are:
NvMediaStatus NvMediaVPIGetKeyPointsFastDesc ( NvMediaVPI vpi,
NvMediaVPIGetKeyPointsFastDescriptor descriptor,
NvMediaImage input,
const uint32_t  strengthThresh,
const NvMediaBool  nonmaxSupression,
NvMediaArray keypoints,
NvMediaArray scores 
)

Queues an operation to get FAST keypoints throughout an image.

If the keypoints array is not empty, then the operation tracks the keypoints as well.

Note
NvMediaVPIFlush() must be called to actually flush the queue to the engine.
Parameters
[in]vpiA pointer to the Vision Programming Interface object returned by NvMediaVPICreate().
[in,out]descriptorA pointer returned by NvMediaVPICreateGetKeyPointsFastDescriptor().
[in]inputNvMediaImage image.
[in]strengthThreshThreshold of difference between intensity of the central pixel and pixels on Bresenham's circle of radius 3.
[in]nonmaxSupressionIndicates whether to apply non-maximum suppression.
[in,out]keypointsA pointer to an NvMediaArray containing keypoints.
[out]scoresA pointer to an NvMediaArray containing scores.
Returns
Status indicator. Possible values are:
NvMediaStatus NvMediaVPIGetKeyPointsHarrisDesc ( NvMediaVPI vpi,
NvMediaVPIGetKeyPointsHarrisDescriptor descriptor,
const NvMediaVPIGetKeyPointsHarrisParams params,
NvMediaImage input,
NvMediaImage mask,
NvMediaArray trackedKeypoints,
NvMediaArray trackedScores,
NvMediaArray keypoints,
NvMediaArray scores 
)

Queues an operation to get Harris keypoints throughout an image.

If the tracked keypoints array is not empty, then those keypoints are inserted at the beginning of the output keypoints array. An optional mask can be supplied to suppress detected and tracked keypoints. Suppressed tracked keypoints are removed from the output array. Non-maximum suppression is applied only to newly detected keypoints.

Note
NvMediaVPIFlush() must be called to actually flush the queue to the engine.
Parameters
[in]vpiA pointer to the Vision Programming Interface object returned by NvMediaVPICreate().
[in,out]descriptorA pointer returned by NvMediaVPICreateGetKeyPointsHarrisDescriptor().
[in]paramsA pointer to NvMediaVPIGetKeyPointsHarrisParams.
[in]inputA pointer to an NvMediaImage image.
[in]maskNvMediaImage mask image. Optional. Value may be 0 (suppressed) or 0xFF (not suppressed).
[in]trackedKeypointsA pointer to an NvMediaArray containing keypoints to track. Optional. If NULL, trackedScores must be NULL. The array must be of type NVMEDIA_VPI_ARRAY_TYPE_KEYPOINT, created by a call to NvMediaVPIArrayCreate.
[in]trackedScoresA pointer to an NvMediaArray containing scores of keypoints to track. Optional. If NULL, trackedKeypoints must be NULL.
[out]keypointsA pointer to an NvMediaArray containing keypoints. array must be of NVMEDIA_VPI_ARRAY_TYPE_KEYPOINT type created by a call to NvMediaVPIArrayCreate().
[out]scoresA pointer to an NvMediaArray containing scores.
Returns
Status indicator. Possible values are:
NvMediaStatus NvMediaVPIGetNumEngines ( uint32_t *  numEngines)

Returns the number of HW engines accessible.

Parameters
[in]numEnginesA pointer to the number of engines.
Returns
Status indicator. Possible values are:
NvMediaStatus NvMediaVPIGetScratchpadSize ( void *  descriptor,
uint32_t *  scratchpadSizeBytes 
)

Returns the size of scratchpad memory required for operations that support an NvMediaCVScratchpad based scratchpad.

Parameters
[in]descriptorA pointer returned by NvMediaVPICreateXYZDescriptor().
[out]scratchpadSizeBytesA pointer to the amount of scratchpad memory required for the operation, in bytes.
Returns
Status indicator. Possible values are:
NvMediaStatus NvMediaVPIGetSparseFlowPyrLKDesc ( NvMediaVPI vpi,
NvMediaVPIGetSparseFlowPyrLKDescriptor descriptor,
const NvMediaVPIGetSparseFlowPyrLKParams params,
NvMediaImagePyramid oldImages,
NvMediaImagePyramid newImages,
NvMediaArray oldPoints,
NvMediaArray newPoints,
NvMediaArray newStatus 
)

Queues an operation to track features in a pyramid.

Note
NvMediaVPIFlush() must be called to actually flush the queue to the engine.
Parameters
[in]vpiA pointer to an Vision Programming Interface object returned by NvMediaVPICreate().
[in,out]descriptorA pointer returned by NvMediaVPICreateGetSparseFlowPyrLKDescriptor().
[in]paramsA pointer to an NvMediaVPIGetSparseFlowPyrLKParams.
[in]oldImagesA pointer to the input NvMediaImagePyramid of first (old) images.
[in]newImagesA pointer to the input NvMediaImagePyramid of destination (new) images.
[in]oldPointsA pointer to an array of keypoints in the oldImages high resolution pyramid.
[in,out]newPointsA pointer to an array of keypoints in the newImages high resolution pyramid. It is used for starting a search in newImages.
[out]newStatusA pointer to an array for tracking status for each input in oldPoints.
Returns
Status indicator. Possible values are:
NvMediaStatus NvMediaVPIGetVersion ( NvMediaVersion version)

Returns version information for the NvMediaVPI library.

Parameters
[in]versionA pointer to a NvMediaVersion structure filled by the NvMediaVPI library.
Returns
Status indicator. Possible values are:
NvMediaStatus NvMediaVPIImageRegister ( NvMediaVPI vpi,
NvMediaImage image 
)

Registers an image for use with an NvMediaVPI function.

Parameters
[in]vpiA pointer to the Vision Programming Interface returned by NvMediaVPICreate().
[in]imageA pointer to image to be registered.
Returns
Status indicator. Possible values are:
NvMediaStatus NvMediaVPIImageUnregister ( NvMediaVPI vpi,
NvMediaImage image 
)

Unregisters an image after use.

Parameters
[in]vpiA pointer to the Vision Programming Interface returned by NvMediaVPICreate().
[in]imageA pointer to the image to be unregistered.
Returns
Status indicator. Possible values are:
NvMediaStatus NvMediaVPIKLTDesc ( NvMediaVPI vpi,
NvMediaVPIKLTDescriptor descriptor,
const NvMediaVPIKLTParams params,
NvMediaImage referenceImage,
NvMediaImage templateImage,
NvMediaArray inputBoxList,
NvMediaArray predictedBoxList,
NvMediaArray outputBoxList,
NvMediaArray estimationList 
)

Queues an operation to run the Kanade Lucas Tomasi (KLT) tracking algorithm.

Note
NvMediaVPIFlush() must be called to actually flush the queue to the engine.
Parameters
[in]vpiA pointer to an Vision Programming Interface object returned by NvMediaVPICreate().
[in,out]descriptorA pointer returned by NvMediaVPICreateKLTDescriptor().
[in]paramsA pointer to an NvMediaVPIKLTParams object.
[in]referenceImageA pointer to an NvMediaImage reference image.
[in]templateImageA pointer to an NvMediaImage template image.
[in]inputBoxListA pointer to an NvMediaArray input bounding box list. The array must be of type NVMEDIA_VPI_ARRAY_TYPE_BBOX_XFORM, created by a call to NvMediaVPIArrayCreate().
[in]predictedBoxListA pointer to an NvMediaArray predicted bounding box list. The array must be of type NVMEDIA_VPI_ARRAY_TYPE_TRANSFORM, created by a call to NvMediaVPIArrayCreate().
[out]outputBoxListA pointer to an NvMediaArray output bounding box list. The array must be of type NVMEDIA_VPI_ARRAY_TYPE_BBOX_XFORM, created by a call to NvMediaVPIArrayCreate().
[out]estimationListA pointer to an NvMediaArray output estimated motion. The array must be of type NVMEDIA_VPI_ARRAY_TYPE_TRANSFORM, created by a call to NvMediaVPIArrayCreate().
Returns
Status indicator. Possible values are:
NvMediaStatus NvMediaVPIKLTFastDesc ( NvMediaVPI vpi,
NvMediaVPIKLTDescriptor descriptor,
NvMediaCVScratchpad scratchpad,
const NvMediaVPIKLTParams params,
NvMediaImage referenceImage,
NvMediaImage templateImage,
NvMediaArray inputBoxList,
NvMediaArray predictedBoxList,
NvMediaArray outputBoxList,
NvMediaArray estimationList 
)

Queues an operation to run the Kanade Lucas Tomasi (KLT) tracking algorithm.

This version uses CVScratchpad for optimized operation.

Note
NvMediaVPIFlush() must be called to actually flush the queue to the engine.
Parameters
[in]vpiA pointer to the Vision Programming Interface object returned by NvMediaVPICreate().
[in,out]descriptorA pointer returned by NvMediaVPICreateKLTDescriptor().
[in]scratchpadA pointer to an NvMediaCVScratchpad created by NvMediaCVScratchpadCreate().
[in]paramsA pointer to an NvMediaVPIKLTParams object.
[in]referenceImageA pointer to an NvMediaImage reference image.
[in]templateImage( A pointer to an NvMediaImage template image.
[in]inputBoxListA pointer to an NvMediaArray input bounding box list. The array must be of type NVMEDIA_VPI_ARRAY_TYPE_BBOX_XFORM, created by a call to NvMediaVPIArrayCreate().
[in]predictedBoxListA pointer to an NvMediaArray predicted bounding box list. The array must be of type NVMEDIA_VPI_ARRAY_TYPE_TRANSFORM type, created by a call to NvMediaVPIArrayCreate().
[out]outputBoxListA pointer to an NvMediaArray output bounding box list. The array must be of type NVMEDIA_VPI_ARRAY_TYPE_BBOX_XFORM, created by a call to NvMediaVPIArrayCreate().
[out]estimationListA pointer to an NvMediaArray output estimated motion. The array must be of type NVMEDIA_VPI_ARRAY_TYPE_TRANSFORM type, created by a call to NvMediaVPIArrayCreate().
Returns
Status indicator. Possible values are:
NvMediaStatus NvMediaVPIProcessStereoPairDesc ( NvMediaVPI vpi,
NvMediaVPIProcessStereoDescriptor descriptor,
NvMediaImage left,
NvMediaImage right,
NvMediaImage output 
)

Queues an operation to process a stereo image pair.

Note
NvMediaVPIFlush() must be called to actually flush the queue to the engine.
Parameters
[in]vpiA pointer to the Vision Programming Interface returned by NvMediaVPICreate().
[in,out]descriptorPointer returned by NvMediaVPICreateProcessStereoPairDescriptor().
[in]leftA pointer to the left NvMediaImage image.
[in]rightA pointer to the right NvMediaImage image.
[out]outputA pointer to the output NvMediaImage image.
Returns
Status indicator. Possible values are:
NvMediaStatus NvMediaVPIPyramidRegister ( NvMediaVPI vpi,
NvMediaImagePyramid pyramid 
)

Registers a pyramid for use with an NvMediaVPI function.

Parameters
[in]vpiA pointer to the Vision Programming Interface returned by NvMediaVPICreate().
[in]pyramidA pointer to the pyramid to be registered.
Returns
Status indicator. Possible values are:
NvMediaStatus NvMediaVPIPyramidUnregister ( NvMediaVPI vpi,
NvMediaImagePyramid pyramid 
)

Unregisters a pyramid after use.

Parameters
[in]vpiA pointer to the Vision Programming Interface returned by NvMediaVPICreate().
[in]pyramidA pointer to the pyramid to be unregistered.
Returns
Status indicator. Possible values are:
NvMediaStatus NvMediaVPIScratchpadRegister ( NvMediaVPI vpi,
NvMediaCVScratchpad scratchpad 
)

Registers scratchpad memory for use with an NvMediaVPI function.

Parameters
[in]vpiA pointer to the Vision Programming Interface returned by NvMediaVPICreate().
[in]scratchpadA pointer to the NvMediaCVScratchpad handle to be registered.
Returns
Status indicator. Possible values are:
NvMediaStatus NvMediaVPIScratchpadUnregister ( NvMediaVPI vpi,
NvMediaCVScratchpad scratchpad 
)

Unregisters scratchpad memory after use.

Parameters
[in]vpiA pointer to the Vision Programming Interface returned by NvMediaVPICreate().
[in]scratchpadA pointer to the NvMediaCVScratchpad handle to be unregistered.
Returns
Status indicator. Possible values are:
NvMediaStatus NvMediaVPIStereoPostprocessDesc ( NvMediaVPI vpi,
NvMediaVPIStereoPostprocessDescriptor descriptor,
NvMediaVPIStereoPostprocessParams params,
NvMediaImage disparityInput,
NvMediaImage confidenceInput,
NvMediaImage disparityOutput,
NvMediaImage confidenceOutput 
)

Performs stereo postprocessing to refine a disparity image.

Note
NvMediaVPIFlush() must be called to actually flush the queue to the engine.
Parameters
[in]vpiA pointer to the Vision Programming Interface returned by NvMediaVPICreate().
[in,out]descriptorA pointer returned by NvMediaVPICreateStereoPostprocessDescriptor().
[in]paramsA pointer to an NvMediaVPIStereoPostprocessParams.
[in]disparityInputA pointer to an input disparity image that needs refinement.
[in]confidenceInputA pointer to an input confidence map.
[out]disparityOutputA pointer to the refined and upscaled (for scale>1.0) disparity image.
[out]confidenceOutputA pointer to the refined and upscaled (for scale>1.0) confidence map.
Returns
Status indicator. Possible values are:
NvMediaStatus NvMediaVPIStereoPreprocessDesc ( NvMediaVPI vpi,
NvMediaVPIStereoPreprocessDescriptor descriptor,
NvMediaVPIStereoPreprocessParams params,
NvMediaArray confidenceTable,
NvMediaImage leftImage,
NvMediaImage rightImage,
NvMediaImage output0,
NvMediaImage output1 
)

Performs stereo preprocessing to produce a disparity image or motion vector hints.

Note
NvMediaVPIFlush() must be called to actually flush the queue to the engine.
Parameters
[in]vpiA pointer to the Vision Programming Interface returned by NvMediaVPICreate().
[in,out]descriptorA pointer returned by NvMediaVPICreateStereoPreprocessDescriptor().
[in]paramsA pointer to an NvMediaVPIStereoPreprocessParams.
[in]confidenceTableA pointer to an NvMediaArray containing mapped confidence. The array must be of unsigned int16 type with a capacity at least NVPVA_STEREO_CONF_GEN_MAX_CONF_TABLE_LEN.
[in]leftImageA pointer to the input left image.
[in]rightImageA pointer to the input right image.
[out]output0A pointer to the first output image. It contains hints if NvMediaVPIOFSTOutputType is NVMEDIA_VPI_MV_HINTS. It contains the left disparity if NvMediaVPIOFSTOutputType is NVMEDIA_VPI_STEREO_DISPARITY.
[out]output1A pointer to the second output image. It must be NULL if NvMediaVPIOFSTOutputType is NVMEDIA_VPI_MV_HINTS. It contains the right disparity if NvMediaVPIOFSTOutputType is NVMEDIA_VPI_STEREO_DISPARITY.
Returns
Status indicator. Possible values are: