wavesurfer.js 7.0.0-alpha.8 → 7.0.0-beta.1

package/dist/plugins/spectrogram.d.ts

@@ -0,0 +1,69 @@
+/**
+ * Spectrogram plugin
+ *
+ * Render a spectrogram visualisation of the audio.
+ *
+ * @author Pavel Denisov (https://github.com/akreal)
+ * @see https://github.com/wavesurfer-js/wavesurfer.js/pull/337
+ *
+ * @example
+ * // ... initialising wavesurfer with the plugin
+ * var wavesurfer = WaveSurfer.create({
+ *   // wavesurfer options ...
+ *   plugins: [
+ *     SpectrogramPlugin.create({
+ *       // plugin options ...
+ *     })
+ *   ]
+ * });
+ */
+import BasePlugin from '../base-plugin.js';
+export type SpectrogramPluginOptions = {
+    /** Selector of element or element in which to render */
+    container: string | HTMLElement;
+    /** Number of samples to fetch to FFT. Must be a power of 2. */
+    fftSamples?: number;
+    /** Height of the spectrogram view in CSS pixels */
+    height?: number;
+    /** Set to true to display frequency labels. */
+    labels?: boolean;
+    /** Size of the overlapping window. Must be < fftSamples. Auto deduced from canvas size by default. */
+    noverlap?: number;
+    /** The window function to be used. */
+    windowFunc?: 'bartlett' | 'bartlettHann' | 'blackman' | 'cosine' | 'gauss' | 'hamming' | 'hann' | 'lanczoz' | 'rectangular' | 'triangular';
+    /** Some window functions have this extra value. (Between 0 and 1) */
+    alpha?: number;
+    /** Min frequency to scale spectrogram. */
+    frequencyMin?: number;
+    /** Max frequency to scale spectrogram. Set this to samplerate/2 to draw whole range of spectrogram. */
+    frequencyMax?: number;
+    /**
+     * A 256 long array of 4-element arrays. Each entry should contain a float between 0 and 1 and specify r, g, b, and alpha.
+     * Each entry should contain a float between 0 and 1 and specify r, g, b, and alpha.
+     */
+    colorMap?: number[][];
+};
+export type SpectrogramPluginEvents = {
+    ready: [];
+    click: [relativeX: number];
+};
+export default class SpectrogramPlugin extends BasePlugin<SpectrogramPluginEvents, SpectrogramPluginOptions> {
+    static create(options?: SpectrogramPluginOptions): SpectrogramPlugin;
+    utils: {
+        style: (el: HTMLElement, styles: Record<string, string>) => CSSStyleDeclaration & Record<string, string>;
+    };
+    constructor(options: SpectrogramPluginOptions);
+    onInit(): void;
+    destroy(): void;
+    createWrapper(): void;
+    _wrapperClickHandler(event: any): void;
+    createCanvas(): void;
+    render(): void;
+    drawSpectrogram: (frequenciesData: any) => void;
+    getFrequencies(callback: any): void;
+    loadFrequenciesData(url: any): Promise<void>;
+    freqType(freq: any): string | number;
+    unitType(freq: any): "KHz" | "Hz";
+    loadLabels(bgFill: any, fontSizeFreq: any, fontSizeUnit: any, fontType: any, textColorFreq: any, textColorUnit: any, textAlign: any, container: any): void;
+    resample(oldMatrix: any): Uint8Array[];
+}

package/dist/plugins/spectrogram.js

