libwebrtc

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_minimum_required(VERSION 3.0)
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})

Status

The following table displays the current state of this project, including supported platforms and architectures.

Linux			macOS		Windows		iOS	Android
x86	x64	arm	x86	x64	x86	x64	arm	arm	arm64	x86	x64
✔	✔			✔	✔	✔

Prerequisites

CMake 3.5 or later,
Python 2.7 (optional for Windows since it will use the interpreter located inside the depot_tools installation)

Debian & Ubuntu

Install the 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

macOS

OS X 10.11 or later,
Xcode 7.3.1 or later

Windows

Windows 7 x64 or later,
Visual Studio 2015 with updates - Download the Installer

Make sure that you install the following components:
- Visual C++, which will select three sub-categories including MFC
- Universal Windows Apps Development Tools > Tools
- Universal Windows Apps Development Tools > Windows 10 SDK (10.0.10586)

Compiling

Clone the repository, initialize the submodules if depot_tools is not installed on your system or not defined inside your PATH environment variable. Create an output directory and browse inside it.

$ git clone https://github.com/aisouard/libwebrtc.git
$ cd libwebrtc
$ git submodule init
$ git submodule update
$ mkdir out
$ cd out

Windows users will have to open the libwebrtc.sln located inside the current directory output directory and build the ALL_BUILD project.

Unix users will just have to run $ cmake .. to generate the Makefiles, then run the following commands.

$ make
$ make package
# make install

The library will be located inside the lib folder of the current output directory. The include folder will contain the header files. CMake scripts will be placed inside the lib/cmake/LibWebRTC directory.

Using WebRTC in your project

At the time of writing this README file, there's no proper way to detect any installation of the WebRTC library and header files. In the meantime, this CMake script generates and declares a LibWebRTC package that will be very easy to use for your projects.

All you have to do is include the package, then embed the "use file" that will automatically find the required libraries, define the proper compiling flags and include directories.

find_package(LibWebRTC REQUIRED)
include(${LIBWEBRTC_USE_FILE})

target_link_libraries(my-app ${LIBWEBRTC_LIBRARIES})

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_TESTS

Build WebRTC tests. (not supported yet)
NINJA_ARGS

Arguments to pass while executing the ninja command. For instance, you can define the number of cores you would like to use, in order to speed-up the build process:

cmake -DNINJA_ARGS="-j 4" ..
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

Contributing

Feel free to open an issue if you wish a bug to be fixed, to discuss a new feature or to ask a question. I'm open to pull requests, as long as your modifications are working on the three major OS (Windows, macOS and Linux).

Don't forget to put your name and e-mail address inside the AUTHORS file! You can also reach me on Twitter for further discussion.

6.2 KiB Raw Blame History