Create a source plugin too. (#19)

Author: kixelated

.gitignore

@@ -2,4 +2,4 @@
 target/
 *.mp4
 *.fmp4
-debug/
+debug/

Cargo.lock

@@ -19,6 +19,8 @@ moq-karp = "0.14"
 
 gst = { package = "gstreamer", version = "0.23" }
 gst-base = { package = "gstreamer-base", version = "0.23" }
+gst-app = { package = "gstreamer-app", version = "0.23", features = ["v1_20"] }
+
 once_cell = "1"
 tokio = { version = "1", features = ["full"] }
 env_logger = "0.9"

Cargo.toml

@@ -1,17 +1,39 @@
+<p align="center">
+	<img height="128px" src="https://github.com/kixelated/moq-rs/blob/main/.github/logo.svg" alt="Media over QUIC">
+</p>
+
 A gstreamer plugin utilizing [moq-rs](https://github.com/kixelated/moq-rs).
 
 # Usage
-Check out the `dev/pub` script for an example pipeline.
+## Requirements
+- [Rustup](https://www.rust-lang.org/tools/install)
+- [Just](https://github.com/casey/just?tab=readme-ov-file#installation)
+
+## Setup
+We use `just` to simplify the development process.
+Check out the [Justfile](justfile) or run `just` to see the available commands.
 
-```bash
-./dev/pub
+Install any other required tools:
+```sh
+just setup
 ```
 
-By default this uses a localhost relay.
-You can change the ENV args if you want to make it watchable on production instead:
+## Development
+First make sure you have a local moq-relay server running:
+```sh
+# In github.com/kixelated/moq-rs
+just relay
+```
+
+Now you can publish and subscribe to a video:
+```sh
+# In github.com/kixelated/moq-gst
+
+# Publish to a localhost moq-relay server
+just pub
 
-```bash
-ADDR=relay.quic.video NAME=something ./dev/pub
+# Subscribe from a localhost moq-relay server
+just sub
 ```
 
 # License

README.md

@@ -0,0 +1,90 @@
+#!/usr/bin/env just --justfile
+
+# Using Just: https://github.com/casey/just?tab=readme-ov-file#installation
+
+export RUST_BACKTRACE := "1"
+export RUST_LOG := "info"
+export URL := "http://localhost:4443"
+#export GST_DEBUG:="*:4"
+
+# List all of the available commands.
+default:
+  just --list
+
+# Install any required dependencies.
+setup:
+	# Upgrade Rust
+	rustup update
+
+	# Make sure the right components are installed.
+	rustup component add rustfmt clippy
+
+	# Install cargo binstall if needed.
+	cargo install cargo-binstall
+
+	# Install cargo shear if needed.
+	cargo binstall --no-confirm cargo-shear
+
+# Download the video and convert it to a fragmented MP4 that we can stream
+download name url:
+	if [ ! -f dev/{{name}}.mp4 ]; then \
+		wget {{url}} -O dev/{{name}}.mp4; \
+	fi
+
+	if [ ! -f dev/{{name}}.fmp4 ]; then \
+		ffmpeg -i dev/{{name}}.mp4 \
+			-c copy \
+			-f mp4 -movflags cmaf+separate_moof+delay_moov+skip_trailer+frag_every_frame \
+			dev/{{name}}.fmp4; \
+	fi
+
+# Publish a video using ffmpeg to the localhost relay server
+pub: (download "bbb" "http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4")
+	# Build the plugins
+	cargo build
+
+	# Run gstreamer and pipe the output to our plugin
+	GST_PLUGIN_PATH="${PWD}/target/debug${GST_PLUGIN_PATH:+:$GST_PLUGIN_PATH}" \
+	gst-launch-1.0 -v -e multifilesrc location="dev/bbb.fmp4" loop=true ! qtdemux name=demux \
+		demux.video_0 ! h264parse ! queue ! identity sync=true ! isofmp4mux name=mux chunk-duration=1 fragment-duration=1 ! moqsink url="$URL/demo/bbb" tls-disable-verify=true \
+		demux.audio_0 ! aacparse ! queue ! mux.
+
+# Subscribe to a video using gstreamer
+sub:
+	# Build the plugins
+	cargo build
+
+	# Run gstreamer and pipe the output to our plugin
+	# This will render the video to the screen
+	GST_PLUGIN_PATH="${PWD}/target/debug${GST_PLUGIN_PATH:+:$GST_PLUGIN_PATH}" \
+	gst-launch-1.0 -v -e moqsrc url="$URL/demo/bbb" tls-disable-verify=true ! decodebin ! videoconvert ! autovideosink
+
+# Run the CI checks
+check $RUSTFLAGS="-D warnings":
+	cargo check --all-targets
+	cargo clippy --all-targets -- -D warnings
+	cargo fmt -- --check
+	cargo shear # requires: cargo binstall cargo-shear
+
+# Run any CI tests
+test $RUSTFLAGS="-D warnings":
+	cargo test
+
+# Automatically fix some issues.
+fix:
+	cargo fix --allow-staged --all-targets --all-features
+	cargo clippy --fix --allow-staged --all-targets --all-features
+	cargo fmt --all
+	cargo shear --fix
+
+# Upgrade any tooling
+upgrade:
+	rustup upgrade
+
+	# Install cargo-upgrades if needed.
+	cargo install cargo-upgrades cargo-edit
+	cargo upgrade
+
+# Build the plugins
+build:
+	cargo build

dev/pub

@@ -1,9 +1,13 @@
 use gst::glib;
 
 mod sink;
+mod source;
 
 pub fn plugin_init(plugin: &gst::Plugin) -> Result<(), glib::BoolError> {
+	env_logger::init();
 	sink::register(plugin)?;
+	source::register(plugin)?;
+
 	Ok(())
 }
 

justfile

@@ -94,7 +94,7 @@ impl ElementImpl for MoqSink {
 		static ELEMENT_METADATA: Lazy<gst::subclass::ElementMetadata> = Lazy::new(|| {
 			gst::subclass::ElementMetadata::new(
 				"MoQ Sink",
-				"Sink",
+				"Sink/Network/MoQ",
 				"Transmits media over the network via MoQ",
 				"Luke Curley <kixelated@gmail.com>",
 			)

src/lib.rs

@@ -8,6 +8,5 @@ glib::wrapper! {
 }
 
 pub fn register(plugin: &gst::Plugin) -> Result<(), glib::BoolError> {
-	env_logger::init();
 	gst::Element::register(Some(plugin), "moqsink", gst::Rank::NONE, MoqSink::static_type())
 }