VXLIB_channelCombine_3to1_i8u_o8u

Functions
VXLIB_STATUS	VXLIB_channelCombine_3to1_i8u_o8u (const uint8_t src0[restrict], const VXLIB_bufParams2D_t *src0_addr, const uint8_t src1[restrict], const VXLIB_bufParams2D_t *src1_addr, const uint8_t src2[restrict], const VXLIB_bufParams2D_t *src2_addr, uint8_t dst[restrict], const VXLIB_bufParams2D_t *dst_addr)
VXLIB_STATUS	VXLIB_channelCombine_3to1_i8u_o8u_checkParams (const uint8_t src0[], const VXLIB_bufParams2D_t *src0_addr, const uint8_t src1[], const VXLIB_bufParams2D_t *src1_addr, const uint8_t src2[], const VXLIB_bufParams2D_t *src2_addr, const uint8_t dst[], const VXLIB_bufParams2D_t *dst_addr)

Detailed Description

Function Documentation

VXLIB_channelCombine_3to1_i8u_o8u()

VXLIB_STATUS VXLIB_channelCombine_3to1_i8u_o8u	(	const uint8_t	src0[restrict],
		const VXLIB_bufParams2D_t *	src0_addr,
		const uint8_t	src1[restrict],
		const VXLIB_bufParams2D_t *	src1_addr,
		const uint8_t	src2[restrict],
		const VXLIB_bufParams2D_t *	src2_addr,
		uint8_t	dst[restrict],
		const VXLIB_bufParams2D_t *	dst_addr
	)

Description:

Implements the Channel Combine Kernel.

Method:

The 3 to 1 Channel Combine is implemented using the following equation:

 dst(x)     = src0(x)
 dst(x + 1) = src1(x)
 dst(x + 2) = src2(x)

Parameters

[in]	src0[]	Pointer to array containing first input image (UQ8.0)
[in]	src0_addr[]	Pointer to structure containing dimensional information of src0
[in]	src1[]	Pointer to array containing second input image (UQ8.0)
[in]	src1_addr[]	Pointer to structure containing dimensional information of src1
[in]	src2[]	Pointer to array containing third input image (UQ8.0)
[in]	src2_addr[]	Pointer to structure containing dimensional information of src2
[out]	dst[]	Pointer to array containing output image (UQ8.0)
[in]	dst_addr[]	Pointer to structure containing dimensional information of dst

Assumptions:

• I/O buffer pointers are assumed to be not aliased.

Performance Considerations:

• For best performance, the following parameter settings are recommended:
  • Set output stride equal to input stride * 3
  • Align all pointers to 8 byte boundaries
  • Set all stride values to a multiple of 8
  • Set all width values to a multiple of 8

VXLIB_channelCombine_3to1_i8u_o8u_checkParams()

VXLIB_STATUS VXLIB_channelCombine_3to1_i8u_o8u_checkParams	(	const uint8_t	src0[],
		const VXLIB_bufParams2D_t *	src0_addr,
		const uint8_t	src1[],
		const VXLIB_bufParams2D_t *	src1_addr,
		const uint8_t	src2[],
		const VXLIB_bufParams2D_t *	src2_addr,
		const uint8_t	dst[],
		const VXLIB_bufParams2D_t *	dst_addr
	)

Description:

Checks the parameters for programming errors for the VXLIB__channelCombine_3to1_i8u_o8u function.

Method:

The following checks are made:

• There shall be no NULL pointers
• The dst image can be VXLIB_UINT8 or VXLIB_UINT24
  • If VXLIB_UINT8:
    • The dim_x of the dst image shall be 3 * dim_x of src images
  • If VXLIB_UINT24:
    • The dim_x of the dst image shall be equal to the dim_x of src images
• All three src images shall have the same x and y dimensions
• The stride_y of the src images shall be equal to or greater than dim_x
• The stride_y of the dst image shall be equal to or greater than src image dim_x * 3

Parameters

[in]	src0[]	Pointer to array containing first input image (UQ8.0)
[in]	src0_addr[]	Pointer to structure containing dimensional information of src0
[in]	src1[]	Pointer to array containing second input image (UQ8.0)
[in]	src1_addr[]	Pointer to structure containing dimensional information of src1
[in]	src2[]	Pointer to array containing third input image (UQ8.0)
[in]	src2_addr[]	Pointer to structure containing dimensional information of src2
[out]	dst[]	Pointer to array containing output image (UQ8.0)
[in]	dst_addr[]	Pointer to structure containing dimensional information of dst