firefly_hal/

hosted.rs

use crate::gamepad::GamepadManager;
use crate::*;
use alloc::boxed::Box;
use core::cell::Cell;
use core::fmt::Display;
use core::marker::PhantomData;
use core::net::{IpAddr, Ipv4Addr, SocketAddr};
use std::io::{Read, Write};
use std::net::{SocketAddrV4, TcpListener, TcpStream, UdpSocket};
use std::path::PathBuf;
use std::sync::mpsc;

const UDP_PORT_MIN: u16 = 3110;
const UDP_PORT_MAX: u16 = 3117;
const TCP_PORT_MIN: u16 = 3210;
const TCP_PORT_MAX: u16 = 3217;
const AUDIO_BUF_SIZE: usize = SAMPLE_RATE as usize / 6;

#[derive(Clone)]
pub struct DeviceConfig {
    /// The full path to the VFS.
    pub root: PathBuf,

    /// The TCP IP address where to listen for serial events.
    pub tcp_ip: IpAddr,

    /// The UDP IP address where to listen for netplay events.
    pub udp_ip: IpAddr,

    /// The UDP IP addresses where to send netplay advertisements.
    pub peers: Vec<IpAddr>,

    /// If provided, the path where to save the audio output (as a WAV file).
    pub wav: Option<PathBuf>,
}

impl Default for DeviceConfig {
    fn default() -> Self {
        let localhost = IpAddr::V4(Ipv4Addr::LOCALHOST);
        Self {
            root: PathBuf::new(),
            tcp_ip: localhost,
            udp_ip: localhost,
            peers: vec![localhost],
            wav: None,
        }
    }
}

pub struct DeviceImpl<'a> {
    config: DeviceConfig,
    /// The time at which the device instance was created.
    start: std::time::Instant,
    /// The shared logic for reading the gamepad input.
    gamepad: GamepadManager,
    /// The audio buffer
    audio: Option<AudioWriter>,
    wifi_status: u8,
    network: NetworkImpl<'a>,
    serial: SerialImpl,
    tcp_conn: Option<TcpStream>,
}

impl<'a> DeviceImpl<'a> {
    pub fn new(config: DeviceConfig) -> Self {
        #[cfg(not(target_os = "android"))]
        let audio = start_audio(&config);
        #[cfg(target_os = "android")]
        let audio = None;
        Self {
            start: std::time::Instant::now(),
            gamepad: GamepadManager::new(),
            audio,
            config,
            wifi_status: 2,
            network: NetworkImpl::new(),
            serial: SerialImpl::new(),
            tcp_conn: None,
        }
    }

    /// Called by the GUI to set input from UI and keyboard.
    pub fn update_input(&mut self, input: InputState) {
        self.gamepad.update_input(input)
    }

    pub fn alloc_psram(&self, size: usize) -> Vec<u8> {
        Vec::with_capacity(size)
    }
}

impl<'a> Device for DeviceImpl<'a> {
    type Dir = DirImpl;

    fn now(&self) -> Instant {
        let now = std::time::Instant::now();
        let dur = now.duration_since(self.start);
        Instant {
            us: dur.as_micros() as u32,
        }
    }

    fn delay(&self, d: Duration) {
        let dur = core::time::Duration::from_micros(d.us as u64);
        std::thread::sleep(dur);
    }

    fn read_input(&mut self) -> Option<InputState> {
        self.gamepad.read_input()
    }

    fn log_debug<D: Display>(&mut self, src: &str, msg: D) {
        println!("DEBUG({src}): {msg}");
    }

    fn log_error<D: Display>(&mut self, src: &str, msg: D) {
        eprintln!("ERROR({src}): {msg}");
    }

    fn random(&mut self) -> u32 {
        rand::random()
    }

    fn open_dir(&mut self, path: &[&str]) -> Result<Self::Dir, FSError> {
        let path: PathBuf = path.iter().collect();
        let path = self.config.root.join(path);
        if !path.exists() {
            return Err(FSError::NotFound);
        }
        if !path.is_dir() {
            return Err(FSError::OpenedFileAsDir);
        }
        Ok(DirImpl { path })
    }

    fn has_headphones(&mut self) -> bool {
        false
    }

    fn get_audio_buffer(&mut self) -> &mut [i16] {
        match &mut self.audio {
            Some(audio) => audio.get_write_buf(),
            None => &mut [][..],
        }
    }

    #[cfg(target_os = "android")]
    fn get_battery_status(&mut self) -> Option<BatteryStatus> {
        None
    }

