@shogo-ai/voice 1.10.0 → 2.4.1

package/dist/particlesConfig-0YbdPOdY.d.ts

@@ -0,0 +1,223 @@
+/**
+ * Configuration surface for the `OrganicSphere` audio-reactive
+ * visualization. All values are plain numbers / strings / null so the
+ * whole object is JSON-serializable — save it, transport it, paste it
+ * into a preset library.
+ *
+ * The sphere renders four eased "variations" driven by frequency bands:
+ *
+ *   low    → modulates time-evolution speed (drift + noise phase)
+ *   volume → drives `uDisplacementStrength` (how far each vertex pushes
+ *            out from the sphere surface)
+ *   medium → drives `uFresnelMultiplier` (how bright the lighting pass
+ *            gets near silhouette edges)
+ *   high   → drives `uDistortionStrength` (large-scale warping of the
+ *            underlying position field before displacement)
+ *
+ * Each variation has a resting `idle` value used when audio is off, a
+ * `gain` multiplier applied to the band level, a `floor` minimum while
+ * audio is playing, and separate attack / decay easing rates.
+ *
+ * Use `resolveOrganicSphereConfig(partial)` to merge a partial override
+ * into the defaults; `OrganicSphere` does this internally so consumers
+ * can pass any subset.
+ */
+interface BandReactivity {
+    /** Resting target used when no audio source is connected. */
+    idle: number;
+    /** Multiplier applied to the normalized band level (0–1) while audio plays. */
+    gain: number;
+    /** Minimum target while audio is playing, before easing. */
+    floor: number;
+    /**
+     * Easing rate when the target rises above `current` (snappier attack
+     * at higher values; per-ms-of-frame delta, not per-frame).
+     */
+    attack: number;
+    /** Easing rate when the target falls below `current` (per-ms). */
+    decay: number;
+}
+interface OrganicSphereConfig {
+    /** Color of light A (default is a deep Shogo burnt orange). */
+    lightAColor: string;
+    /** Color of light B (default is a warm Shogo amber). */
+    lightBColor: string;
+    /** Intensity multiplier for light A. Higher = brighter contribution. */
+    lightAIntensity: number;
+    /** Intensity multiplier for light B. */
+    lightBIntensity: number;
+    /**
+     * Rim-highlight color. `null` falls back to `lightBColor`, which keeps
+     * the silhouette monochromatic and impossible to wash out to white.
+     */
+    rimColor: string | null;
+    /**
+     * Fresnel value above which the rim starts contributing. Higher →
+     * tighter rim; lower → rim bleeds across more of the surface.
+     */
+    rimThreshold: number;
+    /** Exponent on the rim falloff curve. Higher → sharper edge. */
+    rimPower: number;
+    /** Spatial frequency of the distortion noise (`uDistortionFrequency`). */
+    distortionFrequency: number;
+    /** Spatial frequency of the displacement noise (`uDisplacementFrequency`). */
+    displacementFrequency: number;
+    /** Fresnel offset — shifts where the rim and lighting gradient peak. */
+    fresnelOffset: number;
+    /** Fresnel power — steepens or softens the lighting gradient. */
+    fresnelPower: number;
+    /**
+     * Volume variation → `uDisplacementStrength`. Driven by the loudest
+     * of the first three bands (`max(l0, l1, l2)`).
+     */
+    volume: BandReactivity;
+    /** Mid-band variation → `uFresnelMultiplier`. Driven by `l1`. */
+    medium: BandReactivity;
+    /** High-band variation → `uDistortionStrength`. Driven by `l2`. */
+    high: BandReactivity;
+    /**
+     * Low-band variation → time evolution speed (how fast the noise
+     * offset scrolls). Driven by `l0`.
+     */
+    low: BandReactivity;
+    /** Camera z-position. Larger = more zoomed out. */
+    cameraZ: number;
+    /** Vertical field-of-view in degrees. */
+    fov: number;
+    /**
+     * Seed used to derive the initial "wander" offset phase, so identical
+     * audio produces identical visuals across playbacks. Any integer is
+     * fine; change it to roll a different starting pose. When `active`
+     * flips from `false` → `true`, the sphere resets to this phase.
+     */
+    seed: number;
+    /**
+     * Sphere mesh subdivisions. Higher = smoother displacement, more GPU
+     * cost. Changing at runtime triggers a scene rebuild.
+     */
+    subdivisions: number;
+    /**
+     * Device-pixel-ratio cap. `null` picks `min(devicePixelRatio, 2)`.
+     * Set to `1` for lower-end devices.
+     */
+    maxPixelRatio: number | null;
+    /**
+     * Scene clear color. `null` keeps the canvas fully transparent so the
+     * sphere blends into the host UI.
+     */
+    backgroundColor: string | null;
+}
+/**
+ * Preset tuned for Shogo's Voice Mode hero — warm Shogo orange palette,
+ * rim tied to `lightBColor`, camera zoomed back so the sphere reads
+ * "contained" rather than "looming", reactivity values copied from
+ * Bruno Simon's upstream `organic-sphere` demo so silhouettes animate
+ * faithfully.
+ */
+declare const DEFAULT_ORGANIC_SPHERE_CONFIG: OrganicSphereConfig;
+/**
+ * Merge a partial override into `DEFAULT_ORGANIC_SPHERE_CONFIG`, doing a
+ * shallow merge on the root + per-band merge on `volume/medium/high/low`
+ * so consumers only need to specify what they want to change.
+ */
+declare function resolveOrganicSphereConfig(partial?: Partial<OrganicSphereConfig>): OrganicSphereConfig;
+
+/**
+ * Configuration surface for the `OrganicParticles` audio-reactive
+ * visualization — a particle-cloud sibling of `OrganicSphere`.
+ *
+ * Shares the same `BandReactivity` shape and four-band model
+ * (volume / medium / high / low) as the sphere, so audio-tuning muscle
+ * memory carries over. What changes is the cloud-specific fields:
+ *
+ *   volume → radial displacement (how far the cloud bursts outward)
+ *   medium → particle size boost (how puffy each point renders)
+ *   high   → swirl strength (how much the cloud twists)
+ *   low    → time evolution speed (noise phase drift)
+ *
+ * Like `OrganicSphereConfig`, everything is JSON-serializable.
+ */
+
+interface OrganicParticlesConfig {
+    /**
+     * Number of particles. Changing this rebuilds the scene. Sweet spot
+     * for visual density without frame-drop is 20k–80k on a modern GPU.
+     */
+    count: number;
+    /**
+     * Inner / outer radius of the seeded spawn shell. Particles are
+     * uniformly distributed between these two radii so the cloud has
+     * perceptible thickness rather than sitting on a single sphere.
+     */
+    innerRadius: number;
+    outerRadius: number;
+    /** Spatial frequency of the Perlin noise warp. */
+    noiseFrequency: number;
+    /** Strength of the noise warp. */
+    noiseStrength: number;
+    /**
+     * Constant per-ms Y-axis rotation applied to the whole cloud,
+     * independent of audio. `0` (default) means the cloud is perfectly
+     * still when no audio plays. Positive = spin right, negative = left.
+     */
+    rotationBias: number;
+    /**
+     * Rate (per ms) at which `uTime` advances the per-particle swirl
+     * angle in the shader, independent of audio. `0` (default) = swirl
+     * only responds to audio high-band + particle height.
+     */
+    swirlTimeRate: number;
+    /**
+     * Rate (per ms) at which `uTime` advances while the cloud is idle
+     * (i.e. `active === false`). Lets the Perlin noise field keep
+     * shimmering subtly when nothing is playing so the cloud doesn't feel
+     * dead. `0` = fully frozen when paused. Default `0.0001` ≈ one full
+     * noise period every ~10 s — perceptible but not distracting.
+     */
+    idleNoiseRate: number;
+    /** Base particle size (before audio boost / perspective scaling). */
+    sizeBase: number;
+    /**
+     * Edge softness of each particle sprite, in [0, 1]. `0` = hard disc,
+     * `1` = heavy feather/plasma. ~0.6 reads as "nebula".
+     */
+    softness: number;
+    /** Overall opacity multiplier. */
+    opacity: number;
+    /** Color at the cloud core (low `vHeat`). */
+    colorCool: string;
+    /** Color at the cloud fringe (high `vHeat`). */
+    colorHot: string;
+    /** volume → radial displacement push. */
+    volume: BandReactivity;
+    /** medium → per-particle size boost. */
+    medium: BandReactivity;
+    /** high → swirl / twist amount. */
+    high: BandReactivity;
+    /** low → time evolution speed. */
+    low: BandReactivity;
+    cameraZ: number;
+    fov: number;
+    /**
+     * Seed used to generate the initial particle positions AND the wander
+     * phase. Same seed + same audio → same visual across playbacks.
+     */
+    seed: number;
+    /** `null` picks `min(devicePixelRatio, 2)`. */
+    maxPixelRatio: number | null;
+    /** Scene clear color. `null` = transparent. */
+    backgroundColor: string | null;
+}
+/**
+ * Preset tuned to match the Shogo warm-orange palette used by
+ * `DEFAULT_ORGANIC_SPHERE_CONFIG`, so the two modes read as siblings.
+ * Count/size defaults target 60fps on mid-tier GPUs.
+ */
+declare const DEFAULT_ORGANIC_PARTICLES_CONFIG: OrganicParticlesConfig;
+/**
+ * Merge a partial override into `DEFAULT_ORGANIC_PARTICLES_CONFIG`,
+ * with per-band shallow merges for `volume/medium/high/low`.
+ */
+declare function resolveOrganicParticlesConfig(partial?: Partial<OrganicParticlesConfig>): OrganicParticlesConfig;
+
+export { type BandReactivity as B, DEFAULT_ORGANIC_PARTICLES_CONFIG as D, type OrganicParticlesConfig as O, DEFAULT_ORGANIC_SPHERE_CONFIG as a, type OrganicSphereConfig as b, resolveOrganicSphereConfig as c, resolveOrganicParticlesConfig as r };