Skip to content

Latest commit

 

History

History
160 lines (118 loc) · 5 KB

README.md

File metadata and controls

160 lines (118 loc) · 5 KB
Raw

Native Plugin

This guide will cover building and deploying the native plugin com.unity.webrtc depends on.

Developing environment

Install dependencies to make development environment.

How to install dependencies (Windows)

On windows, chocolatey is used to install.

# Install CUDA
choco install cuda --version=10.1

# Install Windows SDK
choco install -y vcredist2010 vcredist2013 vcredist140 windows-sdk-10-version-1809-all

# Install Vulkan
choco install -y wget
wget https://vulkan.lunarg.com/sdk/download/1.1.121.2/windows/VulkanSDK-1.1.121.2-Installer.exe -O C:/Windows/Temp/VulkanSDK.exe
C:/Windows/Temp/VulkanSDK.exe /S

# Install CMake 3.18.0
choco install cmake -y --version 3.18.0

# Setting up environment variables
setx CUDA_PATH "C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v10.1" /m
setx VULKAN_SDK "C:\VulkanSDK\1.1.121.2" /m

#install googletest
cd %SOLUTION_DIR%
git clone https://github.com/google/googletest.git
cd googletest
git checkout 2fe3bd994b3189899d93f1d5a881e725e046fdc2
cmake . -G "Visual Studio 15 2017" -A x64 -B "build64" -DCMAKE_CXX_FLAGS_DEBUG="/MTd /Zi -D_ITERATOR_DEBUG_LEVEL=0"
cmake --build build64 --config Release
cmake --build build64 --config Debug
mkdir include\gtest
xcopy /e googletest\include\gtest include\gtest
mkdir include\gmock
xcopy /e googlemock\include\gmock include\gmock
mkdir lib
xcopy /e build64\googlemock\Release lib
xcopy /e build64\googlemock\Debug lib
xcopy /e build64\googlemock\gtest\Release lib
xcopy /e build64\googlemock\gtest\Debug lib

How to install dependencies (Ubuntu18.04)

The below commands shows the build process developing environment on Ubuntu 18.04.

# Install libc++-dev libc++abi-dev clang vulkan-utils libvulkan1 libvulkan-dev
sudo apt-get install -y libc++-dev libc++abi-dev clang vulkan-utils libvulkan1 libvulkan-dev

# Install libc++, libc++abi googletest clang glut
sudo apt update
sudo apt install -y 6googletest clang freeglut3-dev

# Install CUDA SDK
sudo apt-key adv --fetch-keys http://developer.download.nvidia.com/compute/cuda/repos/ubuntu1804/x86_64/7fa2af80.pub
wget http://developer.download.nvidia.com/compute/cuda/repos/ubuntu1804/x86_64/cuda-repo-ubuntu1804_10.1.243-1_amd64.deb
sudo dpkg -i cuda-repo-ubuntu1804_10.1.243-1_amd64.deb
sudo apt update
sudo apt install -y cuda

# Install CMake 3.18.0
sudo apt install -y libssl-dev
sudo apt purge -y cmake
wget https://github.com/Kitware/CMake/releases/download/v3.18.0/cmake-3.18.0.tar.gz
tar xvf cmake-3.18.0.tar.gz
cd cmake-3.18.0
./bootstrap && make && sudo make install

# Install googletest
cd /usr/src/googletest
sudo cmake -Dcxx_no_rtti=ON \
           -DCMAKE_C_COMPILER="clang" \
           -DCMAKE_CXX_COMPILER="clang++" \
           -DCMAKE_CXX_FLAGS="-stdlib=libc++" \
           CMakeLists.txt
sudo make
sudo cp googlemock/*.a "/usr/lib"
sudo cp googlemock/gtest/*.a "/usr/lib"

How to install dependencies (MacOS)

On MacOS, homebrew is used to install.

# Install CMake
brew install cmake

# Install googletest
git clone https://github.com/google/googletest.git
cd googletest
git checkout 2fe3bd994b3189899d93f1d5a881e725e046fdc2
cmake .
make
sudo make install

Embedding libwebrtc

The plugin relies on libwebrtc, so building it requires a static libwebrtc link. webrtc-win.zip can be found on the Github Release page. If you want to build the library yourself, build script can be found below BuildScript~ folder.

Download the zip on Github Release page. Extract the files from the zip, and place them in the Plugin~ folder.

Project Settings

To build plugin, you need to execute CMake command in the Plugin~ folder.

On Windows

cmake . -G "Visual Studio 15 2017" -A x64 -B "build64"
cmake --build build64 --config Release

or 

cmake . -G "Visual Studio 16 2019" -A x64 -B "build64"
cmake --build build64 --config Release

On MacOS

cmake -GXcode .
xcodebuild -scheme webrtc -configuration Release build

On Linux

cmake -DCMAKE_C_COMPILER="clang" \
      -DCMAKE_CXX_COMPILER="clang++" \
      .
make

Debug

The WebRTC project properties must be adjusted to match your environment in order to build the plugin.

Set the Unity.exe path under Command and the project path under Command Arguments. Once set, during debugging the Unity Editor will run and breakpoints will be enabled.

Deploying the Plugin

When you run the build, webrtc.dll will be placed in Packages\com.unity.webrtc\Runtime\Plugins\x86_64. You should then be able to verify the following settings in the Unity Inspector window.