@pixerate/flair 0.28.0 → 0.30.0

package/dist/index.d.ts

@@ -1,9 +1,9 @@
 import { C as ControlValue } from './controls-Ec6P0Vpy.js';
 export { c as ControlCheck, a as ControlDef, b as ControlType, T as TextureSettings, d as checkControlValue, e as coerceControlValue, f as componentCount, g as controlValue, h as describeValue, i as hexToRgb, j as humanise, k as imageUrls, l as isImageUrl, p as parseColor, m as parseControls, r as rgbToHex } from './controls-Ec6P0Vpy.js';
-export { B as BUILTIN_UNIFORMS, C as CompileError, b as CompileResult, a as CompileStatus, c as CompiledShader, F as FrameState, I as ImageLoadError, L as LiveSource, R as RendererStats, d as SVG_EDGE, e as ShaderCompileError, S as ShaderRenderer, f as ShaderRendererOptions, T as TextureCache, g as TextureSource, V as VERTEX_SOURCE, h as applyTextureSettings, i as compileShader, j as createContext, k as drawFrame, l as formatCompileError, m as isSvgUrl, n as loadImage, p as parseCompileLog, o as preloadImages, r as releaseImages, q as resetGlCaches, s as seekVideo, t as sizeSvg, w as wrapSource } from './renderer-teaa98RE.js';
-export { H as HOVER_SECONDS, M as MAX_CLICKS, a as MAX_TRAIL, P as PointerTracker, R as RenderOptions, S as ShaderClick, b as ShaderFrames, c as ShaderFramesOptions, T as TRAIL_SECONDS, d as clicksUniform, t as trailUniform } from './frames-VEcqa40g.js';
-import { C as Clock } from './svg-BhRboN9q.js';
-export { A as AnimateCountOptions, D as DataKey, E as EASES, c as EaseName, M as ManualClock, d as SCRAMBLE_MS, e as STEP_MS, f as SVG_PICTURE, g as SvgAnimation, h as SvgBox, i as SvgElementFrame, S as SvgMotion, b as SvgPlayer, j as SvgPlayerOptions, a as SvgTrigger, k as SvgView, l as SvgViewOptions, m as animateCount, n as defaultDataKey, o as formatCount, p as jitter, q as lerpAttr, r as lerpData, s as pageHidden, t as parseSvg, u as realClock, v as stepData, w as stepProgress, x as stepStart, y as svgDuration, z as svgFrame, B as svgMotionIssues, F as svgOpeningTag, G as svgView, H as writtenText } from './svg-BhRboN9q.js';
+export { c as AUDIO_BANDS, d as AudioAnalysis, e as AudioAnalysisOptions, f as AudioBufferAnalysis, g as AudioBufferAnalysisOptions, a as AudioFrame, h as AudioSamples, A as AudioSource, B as BUILTIN_UNIFORMS, C as CompileError, i as CompileResult, b as CompileStatus, j as CompiledShader, F as FrameState, I as ImageLoadError, k as LiveAudio, L as LiveSource, R as RendererStats, l as SPECTRUM_BINS, m as SVG_EDGE, n as ShaderCompileError, S as ShaderRenderer, o as ShaderRendererOptions, T as TextureCache, p as TextureSource, V as VERTEX_SOURCE, q as analyseAudioBuffer, r as applyTextureSettings, s as compileShader, t as createContext, u as drawFrame, v as fft, w as formatCompileError, x as frequencyData, y as isSvgUrl, z as loadImage, D as parseCompileLog, E as preloadImages, G as releaseImages, H as resetGlCaches, J as rmsLevel, K as seekVideo, M as sharedAudioContext, N as sizeSvg, O as wrapSource } from './renderer-tk1nbVkW.js';
+export { H as HOVER_SECONDS, M as MAX_CLICKS, a as MAX_TRAIL, P as PointerTracker, R as RenderOptions, S as ShaderClick, b as ShaderFrames, c as ShaderFramesOptions, T as TRAIL_SECONDS, d as clicksUniform, t as trailUniform } from './frames-CGJudAbu.js';
+import { C as Clock } from './svg-DaKRPA9v.js';
+export { A as AnimateCountOptions, D as DataKey, E as EASES, c as EaseName, M as ManualClock, d as SCRAMBLE_MS, e as SCROLL_RANGE, f as STEP_MS, g as SVG_PICTURE, h as SvgAnimation, i as SvgBox, j as SvgElementFrame, S as SvgMotion, b as SvgPlayer, k as SvgPlayerOptions, a as SvgTrigger, l as SvgView, m as SvgViewOptions, n as animateCount, o as defaultDataKey, p as formatCount, q as jitter, r as lerpAttr, s as lerpData, t as pageHidden, u as parseSvg, v as realClock, w as stepData, x as stepProgress, y as stepStart, z as svgDuration, B as svgFrame, F as svgMotionIssues, G as svgOpeningTag, H as svgView, I as writtenText } from './svg-DaKRPA9v.js';
 export { AnimatedSvgOptions, BoxAlignment, BoxFit, FittedBoxResult, FormatUnitOptions, MorphOptions, StackLayoutOptions, SvgFrameMarkupOptions, SvgInlineLayout, UnitFormat, computeBoxFit, formatUnit, layoutStack, morphPaths, morphSequence, parseViewBox, remap, stepVariant, svgAnimatedMarkup, svgFrameMarkup, svgInlineLayout, svgViewBox } from './vector/index.js';
 
 /** Controls a registered thumbnail. */