@@ -0,0 +1,340 @@
+/**
+ * Spectrogram plugin
+ *
+ * Render a spectrogram visualisation of the audio.
+ *
+ * @author Pavel Denisov (https://github.com/akreal)
+ * @see https://github.com/wavesurfer-js/wavesurfer.js/pull/337
+ *
+ * @example
+ * // ... initialising wavesurfer with the plugin
+ * var wavesurfer = WaveSurfer.create({
+ *   // wavesurfer options ...
+ *   plugins: [
+ *     SpectrogramPlugin.create({
+ *       // plugin options ...
+ *     })
+ *   ]
+ * });
+ */
+// @ts-nocheck
+import BasePlugin from '../base-plugin.js';
+import FFT from './spectrogram-fft.mjs';
+export default class SpectrogramPlugin extends BasePlugin {
+    static create(options) {
+        return new SpectrogramPlugin(options || {});
+    }
+    constructor(options) {
+        super(options);
+        this.utils = {
+            style: (el, styles) => Object.assign(el.style, styles),
+        };
+        this.drawSpectrogram = (frequenciesData) => {
+            if (!isNaN(frequenciesData[0][0])) {
+                // data is 1ch [sample, freq] format
+                // to [channel, sample, freq] format
+                frequenciesData = [frequenciesData];
+            }
+            const spectrCc = this.spectrCc;
+            const height = this.height;
+            const width = this.width;
+            const freqFrom = this.buffer.sampleRate / 2;
+            const freqMin = this.frequencyMin;
+            const freqMax = this.frequencyMax;
+            if (!spectrCc) {
+                return;
+            }
+            for (let c = 0; c < frequenciesData.length; c++) {
+                // for each channel
+                const pixels = this.resample(frequenciesData[c]);
+                const imageData = new ImageData(width, height);
+                for (let i = 0; i < pixels.length; i++) {
+                    for (let j = 0; j < pixels[i].length; j++) {
+                        const colorMap = this.colorMap[pixels[i][j]];
+                        const redIndex = ((height - j) * width + i) * 4;
+                        imageData.data[redIndex] = colorMap[0] * 255;
+                        imageData.data[redIndex + 1] = colorMap[1] * 255;
+                        imageData.data[redIndex + 2] = colorMap[2] * 255;
+                        imageData.data[redIndex + 3] = colorMap[3] * 255;
+                    }
+                }
+                // scale and stack spectrograms
+                createImageBitmap(imageData).then((renderer) => {
+                    spectrCc.drawImage(renderer, 0, height * (1 - freqMax / freqFrom), // source x, y
+                    width, (height * (freqMax - freqMin)) / freqFrom, // source width, height
+                    0, height * c, // destination x, y
+                    width, height);
+                });
+            }
+            this.emit('ready');
+        };
+        this.frequenciesDataUrl = options.frequenciesDataUrl;
+        this.container =
+            'string' == typeof options.container ? document.querySelector(options.container) : options.container;
+        if (options.colorMap) {
+            if (options.colorMap.length < 256) {
+                throw new Error('Colormap must contain 256 elements');
+            }
+            for (let i = 0; i < options.colorMap.length; i++) {
+                const cmEntry = options.colorMap[i];
+                if (cmEntry.length !== 4) {
+                    throw new Error('ColorMap entries must contain 4 values');
+                }
+            }
+            this.colorMap = options.colorMap;
+        }
+        else {
+            this.colorMap = [];
+            for (let i = 0; i < 256; i++) {
+                const val = (255 - i) / 256;
+                this.colorMap.push([val, val, val, 1]);
+            }
+        }
+        this.fftSamples = options.fftSamples || 512;
+        this.height = options.height || this.fftSamples / 2;
+        this.noverlap = options.noverlap;
+        this.windowFunc = options.windowFunc;
+        this.alpha = options.alpha;
+        this.channels = 1;
+        // Getting file's original samplerate is difficult(#1248).
+        // So set 12kHz default to render like wavesurfer.js 5.x.
+        this.frequencyMin = options.frequencyMin || 0;
+        this.frequencyMax = options.frequencyMax || 0;
+        this.createWrapper();
+        this.createCanvas();
+    }
+    onInit() {
+        this.container = this.container || this.wavesurfer.getWrapper();
+        this.container.appendChild(this.wrapper);
+        if (this.wavesurfer.options.fillParent) {
+            this.utils.style(this.wrapper, {
+                width: '100%',
+                overflowX: 'hidden',
+                overflowY: 'hidden',
+            });
+        }
+        this.width = this.wavesurfer.getWrapper().offsetWidth;
+        this.subscriptions.push(this.wavesurfer.on('redraw', () => this.render()));
+    }
+    destroy() {
+        this.unAll();
+        this.wavesurfer.un('ready', this._onReady);
+        this.wavesurfer.un('redraw', this._onRender);
+        this.wavesurfer = null;
+        this.util = null;
+        this.options = null;
+        if (this.wrapper) {
+            this.wrapper.remove();
+            this.wrapper = null;
+        }
+    }
+    createWrapper() {
+        this.wrapper = document.createElement('div');
+        this.utils.style(this.wrapper, {
+            display: 'block',
+            position: 'relative',
+            userSelect: 'none',
+            webkitUserSelect: 'none',
+            height: `${this.height * this.channels}px`,
+        });
+        // if labels are active
+        if (this.options.labels) {
+            const labelsEl = document.createElement('canvas');
+            labelsEl.classList.add('spec-labels');
+            this.utils.style(labelsEl, {
+                position: 'absolute',
+                zIndex: 9,
+                width: '55px',
+                height: '100%',
+            });
+            this.wrapper.appendChild(labelsEl);
+            this.labelsEl = labelsEl;
+        }
+        this.wrapper.addEventListener('click', this._onWrapperClick);
+    }
+    _wrapperClickHandler(event) {
+        event.preventDefault();
+        const relX = 'offsetX' in event ? event.offsetX : event.layerX;
+        this.emit('click', relX / this.width || 0);
+    }
+    createCanvas() {
+        const canvas = document.createElement('canvas');
+        this.wrapper.appendChild(canvas);
+        this.spectrCc = canvas.getContext('2d');
+        this.utils.style(canvas, {
+            position: 'absolute',
+            left: 0,
+            top: 0,
+            width: '100%',
+            height: '100%',
+            zIndex: 4,
+        });
+        this.canvas = canvas;
+    }
+    render() {
+        this.canvas.width = this.width;
+        this.canvas.height = this.height;
+        if (this.frequenciesDataUrl) {
+            this.loadFrequenciesData(this.frequenciesDataUrl);
+        }
+        else {
+            this.getFrequencies(this.drawSpectrogram);
+        }
+        this.loadLabels('rgba(68,68,68,0.5)', '12px', '10px', '', '#fff', '#f7f7f7', 'center', '#specLabels');
+    }
+    getFrequencies(callback) {
+        const fftSamples = this.fftSamples;
+        const buffer = this.wavesurfer.getDecodedData();
+        const channels = this.channels;
+        this.frequencyMax = this.frequencyMax || buffer.sampleRate / 2;
+        if (!buffer)
+            return;
+        this.buffer = buffer;
+        // This may differ from file samplerate. Browser resamples audio.
+        const sampleRate = buffer.sampleRate;
+        const frequencies = [];
+        let noverlap = this.noverlap;
+        if (!noverlap) {
+            const uniqueSamplesPerPx = buffer.length / this.canvas.width;
+            noverlap = Math.max(0, Math.round(fftSamples - uniqueSamplesPerPx));
+        }
+        const fft = new FFT(fftSamples, sampleRate, this.windowFunc, this.alpha);
+        for (let c = 0; c < channels; c++) {
+            // for each channel
+            const channelData = buffer.getChannelData(c);
+            const channelFreq = [];
+            let currentOffset = 0;
+            while (currentOffset + fftSamples < channelData.length) {
+                const segment = channelData.slice(currentOffset, currentOffset + fftSamples);
+                const spectrum = fft.calculateSpectrum(segment);
+                const array = new Uint8Array(fftSamples / 2);
+                let j;
+                for (j = 0; j < fftSamples / 2; j++) {
+                    array[j] = Math.max(-255, Math.log10(spectrum[j]) * 45);
+                }
+                channelFreq.push(array);
+                // channelFreq: [sample, freq]
+                currentOffset += fftSamples - noverlap;
+            }
+            frequencies.push(channelFreq);
+            // frequencies: [channel, sample, freq]
+        }
+        callback(frequencies, this);
+    }
+    loadFrequenciesData(url) {
+        return fetch(url)
+            .then((response) => response.json())
+            .then(this.drawSpectrogram);
+    }
+    freqType(freq) {
+        return freq >= 1000 ? (freq / 1000).toFixed(1) : Math.round(freq);
+    }
+    unitType(freq) {
+        return freq >= 1000 ? 'KHz' : 'Hz';
+    }
+    loadLabels(bgFill, fontSizeFreq, fontSizeUnit, fontType, textColorFreq, textColorUnit, textAlign, container) {
+        const frequenciesHeight = this.height;
+        bgFill = bgFill || 'rgba(68,68,68,0)';
+        fontSizeFreq = fontSizeFreq || '12px';
+        fontSizeUnit = fontSizeUnit || '10px';
+        fontType = fontType || 'Helvetica';
+        textColorFreq = textColorFreq || '#fff';
+        textColorUnit = textColorUnit || '#fff';
+        textAlign = textAlign || 'center';
+        container = container || '#specLabels';
+        const bgWidth = 55;
+        const getMaxY = frequenciesHeight || 512;
+        const labelIndex = 5 * (getMaxY / 256);
+        const freqStart = this.frequencyMin;
+        const step = (this.frequencyMax - freqStart) / labelIndex;
+        // prepare canvas element for labels
+        const ctx = this.labelsEl.getContext('2d');
+        const dispScale = window.devicePixelRatio;
+        this.labelsEl.height = this.height * this.channels * dispScale;
+        this.labelsEl.width = bgWidth * dispScale;
+        ctx.scale(dispScale, dispScale);
+        if (!ctx) {
+            return;
+        }
+        for (let c = 0; c < this.channels; c++) {
+            // for each channel
+            // fill background
+            ctx.fillStyle = bgFill;
+            ctx.fillRect(0, c * getMaxY, bgWidth, (1 + c) * getMaxY);
+            ctx.fill();
+            let i;
+            // render labels
+            for (i = 0; i <= labelIndex; i++) {
+                ctx.textAlign = textAlign;
+                ctx.textBaseline = 'middle';
+                const freq = freqStart + step * i;
+                const label = this.freqType(freq);
+                const units = this.unitType(freq);
+                const yLabelOffset = 2;
+                const x = 16;
+                let y;
+                if (i == 0) {
+                    y = (1 + c) * getMaxY + i - 10;
+                    // unit label
+                    ctx.fillStyle = textColorUnit;
+                    ctx.font = fontSizeUnit + ' ' + fontType;
+                    ctx.fillText(units, x + 24, y);
+                    // freq label
+                    ctx.fillStyle = textColorFreq;
+                    ctx.font = fontSizeFreq + ' ' + fontType;
+                    ctx.fillText(label, x, y);
+                }
+                else {
+                    y = (1 + c) * getMaxY - i * 50 + yLabelOffset;
+                    // unit label
+                    ctx.fillStyle = textColorUnit;
+                    ctx.font = fontSizeUnit + ' ' + fontType;
+                    ctx.fillText(units, x + 24, y);
+                    // freq label
+                    ctx.fillStyle = textColorFreq;
+                    ctx.font = fontSizeFreq + ' ' + fontType;
+                    ctx.fillText(label, x, y);
+                }
+            }
+        }
+    }
+    resample(oldMatrix) {
+        const columnsNumber = this.width;
+        const newMatrix = [];
+        const oldPiece = 1 / oldMatrix.length;
+        const newPiece = 1 / columnsNumber;
+        let i;
+        for (i = 0; i < columnsNumber; i++) {
+            const column = new Array(oldMatrix[0].length);
+            let j;
+            for (j = 0; j < oldMatrix.length; j++) {
+                const oldStart = j * oldPiece;
+                const oldEnd = oldStart + oldPiece;
+                const newStart = i * newPiece;
+                const newEnd = newStart + newPiece;
+                const overlap = oldEnd <= newStart || newEnd <= oldStart
+                    ? 0
+                    : Math.min(Math.max(oldEnd, newStart), Math.max(newEnd, oldStart)) -
+                        Math.max(Math.min(oldEnd, newStart), Math.min(newEnd, oldStart));
+                let k;
+                /* eslint-disable max-depth */
+                if (overlap > 0) {
+                    for (k = 0; k < oldMatrix[0].length; k++) {
+                        if (column[k] == null) {
+                            column[k] = 0;
+                        }
+                        column[k] += (overlap / newPiece) * oldMatrix[j][k];
+                    }
+                }
+                /* eslint-enable max-depth */
+            }
+            const intColumn = new Uint8Array(oldMatrix[0].length);
+            let m;
+            for (m = 0; m < oldMatrix[0].length; m++) {
+                intColumn[m] = column[m];
+            }
+            newMatrix.push(intColumn);
+        }
+        return newMatrix;
+    }
+}