    #[cfg(not(target_os = "android"))]
    fn get_battery_status(&mut self) -> Option<BatteryStatus> {
        use battery::units::electric_potential::microvolt;
        let manager = battery::Manager::new().ok()?;
        let mut batteries = manager.batteries().ok()?;
        let battery = batteries.next()?;
        let battery = battery.ok()?;
        let state = battery.state();
        let voltage = battery.voltage().get::<microvolt>();
        Some(BatteryStatus {
            voltage: voltage as u16,
            connected: state == battery::State::Charging,
            full: state == battery::State::Full,
        })
    }
}

pub struct DirImpl {
    path: PathBuf,
}

impl Dir for DirImpl {
    type Read = File;
    type Write = File;

    fn open_file(&mut self, name: &str) -> Result<Self::Read, FSError> {
        let path = self.path.join(name);
        let file = std::fs::File::open(path)?;
        Ok(File { file })
    }

    fn create_file(&mut self, name: &str) -> Result<Self::Write, FSError> {
        let path = self.path.join(name);
        if let Some(parent) = path.parent() {
            _ = std::fs::create_dir_all(parent);
        }
        let file = std::fs::File::create(path)?;
        Ok(File { file })
    }

    fn append_file(&mut self, name: &str) -> Result<Self::Write, FSError> {
        let path = self.path.join(name);
        let mut opts = std::fs::OpenOptions::new();
        let file = opts.append(true).open(path)?;
        Ok(File { file })
    }

    fn get_file_size(&mut self, name: &str) -> Result<u32, FSError> {
        let path = self.path.join(name);
        let meta = std::fs::metadata(path)?;
        Ok(meta.len() as u32)
    }

    fn remove_file(&mut self, name: &str) -> Result<(), FSError> {
        let path = self.path.join(name);
        let res = std::fs::remove_file(path);
        match res {
            Ok(_) => Ok(()),
            Err(err) => match err.kind() {
                std::io::ErrorKind::NotFound => Ok(()),
                _ => Err(err.into()),
            },
        }
    }

    fn create_dir(&mut self, name: &str) -> Result<(), FSError> {
        let path = self.path.join(name);
        std::fs::create_dir(path)?;
        Ok(())
    }

    fn remove_dir(self) -> Result<(), FSError> {
        let res = std::fs::remove_dir_all(&self.path);
        match res {
            Ok(_) => Ok(()),
            Err(err) => match err.kind() {
                std::io::ErrorKind::NotFound => Ok(()),
                _ => Err(err.into()),
            },
        }
    }

    fn iter_dir<F>(&mut self, mut f: F) -> Result<(), FSError>
    where
        F: FnMut(EntryKind, &[u8]),
    {
        let entries = std::fs::read_dir(&self.path)?;
        for entry in entries {
            let entry = entry?;
            let path = entry.path();
            let kind = if path.is_dir() {
                EntryKind::Dir
            } else if path.is_file() {
                EntryKind::File
            } else {
                continue;
            };
            let fname = entry.file_name();
            let fname = fname.as_encoded_bytes();
            f(kind, fname);
        }
        Ok(())
    }
}

pub struct File {
    file: std::fs::File,
}

impl embedded_io::ErrorType for File {
    type Error = std::io::Error;
}

impl embedded_io::Read for File {
    fn read(&mut self, buf: &mut [u8]) -> Result<usize, Self::Error> {
        std::io::Read::read(&mut self.file, buf)
    }
}

impl embedded_io::Write for File {
    fn write(&mut self, buf: &[u8]) -> Result<usize, Self::Error> {
        std::io::Write::write(&mut self.file, buf)
    }

    fn flush(&mut self) -> Result<(), Self::Error> {
        std::io::Write::flush(&mut self.file)
    }
}

pub struct NetworkImpl<'a> {
    worker: Cell<Option<UdpWorker>>,
    r_in: mpsc::Receiver<NetMessage>,
    s_out: mpsc::Sender<NetMessage>,
    s_stop: mpsc::Sender<()>,
    local_addr: Option<SocketAddr>,
    _life: &'a PhantomData<()>,
}

impl<'a> NetworkImpl<'a> {
    fn new() -> Self {
        let (s_in, r_in) = mpsc::channel();
        let (s_out, r_out) = mpsc::channel();
        let (s_stop, r_stop) = mpsc::channel();
        let worker = Cell::new(Some(UdpWorker {
            s_in,
            r_out,
            r_stop,
        }));
        Self {
            worker,
            r_in,
            s_out,
            s_stop,
            local_addr: None,
            _life: &PhantomData,
        }
    }
}

pub type Addr = SocketAddr;

impl<'a> Network for DeviceImpl<'a> {
    type Addr = SocketAddr;

