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

xclbin- 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- library- repo

String

Optional

/usr/lib

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

element- mode

String

Mandatory

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

  • Passthrough:

    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 ouput buffer fo each input buffer.

kernel

Kernel JSON Object

Mandatory

None

A Kernel JSON object provides information about an VVAS video library configuration.

For information on object members, see Kernel JSON Object Members

Table 16: Kernel JSON Object Members

JSON Key

Value Type

Mandatory or Optional

Default Value

Description

library- 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>

kernel- access- mode

String

Optional

shared

Mode in which IP/Kernel is to be accessed. “shared” or “exclusive”

config

Object

Optional

None

Holds the configuration 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 information.

This JSON object is only valid for PCIe based platforms.