Files
cocos4/pal/audio/minigame/player-minigame.ts
T
James Chen 37e1dcc4bd [v3.8.6] Optimize code size: audio (#18198)
* [v3.8.6] Optimize code size: mangle AudioBufferManager since it's not exported.
2025-01-16 10:15:48 +08:00

394 lines
15 KiB
TypeScript

/*
Copyright (c) 2022-2023 Xiamen Yaji Software Co., Ltd.
https://www.cocos.com/
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/
import { minigame } from 'pal/minigame';
import { systemInfo } from 'pal/system-info';
import { TAOBAO, TAOBAO_MINIGAME, HUAWEI, VIVO, OPPO } from 'internal:constants';
import { EventTarget } from '../../../cocos/core/event';
import { AudioEvent, AudioPCMDataView, AudioState, AudioType } from '../type';
import { clamp, clamp01 } from '../../../cocos/core';
import { enqueueOperation, OperationInfo, OperationQueueable } from '../operation-queue';
import { OS } from '../../system-info/enum-type';
export class OneShotAudioMinigame {
private declare _innerAudioContext: InnerAudioContext;
private _onPlayCb?: () => void;
get onPlay (): (() => void) | undefined {
return this._onPlayCb;
}
set onPlay (cb) {
this._onPlayCb = cb;
}
private _onEndCb?: () => void;
get onEnd (): (() => void) | undefined {
return this._onEndCb;
}
set onEnd (cb) {
this._onEndCb = cb;
}
private constructor (nativeAudio: InnerAudioContext, volume: number) {
this._innerAudioContext = nativeAudio;
nativeAudio.volume = volume;
nativeAudio.onPlay(() => {
this._onPlayCb?.();
});
const endCallback = (): void => {
if (this._innerAudioContext) {
// NOTE: Type 'null' is not assignable to type 'InnerAudioContext'.
this._innerAudioContext = null as any;
systemInfo.off('hide', this._onInterruptedBegin, this);
systemInfo.off('show', this._onInterruptedEnd, this);
this._onEndCb?.();
/**The destroy interface, in some platform implementations, internally invokes stop,
* triggering the onStop callback, consequently leading to an infinite loop. **/
nativeAudio.destroy();
}
};
nativeAudio.onEnded(endCallback);
nativeAudio.onStop(endCallback);//OneShotAudio can not be reused.
// event
systemInfo.on('hide', this._onInterruptedBegin, this);
systemInfo.on('show', this._onInterruptedEnd, this);
}
private _onInterruptedBegin (): void {
this._innerAudioContext.pause();
}
private _onInterruptedEnd (): void {
this._innerAudioContext.play();
}
public play (): void {
this._innerAudioContext.play();
}
public stop (): void {
this._innerAudioContext.stop();
}
}
export class AudioPlayerMinigame implements OperationQueueable {
private declare _innerAudioContext: InnerAudioContext;
private _state: AudioState = AudioState.INIT;
private _cacheTime = 0;
private _needSeek = false;
private _seeking = false;
private declare _onPlay: () => void;
private declare _onPause: () => void;
private declare _onStop: () => void;
private declare _onSeeked: () => void;
private declare _onEnded: () => void;
private _readyToHandleOnShow = false;
private _resetSeekCache (): void {
this._cacheTime = 0;
this._needSeek = false;
this._seeking = false;
if ((HUAWEI || VIVO || OPPO) && this._innerAudioContext) {
this._innerAudioContext.startTime = 0;
}
}
/**
* @deprecated since v3.5.0, this is an engine private interface that will be removed in the future.
*/
public _eventTarget: EventTarget = new EventTarget();
/**
* @deprecated since v3.5.0, this is an engine private interface that will be removed in the future.
*/
public _operationQueue: OperationInfo[] = [];
constructor (innerAudioContext: InnerAudioContext) {
const self = this;
self._innerAudioContext = innerAudioContext;
// event
systemInfo.on('hide', self._onInterruptedBegin, self);
systemInfo.on('show', self._onInterruptedEnd, self);
const eventTarget = self._eventTarget;
self._onPlay = (): void => {
self._state = AudioState.PLAYING;
eventTarget.emit(AudioEvent.PLAYED);
if (self._needSeek) {
// eslint-disable-next-line @typescript-eslint/no-empty-function
self.seek(self._cacheTime).catch((e) => {});
}
};
innerAudioContext.onPlay(self._onPlay);
self._onPause = (): void => {
self._state = AudioState.PAUSED;
try {
const currentTime = self._innerAudioContext.currentTime;
if (currentTime !== null && currentTime !== undefined) {
self._cacheTime = currentTime;
}
} catch {
// Do nothing, cacheTime is not updated.
}
eventTarget.emit(AudioEvent.PAUSED);
};
innerAudioContext.onPause(self._onPause);
self._onStop = (): void => {
self._state = AudioState.STOPPED;
// Reset all properties
self._resetSeekCache();
eventTarget.emit(AudioEvent.STOPPED);
if (TAOBAO || TAOBAO_MINIGAME) {
/**Unable to seek again after stop; After stop, regardless of whether the starttime has been set,
the playback will always start from 0 again**/
} else {
const currentTime = self._innerAudioContext ? self._innerAudioContext.currentTime : 0;
if (currentTime !== 0) {
self._innerAudioContext.seek(0);
}
}
};
innerAudioContext.onStop(self._onStop);
self._onSeeked = (): void => {
eventTarget.emit(AudioEvent.SEEKED);
self._seeking = false;
if (self._needSeek) {
self._needSeek = false;
if (self._cacheTime.toFixed(2) !== self._innerAudioContext.currentTime.toFixed(2)) {
// eslint-disable-next-line @typescript-eslint/no-empty-function
self.seek(self._cacheTime).catch((e) => {});
}
}
};
innerAudioContext.onSeeked(self._onSeeked);
self._onEnded = (): void => {
self._state = AudioState.INIT;
self._resetSeekCache();
eventTarget.emit(AudioEvent.ENDED);
};
innerAudioContext.onEnded(self._onEnded);
}
destroy (): void {
const self = this;
systemInfo.off('hide', self._onInterruptedBegin, self);
systemInfo.off('show', self._onInterruptedEnd, self);
const innerAudioContext = self._innerAudioContext;
if (innerAudioContext) {
['Play', 'Pause', 'Stop', 'Seeked', 'Ended'].forEach((event) => {
self._offEvent(event);
});
// NOTE: innerAudioContext might not stop the audio playing, have to call it explicitly.
innerAudioContext.stop();
innerAudioContext.destroy();
// NOTE: Type 'null' is not assignable to type 'InnerAudioContext'
self._innerAudioContext = null as any;
// Restore the state of the audio, otherwise it will cause 'destroy' to be called first and 'stop' to be called later.
// this will cause a error.
self._state = AudioState.INIT;
}
}
private _onInterruptedBegin (): void {
if (this._state === AudioState.PLAYING) {
this.pause().then(() => {
this._state = AudioState.INTERRUPTED;
this._readyToHandleOnShow = true;
this._eventTarget.emit(AudioEvent.INTERRUPTION_BEGIN);
// eslint-disable-next-line @typescript-eslint/no-empty-function
}).catch((e) => {});
}
}
private _onInterruptedEnd (): void {
// We don't know whether onShow or resolve callback in pause promise is called at first.
if (!this._readyToHandleOnShow) {
this._eventTarget.once(AudioEvent.INTERRUPTION_END, this._onInterruptedEnd, this);
return;
}
if (this._state === AudioState.INTERRUPTED) {
this.play().then(() => {
this._eventTarget.emit(AudioEvent.INTERRUPTION_END);
// eslint-disable-next-line @typescript-eslint/no-empty-function
}).catch((e) => {});
}
this._readyToHandleOnShow = false;
}
private _offEvent (eventName: string): void {
if (this[`_on${eventName}`]) {
this._innerAudioContext[`off${eventName}`](this[`_on${eventName}`]);
this[`_on${eventName}`] = null;
}
}
get src (): string {
return this._innerAudioContext ? this._innerAudioContext.src : '';
}
get type (): AudioType {
return AudioType.MINIGAME_AUDIO;
}
static load (url: string): Promise<AudioPlayerMinigame> {
return new Promise((resolve, reject) => {
AudioPlayerMinigame.loadNative(url).then((innerAudioContext) => {
resolve(new AudioPlayerMinigame(innerAudioContext as InnerAudioContext));
}).catch(reject);
});
}
static loadNative (url: string): Promise<unknown> {
return new Promise((resolve, reject) => {
const innerAudioContext = minigame.createInnerAudioContext();
const timer = setTimeout(() => {
clearEvent();
resolve(innerAudioContext);
}, 8000);
function clearEvent (): void {
innerAudioContext.offCanplay(success);
innerAudioContext.offError(fail);
}
function success (): void {
clearEvent();
clearTimeout(timer);
resolve(innerAudioContext);
}
function fail (err): void {
clearEvent();
clearTimeout(timer);
// eslint-disable-next-line no-console
console.error('failed to load innerAudioContext');
// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
reject(new Error(err));
}
innerAudioContext.onCanplay(success);
innerAudioContext.onError(fail);
innerAudioContext.src = url;
});
}
static loadOneShotAudio (url: string, volume: number): Promise<OneShotAudioMinigame> {
return new Promise((resolve, reject) => {
AudioPlayerMinigame.loadNative(url).then((innerAudioContext) => {
// HACK: AudioPlayer should be a friend class in OneShotAudio
// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
resolve(new (OneShotAudioMinigame as any)(innerAudioContext, volume));
}).catch(reject);
});
}
get state (): AudioState {
return this._state;
}
get loop (): boolean {
return this._innerAudioContext.loop;
}
set loop (val: boolean) {
this._innerAudioContext.loop = val;
}
get volume (): number {
return this._innerAudioContext.volume;
}
set volume (val: number) {
val = clamp01(val);
this._innerAudioContext.volume = val;
}
get duration (): number {
// KNOWN ISSUES: duration doesn't work well
// On WeChat platform, duration is 0 at the time audio is loaded.
return this._innerAudioContext.duration;
}
get currentTime (): number {
if ((HUAWEI || VIVO || OPPO) && (this._state === AudioState.STOPPED || this._state === AudioState.INIT)) {
return this._innerAudioContext.startTime;
}
if (this._state !== AudioState.PLAYING || this._needSeek || this._seeking) {
return this._cacheTime;
}
return this._innerAudioContext.currentTime;
}
get sampleRate (): number {
return 0;
}
public getPCMData (channelIndex: number): AudioPCMDataView | undefined {
return undefined;
}
@enqueueOperation
seek (time: number): Promise<void> {
return new Promise((resolve) => {
// KNOWN ISSUES: on Baidu: currentTime returns without numbers on decimal places
if (this._state === AudioState.PLAYING && !this._seeking) {
time = clamp(time, 0, this.duration);
this._seeking = true;
this._cacheTime = time;
this._eventTarget.once(AudioEvent.SEEKED, resolve);
this._innerAudioContext.seek(time);
} else {
//Huawei, vivo, Oppo platform, after stop, regardless of whether the seek has been called, the playback will always start from 0 again
if ((HUAWEI || VIVO || OPPO) && (this._state === AudioState.STOPPED || this._state === AudioState.INIT)) {
this._innerAudioContext.startTime = time;
} else if (this._cacheTime !== time) { // Skip the invalid seek
this._cacheTime = time;
this._needSeek = true;
}
resolve();
}
});
}
@enqueueOperation
play (): Promise<void> {
return new Promise((resolve) => {
this._eventTarget.once(AudioEvent.PLAYED, resolve);
this._innerAudioContext.play();
});
}
@enqueueOperation
pause (): Promise<void> {
return new Promise((resolve) => {
if (this.state !== AudioState.PLAYING) {
resolve();
} else {
this._eventTarget.once(AudioEvent.PAUSED, resolve);
this._innerAudioContext.pause();
}
});
}
@enqueueOperation
stop (): Promise<void> {
return new Promise((resolve) => {
if (AudioState.INIT === this._state) {
this._resetSeekCache();
resolve();
return;
}
this._eventTarget.once(AudioEvent.STOPPED, resolve);
this._innerAudioContext.stop();
});
}
onInterruptionBegin (cb: () => void): void { this._eventTarget.on(AudioEvent.INTERRUPTION_BEGIN, cb); }
offInterruptionBegin (cb?: () => void): void { this._eventTarget.off(AudioEvent.INTERRUPTION_BEGIN, cb); }
onInterruptionEnd (cb: () => void): void { this._eventTarget.on(AudioEvent.INTERRUPTION_END, cb); }
offInterruptionEnd (cb?: () => void): void { this._eventTarget.off(AudioEvent.INTERRUPTION_END, cb); }
onEnded (cb: () => void): void { this._eventTarget.on(AudioEvent.ENDED, cb); }
offEnded (cb?: () => void): void { this._eventTarget.off(AudioEvent.ENDED, cb); }
}