reflow_components 0.2.1

Standard component catalog for Reflow — procedural, media, GPU, animation, I/O, and stream actors.
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
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
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
//! Animation timeline actor — pools keyframe tracks from the DAG.
//!
//! Wire multiple KeyframeActors (or raw track data) into the `tracks`
//! inport. Each connection adds a named track. The timeline plays them
//! all in sync.
//!
//! ```text
//! Keyframe("position", kf:[...]) ──→ tracks ─┐
//! Keyframe("opacity", kf:[...])  ──→ tracks ─┼→ AnimationTimeline → position
//! Keyframe("scale", kf:[...])    ──→ tracks ─┘                   → opacity
//!                                                                 → scale
//! IntervalTrigger ──→ tick ─────────→
//! ```
//!
//! ## Track input format (on `tracks` inport)
//!
//! ```json
//! {
//!   "name": "position",
//!   "keyframes": [
//!     { "time": 0.0, "value": [0, 0, 0], "easing": "easeOutCubic" },
//!     { "time": 1.0, "value": [5, 3, 0] }
//!   ]
//! }
//! ```
//!
//! Multiple tracks accumulate — each new `tracks` message with a different
//! `name` adds to the pool. Same name replaces (hot-reload keyframes).
//!
//! ## Config
//!
//! ```json
//! {
//!   "duration": 2.0,
//!   "loop": false,
//!   "autoplay": true,
//!   "speed": 1.0,
//!   "stagger": {
//!     "delay": 0.1,
//!     "order": "index",
//!     "from": "start",
//!     "easing": "easeOutCubic"
//!   }
//! }
//! ```
//!
//! ## Stagger
//!
//! Automatically offsets each track's start time. Useful for cascading
//! animations across multiple elements (list items, grid cells, letters).
//!
//! - `delay` — time offset between consecutive tracks (seconds)
//! - `order` — `"index"` (arrival order), `"name"` (alphabetical), `"reverse"`
//! - `from` — `"start"` (first track has zero delay), `"center"`, `"end"`
//! - `easing` — ease the stagger distribution itself (optional)
//!
//! Example: 5 tracks with stagger delay 0.1 from start:
//!   track 0 starts at 0.0s, track 1 at 0.1s, track 2 at 0.2s, ...
//!
//! With `from: "center"`:
//!   track 0 at 0.2s, track 1 at 0.1s, track 2 at 0.0s, track 3 at 0.1s, track 4 at 0.2s
//!
//! ## Control (on `control` inport)
//!
//! Send a string: `"play"`, `"pause"`, `"stop"`, `"reverse"`, `"seek:0.5"`

use crate::math::easing;
use crate::{Actor, ActorBehavior, Message, Port};
use anyhow::{Error, Result};
use reflow_actor::{message::EncodableValue, ActorContext};
use reflow_actor_macro::actor;
use serde_json::{json, Value};
use std::collections::HashMap;

