rill-patchbay 0.5.0-beta.5

The world where Automata live - control system for Rill
Documentation 
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

//! # Sensor — external input bridge
//!
//! A `Sensor` converts external data (MIDI, OSC, hardware knobs, signal analysis)
//! into [`ControlEvent`](crate::sensor::ControlEvent)s that can be mapped through
//! [`ParameterMapping`](crate::sensor::ParameterMapping) to graph parameters.
//!
//! ## Available sensor types
//!
//! - [`midi`] — MIDI controller and note sensors
//! - [`osc`] — OSC address-based sensors
//! - [`hearing`] — signal analysis algorithms (pitch, envelope, zero-crossing)
//!   for acoustic sensors that react to graph signal output.
//!
//! Multiple sensors can run independently — all events share a single
//! mailbox drained by [`Patchbay::drain_events`].

pub mod hearing;

use rill_core_actor::ActorRef;

use crate::engine::{ControlEvent, Module};

/// External input that produces [`ControlEvent`]s and dispatches them
/// via a shared [`ActorRef`].
///
/// `Sensor` extends [`Module`] so every sensor is also a rack module.
pub trait Sensor: Module {
    /// Attach the sensor to an event sink.
    ///
    /// Called before [`start`](Self::start). The sensor stores the
    /// [`ActorRef`] and uses it to send events during its lifetime.
    fn attach(&mut self, events: ActorRef<ControlEvent>);

    /// Start the sensor (begin polling, open device, spawn thread, etc.).
    fn start(&mut self);
}