Crate gstreamer

Expand description

§gstreamer-rs

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

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::log::DebugCategoryLogger;
pub use crate::log::DebugCategory;
pub use crate::log::DebugLogFunction;
pub use crate::log::DebugMessage;
pub use crate::log::LoggedObject;
pub use crate::log::CAT_BUFFER;
pub use crate::log::CAT_BUFFER_LIST;
pub use crate::log::CAT_BUS;
pub use crate::log::CAT_CALL_TRACE;
pub use crate::log::CAT_CAPS;
pub use crate::log::CAT_CLOCK;
pub use crate::log::CAT_CONTEXT;
pub use crate::log::CAT_DEFAULT;
pub use crate::log::CAT_ELEMENT_PADS;
pub use crate::log::CAT_ERROR_SYSTEM;
pub use crate::log::CAT_EVENT;
pub use crate::log::CAT_GST_INIT;
pub use crate::log::CAT_LOCKING;
pub use crate::log::CAT_MEMORY;
pub use crate::log::CAT_MESSAGE;
pub use crate::log::CAT_META;
pub use crate::log::CAT_NEGOTIATION;
pub use crate::log::CAT_PADS;
pub use crate::log::CAT_PARAMS;
pub use crate::log::CAT_PARENTAGE;
pub use crate::log::CAT_PERFORMANCE;
pub use crate::log::CAT_PIPELINE;
pub use crate::log::CAT_PLUGIN_INFO;
pub use crate::log::CAT_PLUGIN_LOADING;
pub use crate::log::CAT_PROBE;
pub use crate::log::CAT_PROPERTIES;
pub use crate::log::CAT_QOS;
pub use crate::log::CAT_REFCOUNTING;
pub use crate::log::CAT_REGISTRY;
pub use crate::log::CAT_RUST;
pub use crate::log::CAT_SCHEDULING;
pub use crate::log::CAT_SIGNAL;
pub use crate::log::CAT_STATES;
pub use miniobject::MiniObject;
pub use miniobject::MiniObjectRef;
pub use crate::message::Message;
pub use crate::message::MessageErrorDomain;
pub use crate::message::MessageRef;
pub use crate::message::MessageView;
pub use crate::message::MessageViewMut;
pub use crate::structure::Structure;
pub use crate::structure::StructureRef;
pub use crate::caps::Caps;
pub use crate::caps::CapsFilterMapAction;
pub use crate::caps::CapsRef;
pub use crate::tags::tag_exists;
pub use crate::tags::tag_get_description;
pub use crate::tags::tag_get_flag;
pub use crate::tags::tag_get_nick;
pub use crate::tags::tag_get_type;
pub use crate::tags::Tag;
pub use crate::tags::TagList;
pub use crate::tags::TagListRef;
pub use crate::meta::MetaSeqnum;v1_16
pub use crate::meta::Meta;
pub use crate::meta::MetaAPI;
pub use crate::meta::MetaAPIExt;
pub use crate::meta::MetaRef;
pub use crate::meta::MetaRefMut;
pub use crate::meta::ParentBufferMeta;
pub use crate::meta::ProtectionMeta;
pub use crate::meta::ReferenceTimestampMeta;
pub use crate::buffer::Buffer;
pub use crate::buffer::BufferMap;
pub use crate::buffer::BufferRef;
pub use crate::buffer::MappedBuffer;
pub use crate::buffer::BUFFER_COPY_ALL;
pub use crate::buffer::BUFFER_COPY_METADATA;
pub use crate::memory::MappedMemory;
pub use crate::memory::Memory;
pub use crate::memory::MemoryMap;
pub use crate::memory::MemoryRef;
pub use crate::sample::Sample;
pub use crate::sample::SampleRef;
pub use crate::bufferlist::BufferList;
pub use crate::bufferlist::BufferListRef;
pub use crate::query::Query;
pub use crate::query::QueryRef;
pub use crate::query::QueryView;
pub use crate::query::QueryViewMut;
pub use crate::event::Event;
pub use crate::event::EventRef;
pub use crate::event::EventView;
pub use crate::event::EventViewMut;
pub use crate::event::GroupId;
pub use crate::event::Seqnum;
pub use crate::context::Context;
pub use crate::context::ContextRef;
pub use promise::Promise;
pub use promise::PromiseError;
pub use task::TaskLock;
pub use task::TaskLockGuard;
pub use crate::format::ClockTime;
pub use crate::format::GenericFormattedValue;
pub use crate::format::GenericSignedFormattedValue;
pub use crate::format::Signed;
pub use crate::toc::Toc;
pub use crate::toc::TocEntry;
pub use crate::toc::TocEntryRef;
pub use crate::toc::TocRef;
pub use crate::param_spec::ParamSpecArray;
pub use crate::param_spec::ParamSpecFraction;
pub use glib;
pub use gstreamer_sys as ffi;
pub use paste;

Modules§

buffer
bufferlist
bus
caps
context
element_factory
event
format: This module gathers GStreamer’s formatted value concepts together.
log
memory
message
meta
miniobject
param_spec
parse
prelude
promise
query
sample
slice
stream
stream_collection
structure
subclass
tags
task
toc

Macros§

Structs§