    fn net_local_addr(&self) -> SocketAddr {
        self.network.local_addr.unwrap()
    }

    fn net_start(&mut self) -> NetworkResult<()> {
        let worker = self.network.worker.replace(None);
        let Some(worker) = worker else {
            return Ok(());
        };
        let local_addr = worker.start(self.config.udp_ip)?;
        self.network.local_addr = Some(local_addr);
        Ok(())
    }

    fn net_stop(&mut self) -> NetworkResult<()> {
        _ = self.network.s_stop.send(());
        Ok(())
    }

    fn net_advertise(&mut self) -> NetworkResult<()> {
        let hello = b"HELLO".to_owned();
        let hello: Box<[u8]> = Box::new(hello);
        for ip in &self.config.peers {
            for port in UDP_PORT_MIN..=UDP_PORT_MAX {
                let addr = SocketAddr::new(*ip, port);
                let res = self.network.s_out.send((addr, hello.clone()));
                if res.is_err() {
                    return Err(NetworkError::NetThreadDeallocated);
                }
            }
        }
        Ok(())
    }

    fn net_recv(&mut self) -> NetworkResult<Option<(Self::Addr, Box<[u8]>)>> {
        Ok(self.network.r_in.try_recv().ok())
    }

    fn net_send(&mut self, addr: Self::Addr, data: &[u8]) -> NetworkResult<()> {
        if data.len() >= 200 {
            return Err(NetworkError::OutMessageTooBig);
        };
        let msg = data.to_vec().into_boxed_slice();
        let res = self.network.s_out.send((addr, msg));
        if res.is_err() {
            return Err(NetworkError::NetThreadDeallocated);
        }
        Ok(())
    }

    fn net_send_status(&mut self, _: Self::Addr) -> NetworkResult<firefly_types::spi::SendStatus> {
        Ok(firefly_types::spi::SendStatus::Empty)
    }
}

pub struct SerialImpl {
    worker: Cell<Option<TcpWorker>>,
    r_in: mpsc::Receiver<SerialMessage>,
    s_out: mpsc::Sender<SerialMessage>,
    s_stop: mpsc::Sender<()>,
}

impl SerialImpl {
    fn new() -> Self {
        let (s_in, r_in) = mpsc::channel();
        let (s_out, r_out) = mpsc::channel();
        let (s_stop, r_stop) = mpsc::channel();
        let worker = TcpWorker {
            s_in,
            r_out,
            r_stop,
        };
        let worker = Cell::new(Some(worker));
        Self {
            worker,
            r_in,
            s_out,
            s_stop,
        }
    }
}

impl Serial for DeviceImpl<'_> {
    fn serial_start(&mut self) -> NetworkResult<()> {
        let worker = self.serial.worker.replace(None);
        let Some(worker) = worker else {
            return Ok(());
        };
        worker.start(self.config.tcp_ip)?;
        Ok(())
    }

    fn serial_stop(&mut self) -> NetworkResult<()> {
        _ = self.serial.s_stop.send(());
        Ok(())
    }

    fn serial_recv(&mut self) -> NetworkResult<Option<Box<[u8]>>> {
        Ok(self.serial.r_in.try_recv().ok())
    }

    fn serial_send(&mut self, data: &[u8]) -> NetworkResult<()> {
        if data.len() >= 200 {
            return Err(NetworkError::OutMessageTooBig);
        };
        let msg = data.to_vec().into_boxed_slice();
        let res = self.serial.s_out.send(msg);
        if res.is_err() {
            return Err(NetworkError::NetThreadDeallocated);
        }
        Ok(())
    }
}

