GitCorner

Code

ossartcraftdeckcraft🌐
e4f86d11fe8a
//! Transitions tab.

use std::sync::Arc;

use deckcraft_model::Transition;
use deckcraft_model::anim::TRANSITIONS;
use serde_json::{Value, json};

use super::{CommandSpec, NO_ID_SPACE, always, bad, bool_param, cmd, has_slide, ok, opt_usize_param, str_param};
use crate::{Result, Session};

pub fn specs() -> Vec<CommandSpec> {
    vec![
        cmd!(
            "transition.set",
            "Transition",
            ["Transitions", "Transition to This Slide"],
            None,
            "{kind: none|morph|fade|push|wipe|split|reveal|cut|randomBar|shape|uncover|cover|flash|… (transition.list), option?, duration?: ms, index?}",
            has_slide,
            set
        ),
        cmd!("transition.options", "Effect Options", ["Transitions", "Transition to This Slide"], None, "{option, index?}", has_slide, options),
        cmd!(
            "transition.timing",
            "Timing",
            ["Transitions", "Timing"],
            None,
            "{duration?: ms, onClick?: bool, after?: ms | null, index?}",
            has_slide,
            timing
        ),
        cmd!(
            "transition.sound",
            "Sound",
            ["Transitions", "Timing"],
            None,
            "{builtin?: chime|click|camera|whoosh|drumRoll|laser | path? | data: base64, name?, none?: true (No Sound), stopPrevious?: true, loop?: bool (Loop Until Next Sound), index?} — the sound plays as the slide comes in",
            has_slide,
            sound
        ),
        cmd!("transition.applyAll", "Apply To All", ["Transitions", "Timing"], None, "{}", has_slide, apply_all),
        cmd!(query "transition.list", "Transition Gallery", [], None, "{} → [{id, label, category, duration, options}]", always, list),
    ]
}

fn slide_indices(s: &Session, p: &Value, cmd: &str) -> Result<Vec<usize>> {
    let st = s.doc()?;
    if let Some(i) = opt_usize_param(p, "index", cmd)? {
        return Ok(vec![i]);
    }
    let v: Vec<usize> = st.selection.slides.iter().filter_map(|id| st.doc.slide_index(*id)).collect();
    Ok(if v.is_empty() { vec![st.selection.slide] } else { v })
}

fn set(s: &mut Session, p: &Value) -> Result<Value> {
    let kind = str_param(p, "kind").ok_or_else(|| bad("transition.set", "missing `kind`"))?;
    let info =
        TRANSITIONS.iter().find(|t| t.0.eq_ignore_ascii_case(kind)).ok_or_else(|| bad("transition.set", format!("unknown transition `{kind}`")))?;
    let option = str_param(p, "option").map(String::from).or_else(|| info.4.first().map(|o| o.to_string())).unwrap_or_default();
    let duration = p.get("duration").and_then(Value::as_u64).map(|v| v.min(59_000) as u32);
    let list = slide_indices(s, p, "transition.set")?;
    s.edit(|doc, _| {
        for i in list {
            if let Some(sl) = doc.slides.get_mut(i) {
                let sl = Arc::make_mut(sl);
                let mut t = sl.transition.clone().unwrap_or_default();
                t.kind = info.0.to_string();
                t.option = option.clone();
                t.duration_ms = duration.unwrap_or(info.3);
                t.raw = None;
                sl.transition = if info.0 == "none" && t.advance_after_ms.is_none() && t.advance_on_click && t.sound.is_none() && !t.stop_sound {
                    None
                } else {
                    Some(t)
                };
            }
        }
        Ok(())
    })?;
    Ok(json!({"kind": info.0}))
}

fn options(s: &mut Session, p: &Value) -> Result<Value> {
    let option = str_param(p, "option").ok_or_else(|| bad("transition.options", "missing `option`"))?.to_string();
    let list = slide_indices(s, p, "transition.options")?;
    s.edit(|doc, _| {
        for i in list {
            if let Some(sl) = doc.slides.get_mut(i)
                && let Some(t) = Arc::make_mut(sl).transition.as_mut()
            {
                t.option = option.clone();
            }
        }
        Ok(())
    })?;
    ok()
}

fn timing(s: &mut Session, p: &Value) -> Result<Value> {
    let list = slide_indices(s, p, "transition.timing")?;
    s.edit(|doc, _| {
        for i in list {
            if let Some(sl) = doc.slides.get_mut(i) {
                let t = Arc::make_mut(sl).transition.get_or_insert_with(Transition::default);
                if let Some(d) = p.get("duration").and_then(Value::as_u64) {
                    t.duration_ms = d.min(59_000) as u32;
                }
                if let Some(c) = bool_param(p, "onClick") {
                    t.advance_on_click = c;
                }
                match p.get("after") {
                    Some(Value::Null) => t.advance_after_ms = None,
                    Some(v) => {
                        if let Some(x) = v.as_u64() {
                            t.advance_after_ms = Some(x.min(86_400_000) as u32);
                        }
                    }
                    None => {}
                }
            }
        }
        Ok(())
    })?;
    ok()
}

