Mix Channels

Mix channels from one or more input image channels to one or more output image channels. More...

Macros
#define	VPI_MIX_CHANNELS_MAX_IMAGES   4
	Maximum number of images that can be passed to Mix Channels as either input or output.

Functions
VPIStatus	vpiSubmitMixChannels (VPIStream stream, uint64_t backend, VPIImage *inputs, int numInputs, VPIImage *outputs, int numOutputs, const int *inMapping, const int *outMapping, int numMapping)
	Submits a Mix Channels operation to the stream. More...

Detailed Description

Mix channels from one or more input image channels to one or more output image channels.

The operation is a copy operation without increasing or decreasing resolution, the input and output sizes must match, and without any color conversion. Refer to Mix Channels for more details and usage examples.

Function Documentation

vpiSubmitMixChannels()

VPIStatus vpiSubmitMixChannels	(	VPIStream	stream,
		uint64_t	backend,
		VPIImage *	inputs,
		int	numInputs,
		VPIImage *	outputs,
		int	numOutputs,
		const int *	inMapping,
		const int *	outMapping,
		int	numMapping
	)

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

Submits a Mix Channels 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. Valid values: VPI_BACKEND_CPU VPI_BACKEND_CUDA
[in]	inputs	One or more input images from where to draw channels from. Must not be NULL. All input images must be already allocated. Each input image plane size must match the mapped output image plane size. Images must have enabled the backends that will execute the algorithm. The accepted image formats are: VPI_IMAGE_FORMAT_U8 VPI_IMAGE_FORMAT_S8 VPI_IMAGE_FORMAT_U16 VPI_IMAGE_FORMAT_U32 VPI_IMAGE_FORMAT_S32 VPI_IMAGE_FORMAT_S16 VPI_IMAGE_FORMAT_2S16 VPI_IMAGE_FORMAT_F32 VPI_IMAGE_FORMAT_F64 VPI_IMAGE_FORMAT_2F32 VPI_IMAGE_FORMAT_Y8 VPI_IMAGE_FORMAT_Y8_ER VPI_IMAGE_FORMAT_Y16 VPI_IMAGE_FORMAT_Y16_ER VPI_IMAGE_FORMAT_NV12 VPI_IMAGE_FORMAT_NV12_ER VPI_IMAGE_FORMAT_NV24 VPI_IMAGE_FORMAT_NV24_ER VPI_IMAGE_FORMAT_RGB8 VPI_IMAGE_FORMAT_BGR8 VPI_IMAGE_FORMAT_RGBA8 VPI_IMAGE_FORMAT_BGRA8 VPI_IMAGE_FORMAT_RGB8p VPI_IMAGE_FORMAT_BGR8p VPI_IMAGE_FORMAT_RGBA8p VPI_IMAGE_FORMAT_BGRA8p
[in]	numInputs	Number of inputs in the array of inputs pointer argument. Must be between 1 and VPI_MIX_CHANNELS_MAX_IMAGES .
[out]	outputs	One or more output images from where to insert channels to. Must not be NULL. All output images must be already allocated. Each output image plane size must match the mapped input image plane size. Images must have enabled the backends that will execute the algorithm. The accepted image formats are the same as in inputs.
[in]	numOutputs	Number of outputs in the array of outputs pointer argument. Must be between 1 and VPI_MIX_CHANNELS_MAX_IMAGES .
[in]	inMapping	Array with indices to channels of input images The channels are considered linearized throughout images, that is each input is viewed as a sequence of channels and all inputs are concatenated in its array order. The index of an input channel gives the position on the whole inputs channels concatenated sequence. Must contain existing input channel indices. Array size must be equal to numMapping.
[in]	outMapping	Array with indices to channels of output images The channels are considered linearized throughout images, that is each output is viewed as a sequence of channels and all outputs are concatenated in its array order. The index of an output channel gives the position on the whole outputs channels concatenated sequence. Must contain existing output channel indices. Array size must be equal to numMapping.
[in]	numMapping	Number of mappings in the mapping array pointer argument. Must be >= 1 and <= VPI_MIX_CHANNELS_MAX_IMAGES * VPI_MAX_PLANE_COUNT.

Return values

VPI_ERROR_INVALID_ARGUMENT	stream or inputs or outputs or mappings are NULL.
VPI_ERROR_INVALID_ARGUMENT	numInputs or numOutputs or numMapping are outside valid range.
VPI_ERROR_INVALID_IMAGE_FORMAT	Unsupported input or output format.
VPI_ERROR_INVALID_OPERATION	The needed backends aren't enabled in stream, inputs or outputs.
VPI_SUCCESS	Operation executed successfully.