/*=============================================================================
 AudioCache.js
----------------------------------------------------------------------------
 (C)2024 Triacontane
 This software is released under the MIT License.
 http://opensource.org/licenses/mit-license.php
----------------------------------------------------------------------------
 Version
 1.0.0 2024/04/17 初版
----------------------------------------------------------------------------
 [Blog]   : https://triacontane.blogspot.jp/
 [Twitter]: https://twitter.com/triacontane/
 [GitHub] : https://github.com/triacontane/
=============================================================================*/

/*:
@target MZ
@url https://github.com/triacontane/RPGMakerMV/tree/mz_master/AudioCache.js
@plugindesc Audio Cache Plug-in
@author Triacontane
@license MIT License

@help
English Help Translator: munokura
This is an unofficial English translation of the plugin help,
created to support global RPG Maker users.
Feedback is welcome to improve translation quality
(see: https://github.com/munokura/triacontane-MZ-plugins ).
Original plugin by Triacontane.
Please check the latest official version at:
https://triacontane.blogspot.com
-----

AudioCache.js

Pre-creates and caches a buffer for the specified audio file.
Caching ensures lag-free playback.
However, sound effects cannot be cached.

To minimize performance impact, only one file per category (e.g., BGM) can be
cached at a time.

The cache is discarded once playback finishes.

This plugin requires the base plugin "PluginCommonBase.js."
"PluginCommonBase.js" is located in the following folder
in the RPG Maker MZ installation folder:
dlc/BasicResources/plugins/official

Terms of Use:
You may modify and redistribute this plugin without permission, and there are
no restrictions on its use (commercial, 18+, etc.).
This plugin is now yours.

@param outputLog
@text Log Output
@desc During test play, a log is output when creating or destroying a cache.
@type boolean
@default true

@command CACHE_AUDIO
@text Audio Cache
@desc Pre-creates and caches a buffer for the specified audio file.
@arg file
@text File name
@desc The name of the audio file to cache. SE files cannot be cached.
@type file
@dir audio
*/

/*:ja
@plugindesc オーディオキャッシュプラグイン
@target MZ
@url https://github.com/triacontane/RPGMakerMV/tree/mz_master/AudioCache.js
@base PluginCommonBase
@orderAfter PluginCommonBase
@author トリアコンタン

@param outputLog
@text ログ出力
@desc テストプレー時、キャッシュの作成や破棄時にログを出力します。
@default true
@type boolean

@command CACHE_AUDIO
@text オーディオキャッシュ
@desc 指定したオーディオファイルのバッファを事前に作成してキャッシュします。

@arg file
@text ファイル名
@desc キャッシュするオーディオファイル名です。SEのキャッシュはできません。
@default
@type file
@dir audio

@help AudioCache.js

指定したオーディオファイルのバッファを事前に作成してキャッシュします。
キャッシュしておけば実際に演奏するときにタイムラグなしで演奏されます。
ただし、SEのキャッシュはできません。

パフォーマンス上の影響を最小限にするため、一度にキャッシュできるファイルは
BGMなどのカテゴリごとにひとつだけです。
また、演奏が終わったタイミングでキャッシュは破棄されます。

このプラグインの利用にはベースプラグイン『PluginCommonBase.js』が必要です。
『PluginCommonBase.js』は、RPGツクールMZのインストールフォルダ配下の
以下のフォルダに格納されています。
dlc/BasicResources/plugins/official

利用規約：
 作者に無断で改変、再配布が可能で、利用形態（商用、18禁利用等）
 についても制限はありません。
 このプラグインはもうあなたのものです。
*/

(() => {
    'use strict';
    const script = document.currentScript;
    const param = PluginManagerEx.createParameter(script);

    PluginManagerEx.registerCommand(script, 'CACHE_AUDIO', args => {
        AudioManager.cacheBuffer(args.file);
    });

    AudioManager._cacheBuffers = {};

    AudioManager.cacheBuffer = function(path) {
        const pathList = path.split('/');
        const folder = pathList.shift() + '/';
        const name = pathList.join('/');
        if (name && !this.isExistCache(folder, name)) {
            this.clearCache(folder);
            this._cacheBuffers[folder] = this.createBuffer(folder, name);
            this.outputCacheLog(`create : ${folder}${name}`);
        }
    };

    AudioManager.clearCache = function(folder) {
        this._cacheBuffers[folder] = null;
        this.outputCacheLog(`clear : ${folder}`);
    };

    const _AudioManager_createBuffer = AudioManager.createBuffer;
    AudioManager.createBuffer = function(folder, name) {
        if (this.isExistCache(folder, name)) {
            this.outputCacheLog(`load form cache : ${folder}${name}`);
            return this._cacheBuffers[folder];
        } else {
            return _AudioManager_createBuffer.apply(this, arguments);
        }
    };

    AudioManager.outputCacheLog = function(value) {
        if (Utils.isOptionValid('test') && param.outputLog) {
            console.log(`AudioCache ${value}`);
        }
    }

    AudioManager.isExistCache = function (folder, name) {
        return this._cacheBuffers[folder]?.name === name;
    };

    const _WebAudio_prototype_destroy = WebAudio.prototype.destroy;
    WebAudio.prototype.destroy = function() {
        const folder = this._url.split('/')[1] + '/';
        if (AudioManager.isExistCache(folder, this.name)) {
            AudioManager.clearCache(folder);
        }
        _WebAudio_prototype_destroy.apply(this, arguments);
    };
})();