SVET Linux sample appliction 2021.1.0 release

Dependency: MediaSDK 21.1.3 and OpenVINO 2021.3

Signed-off-by: Wang Elaine <[email protected]>

Author: dwang26

LICENSE

@@ -1,29 +1,17 @@
-BSD 3-Clause License
-
-Copyright (c) 2021, Intel Corporation
+/******************************************************************************\
+Copyright (c) 2005-2021, Intel Corporation
 All rights reserved.
 
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice, this
-   list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its
-   contributors may be used to endorse or promote products derived from
-   this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+\**********************************************************************************/
+
+

README.md

@@ -38,22 +38,22 @@ See [user guide](./doc/concurrent_video_analytic_sample_application_user_guide_2
 # System requirements
 
 **Operating System:**
-* Ubuntu 18.04.02
+* Ubuntu 18.04.05
 
 **Software:**
-* [MediaSDK 20.3.0](https://github.com/Intel-Media-SDK/MediaSDK/releases/tag/intel-mediasdk-20.3.0)
-* [OpenVINO™ 2021.1](https://software.intel.com/en-us/openvino-toolkit)
+* [MediaSDK 21.1.3](https://github.com/Intel-Media-SDK/MediaSDK/releases/tag/intel-mediasdk-21.1.3)
+* [OpenVINO™ 2021.3](https://software.intel.com/en-us/openvino-toolkit)
 
 **Hardware:** 
-* Intel® platforms supported by the MediaSDK 20.3.0 and OpenVINO 2021.1. 
+* Intel® platforms supported by the MediaSDK 21.1.3 and OpenVINO 2021.3. 
 * For Media SDK, the major platform dependency comes from the back-end media driver. https://github.com/intel/media-driver
 * For OpenVINO™, see details from here: https://software.intel.com/en-us/openvino-toolkit/documentation/system-requirements
 
 # How to build
 
 Run build_and_install.sh to install dependent software packages and build sample application video_e2e_sample. 
 
-Please refer to ”Installation Guide“ in [user guide](./doc/concurrent_video_analytic_sample_application_user_guide_2020.3.0.pdf) for details.
+Please refer to ”Installation Guide“ in [user guide](./doc/concurrent_video_analytic_sample_application_user_guide.pdf) for details.
 
 ## Build steps
 
@@ -68,7 +68,16 @@ cd cva_sample
 ```
 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.
 
-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.3.0.pdf) for details.
+After the script finishing, the sample application video_e2e_sample can be found under ./bin.
+
+In order to enable the media SDK installed by SVET to coexist with different versions of media SDK installed on the same computer, we suggest (we have done so in our build script) that the media SDK environment variables of SVET should only be set in the current bash, not saved to the global system environment.
+So please run 'source ./svet_env_setup.sh' first when you start a new shell (or change user in shell such as run 'su -') to run ./bin/video_e2e_sample".
+
+```sh
+cd cva_sample
+source ./svet_env_setup.sh
+```
+Please refer to "Run sample application" in [user guide](./doc/concurrent_video_analytic_sample_application_user_guide.pdf) for details.
 
 # Known limitations
 

build_and_install.sh

@@ -3,8 +3,26 @@
 root_path=$PWD
 #download_method="git"
 download_method="wget"
+built_with_ocv=true
+LIBVA_INSTALL_PREFIX="/opt/intel/svet/msdk"
+LIBVA_INSTALL_PATH="${LIBVA_INSTALL_PREFIX}/lib"
+LIBVA_DRIVERS_PATH="${LIBVA_INSTALL_PATH}/dri"
+LIBVA_DRIVER_NAME="iHD"
 
-if [[ ! -d "${INTEL_OPENVINO_DIR}" ]];
+while getopts b: flag
+do
+    case "${flag}" in
+        b)
+            if [[ "no_ocv" == ${OPTARG} ]]
+            then
+                echo "Build SVET without OpenVINO"
+                built_with_ocv=false
+            fi
+            ;;
+    esac
+done
+
+if [ ! -d "${INTEL_OPENVINO_DIR}" ] && [ $built_with_ocv = true ];
 then echo "Please make sure openvino has been installed and enviroment variables has been set by "
     echo "source intel/openvino/bin/setupvars.sh"
     exit -1;
@@ -36,11 +54,11 @@ if [[ $download_method == "wget" ]]
 then
     echo "Checking the md5sum of downloaded packages"
     declare -A  media_packages_md5sum
-    media_packages_md5sum[intel-gmmlib-20.3.2.tar.gz]=583d9fbef52d880238629f2ced50a9be
-    media_packages_md5sum[intel-media-20.3.0.tar.gz]=9c9219c09447567254aec00ade5dd3b8
-    media_packages_md5sum[intel-mediasdk-20.3.0.tar.gz]=1fd2cb03d15b3c308e6a9bd1735d2845
-    media_packages_md5sum[libva.tar.gz]=fdc00aedad4a51e058403f5f24d9abac
-    media_packages_md5sum[libva-utils.tar.gz]=a22479f85f7693536c5756ad46192b32 
+    media_packages_md5sum[intel-gmmlib-21.1.1.tar.gz]=100ff57bff1cb19763f729fcd00269d1
+    media_packages_md5sum[intel-media-21.1.3.tar.gz]=98f59d7fd2c6c08808acf0ba741216b0
+    media_packages_md5sum[intel-mediasdk-21.1.3.tar.gz]=a4747e315448ded38171b245232a5a7c
+    media_packages_md5sum[libva.tar.gz]=ba136b5a02ee4c7bf093d09bc1635560
+    media_packages_md5sum[libva-utils.tar.gz]=010243cc8217fd455d0ad11f2025d43c
 
     for c in ${!media_packages_md5sum[@]}; do
         md5_res=`md5sum $c`
@@ -80,40 +98,49 @@ then
     rm -f bin
     ln -s MediaSDK/build/__bin/release/ bin
 
-    
-    va_env_set=`grep "LIBVA_DRIVERS_PATH=/usr/lib/x86_64-linux-gnu/dri" ~/.bashrc -c`
-
-    if (( va_env_set == 0 )) 
-    then
-        set -x
-        export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/lib/x86_64-linux-gnu:/usr/lib
-        export LIBVA_DRIVERS_PATH=/usr/lib/x86_64-linux-gnu/dri
-        export LIBVA_DRIVER_NAME=iHD
-        export MFX_HOME=/opt/intel/mediasdk
-        set +x
-        echo 'export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/lib/x86_64-linux-gnu:/usr/lib' >> ~/.bashrc
-        echo "export LIBVA_DRIVERS_PATH=/usr/lib/x86_64-linux-gnu/dri" >> ~/.bashrc
-        echo "export LIBVA_DRIVER_NAME=iHD" >> ~/.bashrc
-        echo "export MFX_HOME=/opt/intel/mediasdk" >> ~/.bashrc
-
-    fi
 
-    if [[ -d "/opt/intel/mediasdk/lib64" ]]
-    then
-        echo "A old MediaSDK version is found under folder /opt/intel/mediasdk/lib64"
-        echo "Rename /opt/intel/mediasdk/lib64 as /opt/intel/mediasdk/oldlib64"
-        mv  /opt/intel/mediasdk/lib64 /opt/intel/mediasdk/oldlib64
-    fi
-
-    if [[ $LD_LIBRARY_PATH != *"/opt/intel/mediasdk/lib/"* ]]
-    then
-        export LD_LIBRARY_PATH="/opt/intel/mediasdk/lib/:$LD_LIBRARY_PATH"
-        echo 'export LD_LIBRARY_PATH="/opt/intel/mediasdk/lib/:$LD_LIBRARY_PATH"' >> ~/.bashrc
-    fi
+    #va_env_set=`grep "LIBVA_DRIVERS_PATH=/usr/lib/x86_64-linux-gnu/dri" ~/.bashrc -c`
+    set -x
+    export LD_LIBRARY_PATH=$LIBVA_INSTALL_PATH:$LD_LIBRARY_PATH
+    export LIBRARY_PATH=$LIBVA_INSTALL_PATH:$LIBRARY_PATH
+    export LIBVA_DRIVERS_PATH=$LIBVA_DRIVERS_PATH
+    export LIBVA_DRIVER_NAME=$LIBVA_DRIVER_NAME
+    export MFX_HOME=$LIBVA_INSTALL_PREFIX
+    set +x
+
+    #if (( va_env_set == 0 ))
+    #then
+        #set -x
+        #export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/lib/x86_64-linux-gnu:/usr/lib
+        #export LIBVA_DRIVERS_PATH=/usr/lib/x86_64-linux-gnu/dri
+        #export LIBVA_DRIVER_NAME=iHD
+        #export MFX_HOME=/opt/intel/mediasdk
+        #set +x
+        #echo 'export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/lib/x86_64-linux-gnu:/usr/lib' >> ~/.bashrc
+        #echo "export LIBVA_DRIVERS_PATH=/usr/lib/x86_64-linux-gnu/dri" >> ~/.bashrc
+        #echo "export LIBVA_DRIVER_NAME=iHD" >> ~/.bashrc
+        #echo "export MFX_HOME=/opt/intel/mediasdk" >> ~/.bashrc
+
+    #fi
+
+    #if [[ -d "/opt/intel/mediasdk/lib64" ]]
+    #then
+    #    echo "A old MediaSDK version is found under folder /opt/intel/mediasdk/lib64"
+    #    echo "Rename /opt/intel/mediasdk/lib64 as /opt/intel/mediasdk/oldlib64"
+    #    mv  /opt/intel/mediasdk/lib64 /opt/intel/mediasdk/oldlib64
+    #fi
+
+    #if [[ $LD_LIBRARY_PATH != *"/opt/intel/mediasdk/lib/"* ]]
+    #then
+    #    export LD_LIBRARY_PATH="/opt/intel/mediasdk/lib/:$LD_LIBRARY_PATH"
+    #    echo 'export LD_LIBRARY_PATH="/opt/intel/mediasdk/lib/:$LD_LIBRARY_PATH"' >> ~/.bashrc
+    #fi
 
     if [[ -d $cl_cache_dir ]];
     then
         echo "cl_cache is enabled. \$cl_cache_dir : $cl_cache_dir"
+        echo "Clean previous cl kernel cache"
+        sudo rm -f $cl_cache_dir/*
     else
         echo "Add enabling cl_cache commands to ~\.bashrc"
         set -x
@@ -123,36 +150,93 @@ then
         echo "export cl_cache_dir=~/cl_cache" >> ~/.bashrc
     fi
 
+    #install library for metric_monitor
+    sudo cp MediaSDK/build/__bin/release/libcttmetrics.so /usr/lib/
+
     #Start to build SVET sample application
     #Copy MediaSDK sample headers and libraries that weren't installed by default
-    sudo mkdir -p /opt/intel/mediasdk/include/sample_common
-    sudo mkdir -p /opt/intel/mediasdk/include/vpp_plugin
-    sudo mkdir -p /opt/intel/mediasdk/include/rotate_cpu
-    sudo cp -rf MediaSDK/samples/sample_common/include/ /opt/intel/mediasdk/include/sample_common/
-    sudo cp -rf MediaSDK/samples/sample_plugins/vpp_plugin/include/ /opt/intel/mediasdk/include/vpp_plugin/
-    sudo cp -rf MediaSDK/samples/sample_plugins/rotate_cpu/include/ /opt/intel/mediasdk/include/rotate_cpu/
-    sudo cp -f MediaSDK/build/__lib/release/libsample_common.a  /opt/intel/mediasdk/lib/
-    sudo cp -f MediaSDK/build/__lib/release/libvpp_plugin.a /opt/intel/mediasdk/lib/
+    sudo -E mkdir -p $MFX_HOME/include/sample_common
+    sudo -E mkdir -p $MFX_HOME/include/vpp_plugin
+    sudo -E mkdir -p $MFX_HOME/include/rotate_cpu
+    sudo -E cp -rf MediaSDK/samples/sample_common/include/ $MFX_HOME/include/sample_common/
+    sudo -E cp -rf MediaSDK/samples/sample_plugins/vpp_plugin/include/ $MFX_HOME/include/vpp_plugin/
+    sudo -E cp -rf MediaSDK/samples/sample_plugins/rotate_cpu/include/ $MFX_HOME/include/rotate_cpu/
+    sudo -E cp -f MediaSDK/build/__lib/release/libsample_common.a  $LIBVA_INSTALL_PATH/
+    sudo -E cp -f MediaSDK/build/__lib/release/libvpp_plugin.a $LIBVA_INSTALL_PATH/
+
+    rm -rf video_e2e_sample/build
 
     mkdir -p video_e2e_sample/build
+
+    if [ $built_with_ocv != true ]
+    then
+        echo "Use the CMakefile.txt that excludes inference source code"
+        cp script/CMakeLists_woOpenVINO.txt video_e2e_sample/CMakeLists.txt
+    fi
+
     cd video_e2e_sample/build
     cmake ../ | tee /tmp/svet_build.log
     cat /tmp/svet_build.log >> svet_build.log
     make -j4 | tee /tmp/svet_build.log
     cat /tmp/svet_build.log >> svet_build.log
+fi
+
+cd $root_path
+if [ $built_with_ocv = true ]
+then
+    #Download openvino models
+    echo "Check if openvino models IR files have been downloaded...."
+    source ./script/download_and_copy_models.sh
+fi
+
+cd $root_path
 
-    cd $root_path
-    if [[ -f bin/video_e2e_sample ]];
+if [[ ! -d video ]]
+then
+    mkdir -p video
+fi
+
+if [[ ! -f video/1080p.h264 ]]
+then
+   echo "Download test clip video/1080p.h264"
+   cd video/
+   wget -O main.zip https://github.com/elainewangprc/testvideo/archive/refs/heads/main.zip
+   if [[ ! -f "main.zip" ]]
+   then
+       echo "Failed to download https://github.com/elainewangprc/testvideo/archive/refs/heads/main.zip"
+       echo "Please download it manually"
+   else
+       unzip main.zip
+       cp testvideo-main/*.h264 .
+   fi
+   cd ../
+fi
+
+cd $root_path
+if [[ -f bin/video_e2e_sample ]]
+then
+    echo "************************************************************************"
+    echo "SVET sample application building has completed!"
+
+    gen12=`sudo cat /sys/kernel/debug/dri/0/i915_capabilities | grep "gen: 12"`
+    if [[ ! -z $gen12 ]];
     then
-        echo "SVET sample application building has completed!"
-        echo "Please use ./bin/video_e2e_sample for testing"
-    else
-        echo "SVET sample application building failed!"
-        echo "Please create an IPS with SVET in title on premiersupport.intel.com and upload ./svet_build.log ./svet_download.log to IPS."
+        ver=`uname -a`
+        if [[ $ver != *5.4.102* ]] ;
+        then
+            echo "For TigerLake CPU, please refer to user guide chapter 1.3 to upgrade the kernel with https://github.com/intel/linux-intel-lts/releases/tag/lts-v5.4.102-yocto-210310T010318Z";
+        fi
     fi
-fi
 
-#Download openvino models
-echo "Check if openvino models IR files have been downloaded...."
-source ./script/download_and_copy_models.sh
+    echo "Please run the cmd below to setup running environment:"
+    echo " "
+    echo "source ./svet_env_setup.sh"
+    echo " "
+    echo "Then use ./bin/video_e2e_sample for testing"
+    echo "IMPORTANT NOTICE: please run 'source ./svet_env_setup.sh' first when you start a new shell (or change user in shell such as run 'su -') to run ./bin/video_e2e_sample"
+    echo "************************************************************************"
+else
+    echo "SVET sample application building failed!"
+    echo "Please create an IPS with SVET in title on premiersupport.intel.com and upload ./svet_build.log ./svet_download.log to IPS."
+fi
 

doc/FAQ.md

@@ -1,7 +1,7 @@
 # Frequently asked questions (SVET sample application)
 
 ## Where can I find the descritpion of options used in par file?
-See chapter 2.4 in doc/svet_sample_application_user_guide_2020.1.0.pdf
+See chapter 2.4 in doc/svet_sample_application_user_guide_2021.1.0.pdf
 Running the SVET sample applicton with option "-?" can show the usage of options.
 
 ## Why does the system need to be switched to text console mode before running the sample application
@@ -44,7 +44,7 @@ It can be caused by the decoded frames aren't fed to inference engine efficientl
 Please refer to https://github.com/opencv/open_model_zoo/tree/master/models/intel. The names of models used in sample application are
 face-detection-retail-0004, human-pose-estimation-0001, vehicle-attributes-recognition-barrier-0039, vehicle-license-plate-detection-barrier-0106.
 
-## Can I use other OpenVINO version rather than 2020.3 ?
+## Can I use other OpenVINO version rather than 2021.3 ?
 Yes, but you have to modify some code due to interfaces changing. And also you need to download the IR files and copy them to ./model manually. Please refer to script/download_and_copy_models.sh for how to download the IR files.
 
 ## When run 4 channel decode plus inference and display on APL, the CPU occupy ratio is very high and fps is low