# libwebrtc [![License][license-img]][license-href] This repository contains a collection of CMake scripts to help you embed Google's native WebRTC implementation inside your project as simple as this: ```cmake cmake_minimum_required(VERSION 3.3) project(sample) find_package(LibWebRTC REQUIRED) include(${LIBWEBRTC_USE_FILE}) set(SOURCE_FILES main.cpp) add_executable(sample ${SOURCE_FILES}) target_link_libraries(sample ${LIBWEBRTC_LIBRARIES}) ``` ## Prerequisites - CMake 3.3 or later - Python 2.7 (optional for Windows since it will use the interpreter located inside the `depot_tools` installation) ### Debian & Ubuntu - Required development packages: ``` # apt-get install build-essential libglib2.0-dev libgtk2.0-dev libxtst-dev \ libxss-dev libpci-dev libdbus-1-dev libgconf2-dev \ libgnome-keyring-dev libnss3-dev libasound2-dev libpulse-dev \ libudev-dev ``` - GCC & G++ 4.8 or later, for C++11 support ### macOS - OS X 10.11 or later - Xcode 7.3.1 or later ### Windows - Windows 7 x64 or later - Visual Studio 2015/2017 Make sure that you install the following components: - Visual C++, which will select three sub-categories including MFC - Universal Windows Apps Development Tools - Tools (1.4.1) and Windows 10 SDK (**10.0.14393**) - [Windows 10 SDK][w10sdk] with **Debugging Tools for Windows** or [Windows Driver Kit 10][wdk10] installed in the same Windows 10 SDK installation directory. ## Compiling Clone the repository, create an output directory, browse inside it, then run CMake to configure project. ``` git clone https://github.com/UltraCoderRU/libwebrtc-build.git cd libwebrtc-build mkdir build cd build # Linux: cmake -DCMAKE_BUILD_TYPE= -DCMAKE_INSTALL_PREFIX= .. # Windows cmake -G "Visual Studio 15 2017 Win64" -DCMAKE_INSTALL_PREFIX= .. ``` After configuration build library using standard CMake commands. ``` # Linux: cmake --build . sudo cmake --build . --target install # Windows: cmake --build . --config --target INSTALL ``` The library will be located inside the `lib` subdirectory of the ``. The `include` subdirectory will contain the header files. CMake scripts will be placed inside the `lib/cmake/LibWebRTC` subdirectory. ## Using WebRTC in your project To import LibWebRTC into your CMake project use `find_package`: ```cmake find_package(LibWebRTC REQUIRED) include(${LIBWEBRTC_USE_FILE}) target_link_libraries(my-app ${LIBWEBRTC_LIBRARIES}) ``` You should add library installation path to `CMAKE_INSTALL_PREFIX` variable while configuring your project: ``` cmake -DCMAKE_PREFIX_PATH= ... ``` ## Fetching a specific revision The latest working release will be fetched by default, unless you decide to retrieve a specific commit by setting it's hash into the **WEBRTC_REVISION** CMake variable, or another branch head ref into the **WEBRTC_BRANCH_HEAD** variable. ``` cmake -DWEBRTC_REVISION=be22d51 .. cmake -DWEBRTC_BRANCH_HEAD=refs/branch-heads/4103 .. ``` If both variables are set, it will focus on fetching the commit defined inside **WEBRTC_REVISION**. ## Configuration The library will be compiled and usable on the same host's platform and architecture. Here are some CMake flags which could be useful if you need to perform cross-compiling. - **BUILD_DEB_PACKAGE** Generate Debian package, defaults to OFF, available under Linux only. - **BUILD_RPM_PACKAGE** Generate Red Hat package, defaults to OFF, available under Linux only. - **BUILD_TESTS** Build WebRTC unit tests and mocked classes such as `FakeAudioCaptureModule`. - **BUILD_SAMPLE** Build an executable located inside the `sample` folder. - **DEPOT_TOOLS_PATH** Set this variable to your own `depot_tools` directory. This will prevent CMake from fetching the one matching with the desired WebRTC revision. - **GN_EXTRA_ARGS** Add extra arguments to the `gn gen --args` parameter. - **NINJA_ARGS** Arguments to pass while executing the `ninja` command. - **TARGET_OS** Target operating system, the value will be used inside the `--target_os` argument of the `gn gen` command. The value **must** be one of the following: - `android` - `chromeos` - `ios` - `linux` - `mac` - `nacl` - `win` - **TARGET_CPU** Target architecture, the value will be used inside the `--target_cpu` argument of the `gn gen` command. The value **must** be one of the following: - `x86` - `x64` - `arm` - `arm64` - `mipsel` - **WEBRTC_BRANCH_HEAD** Set the branch head ref to retrieve, it is set to the latest working one. This variable is ignored if **WEBRTC_REVISION** is set. - **WEBRTC_REVISION** Set a specific commit hash to check-out. ## Status The following table displays the current state of this project, including supported platforms and architectures.
x86 x64 arm arm64
Linux ✔ ✔ - -
macOS - ✔ - -
Windows ✔ ✔ - -
## Acknowledgements Many thanks to Dr. Alex Gouaillard for being an excellent mentor for this project. Everything started from his « [Automating libwebrtc build with CMake][webrtc-dr-alex-cmake] » blog article, which was a great source of inspiration for me to create the easiest way to link the WebRTC library in any native project. [license-img]:https://img.shields.io/badge/License-Apache%202.0-blue.svg [license-href]:https://opensource.org/licenses/Apache-2.0 [osx1011sdk]: https://github.com/phracker/MacOSX-SDKs/releases/download/MacOSX10.11.sdk/MacOSX10.11.sdk.tar.xz [w10sdk]:https://developer.microsoft.com/en-us/windows/downloads/windows-10-sdk [wdk10]:https://go.microsoft.com/fwlink/p/?LinkId=526733 [webrtc-dr-alex-cmake]:http://webrtcbydralex.com/index.php/2015/07/22/automating-libwebrtc-build-with-cmake [author]:https://axel.isouard.fr