nw_sys/

screen.rs

//!
//! Access to system display information, including system resolution, display layout and
//! display layout change notification events.
//!
//! # Synopsis
//! ```
//! // init must be called once during startup, before any function to nw.Screen can be called
//! nw_sys::screen::init_once();
//!
//! let display_bounds_changed_callback = Callback::new(move |screen:JsValue|{
//!     let screen: nw_sys::screen::ScreenInfo = screen.try_into()?;
//!     log_info!("displayBoundsChanged: {:#?}", screen);
//!     Ok(())
//! });
//!
//! let display_added_callback = Callback::new(move |screen:JsValue|{
//!     let screen: nw_sys::screen::ScreenInfo = screen.try_into()?;
//!     log_info!("displayAdded: {:#?}", screen);
//!     Ok(())
//! });
//!
//! let display_removed_callback = Callback::new(move |screen:JsValue|{
//!     let screen: nw_sys::screen::ScreenInfo = screen.try_into()?;
//!     log_info!("displayRemoved: {:#?}", screen);
//!     Ok(())
//! });
//!
//! // listen to screen events
//! nw_sys::screen::on("displayBoundsChanged", display_bounds_changed_callback.as_ref());
//! nw_sys::screen::on("displayAdded", display_added_callback.as_ref());
//! nw_sys::screen::on("displayRemoved", display_removed_callback.as_ref());
//!
//! // save callbacks somewhere
//! app.push_callback(display_bounds_changed_callback)?;
//! app.push_callback(display_added_callback)?;
//! app.push_callback(display_removed_callback)?;
//!
//! ```
//!
//! Screen
//! # Synopsis
//! ```
//! use workflow_wasm::prelude::*;
//!
//! // init must be called once during startup, before any function to nw.Screen can be called
//! nw_sys::screen::init_once();
//!
//! let display_bounds_changed_callback = callback!(move |screen:JsValue|{
//!     let screen: nw_sys::screen::ScreenInfo = screen.try_into()?;
//!     log_info!("displayBoundsChanged: {:#?}", screen);
//!     Ok(())
//! });
//!
//! let display_added_callback = callback!(move |screen:JsValue|{
//!     let screen: nw_sys::screen::ScreenInfo = screen.try_into()?;
//!     log_info!("displayAdded: {:#?}", screen);
//!     Ok(())
//! });
//!
//! let display_removed_callback = callback!(move |screen:JsValue|{
//!     let screen: nw_sys::screen::ScreenInfo = screen.try_into()?;
//!     log_info!("displayRemoved: {:#?}", screen);
//!     Ok(())
//! });
//!
//! // listen to screen events
//! nw_sys::screen::on("displayBoundsChanged", display_bounds_changed_callback.into_js());
//! nw_sys::screen::on("displayAdded", display_added_callback.into_js());
//! nw_sys::screen::on("displayRemoved", display_removed_callback.into_js());
//!
//! // save callbacks somewhere
//! app.push_callback(display_bounds_changed_callback)?;
//! app.push_callback(display_added_callback)?;
//! app.push_callback(display_removed_callback)?;
//!
//! ```

use js_sys::{Array, Function};
use wasm_bindgen::prelude::*;
//use workflow_log::log_info;
//use crate::options::OptionsExt;
use crate::result::Result;
use crate::utils;

#[wasm_bindgen]
extern "C" {

    #[wasm_bindgen(js_namespace=nw, js_name = Screen)]
    #[derive(Debug, Clone)]
    type ScreenLocal;

    #[wasm_bindgen(js_namespace=["nw", "Screen"], js_name = Init)]
    /// Init the Screen singleton object, you only need to call this once
    ///
    /// ⧉ [NWJS Documentation](https://docs.nwjs.io/en/latest/References/Screen/#screeninit)
    ///
    pub fn init();

    #[wasm_bindgen(getter, static_method_of=ScreenLocal, js_namespace=["nw"], js_class=Screen, js_name = screens)]
    fn screens_impl() -> Array;

    #[wasm_bindgen(js_namespace=["nw", "Screen"], js_name = chooseDesktopMedia)]
    fn choose_desktop_media_impl(sources: Array, callback: &Function);

    #[wasm_bindgen(js_namespace=["nw", "Screen"], js_name = on)]
    ///
    ///
    /// Interface for accessing display & monitor layout information. For usage example please refer to [nw_sys::screen](self)
    ///
    /// ### Events:
    /// - displayBoundsChanged (screen)
    /// - displayAdded (screen)
    /// - displayRemoved (screen)
    ///
    ///
    /// ⧉ [NWJS Documentation](https://docs.nwjs.io/en/latest/References/Screen/#event-displayboundschangedscreen)
    ///
    pub fn on(event_name: &str, callback: &Function);
}

