wavesurfer.js 7.0.0-alpha.46 → 7.0.0-alpha.48

package/README.md

@@ -22,7 +22,7 @@ Or, as a script tag which exposes `WaveSurfer` as a global variable:
 
 To import a plugin, e.g. the Timeline plugin:
 ```
-import Timeline from 'https://unpkg.com/wavesurfer.js@alpha/plugins/timeline.js'
+import Timeline from 'https://unpkg.com/wavesurfer.js@alpha/dist/plugins/timeline.js'
 ```
 
 TypeScript types are included in the package, so there's no need to install `@types/wavesurfer.js`.
@@ -38,12 +38,33 @@ wavesurfer.js v7 (aka wavesurfer.ts) brings several improvements:
 ## Plugins
 The "official" plugins have been completely rewritten and enhanced:
 
- * [Regions](https://wavesurfer-ts.pages.dev/tutorial/#/examples/regions.js) – now also replaces the old Markers plugin
- * [Timeline](https://wavesurfer-ts.pages.dev/tutorial/#/examples/timeline.js) – displays notches and time labels below the waveform
- * [Minimap](https://wavesurfer-ts.pages.dev/tutorial/#/examples/minimap.js) – a small waveform that serves as a scrollbar for the main waveform
- * [Envelope](https://wavesurfer-ts.pages.dev/tutorial/#/examples/envelope.js) – a graphical interface to add fade-in and -out effects and control volume
- * [Record](https://wavesurfer-ts.pages.dev/tutorial/#/examples/record.js) – records audio from the microphone and renders a waveform
- * [Spectrogram](https://wavesurfer-ts.pages.dev/tutorial/#/examples/spectrogram.js) – visualization of an audio frequency spectrum
+ * [Regions](https://wavesurfer.pages.dev/examples/#regions.js) – now also replaces the old Markers plugin
+ * [Timeline](https://wavesurfer.pages.dev/examples/#timeline.js) – displays notches and time labels below the waveform
+ * [Minimap](https://wavesurfer.pages.dev/examples/#minimap.js) – a small waveform that serves as a scrollbar for the main waveform
+ * [Envelope](https://wavesurfer.pages.dev/examples/#envelope.js) – a graphical interface to add fade-in and -out effects and control volume
+ * [Record](https://wavesurfer.pages.dev/examples/#record.js) – records audio from the microphone and renders a waveform
+ * [Spectrogram](https://wavesurfer.pages.dev/examples/#spectrogram.js) – visualization of an audio frequency spectrum
+
+## CSS styling
+
+wavesurfer.js v7 is rendered into a Shadow DOM tree. This isolates its CSS from the rest of the web page.
+However, it's still possible to style various wavesurfer.js elements via CSS using the `::part()` pseudo-selector.
+For example:
+
+```css
+#waveform ::part(cursor):before {
+  content: '🏄';
+}
+#waveform ::part(region) {
+  font-family: fantasy;
+}
+```
+
+You can see which elements you can style in the DOM inspector – they will have a `part` attribute.
+
+<img width="466" alt="DOM inspector screenshot" src="https://github.com/katspaugh/wavesurfer.ts/assets/381895/fcfb4e4d-9572-4931-811f-9615b7e3aa85">
+
+See [this example](https://wavesurfer.pages.dev/examples/#styling.js) for play around with styling.
 
 ## Documentation
 See the documentation on wavesurfer.js [methods](https://wavesurfer-ts.pages.dev/docs/classes/wavesurfer.WaveSurfer), [options](https://wavesurfer-ts.pages.dev/docs/types/wavesurfer.WaveSurferOptions) and [events](https://wavesurfer-ts.pages.dev/docs/types/wavesurfer.WaveSurferEvents) on our website.
@@ -53,7 +74,7 @@ See the documentation on wavesurfer.js [methods](https://wavesurfer-ts.pages.dev
 Most options, events, and methods are similar to those in previous versions.
 
 ### Notable differences
- * The `backend` option is removed – HTML5 audio (or video) is the only playback mechanism. However, you can still connect wavesurfer to Web Audio via `MediaElementSourceNode`. See this [example](https://wavesurfer-ts.pages.dev/tutorial/#/examples/webaudio.js).
+ * The `backend` option is removed – HTML5 audio (or video) is the only playback mechanism. However, you can still connect wavesurfer to Web Audio via `MediaElementSourceNode`. See this [example](https://wavesurfer.pages.dev/examples/#webaudio.js).
  * The Markers plugin is removed – use the Regions plugin with `startTime` equal to `endTime`.
  * No Microphone plugn – superseded by the new Record plugin with more features.
  * No Cursor and Playhead plugins yet – to be done.
@@ -68,7 +89,7 @@ Most options, events, and methods are similar to those in previous versions.
  * `toggleMute` is now called `setMuted(true | false)`
  * `setHeight`, `setWaveColor`, `setCursorColor`, etc. – use `setOptions` with the corresponding params instead. E.g., `wavesurfer.setOptions({ height: 300, waveColor: '#abc' })`
 
-See the complete [documentation of the new API](https://wavesurfer-ts.pages.dev/docs/classes/wavesurfer.WaveSurfer).
+See the complete [documentation of the new API](https://wavesurfer-ts.pages.dev/docs/modules/wavesurfer).
 
 ## Development
 

package/dist/decoder.d.ts

@@ -1,5 +1,5 @@
 /** Decode an array buffer into an audio buffer */
-declare function decode(audioData: ArrayBuffer, sampleRate?: number): Promise<AudioBuffer>;
+declare function decode(audioData: ArrayBuffer, sampleRate: number): Promise<AudioBuffer>;
 /** Create an audio buffer from pre-decoded audio data */
 declare function createBuffer(channelData: Float32Array[] | Array<number[]>, duration: number): AudioBuffer;
 declare const Decoder: {

package/dist/decoder.js

@@ -1,5 +1,5 @@
 /** Decode an array buffer into an audio buffer */
-async function decode(audioData, sampleRate = 8000) {
+async function decode(audioData, sampleRate) {
     const audioCtx = new AudioContext({ sampleRate });
     const decode = audioCtx.decodeAudioData(audioData);
     decode.finally(() => audioCtx.close());

package/dist/fetcher.d.ts

@@ -1,4 +1,5 @@
-declare class Fetcher {
-    load(url: string): Promise<ArrayBuffer>;
-}
+declare function load(url: string): Promise<ArrayBuffer>;
+declare const Fetcher: {
+    load: typeof load;
+};
 export default Fetcher;

package/dist/fetcher.js

@@ -1,6 +1,7 @@
-class Fetcher {
-    async load(url) {
-        return fetch(url).then((response) => response.arrayBuffer());
-    }
+async function load(url) {
+    return fetch(url).then((response) => response.arrayBuffer());
 }
+const Fetcher = {
+    load,
+};
 export default Fetcher;

package/dist/plugins/envelope.d.ts

@@ -25,14 +25,15 @@ declare const defaultOptions: {
     dragPointFill: string;
     dragPointStroke: string;
 };
+type Options = EnvelopePluginOptions & typeof defaultOptions;
 export type EnvelopePluginEvents = {
     'fade-in-change': [time: number];
     'fade-out-change': [time: number];
     'volume-change': [volume: number];
 };
 declare class EnvelopePlugin extends BasePlugin<EnvelopePluginEvents, EnvelopePluginOptions> {
-    protected options: EnvelopePluginOptions & typeof defaultOptions;
-    private svg;
+    protected options: Options;
+    private polyline;
     private audioContext;
     private gainNode;
     private volume;
@@ -41,24 +42,29 @@ declare class EnvelopePlugin extends BasePlugin<EnvelopePluginEvents, EnvelopePl
     private readonly naturalVolumeExponent;
     constructor(options: EnvelopePluginOptions);
     static create(options: EnvelopePluginOptions): EnvelopePlugin;
+    destroy(): void;
     /** Called by wavesurfer, don't call manually */
     onInit(): void;
-    private makeDraggable;
-    private renderPolyline;
     private initSvg;
-    destroy(): void;
+    private renderPolyline;
     private initWebAudio;
     private invertNaturalVolume;
     private naturalVolume;
     private setGainValue;
-    private onVolumeDrag;
     private initFadeEffects;
     /** Get the current audio volume */
     getCurrentVolume(): number;
-    /** Set the fade-in start time */
-    setStartTime(time: number, moveDragPoint?: boolean): void;
-    /** Set the fade-out end time */
-    setEndTime(time: number, moveDragPoint?: boolean): void;
+    /**
+     * Set the fade-in start time.
+     * @param time The time (in seconds) to set the fade-in start time to
+     * @param moveFadeInEnd Whether to move the drag point to the new time (default: false)
+     */
+    setStartTime(time: number, moveFadeInEnd?: boolean): void;
+    /** Set the fade-in end time.
+     * @param time The time (in seconds) to set the fade-in end time to
+     * @param moveFadeOutStart Whether to move the drag point to the new time (default: false)
+     */
+    setEndTime(time: number, moveFadeOutStart?: boolean): void;
     /** Set the volume of the audio */
     setVolume(volume: number): void;
 }

package/dist/plugins/envelope.js

@@ -2,6 +2,7 @@
  * Envelope is a visual UI for controlling the audio volume and add fade-in and fade-out effects.
  */
 import BasePlugin from '../base-plugin.js';
+import EventEmitter from '../event-emitter.js';
 const defaultOptions = {
     fadeInStart: 0,
     fadeOutEnd: 0,
@@ -13,58 +14,85 @@ const defaultOptions = {
     dragPointFill: 'rgba(255, 255, 255, 0.8)',
     dragPointStroke: 'rgba(255, 255, 255, 0.8)',
 };
-class EnvelopePlugin extends BasePlugin {
-    constructor(options) {
-        super(options);
-        this.svg = null;
-        this.audioContext = null;
-        this.gainNode = null;
-        this.volume = 1;
-        this.isFadingIn = false;
-        this.isFadingOut = false;
-        // Adjust the exponent to change the curve of the volume control
-        this.naturalVolumeExponent = 1.5;
-        this.options = Object.assign({}, defaultOptions, options);
-        this.options.lineColor = this.options.lineColor || defaultOptions.lineColor;
-        this.options.dragPointFill = this.options.dragPointFill || defaultOptions.dragPointFill;
-        this.options.dragPointStroke = this.options.dragPointStroke || defaultOptions.dragPointStroke;
-        this.volume = this.options.volume ?? 1;
-    }
-    static create(options) {
-        return new EnvelopePlugin(options);
-    }
-    /** Called by wavesurfer, don't call manually */
-    onInit() {
-        if (!this.wavesurfer) {
-            throw Error('WaveSurfer is not initialized');
+class Polyline extends EventEmitter {
+    constructor(options, wrapper) {
+        super();
+        this.top = 0;
+        // An padding to make the envelope fit into the SVG
+        this.padding = options.dragPointSize / 2 + 1;
+        // SVG element
+        const svg = document.createElementNS('http://www.w3.org/2000/svg', 'svg');
+        svg.setAttribute('width', '100%');
+        svg.setAttribute('height', '100%');
+        svg.setAttribute('viewBox', `0 0 ${wrapper.clientWidth} ${wrapper.clientHeight}`);
+        svg.setAttribute('preserveAspectRatio', 'none');
+        svg.setAttribute('style', 'position: absolute; left: 0; top: 0; z-index: 4; pointer-events: none;');
+        svg.setAttribute('part', 'envelope');
+        this.svg = svg;
+        // A polyline representing the envelope
+        const polyline = document.createElementNS('http://www.w3.org/2000/svg', 'polyline');
+        polyline.setAttribute('points', '0,0 0,0 0,0 0,0');
+        polyline.setAttribute('stroke', options.lineColor);
+        polyline.setAttribute('stroke-width', options.lineWidth);
+        polyline.setAttribute('fill', 'none');
+        polyline.setAttribute('style', 'pointer-events: none;');
+        polyline.setAttribute('part', 'polyline');
+        svg.appendChild(polyline);
+        // Draggable top line
+        const line = document.createElementNS('http://www.w3.org/2000/svg', 'line');
+        line.setAttribute('stroke', 'transparent');
+        line.setAttribute('stroke-width', (options.lineWidth * 3).toString());
+        line.setAttribute('style', 'cursor: ns-resize; pointer-events: all;');
+        line.setAttribute('part', 'line');
+        svg.appendChild(line);
+        [0, 1].forEach(() => {
+            const circle = document.createElementNS('http://www.w3.org/2000/svg', 'circle');
+            circle.setAttribute('r', (options.dragPointSize / 2).toString());
+            circle.setAttribute('fill', options.dragPointFill);
+            circle.setAttribute('stroke', options.dragPointStroke || options.dragPointFill);
+            circle.setAttribute('stroke-width', '2');
+            circle.setAttribute('style', 'cursor: ew-resize; pointer-events: all;');
+            circle.setAttribute('part', 'circle');
+            svg.appendChild(circle);
+        });
+        wrapper.appendChild(svg);
+        // Init dtagging
+        {
+            // On top line drag
+            const onDragY = (dy) => {
+                const newTop = this.top + dy;
+                const { height } = svg.viewBox.baseVal;
+                if (newTop < -0.5 || newTop > height)
+                    return;
+                const relativeY = Math.min(1, Math.max(0, (height - newTop) / height));
+                this.emit('line-move', relativeY);
+            };
+            // On points drag
+            const onDragX = (index, dx) => {
+                const point = polyline.points.getItem(index);
+                const newX = point.x + dx;
+                const { width } = svg.viewBox.baseVal;
+                this.emit('point-move', index, newX / width);
+            };
+            // Draggable top line of the polyline
+            this.makeDraggable(line, (_, dy) => onDragY(dy));
+            // Make each point draggable
+            const draggables = this.svg.querySelectorAll('circle');
+            Array.from(draggables).forEach((draggable, index) => {
+                this.makeDraggable(draggable, (dx) => onDragX(index + 1, dx));
+            });
         }
-        this.subscriptions.push(this.wavesurfer.once('decode', (duration) => {
-            this.options.fadeInStart = this.options.fadeInStart || 0;
-            this.options.fadeOutEnd = this.options.fadeOutEnd || duration;
-            this.options.fadeInEnd = this.options.fadeInEnd || this.options.fadeInStart;
-            this.options.fadeOutStart = this.options.fadeOutStart || this.options.fadeOutEnd;
-            this.initWebAudio();
-            this.initSvg();
-            this.initFadeEffects();
-        }));
-        let delay;
-        this.subscriptions.push(this.wavesurfer.on('zoom', () => {
-            if (delay)
-                clearTimeout(delay);
-            delay = setTimeout(() => {
-                this.svg?.remove();
-                this.initSvg();
-            }, 100);
-        }));
     }
     makeDraggable(draggable, onDrag) {
+        draggable.addEventListener('click', (e) => {
+            e.preventDefault();
+            e.stopPropagation();
+        });
         draggable.addEventListener('mousedown', (e) => {
+            e.preventDefault();
+            e.stopPropagation();
             let x = e.clientX;
             let y = e.clientY;
-            const wasInteractive = this.wavesurfer?.options.interact || true;
-            let delay;
-            // Make the wavesurfer ignore clicks when we're dragging
-            this.wavesurfer?.toggleInteraction(false);
             const move = (e) => {
                 const dx = e.clientX - x;
                 const dy = e.clientY - y;
@@ -75,145 +103,124 @@ class EnvelopePlugin extends BasePlugin {
             const up = () => {
                 document.removeEventListener('mousemove', move);
                 document.removeEventListener('mouseup', up);
-                // Restore interactive state
-                if (delay)
-                    clearTimeout(delay);
-                delay = setTimeout(() => {
-                    this.wavesurfer?.toggleInteraction(wasInteractive);
-                }, 100);
             };
             document.addEventListener('mousemove', move);
             document.addEventListener('mouseup', up);
-            e.preventDefault();
-            e.stopPropagation();
         });
     }
-    renderPolyline() {
-        if (!this.svg || !this.wavesurfer)
-            return;
-        const polyline = this.svg.querySelector('polyline');
-        const points = polyline.points;
+    update({ x1, x2, x3, x4, y }) {
         const width = this.svg.clientWidth;
         const height = this.svg.clientHeight;
-        const duration = this.wavesurfer.getDuration();
-        const offset = this.options.dragPointSize / 2;
-        const top = height - this.invertNaturalVolume(this.volume) * height + offset;
+        this.top = height - y * height;
+        const top = Math.max(this.padding, Math.min(this.top, height - this.padding));
+        this.svg.setAttribute('viewBox', `0 0 ${width} ${height}`);
+        const polyline = this.svg.querySelector('polyline');
+        const { points } = polyline;
+        points.getItem(0).x = x1 * width;
+        points.getItem(0).y = height;
+        points.getItem(1).x = x2 * width;
         points.getItem(1).y = top;
+        points.getItem(2).x = x3 * width;
         points.getItem(2).y = top;
-        points.getItem(0).x = (this.options.fadeInStart / duration) * width;
-        points.getItem(3).x = (this.options.fadeOutEnd / duration) * width;
+        points.getItem(3).x = x4 * width;
+        points.getItem(3).y = height;
         const line = this.svg.querySelector('line');
         line.setAttribute('x1', points.getItem(1).x.toString());
         line.setAttribute('x2', points.getItem(2).x.toString());
         line.setAttribute('y1', top.toString());
         line.setAttribute('y2', top.toString());
         const circles = this.svg.querySelectorAll('circle');
-        for (let i = 0; i < circles.length; i++) {
-            const circle = circles[i];
-            const point = polyline.points.getItem(i + 1);
+        Array.from(circles).forEach((circle, i) => {
+            const point = points.getItem(i + 1);
             circle.setAttribute('cx', point.x.toString());
-            circle.setAttribute('cy', top.toString());
+            circle.setAttribute('cy', point.y.toString());
+        });
+    }
+    destroy() {
+        this.svg.remove();
+    }
+}
+class EnvelopePlugin extends BasePlugin {
+    constructor(options) {
+        super(options);
+        this.polyline = null;
+        this.audioContext = null;
+        this.gainNode = null;
+        this.volume = 1;
+        this.isFadingIn = false;
+        this.isFadingOut = false;
+        // Adjust the exponent to change the curve of the volume control
+        this.naturalVolumeExponent = 1.5;
+        this.options = Object.assign({}, defaultOptions, options);
+        this.options.lineColor = this.options.lineColor || defaultOptions.lineColor;
+        this.options.dragPointFill = this.options.dragPointFill || defaultOptions.dragPointFill;
+        this.options.dragPointStroke = this.options.dragPointStroke || defaultOptions.dragPointStroke;
+        this.volume = this.options.volume ?? 1;
+    }
+    static create(options) {
+        return new EnvelopePlugin(options);
+    }
+    destroy() {
+        this.polyline?.destroy();
+        super.destroy();
+    }
+    /** Called by wavesurfer, don't call manually */
+    onInit() {
+        if (!this.wavesurfer) {
+            throw Error('WaveSurfer is not initialized');
         }
+        this.initWebAudio();
+        this.initSvg();
+        this.initFadeEffects();
+        this.subscriptions.push(this.wavesurfer.on('decode', (duration) => {
+            this.options.fadeInStart = this.options.fadeInStart || 0;
+            this.options.fadeOutEnd = this.options.fadeOutEnd || duration;
+            this.options.fadeInEnd = this.options.fadeInEnd || this.options.fadeInStart;
+            this.options.fadeOutStart = this.options.fadeOutStart || this.options.fadeOutEnd;
+            this.renderPolyline();
+        }));
+        this.subscriptions.push(this.wavesurfer.on('redraw', () => this.renderPolyline()));
     }
     initSvg() {
         if (!this.wavesurfer)
             return;
         const wrapper = this.wavesurfer.getWrapper();
-        const width = wrapper.clientWidth;
-        const height = wrapper.clientHeight;
-        const duration = this.wavesurfer.getDuration();
-        // SVG element
-        const svg = document.createElementNS('http://www.w3.org/2000/svg', 'svg');
-        svg.setAttribute('width', '100%');
-        svg.setAttribute('height', '100%');
-        svg.setAttribute('viewBox', `0 0 ${width} ${height}`);
-        svg.setAttribute('preserveAspectRatio', 'none');
-        svg.setAttribute('style', 'position: absolute; left: 0; top: 0; z-index: 4; pointer-events: none;');
-        this.svg = svg;
-        // A polyline representing the envelope
-        const polyline = document.createElementNS('http://www.w3.org/2000/svg', 'polyline');
-        polyline.setAttribute('points', '0,0 0,0 0,0 0,0');
-        polyline.setAttribute('stroke', this.options.lineColor);
-        polyline.setAttribute('stroke-width', this.options.lineWidth);
-        polyline.setAttribute('fill', 'none');
-        polyline.setAttribute('style', 'pointer-events: none');
-        svg.appendChild(polyline);
-        // Draggable top line
-        const line = document.createElementNS('http://www.w3.org/2000/svg', 'line');
-        line.setAttribute('stroke', 'none');
-        line.setAttribute('stroke-width', (this.options.lineWidth * 3).toString());
-        line.setAttribute('style', 'cursor: ns-resize; pointer-events: all;');
-        svg.appendChild(line);
-        const points = polyline.points;
-        const offset = this.options.dragPointSize / 2;
-        points.getItem(0).x = (this.options.fadeInStart / duration) * width;
-        points.getItem(0).y = height;
-        points.getItem(1).x = (this.options.fadeInEnd / duration) * width;
-        points.getItem(1).y = 0;
-        points.getItem(2).x = (this.options.fadeOutStart / duration) * width;
-        points.getItem(2).y = 0;
-        points.getItem(3).x = (this.options.fadeOutEnd / duration) * width;
-        points.getItem(3).y = height;
-        // Drag points
-        const dragPoints = [1, 2];
-        dragPoints.forEach(() => {
-            const circle = document.createElementNS('http://www.w3.org/2000/svg', 'circle');
-            circle.setAttribute('r', (this.options.dragPointSize / 2).toString());
-            circle.setAttribute('fill', this.options.dragPointFill);
-            circle.setAttribute('stroke', this.options.dragPointStroke || this.options.dragPointFill);
-            circle.setAttribute('stroke-width', '2');
-            circle.setAttribute('style', 'cursor: ew-resize; pointer-events: all;');
-            svg.appendChild(circle);
-        });
-        this.wavesurfer.getWrapper().appendChild(svg);
-        // Initial polyline
-        this.renderPolyline();
-        // On top line drag
-        const onDragY = (dy) => {
-            const newTop = points.getItem(1).y + dy - offset;
-            if (newTop < -0.5 || newTop > height)
-                return;
-            const newVolume = Math.min(1, Math.max(0, (height - newTop) / height));
-            this.onVolumeDrag(newVolume);
-        };
-        // On points drag
-        const onDragX = (dx, dy, index) => {
-            const point = polyline.points.getItem(index);
-            const newX = point.x + dx;
-            const newTime = (newX / width) * duration;
-            if ((index === 1 && newTime > this.options.fadeOutStart) || newTime < this.options.fadeInStart)
-                return;
-            if ((index === 2 && newTime < this.options.fadeInEnd) || newTime > this.options.fadeOutEnd)
-                return;
-            point.x = newX;
+        this.polyline = new Polyline(this.options, wrapper);
+        this.subscriptions.push(this.polyline.on('line-move', (relativeY) => {
+            this.setVolume(this.naturalVolume(relativeY));
+        }), this.polyline.on('point-move', (index, relativeX) => {
+            const duration = this.wavesurfer?.getDuration() || 0;
+            const newTime = relativeX * duration;
+            // Fade-in end point
             if (index === 1) {
+                if (newTime < this.options.fadeInStart || newTime > this.options.fadeOutStart)
+                    return;
                 this.options.fadeInEnd = newTime;
                 this.emit('fade-in-change', newTime);
             }
             else if (index === 2) {
+                // Fade-out start point
+                if (newTime > this.options.fadeOutEnd || newTime < this.options.fadeInEnd)
+                    return;
                 this.options.fadeOutStart = newTime;
                 this.emit('fade-out-change', newTime);
             }
-            // Also allow dragging points vertically
-            if (dy > 1 || dy < -1) {
-                onDragY(dy);
-            }
-            else {
-                this.renderPolyline();
-            }
-        };
-        // Draggable top line of the polyline
-        this.makeDraggable(line, (_, dy) => onDragY(dy));
-        // Make each point draggable
-        const draggables = svg.querySelectorAll('circle');
-        for (let i = 0; i < draggables.length; i++) {
-            const index = i + 1;
-            this.makeDraggable(draggables[i], (dx, dy) => onDragX(dx, dy, index));
-        }
+            this.renderPolyline();
+        }));
     }
-    destroy() {
-        this.svg?.remove();
-        super.destroy();
+    renderPolyline() {
+        if (!this.polyline || !this.wavesurfer)
+            return;
+        const duration = this.wavesurfer.getDuration();
+        if (!duration)
+            return;
+        this.polyline.update({
+            x1: this.options.fadeInStart / duration,
+            x2: this.options.fadeInEnd / duration,
+            x3: this.options.fadeOutStart / duration,
+            x4: this.options.fadeOutEnd / duration,
+            y: this.invertNaturalVolume(this.volume),
+        });
     }
     initWebAudio() {
         const audio = this.wavesurfer?.getMediaElement();
@@ -249,9 +256,6 @@ class EnvelopePlugin extends BasePlugin {
             this.gainNode.gain.value = this.volume;
         }
     }
-    onVolumeDrag(volume) {
-        this.setVolume(this.naturalVolume(volume));
-    }
     initFadeEffects() {
         if (!this.audioContext || !this.wavesurfer)
             return;
@@ -305,22 +309,29 @@ class EnvelopePlugin extends BasePlugin {
     getCurrentVolume() {
         return this.gainNode ? this.gainNode.gain.value : this.volume;
     }
-    /** Set the fade-in start time */
-    setStartTime(time, moveDragPoint) {
-        const rampLength = this.options.fadeInEnd - this.options.fadeInStart;
-        this.options.fadeInStart = time;
-        if (moveDragPoint) {
+    /**
+     * Set the fade-in start time.
+     * @param time The time (in seconds) to set the fade-in start time to
+     * @param moveFadeInEnd Whether to move the drag point to the new time (default: false)
+     */
+    setStartTime(time, moveFadeInEnd = false) {
+        if (moveFadeInEnd) {
+            const rampLength = this.options.fadeInEnd - this.options.fadeInStart;
             this.options.fadeInEnd = time + rampLength;
         }
+        this.options.fadeInStart = time;
         this.renderPolyline();
     }
-    /** Set the fade-out end time */
-    setEndTime(time, moveDragPoint) {
-        const rampLength = this.options.fadeOutEnd - this.options.fadeOutStart;
-        this.options.fadeOutEnd = time;
-        if (moveDragPoint) {
+    /** Set the fade-in end time.
+     * @param time The time (in seconds) to set the fade-in end time to
+     * @param moveFadeOutStart Whether to move the drag point to the new time (default: false)
+     */
+    setEndTime(time, moveFadeOutStart = false) {
+        if (moveFadeOutStart) {
+            const rampLength = this.options.fadeOutEnd - this.options.fadeOutStart;
             this.options.fadeOutStart = time - rampLength;
         }
+        this.options.fadeOutEnd = time;
         this.renderPolyline();
     }
     /** Set the volume of the audio */

package/dist/plugins/envelope.min.js

@@ -1 +1 @@
-!function(t,e){"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports.Envelope=e():t.Envelope=e()}(WaveSurfer,(()=>(()=>{"use strict";var t={284:(t,e,i)=>{i.d(e,{Z:()=>o});var s=i(139);class n extends s.Z{constructor(t){super(),this.subscriptions=[],this.options=t}onInit(){}init(t){this.wavesurfer=t,this.onInit()}destroy(){this.subscriptions.forEach((t=>t()))}}const o=n},139:(t,e,i)=>{i.d(e,{Z:()=>s});const s=class{constructor(){this.listeners={}}on(t,e){return this.listeners[t]||(this.listeners[t]=new Set),this.listeners[t].add(e),()=>this.un(t,e)}once(t,e){const i=this.on(t,e),s=this.on(t,(()=>{i(),s()}));return i}un(t,e){this.listeners[t]&&(e?this.listeners[t].delete(e):delete this.listeners[t])}unAll(){this.listeners={}}emit(t,...e){this.listeners[t]&&this.listeners[t].forEach((t=>t(...e)))}}}},e={};function i(s){var n=e[s];if(void 0!==n)return n.exports;var o=e[s]={exports:{}};return t[s](o,o.exports,i),o.exports}i.d=(t,e)=>{for(var s in e)i.o(e,s)&&!i.o(t,s)&&Object.defineProperty(t,s,{enumerable:!0,get:e[s]})},i.o=(t,e)=>Object.prototype.hasOwnProperty.call(t,e);var s={};return(()=>{i.d(s,{default:()=>o});var t=i(284);const e={fadeInStart:0,fadeOutEnd:0,fadeInEnd:0,fadeOutStart:0,lineWidth:4,lineColor:"rgba(0, 0, 255, 0.5)",dragPointSize:10,dragPointFill:"rgba(255, 255, 255, 0.8)",dragPointStroke:"rgba(255, 255, 255, 0.8)"};class n extends t.Z{constructor(t){super(t),this.svg=null,this.audioContext=null,this.gainNode=null,this.volume=1,this.isFadingIn=!1,this.isFadingOut=!1,this.naturalVolumeExponent=1.5,this.options=Object.assign({},e,t),this.options.lineColor=this.options.lineColor||e.lineColor,this.options.dragPointFill=this.options.dragPointFill||e.dragPointFill,this.options.dragPointStroke=this.options.dragPointStroke||e.dragPointStroke,this.volume=this.options.volume??1}static create(t){return new n(t)}onInit(){if(!this.wavesurfer)throw Error("WaveSurfer is not initialized");let t;this.subscriptions.push(this.wavesurfer.once("decode",(t=>{this.options.fadeInStart=this.options.fadeInStart||0,this.options.fadeOutEnd=this.options.fadeOutEnd||t,this.options.fadeInEnd=this.options.fadeInEnd||this.options.fadeInStart,this.options.fadeOutStart=this.options.fadeOutStart||this.options.fadeOutEnd,this.initWebAudio(),this.initSvg(),this.initFadeEffects()}))),this.subscriptions.push(this.wavesurfer.on("zoom",(()=>{t&&clearTimeout(t),t=setTimeout((()=>{this.svg?.remove(),this.initSvg()}),100)})))}makeDraggable(t,e){t.addEventListener("mousedown",(t=>{let i=t.clientX,s=t.clientY;const n=this.wavesurfer?.options.interact||!0;let o;this.wavesurfer?.toggleInteraction(!1);const r=t=>{const n=t.clientX-i,o=t.clientY-s;i=t.clientX,s=t.clientY,e(n,o)},a=()=>{document.removeEventListener("mousemove",r),document.removeEventListener("mouseup",a),o&&clearTimeout(o),o=setTimeout((()=>{this.wavesurfer?.toggleInteraction(n)}),100)};document.addEventListener("mousemove",r),document.addEventListener("mouseup",a),t.preventDefault(),t.stopPropagation()}))}renderPolyline(){if(!this.svg||!this.wavesurfer)return;const t=this.svg.querySelector("polyline"),e=t.points,i=this.svg.clientWidth,s=this.svg.clientHeight,n=this.wavesurfer.getDuration(),o=this.options.dragPointSize/2,r=s-this.invertNaturalVolume(this.volume)*s+o;e.getItem(1).y=r,e.getItem(2).y=r,e.getItem(0).x=this.options.fadeInStart/n*i,e.getItem(3).x=this.options.fadeOutEnd/n*i;const a=this.svg.querySelector("line");a.setAttribute("x1",e.getItem(1).x.toString()),a.setAttribute("x2",e.getItem(2).x.toString()),a.setAttribute("y1",r.toString()),a.setAttribute("y2",r.toString());const u=this.svg.querySelectorAll("circle");for(let e=0;e<u.length;e++){const i=u[e],s=t.points.getItem(e+1);i.setAttribute("cx",s.x.toString()),i.setAttribute("cy",r.toString())}}initSvg(){if(!this.wavesurfer)return;const t=this.wavesurfer.getWrapper(),e=t.clientWidth,i=t.clientHeight,s=this.wavesurfer.getDuration(),n=document.createElementNS("http://www.w3.org/2000/svg","svg");n.setAttribute("width","100%"),n.setAttribute("height","100%"),n.setAttribute("viewBox",`0 0 ${e} ${i}`),n.setAttribute("preserveAspectRatio","none"),n.setAttribute("style","position: absolute; left: 0; top: 0; z-index: 4; pointer-events: none;"),this.svg=n;const o=document.createElementNS("http://www.w3.org/2000/svg","polyline");o.setAttribute("points","0,0 0,0 0,0 0,0"),o.setAttribute("stroke",this.options.lineColor),o.setAttribute("stroke-width",this.options.lineWidth),o.setAttribute("fill","none"),o.setAttribute("style","pointer-events: none"),n.appendChild(o);const r=document.createElementNS("http://www.w3.org/2000/svg","line");r.setAttribute("stroke","none"),r.setAttribute("stroke-width",(3*this.options.lineWidth).toString()),r.setAttribute("style","cursor: ns-resize; pointer-events: all;"),n.appendChild(r);const a=o.points,u=this.options.dragPointSize/2;a.getItem(0).x=this.options.fadeInStart/s*e,a.getItem(0).y=i,a.getItem(1).x=this.options.fadeInEnd/s*e,a.getItem(1).y=0,a.getItem(2).x=this.options.fadeOutStart/s*e,a.getItem(2).y=0,a.getItem(3).x=this.options.fadeOutEnd/s*e,a.getItem(3).y=i,[1,2].forEach((()=>{const t=document.createElementNS("http://www.w3.org/2000/svg","circle");t.setAttribute("r",(this.options.dragPointSize/2).toString()),t.setAttribute("fill",this.options.dragPointFill),t.setAttribute("stroke",this.options.dragPointStroke||this.options.dragPointFill),t.setAttribute("stroke-width","2"),t.setAttribute("style","cursor: ew-resize; pointer-events: all;"),n.appendChild(t)})),this.wavesurfer.getWrapper().appendChild(n),this.renderPolyline();const h=t=>{const e=a.getItem(1).y+t-u;if(e<-.5||e>i)return;const s=Math.min(1,Math.max(0,(i-e)/i));this.onVolumeDrag(s)},d=(t,i,n)=>{const r=o.points.getItem(n),a=r.x+t,u=a/e*s;1===n&&u>this.options.fadeOutStart||u<this.options.fadeInStart||2===n&&u<this.options.fadeInEnd||u>this.options.fadeOutEnd||(r.x=a,1===n?(this.options.fadeInEnd=u,this.emit("fade-in-change",u)):2===n&&(this.options.fadeOutStart=u,this.emit("fade-out-change",u)),i>1||i<-1?h(i):this.renderPolyline())};this.makeDraggable(r,((t,e)=>h(e)));const l=n.querySelectorAll("circle");for(let t=0;t<l.length;t++){const e=t+1;this.makeDraggable(l[t],((t,i)=>d(t,i,e)))}}destroy(){this.svg?.remove(),super.destroy()}initWebAudio(){const t=this.wavesurfer?.getMediaElement();if(!t)return null;this.volume=this.options.volume??t.volume;const e=new window.AudioContext;this.gainNode=e.createGain(),this.setGainValue(),e.createMediaElementSource(t).connect(this.gainNode),this.gainNode.connect(e.destination),this.audioContext=e}invertNaturalVolume(t){return Math.pow((t-1e-4)/.9999,1/this.naturalVolumeExponent)}naturalVolume(t){return 1e-4+.9999*Math.pow(t,this.naturalVolumeExponent)}setGainValue(){this.gainNode&&(this.gainNode.gain.value=this.volume)}onVolumeDrag(t){this.setVolume(this.naturalVolume(t))}initFadeEffects(){if(!this.audioContext||!this.wavesurfer)return;const t=this.wavesurfer.on("timeupdate",(t=>{if(!this.audioContext||!this.gainNode)return;if(!this.wavesurfer?.isPlaying())return;if("suspended"===this.audioContext.state&&this.audioContext.resume(),!this.isFadingIn&&t>=this.options.fadeInStart&&t<=this.options.fadeInEnd)return this.isFadingIn=!0,this.gainNode.gain.setValueAtTime(0,this.audioContext.currentTime),void this.gainNode.gain.linearRampToValueAtTime(this.volume,this.audioContext.currentTime+(this.options.fadeInEnd-t));if(!this.isFadingOut&&t>=this.options.fadeOutStart&&t<=this.options.fadeOutEnd)return this.isFadingOut=!0,this.gainNode.gain.setValueAtTime(this.volume,this.audioContext.currentTime),void this.gainNode.gain.linearRampToValueAtTime(0,this.audioContext.currentTime+(this.options.fadeOutEnd-t));let e=!1;this.isFadingIn&&(t<this.options.fadeInStart||t>this.options.fadeInEnd)&&(this.isFadingIn=!1,e=!0),this.isFadingOut&&(t<this.options.fadeOutStart||t>=this.options.fadeOutEnd)&&(this.isFadingOut=!1,e=!0),e&&(this.gainNode.gain.cancelScheduledValues(this.audioContext.currentTime),this.setGainValue())}));this.subscriptions.push(t)}getCurrentVolume(){return this.gainNode?this.gainNode.gain.value:this.volume}setStartTime(t,e){const i=this.options.fadeInEnd-this.options.fadeInStart;this.options.fadeInStart=t,e&&(this.options.fadeInEnd=t+i),this.renderPolyline()}setEndTime(t,e){const i=this.options.fadeOutEnd-this.options.fadeOutStart;this.options.fadeOutEnd=t,e&&(this.options.fadeOutStart=t-i),this.renderPolyline()}setVolume(t){this.volume=t,this.setGainValue(),this.renderPolyline(),this.emit("volume-change",t)}}const o=n})(),s.default})()));
+!function(t,e){"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports.Envelope=e():t.Envelope=e()}(WaveSurfer,(()=>(()=>{"use strict";var t={284:(t,e,i)=>{i.d(e,{Z:()=>o});var s=i(139);class n extends s.Z{constructor(t){super(),this.subscriptions=[],this.options=t}onInit(){}init(t){this.wavesurfer=t,this.onInit()}destroy(){this.subscriptions.forEach((t=>t()))}}const o=n},139:(t,e,i)=>{i.d(e,{Z:()=>s});const s=class{constructor(){this.listeners={}}on(t,e){return this.listeners[t]||(this.listeners[t]=new Set),this.listeners[t].add(e),()=>this.un(t,e)}once(t,e){const i=this.on(t,e),s=this.on(t,(()=>{i(),s()}));return i}un(t,e){this.listeners[t]&&(e?this.listeners[t].delete(e):delete this.listeners[t])}unAll(){this.listeners={}}emit(t,...e){this.listeners[t]&&this.listeners[t].forEach((t=>t(...e)))}}}},e={};function i(s){var n=e[s];if(void 0!==n)return n.exports;var o=e[s]={exports:{}};return t[s](o,o.exports,i),o.exports}i.d=(t,e)=>{for(var s in e)i.o(e,s)&&!i.o(t,s)&&Object.defineProperty(t,s,{enumerable:!0,get:e[s]})},i.o=(t,e)=>Object.prototype.hasOwnProperty.call(t,e);var s={};return(()=>{i.d(s,{default:()=>a});var t=i(284),e=i(139);const n={fadeInStart:0,fadeOutEnd:0,fadeInEnd:0,fadeOutStart:0,lineWidth:4,lineColor:"rgba(0, 0, 255, 0.5)",dragPointSize:10,dragPointFill:"rgba(255, 255, 255, 0.8)",dragPointStroke:"rgba(255, 255, 255, 0.8)"};class o extends e.Z{constructor(t,e){super(),this.top=0,this.padding=t.dragPointSize/2+1;const i=document.createElementNS("http://www.w3.org/2000/svg","svg");i.setAttribute("width","100%"),i.setAttribute("height","100%"),i.setAttribute("viewBox",`0 0 ${e.clientWidth} ${e.clientHeight}`),i.setAttribute("preserveAspectRatio","none"),i.setAttribute("style","position: absolute; left: 0; top: 0; z-index: 4; pointer-events: none;"),i.setAttribute("part","envelope"),this.svg=i;const s=document.createElementNS("http://www.w3.org/2000/svg","polyline");s.setAttribute("points","0,0 0,0 0,0 0,0"),s.setAttribute("stroke",t.lineColor),s.setAttribute("stroke-width",t.lineWidth),s.setAttribute("fill","none"),s.setAttribute("style","pointer-events: none;"),s.setAttribute("part","polyline"),i.appendChild(s);const n=document.createElementNS("http://www.w3.org/2000/svg","line");n.setAttribute("stroke","transparent"),n.setAttribute("stroke-width",(3*t.lineWidth).toString()),n.setAttribute("style","cursor: ns-resize; pointer-events: all;"),n.setAttribute("part","line"),i.appendChild(n),[0,1].forEach((()=>{const e=document.createElementNS("http://www.w3.org/2000/svg","circle");e.setAttribute("r",(t.dragPointSize/2).toString()),e.setAttribute("fill",t.dragPointFill),e.setAttribute("stroke",t.dragPointStroke||t.dragPointFill),e.setAttribute("stroke-width","2"),e.setAttribute("style","cursor: ew-resize; pointer-events: all;"),e.setAttribute("part","circle"),i.appendChild(e)})),e.appendChild(i);{const t=t=>{const e=this.top+t,{height:s}=i.viewBox.baseVal;if(e<-.5||e>s)return;const n=Math.min(1,Math.max(0,(s-e)/s));this.emit("line-move",n)},e=(t,e)=>{const n=s.points.getItem(t).x+e,{width:o}=i.viewBox.baseVal;this.emit("point-move",t,n/o)};this.makeDraggable(n,((e,i)=>t(i)));const o=this.svg.querySelectorAll("circle");Array.from(o).forEach(((t,i)=>{this.makeDraggable(t,(t=>e(i+1,t)))}))}}makeDraggable(t,e){t.addEventListener("click",(t=>{t.preventDefault(),t.stopPropagation()})),t.addEventListener("mousedown",(t=>{t.preventDefault(),t.stopPropagation();let i=t.clientX,s=t.clientY;const n=t=>{const n=t.clientX-i,o=t.clientY-s;i=t.clientX,s=t.clientY,e(n,o)},o=()=>{document.removeEventListener("mousemove",n),document.removeEventListener("mouseup",o)};document.addEventListener("mousemove",n),document.addEventListener("mouseup",o)}))}update({x1:t,x2:e,x3:i,x4:s,y:n}){const o=this.svg.clientWidth,r=this.svg.clientHeight;this.top=r-n*r;const a=Math.max(this.padding,Math.min(this.top,r-this.padding));this.svg.setAttribute("viewBox",`0 0 ${o} ${r}`);const h=this.svg.querySelector("polyline"),{points:u}=h;u.getItem(0).x=t*o,u.getItem(0).y=r,u.getItem(1).x=e*o,u.getItem(1).y=a,u.getItem(2).x=i*o,u.getItem(2).y=a,u.getItem(3).x=s*o,u.getItem(3).y=r;const d=this.svg.querySelector("line");d.setAttribute("x1",u.getItem(1).x.toString()),d.setAttribute("x2",u.getItem(2).x.toString()),d.setAttribute("y1",a.toString()),d.setAttribute("y2",a.toString());const l=this.svg.querySelectorAll("circle");Array.from(l).forEach(((t,e)=>{const i=u.getItem(e+1);t.setAttribute("cx",i.x.toString()),t.setAttribute("cy",i.y.toString())}))}destroy(){this.svg.remove()}}class r extends t.Z{constructor(t){super(t),this.polyline=null,this.audioContext=null,this.gainNode=null,this.volume=1,this.isFadingIn=!1,this.isFadingOut=!1,this.naturalVolumeExponent=1.5,this.options=Object.assign({},n,t),this.options.lineColor=this.options.lineColor||n.lineColor,this.options.dragPointFill=this.options.dragPointFill||n.dragPointFill,this.options.dragPointStroke=this.options.dragPointStroke||n.dragPointStroke,this.volume=this.options.volume??1}static create(t){return new r(t)}destroy(){this.polyline?.destroy(),super.destroy()}onInit(){if(!this.wavesurfer)throw Error("WaveSurfer is not initialized");this.initWebAudio(),this.initSvg(),this.initFadeEffects(),this.subscriptions.push(this.wavesurfer.on("decode",(t=>{this.options.fadeInStart=this.options.fadeInStart||0,this.options.fadeOutEnd=this.options.fadeOutEnd||t,this.options.fadeInEnd=this.options.fadeInEnd||this.options.fadeInStart,this.options.fadeOutStart=this.options.fadeOutStart||this.options.fadeOutEnd,this.renderPolyline()}))),this.subscriptions.push(this.wavesurfer.on("redraw",(()=>this.renderPolyline())))}initSvg(){if(!this.wavesurfer)return;const t=this.wavesurfer.getWrapper();this.polyline=new o(this.options,t),this.subscriptions.push(this.polyline.on("line-move",(t=>{this.setVolume(this.naturalVolume(t))})),this.polyline.on("point-move",((t,e)=>{const i=e*(this.wavesurfer?.getDuration()||0);if(1===t){if(i<this.options.fadeInStart||i>this.options.fadeOutStart)return;this.options.fadeInEnd=i,this.emit("fade-in-change",i)}else if(2===t){if(i>this.options.fadeOutEnd||i<this.options.fadeInEnd)return;this.options.fadeOutStart=i,this.emit("fade-out-change",i)}this.renderPolyline()})))}renderPolyline(){if(!this.polyline||!this.wavesurfer)return;const t=this.wavesurfer.getDuration();t&&this.polyline.update({x1:this.options.fadeInStart/t,x2:this.options.fadeInEnd/t,x3:this.options.fadeOutStart/t,x4:this.options.fadeOutEnd/t,y:this.invertNaturalVolume(this.volume)})}initWebAudio(){const t=this.wavesurfer?.getMediaElement();if(!t)return null;this.volume=this.options.volume??t.volume;const e=new window.AudioContext;this.gainNode=e.createGain(),this.setGainValue(),e.createMediaElementSource(t).connect(this.gainNode),this.gainNode.connect(e.destination),this.audioContext=e}invertNaturalVolume(t){return Math.pow((t-1e-4)/.9999,1/this.naturalVolumeExponent)}naturalVolume(t){return 1e-4+.9999*Math.pow(t,this.naturalVolumeExponent)}setGainValue(){this.gainNode&&(this.gainNode.gain.value=this.volume)}initFadeEffects(){if(!this.audioContext||!this.wavesurfer)return;const t=this.wavesurfer.on("timeupdate",(t=>{if(!this.audioContext||!this.gainNode)return;if(!this.wavesurfer?.isPlaying())return;if("suspended"===this.audioContext.state&&this.audioContext.resume(),!this.isFadingIn&&t>=this.options.fadeInStart&&t<=this.options.fadeInEnd)return this.isFadingIn=!0,this.gainNode.gain.setValueAtTime(0,this.audioContext.currentTime),void this.gainNode.gain.linearRampToValueAtTime(this.volume,this.audioContext.currentTime+(this.options.fadeInEnd-t));if(!this.isFadingOut&&t>=this.options.fadeOutStart&&t<=this.options.fadeOutEnd)return this.isFadingOut=!0,this.gainNode.gain.setValueAtTime(this.volume,this.audioContext.currentTime),void this.gainNode.gain.linearRampToValueAtTime(0,this.audioContext.currentTime+(this.options.fadeOutEnd-t));let e=!1;this.isFadingIn&&(t<this.options.fadeInStart||t>this.options.fadeInEnd)&&(this.isFadingIn=!1,e=!0),this.isFadingOut&&(t<this.options.fadeOutStart||t>=this.options.fadeOutEnd)&&(this.isFadingOut=!1,e=!0),e&&(this.gainNode.gain.cancelScheduledValues(this.audioContext.currentTime),this.setGainValue())}));this.subscriptions.push(t)}getCurrentVolume(){return this.gainNode?this.gainNode.gain.value:this.volume}setStartTime(t,e=!1){if(e){const e=this.options.fadeInEnd-this.options.fadeInStart;this.options.fadeInEnd=t+e}this.options.fadeInStart=t,this.renderPolyline()}setEndTime(t,e=!1){if(e){const e=this.options.fadeOutEnd-this.options.fadeOutStart;this.options.fadeOutStart=t-e}this.options.fadeOutEnd=t,this.renderPolyline()}setVolume(t){this.volume=t,this.setGainValue(),this.renderPolyline(),this.emit("volume-change",t)}}const a=r})(),s.default})()));