Development Guide:

If you want to cross compile the source in Linux PC machine, follow these steps, otherwise skip this section.

Refer to the K260 SOM Starter Kit Tutorial to build the cross-compilation SDK, and install it to the path you choose or default. Suppose it's SDKPATH.
Run "./build.sh ${SDKPATH}" in the source code folder of current application, to build the application.
The build process in 2. will produce a rpm package smartcam-1.0.1-1.aarch64.rpm under build/, upload to the board, and run rpm -ivh --force ./smartcam-1.0.1-1.aarch64.rpm to update install.

Setting up the Board

Get the SD Card Image from Boot Image Site and follow the instructions in UG1089 to burn the SD card. And install the SD card to J11.
Hardware Setup:
- Monitor:
  
  Before booting, connect a 1080P/4K monitor to the board via either DP or HDMI port.
  
  4K monitor is preferred to demonstrate at the maximum supported resolution.
- IAS sensor:
  
  Before power on, install an AR1335 sensor module in J7.
- UART/JTAG interface:
  
  For interacting and seeing boot-time information, connect a USB debugger to the J4.
- You may also use a USB webcam as an input device.
  
  The webcam is optional video input device supported in the application.
  
  Recommended webcam is the Logitech BRIO.
- Network connection:
  
  Connect the Ethernet cable to your local network with DHCP enabled to install packages and run Jupyter Notebooks
- Audio Pmod setup as RTSP audio input:
  
  Audio Pmod is optional audio input and output device.
  
  In smartcam application only RTSP mode uses the audio input function to capture audio. Audio is then sent together with the images as RTSP stream and can be received at the client side.
  
  To set it up, first install the Pmod to J2, then connect a microphone or any other sound input device to the line input port. A headphone with a microphone will not work - device needs to be a dedicated input.
  
  Smartcam application does not yet support speakers.
Software Preparation:

You will use a PC having network access to the board as the RTSP client machine.

Make sure that the PC and the KV260 Vision AI Starter Kit are on the same subnet mask.

On the client machine, to receive and play the RTSP stream, we recommend to install FFplay which is part of FFmpeg package.

For Linux, you can install FFmpeg with the package manager of your distribution.

For Windows, you can find install instructions on https://ffmpeg.org/download.html

Other than FFplay, VLC can also be used to play RTSP stream, but we find sometimes it doesn't work on some client machine, while the FFplay works well.
Power on the board, login with username petalinux, and you need to setup the password for the first time bootup.
Get the latest application package.
1. Get the list of available packages in the feed.
  
  sudo xmutil getpkgs
2. Install the package with dnf install:
  
  sudo dnf install packagegroup-kv260-smartcam.noarch
Note: For setups without access to the internet, it is possible to download and use the packages locally. Please refer to the K260 SOM Starter Kit Tutorial for instructions.
Dynamically load the application package.

The firmware consist of bitstream, device tree overlay (dtbo) and xclbin file. The firmware is loaded dynamically on user request once Linux is fully booted. The xmutil utility can be used for that purpose.
1. Show the list and status of available acceleration platforms and AI Applications:
  
  sudo xmutil listapps
2. Switch to a different platform for different AI Application:
  - When xmutil listapps shows that there's no active accelerator, just activate the one you want to use.
    
    sudo xmutil loadapp kv260-smartcam
  - When there's already an accelerator being activated, unload it first, then switch to the one you want.
    
    sudo xmutil unloadapp
    
    sudo xmutil loadapp kv260-smartcam
Getting demo video files suitable for the application:

To be able to demostrate the function of the application in case you have no MIPI and USB camera in hand, we support the file video source too.

You can download video files from the following links, which is of MP4 format.

Facedet / RefineDet AI Task:
- https://pixabay.com/videos/alley-people-walk-street-ukraine-39837/
ADAS SSD AI Task:
- https://pixabay.com/videos/freeway-traffic-cars-rainy-truck-8358/

Then you need to transcode it to H264 file which is one supported input format.

 ffmpeg -i input-video.mp4 -c:v libx264 -pix_fmt nv12 -r 30 output.nv12.h264

Finally, please upload or copy these transcoded H264 files to the board (by using scp, ftp, or copy onto SD card and finding them in /media/sd-mmcblk0p1/), place it to somewhere under /home/petalinux, which is the home directory of the user you login as.

Run the Application

There are two ways to interact with the application.

Juypter notebook.

Use a web-browser (e.g. Chrome, Firefox) to interact with the platform.

The Jupyter notebook URL can be find with command:

sudo jupyter notebook list

Output example:

Currently running servers:

http://ip:port/?token=xxxxxxxxxxxxxxxxxx :: /opt/xilinx/share/notebooks

Command line

These allow the user to define different video input and output device targets using the "smartcam" application. These are to be executed using the UART/debug interface.

Notice The application need to be ran with sudo .

Example scripts

Example scripts and options definitions are provided below.

Refer to File Structure to find the files' location.

Click here to view the example script usage

* MIPI RTSP server:

1. Invoking `"sudo 01.mipi-rtsp.sh"` will start rtsp server for mipi captured images.

2. Script accepts ${width} ${height} as the 1st and 2nd parameter, the default is 1920 x 1080.

3. Running the script will give message in the form:

stream ready at:

rtsp://boardip:port/test

  Run "ffplay rtsp://boardip:port/test" on the client PC to receive the rtsp stream.

4. Checking:

  You should be able to see the images the camera is capturing on the ffplay window, and when there's face captured by camera, there should be blue box drawn around the face, and the box should follow the movement of the face.

