Merge pull request #338 from RidgeRun/feature/add-rust-api

Add Rust client library for GstD with examples

Author: lmerayo1

.gitignore

@@ -38,6 +38,7 @@ autoregen.sh
 # debian files
 *.deb
 *.build
+!**/meson.build
 *.buildinfo
 *.changes
 debian/.debhelper/

Cargo.lock

@@ -0,0 +1,5 @@
+[workspace]
+members = [
+    "libgstc/rust/gstc",
+]
+resolver = "2"

Cargo.toml

@@ -0,0 +1,67 @@
+# Rust `libgstc` Examples
+
+These examples show how to control GStreamer Daemon (`gstd`) using the Rust `gstc` client library.
+
+## Prerequisites
+
+- `gstd` must be running and listening on `127.0.0.1:5000`
+- Rust examples assume the daemon is reachable at that address and port
+- Some examples require GStreamer plugins such as `autovideosink`, `playbin`, `qtmux`, `avenc_mpeg4`, and `lamemp3enc`
+
+## How to Build
+To build the examples, run the following command from the repository root:
+```bash
+cargo build --examples
+```
+The examples will be available at the following path:
+ ```bash
+target/debug/examples/
+```
+
+## How To Run
+
+You can run the examples directly as an executable or
+with Cargo from the Repository root:
+
+```bash
+cargo run --example simple_pipeline
+```
+
+Examples that take an argument can be run like this:
+
+```bash
+cargo run --example gapless_playback -- /path/to/video.mp4
+```
+
+## Examples
+
+### `simple_pipeline`
+
+Creates a `videotestsrc ! autovideosink` pipeline, starts playback, waits for Enter, then stops and deletes the pipeline.
+
+### `pipeline_lifecycle`
+
+Creates a `videotestsrc ! fakesink` pipeline, sets it to `PLAYING`, polls until the daemon reports the expected state, then stops and deletes the pipeline.
+
+### `wait_on_bus`
+
+Creates a finite pipeline with `videotestsrc num-buffers=300`, waits for an EOS message on the bus, prints the raw bus message, then cleans up the pipeline.
+
+### `dynamic_property_change`
+
+Creates a `videotestsrc` pipeline and changes the `pattern` property once per second while the pipeline is running. Press Enter to stop it.
+
+### `gapless_playback`
+
+Plays a media file with `playbin`, waits for EOS, then seeks back to the start to continue playback. Press Enter to stop it.
+
+Run with:
+
+```bash
+cargo run --example gapless_playback -- /path/to/video.mp4
+```
+
+### `mp4_recording`
+
+Creates a live audio/video recording pipeline that writes to `mp4_recording.mp4`. When you press Enter, it injects EOS, waits for the EOS bus message, then stops and deletes the pipeline.
+

examples/libgstc/rust/README.md

@@ -0,0 +1,65 @@
+/*
+ * This file is part of GStreamer Daemon
+ * Copyright 2015-2026 RidgeRun, LLC (http://www.ridgerun.com)
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ */
+
+use gstc::{Client, Status};
+use std::io;
+use std::sync::atomic::{AtomicBool, Ordering};
+use std::sync::Arc;
+use std::thread;
+use std::time::Duration;
+
+fn main() -> Result<(), Status> {
+    let client = Client::new("127.0.0.1", 5000, -1, true)?;
+
+    client.pipeline_create("pipe", "videotestsrc name=vts ! autovideosink")?;
+    println!("Pipeline created successfully!");
+
+    client.pipeline_play("pipe")?;
+    println!("Pipeline set to playing!");
+
+    println!("Press enter to stop the pipeline...");
+    let stop_flag = Arc::new(AtomicBool::new(false));
+    let thread_stop_flag = Arc::clone(&stop_flag);
+    thread::spawn(move || {
+        let mut line = String::new();
+        let _ = io::stdin().read_line(&mut line);
+        thread_stop_flag.store(true, Ordering::Relaxed);
+    });
+
+    let mut format = 0;
+    loop {
+        client.element_set("pipe", "vts", "pattern", &format.to_string())?;
+        format = (format + 1) % 10;
+
+        if stop_flag.load(Ordering::Relaxed) {
+            break;
+        }
+
+        thread::sleep(Duration::from_secs(1));
+    }
+
+    client.pipeline_stop("pipe")?;
+    println!("Pipeline set to null!");
+
+    client.pipeline_delete("pipe")?;
+    println!("Pipeline deleted!");
+
+    Ok(())
+}

examples/libgstc/rust/dynamic_property_change_rust.rs

@@ -0,0 +1,90 @@
+/*
+ * This file is part of GStreamer Daemon
+ * Copyright 2015-2026 RidgeRun, LLC (http://www.ridgerun.com)
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ */
+
+use gstc::{Client, Status};
+use std::env;
+use std::io;
+use std::path::PathBuf;
+use std::sync::atomic::{AtomicBool, Ordering};
+use std::sync::Arc;
+use std::thread;
+
+const RATE: f64 = 1.0;
+const FORMAT: i32 = 3;
+const FLAGS: i32 = 1;
+const START_TYPE: i32 = 1;
+const START: i64 = 0;
+const STOP_TYPE: i32 = 1;
+const STOP: i64 = -1;
+
+fn main() -> Result<(), Status> {
+    let video = match env::args().nth(1) {
+        Some(path) => path,
+        None => {
+            eprintln!("Please provide a video to play");
+            return Err(Status::NullArgument);
+        }
+    };
+
+    let abs_path = PathBuf::from(&video)
+        .canonicalize()
+        .unwrap_or_else(|_| PathBuf::from(&video));
+    let uri = format!("file://{}", abs_path.display());
+
+    let client = Client::new("127.0.0.1", 5000, -1, true)?;
+
+    client.pipeline_create("pipe", &format!("playbin uri={}", uri))?;
+    println!("Pipeline created successfully!");
+
+    client.pipeline_play("pipe")?;
+    println!("Pipeline set to playing!");
+
+    println!("Press enter to stop the pipeline...");
+    let stop_flag = Arc::new(AtomicBool::new(false));
+    let thread_stop_flag = Arc::clone(&stop_flag);
+    thread::spawn(move || {
+        let mut line = String::new();
+        let _ = io::stdin().read_line(&mut line);
+        thread_stop_flag.store(true, Ordering::Relaxed);
+    });
+
+    while !stop_flag.load(Ordering::Relaxed) {
+        let message = client.pipeline_bus_wait("pipe", "eos", -1)?;
+        if message.status != Status::Ok {
+            eprintln!("Unable to read from bus: {}", message.status.code());
+            break;
+        }
+
+        println!("EOS message received!");
+
+        client.pipeline_seek(
+            "pipe", RATE, FORMAT, FLAGS, START_TYPE, START, STOP_TYPE, STOP,
+        )?;
+        println!("Pipeline reset!");
+    }
+
+    client.pipeline_stop("pipe")?;
+    println!("Pipeline set to null!");
+
+    client.pipeline_delete("pipe")?;
+    println!("Pipeline deleted!");
+
+    Ok(())
+}