From 2ead28defe954d6d45b0a6c450dedcaca00c7d67 Mon Sep 17 00:00:00 2001
From: Jan Schmidt <jan@centricular.com>
Date: Wed, 19 Aug 2020 23:15:36 +1000
Subject: [PATCH] examples: Add an example of using the debug ringbuffer

A simple example of using the GStreamer debug ringbuffer to only
dump logs on a specific event (in this case EOS).
---
 examples/Cargo.toml                  |  3 +
 examples/src/bin/debug_ringbuffer.rs | 86 ++++++++++++++++++++++++++++
 2 files changed, 89 insertions(+)
 create mode 100644 examples/src/bin/debug_ringbuffer.rs

diff --git a/examples/Cargo.toml b/examples/Cargo.toml
index d96f95c18..ffa0276b3 100644
--- a/examples/Cargo.toml
+++ b/examples/Cargo.toml
@@ -73,6 +73,9 @@ name = "custom_meta"
 [[bin]]
 name = "decodebin"
 
+[[bin]]
+name = "debug_ringbuffer"
+
 [[bin]]
 name = "encodebin"
 
diff --git a/examples/src/bin/debug_ringbuffer.rs b/examples/src/bin/debug_ringbuffer.rs
new file mode 100644
index 000000000..f13038698
--- /dev/null
+++ b/examples/src/bin/debug_ringbuffer.rs
@@ -0,0 +1,86 @@
+// This example shows how to use the debug ringbuffer.
+//
+// It runs a simple GStreamer pipeline for a short time,
+// and on EOS it dumps the last few KB of debug logs.
+//
+// It's possible to dump the logs at any time in an application,
+// not just on exit like is done here.
+extern crate gstreamer as gst;
+use gst::prelude::*;
+
+use std::process;
+
+#[path = "../examples-common.rs"]
+mod examples_common;
+
+fn example_main() {
+    let pipeline_str = "videotestsrc num-buffers=100 ! autovideosink";
+
+    gst::init().unwrap();
+
+    /* Disable stdout debug, then configure the debug ringbuffer and enable
+     * all debug */
+    gst::debug_remove_default_log_function();
+    /* Keep 1KB of logs per thread, removing old threads after 10 seconds */
+    gst::debug_add_ring_buffer_logger(1024, 10);
+    /* Enable all debug categories */
+    gst::debug_set_default_threshold(gst::DebugLevel::Log);
+
+    let mut context = gst::ParseContext::new();
+    let pipeline =
+        match gst::parse_launch_full(&pipeline_str, Some(&mut context), gst::ParseFlags::empty()) {
+            Ok(pipeline) => pipeline,
+            Err(err) => {
+                if let Some(gst::ParseError::NoSuchElement) = err.kind::<gst::ParseError>() {
+                    println!("Missing element(s): {:?}", context.get_missing_elements());
+                } else {
+                    println!("Failed to parse pipeline: {}", err);
+                }
+
+                process::exit(-1)
+            }
+        };
+    let bus = pipeline.get_bus().unwrap();
+
+    pipeline
+        .set_state(gst::State::Playing)
+        .expect("Unable to set the pipeline to the `Playing` state");
+
+    for msg in bus.iter_timed(gst::CLOCK_TIME_NONE) {
+        use gst::MessageView;
+
+        match msg.view() {
+            MessageView::Eos(..) => {
+                break;
+            }
+            MessageView::Error(err) => {
+                println!(
+                    "Error from {:?}: {} ({:?})",
+                    err.get_src().map(|s| s.get_path_string()),
+                    err.get_error(),
+                    err.get_debug()
+                );
+                break;
+            }
+            _ => (),
+        }
+    }
+
+    pipeline
+        .set_state(gst::State::Null)
+        .expect("Unable to set the pipeline to the `Null` state");
+
+    /* Insert a message into the debug log */
+    gst::gst_error!(gst::CAT_DEFAULT, "Hi from the debug log ringbuffer example");
+
+    println!("Dumping debug logs\n");
+    for s in gst::debug_ring_buffer_logger_get_logs().iter() {
+        println!("{}\n------------------", s);
+    }
+}
+
+fn main() {
+    // tutorials_common::run is only required to set up the application environent on macOS
+    // (but not necessary in normal Cocoa applications where this is set up autmatically)
+    examples_common::run(example_main);
+}