@bendyline/squisq-video 2.3.12 → 2.3.14

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { MediaScheduleOptions, Doc, Theme, VideoPresentation, VideoPipSize, VideoPipShape, VideoPipPosition, ViewportPreset } from '@bendyline/squisq/schemas';
+import { MediaScheduleOptions, Doc, Theme, MotionSpec, VideoPresentation, VideoPipSize, VideoPipShape, VideoPipPosition, ViewportPreset } from '@bendyline/squisq/schemas';
 export { fetchFile } from '@ffmpeg/util';
 
 /**
@@ -263,6 +263,8 @@ interface RenderHtmlOptions {
     captionStyle?: 'standard' | 'social';
     /** Theme override for the capture player. Omitted values resolve from the Doc. */
     theme?: Theme;
+    /** Motion profile override. Omitted values resolve from the Doc, then the theme. */
+    motion?: MotionSpec | null;
     /** Player-level video placement override. Omitted values resolve from Doc frontmatter. */
     videoPresentation?: VideoPresentation;
     /** Picture-in-picture size override. Omitted values resolve from Doc frontmatter. */
@@ -510,4 +512,21 @@ declare function ffmpegGifOutputArgs(options: GifOutputOptions): string[];
  */
 declare function framesToMp4Wasm(frames: Uint8Array[], audio: Uint8Array | null, options?: VideoExportOptions): Promise<EncoderResult>;
 
-export { type AudioTimelineClip, type ComputeAudioTimelineOptions, DASHBOARD_RESOLUTIONS, DEFAULT_DASHBOARD_RESOLUTION, type DashboardResolutionId, type DashboardResolutionPreset, type EncoderResult, FFMPEG_WASM_SETUP_HINT, type FfmpegWasmLoadConfig, type GifDither, type GifFilterOptions, type GifOutputOptions, MAX_DASHBOARD_IMAGE_DIMENSION, MAX_DASHBOARD_IMAGE_PIXELS, MIN_DASHBOARD_IMAGE_DIMENSION, ORIENTATION_DIMENSIONS, QUALITY_PRESETS, type QualityPreset, type RenderHtmlOptions, type ResolveDashboardDimensionsInput, type ResolvedDashboardDimensions, type VideoExportOptions, type VideoOrientation, type VideoQuality, audioBitrateArg, bitrateForQuality, computeAudioTimeline, dashboardFamilyForDimensions, ffmpegAudioMuxArgs, ffmpegGifFilterGraph, ffmpegGifOutputArgs, ffmpegGifPaletteApplicationArgs, ffmpegGifPaletteApplicationGraph, ffmpegGifPaletteGenerationFilter, ffmpegVideoQualityArgs, framesToMp4Wasm, generateRenderHtml, resolveDashboardDimensions, resolveDimensions, resolveFfmpegWasmLoad, validateDashboardImageDimensions, validateVideoExportOptions };
+/**
+ * Frame clock — the one place that turns a frame index into a timeline time.
+ *
+ * Every offline capture path (CLI pipe/memory transports, browser export)
+ * must agree on which instant a frame shows, otherwise a resumed or
+ * deduplicated render drifts from a fresh one. `i / fps` in floating point is
+ * not exactly reproducible across code paths, so the time is rounded to a
+ * microsecond: `frameTimeSeconds(370, 30)` equals `frameTimeSeconds(37, 3)`.
+ *
+ * Contract: a frame's pixels are a function of its time only. Consumers seek
+ * the player to this time and pause every animation before capturing.
+ */
+/** Timeline second shown by frame `index` at `fps`, rounded to a microsecond. */
+declare function frameTimeSeconds(index: number, fps: number): number;
+/** Number of frames needed to cover `durationSeconds` at `fps` (partial frames round up). */
+declare function frameCountFor(durationSeconds: number, fps: number): number;
+
+export { type AudioTimelineClip, type ComputeAudioTimelineOptions, DASHBOARD_RESOLUTIONS, DEFAULT_DASHBOARD_RESOLUTION, type DashboardResolutionId, type DashboardResolutionPreset, type EncoderResult, FFMPEG_WASM_SETUP_HINT, type FfmpegWasmLoadConfig, type GifDither, type GifFilterOptions, type GifOutputOptions, MAX_DASHBOARD_IMAGE_DIMENSION, MAX_DASHBOARD_IMAGE_PIXELS, MIN_DASHBOARD_IMAGE_DIMENSION, ORIENTATION_DIMENSIONS, QUALITY_PRESETS, type QualityPreset, type RenderHtmlOptions, type ResolveDashboardDimensionsInput, type ResolvedDashboardDimensions, type VideoExportOptions, type VideoOrientation, type VideoQuality, audioBitrateArg, bitrateForQuality, computeAudioTimeline, dashboardFamilyForDimensions, ffmpegAudioMuxArgs, ffmpegGifFilterGraph, ffmpegGifOutputArgs, ffmpegGifPaletteApplicationArgs, ffmpegGifPaletteApplicationGraph, ffmpegGifPaletteGenerationFilter, ffmpegVideoQualityArgs, frameCountFor, frameTimeSeconds, framesToMp4Wasm, generateRenderHtml, resolveDashboardDimensions, resolveDimensions, resolveFfmpegWasmLoad, validateDashboardImageDimensions, validateVideoExportOptions };

