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

Commit 380be18

Browse files
authored
Update analytics related description in Server.md (#818)
1 parent 72f1038 commit 380be18

File tree

1 file changed

+27
-17
lines changed

1 file changed

+27
-17
lines changed

doc/servermd/Server.md

Lines changed: 27 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -807,36 +807,42 @@ For usage of media analytics REST API, refer to the REST API document.
807807
### 6.1.2 Building Existing Plugins {#Conferencesection6_1_2}
808808
A few sample plugins are shipped with OWT server. After you build and install OWT server, the source of those analytics plugins will be placed under analytics_agent/plugins/ directory.
809809

810-
Before you build those plugins, you need to install Intel Distribution of OpenVINO 2018 R5 from [https://software.intel.com/en-us/openvino-toolkit/](https://software.intel.com/en-us/openvino-toolkit/). After installation, make sure you go to /opt/intel/computer_vision_sdk/install_dependencies/ directory, and run:
811-
sudo -E ./install_NEO_OCL_driver.sh
810+
Besides basic OWT dependencies, analytics agent requires OpenVINO and GStreamer to do video analytics. Please download OpenVINO 2021.1.110 and dlstreamer_gst 1.2.1 version and refer to option 3 steps in [dlstreamer_gst install guide](https://github.com/openvinotoolkit/dlstreamer_gst/wiki/Install-Guide#install-on-host-machine) to install OpenVINO, gst-video-analytics plugins and related dependencies.
812811

813-
Intel Distribution of OpenVINO 2018 R5 will require Intel Core 6th to 8th Generation with Intel HD graphics or Iris(Pro) graphics for inferencing on GPU with OpenCL as the backend. The supported OSes are Ubuntu 16.04 and higher, or CentOS 7.4 or higher. Make sure your hardware/software configuration is correct before building and deploying the sample plugins.
812+
For dlstreamer installation in CentOS, required version is >=3.1, if your system installed cmake version is < 3.1, build process will fail. In this case, following steps below:
813+
```
814+
yum remove cmake
815+
wget https://github.com/Kitware/CMake/releases/download/v3.14.5/cmake-3.14.5-Linux-x86_64.tar.gz
816+
tar zxf cmake-3.14.5-Linux-x86_64.tar.gz -C /opt/
817+
export CMAKE_HOME=/opt/cmake-3.14.5-Linux-x86_64
818+
export PATH=$PATH:$CMAKE_HOME/bin
819+
cmake --version
820+
```
821+
822+
Then you can continue to build dlstreamer.
823+
824+
Intel Distribution of OpenVINO 2021.1.110 will require Intel Core 6th to 11th Generation with Intel HD graphics or Iris(Pro) graphics for inferencing on GPU with OpenCL as the backend. The supported OSes are Ubuntu 18.04 and higher, or CentOS 7.4 or higher. Make sure your hardware/software configuration is correct before building and deploying the sample plugins.
814825

815826
To build the plugins, simply go to analytics_agent/plugins/sample directory, and run:
816827
./build_samples.sh
817828

818829
Copy all files under build/intel64/Release/lib/ to analytics_agent/lib/ directory, or to the libpath as specified in agent.toml in analytics_agent.
819830

820831
### 6.1.3 Using Pre-built Plugins {#Conferencesection6_1_3}
821-
The Server provides 4 plugins as source code which can be built by your own. To verify them, make sure you run ```source /opt/intel/computer_vision_sdk/bin/setupvars.sh``` before starting up OWT server.
832+
The Server provides 3 plugins as source code which can be built by your own. To verify them, make sure you run ```source /opt/intel/openvino/bin/setupvars.sh``` before starting up OWT server.
822833

823834
#### 6.1.3.1 Face Detection Plugin {#Conferencesection6_1_3_1}
824-
Identified by GUID b849f44bee074b08bf3e627f3fc927c7. This plugin provides the capability of finding faces in current analyzed stream and annotates it with a rectangle boarder on the face.
835+
Identified by GUID dc51138a8284436f873418a21ba8cfa7. This plugin provides the capability of detect face in current stream using GPU and VPU. This sample needs to run on Intel GPU and VPU.
825836
#### 6.1.3.2 Face Recognition Plugin {#Conferencesection6_1_3_2}
826-
Identified by GUID 3f932ff2a80341faa0a73ebb3bcfb85d. This plugin provides the capability of identifying people's name in current stream and annotates them with a rectangle on the face, and also list the name and the confidence of the recognition result.
827-
To add new people for recognition, here are the steps:
828-
1. Take at least 3 pictures of one person and place them under the raw_photos directory with sub-directory name that identifies that person's name(no space in the directory name). The raw_photos should be under the same directory with the pre-process tool.
829-
2. Run the pre-process tool to process the raw photos (which is also built when you build the samples). Append the path of libcpu_extension.so you built to LD_LIBRARY_PATH before you run the tool. Put the output vectors.txt under analytics_agent direcotry of OWT server.
837+
Identified by GUID dc51138a8284436f873418a21ba8cfa8. This plugin provides the capability of basic adding stream in OWT server and save the the stream to a file using different GStreamer plugins.
830838
#### 6.1.3.3 Smart Class Room Plugin {#Conferencesection6_1_3_3}
831-
Identified by GUID 10c213f3d55249718d3bd44712488502. This plugin provides the capability of recognizing the gestures in the stream and annotates the gestures accordingly.
832-
#### 6.1.3.4 Dummy Plugin {#Conferencesection6_1_3_4}
833-
Identified by GUID dc51138a8284436f873418a21ba8cfa7. This plugin simply modifies part of the stream to demonstrate the working process of plugins.
839+
Identified by GUID dc51138a8284436f873418a21ba8cfa9. This plugin provides the capability of detect face in current stream and send back analyzed stream to OWT server.
834840

835841
### 6.1.4 Create and Deploy Your Own Media Analytics Plugin {#Conferencesection6_1_4}
836-
OWT server allows you creating your own media analytics plugins and deploy them to OWT server. Refer to the analytics_agent/plugins/include/plugin.h for more detailed API interface that each media analytics plugin needs to implement.
842+
OWT server allows you creating your own media analytics plugins and deploy them to OWT server. Refer to the analytics_agent/plugins/include/pipeline.h for more detailed API interface that each media analytics plugin needs to implement.
837843

838844
#### 6.1.4.1 Create Plugin {#Conferencesection6_1_4_1}
839-
Your plugin class implementation must inherit from rvaPlugin interface as defined in analytics_agent/plugins/include/plugin.h. Besides the plugin class implementation, it is required to include the DECLARE_PLUGIN(ClassName) macro to export your plugin implementation.
845+
Your plugin class implementation must inherit from rvaPlugin interface as defined in analytics_agent/plugins/include/pipeline.h. Besides the plugin class implementation, it is required to include the DECLARE_PLUGIN(ClassName) macro to export your plugin implementation.
840846
#### 6.1.4.2 Deploy Your Plugin {#Conferencesection6_1_4_2}
841847
To deploy a plugin to OWT Server, you will need to generate a new GUID for your plugin. After that, copy your plugin .so files to analytics_agent/lib, or to the libpath as specified by agent.toml of analtyics agent. Also you need to add an entry into the plugin.cfg file under analytics_agent with the GUID you generated, for example:
842848
[c842f499aa093c27cf1e328f2fc987c7]
@@ -846,8 +852,12 @@ To deploy a plugin to OWT Server, you will need to generate a new GUID for your
846852
name = 'libsomeplugin.so' # full name of the plugin library
847853
libpath = 'pluginlibs/' # relative to analytics_agent directory
848854
configpath = 'pluginlibs/' # relative to analytics agent directory
849-
messaging = true # set to false if your plugin does not send notification
850-
inputfourcc = 'I420' # must be I420 for current version
851-
outputfourcc = 'I420' # set to "" if your plugin will not republish analyzed stream to OWT server.
855+
modelpath = '/mnt/models/face-detection-retail-0004.xml' # inference model path
856+
inferencewidth = 672 # inference input width.
857+
inferenceheight = 384 # inference input height.
858+
inferenceframerate = 5 # inference input framerate
859+
852860

853861
Restart analytics agent and your plugin will be added to OWT server.
862+
863+
For more detailed guide on analytics running environment and plugin development, please refer to doc in GitHub [AnalyticsGuide](https://github.com/open-webrtc-toolkit/owt-server/blob/master/doc/servermd/AnalyticsGuide.md)

0 commit comments

Comments
 (0)