Sanbapolis Arena Management System

Welcome to the repository for everything regarding the management system for the Sanbapolis Arena in Trento.

Table of Contents

Introduction
System Architecture Project Structure Install and run

Introduction

The Sanbapolis Arena has 13 cameras deployed to record sport events from multiple perspectives. The goal of this project is to allow the teams to easily use the cameras to record matches or training sessions and then use analytics tools to extract valuable data to improve performance.

System Architecture

The system is composed by a Rust backend which exposes web APIs for client interaction with a Rocket server. Data is stored in a MariaDB database (a fork of MySQL).

This architecture gives the option to implement various frontend applications, such as a webapp, a mobile app, a Telegram bot, etc.

The IP cameras deployed in the Arena provide a RTSP stream that this system is able to capture and send to a video player with a DASH stream.

Project Structure

This section exlains how the project is organised and gives some advice on how to expand this project while keeping it well structured.

Backend

The Rust backend is divided in several packages following the Clean Architecture guideline. Instead of building a monolithic software (which would become a nightmare to expand and maintain), each package focuses on one aspect of the system (also called layer).

The packages are:

• api

  This package contains all the code that enables the interaction with the application package through web APIs.

  The APIs are documented with the OpenAPI 3.1 specification and a Rust wrapper for Swagger-UI. Run the project and visit http://localhost:8000/swagger-ui to take a look at the documentation.

• application

  This package contains the business logic that performs operations on data stored and provided by the domain package.

• domain

  This package contains all the models and schemas used by Diesel to send and retrieve data from the MariaDB database.

• infrastructure

  This package is used to keep all files used by dependencies, such as Diesel's migrations and a folder to store DASH files.

• shared

  Any data or code used in multiple parts of the project is kept here.

The dependencies between packages are organized so that the code follows the principles of Clean Architecture.

Frontend

//TODO when the frontend development is ongoing

Install and run

In addition to this repo, to run the project you will need to setup a database and (optionally) a RTSP camera (which can be emulated with VLC).

Database Setup

1. Download and install a recent version of MariaDB for your operating system.

2. Open a terminal and use these commands to create the database:

   a. Connect to the MariaDB server with

   sudo mysql -u root -p
   

   and enter the password for the root user.

   b. Create the database with

   CREATE DATABASE sanbapolis;
   

   c. Create a user that Diesel will use to operate on the database:

   CREATE USER 'sanbapolis_user'@'localhost' IDENTIFIED BY '<password>';
   
   GRANT ALL PRIVILEGES ON sanbapolis.* TO 'sanbapolis_user'@'localhost';
   
   FLUSH PRIVILEGES;
   

   You will need to add the username and password to the .env file of the project.

   d. Exit the DB console

   EXIT;
   

   e. (Optional) You might want to install a client to inspect the database for development purposes such as DBeaver

3. In the root folder of the project create a .env file and add the following variables:

   DATABASE_URL=mysql://sanbapolis_user:<password>@localhost/sanbapolis
   JWT_SECRET=<jwt_secret>     # The key used to encrypt JWT tokens
   JWT_DURATION_SECONDS=900    # 15 minutes of validity for every token generated
   

   Make sure to set the same password you chose for the user in step 2c.

4. Follow the instructions to install Diesel CLI

   At the top of the page make sure to select the guide for MySQL (MariaDB is cross-compatible with MySQL syntax and drivers).

5. Navigate to the infrastructure crate and use the following command to setup the database with Diesel

   diesel migration run
   

   To make sure everything works as expected, you can also revert and redo the migrations with this command

   diesel migration redo
   

6. Now that the database structure is present, you can run the project and, for instance, signup as a new user and create a sports club and a team. To learn more about what APIs you can use, visit the /swagger-ui page while the project is running.

Camera Setup

VLC media player can be used to emulate a RTSP camera using a video file saved on your computer.

1. Download VLC media player

2. Choose a video to use as a source for the RTSP camera emulation. If you don't have one, you can easily download a 1 hour test video from Youtube.

3. Add a camera record to the database with this statement:

   INSERT INTO camera (id,ipv4_address,port,username,password) VALUES (1,'127.0.0.1',8554,'username','password');
   

   This data will be used by the program to connect to the RTSP stream.

4. Since VLC doesn't seem to support authentication for RTSP streams, set this variable as false in the .env file:

   RTSP_AUTHENTICATION=false
   

   This way the module in charge of capturing the camera stream will not provide the credentials stored in the database.

5. Start a RTSP server with VLC:

   a. Open VLC

   b. Select Media > Stream (or press CTRL + S)

   c. In the File tab press the Add button and select the file to use as a video source

   d. Press Stream (if not present, choose Stream from the dropdown menu of the button)

   e. Press Next

   f. In the Destination setup window, choose RTSP as a new destination and press the Add button

   g. Set the port field with the same port value you used in step 3 (the default for RTSP is 8554). Leave the path field as / and press Next

   h. In the Transcoding options window, make sure Activate transcoding is checked and press Next

   i. Press Stream to start the server

   j. Now the progress bar in the player window starts advancing. You can use the Play/Pause button to stop or resume the stream

6. Start the project and visit http://localhost:8000/static to load the demo page with the video player.

7. For now, to start the DASH streaming service, you need to call the /player/start endpoint manually. You can do this from the Swagger UI documentation page (http://localhost:8000/swagger-ui).

   A proper frontend should call this endpoint when the video player is shown to the user.

8. The video player should start displaying the video (you may need to reload the page if the player ended its loading attempt).

9. To stop the streaming, call /player/stop.