AllocationParams
Allocator: GLib type: GObject with reference counted clone semantics.
Array
ArrayRef
AtomicClockReturn
Bin: GLib type: GObject with reference counted clone semantics.
BinBuilder: A builder-pattern type to construct Bin objects.
BinFlags
Bitmask
BufferCopyFlags
BufferCursor
BufferFlags
BufferPool: GLib type: GObject with reference counted clone semantics.
BufferPoolAcquireFlags
BufferPoolAcquireParams
BufferPoolConfig
BufferPoolConfigRef
BufferRefCursor
Bus: GLib type: GObject with reference counted clone semantics.
CapsFeatures
CapsFeaturesRef
ChildProxy: GLib type: GObject with reference counted clone semantics.
Clock: GLib type: GObject with reference counted clone semantics.
ClockFlags
ClockId: GLib type: Shared boxed type with reference counted clone semantics.
ControlBinding: GLib type: GObject with reference counted clone semantics.
ControlSource: GLib type: GObject with reference counted clone semantics.
DateTime: GLib type: Shared boxed type with reference counted clone semantics.
DebugColorFlags
DebugGraphDetails
Device: GLib type: GObject with reference counted clone semantics.
DeviceMonitor: GLib type: GObject with reference counted clone semantics.
DeviceMonitorFilterId
DeviceProvider: GLib type: GObject with reference counted clone semantics.
DeviceProviderFactory: GLib type: GObject with reference counted clone semantics.
Element: GLib type: GObject with reference counted clone semantics.
ElementFactory: GLib type: GObject with reference counted clone semantics.
ElementFactoryType
ElementFlags
ErrorMessage
EventTypeFlags
FormattedSegment: GLib type: Inline allocated boxed type with stack copy semantics.
Fraction
FractionRange
GapFlagsv1_20
GhostPad: GLib type: GObject with reference counted clone semantics.
IntRange
Iterator
List
ListRef
LoggableError
MemoryFlags
MetaFlags
NotifyWatchId
Object: GLib type: GObject with reference counted clone semantics.
ObjectFlags
ObjectLockGuard
Pad: GLib type: GObject with reference counted clone semantics.
PadBuilder
PadFlags
PadLinkCheck
PadLinkSuccess
PadProbeId
PadProbeInfo
PadProbeType
PadTemplate: GLib type: GObject with reference counted clone semantics.
PadTemplateBuilder
ParseContext: GLib type: Boxed type with copy-on-clone semantics.
ParseFlags
PeriodicClockId
Pipeline: GLib type: GObject with reference counted clone semantics.
PipelineBuilder: A builder-pattern type to construct Pipeline objects.
PipelineFlags
Plugin: GLib type: GObject with reference counted clone semantics.
PluginAPIFlagsv1_18
PluginDependencyFlags
PluginFeature: GLib type: GObject with reference counted clone semantics.
PluginFlags
Preset: GLib type: GObject with reference counted clone semantics.
ProxyPad: GLib type: GObject with reference counted clone semantics.
Rank
Registry: GLib type: GObject with reference counted clone semantics.
SchedulingFlags
SeekFlags
SegmentFlags
SerializeFlagsv1_20
SingleShotClockId
SliceTypeFind
StackTraceFlags
StateChangeError
StaticCaps
StaticPadTemplate
StdIterator
Stream: GLib type: GObject with reference counted clone semantics.
StreamCollection: GLib type: GObject with reference counted clone semantics.
StreamFlags
StreamLock
StreamType
SystemClock: GLib type: GObject with reference counted clone semantics.
TagSetter: GLib type: GObject with reference counted clone semantics.
Task: GLib type: GObject with reference counted clone semantics.
TaskPool: GLib type: GObject with reference counted clone semantics.
TaskPoolTaskHandle: An opaque handle for a task associated with a particular task pool.
TocSetter: GLib type: GObject with reference counted clone semantics.
Tracer: GLib type: GObject with reference counted clone semantics.
TracerFactory: GLib type: GObject with reference counted clone semantics.
TypeFind
TypeFindFactory: GLib type: GObject with reference counted clone semantics.
URIHandler: GLib type: GObject with reference counted clone semantics.

Enums§

Constants§

PARAM_FLAG_CONDITIONALLY_AVAILABLE
PARAM_FLAG_CONTROLLABLE
PARAM_FLAG_DOC_SHOW_DEFAULT
PARAM_FLAG_MUTABLE_PAUSED
PARAM_FLAG_MUTABLE_PLAYING
PARAM_FLAG_MUTABLE_READY

Statics§

CAPS_FEATURES_MEMORY_SYSTEM_MEMORY
CAPS_FEATURE_MEMORY_SYSTEM_MEMORY
ELEMENT_METADATA_AUTHOR
ELEMENT_METADATA_DESCRIPTION
ELEMENT_METADATA_DOC_URI
ELEMENT_METADATA_ICON_NAME
ELEMENT_METADATA_KLASS
ELEMENT_METADATA_LONGNAME

Traits§

IteratorImpl
TaskHandle: A handle for a task which was pushed to a task pool.
TypeFindImpl

Functions§

active_tracersv1_18
assert_initialized
calculate_linear_regression
deinit^⚠: Deinitialize GStreamer
filename_comparev1_24
get_timestamp
init
main_executable_path
version
version_string

Type Aliases§

ClockTimeDiff
Segment

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

Type Aliases§

Crate gstreamer