Equalize Image Histogram

Equalize image histogram for the input image. More...

Functions
VPIStatus	vpiCreateEqualizeHist (uint64_t backend, VPIImageFormat fmt, VPIPayload *payload)
	Creates payload for vpiSubmitEqualizeHist. More...
VPIStatus	vpiSubmitEqualizeHist (VPIStream stream, uint64_t backend, VPIPayload payload, VPIImage input, VPIImage output)
	Equalize the histogram of the image. More...

Detailed Description

Equalize image histogram for the input image.

Refer to Equalize Histogram for more details and usage examples.

Function Documentation

vpiCreateEqualizeHist()

VPIStatus vpiCreateEqualizeHist	(	uint64_t	backend,
		VPIImageFormat	fmt,
		VPIPayload *	payload
	)

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

Creates payload for vpiSubmitEqualizeHist.

Parameters

[in]

backend

VPI backend that will execute the algorithm. Valid values: VPI_BACKEND_CPU VPI_BACKEND_CUDA

• Backend must be enabled in current context.

Parameters

[in]	fmt	Format of input image. The accepted image formats are: VPI_IMAGE_FORMAT_U8 VPI_IMAGE_FORMAT_U16 VPI_IMAGE_FORMAT_NV12 (only luma channel is equalized) VPI_IMAGE_FORMAT_NV12_ER (only luma channel is equalized)
[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	backends refers to an invalid backend.
VPI_IMAGE_FORMAT_INVALID	fmt is not supported.
VPI_ERROR_INVALID_CONTEXT	Current context is destroyed.
VPI_ERROR_NOT_IMPLEMENTED	Equalize Histogram algorithm is not supported by given backend.
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.

vpiSubmitEqualizeHist()

VPIStatus vpiSubmitEqualizeHist	(	VPIStream	stream,
		uint64_t	backend,
		VPIPayload	payload,
		VPIImage	input,
		VPIImage	output
	)

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

Equalize the histogram of the image.

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	VPI backend that will execute the algorithm. Valid values: VPI_BACKEND_CPU VPI_BACKEND_CUDA
[in]	payload	Payload created with vpiCreateEqualizeHist
[in]	input	Input image. Must not be NULL. Its format must match the one associated with payload. Image must have enabled the backends that will execute the algorithm.
[out]	output	Where the resulting image will be written to. Must not be NULL. Must have same format and dimensions as input image. Image must have enabled the backends that will execute the algorithm.

Return values

VPI_ERROR_INVALID_ARGUMENT	stream is NULL.
VPI_ERROR_INVALID_ARGUMENT	input or output are NULL.
VPI_ERROR_INVALID_ARGUMENT	payload must be created by vpiCreateEqualizeHist.
VPI_ERROR_INVALID_ARGUMENT	input and output must have same dimensions.
VPI_ERROR_INVALID_IMAGE_FORMAT	input image format does not match with one associated with payload.
VPI_ERROR_INVALID_IMAGE_FORMAT	output format doesn't match input's.
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.