MIPI DP display:
1. Make sure the monitor is connected as here.
2. Invoking "sudo 02.mipi-dp.sh" will play the captured video with detection results on monitor.
3. Script accepts ${width} ${height} as the 1st and 2nd parameter, the default is 1920 x 1080.
4. Checking:
  
  You should be able to see the images the camera is capturing on the monitor connected to the board, and when there's face captured by the camera, there should be blue box drawn around the face, and the box should follow the movement of the face.
File to File
1. Invoking "sudo 03.file-to-file.sh"
  
  Take the first argument passed to this script as the path to the video file (you can use the demo video for face detection, or similar videos), perform face detection and generate video with detection bbox, save as ./out.h264
2. Checking:
  
  Play the input video file and generated video file "./out.h264" with any media player you prefer, e.g. VLC, FFPlay. You should be able to see in the output video file, there are blue boxes around the faces of people, and the boxes should follow the movement of the faces, while there're no such boxes with the input video file.
File to DP
1. Invoking "sudo 04.file-ssd-dp.sh"
  
  Take the first argument passed to this script as the path to the video file (you can use the demo video for ADAS SSD, or similar videos), perform vehicles detection and generate video with detection bbox, and display onto monitor
2. Checking:
  
  You should be able to see a video of highway driving, with the detection of vehicles in a bounding box.

Additional configuration options for smartcam invocation:

The example scripts and Jupyter notebook work as examples to show the capability of the smartcam for specific configurations. More combinations could be made based on the options provided by smartcam. User can get detailed application options as following by invoking smartcam --help.

Usage:

 smartcam [OPTION?] - Application for face detection on SOM board of Xilinx.

 Help Options:

 -h, --help             Show help options

 --help-all             Show all help options

 --help-gst             Show GStreamer Options

 
 Application Options:

 -m, --mipi=                use MIPI camera as input source, auto detect, fail if no mipi available.

 -u, --usb=media_ID         usb camera video device id, e.g. 2 for /dev/video2

 -f, --file=file            path location of h26x file as input

 -i, --infile-type=h264     input file type: [h264 | h265]

 -W, --width=1920           resolution w of the input

 -H, --height=1080          resolution h of the input

 -r, --framerate=30         framerate of the input

 -t, --target=dp            [dp|rtsp|file]

 -o, --outmedia-type=h264   output file type: [h264 | h265]

 -p, --port=554             Port to listen on (default: 554)

 -a, --aitask               select AI task to be run: [facedetect|ssd|refinedet]

 -n, --nodet                no AI inference

 -A, --audio                RTSP with I2S audio input

 -R, --report               report fps

 -s, --screenfps            display fps on screen, notic this will cause perfermance degradation.

 --ROI-off                  turn off ROI (Region-of-Interest)

Examples of supported combinations sorted by input are outlined below.

If using the command line to invoke the smartcam, stop the process via CTRL-C prior to starting the next instance.

MIPI Input (IAS sensor input):
- output: RTSP
  
  sudo smartcam --mipi -W 1920 -H 1080 --target rtsp
- output: RTSP with audio
  
  sudo smartcam --mipi -W 1920 -H 1080 --target rtsp --audio
- output: DP
  
  sudo smartcam --mipi -W 1920 -H 1080 --target dp
- output: file
  
  sudo smartcam --mipi -W 1920 -H 1080 --target file
input file (file on file system):

Note You must update the command to the specific file desired as the input source.
- output: RTSP
  
  sudo smartcam --file ./test.h264 -i h264 -W 1920 -H 1080 -r 30 --target rtsp
- output: DP
  
  sudo smartcam --file ./test.h264 -i h264 -W 1920 -H 1080 -r 30 --target dp
- output: file
  
  sudo smartcam --file ./test.h264 -i h264 -W 1920 -H 1080 -r 30 --target file
input USB (USB webcam):

Note You must ensure the width/height/framerate defined are supported by your USB camera.
- output: RTSP
  
  sudo smartcam --usb 1 -W 1920 -H 1080 -r 30 --target rtsp
- output: DP
  
  sudo smartcam --usb 1 -W 1920 -H 1080 -r 30 --target dp
- output: file
  
  sudo smartcam --usb 1 -W 1920 -H 1080 -r 30 --target file

Files structure of the application

The application is installed as:

Binary File Directory: /opt/xilinx/bin

filename description

smartcam main app

filename	description
smartcam	main app

Script File Directory: /opt/xilinx/bin/

filename	description
`01.mipi-rtsp.sh`	call smartcam to run facedetction and send out rtsp stream.
`02.mipi-dp.sh`	call smartcam to run facedetction and display on DP display.
`03.file-file.sh`	call smartcam to run facedetction and display on input h264/5 file and generate output h264/5 with detection boxes.

Configuration File Directory: /opt/xilinx/share/ivas/smartcam/${AITASK}

AITASK = "facedetect" | "refinedet" | "ssd"

filename description

preprocess.json Config of preprocess for AI inference

aiinference.json Config of AI inference (facedetect|refinedet|ssd)

drawresult.json Config of boundbox drawing
Jupyter notebook file: => /opt/xilinx/share/notebooks/smartcam

filename description

smartcam.ipynb Jupyter notebook file for MIPI --> DP/RTSP demo.

filename	description
preprocess.json	Config of preprocess for AI inference
aiinference.json	Config of AI inference (facedetect\|refinedet\|ssd)
drawresult.json	Config of boundbox drawing

fpgadeveloper/smartcam