GStreamer bindings for Rust
Find a file
Sebastian Dröge 45402b5e95 Add specific version configurations for various enum/flags values
gobject-introspection does not support this yet so we have to do that
manually.

Fixes https://gitlab.freedesktop.org/gstreamer/gstreamer-rs/-/issues/271
2020-06-30 11:23:37 +03:00
ci ci: check commit using ci-fairy 2020-06-11 13:57:23 +00:00
docs Convert documentation into a proper crate 2020-06-19 13:09:39 +03:00
examples gstreamer: Simplify MiniObject bindings by removing one layer of abstraction 2020-06-30 11:06:02 +03:00
gir@5a5b8f5f33 Update gir 2020-06-19 12:31:24 +03:00
gir-files update gir-files 2020-06-03 12:50:03 +02:00
gstreamer Add specific version configurations for various enum/flags values 2020-06-30 11:23:37 +03:00
gstreamer-app Add specific version configurations for various enum/flags values 2020-06-30 11:23:37 +03:00
gstreamer-audio Add specific version configurations for various enum/flags values 2020-06-30 11:23:37 +03:00
gstreamer-base Add specific version configurations for various enum/flags values 2020-06-30 11:23:37 +03:00
gstreamer-check Add specific version configurations for various enum/flags values 2020-06-30 11:23:37 +03:00
gstreamer-editing-services Add specific version configurations for various enum/flags values 2020-06-30 11:23:37 +03:00
gstreamer-gl Add specific version configurations for various enum/flags values 2020-06-30 11:23:37 +03:00
gstreamer-net Add specific version configurations for various enum/flags values 2020-06-30 11:23:37 +03:00
gstreamer-pbutils Add specific version configurations for various enum/flags values 2020-06-30 11:23:37 +03:00
gstreamer-player Add specific version configurations for various enum/flags values 2020-06-30 11:23:37 +03:00
gstreamer-rtp Add specific version configurations for various enum/flags values 2020-06-30 11:23:37 +03:00
gstreamer-rtsp Add specific version configurations for various enum/flags values 2020-06-30 11:23:37 +03:00
gstreamer-rtsp-server Add specific version configurations for various enum/flags values 2020-06-30 11:23:37 +03:00
gstreamer-sdp Add specific version configurations for various enum/flags values 2020-06-30 11:23:37 +03:00
gstreamer-video Add specific version configurations for various enum/flags values 2020-06-30 11:23:37 +03:00
gstreamer-webrtc Add specific version configurations for various enum/flags values 2020-06-30 11:23:37 +03:00
tutorials Name functions returning a builder builder(), not new() 2020-06-25 19:42:33 +03:00
.gitignore gitignore: Ignore any target folder, not just in the root 2019-05-16 16:55:02 +02:00
.gitlab-ci.yml ci: check commit using ci-fairy 2020-06-11 13:57:23 +00:00
.gitmodules Add gir submodule 2019-06-18 13:07:04 +03:00
Cargo.toml Convert documentation into a proper crate 2020-06-19 13:09:39 +03:00
deny.toml deny: Allow LGPL-2.0 license for the optional gstreamer-rs-lgpl-docs crate dependency 2020-06-21 18:13:19 +03:00
DEVELOPMENT.md Add DEVELOPMENT.md 2020-05-03 19:37:13 +03:00
generator.py Fix generator 2019-11-11 11:34:09 +01:00
Gir_Gst.toml Add specific version configurations for various enum/flags values 2020-06-30 11:23:37 +03:00
Gir_GstApp.toml Use Results instead of Options where they signal an error instead of just a missing value 2019-12-17 22:21:28 +02:00
Gir_GstAudio.toml Add specific version configurations for various enum/flags values 2020-06-30 11:23:37 +03:00
Gir_GstBase.toml Update symbol versions in the configuration that are missing from the .gir 2020-06-19 13:09:11 +03:00
Gir_GstCheck.toml Regenerate everything with latest gir 2019-01-21 22:00:48 +02:00
Gir_GstEditingServices.toml Update symbol versions in the configuration that are missing from the .gir 2020-06-19 13:09:11 +03:00
Gir_GstGL.toml Add specific version configurations for various enum/flags values 2020-06-30 11:23:37 +03:00
Gir_GstNet.toml Regenerate everything with latest gir 2019-01-21 22:00:48 +02:00
Gir_GstPbutils.toml gstreamer: Allow calling various global functions before gst::init() 2020-06-01 07:27:51 +00:00
Gir_GstPlayer.toml Update manual code and configuration for 1.16 2019-04-23 19:15:53 +03:00
Gir_GstRtp.toml Generate initial bindings for gstreamer-rtp 2019-08-14 18:01:00 +00:00
Gir_GstRtsp.toml Update symbol versions in the configuration that are missing from the .gir 2020-06-19 13:09:11 +03:00
Gir_GstRtspServer.toml gstreamer*: Add missing manual traits 2020-04-11 21:56:45 +00:00
Gir_GstSdp.toml sdp: Remove MIKEY API for now 2019-02-28 20:35:45 +02:00
Gir_GstVideo.toml Add specific version configurations for various enum/flags values 2020-06-30 11:23:37 +03:00
Gir_GstWebRTC.toml webrtc: Generate DataChannel bindings 2020-06-03 17:08:01 +03: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 README.md: Add remark about pkg-config in MSYS2 2020-06-05 10:03:16 +03:00

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 libges-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

$ brew install gstreamer gst-plugins-base gst-plugins-good \
      gst-plugins-bad gst-plugins-ugly gst-libav gst-rtsp-server \
      gst-editing-services

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.

Note that the version of pkg-config included in MSYS2 is known to have problems compiling GStreamer, so you may need to install another version. One option would be pkg-config-lite.

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.