Remap

Remaps the input image, effectively warping it using a user-provided mapping. More...

Functions
VPIStatus	vpiCreateRemap (uint64_t backends, const VPIWarpMap *warpMap, VPIPayload *payload)
	Create a payload for Remap algorithm. More...
VPIStatus	vpiSubmitRemap (VPIStream stream, uint64_t backend, VPIPayload payload, VPIImage input, VPIImage output, VPIInterpolationType interp, VPIBorderExtension border, uint64_t flags)
	Submits a Remap operation to the stream. More...

Detailed Description

Remaps the input image, effectively warping it using a user-provided mapping.

Refer to Remap for more details and usage examples.

Function Documentation

vpiCreateRemap()

VPIStatus vpiCreateRemap	(	uint64_t	backends,
		const VPIWarpMap *	warpMap,
		VPIPayload *	payload
	)

#include </opt/nvidia/vpi3/include/vpi/algo/Remap.h>

Create a payload for Remap algorithm.

This function allocates all resources needed by the Remap algorithm and ties the returned payload to the given stream.

Parameters

[in]	backends	VPI backends that are eligible to execute the algorithm. Valid values: VPI_BACKEND_CPU VPI_BACKEND_CUDA VPI_BACKEND_VIC Backend must be enabled in current context.
[in]	warpMap	Mapping of output back into input. It must define a grid with the same size as output image.
[out]	payload	Pointer to the payload variable that receives the created handle.

Return values

VPI_ERROR_INVALID_ARGUMENT	payload is NULL.
VPI_ERROR_INVALID_ARGUMENT	warpMap is NULL.
VPI_ERROR_INVALID_ARGUMENT	backends refers to an invalid backend.
VPI_ERROR_NOT_IMPLEMENTED	Remap algorithm is not supported by given backends.
VPI_ERROR_NOT_IMPLEMENTED	VIC hardware with Remap support is not available.
VPI_ERROR_INVALID_CONTEXT	Current context is destroyed.
VPI_ERROR_OUT_OF_MEMORY	Cannot allocate required resources.
VPI_ERROR_INVALID_OPERATION	Backend isn't enabled in current context.
VPI_SUCCESS	Operation executed successfully.

vpiSubmitRemap()

VPIStatus vpiSubmitRemap	(	VPIStream	stream,
		uint64_t	backend,
		VPIPayload	payload,
		VPIImage	input,
		VPIImage	output,
		VPIInterpolationType	interp,
		VPIBorderExtension	border,
		uint64_t	flags
	)

#include </opt/nvidia/vpi3/include/vpi/algo/Remap.h>

Submits a Remap operation to the stream.

Parameters

[in]	stream	The stream where the operation will be queued in. Must not be NULL. Stream must have enabled the backends that will execute the algorithm.
[in]	backend	Backend that will execute the algorithm. Must be the backend specified during payload creation or 0 as a shorthand to use this backend.
[in]	payload	Payload created by vpiCreateRemap.
[in]	input	Image to be remapped. In a lens distortion correction context, this would correspond to the distorted image. Must not be NULL. Image must have enabled the backends that will execute the algorithm. On VIC, maximum input dimensions is 16384x16384. Supported image formats are: Formats CPU CUDA VIC VPI_IMAGE_FORMAT_U8 * * * VPI_IMAGE_FORMAT_U16 * * * VPI_IMAGE_FORMAT_Y8 * * * VPI_IMAGE_FORMAT_Y8_BL * VPI_IMAGE_FORMAT_Y8_ER * * * VPI_IMAGE_FORMAT_Y8_ER_BL * VPI_IMAGE_FORMAT_Y16 * * * VPI_IMAGE_FORMAT_Y16_BL * VPI_IMAGE_FORMAT_Y16_ER * * VPI_IMAGE_FORMAT_NV12 * * * VPI_IMAGE_FORMAT_NV12_BL * VPI_IMAGE_FORMAT_NV12_ER * * * VPI_IMAGE_FORMAT_NV12_ER_BL * VPI_IMAGE_FORMAT_NV24 * VPI_IMAGE_FORMAT_NV24_BL * VPI_IMAGE_FORMAT_NV24_ER * VPI_IMAGE_FORMAT_NV24_ER_BL * VPI_IMAGE_FORMAT_RGB8 * * VPI_IMAGE_FORMAT_BGR8 * * VPI_IMAGE_FORMAT_RGBA8 * * VPI_IMAGE_FORMAT_BGRA8 * *
[out]	output	Stores the remapped image. In a lens distortion correction context, this would correspond to the corrected (distortion-free). Must not be NULL. Must have same format as input image. Must have the same type as input Must have same dimensions as the warp map specified during payload creation. Image must have enabled the backends that will execute the algorithm. On VIC, maximum input dimensions is 16384x16384.
[in]	interp	Interpolation method to be used. Valid values: VPI_INTERP_NEAREST VPI_INTERP_LINEAR VPI_INTERP_CATMULL_ROM
[in]	border	What value to pick if remapped coordinated falls outside input image. The accepted border extensions are: VPI_BORDER_ZERO (VIC only supports this one) VPI_BORDER_CLAMP VPI_BORDER_MIRROR VPI_BORDER_REFLECT
[in]	flags	Control flags. Valid values are a combination of one or more of the flags: 0 : default, negation of all other flags. VPI_PRECISE : precise, but potentially slower implementation.

Return values

VPI_ERROR_INVALID_ARGUMENT	stream is NULL.
VPI_ERROR_INVALID_ARGUMENT	input or output are NULL.
VPI_ERROR_INVALID_ARGUMENT	payload is not generated using vpiCreateRemap.
VPI_ERROR_INVALID_ARGUMENT	Invalid flags.
VPI_ERROR_INVALID_ARGUMENT	input and output must have the same format.
VPI_ERROR_INVALID_ARGUMENT	output must have same size corresponding to the warp map passed during payload creation.
VPI_ERROR_INVALID_ARGUMENT	border not supported.
VPI_ERROR_INVALID_PAYLOAD_TYPE	payload is invalid.
VPI_ERROR_INVALID_OPERATION	The needed backends aren't enabled in stream, input or output.
VPI_SUCCESS	Operation executed successfully.