BUILDING.md

Building

This document is intended for mediasoup developers.

Makefile

The root folder of the project contains a Makefile to build the mediasoup worker subproject (under the worker/ folder).

make

The default task runs the Release task unless the environment MEDIASOUP_BUILDTYPE is set to Debug (if so it runs the Debug task).

make Release

Builds the production ready mediasoup worker binary at worker/out/Release/. This is the binary used in production when installing the mediasoup NPM module with npm install mediasoup.

make Debug

Builds a more verbose and non optimized mediasoup worker binary at worker/out/Debug/ with some C flags enabled (such as -O0) and some macros defined (such as DEBUG and MS_LOG_FILE_LINE).

Check the meaning of these macros in the Logger.hpp header file.

In order to instruct the mediasoup Node.js module to use the Debug mediasoup worker binary, an environment variable must be set before running the Node.js application:

$ MEDIASOUP_BUILDTYPE=Debug node myapp.js

make test

Runs the test-Release task unless the environment MEDIASOUP_BUILDTYPE is set to Debug (if so it runs the test-Debug task).

make test-Release

Builds the mediasoup-worker-test test unit binary at worker/out/Release/.

make test-Debug

Builds the mediasoup-worker-test test unit binary in Debug mode at worker/out/Debug/.

make xcode

Builds a Xcode project for the mediasoup worker subproject.

make clean

Cleans objects and binaries related to the mediasoup worker.

make clean-all

Cleans all the objects and binaries, including those generated for library dependencies (such as libuv, openssl and libsrtp).

gulpfile.js

mediasoup comes with a gulpfile.js file to enable gulp tasks.

In order to tun these tasks, gulp-cli (version >= 1.2.2) must be globally installed:

$ npm install -g gulp-cli

gulp

The default task runs the gulp:lint and gulp:test tasks.

gulp rtpcapabilities

Reads mediasoup supported RTP capabilities and inserts them into the worker C++ code. After that, make Release and/or make Debug must be called.

gulp lint

Runs both the lint:node and lint:worker gulp tasks.

gulp lint:node

Validates the Node.js JavaScript code/syntax.

gulp lint:worker

Validates the worker C++ code/syntax using clang-format following worker/.clang-format rules.

gulp format

Runs the format:worker gulp task.

gulp format:worker

Rewrites worker source and include files using clang-format.

gulp tidy

Runs the tidy:worker gulp task.

gulp tidy:worker

Performs C++ code check using clang-tidy following following worker/.clang-tidy rules.

NOTE: It just works on Linux and OSX.

gulp test

Runs both the test:node and test:worker gulp tasks.

gulp test:node

Runs the Node.js test units. Before it, it invokes the make command.

In order to run the JavaScript test units with the mediasoup worker in Debug mode the MEDIASOUP_BUILDTYPE environment variable must be set to Debug:

$ MEDIASOUP_BUILDTYPE=Debug gulp test:node

gulp test:worker

Runs the mediasoup worker test units. Before it, it invokes the make test command.

In order to run the worker test units with the mediasoup worker in Debug mode the MEDIASOUP_BUILDTYPE environment variable must be set to Debug:

$ MEDIASOUP_BUILDTYPE=Debug gulp test:worker