@tremolo-ui/dom 0.4.0 → 0.5.0

package/src/piano/input.ts

@@ -0,0 +1,185 @@
+import { noteAt, type PianoLayout } from '@tremolo-ui/functions'
+
+import { createDrag } from '../pointer/drag'
+
+/**
+ * What asked for a note to sound.
+ *
+ * A note stops only once everything that asked for it has let go, so two
+ * fingers on one key, or a key held by both the mouse and a MIDI keyboard,
+ * behave the way they look.
+ *
+ * Pointers use `pointer:<pointerId>`; everything else names its own source.
+ */
+export type NoteSource = string
+
+export interface PianoInputOptions {
+  /** Geometry of the drawn keyboard, used to find the note under a pointer. */
+  layout: PianoLayout
+
+  /**
+   * Let a pointer slide from one key to the next while it is down. With it off,
+   * the key that was pressed keeps sounding until the pointer is released.
+   *
+   * @default true
+   */
+  glissando?: boolean
+
+  /**
+   * Highest note that can sound. Above it a note is refused, whichever source
+   * asks for it.
+   *
+   * @default 127
+   */
+  midiMax?: number
+
+  /** Called when a note starts sounding, not for each source that asks. */
+  onPlayNote?: (note: number, velocity?: number) => void
+  /** Called once the last source holding a note has let go. */
+  onStopNote?: (note: number) => void
+  /** Called whenever {@link PianoInputInstance.activeNotes} would change. */
+  onActiveNotesChange?: (notes: number[]) => void
+}
+
+export interface PianoInputInstance {
+  /**
+   * Replace the given options. Lets a wrapper feed a fresh layout in without
+   * tearing down the listeners, which would abort a drag in progress.
+   */
+  update: (options: Partial<PianoInputOptions>) => void
+
+  /**
+   * Start a note from something other than a pointer: a keyboard shortcut, a
+   * MIDI message, an imperative call.
+   */
+  noteOn: (
+    note: number,
+    options?: { source?: NoteSource; velocity?: number },
+  ) => void
+  /** Release a note held by `source`. */
+  noteOff: (note: number, options?: { source?: NoteSource }) => void
+
+  /** The notes currently sounding, ascending. */
+  activeNotes: () => number[]
+
+  destroy: () => void
+}
+
+const DEFAULT_SOURCE: NoteSource = 'api'
+
+/**
+ * Drive a piano keyboard with pointers, and own what is sounding.
+ *
+ * Every way of playing a note goes through the one instance — pointers here,
+ * keyboard shortcuts and MIDI through {@link PianoInputInstance.noteOn} — so
+ * there is a single answer to what is currently held, and drawing the keys is
+ * left entirely to the wrapper.
+ *
+ * Tracks every pointer at once, so a chord can be played with several fingers.
+ */
+export function createPianoInput(
+  element: Element,
+  options: PianoInputOptions,
+): PianoInputInstance {
+  let opts = options
+
+  /** Which sources are holding each sounding note. */
+  const held = new Map<number, Set<NoteSource>>()
+  /** The note each pointer is currently on. */
+  const pointerNotes = new Map<number, number>()
+
+  function activeNotes(): number[] {
+    return [...held.keys()].sort((a, b) => a - b)
+  }
+
+  function noteOn(
+    note: number,
+    {
+      source = DEFAULT_SOURCE,
+      velocity,
+    }: { source?: NoteSource; velocity?: number } = {},
+  ) {
+    if (note > (opts.midiMax ?? 127)) return
+
+    const sources = held.get(note)
+    if (sources) {
+      // Already sounding: remember the extra holder and leave it alone.
+      sources.add(source)
+      return
+    }
+
+    held.set(note, new Set([source]))
+    opts.onPlayNote?.(note, velocity)
+    opts.onActiveNotesChange?.(activeNotes())
+  }
+
+  function noteOff(
+    note: number,
+    { source = DEFAULT_SOURCE }: { source?: NoteSource } = {},
+  ) {
+    const sources = held.get(note)
+    if (!sources) return
+
+    sources.delete(source)
+    if (sources.size > 0) return
+
+    held.delete(note)
+    opts.onStopNote?.(note)
+    opts.onActiveNotesChange?.(activeNotes())
+  }
+
+  /** The note under a pointer, or null where the pointer is off the keys. */
+  function noteUnder(clientX: number, clientY: number): number | null {
+    const { left, top, height } = element.getBoundingClientRect()
+    return noteAt(clientX - left, clientY - top, height, opts.layout)
+  }
+
+  /** Move a pointer onto a note, releasing whatever it held before. */
+  function movePointer(pointerId: number, note: number | null) {
+    const source = `pointer:${pointerId}`
+    const previous = pointerNotes.get(pointerId)
+    if (previous === note) return
+
+    if (previous !== undefined) noteOff(previous, { source })
+
+    if (note === null) {
+      pointerNotes.delete(pointerId)
+    } else {
+      pointerNotes.set(pointerId, note)
+      noteOn(note, { source })
+    }
+  }
+
+  const drag = createDrag(element, {
+    multiPointer: true,
+    onDragStart: (state) =>
+      movePointer(state.pointerId, noteUnder(state.clientX, state.clientY)),
+    onDrag: (state) => {
+      // Without glissando the pressed key holds until the pointer is released,
+      // so where the pointer wanders to does not matter.
+      if (opts.glissando === false) return
+      movePointer(state.pointerId, noteUnder(state.clientX, state.clientY))
+    },
+    onDragEnd: (state) => movePointer(state.pointerId, null),
+  })
+
+  return {
+    update: (next) => {
+      opts = { ...opts, ...next }
+    },
+    noteOn,
+    noteOff,
+    activeNotes,
+    destroy: () => {
+      drag.destroy()
+      // Anything still held is released, so a caller that mirrors these
+      // callbacks into a synth is not left with a stuck note.
+      for (const note of activeNotes()) {
+        held.delete(note)
+        opts.onStopNote?.(note)
+      }
+      pointerNotes.clear()
+      opts.onActiveNotesChange?.([])
+    },
+  }
+}