package/dist/plugins/spectrogram.min.js

@@ -0,0 +1 @@
+!function(t,e){"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports.Spectrogram=e():t.Spectrogram=e()}(WaveSurfer,(()=>(()=>{"use strict";var t={d:(e,s)=>{for(var i in s)t.o(s,i)&&!t.o(e,i)&&Object.defineProperty(e,i,{enumerable:!0,get:s[i]})},o:(t,e)=>Object.prototype.hasOwnProperty.call(t,e)},e={};t.d(e,{default:()=>r});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 s=this.on(t,e),i=this.on(t,(()=>{s(),i()}));return s}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)))}},i=class extends s{constructor(t){super(),this.subscriptions=[],this.options=t}onInit(){}init(t){this.wavesurfer=t,this.onInit()}destroy(){this.subscriptions.forEach((t=>t()))}};function a(t,e,s,i){switch(this.bufferSize=t,this.sampleRate=e,this.bandwidth=2/t*(e/2),this.sinTable=new Float32Array(t),this.cosTable=new Float32Array(t),this.windowValues=new Float32Array(t),this.reverseTable=new Uint32Array(t),this.peakBand=0,this.peak=0,s){case"bartlett":for(a=0;a<t;a++)this.windowValues[a]=2/(t-1)*((t-1)/2-Math.abs(a-(t-1)/2));break;case"bartlettHann":for(a=0;a<t;a++)this.windowValues[a]=.62-.48*Math.abs(a/(t-1)-.5)-.38*Math.cos(2*Math.PI*a/(t-1));break;case"blackman":for(i=i||.16,a=0;a<t;a++)this.windowValues[a]=(1-i)/2-.5*Math.cos(2*Math.PI*a/(t-1))+i/2*Math.cos(4*Math.PI*a/(t-1));break;case"cosine":for(a=0;a<t;a++)this.windowValues[a]=Math.cos(Math.PI*a/(t-1)-Math.PI/2);break;case"gauss":for(i=i||.25,a=0;a<t;a++)this.windowValues[a]=Math.pow(Math.E,-.5*Math.pow((a-(t-1)/2)/(i*(t-1)/2),2));break;case"hamming":for(a=0;a<t;a++)this.windowValues[a]=.54-.46*Math.cos(2*Math.PI*a/(t-1));break;case"hann":case void 0:for(a=0;a<t;a++)this.windowValues[a]=.5*(1-Math.cos(2*Math.PI*a/(t-1)));break;case"lanczoz":for(a=0;a<t;a++)this.windowValues[a]=Math.sin(Math.PI*(2*a/(t-1)-1))/(Math.PI*(2*a/(t-1)-1));break;case"rectangular":for(a=0;a<t;a++)this.windowValues[a]=1;break;case"triangular":for(a=0;a<t;a++)this.windowValues[a]=2/t*(t/2-Math.abs(a-(t-1)/2));break;default:throw Error("No such window function '"+s+"'")}for(var a,r=1,n=t>>1;r<t;){for(a=0;a<r;a++)this.reverseTable[a+r]=this.reverseTable[a]+n;r<<=1,n>>=1}for(a=0;a<t;a++)this.sinTable[a]=Math.sin(-Math.PI/a),this.cosTable[a]=Math.cos(-Math.PI/a);this.calculateSpectrum=function(t){var e,s,i,a=this.bufferSize,r=this.cosTable,n=this.sinTable,h=this.reverseTable,l=new Float32Array(a),o=new Float32Array(a),c=2/this.bufferSize,f=Math.sqrt,p=new Float32Array(a/2),u=Math.floor(Math.log(a)/Math.LN2);if(Math.pow(2,u)!==a)throw"Invalid buffer size, must be a power of 2.";if(a!==t.length)throw"Supplied buffer is not the same size as defined FFT. FFT Size: "+a+" Buffer Size: "+t.length;for(var d,w,M,b,g,m,y,v,x=1,S=0;S<a;S++)l[S]=t[h[S]]*this.windowValues[h[S]],o[S]=0;for(;x<a;){d=r[x],w=n[x],M=1,b=0;for(var k=0;k<x;k++){for(S=k;S<a;)m=M*l[g=S+x]-b*o[g],y=M*o[g]+b*l[g],l[g]=l[S]-m,o[g]=o[S]-y,l[S]+=m,o[S]+=y,S+=x<<1;M=(v=M)*d-b*w,b=v*w+b*d}x<<=1}S=0;for(var q=a/2;S<q;S++)(i=c*f((e=l[S])*e+(s=o[S])*s))>this.peak&&(this.peakBand=S,this.peak=i),p[S]=i;return p}}class r extends i{static create(t){return new r(t||{})}constructor(t){if(super(t),this.utils={style:(t,e)=>Object.assign(t.style,e)},this.drawSpectrogram=t=>{isNaN(t[0][0])||(t=[t]);const e=this.spectrCc,s=this.height,i=this.width,a=this.buffer.sampleRate/2,r=this.frequencyMin,n=this.frequencyMax;if(e){for(let h=0;h<t.length;h++){const l=this.resample(t[h]),o=new ImageData(i,s);for(let t=0;t<l.length;t++)for(let e=0;e<l[t].length;e++){const a=this.colorMap[l[t][e]],r=4*((s-e)*i+t);o.data[r]=255*a[0],o.data[r+1]=255*a[1],o.data[r+2]=255*a[2],o.data[r+3]=255*a[3]}createImageBitmap(o).then((t=>{e.drawImage(t,0,s*(1-n/a),i,s*(n-r)/a,0,s*h,i,s)}))}this.emit("ready")}},this.frequenciesDataUrl=t.frequenciesDataUrl,this.container="string"==typeof t.container?document.querySelector(t.container):t.container,t.colorMap){if(t.colorMap.length<256)throw new Error("Colormap must contain 256 elements");for(let e=0;e<t.colorMap.length;e++)if(4!==t.colorMap[e].length)throw new Error("ColorMap entries must contain 4 values");this.colorMap=t.colorMap}else{this.colorMap=[];for(let t=0;t<256;t++){const e=(255-t)/256;this.colorMap.push([e,e,e,1])}}this.fftSamples=t.fftSamples||512,this.height=t.height||this.fftSamples/2,this.noverlap=t.noverlap,this.windowFunc=t.windowFunc,this.alpha=t.alpha,this.channels=1,this.frequencyMin=t.frequencyMin||0,this.frequencyMax=t.frequencyMax||0,this.createWrapper(),this.createCanvas()}onInit(){this.container=this.container||this.wavesurfer.getWrapper(),this.container.appendChild(this.wrapper),this.wavesurfer.options.fillParent&&this.utils.style(this.wrapper,{width:"100%",overflowX:"hidden",overflowY:"hidden"}),this.width=this.wavesurfer.getWrapper().offsetWidth,this.subscriptions.push(this.wavesurfer.on("redraw",(()=>this.render())))}destroy(){this.unAll(),this.wavesurfer.un("ready",this._onReady),this.wavesurfer.un("redraw",this._onRender),this.wavesurfer=null,this.util=null,this.options=null,this.wrapper&&(this.wrapper.remove(),this.wrapper=null)}createWrapper(){if(this.wrapper=document.createElement("div"),this.utils.style(this.wrapper,{display:"block",position:"relative",userSelect:"none",webkitUserSelect:"none",height:this.height*this.channels+"px"}),this.options.labels){const t=document.createElement("canvas");t.classList.add("spec-labels"),this.utils.style(t,{position:"absolute",zIndex:9,width:"55px",height:"100%"}),this.wrapper.appendChild(t),this.labelsEl=t}this.wrapper.addEventListener("click",this._onWrapperClick)}_wrapperClickHandler(t){t.preventDefault();const e="offsetX"in t?t.offsetX:t.layerX;this.emit("click",e/this.width||0)}createCanvas(){const t=document.createElement("canvas");this.wrapper.appendChild(t),this.spectrCc=t.getContext("2d"),this.utils.style(t,{position:"absolute",left:0,top:0,width:"100%",height:"100%",zIndex:4}),this.canvas=t}render(){this.canvas.width=this.width,this.canvas.height=this.height,this.frequenciesDataUrl?this.loadFrequenciesData(this.frequenciesDataUrl):this.getFrequencies(this.drawSpectrogram),this.loadLabels("rgba(68,68,68,0.5)","12px","10px","","#fff","#f7f7f7","center","#specLabels")}getFrequencies(t){const e=this.fftSamples,s=this.wavesurfer.getDecodedData(),i=this.channels;if(this.frequencyMax=this.frequencyMax||s.sampleRate/2,!s)return;this.buffer=s;const r=s.sampleRate,n=[];let h=this.noverlap;if(!h){const t=s.length/this.canvas.width;h=Math.max(0,Math.round(e-t))}const l=new a(e,r,this.windowFunc,this.alpha);for(let t=0;t<i;t++){const i=s.getChannelData(t),a=[];let r=0;for(;r+e<i.length;){const t=i.slice(r,r+e),s=l.calculateSpectrum(t),n=new Uint8Array(e/2);let o;for(o=0;o<e/2;o++)n[o]=Math.max(-255,45*Math.log10(s[o]));a.push(n),r+=e-h}n.push(a)}t(n,this)}loadFrequenciesData(t){return fetch(t).then((t=>t.json())).then(this.drawSpectrogram)}freqType(t){return t>=1e3?(t/1e3).toFixed(1):Math.round(t)}unitType(t){return t>=1e3?"KHz":"Hz"}loadLabels(t,e,s,i,a,r,n,h){t=t||"rgba(68,68,68,0)",e=e||"12px",s=s||"10px",i=i||"Helvetica",a=a||"#fff",r=r||"#fff",n=n||"center",h=h||"#specLabels";const l=this.height||512,o=l/256*5,c=this.frequencyMin,f=(this.frequencyMax-c)/o,p=this.labelsEl.getContext("2d"),u=window.devicePixelRatio;if(this.labelsEl.height=this.height*this.channels*u,this.labelsEl.width=55*u,p.scale(u,u),p)for(let h=0;h<this.channels;h++){let u;for(p.fillStyle=t,p.fillRect(0,h*l,55,(1+h)*l),p.fill(),u=0;u<=o;u++){p.textAlign=n,p.textBaseline="middle";const t=c+f*u,o=this.freqType(t),d=this.unitType(t),w=2,M=16;let b;0==u?(b=(1+h)*l+u-10,p.fillStyle=r,p.font=s+" "+i,p.fillText(d,M+24,b),p.fillStyle=a,p.font=e+" "+i,p.fillText(o,M,b)):(b=(1+h)*l-50*u+w,p.fillStyle=r,p.font=s+" "+i,p.fillText(d,M+24,b),p.fillStyle=a,p.font=e+" "+i,p.fillText(o,M,b))}}}resample(t){const e=this.width,s=[],i=1/t.length,a=1/e;let r;for(r=0;r<e;r++){const e=new Array(t[0].length);let n;for(n=0;n<t.length;n++){const s=n*i,h=s+i,l=r*a,o=l+a,c=h<=l||o<=s?0:Math.min(Math.max(h,l),Math.max(o,s))-Math.max(Math.min(h,l),Math.min(o,s));let f;if(c>0)for(f=0;f<t[0].length;f++)null==e[f]&&(e[f]=0),e[f]+=c/a*t[n][f]}const h=new Uint8Array(t[0].length);let l;for(l=0;l<t[0].length;l++)h[l]=e[l];s.push(h)}return s}}return e.default})()));

package/dist/plugins/timeline.d.ts

@@ -1,28 +1,45 @@
+/**
+ * The Timeline plugin adds timestamps and notches under the waveform.
+ */
 import BasePlugin from '../base-plugin.js';
-import { WaveSurferPluginParams } from '../index.js';
-type TimelinePluginOptions = {
+export type TimelinePluginOptions = {
+    /** The height of the timeline in pixels, defaults to 20 */
     height?: number;
+    /** HTML container for the timeline, defaults to wavesufer's container */
+    container?: HTMLElement;
+    /** Pass 'beforebegin' to insert the timeline on top of the waveform */
+    insertPosition?: InsertPosition;
+    /** The duration of the timeline in seconds, defaults to wavesurfer's duration */
+    duration?: number;
+    /** Interval between ticks in seconds */
     timeInterval?: number;
+    /** Interval between numeric labels */
     primaryLabelInterval?: number;
+    /** Interval between secondary numeric labels */
     secondaryLabelInterval?: number;
+    /** Custom inline style to apply to the container */
+    style?: Partial<CSSStyleDeclaration> | string;
 };
 declare const defaultOptions: {
     height: number;
 };
-type TimelinePluginEvents = {
-    ready: void;
+export type TimelinePluginEvents = {
+    ready: [];
 };
 declare class TimelinePlugin extends BasePlugin<TimelinePluginEvents, TimelinePluginOptions> {
-    private wrapper;
+    private timelineWrapper;
     protected options: TimelinePluginOptions & typeof defaultOptions;
-    constructor(params: WaveSurferPluginParams, options: TimelinePluginOptions);
+    constructor(options?: TimelinePluginOptions);
+    static create(options?: TimelinePluginOptions): TimelinePlugin;
+    /** Called by wavesurfer, don't call manually */
+    onInit(): void;
     /** Unmount */
     destroy(): void;
-    private initWrapper;
+    private initTimelineWrapper;
     private formatTime;
     private defaultTimeInterval;
-    defaultPrimaryLabelInterval(pxPerSec: number): number;
-    defaultSecondaryLabelInterval(pxPerSec: number): number;
+    private defaultPrimaryLabelInterval;
+    private defaultSecondaryLabelInterval;
     private initTimeline;
 }
 export default TimelinePlugin;

package/dist/plugins/timeline.js

@@ -1,29 +1,55 @@
+/**
+ * The Timeline plugin adds timestamps and notches under the waveform.
+ */
 import BasePlugin from '../base-plugin.js';
 const defaultOptions = {
     height: 20,
 };
 class TimelinePlugin extends BasePlugin {
-    constructor(params, options) {
-        super(params, options);
+    constructor(options) {
+        super(options || {});
         this.options = Object.assign({}, defaultOptions, options);
-        this.wrapper = this.initWrapper();
-        this.container.appendChild(this.wrapper);
-        this.subscriptions.push(this.wavesurfer.on('decode', ({ duration }) => {
-            this.initTimeline(duration);
-        }));
+        this.timelineWrapper = this.initTimelineWrapper();
+    }
+    static create(options) {
+        return new TimelinePlugin(options);
+    }
+    /** Called by wavesurfer, don't call manually */
+    onInit() {
+        if (!this.wavesurfer) {
+            throw Error('WaveSurfer is not initialized');
+        }
+        const container = this.options.container ?? this.wavesurfer.getWrapper();
+        if (this.options.insertPosition) {
+            ;
+            (container.firstElementChild || container).insertAdjacentElement(this.options.insertPosition, this.timelineWrapper);
+        }
+        else {
+            container.appendChild(this.timelineWrapper);
+        }
+        if (this.options.duration) {
+            this.initTimeline(this.options.duration);
+        }
+        else {
+            this.subscriptions.push(this.wavesurfer.on('redraw', () => {
+                this.initTimeline(this.wavesurfer?.getDuration() || 0);
+            }));
+        }
     }
     /** Unmount */
     destroy() {
-        this.wrapper.remove();
+        this.timelineWrapper.remove();
         super.destroy();
     }
-    initWrapper() {
-        return document.createElement('div');
+    initTimelineWrapper() {
+        const div = document.createElement('div');
+        div.setAttribute('part', 'timeline');
+        return div;
     }
     formatTime(seconds) {
         if (seconds / 60 > 1) {
             // calculate minutes and seconds from seconds count
-            const minutes = Math.round(seconds / 60);
+            const minutes = Math.floor(seconds / 60);
             seconds = Math.round(seconds % 60);
             const paddedSeconds = `${seconds < 10 ? '0' : ''}${seconds}`;
             return `${minutes}:${paddedSeconds}`;
@@ -71,36 +97,52 @@ class TimelinePlugin extends BasePlugin {
         return 2;
     }
     initTimeline(duration) {
-        var _a, _b, _c;
-        const width = Math.round(this.wrapper.scrollWidth * devicePixelRatio);
-        const pxPerSec = width / duration;
-        const timeInterval = (_a = this.options.timeInterval) !== null && _a !== void 0 ? _a : this.defaultTimeInterval(pxPerSec);
-        const primaryLabelInterval = (_b = this.options.primaryLabelInterval) !== null && _b !== void 0 ? _b : this.defaultPrimaryLabelInterval(pxPerSec);
-        const secondaryLabelInterval = (_c = this.options.secondaryLabelInterval) !== null && _c !== void 0 ? _c : this.defaultSecondaryLabelInterval(pxPerSec);
+        const pxPerSec = this.timelineWrapper.scrollWidth / duration;
+        const timeInterval = this.options.timeInterval ?? this.defaultTimeInterval(pxPerSec);
+        const primaryLabelInterval = this.options.primaryLabelInterval ?? this.defaultPrimaryLabelInterval(pxPerSec);
+        const secondaryLabelInterval = this.options.secondaryLabelInterval ?? this.defaultSecondaryLabelInterval(pxPerSec);
+        const isTop = this.options.insertPosition === 'beforebegin';
         const timeline = document.createElement('div');
         timeline.setAttribute('style', `
       height: ${this.options.height}px;
       overflow: hidden;
       display: flex;
       justify-content: space-between;
-      align-items: flex-end;
+      align-items: ${isTop ? 'flex-start' : 'flex-end'};
       font-size: ${this.options.height / 2}px;
+      white-space: nowrap;
     `);
+        if (isTop) {
+            const topStyle = `
+        position: absolute;
+        top: 0;
+        left: 0;
+        right: 0;
+        z-index: 2;
+      `;
+            timeline.setAttribute('style', timeline.getAttribute('style') + topStyle);
+        }
+        if (typeof this.options.style === 'string') {
+            timeline.setAttribute('style', timeline.getAttribute('style') + this.options.style);
+        }
+        else if (typeof this.options.style === 'object') {
+            Object.assign(timeline.style, this.options.style);
+        }
         const notchEl = document.createElement('div');
         notchEl.setAttribute('style', `
       width: 1px;
       height: 50%;
       display: flex;
       flex-direction: column;
-      justify-content: flex-end;
+      justify-content: ${isTop ? 'flex-start' : 'flex-end'};
       overflow: visible;
       border-left: 1px solid currentColor;
       opacity: 0.25;
     `);
         for (let i = 0; i < duration; i += timeInterval) {
             const notch = notchEl.cloneNode();
-            const isPrimary = i % primaryLabelInterval === 0;
-            const isSecondary = i % secondaryLabelInterval === 0;
+            const isPrimary = (Math.round(i * 100) / 100) % primaryLabelInterval === 0;
+            const isSecondary = (Math.round(i * 100) / 100) % secondaryLabelInterval === 0;
             if (isPrimary || isSecondary) {
                 notch.style.height = '100%';
                 notch.style.textIndent = '3px';
@@ -110,7 +152,8 @@ class TimelinePlugin extends BasePlugin {
             }
             timeline.appendChild(notch);
         }
-        this.wrapper.appendChild(timeline);
+        this.timelineWrapper.innerHTML = '';
+        this.timelineWrapper.appendChild(timeline);
         this.emit('ready');
     }
 }

package/dist/plugins/timeline.min.js

@@ -0,0 +1 @@
+!function(t,e){"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports.Timeline=e():t.Timeline=e()}(WaveSurfer,(()=>(()=>{"use strict";var t={284:(t,e,i)=>{i.d(e,{Z:()=>r});var n=i(139);class s extends n.Z{constructor(t){super(),this.subscriptions=[],this.options=t}onInit(){}init(t){this.wavesurfer=t,this.onInit()}destroy(){this.subscriptions.forEach((t=>t()))}}const r=s},139:(t,e,i)=>{i.d(e,{Z:()=>n});const n=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),n=this.on(t,(()=>{i(),n()}));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(n){var s=e[n];if(void 0!==s)return s.exports;var r=e[n]={exports:{}};return t[n](r,r.exports,i),r.exports}i.d=(t,e)=>{for(var n in e)i.o(e,n)&&!i.o(t,n)&&Object.defineProperty(t,n,{enumerable:!0,get:e[n]})},i.o=(t,e)=>Object.prototype.hasOwnProperty.call(t,e);var n={};return(()=>{i.d(n,{default:()=>r});var t=i(284);const e={height:20};class s extends t.Z{constructor(t){super(t||{}),this.options=Object.assign({},e,t),this.timelineWrapper=this.initTimelineWrapper()}static create(t){return new s(t)}onInit(){if(!this.wavesurfer)throw Error("WaveSurfer is not initialized");const t=this.options.container??this.wavesurfer.getWrapper();this.options.insertPosition?(t.firstElementChild||t).insertAdjacentElement(this.options.insertPosition,this.timelineWrapper):t.appendChild(this.timelineWrapper),this.options.duration?this.initTimeline(this.options.duration):this.subscriptions.push(this.wavesurfer.on("redraw",(()=>{this.initTimeline(this.wavesurfer?.getDuration()||0)})))}destroy(){this.timelineWrapper.remove(),super.destroy()}initTimelineWrapper(){const t=document.createElement("div");return t.setAttribute("part","timeline"),t}formatTime(t){return t/60>1?`${Math.floor(t/60)}:${(t=Math.round(t%60))<10?"0":""}${t}`:""+Math.round(1e3*t)/1e3}defaultTimeInterval(t){return t>=25?1:5*t>=25?5:15*t>=25?15:60*Math.ceil(.5/t)}defaultPrimaryLabelInterval(t){return t>=25?10:5*t>=25?6:4}defaultSecondaryLabelInterval(t){return t>=25?5:2}initTimeline(t){const e=this.timelineWrapper.scrollWidth/t,i=this.options.timeInterval??this.defaultTimeInterval(e),n=this.options.primaryLabelInterval??this.defaultPrimaryLabelInterval(e),s=this.options.secondaryLabelInterval??this.defaultSecondaryLabelInterval(e),r="beforebegin"===this.options.insertPosition,o=document.createElement("div");if(o.setAttribute("style",`\n      height: ${this.options.height}px;\n      overflow: hidden;\n      display: flex;\n      justify-content: space-between;\n      align-items: ${r?"flex-start":"flex-end"};\n      font-size: ${this.options.height/2}px;\n      white-space: nowrap;\n    `),r){const t="\n        position: absolute;\n        top: 0;\n        left: 0;\n        right: 0;\n        z-index: 2;\n      ";o.setAttribute("style",o.getAttribute("style")+t)}"string"==typeof this.options.style?o.setAttribute("style",o.getAttribute("style")+this.options.style):"object"==typeof this.options.style&&Object.assign(o.style,this.options.style);const l=document.createElement("div");l.setAttribute("style",`\n      width: 1px;\n      height: 50%;\n      display: flex;\n      flex-direction: column;\n      justify-content: ${r?"flex-start":"flex-end"};\n      overflow: visible;\n      border-left: 1px solid currentColor;\n      opacity: 0.25;\n    `);for(let e=0;e<t;e+=i){const t=l.cloneNode(),i=Math.round(100*e)/100%n==0,r=Math.round(100*e)/100%s==0;(i||r)&&(t.style.height="100%",t.style.textIndent="3px",t.textContent=this.formatTime(e),i&&(t.style.opacity="1")),o.appendChild(t)}this.timelineWrapper.innerHTML="",this.timelineWrapper.appendChild(o),this.emit("ready")}}const r=s})(),n.default})()));