/// Transitions › Sound: embed an audio file as the slides' transition sound, or `none` to remove it.
fn sound(s: &mut Session, p: &Value) -> Result<Value> {
    let list = slide_indices(s, p, "transition.sound")?;
    let looping = bool_param(p, "loop");
    let edit_all = |s: &mut Session, f: &dyn Fn(&mut Transition)| {
        s.edit(|doc, _| {
            for &i in &list {
                if let Some(sl) = doc.slides.get_mut(i) {
                    f(Arc::make_mut(sl).transition.get_or_insert_with(Transition::default));
                }
            }
            Ok(())
        })
    };
    if bool_param(p, "none") == Some(true) {
        edit_all(s, &|t| {
            t.sound = None;
            t.stop_sound = false;
            t.sound_loop = false;
        })?;
        return Ok(json!({"sound": null}));
    }
    if bool_param(p, "stopPrevious") == Some(true) {
        edit_all(s, &|t| {
            t.sound = None;
            t.sound_loop = false;
            t.stop_sound = true;
        })?;
        return Ok(json!({"sound": null, "stopPrevious": true}));
    }
    let wants_file = p.get("path").is_some() || p.get("data").is_some() || p.get("builtin").is_some();
    if !wants_file {
        // Only Loop Until Next Sound changes.
        let Some(l) = looping else { return Err(bad("transition.sound", "give `path`, `data`, `builtin`, `none`, `stopPrevious` or `loop`")) };
        edit_all(s, &|t| t.sound_loop = l && t.sound.is_some())?;
        return Ok(json!({"loop": l}));
    }
    let (name, bytes) = match str_param(p, "builtin") {
        Some(id) => {
            let (id, label) = crate::sounds::BUILTIN.iter().find(|b| b.0.eq_ignore_ascii_case(id)).ok_or_else(|| {
                let ids: Vec<&str> = crate::sounds::BUILTIN.iter().map(|b| b.0).collect();
                bad("transition.sound", format!("unknown built-in sound `{id}` (one of {})", ids.join(", ")))
            })?;
            let bytes = crate::sounds::builtin(id).ok_or_else(|| bad("transition.sound", "built-in sound failed"))?;
            (format!("{label}.wav"), bytes)
        }
        None => super::insert::media_bytes(p, "transition.sound")?,
    };
    let ct = super::insert::content_type(&name, &bytes);
    let bytes = Arc::new(bytes);
    let audible = deckcraft_media::probe(&bytes).is_ok_and(|i| i.audio.is_some());
    let bytes = Arc::try_unwrap(bytes).unwrap_or_else(|a| (*a).clone());
    if !audible && !ct.starts_with("audio/") {
        return Err(bad("transition.sound", format!("{name} is not a sound file ({ct})")));
    }
    let lp = looping.unwrap_or(false);
    let media = s.edit(|doc, _| {
        // The same built-in sound is embedded once.
        let existing = doc.media.iter().find(|m| m.name == name && m.data.as_slice() == bytes.as_slice()).map(|m| m.id);
        let media = match existing {
            Some(m) => m,
            None => doc.add_media(&name, ct, bytes).ok_or_else(|| bad("transition.sound", NO_ID_SPACE))?,
        };
        for &i in &list {
            if let Some(sl) = doc.slides.get_mut(i) {
                let t = Arc::make_mut(sl).transition.get_or_insert_with(Transition::default);
                t.sound = Some(media);
                t.stop_sound = false;
                t.sound_loop = lp;
            }
        }
        Ok(media)
    })?;
    Ok(json!({"sound": name, "media": media.0, "playable": audible, "loop": lp}))
}

fn apply_all(s: &mut Session, _p: &Value) -> Result<Value> {
    s.edit(|doc, sel| {
        let t = doc.slides.get(sel.slide).and_then(|x| x.transition.clone());
        for sl in &mut doc.slides {
            Arc::make_mut(sl).transition.clone_from(&t);
        }
        Ok(())
    })?;
    ok()
}

fn list(_s: &mut Session, _p: &Value) -> Result<Value> {
    Ok(Value::Array(TRANSITIONS.iter().map(|t| json!({"id": t.0, "label": t.1, "category": t.2, "duration": t.3, "options": t.4})).collect()))
}

#[cfg(test)]
mod tests {
    use serde_json::json;

    use crate::Session;

    #[test]
    fn invalid_index_params_are_rejected_not_defaulted_to_selection() {
        let mut s = Session::with_new();
        while s.doc().expect("doc").doc.slides.len() < 3 {
            s.execute("slide.new", &json!({})).expect("new slide");
        }
        for bad in [json!(-1), json!(1.5)] {
            for (cmd, p) in [
                ("transition.set", json!({"kind": "fade", "index": bad})),
                ("transition.options", json!({"option": "x", "index": bad})),
                ("transition.timing", json!({"duration": 500, "index": bad})),
                ("transition.sound", json!({"none": true, "index": bad})),
            ] {
                assert!(s.execute(cmd, &p).is_err(), "{cmd} must reject {p}");
                assert!(s.doc().expect("doc").doc.slides.iter().all(|sl| sl.transition.is_none()), "{cmd} {p}");
            }
        }
    }
}