GStreamer bindings for Rust
Go to file
Sebastian Dröge 28451435a4 Update CHANGELOG.md for 0.22.2 2024-02-26 14:50:48 +02:00
.gitlab/issue_templates gitlab: add issue template 2023-06-15 11:37:18 +00:00
ci ci: rebuild images to update GStreamer 2024-02-26 09:09:00 +01:00
examples examples: Move some more gtk-rs-core dependencies to the workspace 2024-02-08 14:39:58 +02:00
gir@5975266da3 Update gir 2024-02-06 09:44:51 +02:00
gir-files@fe8258109e Update gir files 2024-02-06 09:45:02 +02:00
gst-gir-files@62c7d3c33c Update GStreamer gir files 2024-02-26 11:29:19 +00:00
gstreamer Update CHANGELOG.md for 0.22.2 2024-02-26 14:50:48 +02:00
gstreamer-allocators Regenerate with latest GStreamer gir files 2024-02-26 11:29:19 +00:00
gstreamer-analytics Regenerate with latest GStreamer gir files 2024-02-26 11:29:19 +00:00
gstreamer-app Regenerate with latest GStreamer gir files 2024-02-26 11:29:19 +00:00
gstreamer-audio Regenerate with latest GStreamer gir files 2024-02-26 11:29:19 +00:00
gstreamer-base Regenerate with latest GStreamer gir files 2024-02-26 11:29:19 +00:00
gstreamer-check Regenerate with latest GStreamer gir files 2024-02-26 11:29:19 +00:00
gstreamer-controller Regenerate with latest GStreamer gir files 2024-02-26 11:29:19 +00:00
gstreamer-editing-services Regenerate with latest GStreamer gir files 2024-02-26 11:29:19 +00:00
gstreamer-gl Regenerate with latest GStreamer gir files 2024-02-26 11:29:19 +00:00
gstreamer-mpegts Regenerate with latest GStreamer gir files 2024-02-26 11:29:19 +00:00
gstreamer-net Regenerate with latest GStreamer gir files 2024-02-26 11:29:19 +00:00
gstreamer-pbutils Regenerate with latest GStreamer gir files 2024-02-26 11:29:19 +00:00
gstreamer-play Regenerate with latest GStreamer gir files 2024-02-26 11:29:19 +00:00
gstreamer-player Regenerate with latest GStreamer gir files 2024-02-26 11:29:19 +00:00
gstreamer-rtp Regenerate with latest GStreamer gir files 2024-02-26 11:29:19 +00:00
gstreamer-rtsp Regenerate with latest GStreamer gir files 2024-02-26 11:29:19 +00:00
gstreamer-rtsp-server Regenerate with latest GStreamer gir files 2024-02-26 11:29:19 +00:00
gstreamer-sdp Regenerate with latest GStreamer gir files 2024-02-26 11:29:19 +00:00
gstreamer-tag Regenerate with latest GStreamer gir files 2024-02-26 11:29:19 +00:00
gstreamer-utils Use workspace features for common deps 2024-02-03 10:48:37 +01:00
gstreamer-validate Regenerate with latest GStreamer gir files 2024-02-26 11:29:19 +00:00
gstreamer-video Regenerate with latest GStreamer gir files 2024-02-26 11:29:19 +00:00
gstreamer-webrtc Regenerate with latest GStreamer gir files 2024-02-26 11:29:19 +00:00
public Add more redirects for old documentation links 2021-05-29 18:56:03 +03:00
tutorials Use workspace features for common deps 2024-02-03 10:48:37 +01:00
.gitignore Remove Cargo.lock from .gitignore 2024-02-16 14:24:32 +02:00
.gitlab-ci.yml Publish docs for 0.22 release 2024-02-08 15:24:21 +02:00
.gitmodules Update gir submodule 2023-07-06 14:08:32 +03:00
COPYRIGHT Add a COPYRIGHT file that describes the general copyright and license situation 2020-12-16 12:42:33 +02:00
Cargo.lock Update Cargo.lock 2024-02-26 11:29:19 +00:00
Cargo.toml Update versions to 0.23.0 2024-02-08 14:47:20 +02:00
DEVELOPMENT.md gir-files/fix: Autoamtically delete duplicate ONEFIELDs in GstVideo.gir 2020-11-25 22:44:18 +01: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 Add some more information about setup on Windows/macOS to the README.md 2022-10-14 21:26:12 +05:30
deny.toml deny: Add override for duplicated toml_edit dependency 2024-02-06 10:29:12 +02:00
generator.py generator.py: Replace with link to gir/generator.py 2021-04-24 09:39:04 +02:00
rustfmt.toml rustfmt.toml: Add file 2022-04-06 07:46:29 +00:00
typos.toml ci: typoes: Fix some typos and add subtiles to the word list 2023-07-06 08:40:30 +03:00

README.md

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.14 and gst-plugins-base 1.14 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.14. 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. See the Cargo.toml files for the full details,

$ 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.

We recommend using the official GStreamer binaries over Homebrew, especially as GStreamer in Homebrew is currently broken.

GStreamer Binaries

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

After installation, you also need to set the PATH environment variable as follows

$ export PATH="/Library/Frameworks/GStreamer.framework/Versions/1.0/bin${PATH:+:$PATH}"

Also note that the pkg-config from GStreamer should be the first one in the PATH as other versions have all kinds of quirks that will cause problems.

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

Make sure the version of these libraries is >= 1.14.

Windows

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

We recommend using the official GStreamer binaries over MSYS2.

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.20.4.msi and gstreamer-1.0-devel-x86_64-1.20.4.msi. Make sure to select the version that matches your Rust toolchain, i.e. MinGW or MSVC.

After installation set the ``PATH` environment variable as follows:

# For a UNIX-style shell:
$ export PATH="c:/gstreamer/1.0/msvc_x86_64/bin${PATH:+:$PATH}"

# For cmd.exe:
$ set PATH=C:\gstreamer\1.0\msvc_x86_64\bin;%PATH%

Make sure to update the path to where you have actually installed GStreamer and for the corresponding toolchain.

Also note that the pkg-config.exe from GStreamer should be the first one in the PATH as other versions have all kinds of quirks that will cause problems.

MSYS2 / pacman

$ pacman -S glib2-devel 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

Make sure the version of these libraries is >= 1.14.

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.

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.