Video via VSI

Video file streaming interface. More...

Content
	Video Driver API Functions
	Video Driver API functions.
	Video Driver API Defines
	Video Driver API Definitions.

Data Structures
struct	VideoDrv_Status_t
	Video Status. More...

Description

Video file streaming interface.

Video streaming use case is implemented for Arm FVPs based on the general-purpose Virtual Streaming Interface (VSI).

The use of common video driver API simplifies re-targeting of the application code between virtual and physical devices. Currently video driver implementations and examples are available for the following platforms:

• Arm FVPs using VSI with an interface to Python script that streams local video or image files (supported formats: *.bmp, *.png, *.jpg, *.wmv, *.avi, *.mp4). Alternatively, PC's camera can be used as video input and PC's display as video output.

and support for other hardware platforms can be added following the same concept.

The table below references the files that implement the video peripheral:

Item	Description
./interface/video/include/video_drv.h	Video Driver API header file. Used by implementations on Arm Virtual Hardware and real HW boards.
./interface/video/source/video_drv.c	Video driver implementation for Arm Virtual Hardware based on VSI
./interface/video/python/arm_vsi4.py	Video via VSI Python script for video input channel 0, based on VSI Python interface.
./interface/video/python/arm_vsi5.py	Video via VSI Python script for video output channel 0, based on VSI Python interface.
./interface/video/python/arm_vsi6.py	Video via VSI Python script for video input channel 1, based on VSI Python interface.
./interface/video/python/arm_vsi7.py	Video via VSI Python script for video output channel 1, based on VSI Python interface.
./interface/video/python/vsi_video.py	Video via VSI Python module for video input / output interface.
./interface/video/python/vsi_video_server.py	Video via VSI Accompanying Python script to the vsi_video.py.

Python requirements

VSI Video Server requires a Python 3.9 or later installation with installed OpenCV Python package:

• opencv-python

Run the following command to install required package with pip:

pip install opencv-python

---

Data Structure Documentation

VideoDrv_Status_t

struct VideoDrv_Status_t

Video Status.

Structure with information about the Video channel status. The data fields encode active and buffer state flags.

Returned by:

• VideoDrv_GetStatus

Data Fields
uint32_t	active: 1	Video stream active.
uint32_t	buf_empty: 1	Video buffer empty.
uint32_t	buf_full: 1	Video buffer full.
uint32_t	overflow: 1	Video buffer overflow (cleared on GetStatus)
uint32_t	underflow: 1	Video buffer underflow (cleared on GetStatus)
uint32_t	eos: 1	Video end of stream (cleared on GetStatus)
uint32_t	reserved: 26