@octoseq/visualiser 0.1.0-main.4ecb074 → 0.1.0-main.5fdb072

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@octoseq/visualiser",
-    "version": "0.1.0-main.4ecb074",
+    "version": "0.1.0-main.5fdb072",
     "description": "WASM-based visualiser for Octoseq",
     "license": "MIT",
     "repository": {

package/pkg/visualiser.d.ts

@@ -8,6 +8,10 @@ export class WasmVisualiser {
    * Check if a script is currently loaded.
    */
   has_script(): boolean;
+  /**
+   * Check if a signal variable exists in the current script.
+   */
+  has_signal(name: string): boolean;
   /**
    * Load a Rhai script for controlling the visualiser.
    * Returns true if the script was loaded successfully.
@@ -18,12 +22,30 @@ export class WasmVisualiser {
    * The signal will be available as `inputs.<name>` in Rhai scripts.
    */
   push_signal(name: string, samples: Float32Array, sample_rate: number): void;
+  /**
+   * Run script in analysis mode to collect debug.emit() signals.
+   *
+   * This runs the script headlessly across the full track duration,
+   * collecting all debug.emit() calls without rendering.
+   *
+   * Returns a JSON-serialized AnalysisResultJson.
+   */
+  run_analysis(script: string, duration: number, time_step: number): string;
   /**
    * Clear all named signals.
    */
   clear_signals(): void;
   set_sigmoid_k(k: number): void;
+  /**
+   * Isolate a single entity for rendering (useful for debugging).
+   * Only this entity will be rendered.
+   */
+  isolate_entity(entity_id: bigint): void;
   push_zoom_data(samples: Float32Array, sample_rate: number): void;
+  /**
+   * Clear entity isolation, resume normal rendering.
+   */
+  clear_isolation(): void;
   /**
    * Get current state values for debugging.
    * Returns [time, scene_entity_count, mesh_count, line_count]
@@ -33,7 +55,312 @@ export class WasmVisualiser {
    * Get the last script error message, if any.
    */
   get_script_error(): string | undefined;
+  /**
+   * Get the list of available signal names.
+   * Returns a JSON array of signal names.
+   */
+  get_signal_names(): string;
+  /**
+   * Get a list of all registered mesh asset IDs.
+   * Returns a JSON array of asset IDs.
+   */
+  list_mesh_assets(): string;
+  /**
+   * Push pre-extracted events for a band.
+   *
+   * Events are extracted by the TypeScript layer using the existing peak picker,
+   * then pushed here for script access via `inputs.bands[id].events`.
+   *
+   * The JSON format should be an array of event objects with:
+   * - time: f32
+   * - weight: f32
+   * - beat_position: Option<f32>
+   * - beat_phase: Option<f32>
+   * - cluster_id: Option<u32>
+   *
+   * Returns true if successful, false if parsing failed.
+   */
+  push_band_events(band_id: string, events_json: string): boolean;
+  /**
+   * Push a band-scoped signal for use in scripts.
+   * The signal will be available as `inputs.bands[band_id].{feature}` in Rhai scripts.
+   * Stores under both band_id and band_label for dual-access support.
+   *
+   * - `band_id`: The unique ID of the frequency band.
+   * - `band_label`: The user-visible label of the band.
+   * - `feature`: Signal type ("energy", "onset", "flux").
+   * - `samples`: Signal data.
+   * - `sample_rate`: Sample rate of the signal.
+   */
+  push_band_signal(band_id: string, band_label: string, feature: string, samples: Float32Array, sample_rate: number): void;
+  /**
+   * Push a stem-scoped signal for use in scripts.
+   * The signal will be available as `inputs.stems[stem_id].{feature}` in Rhai scripts.
+   * Stores under both stem_id and stem_label for dual-access support.
+   *
+   * - `stem_id`: The unique ID of the stem.
+   * - `stem_label`: The user-visible label of the stem.
+   * - `feature`: Signal type ("energy", "onset", "flux").
+   * - `samples`: Signal data.
+   * - `sample_rate`: Sample rate of the signal.
+   */
+  push_stem_signal(stem_id: string, stem_label: string, feature: string, samples: Float32Array, sample_rate: number): void;
+  /**
+   * Set the musical time structure for beat-aware signal processing.
+   * The JSON format matches the TypeScript MusicalTimeStructure type.
+   * Returns true if successful, false if parsing failed.
+   */
+  set_musical_time(json: string): boolean;
+  /**
+   * Clear all band event streams.
+   */
+  clear_band_events(): void;
+  /**
+   * Push a named event stream (e.g., "beatCandidates") for script access.
+   *
+   * The event stream will be available as `inputs.<name>` in Rhai scripts.
+   * This is used for MIR-derived events like beat candidates, onset peaks, etc.
+   *
+   * The JSON format should be an array of event objects with:
+   * - time: f32
+   * - weight: f32
+   * - beat_position: Option<f32>
+   * - beat_phase: Option<f32>
+   * - cluster_id: Option<u32>
+   *
+   * Returns true if successful, false if parsing failed.
+   */
+  push_event_stream(name: string, events_json: string): boolean;
+  /**
+   * Set debug visualization options.
+   */
+  set_debug_options(wireframe: boolean, bounding_boxes: boolean): void;
+  /**
+   * Clear all band signals.
+   */
+  clear_band_signals(): void;
+  /**
+   * Clear the musical time structure.
+   * Beat-aware operations will fall back to 120 BPM default.
+   */
+  clear_musical_time(): void;
+  /**
+   * Clear all stem signals.
+   */
+  clear_stem_signals(): void;
+  /**
+   * Get frequency bounds for all active bands at a given time.
+   * Returns a JSON array of { bandId, label, lowHz, highHz, enabled } objects.
+   */
+  get_band_bounds_at(time: number): string;
+  /**
+   * Get all Signal variables from the current script.
+   * Returns a JSON array of ScriptSignalInfo objects.
+   */
+  get_script_signals(): string;
+  /**
+   * Push a custom signal for use in scripts.
+   * The signal will be available as `inputs.customSignals["signal_id"]` in Rhai scripts.
+   *
+   * - `signal_id`: The unique ID of the custom signal.
+   * - `label`: The user-visible label of the signal.
+   * - `samples`: Signal data.
+   * - `sample_rate`: Sample rate of the signal.
+   */
+  push_custom_signal(signal_id: string, label: string, samples: Float32Array, sample_rate: number): void;
   push_rotation_data(samples: Float32Array, sample_rate: number): void;
+  /**
+   * Render with a frame budget timeout.
+   *
+   * If the frame takes longer than `budget_ms` to process, it will be dropped
+   * and a warning logged. This prevents expensive scripts from freezing the browser.
+   *
+   * Returns true if the frame completed, false if it was dropped due to budget.
+   */
+  render_with_budget(dt: number, budget_ms: number): boolean;
+  /**
+   * Clear all named event streams.
+   */
+  clear_event_streams(): void;
+  /**
+   * Check if frequency bands are currently set.
+   */
+  has_frequency_bands(): boolean;
+  /**
+   * Register a mesh asset from OBJ content.
+   * The asset will be available as `mesh.load(asset_id)` in scripts.
+   * Returns true if successful, false if parsing failed.
+   */
+  register_mesh_asset(asset_id: string, obj_content: string): boolean;
+  /**
+   * Set available stems for script namespace generation.
+   * This registers stem IDs and labels so the script engine can generate
+   * `inputs.stems["stem_id"]` and `inputs.stems["label"]` accessors.
+   *
+   * The JSON format should be an array of [id, label] pairs:
+   * `[["stem-abc123", "Drums"], ["stem-def456", "Bass"]]`
+   *
+   * Returns true if successful, false if parsing failed.
+   */
+  set_available_stems(json: string): boolean;
+  /**
+   * Set the frequency band structure for band-aware processing.
+   * The JSON format matches the TypeScript FrequencyBandStructure type.
+   * Returns true if successful, false if parsing failed.
+   */
+  set_frequency_bands(json: string): boolean;
+  /**
+   * Analyze a signal chain with localized sampling.
+   *
+   * Returns JSON with either:
+   * - SignalChainAnalysis on success
+   * - { "error": "message" } on failure
+   *
+   * Parameters:
+   * - signal_name: Name of the signal variable in the script
+   * - center_time: Time to center analysis around (seconds)
+   * - window_beats: Number of beats before/after center to sample
+   * - sample_count: Number of samples to take
+   */
+  analyze_signal_chain(signal_name: string, center_time: number, window_beats: number, sample_count: number): string;
+  /**
+   * Clear all custom signals.
+   */
+  clear_custom_signals(): void;
+  /**
+   * Get the number of events for a specific band.
+   * Returns 0 if no events are stored for this band.
+   */
+  get_band_event_count(band_id: string): number;
+  /**
+   * Get list of band keys (IDs and labels) that have signals.
+   * Returns a JSON array of strings.
+   */
+  get_band_signal_keys(): string;
+  /**
+   * Get list of stem keys (IDs and labels) that have signals.
+   * Returns a JSON array of strings.
+   */
+  get_stem_signal_keys(): string;
+  /**
+   * Check if performance profiling is currently enabled.
+   */
+  is_profiling_enabled(): boolean;
+  /**
+   * Push a composed signal for use in scripts.
+   * The signal will be available as `inputs.composedSignals["name"]` in Rhai scripts.
+   *
+   * - `name`: The composed signal name (composed signals are keyed by name only).
+   * - `samples`: Signal data.
+   * - `sample_rate`: Sample rate of the signal.
+   */
+  push_composed_signal(name: string, samples: Float32Array, sample_rate: number): void;
+  /**
+   * Clear the frequency band structure.
+   */
+  clear_frequency_bands(): void;
+  /**
+   * Get camera state as JSON for inspector.
+   * Returns current position, rotation, target, fov, near, far, mode, and signal flags.
+   */
+  get_camera_state_json(): string;
+  /**
+   * Enable or disable performance profiling.
+   * When enabled, console timing and collection size logging will be active.
+   */
+  set_profiling_enabled(enabled: boolean): void;
+  /**
+   * Unregister a mesh asset.
+   * Returns true if the asset was unregistered, false if it didn't exist.
+   */
+  unregister_mesh_asset(asset_id: string): boolean;
+  /**
+   * Clear all composed signals.
+   */
+  clear_composed_signals(): void;
+  /**
+   * Get list of custom signal keys (IDs and labels).
+   * Returns a JSON array of strings.
+   */
+  get_custom_signal_keys(): string;
+  /**
+   * Get the number of events in a named event stream.
+   * Returns 0 if no events are stored for this name.
+   */
+  get_event_stream_count(name: string): number;
+  /**
+   * Get the number of frequency bands.
+   */
+  get_frequency_band_count(): number;
+  /**
+   * Run script in analysis mode with event extraction support.
+   *
+   * This runs the script headlessly across the full track duration,
+   * collecting all debug.emit() calls AND extracting events from
+   * any signal.pick.events() calls.
+   *
+   * Returns a JSON-serialized ExtendedAnalysisResultJson.
+   */
+  run_analysis_with_events(script: string, duration: number, time_step: number): string;
+  /**
+   * Get entity positions as JSON for debugging.
+   * Returns a JSON array of objects with id, type, and position fields.
+   */
+  get_entity_positions_json(): string;
+  /**
+   * Push an authored event stream for script access.
+   *
+   * The event stream will be available as `inputs.authored["name"]` in Rhai scripts.
+   * This is used for user-authored events (promoted or manually created).
+   *
+   * The JSON format should be an array of event objects with:
+   * - time: f32
+   * - weight: f32
+   * - beat_position: Option<f32>
+   * - beat_phase: Option<f32>
+   * - cluster_id: Option<u32>
+   *
+   * Returns true if successful, false if parsing failed.
+   */
+  push_authored_event_stream(name: string, events_json: string): boolean;
+  /**
+   * Clear all authored event streams.
+   */
+  clear_authored_event_streams(): void;
+  /**
+   * Set available custom signals for script namespace generation.
+   * This registers custom signal IDs and labels so the script engine can generate
+   * `inputs.customSignals["signal_id"]` accessors.
+   *
+   * The JSON format should be an array of [id, label] pairs:
+   * `[["signal-abc123", "My Signal"], ["signal-def456", "Another Signal"]]`
+   *
+   * Returns true if successful, false if parsing failed.
+   */
+  set_available_custom_signals(json: string): boolean;
+  /**
+   * Drain and return any pending structured script diagnostics as JSON.
+   *
+   * Intended for UI consumption. Calling this clears the pending diagnostics
+   * queue so repeated polling does not duplicate messages.
+   */
+  take_script_diagnostics_json(): string;
+  /**
+   * Set available composed signals for script namespace generation.
+   * This registers composed signal IDs and labels so the script engine can generate
+   * `inputs.composedSignals["name"]` accessors.
+   *
+   * The JSON format should be an array of [id, label] pairs:
+   * `[["intensity", "intensity"], ["buildup", "buildup"]]`
+   *
+   * Returns true if successful, false if parsing failed.
+   */
+  set_available_composed_signals(json: string): boolean;
+  /**
+   * Get the number of events in an authored event stream.
+   * Returns 0 if no events are stored for this name.
+   */
+  get_authored_event_stream_count(name: string): number;
   constructor();
   render(dt: number): void;
   resize(width: number, height: number): void;
@@ -43,6 +370,15 @@ export class WasmVisualiser {
 
 export function create_visualiser(canvas: HTMLCanvasElement): Promise<WasmVisualiser>;
 
+/**
+ * Get the host-defined Script API metadata as a JSON string.
+ *
+ * This is a stable, versioned description of the scripting API surface and is
+ * intended to drive editor UX (autocomplete/hover/docs) and future language
+ * bindings.
+ */
+export function get_script_api_metadata_json(): string;
+
 export function init_panic_hook(): void;
 
 export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
@@ -50,34 +386,81 @@ export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembl
 export interface InitOutput {
   readonly memory: WebAssembly.Memory;
   readonly __wbg_wasmvisualiser_free: (a: number, b: number) => void;
-  readonly create_visualiser: (a: any) => any;
+  readonly create_visualiser: (a: number) => number;
+  readonly get_script_api_metadata_json: (a: number) => void;
+  readonly init_panic_hook: () => void;
+  readonly wasmvisualiser_analyze_signal_chain: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
+  readonly wasmvisualiser_clear_authored_event_streams: (a: number) => void;
+  readonly wasmvisualiser_clear_band_events: (a: number) => void;
+  readonly wasmvisualiser_clear_band_signals: (a: number) => void;
+  readonly wasmvisualiser_clear_composed_signals: (a: number) => void;
+  readonly wasmvisualiser_clear_custom_signals: (a: number) => void;
+  readonly wasmvisualiser_clear_event_streams: (a: number) => void;
+  readonly wasmvisualiser_clear_frequency_bands: (a: number) => void;
+  readonly wasmvisualiser_clear_isolation: (a: number) => void;
+  readonly wasmvisualiser_clear_musical_time: (a: number) => void;
   readonly wasmvisualiser_clear_signals: (a: number) => void;
-  readonly wasmvisualiser_get_current_vals: (a: number) => [number, number];
-  readonly wasmvisualiser_get_script_error: (a: number) => [number, number];
+  readonly wasmvisualiser_clear_stem_signals: (a: number) => void;
+  readonly wasmvisualiser_get_authored_event_stream_count: (a: number, b: number, c: number) => number;
+  readonly wasmvisualiser_get_band_bounds_at: (a: number, b: number, c: number) => void;
+  readonly wasmvisualiser_get_band_event_count: (a: number, b: number, c: number) => number;
+  readonly wasmvisualiser_get_band_signal_keys: (a: number, b: number) => void;
+  readonly wasmvisualiser_get_camera_state_json: (a: number, b: number) => void;
+  readonly wasmvisualiser_get_current_vals: (a: number, b: number) => void;
+  readonly wasmvisualiser_get_custom_signal_keys: (a: number, b: number) => void;
+  readonly wasmvisualiser_get_entity_positions_json: (a: number, b: number) => void;
+  readonly wasmvisualiser_get_event_stream_count: (a: number, b: number, c: number) => number;
+  readonly wasmvisualiser_get_frequency_band_count: (a: number) => number;
+  readonly wasmvisualiser_get_script_error: (a: number, b: number) => void;
+  readonly wasmvisualiser_get_script_signals: (a: number, b: number) => void;
+  readonly wasmvisualiser_get_signal_names: (a: number, b: number) => void;
+  readonly wasmvisualiser_get_stem_signal_keys: (a: number, b: number) => void;
+  readonly wasmvisualiser_has_frequency_bands: (a: number) => number;
   readonly wasmvisualiser_has_script: (a: number) => number;
+  readonly wasmvisualiser_has_signal: (a: number, b: number, c: number) => number;
+  readonly wasmvisualiser_is_profiling_enabled: (a: number) => number;
+  readonly wasmvisualiser_isolate_entity: (a: number, b: bigint) => void;
+  readonly wasmvisualiser_list_mesh_assets: (a: number, b: number) => void;
   readonly wasmvisualiser_load_script: (a: number, b: number, c: number) => number;
   readonly wasmvisualiser_new: () => number;
+  readonly wasmvisualiser_push_authored_event_stream: (a: number, b: number, c: number, d: number, e: number) => number;
+  readonly wasmvisualiser_push_band_events: (a: number, b: number, c: number, d: number, e: number) => number;
+  readonly wasmvisualiser_push_band_signal: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number) => void;
+  readonly wasmvisualiser_push_composed_signal: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
+  readonly wasmvisualiser_push_custom_signal: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => void;
   readonly wasmvisualiser_push_data: (a: number, b: number, c: number, d: number) => void;
+  readonly wasmvisualiser_push_event_stream: (a: number, b: number, c: number, d: number, e: number) => number;
+  readonly wasmvisualiser_push_rotation_data: (a: number, b: number, c: number, d: number) => void;
   readonly wasmvisualiser_push_signal: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
+  readonly wasmvisualiser_push_stem_signal: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number) => void;
   readonly wasmvisualiser_push_zoom_data: (a: number, b: number, c: number, d: number) => void;
+  readonly wasmvisualiser_register_mesh_asset: (a: number, b: number, c: number, d: number, e: number) => number;
   readonly wasmvisualiser_render: (a: number, b: number) => void;
+  readonly wasmvisualiser_render_with_budget: (a: number, b: number, c: number) => number;
   readonly wasmvisualiser_resize: (a: number, b: number, c: number) => void;
+  readonly wasmvisualiser_run_analysis: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
+  readonly wasmvisualiser_run_analysis_with_events: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
+  readonly wasmvisualiser_set_available_composed_signals: (a: number, b: number, c: number) => number;
+  readonly wasmvisualiser_set_available_custom_signals: (a: number, b: number, c: number) => number;
+  readonly wasmvisualiser_set_available_stems: (a: number, b: number, c: number) => number;
+  readonly wasmvisualiser_set_debug_options: (a: number, b: number, c: number) => void;
+  readonly wasmvisualiser_set_frequency_bands: (a: number, b: number, c: number) => number;
+  readonly wasmvisualiser_set_musical_time: (a: number, b: number, c: number) => number;
+  readonly wasmvisualiser_set_profiling_enabled: (a: number, b: number) => void;
   readonly wasmvisualiser_set_sigmoid_k: (a: number, b: number) => void;
   readonly wasmvisualiser_set_time: (a: number, b: number) => void;
-  readonly wasmvisualiser_push_rotation_data: (a: number, b: number, c: number, d: number) => void;
-  readonly init_panic_hook: () => void;
-  readonly wasm_bindgen__convert__closures_____invoke__h9d1c5a23ecfcd5c8: (a: number, b: number, c: any) => void;
-  readonly wasm_bindgen__closure__destroy__heb49a8f426ac2d2e: (a: number, b: number) => void;
-  readonly wasm_bindgen__convert__closures_____invoke__h53437a38721e89f7: (a: number, b: number, c: any) => void;
-  readonly wasm_bindgen__closure__destroy__hf5eaa61ced318e08: (a: number, b: number) => void;
-  readonly wasm_bindgen__convert__closures_____invoke__h320f3d825d3712ba: (a: number, b: number, c: any, d: any) => void;
-  readonly __wbindgen_malloc: (a: number, b: number) => number;
-  readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
-  readonly __wbindgen_exn_store: (a: number) => void;
-  readonly __externref_table_alloc: () => number;
-  readonly __wbindgen_externrefs: WebAssembly.Table;
-  readonly __wbindgen_free: (a: number, b: number, c: number) => void;
-  readonly __wbindgen_start: () => void;
+  readonly wasmvisualiser_take_script_diagnostics_json: (a: number, b: number) => void;
+  readonly wasmvisualiser_unregister_mesh_asset: (a: number, b: number, c: number) => number;
+  readonly __wasm_bindgen_func_elem_10256: (a: number, b: number, c: number) => void;
+  readonly __wasm_bindgen_func_elem_10192: (a: number, b: number) => void;
+  readonly __wasm_bindgen_func_elem_11338: (a: number, b: number, c: number) => void;
+  readonly __wasm_bindgen_func_elem_11323: (a: number, b: number) => void;
+  readonly __wasm_bindgen_func_elem_11945: (a: number, b: number, c: number, d: number) => void;
+  readonly __wbindgen_export: (a: number, b: number) => number;
+  readonly __wbindgen_export2: (a: number, b: number, c: number, d: number) => number;
+  readonly __wbindgen_export3: (a: number) => void;
+  readonly __wbindgen_export4: (a: number, b: number, c: number) => void;
+  readonly __wbindgen_add_to_stack_pointer: (a: number) => number;
 }
 
 export type SyncInitInput = BufferSource | WebAssembly.Module;