GStreamer bindings for Rust
Find a file
2019-06-18 13:07:04 +03:00
docs Update documentation 2019-02-22 12:13:27 +02:00
examples Use TryFrom/TryInto traits where it makes sense instead of our previous ad-hoc solutions 2019-06-03 18:42:34 +03:00
gir@e586ff8cc0 Add gir submodule 2019-06-18 13:07:04 +03:00
gir-files ges: Update bindings to 1.16.0 2019-05-16 01:54:10 +03:00
gstreamer gstreamer/serde: Fix compilation with serde feature enabled 2019-06-06 09:25:19 +03:00
gstreamer-app Explicitly add dyn keyword to trait objects 2019-06-06 09:09:34 +03:00
gstreamer-audio audio: Cast fewer points to *mut pointers in pack/unpack func bindings 2019-05-28 04:59:27 +02:00
gstreamer-base base: add bindings for GstBaseParse 2019-06-01 13:04:12 +05:30
gstreamer-check check: Fix compilation with v1_16 feature enabled 2019-05-28 04:46:41 +02:00
gstreamer-editing-services Explicitly add dyn keyword to trait objects 2019-06-06 09:09:34 +03:00
gstreamer-gl Remove unused extern crates 2019-05-17 09:34:46 +00:00
gstreamer-net Remove various Into<Option<_>> trait bounds from functions 2019-05-24 10:04:16 +00:00
gstreamer-pbutils Explicitly add dyn keyword to trait objects 2019-06-06 09:09:34 +03:00
gstreamer-player Remove various Into<Option<_>> trait bounds from functions 2019-05-24 10:04:16 +00:00
gstreamer-rtsp Regenerate everything for 1.16.0 2019-04-23 19:15:53 +03:00
gstreamer-rtsp-server Explicitly add dyn keyword to trait objects 2019-06-06 09:09:34 +03:00
gstreamer-sdp Remove various Into<Option<_>> trait bounds from functions 2019-05-24 10:04:16 +00:00
gstreamer-video video: turn VIDEO_MAX_PLANES to an usize 2019-06-18 13:30:59 +05:30
gstreamer-webrtc Add missing license files 2019-05-13 10:10:51 +02:00
tutorials Update byte-slice-cast to 0.3 2019-05-24 13:26:49 +02:00
.gitignore gitignore: Ignore any target folder, not just in the root 2019-05-16 16:55:02 +02:00
.gitlab-ci.yml ci: bump minimum Rust version to 1.34 2019-06-01 11:57:15 +05:30
.gitmodules Add gir submodule 2019-06-18 13:07:04 +03:00
Cargo.toml Add GstGL bindings 2018-12-05 23:03:49 +01:00
Gir_Gst.toml gstreamer: plugin_feature: use Rank enum 2019-06-04 12:56:18 +03:00
Gir_GstApp.toml appsink: Properly mark appsink callbacks as Send-only 2019-04-24 15:44:55 +03:00
Gir_GstAudio.toml Regenerate everything with new version of gir 2018-12-08 14:58:14 +02:00
Gir_GstBase.toml base: add bindings for GstBaseParse 2019-06-01 13:04:12 +05:30
Gir_GstCheck.toml Regenerate everything with latest gir 2019-01-21 22:00:48 +02:00
Gir_GstEditingServices.toml ges: update functions returning bool to Result<(), BoolError> 2019-02-07 11:03:01 +01:00
Gir_GstGL.toml Update manual code and configuration for 1.16 2019-04-23 19:15:53 +03:00
Gir_GstNet.toml Regenerate everything with latest gir 2019-01-21 22:00:48 +02:00
Gir_GstPbutils.toml Update manual code and configuration for 1.16 2019-04-23 19:15:53 +03:00
Gir_GstPlayer.toml Update manual code and configuration for 1.16 2019-04-23 19:15:53 +03:00
Gir_GstRtsp.toml Regenerate everything with new version of gir 2018-12-08 14:58:14 +02:00
Gir_GstRtspServer.toml rtsp-server: Generate the various filter functions 2019-02-22 11:55:16 +02:00
Gir_GstSdp.toml sdp: Remove MIKEY API for now 2019-02-28 20:35:45 +02:00
Gir_GstVideo.toml video: Add pack/unpack func bindings 2019-05-28 09:26:44 +02:00
Gir_GstWebRTC.toml Regenerate everything with latest gir 2019-01-21 22:00:48 +02:00
LICENSE-APACHE Add README.md 2017-08-01 19:27:56 +03:00
LICENSE-MIT Add README.md 2017-08-01 19:27:56 +03:00
README.md Remove some historical cruft from the README.md 2018-12-13 19:46:57 +02:00

NOTE: The canonical repository for gstreamer-rs has moved to freedesktop.org GitLab!

gstreamer-rs crates.io pipeline 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 and GStreamer plugins.

The bindings are mostly autogenerated with gir based on the GObject-Introspection API metadata provided by the GStreamer project.

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 \
      gst-editing-services --with-orc --with-libogg --with-opus \
      --with-pango --with-theora --with-libvorbis --with-libvpx \
      --enable-gtk3

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.

Various GStreamer plugins written in Rust can be found in the gst-plugins-rs repository.

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.