Rust
Clone or download
Permalink
Failed to load latest commit information.
docs Update webrtc/sdp docs Apr 5, 2018
examples Fix compilation of iterator example Aug 13, 2018
gir-files Update gir-files from gstreamer-sys Jun 5, 2018
gstreamer-app Regenerate with latest GIR and update for the glib::Quark changes Jul 30, 2018
gstreamer-audio Regenerate with latest GIR and update for the glib::Quark changes Jul 30, 2018
gstreamer-base Add getter for the aggregator pad segment Aug 1, 2018
gstreamer-net Regenerate with latest GIR and update for the glib::Quark changes Jul 30, 2018
gstreamer-pbutils Regenerate with latest GIR and update for the glib::Quark changes Jul 30, 2018
gstreamer-player Regenerate with latest GIR and update for the glib::Quark changes Jul 30, 2018
gstreamer-rtsp-server Regenerate with latest GIR and update for the glib::Quark changes Jul 30, 2018
gstreamer-rtsp Regenerate with latest GIR and update for the glib::Quark changes Jul 30, 2018
gstreamer-sdp Regenerate with latest GIR and update for the glib::Quark changes Jul 30, 2018
gstreamer-video Regenerate with latest GIR and update for the glib::Quark changes Jul 30, 2018
gstreamer-webrtc Regenerate with latest GIR and update for the glib::Quark changes Jul 30, 2018
gstreamer Remove std::iter::Iterator impl from gst::Iterator Aug 13, 2018
tutorials Run everything through latest rustfmt Jul 27, 2018
.gitignore Remove Cargo.lock Sep 1, 2017
.travis.yml Update .travis.yml for the new 1.14 paths Mar 20, 2018
Cargo.toml WebRTC/SDP WIP Apr 5, 2018
Gir_Gst.toml Toc: serde impl Jul 30, 2018
Gir_GstApp.toml Regenerate everything with latest GIR Apr 23, 2018
Gir_GstAudio.toml Regenerate everything with latest GIR Apr 23, 2018
Gir_GstBase.toml Aggregator is only available from gstreamer-base since 1.14 Jul 30, 2018
Gir_GstNet.toml Further work-arounds for floating reference handling changes between … May 9, 2018
Gir_GstPbutils.toml Regenerate everything with latest GIR Apr 23, 2018
Gir_GstPlayer.toml Regenerate everything with latest GIR Apr 23, 2018
Gir_GstRtsp.toml Regenerate everything with latest GIR Apr 23, 2018
Gir_GstRtspServer.toml Regenerate everything with latest GIR Apr 23, 2018
Gir_GstSdp.toml Regenerate everything with latest GIR Apr 23, 2018
Gir_GstVideo.toml Regenerate everything with latest GIR Apr 23, 2018
Gir_GstWebRTC.toml Add various other WebRTC related enums/flags types to the bindings Jun 4, 2018
LICENSE-APACHE Add README.md Aug 1, 2017
LICENSE-MIT Add README.md Aug 1, 2017
README.md Update homebrew instructions to install optional plugins Mar 21, 2018

README.md

gstreamer-rs crates.io Build Status

GStreamer bindings for Rust. Documentation can be found here.

These bindings are providing a safe API that can be used to interface with GStreamer, e.g. for writing GStreamer-based applications.

For background and motivation, see the announcement blogpost.

The bindings (since 0.8.0) are autogenerated with gir based on the GObject-Introspection API metadata provided by the GStreamer project. Older versions before 0.8.0 were manually written and the repository can be found here. The API of the two is incompatible.

A crate for writing GStreamer plugins in Rust can be found here: https://github.com/sdroege/gst-plugin-rs

Table of Contents

  1. Installation
    1. Linux/BSDs
    2. macOS
    3. Windows
  2. Getting Started
  3. License
  4. Contribution

Installation

To build the GStreamer bindings or anything depending on them, you need to have at least GStreamer 1.8 and gst-plugins-base 1.8 installed. In addition, some of the examples/tutorials require various GStreamer plugins to be available, which can be found in gst-plugins-base, gst-plugins-good, gst-plugins-bad, gst-plugins-ugly and/or gst-libav.

