Files
ArtPlayer/packages/artplayer/src/setting/index.js
T
Harvey Zhao 99ad0d7b93 Update package.json
Remove options section from README for clarity

Add 'waiting' event emission during seeking in mediabunnyEngine

This change emits a 'waiting' event when the seeking process begins,
improving the event handling and allowing for better synchronization
during media playback.

fix(audioEngine): adjust audio context suspension timing for improved playback responsiveness

refactor(mediabunnyVideoShim): remove redundant width and height getters; enhance poster setter and add setAttribute method

feat: initialize artplayer-proxy-mediabunny with essential files and structure

feat: implement audio and video engines for mediabunny integration

- Added audioEngine.js to handle audio playback using MediaBunny.
- Created mediabunnyEngine.js to manage both audio and video playback.
- Implemented videoEngine.js for rendering video on a canvas.
- Introduced canvasProxy.js to create a canvas element and manage its methods.
- Developed mediabunnyVideoShim.js to bridge ArtPlayer and MediaBunny functionalities.
- Added videoEvents.js for custom event handling related to video playback.
- Included a utility function clamp.js for value clamping.

feat: add playback rate control to audio and video engines

- Introduced playback rate management in the audio engine, allowing dynamic adjustment of playback speed.
- Updated the mediabunny engine to expose the new setPlaybackRate method.
- Enhanced the mediabunny video shim to support playback rate adjustments, including getter and setter for playbackRate.
- Added event emission for rate changes to ensure proper handling in the application.

Enhance audio engine and video shim functionality

- Added a check to ensure the audio context is initialized before playing audio in the audio engine.
- Introduced a new 'playing' getter in the video shim to accurately reflect the playback state, indicating when the video is neither paused nor ended.

Refactor audio context initialization to handle errors and remove async/await

- Changed `ensureAudioContext` from async to synchronous to simplify error handling.
- Added a try-catch block to handle potential errors when creating the AudioContext with a specified sample rate.
- Updated calls to `ensureAudioContext` to remove unnecessary await statements.

Enhance Mediabunny Engine and Video Shim with State Management and Error Handling

- Added readyState, networkState, and error properties to the Mediabunny Engine for better state management.
- Implemented error handling during media loading, emitting appropriate events on error.
- Updated the Video Engine to emit a 'timeupdate' event for better synchronization.
- Extended the Mediabunny Video Shim to expose new properties (readyState, networkState, error) and methods for improved functionality.
- Added seekable property to the Video Shim to provide seekable range based on media duration.
- Implemented additional properties and methods in the Video Shim for autoplay, loop, controls, currentSrc, poster, preload, defaultMuted, and defaultPlaybackRate.
- Enhanced requestVideoFrameCallback and cancelVideoFrameCallback methods for better frame handling.

refactor: streamline audio and video engine implementations

- Updated audioEngine.js to improve readability and maintainability by using consistent formatting and simplifying function structures.
- Refactored mediabunnyEngine.js to enhance clarity and ensure consistent coding style.
- Enhanced videoEngine.js with improved async handling and clearer function definitions.
- Modified canvasProxy.js to maintain consistent formatting and improve readability.
- Updated mediabunnyVideoShim.js to streamline event handling and improve clarity.
- Refactored videoEvents.js for better readability and consistency in event listener management.
- Simplified clamp.js for improved readability.

feat: enhance audio and video loading with metadata callbacks

- Updated audioEngine to accept an optional onMetadata callback in the load function, which is triggered upon loading completion.
- Modified mediabunnyEngine to handle video and audio loading concurrently, emitting loadedmetadata and durationchange events only when both are ready.
- Enhanced videoEngine to include an onMetadata callback in the load function, ensuring metadata events are emitted appropriately.
- Implemented a throttling mechanism for the timeupdate event in videoEngine to reduce event emissions and improve performance.

feat: add seeking state and played property to mediabunny engine and video shim

- Introduced a `_seeking` state in the mediabunny engine to track seek operations.
- Emitted 'seeking' and 'seeked' events during seek operations.
- Added a `seeking` getter to expose the seeking state.
- Implemented a `played` property in the video shim to provide playback range information.
- Added `width` and `height` getters to the video shim for better video dimension access.
- Enhanced cross-origin handling in the video shim.

feat(audioEngine): enhance audio playback management with starvation detection

- Added an event emitter to notify when the audio context is waiting.
- Implemented a starvation check that suspends the audio context if playback is delayed.
- Introduced a mechanism to track the latest scheduled end time of audio buffers.
- Updated the handling of audio buffer playback to ensure proper state transitions.

refactor: remove unnecessary comments and streamline code in audio, video, and mediabunny engines

feat: add resize functionality to canvas proxy and update type definitions

