framewatch 0.6.0

Event-driven, change-triggered window capture that emits timestamped screenshots + metadata for AI agents.
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

//! A sink that forwards owned events to a channel for an embedding host.

use crate::error::SinkError;
use crate::event::CaptureEvent;
use crate::sink::Sink;
use crossbeam_channel::Sender;

/// Forwards each event to a [`crossbeam_channel::Sender`].
///
/// Use the paired [`crossbeam_channel::Receiver`] in your host application.
pub struct ChannelSink {
    tx: Sender<CaptureEvent>,
}

impl ChannelSink {
    /// Wrap a sender.
    pub fn new(tx: Sender<CaptureEvent>) -> Self {
        Self { tx }
    }

    /// Create a bounded channel and return the sink + receiver.
    pub fn bounded(cap: usize) -> (Self, crossbeam_channel::Receiver<CaptureEvent>) {
        let (tx, rx) = crossbeam_channel::bounded(cap);
        (Self { tx }, rx)
    }

    /// Create an unbounded channel and return the sink + receiver.
    pub fn unbounded() -> (Self, crossbeam_channel::Receiver<CaptureEvent>) {
        let (tx, rx) = crossbeam_channel::unbounded();
        (Self { tx }, rx)
    }
}

impl Sink for ChannelSink {
    fn on_event(&mut self, event: &CaptureEvent) -> Result<(), SinkError> {
        self.tx
            .send(event.clone())
            .map_err(|_| SinkError::Disconnected)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::clock::SystemClock;
    use crate::config::{Config, Target};
    use crate::engine::Engine;
    use crate::frame::{RawFrame, WindowInfo};
    use std::time::Instant;

    fn event() -> CaptureEvent {
        let f = RawFrame::from_bgra(
            vec![128u8; 16 * 16 * 4],
            16,
            16,
            Instant::now(),
            chrono::Utc::now(),
            WindowInfo::synthetic("t", 16, 16),
        );
        let cfg = Config::builder()
            .target(Target::ByExe("x".into()))
            .build()
            .unwrap();
        Engine::new(cfg, SystemClock).process(&f, Instant::now())[0].clone()
    }

    #[test]
    fn unbounded_and_bounded_forward_events() {
        let (mut sink, rx) = ChannelSink::unbounded();
        sink.on_event(&event()).unwrap();
        assert!(rx.try_recv().is_ok());

        let (mut sink, rx) = ChannelSink::bounded(4);
        sink.on_event(&event()).unwrap();
        assert_eq!(rx.len(), 1);
    }

    #[test]
    fn new_wraps_an_existing_sender() {
        let (tx, rx) = crossbeam_channel::unbounded();
        let mut sink = ChannelSink::new(tx);
        sink.on_event(&event()).unwrap();
        assert!(rx.try_recv().is_ok());
    }

    #[test]
    fn disconnected_when_receiver_dropped() {
        let (mut sink, rx) = ChannelSink::unbounded();
        drop(rx);
        assert!(matches!(
            sink.on_event(&event()),
            Err(SinkError::Disconnected)
        ));
    }
}