pub mod desktop_capture_monitor {
    use js_sys::Function;
    use wasm_bindgen::prelude::*;

    #[wasm_bindgen]
    extern "C" {

        #[wasm_bindgen(js_namespace=["nw", "Screen"], js_name = DesktopCaptureMonitor)]
        #[derive(Debug, Clone)]
        type DCM;

        #[wasm_bindgen(getter, static_method_of=DCM, js_namespace=["nw", "Screen"], js_class=DesktopCaptureMonitor, js_name = started)]
        /// Return Boolean of whether the DesktopCaptureMonitor is started.
        ///
        ///
        /// ⧉ [NWJS Documentation](https://docs.nwjs.io/en/latest/References/Screen/#screendesktopcapturemonitorstarted)
        ///
        pub fn started() -> bool;

        #[wasm_bindgen(js_namespace=["nw", "Screen", "DesktopCaptureMonitor"], js_name = start)]
        /// The DesktopCaptureMonitor will start monitoring the system
        /// and trigger the the events. The screen may flicker
        /// if while DesktopCaptureMonitor is running.
        ///
        /// Example:
        /// ```rust
        /// nw::screen::desktop_capture_monitor::start(true, true);
        /// ```
        ///
        /// ⧉ [NWJS Documentation](https://docs.nwjs.io/en/latest/References/Screen/#screendesktopcapturemonitorstartshould_include_screens-should_include_windows)
        ///
        pub fn start(should_include_screens: bool, should_include_windows: bool);

        #[wasm_bindgen(js_namespace=["nw", "Screen", "DesktopCaptureMonitor"], js_name = stop)]
        /// The `DesktopCaptureMonitor` will stop monitoring the system.
        /// `DesktopCaptureMonitor` should be stopped after a stream is selected.
        ///
        ///
        /// ⧉ [NWJS Documentation](https://docs.nwjs.io/en/latest/References/Screen/#screendesktopcapturemonitorstop)
        ///
        pub fn stop();

        #[wasm_bindgen(js_namespace=["nw", "Screen", "DesktopCaptureMonitor"], js_name = registerStream)]
        /// Register and return a valid stream id which will be used into
        /// chromeMediaSourceId in get_user_media constraints.
        ///
        /// See Synopsis for the usage.
        ///
        ///
        /// ⧉ [NWJS Documentation](https://docs.nwjs.io/en/latest/References/Screen/#screendesktopcapturemonitorregisterstreamid)
        ///
        pub fn register_stream(id: &str) -> String;

        #[wasm_bindgen(static_method_of=DCM, js_namespace=["nw", "Screen"], js_class=DesktopCaptureMonitor, js_name = on)]
        /// Add event listener
        ///
        /// ### Events:
        /// - added (id, name, order, type, primary)
        /// - removed (order)
        /// - orderchanged (id, new_order, old_order)
        /// - namechanged (id, name)
        /// - thumbnailchanged (id, thumbnail)
        ///
        ///
        /// ⧉ [NWJS Documentation](https://docs.nwjs.io/en/latest/References/Screen/#event-added-id-name-order-type-primary)
        ///
        pub fn on(event_name: &str, callback: &Function);
    }

    /// Return Boolean of whether the DesktopCaptureMonitor is started.
    ///
    ///
    /// ⧉ [NWJS Documentation](https://docs.nwjs.io/en/latest/References/Screen/#screendesktopcapturemonitorstarted)
    ///
    pub fn started() -> bool {
        DCM::started()
    }

    /// Add event listener
    ///
    /// ### Events:
    /// - added (id, name, order, type, primary)
    /// - removed (order)
    /// - orderchanged (id, new_order, old_order)
    /// - namechanged (id, name)
    /// - thumbnailchanged (id, thumbnail)
    ///
    ///
    /// ⧉ [NWJS Documentation](https://docs.nwjs.io/en/latest/References/Screen/#event-added-id-name-order-type-primary)
    ///
    pub fn on(event_name: &str, callback: &Function) {
        DCM::on(event_name, callback)
    }
}