#[actor(
    AnimationTimelineActor,
    inports::<100>(tick, tracks, control),
    outports::<50>(values, state, progress, metadata),
    state(MemoryState)
)]
pub async fn animation_timeline_actor(
    ctx: ActorContext,
) -> Result<HashMap<String, Message>, Error> {
    let payload = ctx.get_payload();
    let config = ctx.get_config_hashmap();

    let duration = config
        .get("duration")
        .and_then(|v| v.as_f64())
        .unwrap_or(1.0);
    let do_loop = config
        .get("loop")
        .and_then(|v| v.as_bool())
        .unwrap_or(false);
    let autoplay = config
        .get("autoplay")
        .and_then(|v| v.as_bool())
        .unwrap_or(true);
    let dt = config
        .get("dt")
        .and_then(|v| v.as_f64())
        .unwrap_or(1.0 / 60.0);

    // ─── Load config tracks into pool on first invocation ───
    if ctx.get_pool("_tracks").is_empty() {
        if let Some(Value::Object(tracks_map)) = config.get("tracks") {
            for (name, track_data) in tracks_map {
                ctx.pool_upsert("_tracks", name, track_data.clone());
            }
        }
    }

    // ─── Pool incoming tracks from inport (override config) ───
    // Accepts two formats:
    //   Single track:  { "name": "s0_x", "keyframes": [...] }
    //   Batched tracks: { "tracks": { "s0_x": { "keyframes": [...] }, "s0_y": { ... } } }
    if let Some(Message::Object(obj)) = payload.get("tracks") {
        let v: Value = obj.as_ref().clone().into();
        if let Some(Value::Object(batch)) = v.get("tracks") {
            // Batched: multiple named tracks in one message
            for (name, track_data) in batch {
                ctx.pool_upsert("_tracks", name, track_data.clone());
            }
        } else {
            // Single track with "name" field
            let name = v
                .get("name")
                .and_then(|v| v.as_str())
                .unwrap_or("default")
                .to_string();
            ctx.pool_upsert("_tracks", &name, v);
        }
    }

    // ─── Process control ───
    let mut playback_state: String = ctx
        .get_pool("_tl")
        .into_iter()
        .find(|(k, _)| k == "state")
        .and_then(|(_, v)| v.as_str().map(|s| s.to_string()))
        .unwrap_or_else(|| {
            if autoplay {
                "playing".into()
            } else {
                "paused".into()
            }
        });

    // Track whether the completed frame has already been emitted.
    // Once emitted, the timeline goes silent until a new play/reverse resets this.
    let mut completed_emitted: bool = ctx
        .get_pool("_tl")
        .into_iter()
        .find(|(k, _)| k == "completed_emitted")
        .and_then(|(_, v)| v.as_bool())
        .unwrap_or(false);

    let mut elapsed: f64 = ctx
        .get_pool("_tl")
        .into_iter()
        .find(|(k, _)| k == "elapsed")
        .and_then(|(_, v)| v.as_f64())
        .unwrap_or(0.0);

    let mut speed: f64 = ctx
        .get_pool("_tl")
        .into_iter()
        .find(|(k, _)| k == "speed")
        .and_then(|(_, v)| v.as_f64())
        .unwrap_or(config.get("speed").and_then(|v| v.as_f64()).unwrap_or(1.0));

    // Track whether a control command changed playback this tick.
    // When true, skip time advance so the first emitted frame shows
    // the starting value — prevents a visible jump on easeOut curves.
    let mut control_changed = false;

    if let Some(Message::String(cmd)) = payload.get("control") {
        let cmd = cmd.to_string();
        match cmd.as_str() {
            "play" => {
                // If replaying a completed timeline, rewind first
                if playback_state == "completed" {
                    elapsed = 0.0;
                }
                completed_emitted = false;
                playback_state = "playing".into();
                control_changed = true;
            }
            "pause" => playback_state = "paused".into(),
            "stop" => {
                playback_state = "paused".into();
                elapsed = 0.0;
            }
            "reverse" => {
                // Jump to end only if we've actually been played (completed or mid-play).
                // Do NOT jump when paused/never-triggered (elapsed=0 from initial state).
                if elapsed == 0.0 && (playback_state == "completed" || playback_state == "playing")
                {
                    elapsed = duration;
                }
                completed_emitted = false;
                speed = -speed.abs();
                playback_state = "playing".into();
                control_changed = true;
            }
            _ if cmd.starts_with("seek:") => {
                if let Ok(t) = cmd[5..].trim().parse::<f64>() {
                    elapsed = t.clamp(0.0, duration);
                }
            }
            _ => {}
        }
    }
    // Accept Object { "cmd": "play"|"reverse"|"stop"|"pause"|"seek:N" } from subscriber:data
    if let Some(Message::Object(obj)) = payload.get("control") {
        let v: Value = obj.as_ref().clone().into();
        if let Some(cmd_str) = v.get("cmd").and_then(|c| c.as_str()) {
            match cmd_str {
                "play" => {
                    if playback_state == "completed" {
                        elapsed = 0.0;
                    }
                    completed_emitted = false;
                    speed = speed.abs();
                    playback_state = "playing".into();
                    control_changed = true;
                }
                "reverse" => {
                    if elapsed == 0.0
                        && (playback_state == "completed" || playback_state == "playing")
                    {
                        elapsed = duration;
                    }
                    completed_emitted = false;
                    speed = -speed.abs();
                    playback_state = "playing".into();
                    control_changed = true;
                }
                "stop" => {
                    playback_state = "paused".into();
                    elapsed = 0.0;
                }
                "pause" => {
                    playback_state = "paused".into();
                }
                _ if cmd_str.starts_with("seek:") => {
                    if let Ok(t) = cmd_str[5..].trim().parse::<f64>() {
                        elapsed = t.clamp(0.0, duration);
                    }
                }
                _ => {}
            }
        }
    }

    // Also accept Flow on control to start (rewind if completed)
    if let Some(Message::Flow) = payload.get("control") {
        if playback_state == "completed" {
            elapsed = 0.0;
        }
        completed_emitted = false;
        playback_state = "playing".into();
    }

    // ─── Advance time ───
    // Skip advance on the tick that received a control command so the first
    // emitted frame shows the starting value (prevents visible jump on steep
    // easing curves like easeOutCubic).
    if playback_state == "playing" && payload.contains_key("tick") && !control_changed {
        elapsed += dt * speed;

        if elapsed >= duration {
            if do_loop {
                elapsed %= duration;
            } else {
                elapsed = duration;
                playback_state = "completed".into();
            }
        } else if elapsed < 0.0 {
            if do_loop {
                elapsed = duration + (elapsed % duration);
            } else {
                elapsed = 0.0;
                playback_state = "completed".into();
            }
        }
    }

    ctx.pool_upsert("_tl", "state", json!(playback_state));
    ctx.pool_upsert("_tl", "elapsed", json!(elapsed));
    ctx.pool_upsert("_tl", "speed", json!(speed));
    ctx.pool_upsert("_tl", "completed_emitted", json!(completed_emitted));

    let progress = if duration > 0.0 {
        elapsed / duration
    } else {
        1.0
    };

    // ─── Evaluate all pooled tracks with stagger ───
    let track_pool: Vec<(String, Value)> = ctx.get_pool("_tracks").into_iter().collect();

    let mut out = HashMap::new();

    // Compute stagger delays
    let stagger_delays = compute_stagger(&config, &track_pool);

    for (i, (track_name, track_data)) in track_pool.iter().enumerate() {
        let keyframes = track_data.get("keyframes").and_then(|v| v.as_array());

        if let Some(kf) = keyframes {
            // Per-track delay = explicit delay + stagger offset
            let explicit_delay = track_data
                .get("delay")
                .and_then(|v| v.as_f64())
                .unwrap_or(0.0);
            let stagger_delay = stagger_delays.get(i).copied().unwrap_or(0.0);
            let track_time = elapsed - explicit_delay - stagger_delay;

            // Before delay: hold at first keyframe value (start state).
            // After delay: interpolate keyframes normally.
            let value = if track_time >= 0.0 {
                evaluate_keyframes(kf, track_time)
            } else {
                kf.first().and_then(|kf0| kf0.get("value").cloned())
            };

            if let Some(value) = value {
                let msg = match &value {
                    Value::Number(n) => {
                        if let Some(f) = n.as_f64() {
                            Message::Float(f)
                        } else if let Some(i) = n.as_i64() {
                            Message::Integer(i)
                        } else {
                            Message::object(EncodableValue::from(value.clone()))
                        }
                    }
                    _ => Message::object(EncodableValue::from(value)),
                };
                out.insert(track_name.clone(), msg);
            }
        }
    }

    // Micro-timelines with autoplay:false should be silent until triggered.
    // - "paused": never triggered → no output (avoids spurious downstream fires).
    // - "playing": emit every tick.
    // - "completed": emit the final frame exactly once, then go silent until
    //   a new play/reverse resets completed_emitted. This prevents continuously
    //   re-triggering downstream actors (e.g. renderer) with unchanged values.
    let should_emit_values = autoplay
        || playback_state == "playing"
        || (playback_state == "completed" && !completed_emitted);

    if !should_emit_values {
        return Ok(HashMap::new()); // Completely silent — no Optional(None) to connectors.
    }

    // Mark completed frame as emitted so subsequent ticks go silent.
    if playback_state == "completed" {
        ctx.pool_upsert("_tl", "completed_emitted", json!(true));
    }

    // Output all track values as one object on `values` outport
    // so downstream actors get all animated values in one message per tick
    if !out.is_empty() {
        let mut values_obj = serde_json::Map::new();
        for (k, v) in &out {
            match v {
                Message::Float(f) => {
                    values_obj.insert(k.clone(), json!(f));
                }
                Message::Integer(i) => {
                    values_obj.insert(k.clone(), json!(i));
                }
                _ => {}
            }
        }
        if !values_obj.is_empty() {
            out.insert(
                "values".to_string(),
                Message::object(EncodableValue::from(Value::Object(values_obj))),
            );
        }
    }

    out.insert(
        "state".to_string(),
        Message::String(playback_state.clone().into()),
    );
    out.insert("progress".to_string(), Message::Float(progress));
    out.insert(
        "metadata".to_string(),
        Message::object(EncodableValue::from(json!({
            "state": playback_state,
            "elapsed": elapsed,
            "progress": progress,
            "speed": speed,
            "trackCount": track_pool.len(),
            "trackNames": track_pool.iter().map(|(n, _)| n.as_str()).collect::<Vec<_>>(),
        }))),
    );
    Ok(out)
}

