GStreamer bindings for Rust
Find a file
Marijn Suijten 540062b97c Add missing doc aliases to manual code
Using the same script as [1], called with:

    python3 add_doc_alias.py gstreamer*/**/src

[1]: https://github.com/gtk-rs/gtk-rs-core/pull/83
2021-05-19 22:36:18 +02:00
ci ci: update Rust stable to 1.52 2021-05-17 09:41:55 +02:00
examples Update repository URL for gtk-rs "core" crates 2021-05-12 21:21:18 +02:00
gir@612ed89425 Update gir and regenerate 2021-05-05 12:23:40 +02:00
gir-files@6088bb634a gir-files: Add back as submodule from gtk-rs 2021-04-01 15:53:23 +02:00
gst-gir-files@208138af3c gst-gir-files: Add GStreamer-specific gir files back as submodule 2021-04-01 15:53:23 +02:00
gstreamer Add missing doc aliases to manual code 2021-05-19 22:36:18 +02:00
gstreamer-app Add missing doc aliases to manual code 2021-05-19 22:36:18 +02:00
gstreamer-audio Add missing doc aliases to manual code 2021-05-19 22:36:18 +02:00
gstreamer-base Add missing doc aliases to manual code 2021-05-19 22:36:18 +02:00
gstreamer-check Add missing doc aliases to manual code 2021-05-19 22:36:18 +02:00
gstreamer-controller Update repository URL for gtk-rs "core" crates 2021-05-12 21:21:18 +02:00
gstreamer-editing-services Add missing doc aliases to manual code 2021-05-19 22:36:18 +02:00
gstreamer-gl Add missing doc aliases to manual code 2021-05-19 22:36:18 +02:00
gstreamer-mpegts Update repository URL for gtk-rs "core" crates 2021-05-12 21:21:18 +02:00
gstreamer-net Add missing doc aliases to manual code 2021-05-19 22:36:18 +02:00
gstreamer-pbutils Add missing doc aliases to manual code 2021-05-19 22:36:18 +02:00
gstreamer-player Add missing doc aliases to manual code 2021-05-19 22:36:18 +02:00
gstreamer-rtp Add missing doc aliases to manual code 2021-05-19 22:36:18 +02:00
gstreamer-rtsp Update repository URL for gtk-rs "core" crates 2021-05-12 21:21:18 +02:00
gstreamer-rtsp-server Add missing doc aliases to manual code 2021-05-19 22:36:18 +02:00
gstreamer-sdp Add missing doc aliases to manual code 2021-05-19 22:36:18 +02:00
gstreamer-tag Update repository URL for gtk-rs "core" crates 2021-05-12 21:21:18 +02:00
gstreamer-video Add missing doc aliases to manual code 2021-05-19 22:36:18 +02:00
gstreamer-webrtc Add missing doc aliases to manual code 2021-05-19 22:36:18 +02:00
tutorials tutorials/basic-tutorial-13: Make sure that acquiring the main context actually succeeds 2021-05-18 12:16:59 +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: Install rustdoc-stripper in Nightly Rust image 2021-05-05 12:23:40 +02:00
.gitmodules gst-gir-files: Add GStreamer-specific gir files back as submodule 2021-04-01 15:53:23 +02:00
Cargo.toml Remove docs/ crate and references to it 2021-04-24 09:39:02 +02:00
COPYRIGHT Add a COPYRIGHT file that describes the general copyright and license situation 2020-12-16 12:42:33 +02:00
deny.toml deny: Remove obsolete configurations 2021-05-14 10:47:02 +03:00
DEVELOPMENT.md gir-files/fix: Autoamtically delete duplicate ONEFIELDs in GstVideo.gir 2020-11-25 22:44:18 +01:00
generator.py generator.py: Replace with link to gir/generator.py 2021-04-24 09:39:04 +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 README: Install glib2-devel when building in MSYS2 2021-04-26 17:56:29 +00: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 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

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.