@@ -84,6 +84,56 @@ declare function sharedThumbnailPool(): ThumbnailPool;
 /** Registers a thumbnail with the shared pool. See {@link ThumbnailPool.register}. */
 declare function registerThumbnail(canvas: HTMLCanvasElement, source: string, values?: Record<string, ControlValue>, onStatus?: (ok: boolean) => void): ThumbnailHandle;
 
+/**
+ * Scrolling as shaders see it: `iScroll`, a `vec4` of
+ * - x: the canvas's progress through the viewport, 0 when its top meets the
+ *   viewport's bottom, 1 when its bottom leaves the top;
+ * - y: the page's scroll, as a share of how far it can scroll;
+ * - z: scroll velocity in viewport heights per second (positive scrolling
+ *   down, smoothed);
+ * - w: 1 while scrolling, easing back to 0 after.
+ *
+ * Where nothing scrolls it (thumbnails, recordings without a script) it is
+ * all zero, and scroll effects play an idle demo.
+ */
+/** Seconds the velocity takes to follow a change (most of the way). */
+declare const SCROLL_SMOOTHING = 0.12;
+/** Seconds `iScroll.w` takes to ease back to 0 once scrolling stops. */
+declare const SCROLL_SETTLE = 0.4;
+/**
+ * An element's progress through the viewport: 0 when its top meets the
+ * viewport's bottom, 1 when its bottom leaves the top, from its box (as
+ * `getBoundingClientRect` gives it) and the viewport's height.
+ */
+declare function viewportProgress(top: number, height: number, viewport: number): number;
+/**
+ * Follows one element's scrolling for `iScroll`: feed it where the element
+ * is at each frame, with a steady clock in seconds, and read the uniform.
+ * The same positions at the same times always give the same uniform.
+ */
+declare class ScrollTracker {
+    private progress;
+    private page;
+    private offset;
+    private last;
+    private velocity;
+    private movedAt;
+    private seen;
+    /**
+     * Where things are at `time` seconds: the element's `progress` (see
+     * {@link viewportProgress}), the page's scroll share, and the element's
+     * top in viewport heights (from which the velocity comes; any steady
+     * measure that grows as the page scrolls down will do).
+     */
+    sample(progress: number, page: number, offset: number, time: number): void;
+    /** Whether scrolling has settled (nothing more to animate until it moves). */
+    settled(time: number): boolean;
+    /** `iScroll` at `time` (all zero before the first sample). */
+    scroll(time: number): [number, number, number, number];
+    /** Forgets the velocity and activity (when the page jumps, say). */
+    clear(): void;
+}
+
 interface GifOptions {
     source: string;
     values?: Record<string, ControlValue>;
@@ -116,12 +166,25 @@ declare function recordGif(options: GifOptions): Promise<Blob>;
 interface StandaloneOptions {
     /** The comment at the top of the script, saying where the page came from. */
     credit?: string;
+    /**
+     * Sound for audio-reactive shaders (`iAudio`, `iSpectrum`, `iBeat`): an
+     * audio file's URL, shown as a looping `<audio controls>` player in the
+     * corner, or `"mic"`, a button that asks for the microphone (heard, not
+     * played back). Browsers only start sound after a click, so the page
+     * listens once the player is played or the button pressed. A file from
+     * another site needs CORS (it is loaded with `crossorigin="anonymous"`).
+     * Without it, audio effects play their idle demos.
+     */
+    audio?: string;
 }
 /**
  * A self-contained HTML page that runs the shader full-window, with the
  * control values baked in. It has no dependencies and opens from disk. Like
  * the live preview, it feeds `iMouse` from pointer drags and caps the pixel
- * ratio at 2.
+ * ratio at 2. It also feeds the pointer built-ins, and the audio ones from
+ * a player or the microphone when `options.audio` asks for it. The page
+ * itself does not scroll, so `iScroll` stays 0 (scroll effects play their
+ * idle demos).
  *
  * Images are loaded by URL when the page opens: a `data:` URL travels with
  * the page, an `https:` one needs the network and CORS, and a `blob:` one
@@ -1609,4 +1672,4 @@ declare function exportFcp7Xml(scene: Scene, options?: Fcp7ExportOptions): strin
  */
 declare function exportCmx3600Edl(scene: Scene, options?: EdlExportOptions): string;
 
-export { ALL_BLEND_MODES, ALL_TRANSITION_TYPES, type AgentToolDefinition, type AscCdl, type BatchCommand, type BatchExecutionResult, type BatchExecutionStepResult, type Behavior, type BehaviorBase, type BlendMode, type BlockDissolveOptions, type BlurEffect, type BurstEffect, CAMERA_MS, CAMERA_STEPS, CAMERA_STEP_MS, CAMERA_TRANSITIONS, COMMON_FRAME_RATES, type CameraAngle, type CameraLens, type CameraSample, type CameraShot, type CameraTransition, type ClearCommand, Clock, type ColorRGB, type ColorRGBA, type ColorRgba, type ColorSpace, ControlValue, type CounterEffect, type CrossZoomOptions, type CustomCommand, DEFAULT_PERSPECTIVE, DEFAULT_STAGE, type DeleteCommand, type DynamicFraming, EASY_EASE, EFFECT_FADE_MS, EFFECT_TYPES, type EasingCurve, type EdlExportOptions, type Effect, type EffectBase, type ElementCommand, FLAIR_AGENT_TOOLS, type Fcp7ExportOptions, type FlowEffect, type FramingOptions, type GifOptions, type GlassWipeOptions, type GlowEffect, type GradientEffect, type GridWipeOptions, type HighlightEffect, type KeyframeEase, type LiftGammaGain, type LightLeakOptions, type LinearWipeOptions, type LottieAnimatable, type LottieAnimation, type LottieExportOptions, type LottieKeyframe, type LottieLayer, type LottieShapeItem, type LottieTransform, MAX_TILT, type MediaEffect, MemorySceneBoard, type MotnExportOptions, NO_CHECK, type OscillateBehavior, type OvershootBehavior, type PathWaypoint, type PlayOptions, type PlayResult, type Point, type PopupWidget, type RadialIrisOptions, type RampBehavior, type RateBehavior, type RationalFrameRate, type Rect, type ReplicatorConfig, type ReplicatorPattern, type ReplicatorSequence, type Review, type ReviewOptions, type RigWidget, type RippleEffect, type RunningEffect, SMALL_TEXT_PX, type SMPTEFields, type Scene, type SceneBoard, type SceneCommand, type SceneElement, type SceneIssue, type SceneMedia, type SceneOutline, type SceneOutlineShot, type SceneRig, type SceneToolResult, type ShimmerEffect, type Shot, type ShotCamera, type ShotCheck, type ShotLog, type ShotTiming, type SliderSnapshot, type SliderWidget, type SpatialMotionPath, type SpatialPathSample, type SpotlightEffect, type Stage, type StandaloneOptions, type StandardFrameRateKey, TRANSITION_BLUR, type ThrowBehavior, type ThumbnailHandle, ThumbnailPool, type ThumbnailPoolOptions, type TimerEffect, type ToggleWidget, type TransitionOptions, type TransitionSample, type TransitionType, type TwisterOptions, type UpdateCommand, type Vec2, type Vec3, type View, type WriggleBehavior, applyAscCdl, applyLiftGammaGain, applyRig, applySceneBatch, applySceneTool, applyVibrance, areaOf, between, bez1d, bez1dDerivative, blendRgba, blendTransitionPixel, boardHeight, boundsOf, calculateFramingRect, calculateShotTimings, cameraAngle, cameraAt, cameraBlur, cameraFilter, cameraSamples, cameraTrack, cameraTransform, centreOf, checkShot, convertColorSpace, createFrameRate, createLottieEase, createMotionPath, cutsHalfway, easeInOutCubic, easeProgress, effectGone, effectOpacity, evaluateBehavior, evaluateKeyframeSegment, expandReplicator, exportCmx3600Edl, exportFcp7Xml, exportLottie, exportMotn, formatTimecode, fractalWiggle, frame, framesToSMPTE, framesToTimecode, getColorGradingGLSL, getDropFrameCount, getGlslBlendFunction, getOklabGLSL, getTimecodeBase, getTransitionGLSL, getWhiteBalanceGains, hash64, holdTime, interpolateOklab, interpolateOklch, isAngled, isDeleteCommand, isElementCommand, isUpdateCommand, linearRgbToSrgb, linearSrgbToOklab, linearToSrgb, loopTime, mixSeeds, motionBlur, motionBlurAngle, moveBlur, noise1d, noise3d, oklabToLinearSrgb, oklabToOklch, oklabToSrgb, oklchToOklab, overlapArea, parseTimecode, pingPongTime, playScene, projectPoint, quinticFade, recordGif, registerThumbnail, reviewScene, sampleMotionPath, sampleMotionPathAtTime, sampleTransition, sceneStage, screenBox, setRigWidget, sharedThumbnailPool, shotMoveMs, shotView, simulateScene, smpteToFrames, solveBezierU, speedRampTime, srgbToLinear, srgbToLinearRgb, srgbToOklab, standaloneHtml, standaloneSceneHtml, strobeTime, substituteVariables, supportsDropFrame, timecodeToFrames, titleBox, touchedIds, transitionStrength, transitionView, unitFloat, validateScene, viewAt, visibleRect };
+export { ALL_BLEND_MODES, ALL_TRANSITION_TYPES, type AgentToolDefinition, type AscCdl, type BatchCommand, type BatchExecutionResult, type BatchExecutionStepResult, type Behavior, type BehaviorBase, type BlendMode, type BlockDissolveOptions, type BlurEffect, type BurstEffect, CAMERA_MS, CAMERA_STEPS, CAMERA_STEP_MS, CAMERA_TRANSITIONS, COMMON_FRAME_RATES, type CameraAngle, type CameraLens, type CameraSample, type CameraShot, type CameraTransition, type ClearCommand, Clock, type ColorRGB, type ColorRGBA, type ColorRgba, type ColorSpace, ControlValue, type CounterEffect, type CrossZoomOptions, type CustomCommand, DEFAULT_PERSPECTIVE, DEFAULT_STAGE, type DeleteCommand, type DynamicFraming, EASY_EASE, EFFECT_FADE_MS, EFFECT_TYPES, type EasingCurve, type EdlExportOptions, type Effect, type EffectBase, type ElementCommand, FLAIR_AGENT_TOOLS, type Fcp7ExportOptions, type FlowEffect, type FramingOptions, type GifOptions, type GlassWipeOptions, type GlowEffect, type GradientEffect, type GridWipeOptions, type HighlightEffect, type KeyframeEase, type LiftGammaGain, type LightLeakOptions, type LinearWipeOptions, type LottieAnimatable, type LottieAnimation, type LottieExportOptions, type LottieKeyframe, type LottieLayer, type LottieShapeItem, type LottieTransform, MAX_TILT, type MediaEffect, MemorySceneBoard, type MotnExportOptions, NO_CHECK, type OscillateBehavior, type OvershootBehavior, type PathWaypoint, type PlayOptions, type PlayResult, type Point, type PopupWidget, type RadialIrisOptions, type RampBehavior, type RateBehavior, type RationalFrameRate, type Rect, type ReplicatorConfig, type ReplicatorPattern, type ReplicatorSequence, type Review, type ReviewOptions, type RigWidget, type RippleEffect, type RunningEffect, SCROLL_SETTLE, SCROLL_SMOOTHING, SMALL_TEXT_PX, type SMPTEFields, type Scene, type SceneBoard, type SceneCommand, type SceneElement, type SceneIssue, type SceneMedia, type SceneOutline, type SceneOutlineShot, type SceneRig, type SceneToolResult, ScrollTracker, type ShimmerEffect, type Shot, type ShotCamera, type ShotCheck, type ShotLog, type ShotTiming, type SliderSnapshot, type SliderWidget, type SpatialMotionPath, type SpatialPathSample, type SpotlightEffect, type Stage, type StandaloneOptions, type StandardFrameRateKey, TRANSITION_BLUR, type ThrowBehavior, type ThumbnailHandle, ThumbnailPool, type ThumbnailPoolOptions, type TimerEffect, type ToggleWidget, type TransitionOptions, type TransitionSample, type TransitionType, type TwisterOptions, type UpdateCommand, type Vec2, type Vec3, type View, type WriggleBehavior, applyAscCdl, applyLiftGammaGain, applyRig, applySceneBatch, applySceneTool, applyVibrance, areaOf, between, bez1d, bez1dDerivative, blendRgba, blendTransitionPixel, boardHeight, boundsOf, calculateFramingRect, calculateShotTimings, cameraAngle, cameraAt, cameraBlur, cameraFilter, cameraSamples, cameraTrack, cameraTransform, centreOf, checkShot, convertColorSpace, createFrameRate, createLottieEase, createMotionPath, cutsHalfway, easeInOutCubic, easeProgress, effectGone, effectOpacity, evaluateBehavior, evaluateKeyframeSegment, expandReplicator, exportCmx3600Edl, exportFcp7Xml, exportLottie, exportMotn, formatTimecode, fractalWiggle, frame, framesToSMPTE, framesToTimecode, getColorGradingGLSL, getDropFrameCount, getGlslBlendFunction, getOklabGLSL, getTimecodeBase, getTransitionGLSL, getWhiteBalanceGains, hash64, holdTime, interpolateOklab, interpolateOklch, isAngled, isDeleteCommand, isElementCommand, isUpdateCommand, linearRgbToSrgb, linearSrgbToOklab, linearToSrgb, loopTime, mixSeeds, motionBlur, motionBlurAngle, moveBlur, noise1d, noise3d, oklabToLinearSrgb, oklabToOklch, oklabToSrgb, oklchToOklab, overlapArea, parseTimecode, pingPongTime, playScene, projectPoint, quinticFade, recordGif, registerThumbnail, reviewScene, sampleMotionPath, sampleMotionPathAtTime, sampleTransition, sceneStage, screenBox, setRigWidget, sharedThumbnailPool, shotMoveMs, shotView, simulateScene, smpteToFrames, solveBezierU, speedRampTime, srgbToLinear, srgbToLinearRgb, srgbToOklab, standaloneHtml, standaloneSceneHtml, strobeTime, substituteVariables, supportsDropFrame, timecodeToFrames, titleBox, touchedIds, transitionStrength, transitionView, unitFloat, validateScene, viewAt, viewportProgress, visibleRect };

package/dist/index.js

@@ -9,7 +9,7 @@ import {
   standaloneHtml,
   standaloneSceneHtml,
   validateScene
-} from "./chunk-CK6EV37I.js";
+} from "./chunk-ZULFHADW.js";
 import {
   calculateShotTimings,
   createLottieEase,
@@ -114,46 +114,59 @@ import {
 } from "./chunk-H6L67KHI.js";
 import {
   svgAnimatedMarkup
-} from "./chunk-YBGRXVAE.js";
+} from "./chunk-X3C2VFTM.js";
 import {
   parseViewBox,
   svgFrameMarkup,
   svgInlineLayout,
   svgViewBox
-} from "./chunk-STKEKXCK.js";
+} from "./chunk-AUH3PEFW.js";
 import {
+  SCROLL_SETTLE,
+  SCROLL_SMOOTHING,
+  ScrollTracker,
   ShaderFrames,
-  ShaderRenderer
-} from "./chunk-H6VDFBIO.js";
+  ShaderRenderer,
+  viewportProgress
+} from "./chunk-SMR2MJXB.js";
 import {
+  AUDIO_BANDS,
+  AudioAnalysis,
   BUILTIN_UNIFORMS,
   HOVER_SECONDS,
   ImageLoadError,
+  LiveAudio,
   MAX_CLICKS,
   MAX_TRAIL,
   PointerTracker,
+  SPECTRUM_BINS,
   SVG_EDGE,
   ShaderCompileError,
   TRAIL_SECONDS,
   TextureCache,
   VERTEX_SOURCE,
+  analyseAudioBuffer,
   applyTextureSettings,
   clicksUniform,
   compileShader,
   createContext,
   drawFrame,
+  fft,
   formatCompileError,
+  frequencyData,
   isSvgUrl,
   loadImage,
   parseCompileLog,
   preloadImages,
   releaseImages,
   resetGlCaches,
+  rmsLevel,
   seekVideo,
+  sharedAudioContext,
   sizeSvg,
   trailUniform,
   wrapSource
-} from "./chunk-RDU63CDO.js";
+} from "./chunk-HDYBY3PQ.js";
 import {
   ALL_TRANSITION_TYPES,
   blendTransitionPixel,
@@ -177,6 +190,7 @@ import {
 import {
   EASES,
   SCRAMBLE_MS,
+  SCROLL_RANGE,
   STEP_MS,
   SVG_PICTURE,
   SvgPlayer,
@@ -195,7 +209,7 @@ import {
   svgOpeningTag,
   svgView,
   writtenText
-} from "./chunk-PFGGPIMT.js";
+} from "./chunk-DA4UUSDO.js";
 import {
   ManualClock,
   jitter,
@@ -1189,6 +1203,8 @@ async function applySceneBatch(scene, commands) {
 export {
   ALL_BLEND_MODES,
   ALL_TRANSITION_TYPES,
+  AUDIO_BANDS,
+  AudioAnalysis,
   BUILTIN_UNIFORMS,
   CAMERA_MS,
   CAMERA_STEPS,
@@ -1204,6 +1220,7 @@ export {
   FLAIR_AGENT_TOOLS,
   HOVER_SECONDS,
   ImageLoadError,
+  LiveAudio,
   MAX_CLICKS,
   MAX_TILT,
   MAX_TRAIL,
@@ -1212,10 +1229,15 @@ export {
   NO_CHECK,
   PointerTracker,
   SCRAMBLE_MS,
+  SCROLL_RANGE,
+  SCROLL_SETTLE,
+  SCROLL_SMOOTHING,
   SMALL_TEXT_PX,
+  SPECTRUM_BINS,
   STEP_MS,
   SVG_EDGE,
   SVG_PICTURE,
+  ScrollTracker,
   ShaderCompileError,
   ShaderFrames,
   ShaderRenderer,
@@ -1225,6 +1247,7 @@ export {
   TextureCache,
   ThumbnailPool,
   VERTEX_SOURCE,
+  analyseAudioBuffer,
   animateCount,
   applyAscCdl,
   applyLiftGammaGain,
@@ -1279,6 +1302,7 @@ export {
   exportFcp7Xml,
   exportLottie,
   exportMotn,
+  fft,
   formatCompileError,
   formatCount,
   formatTimecode,
@@ -1287,6 +1311,7 @@ export {
   frame,
   framesToSMPTE,
   framesToTimecode,
+  frequencyData,
   getColorGradingGLSL,
   getDropFrameCount,
   getGlslBlendFunction,
@@ -1349,6 +1374,7 @@ export {
   resetGlCaches,
   reviewScene,
   rgbToHex,
+  rmsLevel,
   sampleMotionPath,
   sampleMotionPathAtTime,
   sampleTransition,
@@ -1356,6 +1382,7 @@ export {
   screenBox,
   seekVideo,
   setRigWidget,
+  sharedAudioContext,
   sharedThumbnailPool,
   shotMoveMs,
   shotView,
@@ -1394,6 +1421,7 @@ export {
   unitFloat,
   validateScene,
   viewAt,
+  viewportProgress,
   visibleRect,
   wrapSource,
   writtenText