/// Compute per-track stagger delays from config.
fn compute_stagger(config: &HashMap<String, Value>, tracks: &[(String, Value)]) -> Vec<f64> {
    let n = tracks.len();
    if n == 0 {
        return Vec::new();
    }

    let stagger = match config.get("stagger") {
        Some(v) if v.is_object() => v,
        // Shorthand: "stagger": 0.1 → delay 0.1 per track
        Some(v) if v.is_number() => {
            let delay = v.as_f64().unwrap_or(0.0);
            return (0..n).map(|i| i as f64 * delay).collect();
        }
        _ => return vec![0.0; n],
    };

    let delay = stagger.get("delay").and_then(|v| v.as_f64()).unwrap_or(0.0);
    if delay == 0.0 {
        return vec![0.0; n];
    }

    let order = stagger
        .get("order")
        .and_then(|v| v.as_str())
        .unwrap_or("index");
    let from = stagger
        .get("from")
        .and_then(|v| v.as_str())
        .unwrap_or("start");
    let stagger_easing = stagger
        .get("easing")
        .and_then(|v| v.as_str())
        .unwrap_or("linear");

    // Build index order
    let mut indices: Vec<usize> = (0..n).collect();
    match order {
        "name" => {
            let mut named: Vec<(usize, &str)> = tracks
                .iter()
                .enumerate()
                .map(|(i, (name, _))| (i, name.as_str()))
                .collect();
            named.sort_by_key(|(_, name)| *name);
            indices = named.iter().map(|(i, _)| *i).collect();
        }
        "reverse" => indices.reverse(),
        _ => {} // "index" = arrival order, already correct
    }

    // Compute raw positions [0..1] for each track in the stagger
    let mut delays = vec![0.0f64; n];
    let max_idx = (n - 1).max(1) as f64;

    for (rank, &original_idx) in indices.iter().enumerate() {
        let normalized = rank as f64 / max_idx; // 0..1

        // Apply "from" mode
        let adjusted = match from {
            "end" => 1.0 - normalized,
            "center" => {
                let center_dist = (normalized - 0.5).abs() * 2.0; // 0 at center, 1 at edges
                center_dist
            }
            "edges" => {
                let center_dist = (normalized - 0.5).abs() * 2.0;
                1.0 - center_dist // 0 at edges, 1 at center
            }
            _ => normalized, // "start"
        };

        // Apply stagger easing
        let eased = easing::eval(stagger_easing, adjusted);
        delays[original_idx] = eased * delay * max_idx;
    }

    delays
}

