wavesurfer.js 6.5.0 → 7.0.0-alpha.0

package/src/plugins/regions.ts

@@ -0,0 +1,240 @@
+import BasePlugin from '../base-plugin.js'
+import { WaveSurferPluginParams } from '../index.js'
+
+const MIN_WIDTH = 10
+
+type Region = {
+  startTime: number
+  endTime: number
+  title: string
+  start: number
+  end: number
+  element: HTMLElement
+}
+
+type RegionsPluginEvents = {
+  'region-created': { region: Region }
+  'region-updated': { region: Region }
+  'region-clicked': { region: Region }
+}
+
+class RegionsPlugin extends BasePlugin<RegionsPluginEvents> {
+  private dragStart = NaN
+  private container: HTMLElement
+  private regions: Region[] = []
+  private createdRegion: Region | null = null
+  private modifiedRegion: Region | null = null
+  private isResizingLeft = false
+  private isMoving = false
+
+  /** Create an instance of RegionsPlugin */
+  constructor(params: WaveSurferPluginParams) {
+    super(params)
+
+    this.container = this.initContainer()
+
+    const unsubscribeReady = this.wavesurfer.on('ready', () => {
+      const wrapper = this.renderer.getContainer()
+      wrapper.appendChild(this.container)
+      unsubscribeReady()
+    })
+    this.subscriptions.push(unsubscribeReady)
+
+    const wsContainer = this.renderer.getContainer()
+    wsContainer.addEventListener('mousedown', this.handleMouseDown)
+    document.addEventListener('mousemove', this.handleMouseMove)
+    document.addEventListener('mouseup', this.handleMouseUp)
+  }
+
+  /** Unmounts the regions */
+  public destroy() {
+    this.renderer.getContainer().removeEventListener('mousedown', this.handleMouseDown)
+    document.removeEventListener('mousemove', this.handleMouseMove)
+    document.removeEventListener('mouseup', this.handleMouseUp, true)
+
+    this.container?.remove()
+
+    super.destroy()
+  }
+
+  private initContainer(): HTMLElement {
+    const div = document.createElement('div')
+    div.style.position = 'absolute'
+    div.style.top = '0'
+    div.style.left = '0'
+    div.style.width = '100%'
+    div.style.height = '100%'
+    div.style.zIndex = '3'
+    div.style.pointerEvents = 'none'
+    return div
+  }
+
+  private handleMouseDown = (e: MouseEvent) => {
+    this.dragStart = e.clientX - this.container.getBoundingClientRect().left
+  }
+
+  private handleMouseMove = (e: MouseEvent) => {
+    const dragEnd = e.clientX - this.container.getBoundingClientRect().left
+
+    if (this.modifiedRegion && this.isMoving) {
+      this.moveRegion(this.modifiedRegion, dragEnd - this.dragStart)
+      this.dragStart = dragEnd
+      return
+    }
+
+    if (this.modifiedRegion) {
+      this.updateRegion(
+        this.modifiedRegion,
+        this.isResizingLeft ? dragEnd : undefined,
+        this.isResizingLeft ? undefined : dragEnd,
+      )
+      return
+    }
+
+    if (!isNaN(this.dragStart)) {
+      const dragEnd = e.clientX - this.container.getBoundingClientRect().left
+
+      if (dragEnd - this.dragStart >= MIN_WIDTH) {
+        if (!this.createdRegion) {
+          this.renderer.getContainer().style.pointerEvents = 'none'
+
+          this.createdRegion = this.createRegion(this.dragStart, dragEnd)
+        } else {
+          this.updateRegion(this.createdRegion, this.dragStart, dragEnd)
+        }
+      }
+    }
+  }
+
+  private handleMouseUp = () => {
+    if (this.createdRegion) {
+      this.addRegion(this.createdRegion)
+      this.createdRegion = null
+    }
+    this.modifiedRegion = null
+    this.isMoving = false
+    this.dragStart = NaN
+    this.renderer.getContainer().style.pointerEvents = ''
+  }
+
+  private createRegionElement(start: number, end: number, title = ''): HTMLElement {
+    const el = document.createElement('div')
+    el.style.position = 'absolute'
+    el.style.left = `${start}px`
+    el.style.width = `${end - start}px`
+    el.style.height = '100%'
+    el.style.backgroundColor = 'rgba(0, 0, 0, 0.1)'
+    el.style.transition = 'background-color 0.2s ease'
+    el.style.cursor = 'move'
+    el.style.pointerEvents = 'all'
+    el.title = title
+
+    const leftHandle = document.createElement('div')
+    leftHandle.style.position = 'absolute'
+    leftHandle.style.left = '0'
+    leftHandle.style.width = '6px'
+    leftHandle.style.height = '100%'
+    leftHandle.style.borderLeft = '2px solid rgba(0, 0, 0, 0.5)'
+    leftHandle.style.cursor = 'ew-resize'
+    leftHandle.style.pointerEvents = 'all'
+    el.appendChild(leftHandle)
+
+    const rightHandle = document.createElement('div')
+    rightHandle.style.position = 'absolute'
+    rightHandle.style.right = '0'
+    rightHandle.style.width = '6px'
+    rightHandle.style.height = '100%'
+    rightHandle.style.borderRight = '2px solid rgba(0, 0, 0, 0.5)'
+    rightHandle.style.cursor = 'ew-resize'
+    rightHandle.style.pointerEvents = 'all'
+    el.appendChild(rightHandle)
+
+    leftHandle.addEventListener('mousedown', (e) => {
+      e.stopPropagation()
+      this.modifiedRegion = this.regions.find((r) => r.element === el) || null
+      this.isResizingLeft = true
+      this.isMoving = false
+    })
+
+    rightHandle.addEventListener('mousedown', (e) => {
+      e.stopPropagation()
+      this.modifiedRegion = this.regions.find((r) => r.element === el) || null
+      this.isResizingLeft = false
+      this.isMoving = false
+    })
+
+    el.addEventListener('mousedown', () => {
+      this.modifiedRegion = this.regions.find((r) => r.element === el) || null
+      this.isMoving = true
+    })
+
+    el.addEventListener('click', () => {
+      const region = this.regions.find((r) => r.element === el)
+      if (region) {
+        this.emit('region-clicked', { region })
+      }
+    })
+
+    this.container.appendChild(el)
+
+    return el
+  }
+
+  private createRegion(start: number, end: number, title = ''): Region {
+    const duration = this.wavesurfer.getDuration()
+    const width = this.container.clientWidth
+
+    return {
+      element: this.createRegionElement(start, end, title),
+      start,
+      end,
+      startTime: (start / width) * duration,
+      endTime: (end / width) * duration,
+      title,
+    }
+  }
+
+  private addRegion(region: Region) {
+    this.regions.push(region)
+
+    this.emit('region-created', { region })
+  }
+
+  private updateRegion(region: Region, start?: number, end?: number) {
+    if (start != null) {
+      region.start = start ?? region.start
+      region.element.style.left = `${region.start}px`
+      region.startTime = (start / this.container.clientWidth) * this.wavesurfer.getDuration()
+    }
+
+    if (end != null) {
+      region.end = end
+      region.element.style.width = `${region.end - region.start}px`
+      region.endTime = (end / this.container.clientWidth) * this.wavesurfer.getDuration()
+    }
+
+    this.emit('region-updated', { region })
+  }
+
+  private moveRegion(region: Region, delta: number) {
+    this.updateRegion(region, region.start + delta, region.end + delta)
+  }
+
+  /** Create a region at a given start and end time, with an optional title */
+  public addRegionAtTime(startTime: number, endTime: number, title = '') {
+    const duration = this.wavesurfer.getDuration()
+    const width = this.container.clientWidth
+    const start = (startTime / duration) * width
+    const end = (endTime / duration) * width
+    const region = this.createRegion(start, end, title)
+    this.addRegion(region)
+    return region
+  }
+
+  /** Set the background color of a region */
+  public setRegionColor(region: Region, color: string) {
+    region.element.style.backgroundColor = color
+  }
+}
+
+export default RegionsPlugin

