Control Parameters and Plug-in Properties - Control Parameters and Plug-in Properties - 6.3 English - XD056

Vitis Video Analytics SDK (VVAS) 6.3 User Guide (XD056)

Document_ID
XD056
Release_Date
2026-09-24
Version
6.3 English

The following table lists the GStreamer plug-in properties supported by the vvas_xmulticrop plug-in.

The following default value of interpolation-mode is for the default library-name, that is, libvvas_image_process_hw_lib.so. vvas_xmulticrop queries these values from VvasImageProcess.

Table 20 vvas_xmulticrop Plug-in Properties

Property Name

Type

Range

Default

Description

avoid-output-copy

Boolean

true / false

false

Avoid output frames copy even when the downstream does not support the GstVideoMeta metadata.

enable-pipeline

Boolean

true / false

false

Enable buffer pipelining to improve performance in non-zero-copy use cases.

in-mem-bank

Unsigned int

0 - 65535

-1

VVAS input memory bank to allocate memory. If not set, it will be queried from the VVAS core module.

out-mem-bank

Unsigned int

0 - 65535

-1

VVAS output memory bank to allocate memory. If not set, it will be queried from the VVAS core module.

xclbin-location

String

N/A

NULL

The location of the xclbin.

library-name

String

N/A

libvvas_image
_process_hw_lib.so

Image process library name.

library-config

String

N/A

{“kernel-name”:
“image_processing:
{image_processing_1}
“}

Image process library configuration string. The default value is only valid for the libvvas_image_process_hw_lib.so library.

interpolation-mode

Integer

0, 1, 2

0

Interpolation Mode to use: 0 - BILINEAR 1 - BICUBIC 2 - POLYPHASE Default is 0 (BILINEAR) for the hardware image-process library (libvvas_image_process_hw_lib.so).

alpha-b

Float

0 to 128

0

Mean subtraction for the Blue channel, needed only if PPE is required.

alpha-g

Float

0 to 128

0

Mean subtraction for the Green channel, needed only if PPE is required.

alpha-r

Float

0 to 128

0

Mean subtraction for the Red channel, needed only if PPE is required.

beta-b

Float

0 to 1

1

Scaling for the Blue channel, needed only if PPE is required.

beta-g

Float

0 to 1

1

Scaling for the Green channel, needed only if PPE is required.

beta-r

Float

0 to 1

1

Scaling for the Red channel, needed only if PPE is required.

s-crop-x

Unsigned int

0 to 3840

0

Crop X coordinate for static cropping.

s-crop-y

Unsigned int

0 to 2160

0

Crop Y coordinate for static cropping.

s-crop-width

Unsigned int

0 to 3840

0

Crop width for static cropping (minimum: 16).
When this is 0 or not set, it will be calculated as input width - s-crop-x.

s-crop-height

Unsigned int

0 to 2160

0

Crop height for static cropping (minimum: 16).
When this is 0 or not set, it will be calculated as input height - s-crop-y.

d-width

Unsigned int

0 to 3840

0

Width of dynamically cropped buffers.

d-height

Unsigned int

0 to 2160

0

Height of dynamically cropped buffers.

d-format

Unsigned int

0, 2, 4, 5, 7, 8, 11, 12, 15, 16, 23, 25, 41, 45, 48, 51, 78, 79, 83

0

Format of dynamically cropped buffers.

ppe-on-main-buffer

Boolean

true / false

false

Apply pre-processing on the main buffer also.

software-scaling

Boolean

true / false

false

Retained for GObject compatibility. The software image-process library is not supported in this release; keep false and use libvvas_image_process_hw_lib.so with the image_processing kernel.

Note

The image-processing IP has some alignment requirements, so the crop parameters you provide are aligned as per the IP requirement; alignment ensures that it covers the region of crop specified, so the final cropped image might have extra pixels cropped. The crop width and height must be at least 16.

The maximum value of s-crop-x, s-crop-y, s-crop-width, s-crop-height, d-width, and d-height are as per the maximum resolution supported by VvasImageProcess. vvas_xmulticrop will query these values from VvasImageProcess and update them accordingly.