src/plugin/minimap/index.js
/*eslint no-console: ["error", { allow: ["warn"] }] */
/**
* @typedef {Object} MinimapPluginParams
* @desc Extends the `WavesurferParams` wavesurfer was initialised with
* @property {?string|HTMLElement} container CSS selector or HTML element where
* the map should be rendered. By default it is simply appended
* after the waveform.
* @property {?boolean} deferInit Set to true to manually call
* `initPlugin('minimap')`
*/
/**
* Renders a smaller version waveform as a minimap of the main waveform.
*
* @implements {PluginClass}
* @extends {Observer}
* @example
* // es6
* import MinimapPlugin from 'wavesurfer.minimap.js';
*
* // commonjs
* var MinimapPlugin = require('wavesurfer.minimap.js');
*
* // if you are using <script> tags
* var MinimapPlugin = window.WaveSurfer.minimap;
*
* // ... initialising wavesurfer with the plugin
* var wavesurfer = WaveSurfer.create({
* // wavesurfer options ...
* plugins: [
* MinimapPlugin.create({
* // plugin options ...
* })
* ]
* });
*/
export default class MinimapPlugin {
/**
* Minimap plugin definition factory
*
* This function must be used to create a plugin definition which can be
* used by wavesurfer to correctly instantiate the plugin.
*
* @param {MinimapPluginParams} params parameters use to initialise the plugin
* @return {PluginDefinition} an object representing the plugin
*/
static create(params) {
return {
name: 'minimap',
deferInit: params && params.deferInit ? params.deferInit : false,
params: params,
staticProps: {},
instance: MinimapPlugin
};
}
constructor(params, ws) {
this.params = Object.assign(
{},
ws.params,
{
showRegions: false,
regionsPluginName: params.regionsPluginName || 'regions',
showOverview: false,
overviewBorderColor: 'green',
overviewBorderSize: 2,
// the container should be different
container: false,
height: Math.max(Math.round(ws.params.height / 4), 20)
},
params,
{
scrollParent: false,
fillParent: true
}
);
// if container is a selector, get the element
if (typeof params.container === 'string') {
const el = document.querySelector(params.container);
if (!el) {
console.warn(
`Wavesurfer minimap container ${params.container} was not found! The minimap will be automatically appended below the waveform.`
);
}
this.params.container = el;
}
// if no container is specified add a new element and insert it
if (!params.container) {
this.params.container = ws.util.style(
document.createElement('minimap'),
{
display: 'block'
}
);
}
this.drawer = new ws.Drawer(this.params.container, this.params);
this.wavesurfer = ws;
this.util = ws.util;
this.cleared = false;
this.renderEvent = 'redraw';
this.overviewRegion = null;
this.regionsPlugin = this.wavesurfer[this.params.regionsPluginName];
this.drawer.createWrapper();
this.createElements();
let isInitialised = false;
// ws ready event listener
this._onShouldRender = () => {
// only bind the events in the first run
if (!isInitialised) {
this.bindWavesurferEvents();
this.bindMinimapEvents();
isInitialised = true;
}
// if there is no such element, append it to the container (below
// the waveform)
if (!document.body.contains(this.params.container)) {
ws.container.insertBefore(this.params.container, null);
}
if (this.regionsPlugin && this.params.showRegions) {
this.drawRegions();
}
this.render();
};
this._onAudioprocess = currentTime => {
this.drawer.progress(this.wavesurfer.backend.getPlayedPercents());
};
// ws seek event listener
this._onSeek = () =>
this.drawer.progress(ws.backend.getPlayedPercents());
// event listeners for the overview region
this._onScroll = e => {
if (!this.draggingOverview) {
const orientedTarget = this.util.withOrientation(e.target, this.wavesurfer.params.vertical);
this.moveOverviewRegion(orientedTarget.scrollLeft / this.ratio);
}
};
this._onMouseover = e => {
if (this.draggingOverview) {
this.draggingOverview = false;
}
};
let prevWidth = 0;
this._onResize = ws.util.debounce(() => {
if (prevWidth != this.drawer.wrapper.clientWidth) {
prevWidth = this.drawer.wrapper.clientWidth;
this.render();
this.drawer.progress(
this.wavesurfer.backend.getPlayedPercents()
);
}
});
this._onLoading = percent => {
if (percent >= 100) {
this.cleared = false;
return;
}
if (this.cleared === true) {
return;
}
const len = this.drawer.getWidth();
this.drawer.drawPeaks([0], len, 0, len);
this.cleared = true;
};
this._onZoom = e => {
this.render();
};
this.wavesurfer.on('zoom', this._onZoom);
}
init() {
if (this.wavesurfer.isReady) {
this._onShouldRender();
}
this.wavesurfer.on(this.renderEvent, this._onShouldRender);
}
destroy() {
window.removeEventListener('resize', this._onResize, true);
window.removeEventListener('orientationchange', this._onResize, true);
this.wavesurfer.drawer.wrapper.removeEventListener(
'mouseover',
this._onMouseover
);
this.wavesurfer.un(this.renderEvent, this._onShouldRender);
this.wavesurfer.un('seek', this._onSeek);
this.wavesurfer.un('scroll', this._onScroll);
this.wavesurfer.un('audioprocess', this._onAudioprocess);
this.wavesurfer.un('zoom', this._onZoom);
this.wavesurfer.un('loading', this._onLoading);
this.drawer.destroy();
this.overviewRegion = null;
this.unAll();
}
drawRegions() {
this.regions = {};
this.wavesurfer.on('region-created', region => {
this.regions[region.id] = region;
this.drawer.wrapper && this.renderRegions();
});
this.wavesurfer.on('region-updated', region => {
this.regions[region.id] = region;
this.drawer.wrapper && this.renderRegions();
});
this.wavesurfer.on('region-removed', region => {
delete this.regions[region.id];
this.drawer.wrapper && this.renderRegions();
});
}
renderRegions() {
const regionElements = this.drawer.wrapper.querySelectorAll('region');
let i;
for (i = 0; i < regionElements.length; ++i) {
this.drawer.wrapper.removeChild(regionElements[i]);
}
Object.keys(this.regions).forEach(id => {
const region = this.regions[id];
const width =
this.getWidth() *
((region.end - region.start) / this.wavesurfer.getDuration());
const left =
this.getWidth() *
(region.start / this.wavesurfer.getDuration());
const regionElement = this.util.style(
document.createElement('region'),
{
height: 'inherit',
backgroundColor: region.color,
width: width + 'px',
left: left + 'px',
display: 'block',
position: 'absolute'
}
);
regionElement.classList.add(id);
this.drawer.wrapper.appendChild(regionElement);
});
}
createElements() {
this.drawer.createElements();
if (this.params.showOverview) {
this.overviewRegion = this.util.withOrientation(
this.drawer.wrapper.appendChild(document.createElement('overview')),
this.wavesurfer.params.vertical
);
this.util.style(
this.overviewRegion,
{
top: 0,
bottom: 0,
width: '0px',
display: 'block',
position: 'absolute',
cursor: 'move',
border:
this.params.overviewBorderSize +
'px solid ' +
this.params.overviewBorderColor,
zIndex: 2,
opacity: this.params.overviewOpacity
}
);
}
}
bindWavesurferEvents() {
window.addEventListener('resize', this._onResize, true);
window.addEventListener('orientationchange', this._onResize, true);
this.wavesurfer.on('audioprocess', this._onAudioprocess);
this.wavesurfer.on('seek', this._onSeek);
this.wavesurfer.on('loading', this._onLoading);
if (this.params.showOverview) {
this.wavesurfer.on('scroll', this._onScroll);
this.wavesurfer.drawer.wrapper.addEventListener(
'mouseover',
this._onMouseover
);
}
}
bindMinimapEvents() {
const positionMouseDown = {
clientX: 0,
clientY: 0
};
let relativePositionX = 0;
let seek = true;
// the following event listeners will be destroyed by using
// this.unAll() and nullifying the DOM node references after
// removing them
if (this.params.interact) {
this.drawer.wrapper.addEventListener('click', event => {
this.fireEvent('click', event, this.drawer.handleEvent(event));
});
this.on('click', (event, position) => {
if (seek) {
this.drawer.progress(position);
this.wavesurfer.seekAndCenter(position);
} else {
seek = true;
}
});
}
if (this.params.showOverview) {
this.overviewRegion.domElement.addEventListener('mousedown', e => {
const event = this.util.withOrientation(e, this.wavesurfer.params.vertical);
this.draggingOverview = true;
relativePositionX = event.layerX;
positionMouseDown.clientX = event.clientX;
positionMouseDown.clientY = event.clientY;
});
this.drawer.wrapper.addEventListener('mousemove', e => {
if (this.draggingOverview) {
const event = this.util.withOrientation(e, this.wavesurfer.params.vertical);
this.moveOverviewRegion(
event.clientX -
this.drawer.container.getBoundingClientRect().left -
relativePositionX
);
}
});
this.drawer.wrapper.addEventListener('mouseup', e => {
const event = this.util.withOrientation(e, this.wavesurfer.params.vertical);
if (
positionMouseDown.clientX - event.clientX === 0 &&
positionMouseDown.clientX - event.clientX === 0
) {
seek = true;
this.draggingOverview = false;
} else if (this.draggingOverview) {
seek = false;
this.draggingOverview = false;
}
});
}
}
render() {
const len = this.drawer.getWidth();
const peaks = this.wavesurfer.backend.getPeaks(len, 0, len);
this.drawer.drawPeaks(peaks, len, 0, len);
this.drawer.progress(this.wavesurfer.backend.getPlayedPercents());
if (this.params.showOverview) {
//get proportional width of overview region considering the respective
//width of the drawers
this.ratio = this.wavesurfer.drawer.width / this.drawer.width;
this.waveShowedWidth = this.wavesurfer.drawer.width / this.ratio;
this.waveWidth = this.wavesurfer.drawer.width;
this.overviewWidth = this.drawer.container.offsetWidth / this.ratio;
this.overviewPosition = 0;
this.moveOverviewRegion(
this.wavesurfer.drawer.wrapper.scrollLeft / this.ratio
);
this.util.style(this.overviewRegion, {
width: this.overviewWidth + 'px'
});
}
}
moveOverviewRegion(pixels) {
if (pixels < 0) {
this.overviewPosition = 0;
} else if (
pixels + this.overviewWidth <
this.drawer.container.offsetWidth
) {
this.overviewPosition = pixels;
} else {
this.overviewPosition =
this.drawer.container.offsetWidth - this.overviewWidth;
}
this.util.style(this.overviewRegion, {
left: this.overviewPosition + 'px'
});
if (this.draggingOverview) {
this.wavesurfer.drawer.wrapper.scrollLeft =
this.overviewPosition * this.ratio;
}
}
getWidth() {
return this.drawer.width / this.params.pixelRatio;
}
}