package/src/renderer.ts

@@ -0,0 +1,250 @@
+import EventEmitter from './event-emitter.js'
+
+type RendererOptions = {
+  container: HTMLElement | string | null
+  height: number
+  waveColor: string
+  progressColor: string
+  minPxPerSec: number
+  barWidth?: number
+  barGap?: number
+  barRadius?: number
+}
+
+type RendererEvents = {
+  click: { relativeX: number }
+}
+
+class Renderer extends EventEmitter<RendererEvents> {
+  private options: RendererOptions
+  private container: HTMLElement
+  private shadowRoot: ShadowRoot
+  private mainCanvas: HTMLCanvasElement
+  private progressCanvas: HTMLCanvasElement
+  private cursor: HTMLElement
+  private ctx: CanvasRenderingContext2D
+
+  constructor(options: RendererOptions) {
+    super()
+
+    this.options = options
+
+    let container: HTMLElement | null = null
+    if (typeof this.options.container === 'string') {
+      container = document.querySelector(this.options.container)
+    } else if (this.options.container instanceof HTMLElement) {
+      container = this.options.container
+    }
+    if (!container) {
+      throw new Error('Container not found')
+    }
+
+    const div = document.createElement('div')
+    const shadow = div.attachShadow({ mode: 'open' })
+
+    shadow.innerHTML = `
+      <style>
+        :host .scroll {
+          overflow-x: auto;
+          overflow-y: visible;
+          user-select: none;
+          width: 100%;
+          height: ${this.options.height}px;
+          position: relative;
+        }
+        :host .wrapper {
+          position: relative;
+          width: fit-content;
+          min-width: 100%;
+          height: 100%;
+          z-index: 2;
+        }
+        :host canvas {
+          display: block;
+          height: 100%;
+          min-width: 100%;
+          image-rendering: pixelated;
+        }
+        :host .progress {
+          position: absolute;
+          z-index: 2;
+          top: 0;
+          left: 0;
+          height: 100%;
+          pointer-events: none;
+          clip-path: inset(100%);
+        }
+        :host .cursor {
+          position: absolute;
+          z-index: 3;
+          top: 0;
+          left: 0;
+          height: 100%;
+          border-right: 1px solid ${this.options.progressColor};
+        }
+      </style>
+
+      <div class="scroll">
+        <div class="wrapper">
+          <canvas></canvas>
+          <canvas class="progress"></canvas>
+          <div class="cursor"></div>
+        </div>
+      </div>
+    `
+
+    this.container = div
+    this.shadowRoot = shadow
+    this.mainCanvas = shadow.querySelector('canvas') as HTMLCanvasElement
+    this.ctx = this.mainCanvas.getContext('2d', { desynchronized: true }) as CanvasRenderingContext2D
+    this.progressCanvas = shadow.querySelector('.progress') as HTMLCanvasElement
+    this.cursor = shadow.querySelector('.cursor') as HTMLElement
+    container.appendChild(div)
+
+    this.mainCanvas.addEventListener('click', (e) => {
+      const rect = this.mainCanvas.getBoundingClientRect()
+      const x = e.clientX - rect.left
+      const relativeX = x / rect.width
+      this.emit('click', { relativeX })
+    })
+  }
+
+  destroy() {
+    this.container.remove()
+  }
+
+  private renderLinePeaks(channelData: Float32Array[], width: number, height: number) {
+    const { ctx } = this
+    ctx.clearRect(0, 0, width, height)
+    ctx.beginPath()
+    ctx.moveTo(0, height / 2)
+
+    // Channel 0 is left, 1 is right
+    const leftChannel = channelData[0]
+    const isMono = channelData.length === 1
+    const rightChannel = isMono ? leftChannel : channelData[1]
+
+    // Draw left channel in the top half of the canvas
+    let prevX = -1
+    let prevY = 0
+    for (let i = 0, len = leftChannel.length; i < len; i++) {
+      const x = Math.round((i / leftChannel.length) * width)
+      const y = Math.round(((1 - leftChannel[i]) * height) / 2)
+      if (x !== prevX || y > prevY) {
+        ctx.lineTo(x, y)
+        prevX = x
+        prevY = y
+      }
+    }
+
+    // Draw right channel in the bottom half of the canvas
+    prevX = -1
+    prevY = 0
+    for (let i = rightChannel.length - 1; i >= 0; i--) {
+      const x = Math.round((i / rightChannel.length) * width)
+      const y = Math.round(((1 + rightChannel[i]) * height) / 2)
+      if (x !== prevX || (isMono ? y < -prevY : y > prevY)) {
+        ctx.lineTo(x, y)
+        prevX = x
+        prevY = y
+      }
+    }
+
+    ctx.strokeStyle = ctx.fillStyle = this.options.waveColor
+    ctx.stroke()
+    ctx.fill()
+  }
+
+  private renderBarPeaks(channelData: Float32Array[], width: number, height: number) {
+    const { devicePixelRatio } = window
+    const { ctx } = this
+    ctx.clearRect(0, 0, width, height)
+
+    const barWidthOption = this.options.barWidth || 1
+    const barWidth = barWidthOption * devicePixelRatio
+    const barGap = (this.options.barGap ?? barWidthOption / 2) * devicePixelRatio
+    const barRadius = this.options.barRadius ?? 0
+
+    const leftChannel = channelData[0]
+    const isMono = channelData.length === 1
+    const rightChannel = isMono ? leftChannel : channelData[1]
+
+    const barCount = Math.floor(width / (barWidth + barGap))
+
+    const leftChannelBars = new Float32Array(barCount)
+    const rightChannelBars = new Float32Array(barCount)
+
+    const barIndexScale = barCount / leftChannel.length
+    const leftChannelLength = leftChannel.length
+    for (let i = 0; i < leftChannelLength; i++) {
+      const barIndex = Math.round(i * barIndexScale)
+      leftChannelBars[barIndex] = Math.max(leftChannelBars[barIndex], leftChannel[i])
+      rightChannelBars[barIndex] = (isMono ? Math.min : Math.max)(rightChannelBars[barIndex], rightChannel[i])
+    }
+
+    ctx.beginPath()
+
+    for (let i = 0; i < barCount; i++) {
+      const leftBarHeight = Math.max(1, Math.round((leftChannelBars[i] * height) / 2))
+      const rightBarHeight = Math.max(1, Math.round(Math.abs(rightChannelBars[i] * height) / 2))
+
+      ctx.roundRect(
+        i * (barWidth + barGap),
+        height / 2 - leftBarHeight,
+        barWidth,
+        leftBarHeight + rightBarHeight,
+        barRadius,
+      )
+    }
+
+    ctx.fillStyle = this.options.waveColor
+    ctx.fill()
+  }
+
+  render(channelData: Float32Array[], duration: number, minPxPerSec = this.options.minPxPerSec) {
+    const { devicePixelRatio } = window
+    const width = Math.max(this.container.clientWidth * devicePixelRatio, duration * minPxPerSec)
+    const { height } = this.options
+    this.mainCanvas.width = width
+    this.mainCanvas.height = height
+    this.mainCanvas.style.width = Math.round(width / devicePixelRatio) + 'px'
+
+    const renderingFn = this.options.barWidth ? this.renderBarPeaks : this.renderLinePeaks
+    renderingFn.call(this, channelData, width, height)
+    this.createProgressMask()
+  }
+
+  private createProgressMask() {
+    const progressCtx = this.progressCanvas.getContext('2d', { desynchronized: true })
+    if (!progressCtx) {
+      throw new Error('Failed to get canvas context')
+    }
+    this.progressCanvas.width = this.mainCanvas.width
+    this.progressCanvas.height = this.mainCanvas.height
+    this.progressCanvas.style.width = this.mainCanvas.style.width
+    this.progressCanvas.style.height = this.mainCanvas.style.height
+    progressCtx.drawImage(this.mainCanvas, 0, 0)
+    progressCtx.globalCompositeOperation = 'source-in'
+    progressCtx.fillStyle = this.options.progressColor
+    progressCtx.fillRect(0, 0, this.progressCanvas.width, this.progressCanvas.height)
+  }
+
+  renderProgress(progress: number, autoCenter = false) {
+    this.progressCanvas.style.clipPath = `inset(0 ${100 - progress * 100}% 0 0)`
+    this.cursor.style.left = `${progress * 100}%`
+
+    if (autoCenter) {
+      const center = this.container.clientWidth / 2
+      const fullWidth = this.mainCanvas.clientWidth
+      if (fullWidth * progress >= center) {
+        this.container.scrollLeft = fullWidth * progress - center
+      }
+    }
+  }
+
+  getContainer(): HTMLElement {
+    return this.shadowRoot.querySelector('.scroll') as HTMLElement
+  }
+}
+
+export default Renderer

