feat(legacy): visual cue point editor (#2947)
A visual cue point editor in the track editor view. This view displays the track as a waveform and allows you to set where the in- and out-cue points are set. These cue points determine the start and end points of the track. --------- Co-authored-by: Thomas Göttgens <tgoettgens@mail.com> Co-authored-by: Kyle Robbertze <paddatrapper@users.noreply.github.com>
This commit is contained in:
Thomas Göttgens
GitHub
parent
71b20ae3c9
commit
da02e74f21
20 changed files with 9420 additions and 43 deletions
404
legacy/public/js/wavesurfer/cursor.js
Normal file
404
legacy/public/js/wavesurfer/cursor.js
Normal file
|
|
@ -0,0 +1,404 @@
|
|||
/*!
|
||||
* wavesurfer.js cursor plugin 4.6.0 (2024-02-05)
|
||||
* https://wavesurfer-js.org
|
||||
* @license BSD-3-Clause
|
||||
*/
|
||||
(function webpackUniversalModuleDefinition(root, factory) {
|
||||
if(typeof exports === 'object' && typeof module === 'object')
|
||||
module.exports = factory();
|
||||
else if(typeof define === 'function' && define.amd)
|
||||
define("WaveSurfer", [], factory);
|
||||
else if(typeof exports === 'object')
|
||||
exports["WaveSurfer"] = factory();
|
||||
else
|
||||
root["WaveSurfer"] = root["WaveSurfer"] || {}, root["WaveSurfer"]["cursor"] = factory();
|
||||
})(this, () => {
|
||||
return /******/ (() => { // webpackBootstrap
|
||||
/******/ "use strict";
|
||||
/******/ var __webpack_modules__ = ({
|
||||
|
||||
/***/ "./src/plugin/cursor/index.js":
|
||||
/*!************************************!*\
|
||||
!*** ./src/plugin/cursor/index.js ***!
|
||||
\************************************/
|
||||
/***/ ((module, exports) => {
|
||||
|
||||
|
||||
|
||||
Object.defineProperty(exports, "__esModule", ({
|
||||
value: true
|
||||
}));
|
||||
exports["default"] = void 0;
|
||||
function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
|
||||
function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
|
||||
function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor); } }
|
||||
function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
|
||||
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : String(i); }
|
||||
function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
|
||||
/**
|
||||
* @typedef {Object} CursorPluginParams
|
||||
* @property {?boolean} deferInit Set to true to stop auto init in `addPlugin()`
|
||||
* @property {boolean} hideOnBlur=true Hide the cursor when the mouse leaves the
|
||||
* waveform
|
||||
* @property {string} width='1px' The width of the cursor
|
||||
* @property {string} color='black' The color of the cursor
|
||||
* @property {string} opacity='0.25' The opacity of the cursor
|
||||
* @property {string} style='solid' The border style of the cursor
|
||||
* @property {number} zIndex=3 The z-index of the cursor element
|
||||
* @property {object} customStyle An object with custom styles which are applied
|
||||
* to the cursor element
|
||||
* @property {boolean} showTime=false Show the time on the cursor.
|
||||
* @property {object} customShowTimeStyle An object with custom styles which are
|
||||
* applied to the cursor time element.
|
||||
* @property {string} followCursorY=false Use `true` to make the time on
|
||||
* the cursor follow the x and the y-position of the mouse. Use `false` to make the
|
||||
* it only follow the x-position of the mouse.
|
||||
* @property {function} formatTimeCallback Formats the timestamp on the cursor.
|
||||
*/
|
||||
/**
|
||||
* Displays a thin line at the position of the cursor on the waveform.
|
||||
*
|
||||
* @implements {PluginClass}
|
||||
* @extends {Observer}
|
||||
* @example
|
||||
* // es6
|
||||
* import CursorPlugin from 'wavesurfer.cursor.js';
|
||||
*
|
||||
* // commonjs
|
||||
* var CursorPlugin = require('wavesurfer.cursor.js');
|
||||
*
|
||||
* // if you are using <script> tags
|
||||
* var CursorPlugin = window.WaveSurfer.cursor;
|
||||
*
|
||||
* // ... initialising wavesurfer with the plugin
|
||||
* var wavesurfer = WaveSurfer.create({
|
||||
* // wavesurfer options ...
|
||||
* plugins: [
|
||||
* CursorPlugin.create({
|
||||
* // plugin options ...
|
||||
* })
|
||||
* ]
|
||||
* });
|
||||
*/
|
||||
var CursorPlugin = exports["default"] = /*#__PURE__*/function () {
|
||||
/**
|
||||
* Construct the plugin class. You probably want to use `CursorPlugin.create`
|
||||
* instead.
|
||||
*
|
||||
* @param {CursorPluginParams} params Plugin parameters
|
||||
* @param {object} ws Wavesurfer instance
|
||||
*/
|
||||
function CursorPlugin(params, ws) {
|
||||
var _this = this;
|
||||
_classCallCheck(this, CursorPlugin);
|
||||
this.defaultParams = {
|
||||
hideOnBlur: true,
|
||||
width: '1px',
|
||||
color: 'black',
|
||||
opacity: '0.25',
|
||||
style: 'solid',
|
||||
zIndex: 4,
|
||||
customStyle: {},
|
||||
customShowTimeStyle: {},
|
||||
showTime: false,
|
||||
followCursorY: false,
|
||||
formatTimeCallback: null
|
||||
};
|
||||
this._onMousemove = function (e) {
|
||||
var bbox = _this.wavesurfer.container.getBoundingClientRect();
|
||||
var y = 0;
|
||||
var x = e.clientX - bbox.left;
|
||||
var flip = bbox.right < e.clientX + _this.outerWidth(_this.displayTime);
|
||||
if (_this.params.showTime && _this.params.followCursorY) {
|
||||
// follow y-position of the mouse
|
||||
y = e.clientY - (bbox.top + bbox.height / 2);
|
||||
}
|
||||
_this.updateCursorPosition(x, y, flip);
|
||||
};
|
||||
this._onMouseenter = function () {
|
||||
return _this.showCursor();
|
||||
};
|
||||
this._onMouseleave = function () {
|
||||
return _this.hideCursor();
|
||||
};
|
||||
this.wavesurfer = ws;
|
||||
this.style = ws.util.style;
|
||||
/**
|
||||
* The cursor HTML element
|
||||
*
|
||||
* @type {?HTMLElement}
|
||||
*/
|
||||
this.cursor = null;
|
||||
/**
|
||||
* displays the time next to the cursor
|
||||
*
|
||||
* @type {?HTMLElement}
|
||||
*/
|
||||
this.showTime = null;
|
||||
/**
|
||||
* The html container that will display the time
|
||||
*
|
||||
* @type {?HTMLElement}
|
||||
*/
|
||||
this.displayTime = null;
|
||||
this.params = Object.assign({}, this.defaultParams, params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Initialise the plugin (used by the Plugin API)
|
||||
*/
|
||||
_createClass(CursorPlugin, [{
|
||||
key: "init",
|
||||
value: function init() {
|
||||
this.wrapper = this.wavesurfer.container;
|
||||
this.cursor = this.wrapper.appendChild(this.style(document.createElement('cursor'), Object.assign({
|
||||
position: 'absolute',
|
||||
zIndex: this.params.zIndex,
|
||||
left: 0,
|
||||
top: 0,
|
||||
bottom: 0,
|
||||
width: '0',
|
||||
display: 'flex',
|
||||
borderRightStyle: this.params.style,
|
||||
borderRightWidth: this.params.width,
|
||||
borderRightColor: this.params.color,
|
||||
opacity: this.params.opacity,
|
||||
pointerEvents: 'none'
|
||||
}, this.params.customStyle)));
|
||||
if (this.params.showTime) {
|
||||
this.showTime = this.wrapper.appendChild(this.style(document.createElement('showTitle'), Object.assign({
|
||||
position: 'absolute',
|
||||
zIndex: this.params.zIndex,
|
||||
left: 0,
|
||||
top: 0,
|
||||
bottom: 0,
|
||||
width: 'auto',
|
||||
display: 'flex',
|
||||
opacity: this.params.opacity,
|
||||
pointerEvents: 'none',
|
||||
height: '100%'
|
||||
}, this.params.customStyle)));
|
||||
this.displayTime = this.showTime.appendChild(this.style(document.createElement('div'), Object.assign({
|
||||
display: 'inline',
|
||||
pointerEvents: 'none',
|
||||
margin: 'auto',
|
||||
visibility: 'hidden' // initial value will be hidden just for measuring purpose
|
||||
}, this.params.customShowTimeStyle)));
|
||||
// initial value to measure display width
|
||||
this.displayTime.innerHTML = this.formatTime(0);
|
||||
}
|
||||
this.wrapper.addEventListener('mousemove', this._onMousemove);
|
||||
if (this.params.hideOnBlur) {
|
||||
// ensure elements are hidden initially
|
||||
this.hideCursor();
|
||||
this.wrapper.addEventListener('mouseenter', this._onMouseenter);
|
||||
this.wrapper.addEventListener('mouseleave', this._onMouseleave);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Destroy the plugin (used by the Plugin API)
|
||||
*/
|
||||
}, {
|
||||
key: "destroy",
|
||||
value: function destroy() {
|
||||
if (this.params.showTime) {
|
||||
this.cursor.parentNode.removeChild(this.showTime);
|
||||
}
|
||||
this.cursor.parentNode.removeChild(this.cursor);
|
||||
this.wrapper.removeEventListener('mousemove', this._onMousemove);
|
||||
if (this.params.hideOnBlur) {
|
||||
this.wrapper.removeEventListener('mouseenter', this._onMouseenter);
|
||||
this.wrapper.removeEventListener('mouseleave', this._onMouseleave);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Update the cursor position
|
||||
*
|
||||
* @param {number} xpos The x offset of the cursor in pixels
|
||||
* @param {number} ypos The y offset of the cursor in pixels
|
||||
* @param {boolean} flip Flag to flip duration text from right to left
|
||||
*/
|
||||
}, {
|
||||
key: "updateCursorPosition",
|
||||
value: function updateCursorPosition(xpos, ypos) {
|
||||
var flip = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
|
||||
this.style(this.cursor, {
|
||||
left: "".concat(xpos, "px")
|
||||
});
|
||||
if (this.params.showTime) {
|
||||
var duration = this.wavesurfer.getDuration();
|
||||
var elementWidth = this.wavesurfer.drawer.width / this.wavesurfer.params.pixelRatio;
|
||||
var scrollWidth = this.wavesurfer.drawer.getScrollX();
|
||||
var scrollTime = duration / this.wavesurfer.drawer.width * scrollWidth;
|
||||
var timeValue = Math.max(0, xpos / elementWidth * duration) + scrollTime;
|
||||
var formatValue = this.formatTime(timeValue);
|
||||
if (flip) {
|
||||
var textOffset = this.outerWidth(this.displayTime);
|
||||
xpos -= textOffset;
|
||||
}
|
||||
this.style(this.showTime, {
|
||||
left: "".concat(xpos, "px"),
|
||||
top: "".concat(ypos, "px")
|
||||
});
|
||||
this.style(this.displayTime, {
|
||||
visibility: 'visible'
|
||||
});
|
||||
this.displayTime.innerHTML = "".concat(formatValue);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Show the cursor
|
||||
*/
|
||||
}, {
|
||||
key: "showCursor",
|
||||
value: function showCursor() {
|
||||
this.style(this.cursor, {
|
||||
display: 'flex'
|
||||
});
|
||||
if (this.params.showTime) {
|
||||
this.style(this.showTime, {
|
||||
display: 'flex'
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Hide the cursor
|
||||
*/
|
||||
}, {
|
||||
key: "hideCursor",
|
||||
value: function hideCursor() {
|
||||
this.style(this.cursor, {
|
||||
display: 'none'
|
||||
});
|
||||
if (this.params.showTime) {
|
||||
this.style(this.showTime, {
|
||||
display: 'none'
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Format the timestamp for `cursorTime`.
|
||||
*
|
||||
* @param {number} cursorTime Time in seconds
|
||||
* @returns {string} Formatted timestamp
|
||||
*/
|
||||
}, {
|
||||
key: "formatTime",
|
||||
value: function formatTime(cursorTime) {
|
||||
cursorTime = isNaN(cursorTime) ? 0 : cursorTime;
|
||||
if (this.params.formatTimeCallback) {
|
||||
return this.params.formatTimeCallback(cursorTime);
|
||||
}
|
||||
return [cursorTime].map(function (time) {
|
||||
return [Math.floor(time % 3600 / 60),
|
||||
// minutes
|
||||
('00' + Math.floor(time % 60)).slice(-2),
|
||||
// seconds
|
||||
('000' + Math.floor(time % 1 * 1000)).slice(-3) // milliseconds
|
||||
].join(':');
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get outer width of given element.
|
||||
*
|
||||
* @param {DOM} element DOM Element
|
||||
* @returns {number} outer width
|
||||
*/
|
||||
}, {
|
||||
key: "outerWidth",
|
||||
value: function outerWidth(element) {
|
||||
if (!element) return 0;
|
||||
var width = element.offsetWidth;
|
||||
var style = getComputedStyle(element);
|
||||
width += parseInt(style.marginLeft + style.marginRight);
|
||||
return width;
|
||||
}
|
||||
}], [{
|
||||
key: "create",
|
||||
value:
|
||||
/**
|
||||
* Cursor 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 {CursorPluginParams} params parameters use to initialise the
|
||||
* plugin
|
||||
* @return {PluginDefinition} an object representing the plugin
|
||||
*/
|
||||
function create(params) {
|
||||
return {
|
||||
name: 'cursor',
|
||||
deferInit: params && params.deferInit ? params.deferInit : false,
|
||||
params: params,
|
||||
staticProps: {},
|
||||
instance: CursorPlugin
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* @type {CursorPluginParams}
|
||||
*/
|
||||
|
||||
/**
|
||||
* @param {object} e Mouse move event
|
||||
*/
|
||||
|
||||
/**
|
||||
* @returns {void}
|
||||
*/
|
||||
|
||||
/**
|
||||
* @returns {void}
|
||||
*/
|
||||
}]);
|
||||
return CursorPlugin;
|
||||
}();
|
||||
module.exports = exports.default;
|
||||
|
||||
/***/ })
|
||||
|
||||
/******/ });
|
||||
/************************************************************************/
|
||||
/******/ // The module cache
|
||||
/******/ var __webpack_module_cache__ = {};
|
||||
/******/
|
||||
/******/ // The require function
|
||||
/******/ function __webpack_require__(moduleId) {
|
||||
/******/ // Check if module is in cache
|
||||
/******/ var cachedModule = __webpack_module_cache__[moduleId];
|
||||
/******/ if (cachedModule !== undefined) {
|
||||
/******/ return cachedModule.exports;
|
||||
/******/ }
|
||||
/******/ // Create a new module (and put it into the cache)
|
||||
/******/ var module = __webpack_module_cache__[moduleId] = {
|
||||
/******/ // no module.id needed
|
||||
/******/ // no module.loaded needed
|
||||
/******/ exports: {}
|
||||
/******/ };
|
||||
/******/
|
||||
/******/ // Execute the module function
|
||||
/******/ __webpack_modules__[moduleId](module, module.exports, __webpack_require__);
|
||||
/******/
|
||||
/******/ // Return the exports of the module
|
||||
/******/ return module.exports;
|
||||
/******/ }
|
||||
/******/
|
||||
/************************************************************************/
|
||||
/******/
|
||||
/******/ // startup
|
||||
/******/ // Load entry module and return exports
|
||||
/******/ // This entry module is referenced by other modules so it can't be inlined
|
||||
/******/ var __webpack_exports__ = __webpack_require__("./src/plugin/cursor/index.js");
|
||||
/******/
|
||||
/******/ return __webpack_exports__;
|
||||
/******/ })()
|
||||
;
|
||||
});
|
||||
//# sourceMappingURL=wavesurfer.cursor.js.map
|
||||
Loading…
Add table
Add a link
Reference in a new issue