Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/introlab/webrtc-native-build
Native build of Google's webrtc library.
https://github.com/introlab/webrtc-native-build
binary build introlab webrtc
Last synced: 3 months ago
JSON representation
Native build of Google's webrtc library.
- Host: GitHub
- URL: https://github.com/introlab/webrtc-native-build
- Owner: introlab
- License: apache-2.0
- Created: 2021-03-15T14:16:57.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-10T13:39:22.000Z (7 months ago)
- Last Synced: 2024-07-11T03:24:55.283Z (7 months ago)
- Topics: binary, build, introlab, webrtc
- Language: Dockerfile
- Homepage:
- Size: 199 KB
- Stars: 27
- Watchers: 4
- Forks: 11
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# webrtc-native-build
Native build of Google's webrtc library. The library is also packaged with BoringSSL and libyuv.
* [WebRTC](https://webrtc.org/) is a standard for real-time audio/video/data communication and is mostly used in web browsers.
* [BoringSSL](https://github.com/google/boringssl) is a fork of OpenSSL that is designed to meet Google's needs.
* [libyuv](https://chromium.googlesource.com/libyuv/libyuv/) is an open source project that includes YUV scaling and conversion functionalities.
## License
By default, libwebrtc is built with non-free codecs. To build without them, change the following flags in [generate_ninja_files.bash](3rdParty/webrtc_native/generate_ninja_files.bash) and [generate_ninja_files.bat](3rdParty/webrtc_native/generate_ninja_files.bat).
```bash
rtc_use_h264=false
proprietary_codecs=false
ffmpeg_branding="Chromium"
```
## Dependencies (Linux)
```bash
sudo apt-get install ninja-build cmake build-essential libssl-dev libboost-all-dev
sudo apt-get install libglib2.0-dev libgtk-3-dev libpulse-dev libasound2-dev
# For cross compiling
sudo apt-get install g++-aarch64-linux-gnu gcc-aarch64-linux-gnu
sudo apt-get install gcc-arm-linux-gnueabihf g++-arm-linux-gnueabihf
```
## Dependencies (Mac)
```bash
# XCode and homebrew must be installed first.
brew install ninja
```
## Building
```bash
# Create build directory
mkdir build
# Go to build directory
cd build
# Run CMake with arguments
cmake ../ [-DCMAKE_BUILD_TYPE=Release|Debug] [-DCMAKE_BUILD_ARCHITECTURE=arm32|arm64|amd64|win64|osx64]
# Parallel build
make -j
# will copy to dist directory
make install
```
## Building on Windows
Building on Windows is not supported yet for recent versions of WebRTC.
You can submit a PR to help with this if you wish.
If you want to build on Windows, you can use the tag `4389.e7d9f7.130`.
There is also a prebuilt version of the library available in the releases section on GitHub.
### Dependencies
* [Ninja](https://github.com/ninja-build/ninja/releases)
* Copy `ninja.exe` in `3rdParty/webrtc_native/`
* [CMake](https://cmake.org/download)
* [Git](https://git-scm.com/download/win)
* [Python](https://www.python.org/downloads)
* [MSVC 2022 Build Tools](https://visualstudio.microsoft.com/fr/downloads/)
* Windows SDK 10.0.20348.0 (make sure that it is checked while installing MSVC)
* Windows SDK Debugging Tools
1. Navigate to `Control Panel` -> `Programs` -> `Programs and Features`
2. Right-click on `Windows Software Development Kit`, and choose `Change`
3. Select `Change` and click `Next`
4. Check the box for `Debugging Tools for Windows` and click `Change`
Make sure to check `Add to PATH` for everything you install
### Setup
* Create a copy of your `/python.exe` executable as `/python3.exe`.
* Make sure that `python`, `python3`, `cmake` and `git` are in your path.
* Make sure the registry entry `HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem::LongPathsEnabled` is set to `0x1`
* Launch a `CMD` prompt as Administrator, and execute `git config --system core.longpaths true`
### Building
Using a CMD prompt (not tested with `powershell` or `git-bash` or any other shell)
```powershell
# Create build directory
mkdir build
# Go to build directory
cd build
# Run CMake with arguments
cmake .. -G "Ninja" [-DCMAKE_BUILD_TYPE=Release|Debug]
# Parallel build
ninja
# Copy to dist directory
ninja install
# Generate a zip archive in build/
ninja package
```
### Important notes
* You might have trouble building if your system is not in English
* You might have trouble building if the full path to `python.exe` has at least one space in it
### Consuming the library
On Windows, you will have to link any target that consumes this library to these additional Windows libraries:
* `secur32`
* `winmm`
* `dmoguids`
* `wmcodecdspuuid`
* `msdmo`
* `strmiids`
* `iphlpapi`
If you don't link against these libraries, your linker might see missing symbols like these ones:
* `__imp_timeGetTime`
* `__imp_timeKillEvent`
* `__imp_timeSetEvent`
* `__imp_timeBeginPeriod`
* `__imp_timeEndPeriod`
* `CLSID_CWMAudioAEC`
* `IID_IMediaObject`
* `IID_IMediaBuffer`
* `MoInitMediaType`
* `MoFreeMediaType`
* `InitializeSecurityContextA`
* `AcquireCredentialsHandleA`
* `__imp_FreeCredentialsHandle`
* `CompleteAuthToken`
* `__imp_DeleteSecurityContext`
## How to use a new version?
1. Fetch WebRTC Code
```bash
mkdir build
cd build
cmake .. -DCMAKE_BUILD_TYPE=Release
```
2. Find the new `branch-head-number`
1. Open Chrome
2. Open the following URL [chrome://settings/help](chrome://settings/help)
3. The new `branch-head-number` is the third number of the version (Version 120.0.6099.109 --> `branch-head-number` = 6099)
3. Find the commit hash
```bash
git checkout branch-heads/
git rev-parse HEAD
```
4. Update the version (see the next section)
1. Update the hash and version in the [CMakeList.txt file](3rdParty/webrtc_native/CMakeLists.txt#L1-L2)
2. Update the [VERSION file](VERSION)
## Versioning Scheme
`branch-head-number`.`first-6-digits-of-webrtc-commit-hash`.`patch-number`
To find the `patch-number` for a given `branch-head-number`, use the following web page:
`https://chromium.googlesource.com/chromium/src/+/branch-heads//chrome/VERSION`
## Dropped support
### MacOS 10.15 Catalina
GitHub Actions dropped support for MacOS 10.15 Catalina.
However, the latest tag might still work to build under MacOS 10.15.
There are also prebuilt versions of the library available in the releases section on GitHub, for tag version `5039.5df5b1.1` and earlier.
## Authors
* Marc-Antoine Maheux (@mamaheux)
* Dominic Létourneau (@doumdi)
* Philippe Warren (@philippewarren)
## License
* [Apache License, Version 2.0](LICENSE)
## Sponsor
[IntRoLab - Intelligent / Interactive / Integrated / Interdisciplinary Robot Lab](https://introlab.3it.usherbrooke.ca)