package/dist/index.js

@@ -196,6 +196,7 @@ function generateRenderHtml(doc, options) {
     height = 1080,
     captionStyle,
     theme,
+    motion,
     videoPresentation,
     pipSize,
     pipShape,
@@ -222,9 +223,14 @@ function generateRenderHtml(doc, options) {
   const imageMapJson = escapeForScript(JSON.stringify(imageMap));
   const audioMapJson = hasAudio ? escapeForScript(JSON.stringify(audioMap)) : "null";
   const playerOptionLines = [
+    // Always pin the composed viewport to the export size. The page also
+    // pins #squisq-root to it, but an explicit viewport is what stops
+    // portrait/custom renders from falling back to the landscape preset.
+    `    viewport: ${JSON.stringify({ width, height })}`,
     `    animationsEnabled: ${JSON.stringify(animationsEnabled)}`,
     captionStyle ? `    captionStyle: ${JSON.stringify(captionStyle)}` : null,
     theme ? `    theme: ${escapeForScript(JSON.stringify(theme))}` : null,
+    motion != null ? `    motion: ${escapeForScript(JSON.stringify(motion))}` : null,
     videoPresentation ? `    videoPresentation: ${JSON.stringify(videoPresentation)}` : null,
     pipSize ? `    pipSize: ${JSON.stringify(pipSize)}` : null,
     pipShape ? `    pipShape: ${JSON.stringify(pipShape)}` : null,
@@ -512,6 +518,26 @@ async function framesToMp4Wasm(frames, audio, options = {}) {
     ffmpeg.terminate();
   }
 }
+
+// src/frameClock.ts
+function frameTimeSeconds(index, fps) {
+  if (!Number.isSafeInteger(index) || index < 0) {
+    throw new RangeError("Frame index must be a non-negative integer.");
+  }
+  if (!Number.isFinite(fps) || fps <= 0) {
+    throw new RangeError("Frames per second must be a positive number.");
+  }
+  return Math.round(index * 1e6 / fps) / 1e6;
+}
+function frameCountFor(durationSeconds, fps) {
+  if (!Number.isFinite(durationSeconds) || durationSeconds < 0) {
+    throw new RangeError("Duration must be a non-negative number of seconds.");
+  }
+  if (!Number.isFinite(fps) || fps <= 0) {
+    throw new RangeError("Frames per second must be a positive number.");
+  }
+  return Math.max(0, Math.ceil(durationSeconds * fps - 1e-9)) + 0;
+}
 export {
   DASHBOARD_RESOLUTIONS,
   DEFAULT_DASHBOARD_RESOLUTION,
@@ -533,6 +559,8 @@ export {
   ffmpegGifPaletteApplicationGraph,
   ffmpegGifPaletteGenerationFilter,
   ffmpegVideoQualityArgs,
+  frameCountFor,
+  frameTimeSeconds,
   framesToMp4Wasm,
   generateRenderHtml,
   resolveDashboardDimensions,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bendyline/squisq-video",
-  "version": "2.3.12",
+  "version": "2.3.14",
   "description": "Cross-runtime video and animated-GIF helpers with browser-based ffmpeg.wasm encoding for Squisq documents",
   "license": "MIT",
   "author": "Bendyline",
@@ -48,7 +48,7 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@bendyline/squisq": "2.11.9",
+    "@bendyline/squisq": "2.11.10",
     "@ffmpeg/ffmpeg": "0.12.15",
     "@ffmpeg/util": "0.12.2"
   },