impl Wifi for DeviceImpl<'_> {
    fn wifi_scan(&mut self) -> NetworkResult<[String; 6]> {
        let points = ["Default Network", "", "", "", "", ""];
        let points = points.map(|s| s.to_string());
        Ok(points)
    }

    fn wifi_connect(&mut self, ssid: &str, pass: &str) -> NetworkResult<()> {
        if ssid != "Default Network" {
            self.wifi_status = 2; // disconnected
        } else if pass == "invalid" {
            self.wifi_status = 1; // error
        } else {
            self.wifi_status = 3; // initializing
        }
        Ok(())
    }

    fn wifi_status(&mut self) -> NetworkResult<u8> {
        if self.wifi_status == 3 {
            self.wifi_status = 4; // connected
            Ok(3)
        } else {
            Ok(self.wifi_status)
        }
    }

    fn wifi_disconnect(&mut self) -> NetworkResult<()> {
        self.wifi_status = 2;
        Ok(())
    }

    fn tcp_connect(&mut self, ip: u32, port: u16) -> NetworkResult<()> {
        if self.wifi_status != 4 {
            return Err(NetworkError::Error("not connected to wifi"));
        }
        let ip = Ipv4Addr::new(
            (ip >> 24) as u8,
            (ip >> 16) as u8,
            (ip >> 8) as u8,
            ip as u8,
        );
        let addr = SocketAddrV4::new(ip, port);
        let Ok(stream) = TcpStream::connect(addr) else {
            return Err(NetworkError::CannotBind);
        };
        _ = stream.set_nonblocking(true);
        self.tcp_conn = Some(stream);
        Ok(())
    }

    fn tcp_status(&mut self) -> NetworkResult<u8> {
        let Some(stream) = &mut self.tcp_conn else {
            return Ok(1);
        };
        if stream.peer_addr().is_err() {
            return Ok(1);
        }
        Ok(5)
    }

    fn tcp_send(&mut self, data: &[u8]) -> NetworkResult<()> {
        let Some(stream) = &mut self.tcp_conn else {
            return Err(NetworkError::NotInitialized);
        };
        let res = stream.write_all(data);
        if let Err(err) = res {
            let err = alloc::format!("{err}");
            return Err(NetworkError::OwnedError(err));
        }
        Ok(())
    }

    fn tcp_recv(&mut self) -> NetworkResult<Box<[u8]>> {
        let Some(stream) = &mut self.tcp_conn else {
            return Err(NetworkError::NotInitialized);
        };
        let mut buf = vec![0; 80];
        let n = match stream.read(&mut buf) {
            Ok(n) => n,
            Err(err) => {
                if err.kind() == std::io::ErrorKind::WouldBlock {
                    0
                } else {
                    return Err(NetworkError::Error("failed to read incoming TCP data"));
                }
            }
        };
        buf.truncate(n);
        Ok(buf.into_boxed_slice())
    }

    fn tcp_close(&mut self) -> NetworkResult<()> {
        let Some(stream) = self.tcp_conn.take() else {
            return Ok(());
        };
        _ = stream.shutdown(std::net::Shutdown::Both);
        Ok(())
    }
}

type NetMessage = (SocketAddr, Box<[u8]>);
type SerialMessage = Box<[u8]>;

struct UdpWorker {
    s_in: mpsc::Sender<NetMessage>,
    r_out: mpsc::Receiver<NetMessage>,
    r_stop: mpsc::Receiver<()>,
}

impl UdpWorker {
    fn start(self, ip: IpAddr) -> Result<SocketAddr, NetworkError> {
        let addrs: Vec<_> = (UDP_PORT_MIN..=UDP_PORT_MAX)
            .map(|port| SocketAddr::new(ip, port))
            .collect();
        let socket = match UdpSocket::bind(&addrs[..]) {
            Ok(socket) => socket,
            Err(_) => return Err(NetworkError::CannotBind),
        };
        let timeout = std::time::Duration::from_millis(10);
        socket.set_read_timeout(Some(timeout)).unwrap();
        if let Ok(addr) = socket.local_addr() {
            println!("listening on {addr}/udp");
        } else {
            println!("listening a UDP port");
        }
        let local_addr = socket.local_addr().unwrap();
        std::thread::spawn(move || {
            loop {
                match self.r_stop.try_recv() {
                    Ok(_) | Err(mpsc::TryRecvError::Disconnected) => {
                        break;
                    }
                    Err(mpsc::TryRecvError::Empty) => {}
                }
                let mut buf = vec![0; 64];
                if let Ok((size, addr)) = socket.recv_from(&mut buf) {
                    if size == 0 {
                        continue;
                    }
                    buf.truncate(size);
                    let buf = buf.into_boxed_slice();
                    _ = self.s_in.send((addr, buf));
                }
                if let Ok((addr, buf)) = self.r_out.try_recv() {
                    if addr == local_addr {
                        continue;
                    }
                    _ = socket.send_to(&buf, addr);
                }
            }
        });
        Ok(local_addr)
    }
}

struct TcpWorker {
    s_in: mpsc::Sender<SerialMessage>,
    r_out: mpsc::Receiver<SerialMessage>,
    r_stop: mpsc::Receiver<()>,
}

