@motionscript/audio 0.0.0-stage → 0.1.0-alpha.0

package/src/waveform/shared.ts

@@ -0,0 +1,194 @@
+import { Graphics2D, type Fill, type FillResolved } from "@motionscript/core"
+
+import type { EnvelopeBar } from "./envelope"
+
+/**
+ * Geometry and paint shared by the two waveform nodes.
+ *
+ * They draw the same object — a row of bars whose heights are loudness — and
+ * differ only in what decides the heights: the whole file for one, a window
+ * around the playhead for the other. Everything about *how a row of bars is
+ * laid out and painted* is therefore common, and lives here so the two cannot
+ * drift into looking like different components.
+ */
+
+/** How a bar is grown out of its baseline. */
+export const WAVEFORM_ALIGNMENTS = ["center", "bottom"] as const
+export type WaveformAlignment = (typeof WAVEFORM_ALIGNMENTS)[number]
+
+/** What the bars are shaped like. */
+export const WAVEFORM_STYLES = ["bars", "line", "blocks"] as const
+export type WaveformStyle = (typeof WAVEFORM_STYLES)[number]
+
+/**
+ * The colours voices are drawn in when nobody has assigned any.
+ *
+ * The same eight the app's speaker library suggests, in the same order, so a
+ * transcript whose voices are still unnamed already draws in the colours the
+ * transcript panel is showing them in. Duplicated as literals rather than
+ * imported because `scene-core` knows nothing about the app's speaker table —
+ * and must not, since a scene has to build in a headless render with no
+ * database in scope.
+ */
+export const VOICE_PALETTE = [
+  "#6366f1",
+  "#14b8a6",
+  "#f59e0b",
+  "#ec4899",
+  "#22c55e",
+  "#3b82f6",
+  "#f97316",
+  "#a855f7",
+] as const
+
+/** The colour a voice takes, wrapping past the end of the palette. */
+export function voiceColor(index: number): string {
+  return VOICE_PALETTE[
+    ((index % VOICE_PALETTE.length) + VOICE_PALETTE.length) %
+      VOICE_PALETTE.length
+  ]
+}
+
+/** Where one bar sits and how tall it came out. */
+export interface BarBox {
+  x: number
+  y: number
+  width: number
+  height: number
+}
+
+/**
+ * Lays a row of bars out across a box.
+ *
+ * The gap is stated as a *fraction of the pitch* rather than in pixels, and
+ * that is the one decision here worth stating out loud: the bar count is a
+ * control, so a gap in pixels would silently become a solid block at 200 bars
+ * and a picket fence at 20. As a fraction, the row keeps the same rhythm at
+ * every density — which is what lets the count be a slider anyone can drag.
+ *
+ * A bar is never thinner than a hairline and never shorter than one either: a
+ * silent passage has to read as "audio, and nothing here" rather than as a hole
+ * in the drawing, exactly as it does on the timeline's clip bars.
+ */
+export function layOutBars(
+  bars: readonly EnvelopeBar[],
+  options: {
+    width: number
+    height: number
+    gap: number
+    align: WaveformAlignment
+    /** Multiplies every magnitude before it is clamped back into 0…1. */
+    gain: number
+    /** Fraction of the box a silent bar still occupies. */
+    floor: number
+  }
+): BarBox[] {
+  const { width, height, gap, align, gain, floor } = options
+  const count = bars.length
+  if (count === 0 || width <= 0 || height <= 0) return []
+
+  const pitch = width / count
+  const barWidth = Math.max(1, pitch * (1 - clamp01(gap)))
+  // The tallest a bar may be. Centre-aligned bars grow both ways from the
+  // middle, so the *half* is what a magnitude of 1 fills.
+  const full = align === "center" ? height / 2 : height
+
+  const out: BarBox[] = new Array(count)
+  for (let i = 0; i < count; i++) {
+    const magnitude = clamp01(bars[i].magnitude * gain)
+    const reach = Math.max(full * clamp01(floor), full * magnitude)
+    const x = -width / 2 + pitch * i + (pitch - barWidth) / 2
+
+    out[i] =
+      align === "center"
+        ? { x, y: -reach, width: barWidth, height: Math.max(1, reach * 2) }
+        : {
+            x,
+            y: height / 2 - reach,
+            width: barWidth,
+            height: Math.max(1, reach),
+          }
+  }
+  return out
+}
+
+/**
+ * Draws a run of bars in one paint.
+ *
+ * Batched by colour by the caller, and this is why: every `Graphics2D` handed to
+ * `ctx.draw` is a surface the renderer composites, so a bar apiece would be a
+ * thousand surfaces a frame. Chaining the rects of one colour into a single
+ * `Graphics2D` before filling makes it one — and, as a bonus, a gradient fill
+ * maps across the whole run rather than restarting inside every bar, which is
+ * the behaviour anyone reaching for a gradient here actually wants.
+ */
+export function paintBars(
+  boxes: readonly BarBox[],
+  fill: Fill,
+  radius: number
+): Graphics2D | null {
+  if (boxes.length === 0) return null
+  if ((fill as FillResolved[]).length === 0) return null
+
+  const graphics = new Graphics2D()
+  for (const box of boxes) {
+    graphics.rect({
+      x: box.x + box.width / 2,
+      y: box.y + box.height / 2,
+      width: box.width,
+      height: box.height,
+      // Never rounder than the bar is wide, or a thin bar becomes a lozenge
+      // whose ends taper away to nothing.
+      cornerRadius: Math.min(radius, box.width / 2, box.height / 2),
+    })
+  }
+  return graphics.fill(fill)
+}
+
+/**
+ * Groups bars by the paint they take, preserving order within each group.
+ *
+ * The seam that makes {@link paintBars} worth batching: a diarized waveform has
+ * as many colours as it has voices, not as many as it has bars, so a
+ * conversation of two people is two draws however long it runs.
+ */
+export function groupByPaint<K>(
+  boxes: readonly BarBox[],
+  keyOf: (index: number) => K
+): Map<K, BarBox[]> {
+  const groups = new Map<K, BarBox[]>()
+  for (let i = 0; i < boxes.length; i++) {
+    const key = keyOf(i)
+    const run = groups.get(key)
+    if (run) run.push(boxes[i])
+    else groups.set(key, [boxes[i]])
+  }
+  return groups
+}
+
+export function clamp01(value: number): number {
+  return value < 0 ? 0 : value > 1 ? 1 : value
+}
+
+/**
+ * The {@link groupByPaint} key one bar of a live visualiser takes.
+ *
+ * Filtered to one voice, every bar is that voice regardless of `byVoice` or
+ * whose turn the bucket originally belonged to. That second part is the one
+ * worth spelling out: {@link forSpeaker} silences a bar by zeroing its
+ * magnitude but leaves `speaker` exactly as it was, so a bar sitting in the
+ * middle of a *different* voice's turn is still stamped with that voice's
+ * index — grouping by `byVoice`'s usual per-bar key would paint those silent
+ * stretches in whoever used to be talking there, in flickers too short to
+ * read as anything but noise. Forcing every bar under the filtered voice's own
+ * key is the true picture instead: the node is drawing exactly one person, on
+ * or off, never anyone else's colour.
+ */
+export function livePaintKey(
+  barSpeaker: number,
+  byVoice: boolean,
+  filteredVoice: number | null
+): string {
+  if (filteredVoice !== null) return `voice:${filteredVoice}`
+  return byVoice ? `voice:${barSpeaker}` : "all"
+}

package/README.md

@@ -1,4 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
-If no other versions are published within 30 days, this package and version will be deleted.