Skip to content
This repository was archived by the owner on Sep 30, 2024. It is now read-only.

Commit 49d27fb

Browse files
committed
update README.md and rephase some wording in scripts
Signed-off-by: roger mao <[email protected]>
1 parent 1c62617 commit 49d27fb

File tree

4 files changed

+82
-4
lines changed

4 files changed

+82
-4
lines changed

README.md

Lines changed: 77 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,77 @@
1-
# concurrent-video-anlalytic-pipeline-optimzation-sample
1+
# Concurrent Video Analytic Pipeline Optimzation Sample
2+
Support users to quickly setup and adjust the core concurrent video analysis workload through configuration file to obtain the best performance of video codec, post-processing and inference based on Intel® integrated GPU according to their product requirements.
3+
Users can use the sample application video_e2e_sample to complete runtime performance evaluation or as a reference for debugging core video workload issues.
4+
5+
## Typical workloads
6+
Sample par files can be found in par_files directory. Verfied on i7-8559U. Performance differs on other platforms.
7+
* 16 1080p H264 decoding, scaling, face detection inference, rendering inference results, composition, saving composition results to local H264 file, and display
8+
* 4 1080p H264 decoding, scaling, human pose estimation inference, rendering inference results, composition and display
9+
* 4 1080p H264 decoding, scaling, vehicle and vehicle attributes detection inference, rendering inference results, composition and display
10+
* 16 1080p RTSP H264 stream decoding, scaling, face detection inference, rendering inference results, composition and display.
11+
* 16 1080p H264 decoding, scaling, face detection inference, rendering inference results, composition and display. Plus 16 1080p H264 decoding, composition and showing on second display.
12+
13+
# Dependencies
14+
The sample application depends on [Intel® Media SDK](https://github.com/Intel-Media-SDK/), [Intel® OpenVINO™](https://software.intel.com/en-us/openvino-toolkit) and [FFmpeg](https://www.ffmpeg.org/)
15+
16+
# FAQ
17+
See doc/FAQ.md
18+
19+
# Table of contents
20+
21+
* [License](#license)
22+
* [How to contribute](#how-to-contribute)
23+
* [Documentation](#documentation)
24+
* [System requirements](#system-requirements)
25+
* [How to build](#how-to-build)
26+
* [Build steps](#build-steps)
27+
* [Known limitations](#know-limitations)
28+
29+
# License
30+
The sample application is licensed under MIT license. See [LICENSE](./LICENSE) for details.
31+
32+
# How to contribute
33+
See [CONTRIBUTING](./doc/CONTRIBUTING.md) for details. Thank you!
34+
35+
# Documentation
36+
See [user guide](./doc/concurrent_video_analytic_sample_application_user_guide_2020.1.0.pdf)
37+
38+
# System requirements
39+
40+
**Operating System:**
41+
* Ubuntu 18.04.02
42+
43+
**Software:**
44+
* [MediaSDK 19.4.0](https://github.com/Intel-Media-SDK/MediaSDK/releases/tag/intel-mediasdk-19.4.0)
45+
* [OpenVINO™ 2019 R3](https://software.intel.com/en-us/openvino-toolkit)
46+
47+
**Hardware:**
48+
* Intel® platforms supported by the MediaSDK 19.4.0 and OpenVINO 2019 R3.
49+
* For Media SDK, the major platform dependency comes from the back-end media driver. https://github.com/intel/media-driver
50+
* For OpenVINO™, see details from here: https://software.intel.com/en-us/openvino-toolkit/documentation/system-requirements
51+
52+
# How to build
53+
54+
Run build_and_install.sh to install dependent software packages and build sample application video_e2e_sample.
55+
56+
Please refer to ”Installation Guide“ in [user guide](./doc/concurrent_video_analytic_sample_application_user_guide_2020.1.0.pdf) for details.
57+
58+
## Build steps
59+
60+
Get sources with the following git command:
61+
```sh
62+
git clone https://github.com/intel-iot-devkit/concurrent-video-analytic-pipeline-optimization-sample-l.git cva_sample
63+
```
64+
65+
```sh
66+
cd cva_sample
67+
./build_and_install.sh
68+
```
69+
This script will install the dependent software packages by running command "apt install". So it will ask for sudo password. Then it will download libva, libva-util, media-driver and MediaSDK source code and install these libraries. It might take 10 to 20 minutes depending on the network bandwidth.
70+
71+
After the script finishing, the sample application video_e2e_sample can be found under ./bin. Please refer to "Run sample application" in [user guide](./doc/concurrent_video_analytic_sample_application_user_guide_2020.1.0.pdf) for details.
72+
73+
# Known limitations
74+
75+
The sample application has been validated on Intel® platforms Skylake(i7-6770HQ), Coffee Lake(i7-8559U i7-8700) and Whiskey Lake(i7-8665UE).
76+
77+

build_and_install.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ then
6363
echo 'export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:/opt/intel/mediasdk/lib"' >> ~/.bashrc
6464
fi
6565

66-
echo "VAAS sample application building has completed!"
66+
echo "Sample application building has completed!"
6767
echo "Please use ./bin/video_e2e_sample for testing"
6868
fi
6969

script/install_binary.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/bin/bash
2-
3-
#use should use sudo to run this binaries
2+
#This script is supposed to run under directory svet_e2e_sample_l which is generated by script pack_binary.sh
3+
#Please use "sudo" to run this script for installing libva, media-driver and MediaSDK library binaries.
44

55
echo "If libva/media-driver/MediaSDK have been installed before, their libraies will be overwrote!"
66

script/pack_binary.sh

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
#!/bin/bash
2+
#This script is used to pack all libva, media-driver and MediaSDK binaries to directory svet_e2e_sample_l.
3+
#Copy whole directory svet_e2e_sample_l to another device and run install_binary.sh to install the binaries
24

35
root_path=$PWD
46
release_folder=$root_path/svet_e2e_sample_l

0 commit comments

Comments
 (0)