@tremolo-ui/dom 0.6.0 → 0.8.0

package/src/options/replace.ts

@@ -0,0 +1,22 @@
+/**
+ * The `update()` argument that leaves an instance with exactly `next` as its
+ * options.
+ *
+ * `update()` merges into what the instance has, which suits a wrapper that
+ * pushes one setting at a time. A wrapper handed the whole new set instead —
+ * a Svelte action, a Vue composable — has to clear what the new set no longer
+ * carries, or a handler taken away, or an option left to its default, keeps
+ * working.
+ *
+ * @example
+ * instance.update(replaceOptions(previous, next))
+ */
+export function replaceOptions<T extends object>(
+  previous: T | undefined,
+  next: T | undefined,
+): Partial<T> {
+  const cleared = Object.fromEntries(
+    Object.keys(previous ?? {}).map((key) => [key, undefined]),
+  ) as Partial<T>
+  return { ...cleared, ...next }
+}

package/src/piano/index.ts

@@ -1,7 +1,12 @@
-import { noteAt, type PianoLayout } from '@tremolo-ui/functions'
-
 import { createDrag } from '../pointer/drag'
 
+import { noteAt, type PianoLayout } from './layout'
+import {
+  isEditableTarget,
+  type KeyboardShortcuts,
+  type KeyboardShortcutsScope,
+} from './shortcuts'
+
 /**
  * What asked for a note to sound.
  *
@@ -33,6 +38,26 @@ export interface PianoInputOptions {
    */
   midiMax?: number
 
+  /**
+   * Play notes from the computer keyboard: `keys[i]` plays
+   * `layout.noteRange.first + i`. `SHORTCUTS` has ready-made layouts.
+   *
+   * A held key keeps its note until it is released, the focus leaves (with
+   * `root`), or the window loses focus. Changing the keys, the scope or the
+   * note range releases every note a key is holding, since the key would
+   * mean something else on release.
+   */
+  keyboardShortcuts?: KeyboardShortcuts
+
+  /**
+   * Where keyboard shortcuts listen: on the element (`root`), which has to
+   * be focusable, or anywhere on the page (`window`). Keys typed into an
+   * editable element are ignored either way.
+   *
+   * @default 'root'
+   */
+  keyboardShortcutsScope?: KeyboardShortcutsScope
+
   /** 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. */
