Crate gstreamer_gl

Help

Expand description

§gstreamer-rs

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

Installation
1. Linux/BSDs
2. macOS
3. Windows
Getting Started
License
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

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 crate::gl_video_frame::GLVideoFrame;
pub use crate::gl_video_frame::GLVideoFrameExt;
pub use crate::gl_video_frame::GLVideoFrameRef;
pub use glib;
pub use gst;
pub use gst_base;
pub use gst_video;
pub use gstreamer_gl_sys as ffi;
pub use crate::functions::*;

Modules§

functions
gl_video_frame
prelude
subclass

Structs§

GLAPI
GLAllocationParams: GLib type: Boxed type with copy-on-clone semantics.
GLBaseFilter: 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.
GLBaseMemory
GLBaseMemoryAllocator: Opaque GLBaseMemoryAllocator struct
GLBaseMemoryRef
GLBaseSrc: 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.
GLBufferPool: a GLBufferPool is an object that allocates buffers with GLBaseMemory
GLColorConvert: GLColorConvert is an object that converts between color spaces and/or formats using OpenGL Shaders.
GLConfigSurfaceType
GLContext: 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: GLDisplay represents a connection to the underlying windowing system. Elements are required to make use of gst::Context to share and propagate a GLDisplay.
GLDisplayType
GLFilter: GLFilter helps to implement simple OpenGL filter elements taking a single input and producing a single output with a GLFramebuffer
GLFramebuffer: A GLFramebuffer represents and holds an OpenGL framebuffer object with it’s associated attachments.
GLMemory
GLMemoryAllocator: Opaque GLMemoryAllocator struct
GLMemoryPBO
GLMemoryPBORef
GLMemoryRef
GLOverlayCompositor: Opaque GLOverlayCompositor object
GLPlatform
GLSLProfile: GLSL profiles
GLSLStage: GLSLStage holds and represents a single OpenGL shader stage.
GLShader: Properties
GLSyncMeta
GLUpload: GLUpload is an object that uploads data from system memory into GL textures.
GLVideoAllocationParams: GLib type: Boxed type with copy-on-clone semantics.
GLViewConvert: Convert stereoscopic/multiview video using fragment shaders.
GLWindow: GstGLWindow represents a window that elements can render into. A window can either be a user visible window (onscreen) or hidden (offscreen).

Enums§

GLConfigCaveat
GLContextError: OpenGL context errors.
GLFormat
GLQueryType
GLSLError: Compilation stage that caused an error
GLSLVersion: GLSL version list
GLStereoDownmix: Output anaglyph type to generate when downmixing to mono
GLTextureTarget: 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.
GLUploadReturn
GLWindowError

Statics§

BUFFER_POOL_OPTION_GL_SYNC_META: An option that can be activated on bufferpools to request OpenGL synchronization metadata on buffers from the pool.
BUFFER_POOL_OPTION_GL_TEXTURE_TARGET_2D: String used for GLTextureTarget::_2d as a gst::BufferPool pool option
BUFFER_POOL_OPTION_GL_TEXTURE_TARGET_EXTERNAL_OES: String used for GLTextureTarget::ExternalOes as a gst::BufferPool pool option
BUFFER_POOL_OPTION_GL_TEXTURE_TARGET_RECTANGLE: String used for GLTextureTarget::Rectangle as a gst::BufferPool pool option
CAPS_FEATURES_MEMORY_GL_MEMORY
CAPS_FEATURE_MEMORY_GL_BUFFER: Name of the caps feature indicating the use of GL buffers
CAPS_FEATURE_MEMORY_GL_MEMORY: Name of the caps feature for indicating the use of GLMemory
GL_API_GLES1_NAME: The name for GLAPI::GLES1 used in various places
GL_API_GLES2_NAME: The name for GLAPI::GLES2 used in various places
GL_API_OPENGL3_NAME: The name for GLAPI::OPENGL3 used in various places
GL_API_OPENGL_NAME: The name for GLAPI::OPENGL used in various places
GL_BASE_MEMORY_ALLOCATOR_NAME: The name of the GL buffer allocator
GL_BUFFER_ALLOCATOR_NAME: The name of the GL buffer allocator
GL_COLOR_CONVERT_VIDEO_CAPS: The currently supported gst::Caps that can be converted
GL_CONFIG_STRUCTURE_NAME: The canonical name of a gst::Structure that contains a configuration for a GLContext.
GL_CONTEXT_TYPE_CGL
GL_CONTEXT_TYPE_EAGL
GL_CONTEXT_TYPE_EGL
GL_CONTEXT_TYPE_GLX
GL_CONTEXT_TYPE_WGL
GL_DISPLAY_CONTEXT_TYPE: The name used in gst::Context queries for requesting a GLDisplay
GL_MEMORY_ALLOCATOR_NAME: The name of the GL memory allocator
GL_MEMORY_PBO_ALLOCATOR_NAME: The name of the GL Memory PBO allocator
GL_RENDERBUFFER_ALLOCATOR_NAME: The name of the GL renderbuffer allocator
GL_TEXTURE_TARGET_2D_STR: String used for GLTextureTarget::_2d in things like caps values
GL_TEXTURE_TARGET_EXTERNAL_OES_STR: String used for GLTextureTarget::ExternalOes in things like caps values
GL_TEXTURE_TARGET_RECTANGLE_STR: String used for GLTextureTarget::Rectangle in things like caps values

Crate gstreamer_glCopy item path

§gstreamer-rs

§Table of Contents

§Installation

§Linux/BSDs

§macOS

§GStreamer Binaries

§Homebrew

§Windows

§GStreamer Binaries

§MSYS2 / pacman

§Getting Started

§LICENSE

§Contribution

Re-exports§

Modules§

Structs§

Enums§

Statics§

Crate gstreamer_gl