diff options
| author | skal <pascal.massimino@gmail.com> | 2026-02-16 11:58:34 +0100 |
|---|---|---|
| committer | skal <pascal.massimino@gmail.com> | 2026-02-16 11:58:34 +0100 |
| commit | 7a383635525c9f9617965f3c79a9f2d6c86550cd (patch) | |
| tree | 84491cede72c416e2f0b8131854c849c4b1454a5 /doc/SEQUENCE_v2.md | |
| parent | af5d0e4c3a6cb773a4fb51ac32f4c33a7f8d8224 (diff) | |
docs(sequence): update and compact v2 documentation
Documentation Changes:
- Rewrote SEQUENCE_v2.md: practical guide focused on actual implementation
- Removed design philosophy, added concrete examples
- Documented all implemented features and current limitations
- Added effect creation templates (standard post-process, 3D with depth)
- 130 lines → 222 lines (expanded with examples)
- Updated EFFECT_WORKFLOW.md for v2
- Changed from v1 Effect/PostProcessEffect to EffectV2
- Updated all steps for v2 workflow (6 steps instead of 8)
- Added complete templates with proper v2 signatures
- Documented common issues and solutions
- Removed v1-specific content
- Archived v1 documentation
- Moved doc/SEQUENCE.md → doc/archive/SEQUENCE_V1.md
- V1 system removed, documentation preserved for reference
Content Focus:
- Quick start examples (simple chain, multi-output, ping-pong)
- Timeline syntax reference with REQUIRED priority modifiers
- Architecture overview (SequenceV2, EffectV2, Node system)
- Compiler features (DAG validation, topological sort, ping-pong detection)
- Practical templates (copy-paste ready)
- Common issues section (build errors, runtime errors)
Status Documentation:
- ✅ Implemented: DAG validation, node aliasing, 7 effects ported
- ❌ Missing: Flatten mode, BPM handling, GetDemoDuration calculation
- TODO: Port remaining effects, implement flatten, update HTML editor
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Diffstat (limited to 'doc/SEQUENCE_v2.md')
| -rw-r--r-- | doc/SEQUENCE_v2.md | 279 |
1 files changed, 185 insertions, 94 deletions
diff --git a/doc/SEQUENCE_v2.md b/doc/SEQUENCE_v2.md index 0e9d5a9..7ce6efc 100644 --- a/doc/SEQUENCE_v2.md +++ b/doc/SEQUENCE_v2.md @@ -1,130 +1,221 @@ -# Sequence v2 System Documentation +# Sequence v2: DAG-based Effect Routing -**Status:** Phase 1 & 2 complete (Foundation + Compiler operational) +**Status:** ✅ Operational (Phase 4 complete, v1 removed) + +Explicit node system with DAG effect routing. Replaces v1 implicit framebuffer ping-pong. ## Quick Start ```bash -# Compile v2 timeline to C++ -python3 tools/seq_compiler_v2.py input.seq --output generated/timeline_v2.cc +# Compile timeline +python3 tools/seq_compiler_v2.py workspaces/main/timeline_v2.seq --output src/generated/timeline.cc -# Final mode (flattened, no vtables) -python3 tools/seq_compiler_v2.py input.seq --output timeline_v2.cc --flatten +# Flatten mode (future: inline effects, no vtables) +python3 tools/seq_compiler_v2.py timeline.seq --output timeline.cc --flatten ``` -## v2 Timeline Syntax +## Timeline Syntax ``` -# BPM 120 +# BPM 120 (optional, currently ignored) -SEQUENCE 0.0 0 "sequence_name" +SEQUENCE <start_time> <priority> ["name"] # Node declarations (optional, auto-inferred as u8x4_norm) - NODE gbuf_normal f16x8 + NODE temp1 u8x4_norm NODE depth depth24 + NODE gbuf_normal f16x8 - # Asset dependencies + # Asset dependencies (validated at compile-time) ASSET shader_blur - # Effect routing: inputs... -> outputs... - EFFECT + DeferredRender source depth -> gbuf_normal gbuf_pos 0.0 10.0 - EFFECT + Compose gbuf_normal gbuf_pos -> composed 0.0 10.0 - EFFECT + Blur composed -> sink 0.0 10.0 + # Effect routing with priority modifier + EFFECT <+|=|-> EffectClass input1 input2 -> output1 output2 start end [params] +``` + +**Priority modifiers** (REQUIRED): +- `+` : Increment priority (foreground) +- `=` : Same priority as previous +- `-` : Decrement priority (background) + +**Node types**: `u8x4_norm` (default), `f32x4`, `f16x8`, `depth24`, `compute_f32` + +**Reserved nodes**: `source` (input), `sink` (output) + +### Examples + +**Simple chain:** +``` +SEQUENCE 0.0 0 "basic" + EFFECT + HeptagonEffect source -> temp1 0.0 10.0 + EFFECT + GaussianBlur temp1 -> sink 0.0 10.0 +``` + +**Multi-output (G-buffer):** +``` +SEQUENCE 0.0 0 "deferred" + NODE gbuf_n f16x8 + NODE gbuf_p f32x4 + NODE depth depth24 + + EFFECT + DeferredRender source depth -> gbuf_n gbuf_p 0.0 10.0 + EFFECT + Compose gbuf_n gbuf_p -> sink 0.0 10.0 +``` + +**Ping-pong (auto-optimized):** +``` +SEQUENCE 0.0 0 "blur" + # Compiler detects alternating pattern, aliases temp2 -> temp1 + EFFECT + BlurH source -> temp1 0.0 10.0 + EFFECT + BlurV temp1 -> temp2 0.0 10.0 + EFFECT + Sharpen temp2 -> sink 0.0 10.0 +``` + +## Architecture + +### SequenceV2 Class + +```cpp +class SequenceV2 { + NodeRegistry nodes_; // Typed texture management + std::vector<EffectDAGNode> effect_dag_; // Topologically sorted + UniformsSequenceParams params_; // Per-frame uniforms + + virtual void preprocess(float time, float beat_time, float beat_phase, float audio_intensity); + virtual void render_effects(WGPUCommandEncoder encoder); +}; +``` + +### EffectV2 Class + +```cpp +class EffectV2 { + std::vector<std::string> input_nodes_; + std::vector<std::string> output_nodes_; + + virtual void declare_nodes(NodeRegistry& registry) {} // Optional temp nodes + virtual void render(WGPUCommandEncoder encoder, + const UniformsSequenceParams& params, + NodeRegistry& nodes) = 0; +}; ``` -**Node types:** `u8x4_norm`, `f32x4`, `f16x8`, `depth24`, `compute_f32` +### Node System -**Priority modifiers:** `+` (increment), `=` (same), `-` (decrement) +**Types**: Match WGSL texture formats +- `U8X4_NORM`: RGBA8Unorm (default for source/sink/intermediate) +- `F32X4`: RGBA32Float (HDR, compute outputs) +- `F16X8`: 8-channel float16 (G-buffer normals/vectors) +- `DEPTH24`: Depth24Plus (3D rendering) +- `COMPUTE_F32`: Storage buffer (non-texture compute data) ---- +**Aliasing**: Compiler detects ping-pong patterns (Effect i writes A reads B, Effect i+1 writes B reads A) and aliases nodes to same backing texture. -This document describes the high-level ideas for an improved Sequence + Effects system "version 2". +## Compiler Features -## Goal +**seq_compiler_v2.py** generates optimized C++ from `.seq`: -* more flexibility and less boilerplate -* fully configurable by text (.seq) -* no compatibility with previous version of sequences -* sequence can be stacked (with priority) and arranged in a timeline to create a demo +1. **DAG Validation**: Cycle detection, connectivity checks +2. **Topological Sort**: Execution order from dependencies +3. **Ping-pong Detection**: Automatic node aliasing +4. **Code Generation**: SequenceV2 subclasses with node declarations and effect DAG -## Structure +**Output**: Single `.cc` file with: +- Multiple `SequenceV2` subclasses (one per SEQUENCE) +- `InitializeV2Sequences()` - Registry initialization +- `GetActiveV2Sequence(float time)` - Active sequence lookup +- `RenderV2Timeline()` - Encoder-based and surface-based variants -### Sequence +## Creating Effects -A 'Sequence' unit consist of: - * A predeclared set of named assets and Effects that are used during the sequence - * a start-time, end-time - * a globally-visible set of internal time-dependent params (UniformsSequenceParams) derived from GlobalParams - * a globally-visible set of fixed params values (UniformsSequenceStaticParams) used to configure effects - * an input in RGBAu8 format ("Source"). Black by default (RGB=0,0,0,255). Buffer format: u8x4_norm (see below) - * an output in RGBAu8 format ("Sink"). This output goes to the next sequence in stack or to physical display - * the sink of a Sequence is the source of the next Sequence in the stack, or goes to screen if it's the last sequence in stack - * three programatic sections: 'Preprocess', 'EffectFlow' (time-ordered set of effects), 'Postprocess' - * a set of internal buffers (Nodes = compute buffers or textures, used as input or render targets by effects stack) - * this Nodes are visible to the final post-process effect - * Node persists during the whole sequence - * at compile time, one can detect which Node can actually be ping-pong buffers - * each Sequence's preprocess and postprocess is unique and attached to the sequence +**For standard post-process:** +```cpp +class MyEffectV2 : public EffectV2 { + WGPURenderPipeline pipeline_; + UniformBuffer<UniformsSequenceParams> uniforms_; -### Effects + MyEffectV2(const GpuContext& ctx, const std::vector<std::string>& inputs, + const std::vector<std::string>& outputs) + : EffectV2(ctx, inputs, outputs) { + uniforms_.init(ctx_.device); + pipeline_ = create_post_process_pipeline(ctx_.device, + WGPUTextureFormat_RGBA8Unorm, + my_shader_wgsl); + } -The effect unit consists in: - * An 'Effect' within the Sequence uses the UniformsSequenceParams and GlobalParams to update its internal state - * Receives updated InputNode from the previous effects (InputNode = buffer, textures, g-buffer, ...) - * processes them with a shader or c++ code (3d engine, etc.) - * fills its OutputNode, passed to the next effect or the final postprocessing step - * uses the sequence's assets and params only - * if needed an effect predefines an alias of one of its internal buffer as its declared 'postprocess_output' OutputNode - * by default, postprocess_output = sequence RGBA Source - * Effect's are not attached to a particular Sequence, and can be used in any Sequence + void render(WGPUCommandEncoder encoder, const UniformsSequenceParams& params, + NodeRegistry& nodes) override { + WGPUTextureView input = nodes.get_view(input_nodes_[0]); + WGPUTextureView output = nodes.get_view(output_nodes_[0]); + uniforms_.update(ctx_.queue, params); + // ... render pass + } +}; +``` + +**For 3D effects with depth:** +```cpp +class My3DEffectV2 : public EffectV2 { + std::string depth_node_; + + My3DEffectV2(...) : EffectV2(...), depth_node_(outputs[0] + "_depth") {} + + void declare_nodes(NodeRegistry& registry) override { + registry.declare_node(depth_node_, NodeType::DEPTH24, -1, -1); + } + + void render(...) { + WGPUTextureView color = nodes.get_view(output_nodes_[0]); + WGPUTextureView depth = nodes.get_view(depth_node_); + // ... render pass with depth attachment + } +}; +``` + +## Uniform Access + +```cpp +params.time; // Physical seconds (constant speed) +params.beat_time; // Musical beats (tempo-scaled) +params.beat_phase; // Fractional beat 0.0-1.0 +params.audio_intensity; // Audio peak for beat sync +params.resolution; // vec2(width, height) +params.aspect_ratio; // width/height +``` -### Preprocess: - * the preprocessing step sets up the local UniformsSequenceParams (prepare timers, objects' transforms, camera position, fills Uniform buffers, etc.) - * it's a single function attached to the Sequence unit (virtual method?) +## Status & Limitations -### Postprocess: - * the post-process unique (virtual) function is responsible for the final assembly into OuputNode - * it can take any internal Node as input (most likely the last effects' output) and produces its final Sink content +**Implemented** ✅: +- DAG validation, topological sort, ping-pong optimization +- Multi-input/multi-output effects +- Node aliasing (compile-time optimization) +- 7 effects ported (Passthrough, Placeholder, GaussianBlur, Heptagon, Particles, RotatingCube, Hybrid3D) -## How it works +**Missing/Future** ❌: +- Flatten mode (--flatten generates same code as dev mode) +- BPM handling (parsed but ignored) +- GetDemoDuration() calculation (hardcoded 40.0f) +- Sequence-relative time (uses global time) +- Asset validation (not checked against AssetId enum) +- Node type compatibility checking -### initialization +**TODO**: +- Port remaining effects (10+ effects, CNN effects) +- Implement flatten mode (inline effects, direct members) +- Update HTML timeline editor for v2 graph visualization -at initialization time, the sequence knows from compile-time: - * the list of assets it needs to be ready at start time - * the list of effects needed, their input nodes, their output node - * the list of internal textures, buffer, render target, depth-buffer it will need for its stack effect to work - * which intern Node buffers can actually be ping-pong buffers, to optimize resource - * generally speaking, the lifetime of a buffer during a frame is known at compile time and can be optimized +## Migration Notes -### Flow - * preprocess: prepare internal state at time t: UniformsSequenceParams - * for each effects: - ** bind the InputNode nodes (previous effect buffers, compute buffers, etc.) - ** runs the compute, vertex and fragment passes - ** fills its output Nodes - * process: turns its pre-declared input Nodes into its unique Sink node, ready for next sequence, or display +**V1 → V2 Differences**: +- V1: Implicit framebuffer ping-pong (framebuffer_a_ ↔ framebuffer_b_) +- V2: Explicit node declarations with routing -## Requirement +**Breaking Changes**: +- Effect base class changed (Effect → EffectV2) +- Constructor signature: `(GpuContext, inputs[], outputs[])` +- Render signature: Added `NodeRegistry& nodes` parameter +- No `is_post_process()` method (routing makes it explicit) - * unified code to flow the engine - * textual description of the sequence/effects arrangement (similar to the .seq) - * update the HTML editor tool - * unified description of buffer, texture and compute buffers at compilation time - ** example, of a sequence's internal Node declaration: - "NODE Name1 u8x16_norm" - "NODE Name2 f32x4" - "NODE Name3 f16x8" - "Node Name4 u8x4_norm" <- Source/Sink of a sequence, four bytes - * each effect - ** declares its requirement as input Node. - ** declares its output Node - ** can access the C++ version and WebGPU versions of GlobalParams, UniformsSequenceParams and UniformsSequenceStaticParams - ** are not attached to a particular sequence, but can be used in many - * validation and optimization at compile time (generating c++ code) by seq_compiler - * compilation can generate boilerplate preprocess() / postprocess() functions - * no backward compatibility needed. Sequence v1 can go. - * the HTML Editor overall code, look and functionalities need to be preserved though. Just adapted to v2. - ** basically the sequence box will need to show input Node and output Node and have an editable property panel for these - ** same for effects: ability to edit their input Node and output Node names - * a lot of v1 effects can be deleted (solarized, chroma aberration, etc.): they will be implemented ad-hoc in postprocess() with a single macro call within the final shader - * need a minimal migration plan for code. +**See Also**: +- `doc/EFFECT_WORKFLOW.md` - Step-by-step effect creation +- `tools/seq_compiler_v2.py` - Compiler implementation +- `workspaces/main/timeline_v2.seq` - Example timeline |
