Dynamic Remap

Dynamically remaps pixels from an input image to an output image via a user-provided map image. More...

Functions
VPIStatus	vpiCreateDynamicRemap (uint64_t backends, VPIPayload *payload)
	Create a payload for Dynamic Remap algorithm. More...
VPIStatus	vpiSubmitDynamicRemap (VPIStream stream, uint64_t backend, VPIPayload payload, VPIImage input, VPIImage output, VPIImage map, VPIInterpolationType inputInterpolation, VPIInterpolationType mapInterpolation, VPIBorderExtension border, uint64_t flags)
	Submits a Dynamic Remap operation to the stream. More...

Detailed Description

Dynamically remaps pixels from an input image to an output image via a user-provided map image.

It is dynamic since it allows for dynamic update of the map image, as a regular async stream ordered operation.

Refer to Dynamic Remap for more details and usage examples.

Function Documentation

vpiCreateDynamicRemap()

VPIStatus vpiCreateDynamicRemap	(	uint64_t	backends,
		VPIPayload *	payload
	)

#include <vpi/algo/DynamicRemap.h>

Create a payload for Dynamic Remap algorithm.

This function allocates all resources needed by the Dynamic 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_CUDA Backend must be enabled in current context.
[out]	payload	Pointer to the payload variable that receives the created handle. It must not be NULL.

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	Algorithm is not supported by given backends.
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.

vpiSubmitDynamicRemap()

VPIStatus vpiSubmitDynamicRemap	(	VPIStream	stream,
		uint64_t	backend,
		VPIPayload	payload,
		VPIImage	input,
		VPIImage	output,
		VPIImage	map,
		VPIInterpolationType	inputInterpolation,
		VPIInterpolationType	mapInterpolation,
		VPIBorderExtension	border,
		uint64_t	flags
	)

#include <vpi/algo/DynamicRemap.h>

Submits a Dynamic Remap operation to the stream.

The dynamic remap copies values from input to output via a map, using two sampling steps: (1) a control-point value is sampled in the map; (2) a pixel value is sampled in the input. The following formula summarizes the two sampling steps: output(i, j) = input(map(i, j)); where each sampling step has its own interpolation.

Parameters

[in]	stream	The stream where the operation will be queued in. It must not be NULL. Stream must have enabled the backends that will execute the algorithm.
[in]	backend	Backend that will execute the algorithm. It must be the backend specified during payload creation or 0 as a shorthand to use its backend.
[in]	payload	Payload created by vpiCreateDynamicRemap.
[in]	input	Image to be remapped. It must not be NULL. It must have enabled the backends that will execute the algorithm. Supported image formats are: VPI_IMAGE_FORMAT_U8 VPI_IMAGE_FORMAT_Y8 VPI_IMAGE_FORMAT_Y8_ER VPI_IMAGE_FORMAT_F32 VPI_IMAGE_FORMAT_RGB8 VPI_IMAGE_FORMAT_BGR8 VPI_IMAGE_FORMAT_RGBA8 VPI_IMAGE_FORMAT_BGRA8
[out]	output	Stores the remapped image. It must not be NULL. It must have enabled the backends that will execute the algorithm. It must have the same format as input image. It can have dimensions different than input and map.
[out]	map	Stores the mapping of output coordinates into the input image. It must not be NULL. It must have enabled the backends that will execute the algorithm. It must have format: VPI_IMAGE_FORMAT_2F32 It can have dimensions different than input and output.
[in]	inputInterpolation	Interpolation method to be used when fetching values from input. Valid values: VPI_INTERP_NEAREST VPI_INTERP_LINEAR VPI_INTERP_CATMULL_ROM
[in]	mapInterpolation	Interpolation method to be used when fetching values from map. Valid values: VPI_INTERP_NEAREST VPI_INTERP_LINEAR VPI_INTERP_CATMULL_ROM
[in]	border	What value to pick if remapped coordinates fall outside input image. The accepted border extensions are: VPI_BORDER_ZERO 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 operator mode, i.e. sampling aligned to pixel center, map values are absolute, denormalized positions in the input. VPI_SAMPLING_ALIGNED_TO_CORNER : The sampling of pixels in continuous spatial domain may be either at top-left corner or at the center. If given, sampling occurs at the top-left corner, or else (default) sampling at the pixel center. VPI_RELATIVE_MAP : If given, map values as relative offsets to be applied to each output position to fetch values from the input, or else (default) values as absolute positions in the input. VPI_NORMALIZED_MAP : If given, map values as normalized in [-1, 1] range for either absolute positions or relative offsets, or else (default) map values as denormalized.

Return values

VPI_ERROR_INVALID_ARGUMENT	stream is NULL.
VPI_ERROR_INVALID_ARGUMENT	input or map or output are NULL.
VPI_ERROR_INVALID_ARGUMENT	payload is not generated using vpiCreateDynamicRemap.
VPI_ERROR_INVALID_ARGUMENT	input and output must have the same format.
VPI_ERROR_INVALID_ARGUMENT	border not supported.
VPI_ERROR_INVALID_ARGUMENT	flags has an invalid combination.
VPI_ERROR_INVALID_PAYLOAD_TYPE	payload is invalid.
VPI_ERROR_INVALID_OPERATION	The needed backends aren't enabled in stream, input or output or map.
VPI_SUCCESS	Operation executed successfully.