package/src/timer.ts

@@ -0,0 +1,27 @@
+import EventEmitter from './event-emitter.js'
+
+type TimerEvents = {
+  tick: void
+}
+
+class Timer extends EventEmitter<TimerEvents> {
+  private unsubscribe: () => void = () => undefined
+
+  constructor() {
+    super()
+
+    this.unsubscribe = this.on('tick', () => {
+      requestAnimationFrame(() => {
+        this.emit('tick')
+      })
+    })
+
+    this.emit('tick')
+  }
+
+  destroy() {
+    this.unsubscribe()
+  }
+}
+
+export default Timer

package/tsconfig.json

@@ -0,0 +1,105 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Enable incremental compilation */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./",                          /* Specify the folder for .tsbuildinfo incremental compilation files. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    "lib": [ "es2019", "dom" ],
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
+    // "reactNamespace": "",                             /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+
+    /* Modules */
+    "module": "esnext",
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like `./node_modules/@types`. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files */
+    // "noResolve": true,                                /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */
+
+    /* Emit */
+    "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
+    "outDir": "./dist",                                  /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like `__extends` in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing `const enum` declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied `any` type.. */
+    // "strictNullChecks": true,                         /* When type checking, take into account `null` and `undefined`. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when `this` is given the type `any`. */
+    // "useUnknownInCatchVariables": true,               /* Type catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when a local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Include 'undefined' in index signature results */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  },
+  "exclude": [
+    "node_modules",
+    "dist"
+  ]
+}