fn evaluate_keyframes(keyframes: &[Value], time: f64) -> Option<Value> {
    if keyframes.is_empty() {
        return None;
    }
    if keyframes.len() == 1 {
        return keyframes[0].get("value").cloned();
    }

    let mut prev_idx = 0;
    let mut next_idx = keyframes.len() - 1;

    for (i, kf) in keyframes.iter().enumerate() {
        let kt = kf.get("time").and_then(|v| v.as_f64()).unwrap_or(0.0);
        if kt <= time {
            prev_idx = i;
        }
        if kt >= time && i > prev_idx {
            next_idx = i;
            break;
        }
    }

    if prev_idx == next_idx {
        return keyframes[prev_idx].get("value").cloned();
    }

    let prev = &keyframes[prev_idx];
    let next = &keyframes[next_idx];
    let pt = prev.get("time").and_then(|v| v.as_f64()).unwrap_or(0.0);
    let nt = next.get("time").and_then(|v| v.as_f64()).unwrap_or(1.0);
    let pv = prev.get("value")?;
    let nv = next.get("value")?;
    let easing_fn = prev
        .get("easing")
        .and_then(|v| v.as_str())
        .unwrap_or("linear");

    let seg = nt - pt;
    let t = if seg > 0.0 {
        ((time - pt) / seg).clamp(0.0, 1.0)
    } else {
        1.0
    };
    let e = easing::eval(easing_fn, t);

    Some(interpolate(pv, nv, e))
}

fn interpolate(from: &Value, to: &Value, t: f64) -> Value {
    match (from, to) {
        (Value::Number(a), Value::Number(b)) => {
            let a = a.as_f64().unwrap_or(0.0);
            let b = b.as_f64().unwrap_or(0.0);
            json!(a + (b - a) * t)
        }
        (Value::Array(a), Value::Array(b)) if a.len() == b.len() => {
            let r: Vec<f64> = a
                .iter()
                .zip(b.iter())
                .map(|(av, bv)| {
                    let a = av.as_f64().unwrap_or(0.0);
                    let b = bv.as_f64().unwrap_or(0.0);
                    a + (b - a) * t
                })
                .collect();
            json!(r)
        }
        _ => {
            if t >= 0.5 {
                to.clone()
            } else {
                from.clone()
            }
        }
    }
}