README.md 2.36 KB
Newer Older
Nadir Dalla Pozza's avatar
Nadir Dalla Pozza committed
1
# Video Analyser
Niccolò Pretto's avatar
Niccolò Pretto committed
2

Matteo's avatar
Matteo committed
3
4
[![MPAI CAE-ARP](https://img.shields.io/badge/MPAI%20CAE--ARP-gray?style=for-the-badge&logo=AppleMusic&logoColor=cyan&link=https://mpai.community/standards/mpai-cae/about-mpai-cae/)](https://mpai.community/standards/mpai-cae/about-mpai-cae/)

Matteo Spanio's avatar
update    
Matteo Spanio committed
5
6
[TOC]

Nadir Dalla Pozza's avatar
Nadir Dalla Pozza committed
7
8
9
10
## Description
Implements the Technical Specification of [MPAI CAE-ARP](https://mpai.community/standards/mpai-cae/about-mpai-cae/#Figure2) *Video Analyser* AIM, providing:
* 2 Irregularity Files;
* Irregularity Images.
Niccolò Pretto's avatar
Niccolò Pretto committed
11

Matteo Spanio's avatar
update    
Matteo Spanio committed
12
## Quick start
Niccolò Pretto's avatar
Niccolò Pretto committed
13

Matteo Spanio's avatar
update    
Matteo Spanio committed
14
Clone the repository:
Niccolò Pretto's avatar
Niccolò Pretto committed
15
```
Matteo Spanio's avatar
update    
Matteo Spanio committed
16
git clone https://gitlab.dei.unipd.it/mpai/video-analyzer.git
Nadir Dalla Pozza's avatar
Nadir Dalla Pozza committed
17
```
Niccolò Pretto's avatar
Niccolò Pretto committed
18

Matteo Spanio's avatar
update    
Matteo Spanio committed
19
20
21
22
23
24
Install the dependencies:
- [Boost C++ Libraries](https://www.boost.org);
- [OpenCV](https://docs.opencv.org/4.x/index.html);
- [nlohmann/json](https://github.com/nlohmann/json).

Build the project from the root directory:
Nadir Dalla Pozza's avatar
Nadir Dalla Pozza committed
25
```
Matteo Spanio's avatar
update    
Matteo Spanio committed
26
make build
Nadir Dalla Pozza's avatar
Nadir Dalla Pozza committed
27
```
Niccolò Pretto's avatar
Niccolò Pretto committed
28

Matteo Spanio's avatar
update    
Matteo Spanio committed
29
Add the Preservation Files to the `data` directory following this structure:
Nadir Dalla Pozza's avatar
Nadir Dalla Pozza committed
30
```
Matteo Spanio's avatar
update    
Matteo Spanio committed
31
data
Nadir Dalla Pozza's avatar
Nadir Dalla Pozza committed
32
33
34
35
├── PreservationAudioFile
│   ├── File1.wav
│   ├── File2.wav
│   └── ...
Matteo Spanio's avatar
update    
Matteo Spanio committed
36
37
38
└── PreservationAudioVisualFile
    ├── File1.mp4
    ├── File2.mp4
Nadir Dalla Pozza's avatar
Nadir Dalla Pozza committed
39
40
    └── ...
```
Niccolò Pretto's avatar
Niccolò Pretto committed
41

Matteo Spanio's avatar
update    
Matteo Spanio committed
42
Run the project from the root directory:
Nadir Dalla Pozza's avatar
Nadir Dalla Pozza committed
43
```
Matteo Spanio's avatar
update    
Matteo Spanio committed
44
make run
Nadir Dalla Pozza's avatar
Nadir Dalla Pozza committed
45
```
Niccolò Pretto's avatar
Niccolò Pretto committed
46

Matteo Spanio's avatar
update    
Matteo Spanio committed
47
48
49
50
## Generate the documentation
Along with the source code, the documentation of the *Video Analyser* is provided in the `docs` folder. The documentation is generated with [Doxygen](https://www.doxygen.nl/index.html) and can be accessed by opening the `index.html` file in the `docs/html` folder with a browser.

To generate the documentation, run the following command from the root folder:
Nadir Dalla Pozza's avatar
Nadir Dalla Pozza committed
51
```
Matteo Spanio's avatar
update    
Matteo Spanio committed
52
make docs
Nadir Dalla Pozza's avatar
Nadir Dalla Pozza committed
53
```
Matteo Spanio's avatar
update    
Matteo Spanio committed
54
55

Note that Doxygen must be installed on your machine.
Niccolò Pretto's avatar
Niccolò Pretto committed
56
57

## Support
Nadir Dalla Pozza's avatar
Nadir Dalla Pozza committed
58
59
60
If you require additional information or have any problem, you can contact us at:
* Nadir Dalla Pozza (nadir.dallapozza@unipd.it);
* Niccolò Pretto (niccolo.pretto@unipd.it).
Niccolò Pretto's avatar
Niccolò Pretto committed
61

Nadir Dalla Pozza's avatar
Nadir Dalla Pozza committed
62
63
64
65
66
## Authors and acknowledgment
This project was developed by:
* Nadir Dalla Pozza (University of Padova);
* Niccolò Pretto (University of Padova);
* Sergio Canazza (University of Padova).
Niccolò Pretto's avatar
Niccolò Pretto committed
67

Nadir Dalla Pozza's avatar
Nadir Dalla Pozza committed
68
69
70
71
This project takes advantage of the following libraries:
* [Boost C++ Libraries](https://www.boost.org);
* [OpenCV](https://docs.opencv.org/4.x/index.html);
* [nlohmann/json](https://github.com/nlohmann/json).
Niccolò Pretto's avatar
Niccolò Pretto committed
72

Nadir Dalla Pozza's avatar
Nadir Dalla Pozza committed
73
Developed with IDE [Visual Studio Code](https://code.visualstudio.com).
Niccolò Pretto's avatar
Niccolò Pretto committed
74
75

## License
Matteo Spanio's avatar
update    
Matteo Spanio committed
76
This project is licensed with [GNU GPL v3.0](https://www.gnu.org/licenses/gpl-3.0.html).