static mut INIT: bool = false;

/// Return true is screen is initialized
pub fn is_initialized() -> bool {
    unsafe { INIT }
}

/// Call the screen::init() if screen is not initialized yet
pub fn init_once() {
    if !is_initialized() {
        unsafe { INIT = true };
        init();
    }
}

/// Media source type
pub enum MediaSources {
    Screen,
    Window,
    ScreenAndWindow,
}

/// Choose desktop media
///
/// Screen sharing by selection; Currently only working in Windows and OSX
/// and some linux distribution.
///
/// ⧉ [NWJS Documentation](https://docs.nwjs.io/en/latest/References/Screen/#screenchoosedesktopmedia-sources-callback)
///
pub fn choose_desktop_media(sources: MediaSources, callback: &Function) -> Result<()> {
    let array = Array::new();
    match sources {
        MediaSources::Screen => {
            array.push(&JsValue::from("screen"));
        }
        MediaSources::Window => {
            array.push(&JsValue::from("window"));
        }
        MediaSources::ScreenAndWindow => {
            array.push(&JsValue::from("screen"));
            array.push(&JsValue::from("window"));
        }
    };

    choose_desktop_media_impl(array, callback);
    Ok(())
}

/// Get the array of screen (number of screen connected to the computer)
///
/// ⧉ [NWJS Documentation](https://docs.nwjs.io/en/latest/References/Screen/#screenscreens)
///
pub fn screens() -> Result<Vec<ScreenInfo>> {
    let mut result: Vec<ScreenInfo> = Vec::new();
    let array = ScreenLocal::screens_impl();
    for index in 0..array.length() {
        let screen = array.get(index);
        //log_info!("screen: {:#?}", screen);
        result.push(screen.try_into()?);
    }
    Ok(result)
}

/// physical screen resolution, can be negative,
/// not necessarily start from 0,
/// depending on screen arrangement
#[derive(Debug)]
pub struct Bounds {
    pub x: f64,
    pub y: f64,
    pub width: f64,
    pub height: f64,
}

/// useable area within the screen bound
#[derive(Debug)]
pub struct WorkArea {
    pub x: f64,
    pub y: f64,
    pub width: f64,
    pub height: f64,
}

/// Screen Info
#[derive(Debug)]
pub struct ScreenInfo {
    pub id: u64,
    pub scale_factor: f64,
    pub is_built_in: bool,
    pub rotation: u64,
    pub touch_support: u64,
    pub bounds: Bounds,
    pub work_area: WorkArea,
}

fn read_box(jsv: &JsValue, prop: &str) -> Result<(f64, f64, f64, f64)> {
    let jsv = utils::try_get_js_value(jsv, prop)?;
    let x = utils::try_get_f64_from_prop(&jsv, "x")?;
    let y = utils::try_get_f64_from_prop(&jsv, "y")?;
    let width = utils::try_get_f64_from_prop(&jsv, "width")?;
    let height = utils::try_get_f64_from_prop(&jsv, "height")?;

    Ok((x, y, width, height))
}

impl TryFrom<JsValue> for ScreenInfo {
    type Error = crate::error::Error;
    fn try_from(jsv: JsValue) -> std::result::Result<Self, Self::Error> {
        let id = utils::try_get_u64_from_prop(&jsv, "id")?;
        let scale_factor = utils::try_get_f64_from_prop(&jsv, "scaleFactor")?;
        let is_built_in = utils::try_get_bool_from_prop(&jsv, "isBuiltIn")?;
        let rotation = utils::try_get_u64_from_prop(&jsv, "rotation")?;
        let touch_support = utils::try_get_u64_from_prop(&jsv, "touchSupport")?;

        let (x, y, width, height) = read_box(&jsv, "bounds")?;
        let bounds = Bounds {
            x,
            y,
            width,
            height,
        };

        let (x, y, width, height) = read_box(&jsv, "work_area")?;
        let work_area = WorkArea {
            x,
            y,
            width,
            height,
        };

        let info = Self {
            id,
            scale_factor,
            is_built_in,
            rotation,
            touch_support,
            bounds,
            work_area,
        };
        Ok(info)
    }
}