Installing on Debian and Ubuntu
-
Install Bazelisk.
Follow the official Bazel documentation to install Bazelisk.
-
Checkout MediaPipe repository.
$ cd $HOME $ git clone --depth 1 https://github.com/google/mediapipe.git # Change directory into MediaPipe root directory $ cd mediapipe -
Install OpenCV and FFmpeg.
Option 1. Use package manager tool to install the pre-compiled OpenCV libraries. FFmpeg will be installed via
libopencv-video-dev.OS OpenCV Debian 9 (stretch) 2.4 Debian 10 (buster) 3.2 Debian 11 (bullseye) 4.5 Ubuntu 16.04 LTS 2.4 Ubuntu 18.04 LTS 3.2 Ubuntu 20.04 LTS 4.2 Ubuntu 20.04 LTS 4.2 Ubuntu 21.04 4.5 $ sudo apt-get install -y \ libopencv-core-dev \ libopencv-highgui-dev \ libopencv-calib3d-dev \ libopencv-features2d-dev \ libopencv-imgproc-dev \ libopencv-video-devNote. On Debian 11/Ubuntu 21.04 when OpenCV 4.5 is installed with
libopencv-video-dev,libopencv-contrib-devshould also be installed.$ sudo apt-get install -y libopencv-contrib-devMediaPipe's
opencv_linux.BUILDandWORKSPACEare already configured for OpenCV 2/3 and should work correctly on any architecture:# WORKSPACE new_local_repository ( name = "linux_opencv" , build_file = "@//third_party:opencv_linux.BUILD" , path = "/usr" , ) # opencv_linux.BUILD for OpenCV 2/3 installed from Debian package cc_library ( name = "opencv" , linkopts = [ "-l:libopencv_core.so" , "-l:libopencv_calib3d.so" , "-l:libopencv_features2d.so" , "-l:libopencv_highgui.so" , "-l:libopencv_imgcodecs.so" , "-l:libopencv_imgproc.so" , "-l:libopencv_video.so" , "-l:libopencv_videoio.so" , ] , )For OpenCV 4 you need to modify
opencv_linux.BUILDtaking into account current architecture:# WORKSPACE new_local_repository ( name = "linux_opencv" , build_file = "@//third_party:opencv_linux.BUILD" , path = "/usr" , ) # opencv_linux.BUILD for OpenCV 4 installed from Debian package cc_library ( name = "opencv" , hdrs = glob ([ # Uncomment according to your multiarch value (gcc -print-multiarch): # "include/aarch64-linux-gnu/opencv4/opencv2/cvconfig.h", # "include/arm-linux-gnueabihf/opencv4/opencv2/cvconfig.h", # "include/x86_64-linux-gnu/opencv4/opencv2/cvconfig.h", "include/opencv4/opencv2/**/*.h*" , ]) , includes = [ # Uncomment according to your multiarch value (gcc -print-multiarch): # "include/aarch64-linux-gnu/opencv4/", # "include/arm-linux-gnueabihf/opencv4/", # "include/x86_64-linux-gnu/opencv4/", "include/opencv4/" , ] , linkopts = [ "-l:libopencv_core.so" , "-l:libopencv_calib3d.so" , "-l:libopencv_features2d.so" , "-l:libopencv_highgui.so" , "-l:libopencv_imgcodecs.so" , "-l:libopencv_imgproc.so" , "-l:libopencv_video.so" , "-l:libopencv_videoio.so" , ] , )Option 2. Run
setup_opencv.shto automatically build OpenCV from source and modify MediaPipe's OpenCV config. This option will do all steps defined in Option 3 automatically.Option 3. Follow OpenCV's documentation to manually build OpenCV from source code.
You may need to modify
WORKSPACEandopencv_linux.BUILDto point MediaPipe to your own OpenCV libraries. Assume OpenCV would be installed to/usr/local/which is recommended by default.OpenCV 2/3 setup:
# WORKSPACE new_local_repository ( name = "linux_opencv" , build_file = "@//third_party:opencv_linux.BUILD" , path = "/usr/local" , ) # opencv_linux.BUILD for OpenCV 2/3 installed to /usr/local cc_library ( name = "opencv" , linkopts = [ "-L/usr/local/lib" , "-l:libopencv_core.so" , "-l:libopencv_calib3d.so" , "-l:libopencv_features2d.so" , "-l:libopencv_highgui.so" , "-l:libopencv_imgcodecs.so" , "-l:libopencv_imgproc.so" , "-l:libopencv_video.so" , "-l:libopencv_videoio.so" , ] , )OpenCV 4 setup:
# WORKSPACE new_local_repository ( name = "linux_opencv" , build_file = "@//third_party:opencv_linux.BUILD" , path = "/usr/local" , ) # opencv_linux.BUILD for OpenCV 4 installed to /usr/local cc_library ( name = "opencv" , hdrs = glob ([ "include/opencv4/opencv2/**/*.h*" , ]) , includes = [ "include/opencv4/" , ] , linkopts = [ "-L/usr/local/lib" , "-l:libopencv_core.so" , "-l:libopencv_calib3d.so" , "-l:libopencv_features2d.so" , "-l:libopencv_highgui.so" , "-l:libopencv_imgcodecs.so" , "-l:libopencv_imgproc.so" , "-l:libopencv_video.so" , "-l:libopencv_videoio.so" , ] , )Current FFmpeg setup is defined in
ffmpeg_linux.BUILDand should work for any architecture:# WORKSPACE new_local_repository ( name = "linux_ffmpeg" , build_file = "@//third_party:ffmpeg_linux.BUILD" , path = "/usr" ) # ffmpeg_linux.BUILD for FFmpeg installed from Debian package cc_library ( name = "libffmpeg" , linkopts = [ "-l:libavcodec.so" , "-l:libavformat.so" , "-l:libavutil.so" , ] , ) -
For running desktop examples on Linux only (not on OS X) with GPU acceleration.
# Requires a GPU with EGL driver support. # Can use mesa GPU libraries for desktop, (or Nvidia/AMD equivalent). sudo apt-get install mesa-common-dev libegl1-mesa-dev libgles2-mesa-dev # To compile with GPU support, replace --define MEDIAPIPE_DISABLE_GPU = 1 # with --copt -DMESA_EGL_NO_X11_HEADERS --copt -DEGL_NO_X11 # when building GPU examples. -
Run the Hello World! in C++ example .
$ export GLOG_logtostderr = 1 # if you are running on Linux desktop with CPU only $ bazel run --define MEDIAPIPE_DISABLE_GPU = 1 \ mediapipe/examples/desktop/hello_world:hello_world # If you are running on Linux desktop with GPU support enabled (via mesa drivers) $ bazel run --copt -DMESA_EGL_NO_X11_HEADERS --copt -DEGL_NO_X11 \ mediapipe/examples/desktop/hello_world:hello_world # Should print: # Hello World! # Hello World! # Hello World! # Hello World! # Hello World! # Hello World! # Hello World! # Hello World! # Hello World! # Hello World!
If you run into a build error, please read Troubleshooting to find the solutions of several common build issues.
Installing on CentOS
Disclaimer: Running MediaPipe on CentOS is experimental.
-
Install Bazelisk.
Follow the official Bazel documentation to install Bazelisk.
-
Checkout MediaPipe repository.
$ git clone --depth 1 https://github.com/google/mediapipe.git # Change directory into MediaPipe root directory $ cd mediapipe -
Install OpenCV.
Option 1. Use package manager tool to install the pre-compiled version.
$ sudo yum install opencv-develOption 2. Build OpenCV from source code.
new_local_repository ( name = "linux_opencv" , build_file = "@//third_party:opencv_linux.BUILD" , path = "/usr/local" , ) new_local_repository ( name = "linux_ffmpeg" , build_file = "@//third_party:ffmpeg_linux.BUILD" , path = "/usr/local" , ) cc_library ( name = "opencv" , srcs = glob ( [ "lib/libopencv_core.so" , "lib/libopencv_highgui.so" , "lib/libopencv_imgcodecs.so" , "lib/libopencv_imgproc.so" , "lib/libopencv_video.so" , "lib/libopencv_videoio.so" , ] , ) , hdrs = glob ([ # For OpenCV 3.x "include/opencv2/**/*.h*" , # For OpenCV 4.x # "include/opencv4/opencv2/**/*.h*", ]) , includes = [ # For OpenCV 3.x "include/" , # For OpenCV 4.x # "include/opencv4/", ] , linkstatic = 1 , visibility = [ "//visibility:public" ] , ) cc_library ( name = "libffmpeg" , srcs = glob ( [ "lib/libav*.so" , ] , ) , hdrs = glob ([ "include/libav*/*.h" ]) , includes = [ "include" ] , linkopts = [ "-lavcodec" , "-lavformat" , "-lavutil" , ] , linkstatic = 1 , visibility = [ "//visibility:public" ] , ) -
Run the Hello World! in C++ example .
$ export GLOG_logtostderr = 1 # Need bazel flag 'MEDIAPIPE_DISABLE_GPU=1' if you are running on Linux desktop with CPU only $ bazel run --define MEDIAPIPE_DISABLE_GPU = 1 \ mediapipe/examples/desktop/hello_world:hello_world # Should print: # Hello World! # Hello World! # Hello World! # Hello World! # Hello World! # Hello World! # Hello World! # Hello World! # Hello World! # Hello World!
If you run into a build error, please read Troubleshooting to find the solutions of several common build issues.
Installing on macOS
-
Prework:
-
Install Bazelisk.
Follow the official Bazel documentation to install Bazelisk.
-
Checkout MediaPipe repository.
$ git clone --depth 1 https://github.com/google/mediapipe.git $ cd mediapipe -
Install OpenCV and FFmpeg.
Option 1. Use HomeBrew package manager tool to install the pre-compiled OpenCV 3 libraries. FFmpeg will be installed via OpenCV.
$ brew install opencv # There is a known issue caused by the glog dependency. Uninstall glog. $ brew uninstall --ignore-dependencies glogOption 2. Use MacPorts package manager tool to install the OpenCV libraries.
$ port install opencvnew_local_repository ( name = "macos_opencv" , build_file = "@//third_party:opencv_macos.BUILD" , path = "/opt" , ) new_local_repository ( name = "macos_ffmpeg" , build_file = "@//third_party:ffmpeg_macos.BUILD" , path = "/opt" , ) cc_library ( name = "opencv" , srcs = glob ( [ "local/lib/libopencv_core.dylib" , "local/lib/libopencv_highgui.dylib" , "local/lib/libopencv_imgcodecs.dylib" , "local/lib/libopencv_imgproc.dylib" , "local/lib/libopencv_video.dylib" , "local/lib/libopencv_videoio.dylib" , ] , ) , hdrs = glob ([ "local/include/opencv2/**/*.h*" ]) , includes = [ "local/include/" ] , linkstatic = 1 , visibility = [ "//visibility:public" ] , ) cc_library ( name = "libffmpeg" , srcs = glob ( [ "local/lib/libav*.dylib" , ] , ) , hdrs = glob ([ "local/include/libav*/*.h" ]) , includes = [ "local/include/" ] , linkopts = [ "-lavcodec" , "-lavformat" , "-lavutil" , ] , linkstatic = 1 , visibility = [ "//visibility:public" ] , ) -
Make sure that Python 3 and the Python "six" library are installed.
$ brew install python $ sudo ln -s -f /usr/local/bin/python3.7 /usr/local/bin/python $ python --version Python 3 .7.4 $ pip3 install --user six -
Run the Hello World! in C++ example .
$ export GLOG_logtostderr = 1 # Need bazel flag 'MEDIAPIPE_DISABLE_GPU=1' as desktop GPU is currently not supported $ bazel run --define MEDIAPIPE_DISABLE_GPU = 1 \ mediapipe/examples/desktop/hello_world:hello_world # Should print: # Hello World! # Hello World! # Hello World! # Hello World! # Hello World! # Hello World! # Hello World! # Hello World! # Hello World! # Hello World!
If you run into a build error, please read Troubleshooting to find the solutions of several common build issues.
Installing on Windows
Disclaimer: Running MediaPipe on Windows is experimental.
-
Install MSYS2 and edit the
%PATH%environment variable.If MSYS2 is installed to
C:\msys64, addC:\msys64\usr\binto your%PATH%environment variable. -
Install necessary packages.
C:\> pacman -S git patch unzip -
Install Python and allow the executable to edit the
%PATH%environment variable.Download Python Windows executable from https://www.python.org/downloads and install.
-
Install Visual C++ Build Tools and WinSDK
Go to the VisualStudio website , download build tools, and install Microsoft Visual C++ 2022 Redistributable and Microsoft Build Tools 2022.
Download the WinSDK from the official MicroSoft website and install.
-
Install Bazel or Bazelisk and add the location of the Bazel executable to the
%PATH%environment variable.Option 1. Follow the official Bazel documentation to install Bazel 6.5.0 or higher.
Option 2. Follow the official Bazel documentation to install Bazelisk.
-
Set Bazel variables. Learn more details about "Build on Windows" in the Bazel official documentation.
# Please find the exact paths and version numbers from your local version. C:\> set BAZEL_VS=C:\Program Files (x86)\Microsoft Visual Studio\<version>\BuildTools C:\> set BAZEL_VC=C:\Program Files (x86)\Microsoft Visual Studio\<version>\BuildTools\VC C:\> set BAZEL_VC_FULL_VERSION=<Your local VC version> C:\> set BAZEL_WINSDK_FULL_VERSION=<Your local WinSDK version> -
Checkout MediaPipe repository.
C:\Users\Username\mediapipe_repo> git clone --depth 1 https://github.com/google/mediapipe.git # Change directory into MediaPipe root directory C:\Users\Username\mediapipe_repo> cd mediapipe -
Install OpenCV.
Download the Windows executable from https://opencv.org/releases/ and install. MediaPipe 0.10.x supports OpenCV 3.4.10. Remember to edit the
WORKSPACEfile if OpenCV is not installed atC:\opencv.new_local_repository( name = "windows_opencv", build_file = "@//third_party:opencv_windows.BUILD", path = "C:\\<path to opencv>\\build", ) -
Run the Hello World! in C++ example .
C:\Users\Username\mediapipe_repo>bazel build -c opt --define MEDIAPIPE_DISABLE_GPU=1 --action_env PYTHON_BIN_PATH="C://python_36//python.exe" mediapipe/examples/desktop/hello_world C:\Users\Username\mediapipe_repo>set GLOG_logtostderr=1 C:\Users\Username\mediapipe_repo>bazel-bin\mediapipe\examples\desktop\hello_world\hello_world.exe # should print: # I20200514 20:43:12.277598 1200 hello_world.cc:56] Hello World! # I20200514 20:43:12.278597 1200 hello_world.cc:56] Hello World! # I20200514 20:43:12.279618 1200 hello_world.cc:56] Hello World! # I20200514 20:43:12.279618 1200 hello_world.cc:56] Hello World! # I20200514 20:43:12.279618 1200 hello_world.cc:56] Hello World! # I20200514 20:43:12.279618 1200 hello_world.cc:56] Hello World! # I20200514 20:43:12.279618 1200 hello_world.cc:56] Hello World! # I20200514 20:43:12.279618 1200 hello_world.cc:56] Hello World! # I20200514 20:43:12.279618 1200 hello_world.cc:56] Hello World! # I20200514 20:43:12.280613 1200 hello_world.cc:56] Hello World!
If you run into a build error, please read Troubleshooting to find the solutions of several common build issues.
Installing on Windows Subsystem for Linux (WSL)
-
Follow the instruction to install Windows Subsystem for Linux (Ubuntu).
-
Install Windows ADB and start the ADB server in Windows.
-
Launch WSL.
-
Install the needed packages.
username@DESKTOP-TMVLBJ1:~$ sudo apt-get update && sudo apt-get install -y build-essential git python zip adb openjdk-8-jdk -
Install Bazelisk.
Follow the official Bazel documentation to install Bazelisk.
-
Checkout MediaPipe repository.
username@DESKTOP-TMVLBJ1:~$ git clone --depth 1 https://github.com/google/mediapipe.git username@DESKTOP-TMVLBJ1:~$ cd mediapipe -
Install OpenCV and FFmpeg.
Option 1. Use package manager tool to install the pre-compiled OpenCV libraries. FFmpeg will be installed via libopencv-video-dev.
username@DESKTOP-TMVLBJ1:~/mediapipe$ sudo apt-get install libopencv-core-dev libopencv-highgui-dev \ libopencv-calib3d-dev libopencv-features2d-dev \ libopencv-imgproc-dev libopencv-video-devOption 2. Run
setup_opencv.shto automatically build OpenCV from source and modify MediaPipe's OpenCV config.Option 3. Follow OpenCV's documentation to manually build OpenCV from source code.
new_local_repository ( name = "linux_opencv" , build_file = "@//third_party:opencv_linux.BUILD" , path = "/usr/local" , ) cc_library ( name = "opencv" , srcs = glob ( [ "lib/libopencv_core.so" , "lib/libopencv_highgui.so" , "lib/libopencv_imgcodecs.so" , "lib/libopencv_imgproc.so" , "lib/libopencv_video.so" , "lib/libopencv_videoio.so" , ] , ) , hdrs = glob ([ "include/opencv4/**/*.h*" ]) , includes = [ "include/opencv4/" ] , linkstatic = 1 , visibility = [ "//visibility:public" ] , ) -
Run the Hello World! in C++ example .
username@DESKTOP-TMVLBJ1:~/mediapipe$ export GLOG_logtostderr = 1 # Need bazel flag 'MEDIAPIPE_DISABLE_GPU=1' as desktop GPU is currently not supported username@DESKTOP-TMVLBJ1:~/mediapipe$ bazel run --define MEDIAPIPE_DISABLE_GPU = 1 \ mediapipe/examples/desktop/hello_world:hello_world # Should print: # Hello World! # Hello World! # Hello World! # Hello World! # Hello World! # Hello World! # Hello World! # Hello World! # Hello World! # Hello World!
If you run into a build error, please read Troubleshooting to find the solutions of several common build issues.
Installing using Docker
This will use a Docker image that will isolate mediapipe's installation from the rest of the system.
-
Install Docker on your host system.
-
Build a docker image with tag "mediapipe".
$ git clone --depth 1 https://github.com/google/mediapipe.git $ cd mediapipe $ docker build --tag = mediapipe . # Should print: # Sending build context to Docker daemon 147.8MB # Step 1/9 : FROM ubuntu:latest # latest: Pulling from library/ubuntu # 6abc03819f3e: Pull complete # 05731e63f211: Pull complete # ........ # See http://bazel.build/docs/getting-started.html to start a new project! # Removing intermediate container 82901b5e79fa # ---> f5d5f402071b # Step 9/9 : COPY . /edge/mediapipe/ # ---> a95c212089c5 # Successfully built a95c212089c5 # Successfully tagged mediapipe:latest -
Run the Hello World! in C++ example .
$ docker run -it --name mediapipe mediapipe:latest root@bca08b91ff63:/mediapipe# GLOG_logtostderr = 1 bazel run --define MEDIAPIPE_DISABLE_GPU = 1 mediapipe/examples/desktop/hello_world # Should print: # Hello World! # Hello World! # Hello World! # Hello World! # Hello World! # Hello World! # Hello World! # Hello World! # Hello World! # Hello World!
If you run into a build error, please read Troubleshooting to find the solutions of several common build issues.
-
Build a MediaPipe Android example.
$ docker run -it --name mediapipe mediapipe:latest root@bca08b91ff63:/mediapipe# bash ./setup_android_sdk_and_ndk.sh # Should print: # Android NDK is now installed. Consider setting $ANDROID_NDK_HOME environment variable to be /root/Android/Sdk/ndk-bundle/android-ndk-r19c # Set android_ndk_repository and android_sdk_repository in WORKSPACE # Done root@bca08b91ff63:/mediapipe# bazel build -c opt --config = android_arm64 mediapipe/examples/android/src/java/com/google/mediapipe/apps/objectdetectiongpu:objectdetectiongpu # Should print: # Target //mediapipe/examples/android/src/java/com/google/mediapipe/apps/objectdetectiongpu:objectdetectiongpu up-to-date: # bazel-bin/mediapipe/examples/android/src/java/com/google/mediapipe/apps/objectdetectiongpu/objectdetectiongpu_deploy.jar # bazel-bin/mediapipe/examples/android/src/java/com/google/mediapipe/apps/objectdetectiongpu/objectdetectiongpu_unsigned.apk # bazel-bin/mediapipe/examples/android/src/java/com/google/mediapipe/apps/objectdetectiongpu/objectdetectiongpu.apk # INFO: Elapsed time: 144.462s, Critical Path: 79.47s # INFO: 1958 processes: 1 local, 1863 processwrapper-sandbox, 94 worker. # INFO: Build completed successfully, 2028 total actions
