Use libwebrtc's DesktopCapturer for screen capture

This adds support for screen sharing on Wayland (fixes #28754).

libwebrtc replaces scap, which aims to be cross platform but was
only used on Windows and X11. The X11 support relied on an out-of-tree
branch on which the original author closed their own pull request
(CapSoftware/scap#124). This also replaces
Zed's platform-specific code on macOS. Switching to a single
cross platform library simplifies the code by removing the need
for Zed to have its own traits for cross platform abstraction.

Author: Be-ing

Cargo.lock

@@ -460,7 +460,7 @@ async-recursion = "1.0.0"
 async-tar = "0.5.1"
 async-task = "4.7"
 async-trait = "0.1"
-async-tungstenite = "0.31.0"
+async-tungstenite = "0.32.0"
 async_zip = { version = "0.0.17", features = ["deflate", "deflate64"] }
 aws-config = { version = "1.6.1", features = ["behavior-version-latest"] }
 aws-credential-types = { version = "1.2.2", features = [
@@ -539,6 +539,10 @@ jupyter-websocket-client = "0.15.0"
 libc = "0.2"
 libsqlite3-sys = { version = "0.30.1", features = ["bundled"] }
 linkify = "0.10.0"
+libwebrtc = { branch = "zed", git = "https://github.com/Be-ing/rust-sdks" }
+livekit = { branch = "zed", git = "https://github.com/Be-ing/rust-sdks", features = [
+    "__rustls-tls"
+] }
 log = { version = "0.4.16", features = ["kv_unstable_serde", "serde"] }
 lsp-types = { git = "https://github.com/zed-industries/lsp-types", rev = "b71ab4eeb27d9758be8092020a46fe33fbca4e33" }
 mach2 = "0.5"
@@ -670,7 +674,7 @@ time = { version = "0.3", features = [
 ] }
 tiny_http = "0.8"
 tokio = { version = "1" }
-tokio-tungstenite = { version = "0.26", features = ["__rustls-tls"] }
+tokio-tungstenite = { version = "0.28", features = ["__rustls-tls"] }
 toml = "0.8"
 toml_edit = { version = "0.22", default-features = false, features = ["display", "parse", "serde"] }
 tower-http = "0.4.4"

Cargo.toml

@@ -29,4 +29,4 @@ thiserror.workspace = true
 util.workspace = true
 
 [target.'cfg(not(any(all(target_os = "windows", target_env = "gnu"), target_os = "freebsd")))'.dependencies]
-libwebrtc = { rev = "5f04705ac3f356350ae31534ffbc476abc9ea83d", git = "https://github.com/zed-industries/livekit-rust-sdks" }
+libwebrtc = { workspace = true }

crates/audio/Cargo.toml

@@ -32,6 +32,7 @@ futures.workspace = true
 feature_flags.workspace = true
 gpui = { workspace = true, features = ["screen-capture"] }
 language.workspace = true
+libwebrtc.workspace = true
 log.workspace = true
 postage.workspace = true
 project.workspace = true

crates/call/Cargo.toml

@@ -13,13 +13,14 @@ use feature_flags::FeatureFlagAppExt;
 use fs::Fs;
 use futures::StreamExt;
 use gpui::{
-    App, AppContext as _, AsyncApp, Context, Entity, EventEmitter, FutureExt as _,
-    ScreenCaptureSource, ScreenCaptureStream, Task, Timeout, WeakEntity,
+    App, AppContext as _, AsyncApp, Context, Entity, EventEmitter, FutureExt as _, Task, Timeout,
+    WeakEntity,
 };
 use gpui_tokio::Tokio;
 use language::LanguageRegistry;
+use libwebrtc::desktop_capturer::CaptureSource;
 use livekit::{LocalTrackPublication, ParticipantIdentity, RoomEvent};
-use livekit_client::{self as livekit, AudioStream, TrackSid};
+use livekit_client::{self as livekit, AudioStream, ScreenCaptureStreamHandle, TrackSid};
 use postage::{sink::Sink, stream::Stream, watch};
 use project::Project;
 use settings::Settings as _;
@@ -1267,9 +1268,7 @@ impl Room {
 
     pub fn shared_screen_id(&self) -> Option<u64> {
         self.live_kit.as_ref().and_then(|lk| match lk.screen_track {
-            LocalTrack::Published { ref _stream, .. } => {
-                _stream.metadata().ok().map(|meta| meta.id)
-            }
+            LocalTrack::Published { ref _stream, .. } => Some(_stream.screen_id),
             _ => None,
         })
     }
@@ -1398,7 +1397,7 @@ impl Room {
 
     pub fn share_screen(
         &mut self,
-        source: Rc<dyn ScreenCaptureSource>,
+        source: CaptureSource,
         cx: &mut Context<Self>,
     ) -> Task<Result<()>> {
         if self.status.is_offline() {
@@ -1418,7 +1417,7 @@ impl Room {
         };
 
         cx.spawn(async move |this, cx| {
-            let publication = participant.publish_screenshare_track(&*source, cx).await;
+            let publication = participant.publish_screenshare_track(source, cx).await;
 
             this.update(cx, |this, cx| {
                 let live_kit = this
@@ -1445,7 +1444,7 @@ impl Room {
                         } else {
                             live_kit.screen_track = LocalTrack::Published {
                                 track_publication: publication,
-                                _stream: stream,
+                                _stream: Box::new(stream),
                             };
                             cx.notify();
                         }
@@ -1644,7 +1643,7 @@ fn spawn_room_connection(
 
 struct LiveKitRoom {
     room: Rc<livekit::Room>,
-    screen_track: LocalTrack<dyn ScreenCaptureStream>,
+    screen_track: LocalTrack<ScreenCaptureStreamHandle>,
     microphone_track: LocalTrack<AudioStream>,
     /// Tracks whether we're currently in a muted state due to auto-mute from deafening or manual mute performed by user.
     muted_by_user: bool,

crates/call/src/call_impl/room.rs

@@ -41,6 +41,7 @@ futures.workspace = true
 fuzzy.workspace = true
 gpui.workspace = true
 log.workspace = true
+livekit_client.workspace = true
 menu.workspace = true
 notifications.workspace = true
 picker.workspace = true

crates/collab_ui/Cargo.toml

@@ -19,6 +19,7 @@ use gpui::{
     Render, SharedString, Styled, Subscription, Task, TextStyle, WeakEntity, Window, actions,
     anchored, canvas, deferred, div, fill, list, point, prelude::*, px,
 };
+use livekit_client::screen_capture_sources;
 use menu::{Cancel, Confirm, SecondaryConfirm, SelectNext, SelectPrevious};
 use project::{Fs, Project};
 use rpc::{
@@ -152,10 +153,8 @@ pub fn init(cx: &mut App) {
                         if room.is_sharing_screen() {
                             room.unshare_screen(true, cx).ok();
                         } else {
-                            let sources = cx.screen_capture_sources();
-
+                            let sources = screen_capture_sources();
                             cx.spawn(async move |room, cx| {
-                                let sources = sources.await??;
                                 let first = sources.into_iter().next();
                                 if let Some(first) = first {
                                     room.update(cx, |room, cx| room.share_screen(first, cx))?

crates/collab_ui/src/collab_panel.rs

@@ -40,8 +40,8 @@ use crate::{
     Keymap, Keystroke, LayoutId, Menu, MenuItem, OwnedMenu, PathPromptOptions, Pixels, Platform,
     PlatformDisplay, PlatformKeyboardLayout, PlatformKeyboardMapper, Point, PromptBuilder,
     PromptButton, PromptHandle, PromptLevel, Render, RenderImage, RenderablePromptHandle,
-    Reservation, ScreenCaptureSource, SharedString, SubscriberSet, Subscription, SvgRenderer, Task,
-    TextSystem, Window, WindowAppearance, WindowHandle, WindowId, WindowInvalidator,
+    Reservation, SharedString, SubscriberSet, Subscription, SvgRenderer, Task, TextSystem, Window,
+    WindowAppearance, WindowHandle, WindowId, WindowInvalidator,
     colors::{Colors, GlobalColors},
     current_platform, hash, init_app_menus,
 };
@@ -1031,13 +1031,6 @@ impl App {
         self.platform.is_screen_capture_supported()
     }
 
-    /// Returns a list of available screen capture sources.
-    pub fn screen_capture_sources(
-        &self,
-    ) -> oneshot::Receiver<Result<Vec<Rc<dyn ScreenCaptureSource>>>> {
-        self.platform.screen_capture_sources()
-    }
-
     /// Returns the display with the given ID, if one exists.
     pub fn find_display(&self, id: DisplayId) -> Option<Rc<dyn PlatformDisplay>> {
         self.displays()

crates/gpui/src/app.rs

@@ -23,18 +23,6 @@ mod test;
 #[cfg(target_os = "windows")]
 mod windows;
 
-#[cfg(all(
-    feature = "screen-capture",
-    any(
-        target_os = "windows",
-        all(
-            any(target_os = "linux", target_os = "freebsd"),
-            any(feature = "wayland", feature = "x11"),
-        )
-    )
-))]
-pub(crate) mod scap_screen_capture;
-
 use crate::{
     Action, AnyWindowHandle, App, AsyncWindowContext, BackgroundExecutor, Bounds,
     DEFAULT_WINDOW_SIZE, DevicePixels, DispatchEventResult, Font, FontId, FontMetrics, FontRun,
@@ -189,21 +177,6 @@ pub(crate) trait Platform: 'static {
     fn is_screen_capture_supported(&self) -> bool {
         false
     }
-    #[cfg(feature = "screen-capture")]
-    fn screen_capture_sources(&self)
-    -> oneshot::Receiver<Result<Vec<Rc<dyn ScreenCaptureSource>>>>;
-    #[cfg(not(feature = "screen-capture"))]
-    fn screen_capture_sources(
-        &self,
-    ) -> oneshot::Receiver<anyhow::Result<Vec<Rc<dyn ScreenCaptureSource>>>> {
-        let (sources_tx, sources_rx) = oneshot::channel();
-        sources_tx
-            .send(Err(anyhow::anyhow!(
-                "gpui was compiled without the screen-capture feature"
-            )))
-            .ok();
-        sources_rx
-    }
 
     fn open_window(
         &self,
@@ -302,42 +275,6 @@ pub trait PlatformDisplay: Send + Sync + Debug {
     }
 }
 
-/// Metadata for a given [ScreenCaptureSource]
-#[derive(Clone)]
-pub struct SourceMetadata {
-    /// Opaque identifier of this screen.
-    pub id: u64,
-    /// Human-readable label for this source.
-    pub label: Option<SharedString>,
-    /// Whether this source is the main display.
-    pub is_main: Option<bool>,
-    /// Video resolution of this source.
-    pub resolution: Size<DevicePixels>,
-}
-
-/// A source of on-screen video content that can be captured.
-pub trait ScreenCaptureSource {
-    /// Returns metadata for this source.
-    fn metadata(&self) -> Result<SourceMetadata>;
-
-    /// Start capture video from this source, invoking the given callback
-    /// with each frame.
-    fn stream(
-        &self,
-        foreground_executor: &ForegroundExecutor,
-        frame_callback: Box<dyn Fn(ScreenCaptureFrame) + Send>,
-    ) -> oneshot::Receiver<Result<Box<dyn ScreenCaptureStream>>>;
-}
-
-/// A video stream captured from a screen.
-pub trait ScreenCaptureStream {
-    /// Returns metadata for this source.
-    fn metadata(&self) -> Result<SourceMetadata>;
-}
-
-/// A frame of video captured from a screen.
-pub struct ScreenCaptureFrame(pub PlatformScreenCaptureFrame);
-
 /// An opaque identifier for a hardware display
 #[derive(PartialEq, Eq, Hash, Copy, Clone)]
 pub struct DisplayId(pub(crate) u32);

crates/gpui/src/platform.rs

@@ -23,10 +23,5 @@ pub(crate) use wayland::*;
 #[cfg(feature = "x11")]
 pub(crate) use x11::*;
 
-#[cfg(all(feature = "screen-capture", any(feature = "wayland", feature = "x11")))]
-pub(crate) type PlatformScreenCaptureFrame = scap::frame::Frame;
-#[cfg(not(all(feature = "screen-capture", any(feature = "wayland", feature = "x11"))))]
-pub(crate) type PlatformScreenCaptureFrame = ();
-
 #[cfg(feature = "wayland")]
 pub use wayland::layer_shell;