Linux/BSDs

You need to install the above mentioned packages with your distributions package manager, or build them from source.

On Debian/Ubuntu they can be installed with

$ apt-get install libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev \
      gstreamer1.0-plugins-base gstreamer1.0-plugins-good \
      gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly \
      gstreamer1.0-libav libgstrtspserver-1.0-dev

The minimum required version of the above libraries is >= 1.8. If you build the gstreamer-player sub-crate, or any of the examples that depend on gstreamer-player, you must ensure that in addition to the above packages, libgstreamer-plugins-bad1.0-dev is installed and that the version is >= 1.12. See the Cargo.toml files for the full details,

# Only if you wish to install gstreamer-player, make sure the version
# of this package is >= 1.12.
$ apt-get install libgstreamer-plugins-bad1.0-dev

Package names on other distributions should be similar. Please submit a pull request with instructions for yours.

macOS

You can install GStreamer and the plugins via Homebrew or by installing the binaries provided by the GStreamer project.

Homebrew

Homebrew only installs various plugins if explicitly enabled, so some extra --with-* flags may be required.

$ brew install gstreamer gst-plugins-base gst-plugins-good \
      gst-plugins-bad gst-plugins-ugly gst-libav gst-rtsp-server \
      --with-orc -with-libogg --with-opus --with-pango --with-theora \
      --with-libvorbis

If you wish to install the gstreamer-player sub-crate, make sure the version of these libraries is >= 1.12. Otherwise, a version >= 1.8 is sufficient.

GStreamer Binaries

You need to download the two .pkg files from the GStreamer website and install them, e.g. gstreamer-1.0-1.12.3-x86_64.pkg and gstreamer-1.0-devel-1.12.3-x86_64.pkg.

After installation, you also need to install pkg-config (e.g. via Homebrew) and set the PKG_CONFIG_PATH environment variable

$ export PKG_CONFIG_PATH="/Library/Frameworks/GStreamer.framework/Versions/Current/lib/pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}"

Windows

You can install GStreamer and the plugins via MSYS2 with pacman or by installing the binaries provided by the GStreamer project.

MSYS2 / pacman

$ pacman -S pkg-config mingw-w64-x86_64-gstreamer mingw-w64-x86_64-gst-plugins-base \
      mingw-w64-x86_64-gst-plugins-good mingw-w64-x86_64-gst-plugins-bad \
      mingw-w64-x86_64-gst-plugins-ugly mingw-w64-x86_64-gst-libav \
      mingw-w64-x86_64-gst-rtsp-server

If you wish to install the gstreamer-player sub-crate, make sure the version of these libraries is >= 1.12. Otherwise, a version >= 1.8 is sufficient.

GStreamer Binaries

You need to download the two .msi files for your platform from the GStreamer website and install them, e.g. gstreamer-1.0-x86_64-1.12.3.msi and gstreamer-1.0-devel-x86_64-1.12.3.msi.

After installation, you also need to install pkg-config (e.g. via MSYS2 or from here) and set the PKG_CONFIG_PATH environment variable

$ export PKG_CONFIG_PATH="c:\\gstreamer\\1.0\\x86_64\\lib\\pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}"

Getting Started

The API reference can be found here, however it is only the Rust API reference and does not explain any of the concepts.

For getting started with GStreamer development, the best would be to follow the documentation on the GStreamer website, especially the Application Development Manual. While being C-centric, it explains all the fundamental concepts of GStreamer and the code examples should be relatively easily translatable to Rust. The API is basically the same, function/struct names are the same and everything is only more convenient (hopefully) and safer.

In addition there are tutorials on the GStreamer website. Many of them were ported to Rust already and the code can be found in the tutorials directory.

Some further examples for various aspects of GStreamer and how to use it from Rust can be found in the examples directory.

LICENSE

gstreamer-rs and all crates contained in here are licensed under either of

at your option.

GStreamer itself is licensed under the Lesser General Public License version 2.1 or (at your option) any later version: https://www.gnu.org/licenses/lgpl-2.1.html

Contribution

Any kinds of contributions are welcome as a pull request.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in gstreamer-rs by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.