- Implemented a resize function in canvasProxy.js to adjust canvas size based on player dimensions and video metadata.
- Updated TypeScript definitions for artplayer-proxy-mediabunny to include option and result types.
- Modified build-ts script to include all plugin type definitions.
- Added TypeScript definitions for artplayer-proxy-canvas and artplayer-proxy-mediabunny.

refactor: remove unused properties from Artplayer instance and make option parameter optional in artplayerProxyCanvas type definition

Enhance Mediabunny and Video Engine functionality

- Added event listener for 'ended' event in mediabunnyEngine to handle playback state.
- Modified seek function to check if playback should resume after seeking.
- Reset canvas dimensions to zero in videoEngine when video track is not available or cannot be decoded.
- Ensured canvas is cleared when video track is invalid to prevent rendering issues.

Emit 'waiting' event during loadstart in mediabunnyEngine

Refactor event emission in mediabunnyEngine and add sleep utility function

- Changed the event emission for 'loadstart' to be asynchronous using setTimeout.
- Introduced a new utility function 'sleep' to facilitate delayed execution in promises.

feat: enhance mediabunny proxy with new options and source handling

- Added options for event delay, load timeout, timeupdate interval, AV sync tolerance, poster, and source in README.
- Implemented source normalization in audio and video engines to support URL, Blob, and ReadableStream.
- Updated mediabunny engine to handle new options and improve load handling with timeout and error management.
- Enhanced video engine to draw a poster when no video source is available and manage playback rate.
- Modified shim to accept source option and integrate with the new engine options.
- Updated TypeScript definitions to reflect new options and source types.

feat: add dropLateFrames option to video and mediabunny engines

- Introduced dropLateFrames option in mediabunnyEngine and videoEngine to control frame dropping behavior.
- Updated videoEngine logic to handle frame rendering based on the dropLateFrames setting.
- Added type definition for dropLateFrames in TypeScript declaration file.

fix: delay loadstart event emission to ensure proper event handling

The 'loadstart' event emission is now wrapped in a setTimeout to ensure it is triggered after the current call stack is cleared. This change aims to improve the timing of event emissions and prevent potential issues with event handling in the mediabunny engine.

feat: add preflight range check and drop late frames option

- Updated README.md to include new options: dropLateFrames and preflightRange.
- Enhanced mediabunnyEngine to support new options with default values.
- Implemented preflight function in videoEngine to check server support for Range requests.
- Adjusted videoEngine to utilize preflight check before loading media.
- Updated TypeScript definitions to include preflightRange option.

Remove aspectRatio option from Artplayer configuration

Update README and mediabunny example URL for consistency

Refactor code structure for improved readability and maintainability

Update dependencies and fix play/seek state management in mediabunnyEngine

Refactor code structure for improved readability and maintainability

fix(types): update export syntax and formatting in TypeScript declaration files
2025-12-13 14:06:30 +08:00

557 lines
13 KiB
JavaScript

