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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
use std::sync::Arc;

use thiserror::Error;
use tokio::{
    select,
    sync::{broadcast, mpsc, oneshot},
};

use crate::{
    api::types::PriorityInfo,
    global::{Event, Global, InputMessage, InstanceEventKind},
    models::{Color, InstanceConfig},
    servers::{self, ServerHandle},
};

mod black_border_detector;
use black_border_detector::*;

mod core;
use self::core::*;

mod device;
use device::*;

mod muxer;
pub use muxer::StartEffectError;
use muxer::*;

mod smoothing;
use smoothing::*;

#[derive(Debug, Error)]
pub enum InstanceError {
    #[error("i/o error: {0}")]
    Io(#[from] std::io::Error),
    #[error("device error: {0}")]
    Device(#[from] DeviceError),
    #[error("recv error: {0}")]
    Recv(#[from] broadcast::error::RecvError),
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum ActiveState {
    Inactive,
    Active,
    Deactivating,
}

impl Default for ActiveState {
    fn default() -> Self {
        Self::Inactive
    }
}

pub struct Instance {
    config: Arc<InstanceConfig>,
    device: InstanceDevice,
    handle_rx: mpsc::Receiver<InstanceMessage>,
    receiver: broadcast::Receiver<InputMessage>,
    local_receiver: mpsc::Receiver<InputMessage>,
    event_tx: broadcast::Sender<Event>,
    muxer: PriorityMuxer,
    core: Core,
    _boblight_server: Option<Result<ServerHandle, std::io::Error>>,
    active_state: ActiveState,
}

impl Instance {
    pub async fn new(global: Global, config: InstanceConfig) -> (Self, InstanceHandle) {
        let device: InstanceDevice =
            Device::new(&config.instance.friendly_name, config.device.clone())
                .await
                .into();

        let led_count = config.leds.leds.len();

        if let Err(error) = &device.inner {
            error!(
                instance = %config.instance.id,
                name = %config.instance.friendly_name,
                error = %error,
                "initializing instance failed"
            );
        }

        let receiver = global.subscribe_input().await;
        let (local_tx, local_receiver) = mpsc::channel(4);

        let muxer = PriorityMuxer::new(global.clone(), MuxerConfig { led_count }).await;
        let core = Core::new(&config).await;

        let (tx, handle_rx) = mpsc::channel(1);
        let id = config.instance.id;
        let handle = InstanceHandle { id, tx, local_tx };

        let config = Arc::new(config);
        let _boblight_server = if config.boblight_server.enable {
            let server_handle = servers::bind(
                "Boblight",
                config.boblight_server.clone(),
                global.clone(),
                {
                    let handle = handle.clone();

                    move |tcp, global| {
                        servers::boblight::handle_client(tcp, led_count, handle.clone(), global)
                    }
                },
            )
            .await;

            if let Err(error) = &server_handle {
                error!(
                    instance = %config.instance.id,
                    name = %config.instance.friendly_name,
                    error = %error,
                    "cannot start Boblight server"
                );
            }

            Some(server_handle)
        } else {
            None
        };

        let event_tx = global.get_event_tx().await;

        (
            Self {
                config,
                device,
                handle_rx,
                receiver,
                local_receiver,
                event_tx,
                muxer,
                core,
                _boblight_server,
                active_state: ActiveState::default(),
            },
            handle,
        )
    }

    async fn on_input_message(&mut self, message: InputMessage) {
        if let Some(message) = self.muxer.handle_message(message).await {
            // The message triggered a muxing update
            self.on_muxed_message(message);
        }
    }

    fn on_muxed_message(&mut self, message: MuxedMessage) {
        if self.active_state == ActiveState::Active {
            if message.priority() == muxer::MAX_PRIORITY
                && message.color() == Some(Color::new(0, 0, 0))
            {
                self.active_state = ActiveState::Deactivating;
            }
        } else if (message.priority() != muxer::MAX_PRIORITY
            || message.color() != Some(Color::new(0, 0, 0)))
            && std::mem::replace(&mut self.active_state, ActiveState::Active)
                == ActiveState::Inactive
        {
            self.event_tx
                .send(Event::instance(self.id(), InstanceEventKind::Activate))
                .unwrap();
        }

        self.core.handle_message(message);
    }

    pub fn id(&self) -> i32 {
        self.config.instance.id
    }

    async fn handle_instance_message(&mut self, message: InstanceMessage) -> InstanceControl {
        // ok: the instance shouldn't care if the receiver dropped

        match message {
            InstanceMessage::PriorityInfo(tx) => {
                tx.send(self.muxer.current_priorities().await).ok();
            }
            InstanceMessage::Config(tx) => {
                tx.send(self.config.clone()).ok();
            }
            InstanceMessage::Stop(tx) => {
                tx.send(()).ok();
                return InstanceControl::Break;
            }
        }

        InstanceControl::Continue
    }

    #[instrument]
    pub async fn run(mut self) -> Result<(), InstanceError> {
        loop {
            select! {
                update = self.device.update() => {
                    trace!("device update");

                    if let Err(error) = update {
                        // A device update shouldn't error, disable it
                        error!(error = %error, "device update failed, disabling device");
                        self.device.inner = Err(error);
                    }
                },
                message = self.receiver.recv() => {
                    trace!(message = ?message, "global msg");

                    match message {
                        Ok(message) => {
                            self.on_input_message(message).await;
                        },
                        Err(tokio::sync::broadcast::error::RecvError::Closed) => {
                            // No more input messages
                            break Ok(());
                        },
                        Err(tokio::sync::broadcast::error::RecvError::Lagged(skipped)) => {
                            warn!(skipped = %skipped, "skipped input messages");
                        },
                    }
                },
                message = self.local_receiver.recv() => {
                    trace!(message = ?message, "local msg");

                    if let Some(message) = message {
                        self.on_input_message(message).await;
                    } else {
                        break Ok(());
                    }
                },
                message = self.muxer.update() => {
                    trace!(message = ?message, "muxer msg");

                    // Muxer update completed
                    if let Some(message) = message {
                        self.on_muxed_message(message);
                    }
                },
                (led_data, update) = self.core.update() => {
                    trace!("core update");

                    // LED data changed
                    self.device.set_led_data(led_data).await?;

                    if update == SmoothingUpdate::Settled &&
                        self.active_state == ActiveState::Deactivating {
                        self.active_state = ActiveState::Inactive;
                        self.event_tx
                            .send(Event::instance(self.id(), InstanceEventKind::Deactivate))
                            .unwrap();
                    }
                },
                message = self.handle_rx.recv() => {
                    trace!(message = ?message, "handle_rx msg");

                    if let Some(message) = message {
                        if InstanceControl::Break == self.handle_instance_message(message).await {
                            break Ok(());
                        }
                    } else {
                        // If the handle is dropped, it means the instance was unregistered
                        break Ok(());
                    }
                }
            }
        }
    }
}

impl std::fmt::Debug for Instance {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("Instance").field("id", &self.id()).finish()
    }
}

/// A wrapper for a device that may have failed initializing
struct InstanceDevice {
    inner: Result<Device, DeviceError>,
}

impl InstanceDevice {
    async fn update(&mut self) -> Result<(), DeviceError> {
        if let Ok(device) = &mut self.inner {
            device.update().await
        } else {
            futures::future::pending::<()>().await;
            Ok(())
        }
    }

    async fn set_led_data(&mut self, led_data: &[Color]) -> Result<(), DeviceError> {
        if let Ok(device) = &mut self.inner {
            device.set_led_data(led_data).await
        } else {
            Ok(())
        }
    }
}

impl From<Result<Device, DeviceError>> for InstanceDevice {
    fn from(inner: Result<Device, DeviceError>) -> Self {
        Self { inner }
    }
}

#[derive(Debug, Clone, Copy, PartialEq)]
enum InstanceControl {
    Continue,
    Break,
}

#[derive(Debug)]
enum InstanceMessage {
    PriorityInfo(oneshot::Sender<Vec<PriorityInfo>>),
    Config(oneshot::Sender<Arc<InstanceConfig>>),
    Stop(oneshot::Sender<()>),
}

#[derive(Clone)]
pub struct InstanceHandle {
    id: i32,
    tx: mpsc::Sender<InstanceMessage>,
    local_tx: mpsc::Sender<InputMessage>,
}

#[derive(Debug, Error)]
pub enum InstanceHandleError {
    #[error("the corresponding instance is no longer running")]
    Dropped,
}

impl<T> From<tokio::sync::mpsc::error::SendError<T>> for InstanceHandleError {
    fn from(_: tokio::sync::mpsc::error::SendError<T>) -> Self {
        Self::Dropped
    }
}

impl From<tokio::sync::oneshot::error::RecvError> for InstanceHandleError {
    fn from(_: tokio::sync::oneshot::error::RecvError) -> Self {
        Self::Dropped
    }
}

impl InstanceHandle {
    pub fn id(&self) -> i32 {
        self.id
    }

    pub fn input_channel(&self) -> &mpsc::Sender<InputMessage> {
        &self.local_tx
    }

    pub async fn send(&self, input: InputMessage) -> Result<(), InstanceHandleError> {
        Ok(self.local_tx.send(input).await?)
    }

    pub async fn current_priorities(&self) -> Result<Vec<PriorityInfo>, InstanceHandleError> {
        let (tx, rx) = oneshot::channel();
        self.tx.send(InstanceMessage::PriorityInfo(tx)).await?;
        Ok(rx.await?)
    }

    pub async fn config(&self) -> Result<Arc<InstanceConfig>, InstanceHandleError> {
        let (tx, rx) = oneshot::channel();
        self.tx.send(InstanceMessage::Config(tx)).await?;
        Ok(rx.await?)
    }

    pub async fn stop(&self) -> Result<(), InstanceHandleError> {
        let (tx, rx) = oneshot::channel();
        self.tx.send(InstanceMessage::Stop(tx)).await?;
        Ok(rx.await?)
    }
}