gst-plugins-rs

Repository containing various GStreamer plugins and elements written in the Rust programming language.

The plugins build upon the GStreamer Rust bindings. Check the README.md of that repository also for details about how to set-up your development environment.

Plugins

You will find the following plugins in this repository:

• generic

  • file: A Rust implementation of the standard filesrc and filesink elements

  • sodium: Elements to perform encryption and decryption using libsodium.

  • threadshare: Some popular threaded elements reimplemented using common thread-sharing infrastructure.

• net

  • reqwest: An HTTP source element based on the reqwest library.

  • rusoto: A source and sink plugin to talk to the Amazon S3 object storage system, as well as an element wrapping the AWS Transcriber service using the Rusoto library.

• audio

  • audiofx: Plugins to apply audio effects to a stream (such as adding echo/reverb, removing noise or normalization).

  • claxon: A FLAC decoder based on the Claxon library.

  • csound: A plugin to implement audio effects using the Csound library.

  • lewton: A Vorbis decoder based on the lewton library.

  • spotify: A plugin to access content from Spotify based on the librespot library.

• video

  • cdg: A parser and renderer for CD+G karaoke data.

  • closedcaption: Plugins to deal with several closed caption formats (MCC, SCC, EIA-608/CEA-608 and timed text).

  • dav1d: AV1 decoder based on the dav1d library.

  • ffv1: FFV1 decoder based on the ffv1 library.

  • flavors: FLV demuxer based on the flavors library.

  • gif: A GIF encoder based on the gif library.

  • hsv: Elements to work with video data in hue, saturation, value form.

  • png: PNG encoder based on the png library.

  • rav1e: AV1 encoder based on the rav1e library.

  • webp: WebP decoder based on the libwebp-sys-2 library.

• text

  • json: A plugin to convert a stream of JSON objects to a higher level wrapped NDJSON output.

  • regex: A regular expression text filter plugin.

  • wrap: A plugin to perform text wrapping with hyphenation.

  • ahead: A plugin to display upcoming text buffers ahead.

• utils

  • fallbackswitch: Aggregator element that allows falling back to a different sink pad after a timeout.

  • togglerecord: Element to enable starting and stopping multiple streams together.

Building

gst-plugins-rs relies on cargo-c to generate shared and static C libraries. It can be installed using:

$ cargo install cargo-c

Then you can easily build and test a specific plugin:

$ cargo cbuild -p gst-plugin-cdg
$ GST_PLUGIN_PATH="target/x86_64-unknown-linux-gnu/debug:$GST_PLUGIN_PATH" gst-inspect-1.0 cdgdec

Replace x86_64-unknown-linux-gnu with your system's Rust target triple (rustc -vV).

The plugin can also be installed system-wide:

$ cargo cbuild -p gst-plugin-cdg --prefix=/usr
$ cargo cinstall -p gst-plugin-cdg --prefix=/usr

This will install the plugin to /usr/lib/gstreamer-1.0. You can use --libdir to pass a custom lib directory such as /usr/lib/x86_64-linux-gnu for example.

Note that you can also just use cargo directly to build Rust static libraries and shared C libraries. cargo-c is mostly useful to build static C libraries and generate pkg-config files.

LICENSE

gst-plugins-rs and all crates contained in here are licensed under one of the following licenses

• Mozilla Public License Version 2.0 (LICENSE-MPL-2.0 or http://opensource.org/licenses/MPL-2.0)
• 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)
• Lesser General Public License (LICENSE-LGPLv2) version 2.1 or (at your option) any later version

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 merge request.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in gst-plugins-rs by you shall be licensed under the license of the plugin it is added to.

For new plugins the MPL-2 license is preferred.