scrannotate 0.3.0

Screenshot annotation tool: capture a screen, select, annotate in place, copy or save
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

//! Screen capture: one monitor per shot, raw frames via pinray — no image
//! encoding or disk round trip, so it's fast. Every platform runs the same
//! one-shot session ([`session`]); what differs is how `--screen N` finds
//! its monitor:
//!
//! - Linux ([`screencast`]): the ScreenCast portal never lets an app pick a
//!   monitor programmatically, so slots are *grants* — the first use of
//!   `--screen N` shows the desktop's chooser once and binds the pick to
//!   that number (its own restore token); every later run is instant and
//!   silent. `--pick-screen` re-binds a slot.
//! - macOS/Windows ([`monitor`]): displays are enumerable, so slot N is
//!   simply the Nth display, primary first. `--pick-screen` lists them.
//!
//! The `capture` cargo feature (on by default) carries the pinray
//! dependency — on Linux that means libpipewire-0.3-dev at build time;
//! macOS and Windows need no system packages. Without it only `--from-file`
//! works.

#[cfg(all(feature = "capture", any(target_os = "macos", windows)))]
mod monitor;
#[cfg(all(feature = "capture", target_os = "linux"))]
mod screencast;
#[cfg(all(feature = "capture", any(target_os = "linux", target_os = "macos", windows)))]
mod session;

use anyhow::Result;
use image::RgbaImage;

// Only the stub reads nothing from it in a capture-less dev build.
#[cfg_attr(not(feature = "capture"), allow(dead_code))]
pub struct CaptureOptions {
    /// Include the mouse cursor in the frame.
    pub cursor: bool,
    /// Linux only: re-open the portal's chooser to re-bind this screen
    /// slot. (On macOS/Windows `--pick-screen` is answered in `main` via
    /// [`screen_list`] instead of reaching `capture`.)
    #[cfg_attr(not(target_os = "linux"), allow(dead_code))]
    pub pick_screen: bool,
    /// 1-based screen slot.
    pub screen: u32,
}

/// A captured frame plus — where the platform can know it — the identity of
/// the monitor it came from, so the editor window can open on that monitor.
pub struct Capture {
    pub image: RgbaImage,
    /// `None` on Linux: the portal never says which monitor the user
    /// picked, and the compositor owns window placement there anyway.
    pub display: Option<DisplayInfo>,
}

/// Identity of the captured monitor — exactly what each platform's
/// window-placement matcher needs (`app::ScreencapApp::place_window`).
/// Fieldless on Linux, where it is never constructed.
pub struct DisplayInfo {
    /// macOS: the CGDirectDisplayID as a decimal string, matched against
    /// winit's `MonitorHandle::native_id`.
    #[cfg(target_os = "macos")]
    pub id: String,
    /// Windows: `\\.\DISPLAYn`, matched against winit's
    /// `MonitorHandle::name`.
    #[cfg(windows)]
    pub name: String,
    /// Windows: physical size — the fallback match if names disagree.
    #[cfg(windows)]
    pub width: u32,
    #[cfg(windows)]
    pub height: u32,
}

#[cfg(all(feature = "capture", target_os = "linux"))]
pub fn capture(opts: &CaptureOptions) -> Result<Capture> {
    screencast::capture_screenshot(opts.cursor, opts.pick_screen, opts.screen)
}

#[cfg(all(feature = "capture", any(target_os = "macos", windows)))]
pub fn capture(opts: &CaptureOptions) -> Result<Capture> {
    monitor::capture_screenshot(opts.cursor, opts.screen)
}

#[cfg(not(all(feature = "capture", any(target_os = "linux", target_os = "macos", windows))))]
pub fn capture(_opts: &CaptureOptions) -> Result<Capture> {
    anyhow::bail!(
        "this build has no capture backend (the `capture` feature is off); \
         only --from-file works"
    )
}

/// `--pick-screen` on macOS/Windows: the numbered display list.
#[cfg(all(feature = "capture", any(target_os = "macos", windows)))]
pub fn screen_list() -> Result<String> {
    monitor::screen_list()
}

#[cfg(all(not(feature = "capture"), any(target_os = "macos", windows)))]
pub fn screen_list() -> Result<String> {
    anyhow::bail!("this build has no capture backend (the `capture` feature is off)")
}