JSON File Schema

Configuration file used in VVAS Infrastructure plugins has to be defined in json format. This section defines the schema for the configuration files.

Table 15: Root JSON Object Members

JSONKey

ValueType

Mandatory or Optional

Default Value

Description

xclb

in-location

String

Optional

NULL

Location of the xclbin to program the FPGA. In PCIe platforms, the XRM chooses the device to download the xclbin based on processing load.

vvas-l

ibrary-repo

String

Optional

/usr/lib

The VVAS library repository path that looks for a cceleration software libraries using the VVAS GStreamer plug-in.

e

lement-mode

Enum

Mandatory

The GStreamer uses the element mode to operate. Based on re quirements, you must choose one of the following modes:

  • P

assthrough:

In this mode, the

element

does not alter the input

buffer.

  • Inplace:

    In this mode, the

    element

    alters

    the input

    buffer

    instead

    of

producing

new

output

buffers.

  • Transform:

    In this mode, the

    element

    produces

    an

    output

    buffer

    for each input

    buffer.

kernels

Array of | Objects | Mandatory

None

Array of kernel objects. Each kernel object provides information about an VVAS video library con figuration.

Minimum value: 1

Maximum value: 2

For information on object members, see Table 16: Kernel JSON Object Memb ers.

Table 16: Kernel JSON Object Members

JSON Key

Value Type

Mandatory or Optional

Default Value

Description

l ibrary-name

String

Mandatory

None

The name of the VVAS video library loaded by the VVAS GStreamer plug-ins. The absolute path of the video library is formed by pre-pending the vvas- l ibrary-repo path.

kernel-name

String

Optional

None

The name of the IP or kernel in the form of

<kernel name >:<instance name>

config

Object

Optional

None

Holds the co

nfiguration

specific to the VVAS video library. The VVAS

GStreamer

plug-ins do not parse this JSON object, instead it is sent to the video library.

soft-kernel

Object
Mandatory

if the kernel library is written for the soft kernel.

None

Contains

soft-kernel

specific i

nformation.

This JSON object is only valid for PCIe based

platforms.