package/src/pointer/drag.ts

@@ -8,16 +8,23 @@ export type DragState = {
   /** Pointer position in viewport coordinates. */
   clientX: number
   clientY: number
+  /**
+   * Which pointer this is. Always the same value for one drag; with
+   * {@link DragOptions.multiPointer} it tells concurrent drags apart.
+   */
+  pointerId: number
   event: PointerEvent
 }
 
 export type DragOptions = {
   /**
-   * Minimum movement in pixels before `onDrag` fires.
+   * Minimum movement in pixels before `onDrag` fires. Movement below it is
+   * carried over to the next event rather than discarded, so a slow drag still
+   * reports once it adds up.
+   *
    * Prevents `onDrag` from firing on, for example, a double click.
-   * Values below 1 are clamped to 1.
    *
-   * @default 1
+   * @default 0
    */
   threshold?: number
 
@@ -25,15 +32,38 @@ export type DragOptions = {
    * CSS cursor to show while dragging. Applied to the element itself: pointer
    * capture keeps it in effect even once the pointer leaves the element, so
    * there is no need to touch the document.
+   *
+   * With {@link DragOptions.multiPointer} it is set for the first pointer and
+   * restored once the last one is up.
    */
   cursor?: string
 
+  /**
+   * Track every pointer that goes down on the element, rather than only the
+   * first. Each one gets its own `onDragStart` / `onDrag` / `onDragEnd` and
+   * carries its own totals; {@link DragState.pointerId} says which is which.
+   *
+   * Fixed for the lifetime of the instance: switching part way through a drag
+   * has no meaning, so `update()` ignores it.
+   *
+   * @default false
+   */
+  multiPointer?: boolean
+
   onDragStart?: (state: DragState) => void
   onDrag?: (state: DragState) => void
   onDragEnd?: (state: DragState) => void
 }
 
 export interface DragInstance {
+  /**
+   * Replace the given options. Lets a wrapper feed fresh handlers in without
+   * tearing down the listeners, which would abort a drag in progress.
+   *
+   * `multiPointer` is fixed for the lifetime of the instance and is ignored
+   * here.
+   */
+  update: (options: DragOptions) => void
   destroy: () => void
 }
 
@@ -57,6 +87,16 @@ type CaptureTarget = {
   hasPointerCapture?: (pointerId: number) => boolean
 }
 
+/** What one pointer needs to report its own movement. */
+type PointerState = {
+  /** Where the listeners for this pointer live. */
+  moveTarget: EventTarget
+  startX: number
+  startY: number
+  lastX: number
+  lastY: number
+}
+
 /**
  * Track a pointer drag on an element.
  *
@@ -65,18 +105,15 @@ type CaptureTarget = {
  * element gets `touch-action: none` so that touch dragging does not scroll the
  * page, plus `user-select: none` so that a long press does not start a text
  * selection instead.
+ *
+ * One pointer at a time by default; see {@link DragOptions.multiPointer}.
  */
 export function createDrag(
   element: Element,
-  {
-    threshold: _threshold = 1,
-    cursor,
-    onDragStart,
-    onDrag,
-    onDragEnd,
-  }: DragOptions = {},
+  options: DragOptions = {},
 ): DragInstance {
-  const threshold = Math.max(_threshold, 1)
+  let opts = options
+  const multiPointer = options.multiPointer ?? false
   const capture = element as CaptureTarget
   const style = (element as Partial<HTMLElement>).style
 
@@ -88,27 +125,29 @@ export function createDrag(
     }
   }
 
-  let pointerId: number | null = null
-  /** Where the listeners for the current drag live. */
-  let moveTarget: EventTarget | null = null
-  let startX = 0
-  let startY = 0
-  let lastX = 0
-  let lastY = 0
+  const pointers = new Map<number, PointerState>()
+  /**
+   * How many pointers each target carries. Adding the same listener twice is a
+   * no-op and removing it once removes it for good, so a target is subscribed
+   * to while at least one pointer is on it and no longer.
+   */
+  const targets = new Map<EventTarget, number>()
   let previousCursor: string | undefined
 
   function state(
     event: PointerEvent,
+    pointer: PointerState,
     deltaX: number,
     deltaY: number,
   ): DragState {
     return {
-      x: event.screenX - startX,
-      y: event.screenY - startY,
+      x: event.screenX - pointer.startX,
+      y: event.screenY - pointer.startY,
       deltaX,
       deltaY,
       clientX: event.clientX,
       clientY: event.clientY,
+      pointerId: event.pointerId,
       event,
     }
   }
@@ -122,83 +161,124 @@ export function createDrag(
     event.preventDefault()
   }
 
+  function retainTarget(target: EventTarget) {
+    const count = targets.get(target) ?? 0
+    if (count === 0) {
+      target.addEventListener('pointermove', handlePointerMove)
+      target.addEventListener('pointerup', handlePointerUp)
+      target.addEventListener('pointercancel', handlePointerUp)
+    }
+    targets.set(target, count + 1)
+  }
+
+  function releaseTarget(target: EventTarget) {
+    const count = targets.get(target) ?? 0
+    if (count > 1) {
+      targets.set(target, count - 1)
+      return
+    }
+    target.removeEventListener('pointermove', handlePointerMove)
+    target.removeEventListener('pointerup', handlePointerUp)
+    target.removeEventListener('pointercancel', handlePointerUp)
+    targets.delete(target)
+  }
+
   function handlePointerDown(event: Event) {
     const pointerEvent = event as PointerEvent
-    // Only one pointer drives the drag; ignore additional touches.
-    if (pointerId !== null) return
-
-    pointerId = pointerEvent.pointerId
-    startX = lastX = pointerEvent.screenX
-    startY = lastY = pointerEvent.screenY
+    const pointerId = pointerEvent.pointerId
+    // Without multiPointer only one pointer drives the drag; ignore the rest.
+    if (pointers.has(pointerId)) return
+    if (!multiPointer && pointers.size > 0) return
 
-    if (cursor && style) {
+    const isFirst = pointers.size === 0
+    if (isFirst && opts.cursor && style) {
       previousCursor = style.cursor
-      style.cursor = cursor
+      style.cursor = opts.cursor
     }
 
     capture.setPointerCapture?.(pointerId)
     // With pointer capture the element receives the rest of the gesture.
     // Without it (older engines, jsdom) fall back to the window.
-    moveTarget =
+    const moveTarget =
       capture.hasPointerCapture?.(pointerId) === true
         ? element
         : (globalThis.window ?? element)
 
-    moveTarget.addEventListener('pointermove', handlePointerMove)
-    moveTarget.addEventListener('pointerup', handlePointerUp)
-    moveTarget.addEventListener('pointercancel', handlePointerUp)
-    globalThis.document?.addEventListener('selectstart', preventSelectStart)
+    const pointer: PointerState = {
+      moveTarget,
+      startX: pointerEvent.screenX,
+      startY: pointerEvent.screenY,
+      lastX: pointerEvent.screenX,
+      lastY: pointerEvent.screenY,
+    }
+    pointers.set(pointerId, pointer)
+
+    retainTarget(moveTarget)
+    if (isFirst) {
+      globalThis.document?.addEventListener('selectstart', preventSelectStart)
+    }
 
-    onDragStart?.(state(pointerEvent, 0, 0))
+    opts.onDragStart?.(state(pointerEvent, pointer, 0, 0))
   }
 
   function handlePointerMove(event: Event) {
     const pointerEvent = event as PointerEvent
-    if (pointerEvent.pointerId !== pointerId) return
+    const pointer = pointers.get(pointerEvent.pointerId)
+    if (!pointer) return
 
-    const deltaX = pointerEvent.screenX - lastX
-    const deltaY = pointerEvent.screenY - lastY
-    lastX = pointerEvent.screenX
-    lastY = pointerEvent.screenY
+    const deltaX = pointerEvent.screenX - pointer.lastX
+    const deltaY = pointerEvent.screenY - pointer.lastY
 
-    // Movement below the threshold is dropped rather than accumulated.
+    // Movement below the threshold accumulates until it crosses it. Dropping it
+    // instead would swallow a slow drag entirely: pointer coordinates are
+    // fractional, so each event can move less than a pixel and never report.
+    const threshold = opts.threshold ?? 0
     if (Math.abs(deltaX) < threshold && Math.abs(deltaY) < threshold) return
 
-    onDrag?.(state(pointerEvent, deltaX, deltaY))
+    pointer.lastX = pointerEvent.screenX
+    pointer.lastY = pointerEvent.screenY
+
+    opts.onDrag?.(state(pointerEvent, pointer, deltaX, deltaY))
   }
 
   function handlePointerUp(event: Event) {
     const pointerEvent = event as PointerEvent
-    if (pointerEvent.pointerId !== pointerId) return
+    const pointer = pointers.get(pointerEvent.pointerId)
+    if (!pointer) return
 
-    const deltaX = pointerEvent.screenX - lastX
-    const deltaY = pointerEvent.screenY - lastY
-    const finalState = state(pointerEvent, deltaX, deltaY)
+    const deltaX = pointerEvent.screenX - pointer.lastX
+    const deltaY = pointerEvent.screenY - pointer.lastY
+    const finalState = state(pointerEvent, pointer, deltaX, deltaY)
 
-    stopTracking()
-    onDragEnd?.(finalState)
+    stopTracking(pointerEvent.pointerId)
+    opts.onDragEnd?.(finalState)
   }
 
-  function stopTracking() {
-    if (pointerId === null) return
+  function stopTracking(pointerId: number) {
+    const pointer = pointers.get(pointerId)
+    if (!pointer) return
+
     capture.releasePointerCapture?.(pointerId)
-    moveTarget?.removeEventListener('pointermove', handlePointerMove)
-    moveTarget?.removeEventListener('pointerup', handlePointerUp)
-    moveTarget?.removeEventListener('pointercancel', handlePointerUp)
+    releaseTarget(pointer.moveTarget)
+    pointers.delete(pointerId)
+
+    if (pointers.size > 0) return
+
     globalThis.document?.removeEventListener('selectstart', preventSelectStart)
-    if (cursor && style) {
-      style.cursor = previousCursor ?? ''
+    if (previousCursor !== undefined && style) {
+      style.cursor = previousCursor
       previousCursor = undefined
     }
-    moveTarget = null
-    pointerId = null
   }
 
   element.addEventListener('pointerdown', handlePointerDown)
 
   return {
+    update: (next) => {
+      opts = { ...opts, ...next, multiPointer }
+    },
     destroy: () => {
-      stopTracking()
+      for (const pointerId of [...pointers.keys()]) stopTracking(pointerId)
       element.removeEventListener('pointerdown', handlePointerDown)
       if (style) {
         for (const [property] of MANAGED_STYLES) {