mirror of https://gitlab.freedesktop.org/gstreamer/gst-plugins-rs.git synced 2024-11-22 19:41:00 +00:00

GStreamer plugins written in Rust. *These plugins can be used by applications written in other programming languages as well of course, they are just like any other GStreamer plugins available on the system.*

gitlab gstreamer official-mirror rust

Find a file

François Laignel 6a2df92453 Revert "fmp4mux: Dequeue as many buffers as are available in each aggregate call" This reverts commit `402500f79c`. This commit introduces race conditions. It was intended as solving an issue with some pipelines which had their queues filling up, causing the streams to stall. It is reverted as this solution is considered a workaround for another issue. See discussion in: https://gitlab.freedesktop.org/gstreamer/gst-plugins-rs/-/merge_requests/803		2022-07-20 15:56:04 +00:00
audio	audioloudnorm: Drain on segment event	2022-06-20 21:57:04 +09:00
ci	ci: Update to cargo-c 0.9.11	2022-07-19 18:16:19 +03:00
generic	Revert "fmp4mux: Dequeue as many buffers as are available in each aggregate call"	2022-07-20 15:56:04 +00:00
net	Add RaptorQ RTP FEC plugins	2022-07-20 13:34:58 +00:00
text	Simplify Formatted value handling	2022-07-11 21:21:54 +02:00
tutorial	tutorial/sinesrc: Use pushsrc as direct superclass in the glib::wrapper macro too	2022-05-10 10:05:48 +00:00
utils	tracers: queue_levels: log when file is being written	2022-07-20 17:05:29 +02:00
version-helper	Update minimum supported Rust version to 1.57	2022-02-21 23:32:32 +01:00
video	Simplify Formatted value handling	2022-07-11 21:21:54 +02:00
.gitignore	.gitignore builddir	2021-06-03 09:19:31 +02:00
.gitlab-ci.yml	ci: Update to cargo-c 0.9.11	2022-07-19 18:16:19 +03:00
Cargo.toml	Add RaptorQ RTP FEC plugins	2022-07-20 13:34:58 +00:00
cargo_wrapper.py	cargo_wrapper.py: added python3 version check for right usage of shutil.move(..)	2022-05-27 21:34:35 +02:00
deny.toml	deny: Update	2022-07-11 18:30:54 +03:00
LICENSE-APACHE	Change license from LGPLv2.1+ to Apache2/MIT	2017-02-16 17:52:27 +02:00
LICENSE-LGPLv2	Add gst-plugin-togglerecord	2017-12-05 09:56:58 +02:00
LICENSE-MIT	Change license from LGPLv2.1+ to Apache2/MIT	2017-02-16 17:52:27 +02:00
LICENSE-MPL-2.0	Add a GTK4 paintable sink plugin	2021-10-13 12:28:51 +03:00
Makefile	Clean up Makefile some more	2019-07-06 10:32:22 +03:00
meson.build	Add RaptorQ RTP FEC plugins	2022-07-20 13:34:58 +00:00
meson_options.txt	Add a GTK4 paintable sink plugin	2021-10-13 12:28:51 +03:00
README.md	README: mention cargo update to resolve dep issues after git updates	2022-06-20 11:48:32 +01:00
rustfmt.toml	rustfmt.toml: Add file	2022-04-05 19:13:59 +03:00
update-version.sh	Add update-version script	2020-04-15 20:39:31 +02:00

README.md

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
- fmp4: A fragmented MP4/ISOBMFF/CMAF muxer for generating e.g. DASH/HLS media fragments.
- sodium: Elements to perform encryption and decryption using libsodium.
- threadshare: Some popular threaded elements reimplemented using common thread-sharing infrastructure.
net
- hlssink3: An element for generating MPEG-TS HLS streams.
- reqwest: An HTTP source element based on the reqwest library.
- aws: Various elements for Amazon AWS services using the AWS SDK library
  - s3src/s3sink: A source and sink element to talk to the Amazon S3 object storage system.
  - aws_transcriber: an element wrapping the AWS Transcriber service.
audio
- audiofx: Elements to apply audio effects to a stream
  - rsaudioecho: a simple echo/reverb filter.
  - rsaudioloudnorm: audio normalization filter.
  - audiornnoise: Filter for removing noise.
  - ebur128level: Filter for measuring audio loudness according to EBU R-128.
  - hrtfrender: Filter for rendering audio according to a head-related transfer function.
- 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: Plugin to deal with closed caption streams
  - ccdetect: Detects if a stream contains active Closed Captions.
  - cea608overlay: Overlay CEA-608 / EIA-608 closed captions over a video stream.
  - cea608tojson: Convert CEA-608 / EIA-608 closed captions to a JSON stream.
  - cea608tott: Convert CEA-608 / EIA-608 closed captions to timed text.
  - jsontovtt: Convert JSON to timed text.
  - mccenc: Convert CEA-608 / EIA-608 and CEA-708 / EIA-708 closed captions to the MCC format.
  - mccparse: Parse CEA-608 / EIA-608 and CEA-708 / EIA-708 closed captions from the MCC format.
  - sccenc: Convert CEA-608 / EIA-608 closed captions to the MCC format.
  - sccparse: Parse CEA-608 / EIA-608 closed captions from the MCC format.
  - transcriberbin: Convenience bin around transcriber elements like aws_transcriber.
  - tttocea608: Convert timed text to CEA-608 / EIA-608 closed captions.
  - tttojson: Convert timed text to JSON.
- 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.
- gtk4: A GTK4 video sink that provides a GdkPaintable for UI integration.
- hsv: Plugin with various elements to work with video data in hue, saturation, value format
  - hsvdetector: Mark pixels that are close to a configured color in HSV format.
  - hsvfilter: Apply various transformations in the HSV colorspace.
- png: PNG encoder based on the png library.
- rav1e: AV1 encoder based on the rav1e library.
- videofx: Plugin with various video filters.
  - roundedcorners: Element to make the corners of a video rounded via the alpha channel.
  - colordetect: A pass-through filter able to detect the dominant color(s) on incoming frames, using color-thief.
- webp: WebP decoder based on the libwebp-sys-2 library.
text
- ahead: A plugin to display upcoming text buffers ahead.
- 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.
utils
- fallbackswitch:
  - fallbackswitch: An element that allows falling back to different sink pads after a timeout based on the sink pads' priorities.
  - fallbacksrc: Element similar to urisourcebin that allows configuring a fallback audio/video if there are problems with the main source.
- 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.

In case cargo complains about dependency versions after a git pull, cargo update may be able to resolve those.

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.