package/tutorial/index.html

@@ -0,0 +1,47 @@
+<html>
+  <head>
+    <meta charset="utf-8" />
+
+    <title>wavesurfer.ts examples</title>
+
+    <link rel="stylesheet" href="style.css" />
+
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.32.0-dev.20211218/min/vs/loader.min.js" integrity="sha512-O9SYDgWAM3bEzit1z6mkFd+dxKUplO/oB8UwYGAkg2Zy/WzDUQ2mYA/ysk3c0CxiXAN4u8T9JeZ0Ahk2Jj/33Q==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
+  </head>
+
+  <body>
+    <div class="layout">
+      <header>
+        <h1>wavesurfer.ts examples</h1>
+
+        <a href="/docs">Documentation</a>
+      </header>
+
+      <div class="grid">
+        <div class="sidebar">
+          <ul>
+            <li><a href="/examples/basic.js">Basic</a></li>
+            <li><a href="/examples/regions.js">Regions</a></li>
+            <li><a href="/examples/video.js">Video</a></li>
+            <li><a href="/examples/bars.js">Bars</a></li>
+            <li><a href="/examples/gradient.js">Gradient</a></li>
+            <li><a href="/examples/webaudio.js">Web Audio</a></li>
+          </ul>
+        </div>
+
+        <div id="editor"></div>
+
+        <div class="preview">
+          <iframe id="preview" sandbox="allow-scripts allow-same-origin"></iframe>
+        </div>
+      </div>
+
+      <footer>
+        <a class="github" href="https://github.com/katspaugh/wavesurfer.ts">katspaugh/wavesurfer.ts</a>
+        This app was built using the <a href="https://microsoft.github.io/monaco-editor/">Monaco editor</a>
+      </footer>
+    </div>
+
+    <script type="module" src="src/init.js"></script>
+  </body>
+</html>