import {
addClass,
append,
createElement,
def,
errorHandle,
getRect,
has,
includeFromEvent,
inverseClass,
isMobile,
remove,
replaceElement,
setStyle,
} from '../utils'
import Component from '../utils/component'
import aspectRatio from './aspectRatio'
import flip from './flip'
import playbackRate from './playbackRate'
import subtitleOffset from './subtitleOffset'
export default class Setting extends Component {
constructor(art) {
super(art)
const {
option,
controls,
template: { $setting },
} = art
this.name = 'setting'
this.$parent = $setting
this.id = 0
this.active = null
this.cache = new Map()
this.option = [...this.builtin, ...option.settings]
if (option.setting) {
this.format()
this.render()
art.on('blur', () => {
if (this.show) {
this.show = false
this.render()
}
})
art.on('focus', (event) => {
const isControl = includeFromEvent(event, controls.setting)
const isSetting = includeFromEvent(event, this.$parent)
if (this.show && !isControl && !isSetting) {
this.show = false
this.render()
}
})
art.on('resize', () => this.resize())
}
}
get builtin() {
const result = []
const { option } = this.art
if (option.playbackRate) {
result.push(playbackRate(this.art))
}
if (option.aspectRatio) {
result.push(aspectRatio(this.art))
}
if (option.flip) {
result.push(flip(this.art))
}
if (option.subtitleOffset) {
result.push(subtitleOffset(this.art))
}
return result
}
traverse(callback, option = this.option) {
for (let index = 0; index < option.length; index++) {
const item = option[index]
callback(item)
if (item.selector?.length) {
this.traverse(callback, item.selector)
}
}
}
check(target) {
if (!target) {
return
}
target.$parent.tooltip = target.html
this.traverse((item) => {
item.default = item === target
if (item.default && item.$item) {
inverseClass(item.$item, 'art-current')
}
}, target.$option)
this.render(target.$parents)
}
format(option = this.option, parent, parents, names = []) {
for (let index = 0; index < option.length; index++) {
const item = option[index]
if (item?.name) {
errorHandle(!names.includes(item.name), `The [${item.name}] already exists in [setting]`)
names.push(item.name)
}
else {
item.name = `setting-${this.id++}`
}
if (!item.$formatted) {
def(item, '$parent', {
get: () => parent,
})
def(item, '$parents', {
get: () => parents,
})
def(item, '$option', {
get: () => option,
})
const $events = []
def(item, '$events', {
get: () => $events,
})
def(item, '$formatted', {
get: () => true,
})
}
this.format(item.selector || [], item, option, names)
}
this.option = option
}
find(name = '') {
let result = null
this.traverse((item) => {
if (item.name === name) {
result = item
}
})
return result
}
resize() {
const {
controls,
constructor: { SETTING_WIDTH, SETTING_ITEM_HEIGHT },
template: { $player, $setting },
} = this.art
if (controls.setting && this.show) {
const settingWidth = this.active[0]?.$parent?.width || SETTING_WIDTH
const { left: controlLeft, width: controlWidth } = getRect(controls.setting)
const { left: playerLeft, width: playerWidth } = getRect($player)
const settingLeft = controlLeft - playerLeft + controlWidth / 2 - settingWidth / 2
const settingHeight
= this.active === this.option
? this.active.length * SETTING_ITEM_HEIGHT
: (this.active.length + 1) * SETTING_ITEM_HEIGHT
setStyle($setting, 'height', `${settingHeight}px`)
setStyle($setting, 'width', `${settingWidth}px`)
if (this.art.isRotate || isMobile)
return
if (settingLeft + settingWidth > playerWidth) {
setStyle($setting, 'left', null)
setStyle($setting, 'right', null)
}
else {
setStyle($setting, 'left', `${settingLeft}px`)
setStyle($setting, 'right', 'auto')
}
}
}
inactivate(item) {
for (let index = 0; index < item.$events.length; index++) {
this.art.events.remove(item.$events[index])
}
item.$events.length = 0
}
remove(name) {
const item = this.find(name)
errorHandle(item, `Can't find [${name}] in the [setting]`)
const index = item.$option.indexOf(item)
item.$option.splice(index, 1)
this.inactivate(item)
if (item.$item)
remove(item.$item)
this.render()
}
update(target) {
const item = this.find(target.name)
if (item) {
this.inactivate(item)
Object.assign(item, target)
this.format()
this.createItem(item, true)
this.render()
return item
}
else {
return this.add(target)
}
}
add(item, option = this.option) {
option.push(item)
this.format()
this.createItem(item)
this.render()
return item
}
createHeader(item) {
if (!this.cache.has(item.$option))
return
const $panel = this.cache.get(item.$option)
const {
proxy,
icons: { arrowLeft },
constructor: { SETTING_ITEM_HEIGHT },
} = this.art
const $item = createElement('div')
setStyle($item, 'height', `${SETTING_ITEM_HEIGHT}px`)
addClass($item, 'art-setting-item')
addClass($item, 'art-setting-item-back')
const $left = append($item, '<div class="art-setting-item-left"></div>')
const $icon = createElement('div')
addClass($icon, 'art-setting-item-left-icon')
append($icon, arrowLeft)
append($left, $icon)
append($left, item.$parent.html)
const event = proxy($item, 'click', () => this.render(item.$parents))
item.$parent.$events.push(event)
append($panel, $item)
}
createItem(item, isUpdate = false) {
if (!this.cache.has(item.$option))
return
const $panel = this.cache.get(item.$option)
const oldItem = item.$item
let type = 'selector'
if (has(item, 'switch')) {
type = 'switch'
}
if (has(item, 'range')) {
type = 'range'
}
if (has(item, 'onClick')) {
type = 'button'
}
const { icons, proxy, constructor } = this.art
const $item = createElement('div')
addClass($item, 'art-setting-item')
setStyle($item, 'height', `${constructor.SETTING_ITEM_HEIGHT}px`)
$item.dataset.name = item.name || ''
$item.dataset.value = item.value || ''
const $left = append($item, '<div class="art-setting-item-left"></div>')
const $right = append($item, '<div class="art-setting-item-right"></div>')
const $icon = createElement('div')
addClass($icon, 'art-setting-item-left-icon')
switch (type) {
case 'button':
case 'switch':
case 'range':
append($icon, item.icon || icons.config)
break
case 'selector':
if (item.selector?.length) {
append($icon, item.icon || icons.config)
}
else {
append($icon, icons.check)
}
break
default:
break
}
append($left, $icon)
def(item, '$icon', {
configurable: true,
get: () => $icon,
})
def(item, 'icon', {
configurable: true,
get() {
return $icon.innerHTML
},
set(value) {
$icon.innerHTML = ''
append($icon, value)
},
})
const $html = createElement('div')
addClass($html, 'art-setting-item-left-text')
append($html, item.html || '')
append($left, $html)
def(item, '$html', {
configurable: true,
get: () => $html,
})
def(item, 'html', {
configurable: true,
get() {
return $html.innerHTML
},
set(value) {
$html.innerHTML = ''
append($html, value)
},
})
const $tooltip = createElement('div')
addClass($tooltip, 'art-setting-item-right-tooltip')
append($tooltip, item.tooltip || '')
append($right, $tooltip)
def(item, '$tooltip', {
configurable: true,
get: () => $tooltip,
})
def(item, 'tooltip', {
configurable: true,
get() {
return $tooltip.innerHTML
},
set(value) {
$tooltip.innerHTML = ''
append($tooltip, value)
},
})
switch (type) {
case 'switch': {
const $switch = createElement('div')
addClass($switch, 'art-setting-item-right-icon')
const $switchOn = append($switch, icons.switchOn)
const $switchOff = append($switch, icons.switchOff)
setStyle(item.switch ? $switchOff : $switchOn, 'display', 'none')
append($right, $switch)
def(item, '$switch', {
configurable: true,
get: () => $switch,
})
let $switchValue = item.switch
def(item, 'switch', {
configurable: true,
get: () => $switchValue,
set(value) {
$switchValue = value
if (value) {
setStyle($switchOff, 'display', 'none')
setStyle($switchOn, 'display', null)
}
else {
setStyle($switchOff, 'display', null)
setStyle($switchOn, 'display', 'none')
}
},
})
break
}
case 'range':
{
const $state = createElement('div')
addClass($state, 'art-setting-item-right-icon')
const $range = append($state, '<input type="range">')
$range.value = item.range[0]
$range.min = item.range[1]
$range.max = item.range[2]
$range.step = item.range[3]
addClass($range, 'art-setting-range')
append($right, $state)
def(item, '$range', {
configurable: true,
get: () => $range,
})
let $rangeValue = [...item.range]
def(item, 'range', {
configurable: true,
get: () => $rangeValue,
set(value) {
$rangeValue = [...value]
$range.value = value[0]
$range.min = value[1]
$range.max = value[2]
$range.step = value[3]
},
})
}
break
case 'selector':
if (item.selector?.length) {
const $state = createElement('div')
addClass($state, 'art-setting-item-right-icon')
append($state, icons.arrowRight)
append($right, $state)
}
break
default:
break
}
switch (type) {
case 'switch': {
if (item.onSwitch) {
const event = proxy($item, 'click', async (event) => {
item.switch = await item.onSwitch.call(this.art, item, $item, event)
})
item.$events.push(event)
}
break
}
case 'range': {
if (item.$range) {
if (item.onRange) {
const event = proxy(item.$range, 'change', async (event) => {
item.range[0] = item.$range.valueAsNumber
item.tooltip = await item.onRange.call(this.art, item, $item, event)
})
item.$events.push(event)
}
if (item.onChange) {
const event = proxy(item.$range, 'input', async (event) => {
item.range[0] = item.$range.valueAsNumber
item.tooltip = await item.onChange.call(this.art, item, $item, event)
})
item.$events.push(event)
}
}
break
}
case 'selector':
{
const event = proxy($item, 'click', async (event) => {
if (item.selector?.length) {
this.render(item.selector)
}
else {
this.check(item)
if (item.$parent.onSelect) {
item.$parent.tooltip = await item.$parent.onSelect.call(this.art, item, $item, event)
}
}
})
item.$events.push(event)
if (item.default) {
addClass($item, 'art-current')
}
}
break
case 'button':
if (item.onClick) {
const event = proxy($item, 'click', async (event) => {
item.tooltip = await item.onClick.call(this.art, item, $item, event)
})
item.$events.push(event)
}
break
default:
break
}
def(item, '$item', {
configurable: true,
get: () => $item,
})
if (isUpdate) {
replaceElement($item, oldItem)
}
else {
append($panel, $item)
}
if (item.mounted) {
setTimeout(() => item.mounted.call(this.art, item.$item, item), 0)
}
}
render(option = this.option) {
this.active = option
if (this.cache.has(option)) {
const $panel = this.cache.get(option)
inverseClass($panel, 'art-current')
}
else {
const $panel = createElement('div')
this.cache.set(option, $panel)
addClass($panel, 'art-setting-panel')
append(this.$parent, $panel)
inverseClass($panel, 'art-current')
if (option[0]?.$parent) {
this.createHeader(option[0])
}
for (let index = 0; index < option.length; index++) {
this.createItem(option[index])
}
}
this.resize()
}
}