add restore token to pipewire capture

Author: kbalt

media-video/capture/src/wayland/mod.rs

@@ -27,16 +27,20 @@ pub struct ScreenCaptureOptions {
     /// Screen capture permission persistence
     pub persist_mode: PersistMode,
 
+    /// Restore token to restore previous capture
+    pub restore_token: Option<String>,
+
     /// Pipewire specific options
     pub pipewire: PipewireOptions,
 }
 
 impl Default for ScreenCaptureOptions {
     fn default() -> Self {
-        Self {
+        ScreenCaptureOptions {
             show_cursor: true,
             source_types: SourceType::all(),
             persist_mode: PersistMode::DoNot,
+            restore_token: None,
             pipewire: PipewireOptions::default(),
         }
     }
@@ -187,6 +191,7 @@ pub struct StreamClosedError;
 /// To properly close a capture stream call [`StreamHandle::close`].
 pub struct StreamHandle {
     session: Session<'static, Screencast<'static>>,
+    restore_token: Option<String>,
     sender: pipewire::channel::Sender<stream::Command>,
 }
 
@@ -226,6 +231,11 @@ impl StreamHandle {
             .send(stream::Command::RemoveModifier(modifier))
             .map_err(|_| StreamClosedError)
     }
+
+    /// Get the restore token
+    pub fn restore_token(&self) -> Option<&str> {
+        self.restore_token.as_deref()
+    }
 }
 
 #[derive(Debug, thiserror::Error)]
@@ -279,13 +289,15 @@ async fn start_screen_capture_boxed(
             cursor_mode,
             options.source_types,
             false,
-            None,
+            options.restore_token.as_deref(),
             options.persist_mode,
         )
         .await?;
 
     let response = proxy.start(&session, None).await?.response()?;
 
+    let restore_token = response.restore_token();
+
     let stream = response
         .streams()
         .first()
@@ -314,5 +326,9 @@ async fn start_screen_capture_boxed(
         .await
         .map_err(|_| StartCaptureError::CaptureThreadPanicked)??;
 
-    Ok(StreamHandle { session, sender })
+    Ok(StreamHandle {
+        session,
+        restore_token: restore_token.map(|s| s.to_owned()),
+        sender,
+    })
 }

media-video/h264/tests/vaenc_pw_capture.rs

@@ -34,6 +34,7 @@ async fn va_encode_memory_inner() {
         show_cursor: true,
         source_types: SourceType::all(),
         persist_mode: PersistMode::DoNot,
+        restore_token: None,
         pipewire: PipewireOptions {
             max_framerate: 30,
             pixel_formats: vec![PixelFormat::RGBA(RgbaSwizzle::BGRA)],

media-video/h264/tests/vkenc_pw_capture.rs

@@ -51,6 +51,7 @@ async fn vk_encode_dma_inner() {
         show_cursor: true,
         source_types: SourceType::all(),
         persist_mode: PersistMode::DoNot,
+        restore_token: None,
         pipewire: PipewireOptions {
             max_framerate: 30,
             pixel_formats: vec![PixelFormat::RGBA(RgbaSwizzle::BGRA)],
@@ -262,6 +263,7 @@ async fn vk_encode_memory_inner() {
         show_cursor: true,
         source_types: SourceType::all(),
         persist_mode: PersistMode::DoNot,
+        restore_token: None,
         pipewire: PipewireOptions {
             max_framerate: 30,
             pixel_formats: vec![PixelFormat::RGBA(RgbaSwizzle::BGRA)],