Crate gstreamer_video

Expand description

§gstreamer-rs

GStreamer (Video 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::video_frame::VideoFrame;
pub use crate::video_frame::VideoFrameExt;
pub use crate::video_frame::VideoFrameRef;
pub use crate::video_event::DownstreamForceKeyUnitEvent;
pub use crate::video_event::ForceKeyUnitEvent;
pub use crate::video_event::NavigationEvent;
pub use crate::video_event::StillFrameEvent;
pub use crate::video_event::UpstreamForceKeyUnitEvent;
pub use crate::video_message::NavigationEventMessage;
pub use crate::video_message::NavigationMessage;
pub use crate::video_overlay_composition::VideoOverlayComposition;
pub use crate::video_overlay_composition::VideoOverlayCompositionRef;
pub use crate::video_overlay_composition::VideoOverlayRectangle;
pub use crate::video_overlay_composition::VideoOverlayRectangleRef;
pub use crate::video_meta::VideoCaptionMeta;
pub use crate::video_meta::VideoAFDMeta;
pub use crate::video_meta::VideoBarMeta;
pub use crate::video_meta::VideoAffineTransformationMeta;
pub use crate::video_meta::VideoCropMeta;
pub use crate::video_meta::VideoMeta;
pub use crate::video_meta::VideoOverlayCompositionMeta;
pub use crate::video_meta::VideoRegionOfInterestMeta;
pub use crate::video_converter::VideoConverter;
pub use crate::video_converter::VideoConverterConfig;
pub use crate::video_codec_state::VideoCodecState;
pub use crate::video_codec_state::VideoCodecStateContext;
pub use glib;
pub use gst;
pub use gst_base;
pub use gstreamer_video_sys as ffi;

Modules§

auto 🔒
caps 🔒
caps_features 🔒
color_balance_channel 🔒
enums 🔒
functions 🔒
prelude
subclass
utils 🔒
video_aggregator 🔒
video_aggregator_convert_pad 🔒
video_aggregator_pad 🔒
video_buffer_pool 🔒
video_codec_frame 🔒
video_codec_state
video_color_matrix 🔒
video_converter
video_decoder 🔒
video_encoder 🔒
video_event
video_filter 🔒
video_format 🔒
video_format_info 🔒
video_frame
video_hdr 🔒
video_info 🔒
video_message
video_meta
video_overlay 🔒
video_overlay_composition
video_rectangle 🔒
video_time_code 🔒
video_time_code_interval 🔒
video_vbi 🔒
video_vbi_encoder 🔒
video_vbi_parser 🔒

Macros§

assert_initialized_main_thread 🔒
skip_assert_initialized 🔒
video_decoder_error

Structs§

AncillaryIter
ColorBalance: GLib type: GObject with reference counted clone semantics.
ColorBalanceChannel: GLib type: GObject with reference counted clone semantics.
Navigation: GLib type: GObject with reference counted clone semantics.
ValidVideoTimeCode: GLib type: Inline allocated boxed type with stack copy semantics.
VideoAggregator: GLib type: GObject with reference counted clone semantics.
VideoAggregatorConvertPad: GLib type: GObject with reference counted clone semantics.
VideoAggregatorPad: GLib type: GObject with reference counted clone semantics.
VideoAggregatorParallelConvertPad: GLib type: GObject with reference counted clone semantics.
VideoAlignment
VideoAncillary: GLib type: Inline allocated boxed type with stack copy semantics.
VideoBufferFlags
VideoBufferPool: GLib type: GObject with reference counted clone semantics.
VideoCapsBuilder
VideoChromaSite
VideoCodecFrame
VideoCodecFrameFlags
VideoColorimetry
VideoContentLightLevel
VideoDecoder: GLib type: GObject with reference counted clone semantics.
VideoDecoderRequestSyncPointFlags
VideoEncoder: GLib type: GObject with reference counted clone semantics.
VideoFilter: GLib type: GObject with reference counted clone semantics.
VideoFlags
VideoFormatFlags
VideoFormatInfo
VideoFormatIterator
VideoFrameFlags
VideoInfo
VideoInfoBuilder
VideoMasteringDisplayInfo
VideoMasteringDisplayInfoCoordinate
VideoMultiviewFlags
VideoOrientation: GLib type: GObject with reference counted clone semantics.
VideoOverlay: GLib type: GObject with reference counted clone semantics.
VideoOverlayFormatFlags
VideoPackFlags
VideoRectangle
VideoSink: GLib type: GObject with reference counted clone semantics.
VideoTimeCode: GLib type: Inline allocated boxed type with stack copy semantics.
VideoTimeCodeFlags
VideoTimeCodeInterval: GLib type: Inline allocated boxed type with stack copy semantics.
VideoTimeCodeMeta
VideoVBIEncoder
VideoVBIParser

Enums§

Constants§

VIDEO_DECODER_FLOW_NEED_DATA
VIDEO_ENCODER_FLOW_NEED_DATA
VIDEO_MAX_PLANES

Statics§

BUFFER_POOL_OPTION_VIDEO_AFFINE_TRANSFORMATION_META
BUFFER_POOL_OPTION_VIDEO_ALIGNMENT
BUFFER_POOL_OPTION_VIDEO_GL_TEXTURE_UPLOAD_META
BUFFER_POOL_OPTION_VIDEO_META
CAPS_FEATURES_FORMAT_INTERLACED
CAPS_FEATURES_META_GST_VIDEO_AFFINE_TRANSFORMATION_META
CAPS_FEATURES_META_GST_VIDEO_GL_TEXTURE_UPLOAD_META
CAPS_FEATURES_META_GST_VIDEO_META
CAPS_FEATURES_META_GST_VIDEO_OVERLAY_COMPOSITION
CAPS_FEATURE_FORMAT_INTERLACED
CAPS_FEATURE_META_GST_VIDEO_AFFINE_TRANSFORMATION_META
CAPS_FEATURE_META_GST_VIDEO_GL_TEXTURE_UPLOAD_META
CAPS_FEATURE_META_GST_VIDEO_META
CAPS_FEATURE_META_GST_VIDEO_OVERLAY_COMPOSITION
VIDEO_FORMATS_ALL

Traits§

VideoBufferPoolConfig
VideoFormatIteratorExt
VideoFormatIteratorExtRef

Functions§

calculate_display_ratio
center_video_rectangle
convert_sample
convert_sample_async
convert_sample_async_local
convert_sample_future
guess_framerate
is_video_overlay_prepare_window_handle_message
video_make_raw_caps

Crate gstreamer_videoCopy 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§

Macros§

Structs§

Enums§

Constants§

Statics§

Traits§

Functions§

Crate gstreamer_video