Expand description

gstreamer-rs crates.io pipeline status

GStreamer (OpenGL library) 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. See the Cargo.toml files for the full details.

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

Please, make sure the version of these libraries is >= 1.14.

GStreamer Binaries

You need to download the two .pkg files from the GStreamer website and install them, e.g. gstreamer-1.0-1.14.4-x86_64.pkg and gstreamer-1.0-devel-1.14.4-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

Please, 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.

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.14.4.msi and gstreamer-1.0-devel-x86_64-1.14.4.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

  • Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
  • MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

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.

Re-exports

pub use ffi;
pub use glib;
pub use gst;
pub use gst_base;
pub use gst_video;
pub use crate::functions::*;

Modules

Structs

GLBaseFilter handles the nitty gritty details of retrieving an OpenGL context. It also provided some wrappers around gst_base::BaseTransform’s start(), stop() and set_caps() virtual methods that ensure an OpenGL context is available and current in the calling thread.

GLBaseSrc handles the nitty gritty details of retrieving an OpenGL context. It also provided some wrappers around gst_base::BaseSrc’s start() and stop() virtual methods that ensure an OpenGL context is available and current in the calling thread.

a GLBufferPool is an object that allocates buffers with GLBaseMemory

GLColorConvert is an object that converts between color spaces and/or formats using OpenGL Shaders.

GLContext wraps an OpenGL context object in a uniform API. As a result of the limitation on OpenGL context, this object is not thread safe unless specified and must only be activated in a single thread.

GLDisplay represents a connection to the underlying windowing system. Elements are required to make use of gst::Context to share and propagate a GLDisplay.

GLFilter helps to implement simple OpenGL filter elements taking a single input and producing a single output with a GLFramebuffer

A GLFramebuffer represents and holds an OpenGL framebuffer object with it’s associated attachments.

GLSL profiles

GLSLStage holds and represents a single OpenGL shader stage.

Implements

GLUpload is an object that uploads data from system memory into GL textures.

Convert stereoscopic/multiview video using fragment shaders.

GstGLWindow represents a window that elements can render into. A window can either be a user visible window (onscreen) or hidden (offscreen).

Enums

OpenGL context errors.

Compilation stage that caused an error

GLSL version list

Output anaglyph type to generate when downmixing to mono

The OpenGL texture target that an OpenGL texture can be bound to. The gst_gl_value_set_texture_target_from_mask(), gst_gl_value_get_texture_target_mask(), and gst_gl_value_set_texture_target() functions can be used for handling texture targets with glib::Value’s when e.g. dealing with gst::Caps.

Statics

An option that can be activated on bufferpools to request OpenGL synchronization metadata on buffers from the pool.

Name of the caps feature indicating the use of GL buffers

Name of the caps feature for indicating the use of GLMemory

The name for GLAPI::GLES1 used in various places

The name for GLAPI::GLES2 used in various places

The name for GLAPI::OPENGL3 used in various places

The name for GLAPI::OPENGL used in various places

The name of the GL buffer allocator

The name of the GL buffer allocator

The currently supported gst::Caps that can be converted

The canonical name of a gst::Structure that contains a configuration for a GLContext.

The name used in gst::Context queries for requesting a GLDisplay

The name of the GL memory allocator

The name of the GL Memory PBO allocator

The name of the GL renderbuffer allocator

String used for GLTextureTarget::_2d in things like caps values

String used for GLTextureTarget::ExternalOes in things like caps values

String used for GLTextureTarget::Rectangle in things like caps values

Functions

Note: this function first searches the first 1 kilobytes for a version preprocessor directive and then executes GLSLVersion::profile_from_string().