@@ -49,8 +74,8 @@ export interface PianoInputInstance {
   update: (options: Partial<PianoInputOptions>) => void
 
   /**
-   * Start a note from something other than a pointer: a keyboard shortcut, a
-   * MIDI message, an imperative call.
+   * Start a note from something other than a pointer or a shortcut: a MIDI
+   * message, an imperative call.
    */
   noteOn: (
     note: number,
@@ -87,6 +112,11 @@ export function createPianoInput(
   const held = new Map<number, Set<NoteSource>>()
   /** The note each pointer is currently on. */
   const pointerNotes = new Map<number, number>()
+  /**
+   * The note each held shortcut key is playing, by `code` — the physical key,
+   * so that releasing it with a different modifier or layout still matches.
+   */
+  const shortcutNotes = new Map<string, number>()
 
   function activeNotes(): number[] {
     return [...held.keys()].sort((a, b) => a - b)
@@ -156,6 +186,97 @@ export function createPianoInput(
     }
   }
 
+  /** The note a shortcut key plays, or null when it has none. */
+  function shortcutNote(key: string) {
+    const keys = opts.keyboardShortcuts?.keys
+    if (!keys || key === '') return null
+    const { first, last } = opts.layout.noteRange
+    const index = keys.indexOf(key)
+    const note = first + index
+    return index === -1 || note > last ? null : note
+  }
+
+  function onKeyDown(event: KeyboardEvent) {
+    const id = event.code || event.key
+    if (event.repeat || shortcutNotes.has(id)) return
+    if (isEditableTarget(event.target)) return
+    const note = shortcutNote(event.key)
+    if (note === null) return
+    shortcutNotes.set(id, note)
+    noteOn(note, { source: `keyboard:${id}` })
+  }
+
+  function onKeyUp(event: KeyboardEvent) {
+    const id = event.code || event.key
+    const note = shortcutNotes.get(id)
+    if (note === undefined) return
+    shortcutNotes.delete(id)
+    noteOff(note, { source: `keyboard:${id}` })
+  }
+
+  function releaseShortcuts() {
+    for (const [id, note] of shortcutNotes) {
+      noteOff(note, { source: `keyboard:${id}` })
+    }
+    shortcutNotes.clear()
+  }
+
+  function onFocusOut(event: Event) {
+    const next = (event as FocusEvent).relatedTarget
+    // Moving between the keys and whatever else is inside keeps them held.
+    if (next instanceof Node && element.contains(next)) return
+    releaseShortcuts()
+  }
+
+  /** The scope the listeners are bound for, or null when none are. */
+  let boundScope: KeyboardShortcutsScope | null = null
+
+  function bindShortcuts() {
+    const scope = opts.keyboardShortcuts
+      ? (opts.keyboardShortcutsScope ?? 'root')
+      : null
+    if (scope === boundScope) return
+    unbindShortcuts()
+    const win = globalThis.window
+    if (!scope || !win) return
+    const target: EventTarget = scope === 'window' ? win : element
+    target.addEventListener('keydown', onKeyDown as EventListener)
+    target.addEventListener('keyup', onKeyUp as EventListener)
+    if (scope === 'root') element.addEventListener('focusout', onFocusOut)
+    // A key released while the window is in the background never sends its
+    // keyup, so everything is let go when the focus leaves the page.
+    win.addEventListener('blur', releaseShortcuts)
+    boundScope = scope
+  }
+
+  function unbindShortcuts() {
+    const win = globalThis.window
+    if (!boundScope || !win) return
+    const target: EventTarget = boundScope === 'window' ? win : element
+    target.removeEventListener('keydown', onKeyDown as EventListener)
+    target.removeEventListener('keyup', onKeyUp as EventListener)
+    element.removeEventListener('focusout', onFocusOut)
+    win.removeEventListener('blur', releaseShortcuts)
+    boundScope = null
+  }
+
+  /**
+   * What the held keys were started against. Compared by value: a caller
+   * who writes the keys inline hands over a new array on every update, and
+   * releasing on that would stop a note as soon as anything re-renders.
+   */
+  function shortcutMapping() {
+    const { first, last } = opts.layout.noteRange
+    return [
+      opts.keyboardShortcuts?.keys.join('\u0000') ?? '',
+      opts.keyboardShortcutsScope ?? 'root',
+      first,
+      last,
+    ].join('\u0001')
+  }
+
+  bindShortcuts()
+
   const drag = createDrag(element, {
     multiPointer: true,
     onDragStart: (state) =>
@@ -171,7 +292,10 @@ export function createPianoInput(
 
   return {
     update: (next) => {
+      const mapping = shortcutMapping()
       opts = { ...opts, ...next }
+      if (shortcutMapping() !== mapping) releaseShortcuts()
+      bindShortcuts()
 
       const midiMax = opts.midiMax ?? 127
       const stoppedNotes = activeNotes().filter((note) => note > midiMax)
@@ -191,6 +315,8 @@ export function createPianoInput(
     activeNotes,
     destroy: () => {
       drag.destroy()
+      unbindShortcuts()
+      shortcutNotes.clear()
       // Anything still held is released, so a caller that mirrors these
       // callbacks into a synth is not left with a stuck note.
       const notes = activeNotes()

package/src/piano/layout.ts

@@ -0,0 +1,202 @@
+import {
+  isBlackKey,
+  isWhiteKey,
+  noteKey,
+  noteKeys,
+  type NoteKey,
+} from '@tremolo-ui/functions'
+
+export type NoteRange = {
+  first: number
+  last: number
+}
+
+/**
+ * `[noteRange.first, noteRange.first + 1, ..., noteRange.last]`
+ */
+export function getNoteRangeArray(noteRange: NoteRange): number[] {
+  return Array.from(
+    { length: noteRange.last - noteRange.first + 1 },
+    (_, i) => i + noteRange.first,
+  )
+}
+
+/**
+ * The geometry of a drawn keyboard.
+ *
+ * One description is shared by the drawing and the hit testing, so a key cannot
+ * be drawn somewhere other than where it responds.
+ */
+export interface PianoLayout {
+  noteRange: NoteRange
+
+  /** Width of a white key, excluding {@link PianoLayout.keyGap}. */
+  whiteKeyWidth: number
+
+  /**
+   * Space between two white keys. Part of the slot a white key occupies, so it
+   * still belongs to one of the keys for the purpose of hit testing.
+   *
+   * @default 1
+   */
+  keyGap?: number
+
+  /**
+   * Width of a black key, as a fraction of {@link PianoLayout.whiteKeyWidth}.
+   *
+   * @default 0.65
+   */
+  blackKeyWidthRatio?: number
+
+  /**
+   * Height of a black key, as a fraction of the height of the keyboard.
+   *
+   * @default 0.6
+   */
+  blackKeyHeightRatio?: number
+}
+
+const DEFAULT_KEY_GAP = 1
+const DEFAULT_BLACK_KEY_WIDTH_RATIO = 0.65
+const DEFAULT_BLACK_KEY_HEIGHT_RATIO = 0.6
+
+/**
+ * How many white keys sit at or before each pitch class, counting from C.
+ *
+ * A black key shares the number of the white key to its left plus one, which
+ * puts it on the boundary between the two; {@link notePosition} then shifts it
+ * back by half its width to centre it there.
+ */
+const whiteKeysBefore: Record<NoteKey, number> = {
+  C: 0,
+  'C#': 1,
+  D: 1,
+  'D#': 2,
+  E: 2,
+  F: 3,
+  'F#': 4,
+  G: 4,
+  'G#': 5,
+  A: 5,
+  'A#': 6,
+  B: 6,
+}
+
+/** Width of a black key in pixels. */
+export function blackKeyWidth(layout: PianoLayout): number {
+  return (
+    layout.whiteKeyWidth *
+    (layout.blackKeyWidthRatio ?? DEFAULT_BLACK_KEY_WIDTH_RATIO)
+  )
+}
+
+function rawNotePosition(note: number, layout: PianoLayout): number {
+  const slot = layout.whiteKeyWidth + (layout.keyGap ?? DEFAULT_KEY_GAP)
+  const target = noteKey(note)
+  const first = noteKey(layout.noteRange.first)
+
+  const octave = Math.floor((note - layout.noteRange.first) / 12)
+  const octaveOffset =
+    noteKeys.indexOf(first) > noteKeys.indexOf(target) ? 1 : 0
+  const whiteKeysIn =
+    whiteKeysBefore[target] -
+    whiteKeysBefore[first] +
+    (octave + octaveOffset) * 7
+
+  return isBlackKey(note)
+    ? whiteKeysIn * slot - blackKeyWidth(layout) / 2
+    : whiteKeysIn * slot
+}
+
+function pianoBounds(layout: PianoLayout) {
+  const notes = getNoteRangeArray(layout.noteRange)
+  if (notes.length === 0) return { left: 0, right: 0 }
+
+  let left = Infinity
+  let right = -Infinity
+  const whiteWidth = layout.whiteKeyWidth + (layout.keyGap ?? DEFAULT_KEY_GAP)
+  for (const note of notes) {
+    const noteLeft = rawNotePosition(note, layout)
+    const width = isBlackKey(note) ? blackKeyWidth(layout) : whiteWidth
+    left = Math.min(left, noteLeft)
+    right = Math.max(right, noteLeft + width)
+  }
+  return { left, right }
+}
+
+/** Width of the whole keyboard in pixels. */
+export function pianoWidth(layout: PianoLayout): number {
+  const { left, right } = pianoBounds(layout)
+  return right - left
+}
+
+/**
+ * Offset of the left edge of a key from the left edge of the keyboard, in
+ * pixels.
+ *
+ * Notes outside `noteRange` are placed too, so the value is negative below
+ * `noteRange.first`.
+ */
+export function notePosition(note: number, layout: PianoLayout): number {
+  return rawNotePosition(note, layout) - pianoBounds(layout).left
+}
+
+/**
+ * The note drawn at a point, or null where there is none.
+ *
+ * Black keys are tested first, so they win where they overlap a white one. A
+ * white key covers its gap as well as its width, so the whole width of the
+ * keyboard belongs to some key and a click cannot fall between two.
+ *
+ * @param x offset from the left edge of the keyboard, in pixels
+ * @param y offset from its top edge, in pixels
+ * @param height height of the keyboard, in pixels
+ */
+export function noteAt(
+  x: number,
+  y: number,
+  height: number,
+  layout: PianoLayout,
+): number | null {
+  if (x < 0 || x >= pianoWidth(layout) || y < 0 || y >= height) return null
+
+  const notes = getNoteRangeArray(layout.noteRange)
+  const blackHeight =
+    height * (layout.blackKeyHeightRatio ?? DEFAULT_BLACK_KEY_HEIGHT_RATIO)
+
+  if (y < blackHeight) {
+    for (const note of notes) {
+      if (isWhiteKey(note)) continue
+      const left = notePosition(note, layout)
+      if (left <= x && x < left + blackKeyWidth(layout)) return note
+    }
+  }
+
+  const slot = layout.whiteKeyWidth + (layout.keyGap ?? DEFAULT_KEY_GAP)
+  for (const note of notes) {
+    if (isBlackKey(note)) continue
+    const left = notePosition(note, layout)
+    if (left <= x && x < left + slot) return note
+  }
+
+  return null
+}
+
+/**
+ * The white key width that makes the keyboard exactly `width` wide, for a
+ * keyboard that follows the size of its container.
+ *
+ * Solved from {@link pianoWidth} rather than by dividing among the white
+ * keys, so that a range that starts or ends on a black key — which sticks out
+ * by a fraction of a white key — still fills the container. The width grows
+ * linearly with the white key width, so two samples pin it down.
+ */
+export function fitWhiteKeyWidth(
+  width: number,
+  layout: Omit<PianoLayout, 'whiteKeyWidth'>,
+): number {
+  const at = (whiteKeyWidth: number) => pianoWidth({ ...layout, whiteKeyWidth })
+  const slope = at(2) - at(1)
+  if (slope <= 0) return 0
+  return (width - (at(1) - slope)) / slope
+}

package/src/piano/shortcuts.ts

@@ -0,0 +1,86 @@
+export type KeyboardShortcuts = {
+  /**
+   * Keys laid out from `noteRange.first`, one entry per semitone.
+   *
+   * An empty string leaves that note without a shortcut: `KeyboardEvent.key` is
+   * never empty, so the entry can never match. Use it to skip the black keys
+   * (see {@link SHORTCUTS.HOME_ROW_NATURAL}) and keep the remaining entries
+   * lined up with the notes.
+   */
+  keys: string[]
+}
+
+/**
+ * Ready-made keyboard layouts. Both assume `noteRange.first` is a C.
+ */
+export const SHORTCUTS = {
+  /** Every semitone from C, over the two rows of a QWERTY keyboard. */
+  HOME_ROW: {
+    keys: [
+      'a',
+      'w',
+      's',
+      'e',
+      'd',
+      'f',
+      't',
+      'g',
+      'y',
+      'h',
+      'u',
+      'j',
+      'k',
+      'o',
+      'l',
+      'p',
+      ';',
+    ],
+  },
+  /** The white keys only, on the home row. Black keys have no shortcut. */
+  HOME_ROW_NATURAL: {
+    keys: [
+      'a',
+      '',
+      's',
+      '',
+      'd',
+      'f',
+      '',
+      'g',
+      '',
+      'h',
+      '',
+      'j',
+      'k',
+      '',
+      'l',
+      '',
+      ';',
+    ],
+  },
+}
+
+/**
+ * Where keyboard shortcuts listen. `root` handles keys only while the piano
+ * or one of its descendants has focus; `window` handles them anywhere on the
+ * page except in editable elements.
+ */
+export type KeyboardShortcutsScope = 'root' | 'window'
+
+/**
+ * Whether a key press was typed into something: shortcuts must not play a
+ * note for a letter that is going into a text field.
+ */
+export function isEditableTarget(target: EventTarget | null) {
+  if (!(target instanceof HTMLElement)) return false
+  if (target.matches('input, textarea, select')) return true
+
+  for (let element: HTMLElement | null = target; element;) {
+    const contentEditable = element.getAttribute('contenteditable')
+    if (contentEditable !== null)
+      return contentEditable.toLowerCase() !== 'false'
+    element = element.parentElement
+  }
+
+  return false
+}

package/src/pointer/long-press.ts

@@ -0,0 +1,103 @@
+export interface LongPressOptions {
+  /** Called once on the press, then again every `interval` after `delay`. */
+  onPress: () => void
+  /**
+   * How long the press has to be held before it starts repeating, in
+   * milliseconds.
+   *
+   * @default 500
+   */
+  delay?: number
+  /**
+   * How often it repeats once it has started, in milliseconds.
+   *
+   * @default 40
+   */
+  interval?: number
+}
+
+export interface LongPressInstance {
+  /**
+   * Start a press, from a `pointerdown` or with no event at all. Only the
+   * primary button starts one, and a press already in progress is left alone.
+   */
+  start: (event?: Pick<PointerEvent, 'button' | 'pointerId'>) => void
+  /** End the press, as releasing the pointer would. */
+  stop: () => void
+  /** Replace the given options. The press in progress picks them up. */
+  update: (options: Partial<LongPressOptions>) => void
+  /** Whether a press is in progress. */
+  pressed: () => boolean
+  destroy: () => void
+}
+
+/**
+ * Repeat an action while a pointer is held down: once on the press, then
+ * again every `interval` after `delay` — the way a stepper button or a
+ * key held on a keyboard behaves.
+ *
+ * The release is listened for on the window, not on the element: the
+ * pointer may be let go anywhere. Only the pointer that started the press
+ * ends it, so a second finger lifting elsewhere does not. The window losing
+ * focus ends it too, since the release would never arrive.
+ */
+export function createLongPress(options: LongPressOptions): LongPressInstance {
+  let opts = options
+  let pointerId: number | null = null
+  let active = false
+  let timer: ReturnType<typeof setTimeout> | null = null
+
+  function clearTimer() {
+    if (timer !== null) clearTimeout(timer)
+    timer = null
+  }
+
+  /** Wait `wait`, fire, and keep going at `interval` from then on. */
+  function schedule(wait: number) {
+    timer = setTimeout(() => {
+      opts.onPress()
+      if (active) schedule(opts.interval ?? 40)
+    }, wait)
+  }
+
+  function onPointerEnd(event: PointerEvent) {
+    // Pointer events carry an id; a press started without one ends on any.
+    if (pointerId !== null && event.pointerId !== pointerId) return
+    stop()
+  }
+
+  function listen(add: boolean) {
+    const target = globalThis.window
+    if (!target) return
+    const method = add ? 'addEventListener' : 'removeEventListener'
+    target[method]('pointerup', onPointerEnd as EventListener)
+    target[method]('pointercancel', onPointerEnd as EventListener)
+    target[method]('blur', stop)
+  }
+
+  function stop() {
+    if (!active) return
+    active = false
+    pointerId = null
+    clearTimer()
+    listen(false)
+  }
+
+  return {
+    start: (event) => {
+      if (active || (event && event.button !== 0)) return
+      active = true
+      pointerId = event?.pointerId ?? null
+      listen(true)
+      opts.onPress()
+      // The action may have stopped the press itself.
+      if (active) schedule(opts.delay ?? 500)
+    },
+    stop,
+    update: (next) => {
+      opts = { ...opts, ...next }
+    },
+    pressed: () => active,
+    destroy: stop,
+  }
+}