impl TcpWorker {
    fn start(self, ip: IpAddr) -> Result<(), NetworkError> {
        let addrs: Vec<_> = (TCP_PORT_MIN..=TCP_PORT_MAX)
            .map(|port| SocketAddr::new(ip, port))
            .collect();
        let Ok(socket) = TcpListener::bind(&addrs[..]) else {
            return Err(NetworkError::CannotBind);
        };
        socket.set_nonblocking(true).unwrap();
        std::thread::spawn(move || {
            let mut streams = RingBuf::new();
            loop {
                match self.r_stop.try_recv() {
                    Ok(_) | Err(mpsc::TryRecvError::Disconnected) => {
                        break;
                    }
                    Err(mpsc::TryRecvError::Empty) => {}
                }

                if let Ok((stream, _addr)) = socket.accept() {
                    stream.set_nonblocking(true).unwrap();
                    streams.push(stream);
                };

                for stream in streams.iter_mut() {
                    let mut buf = vec![0; 200];
                    let Ok(size) = stream.read(&mut buf) else {
                        continue;
                    };
                    if size == 0 {
                        continue;
                    }
                    buf.truncate(size);
                    let buf = buf.into_boxed_slice();
                    _ = self.s_in.send(buf);
                }
                if let Ok(buf) = self.r_out.try_recv() {
                    for stream in streams.iter_mut() {
                        _ = stream.write_all(&buf)
                    }
                }
            }
        });
        Ok(())
    }
}

/// A collection that holds 4 latest TCP connections.
///
/// If there are already 4 TCP connections and a new one comes in,
/// the oldest one is dropped.
struct RingBuf {
    data: [Option<TcpStream>; 4],
    next: usize,
}

impl RingBuf {
    fn new() -> Self {
        Self {
            data: [None, None, None, None],
            next: 0,
        }
    }

    fn push(&mut self, val: TcpStream) {
        self.data[self.next] = Some(val);
        self.next = (self.next + 1) % 4
    }

    fn iter_mut(&mut self) -> impl Iterator<Item = &mut TcpStream> {
        self.data.iter_mut().filter_map(Option::as_mut)
    }
}

#[cfg(not(target_os = "android"))]
fn start_audio(config: &DeviceConfig) -> Option<AudioWriter> {
    let wav = if let Some(filename) = &config.wav {
        let spec = hound::WavSpec {
            channels: 2,
            sample_rate: SAMPLE_RATE,
            bits_per_sample: 16,
            sample_format: hound::SampleFormat::Int,
        };
        let writer = hound::WavWriter::create(filename, spec).unwrap();
        Some(writer)
    } else {
        None
    };

    let (send, recv) = mpsc::sync_channel(AUDIO_BUF_SIZE);
    let Ok(mut stream) = rodio::OutputStreamBuilder::open_default_stream() else {
        eprintln!("WARNING: audio device is not available, sound will be disabled");
        return None;
    };
    stream.log_on_drop(false);
    let mixer = stream.mixer();
    let source = AudioReader { wav, recv };
    mixer.add(source);
    let audio = AudioWriter {
        buf: [0; AUDIO_BUF_SIZE],
        idx: 0,
        send,
        _stream: stream,
    };
    Some(audio)
}

struct AudioWriter {
    buf: [i16; AUDIO_BUF_SIZE],
    send: mpsc::SyncSender<i16>,
    /// The index of the next sample that we'll need to try sending.
    idx: usize,
    #[cfg(not(target_os = "android"))]
    _stream: rodio::OutputStream,
}

impl AudioWriter {
    fn get_write_buf(&mut self) -> &mut [i16] {
        if self.idx == AUDIO_BUF_SIZE {
            self.idx = 0;
        }
        let start = self.idx;
        let mut idx = self.idx;
        // write as much as we can from the buffer into the channel
        while idx < AUDIO_BUF_SIZE {
            let res = self.send.try_send(self.buf[idx]);
            if res.is_err() {
                break;
            }
            idx += 1;
        }
        self.idx = idx;
        // fill the now empty part of the buffer with audio data
        &mut self.buf[start..idx]
    }
}

#[cfg(not(target_os = "android"))]
struct AudioReader {
    wav: Option<hound::WavWriter<std::io::BufWriter<std::fs::File>>>,
    recv: mpsc::Receiver<i16>,
}

#[cfg(not(target_os = "android"))]
impl rodio::Source for AudioReader {
    fn current_span_len(&self) -> Option<usize> {
        None
    }

    fn channels(&self) -> u16 {
        2
    }

    fn sample_rate(&self) -> u32 {
        SAMPLE_RATE
    }

    fn total_duration(&self) -> Option<core::time::Duration> {
        None
    }
}

#[cfg(not(target_os = "android"))]
impl Iterator for AudioReader {
    type Item = f32;

    fn next(&mut self) -> Option<Self::Item> {
        let s = self.recv.try_recv().unwrap_or_default();
        if let Some(wav) = self.wav.as_mut() {
            wav.write_sample(s).unwrap()
        }
        let s = f32::from(s) / f32::from(i16::MAX);
        Some(s)
    }
}