https://github.com/servo/media
https://github.com/servo/media
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/servo/media
- Owner: servo
- License: mpl-2.0
- Created: 2018-03-16T09:29:29.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2026-02-03T23:34:00.000Z (5 months ago)
- Last Synced: 2026-02-04T11:49:58.719Z (5 months ago)
- Language: Rust
- Size: 6.45 MB
- Stars: 90
- Watchers: 19
- Forks: 64
- Open Issues: 59
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Servo Media
[](https://github.com/servo/media/actions)
The `servo-media` crate contains the backend implementation to support all [Servo](https://github.com/servo/servo) multimedia related functionality. This is:
- the [HTMLMediaElement](https://html.spec.whatwg.org/multipage/media.html#htmlmediaelement) and the `` and `` elements.
- the [WebAudio API](https://webaudio.github.io/web-audio-api).
- the [WebRTC API](https://w3c.github.io/webrtc-pc/).
- the [Media Capture and Streams APIs](https://w3c.github.io/mediacapture-main/#dom-mediadeviceinfo-groupid).
`servo-media` is supposed to run properly on Linux, macOS, Windows and Android. Check the [build](https://github.com/servo/media/tree/f96c33b7374d5b9915b8bae8623723b2d23ec457#build) instructions for each specific platform.
`servo-media` is built modularly from different crates and it provides an abstraction that allows the implementation of multiple media backends. For now, the only functional backend is [GStreamer](https://github.com/servo/media/tree/f96c33b7374d5b9915b8bae8623723b2d23ec457/backends/gstreamer). New backend implementations are required to implement the [Backend](https://github.com/servo/media/blob/2610789d1abfbe4443579021113c822ba05f34dc/servo-media/lib.rs#L33) trait. This trait is the public API that `servo-media` exposes to clients through the [ServoMedia](https://github.com/servo/media/blob/2610789d1abfbe4443579021113c822ba05f34dc/servo-media/lib.rs#L90) entry point. Check the [examples](https://github.com/servo/media/tree/f96c33b7374d5b9915b8bae8623723b2d23ec457/examples) folder to get a sense of how to use it effectively. Alternatively, you can also check how `servo-media` is integrated and used in [Servo](https://github.com/servo/servo).
## Requirements
So far the only supported and default backend is
[GStreamer](https://gstreamer.freedesktop.org/).
So in order to build this crate you need to install all
[gstreamer-rs](https://github.com/sdroege/gstreamer-rs) dependencies for your
specific platform as listed
[here](https://github.com/sdroege/gstreamer-rs#installation).
### Ubuntu Trusty
Ubuntu Trusty has very old GStreamer packages (1.2, while we need at least 1.16), so you need to [manually build GStreamer >1.16](https://github.com/servo/servo/wiki/How-to-generate-GStreamer-binaries-for-CI) or alternatively run the `etc/ubuntu_trusty_bootstrap.sh` shell script, which downloads a pre-built bundle and sets up the required environment variables:
```ssh
source etc/ubuntu_trusty_bootstrap.sh
```
### Android
For Android there are some extra requirements.
First of all, you need to install the appropriate toolchain for your target.
The recommended approach is to install it through
[rustup](https://rustup.rs/). Taking `arm-linux-androideabi` as our example
target you need to do:
```bash
rustup target add arm-linux-androideabi
```
In addition to that, you also need to install the Android
[NDK](https://developer.android.com/ndk/guides/).
The recommended NDK version is
[r16b](https://developer.android.com/ndk/downloads/older_releases). The
Android [SDK](https://developer.android.com/studio/) is not mandatory
but recommended for practical development.
Once you have the Android NDK installed in your machine, you need to create
what the NDK itself calls a
[standalone toolchain](https://developer.android.com/ndk/guides/standalone_toolchain).
```bash
$ ${ANDROID_NDK}/build/tools/make-standalone-toolchain.sh \
--platform=android-18 --toolchain=arm-linux-androideabi-4.9 \
--install-dir=android-18-arm-toolchain --arch=arm
```
After that you need to tell Cargo where to find the Android linker and ar,
which is in the standalone NDK toolchain we just created. To do that we
configure the `arm-linux-androideabi` target in `.cargo/config` (or in
`~/.cargo/config` if you want to apply the setting globaly) with the `linker`
value.
```toml
[target.arm-linux-androideabi]
linker = "/android-18-toolchain/bin/arm-linux-androideabi-gcc"
ar = "/android-18-toolchain/bin/arm-linux-androideabi-ar"
```
This crate indirectly depends on
[libgstreamer_android_gen](https://github.com/servo/libgstreamer_android_gen):
a tool to generate the required `libgstreamer_android.so` library with all
GStreamer dependencies for Android and some Java code required to initialize
GStreamer on Android.
The final step requires fetching or generating this dependency and setting the pkg-config to use
`libgstreamer_android.so`. To do that, there's a [helper script](etc/android_bootstrap.sh)
that will fetch the latest version of this dependency generated for
Servo. To run the script do:
```
cd etc
./android_bootstrap.sh
```
where `target` can be `armeabi-v7` or `x86`.
After running the script, you will need to add the path to the `pkg-config`
info for all GStreamer dependencies to your `PKG_CONFIG_PATH` environment variable
The script will output the path and a command suggestion. For example:
```
export PKG_CONFIG_PATH=/Users/ferjm/dev/mozilla/media/etc/../gstreamer/armeabi-v7a/gst-build-armeabi-v7a/pkgconfig
```
If you want to generate your own `libgstreamer_android.so`
bundle, check the documentation from that repo and tweak the
[helper script](https://github.com/servo/media/blob/a9c73680eef72d48f975df55fe9451020e350fad/etc/android_bootstrap.sh#L24) accordingly.
## Build
For macOS, Windows, and Linux, simply run:
```bash
cargo build
```
For Android, run:
```bash
PKG_CONFIG_ALLOW_CROSS=1 cargo build --target=arm-linux-androideabi
```
## Running the examples
### Android
Make sure that you have [adb](https://developer.android.com/studio/command-line/adb)
installed and you have adb access to your
Android device. Go to the `examples/android` folder and run:
```ssh
source build.sh
./run.sh
```