@next2d/player 1.14.7 → 1.14.8

package/dist/player/next2d/media/Sound.js

@@ -0,0 +1,515 @@
+import { EventDispatcher } from "../events/EventDispatcher";
+import { URLRequest } from "../net/URLRequest";
+import { SoundMixer } from "./SoundMixer";
+import { Event as Next2DEvent } from "../events/Event";
+import { IOErrorEvent } from "../events/IOErrorEvent";
+import { ProgressEvent as Next2DProgressEvent } from "../events/ProgressEvent";
+import { $Math, $performance, $requestAnimationFrame, $clamp, $getArray } from "../../util/RenderUtil";
+import { $ajax, $audioContext, $audios, $currentPlayer, $decodeAudioData } from "../../util/Util";
+/**
+ * Sound クラスを使用すると、アプリケーション内のサウンドを処理することができます。
+ * Sound クラスを使用すると、Sound オブジェクトの作成や、外部 MP3 ファイルのオブジェクトへのロードと再生ができます。
+ *
+ * The Sound class lets you work with sound in an application.
+ * The Sound class lets you create a Sound object,
+ * load and play an external MP3 file into that object.
+ *
+ * @class
+ * @memberOf next2d.media
+ * @extends  EventDispatcher
+ */
+export class Sound extends EventDispatcher {
+    _$sources;
+    _$bytesLoaded;
+    _$bytesTotal;
+    _$volume;
+    _$currentCount;
+    _$src;
+    _$loopCount;
+    _$stopFlag;
+    _$character;
+    _$audioBuffer;
+    _$arrayBuffer;
+    /**
+     * @constructor
+     * @public
+     */
+    constructor() {
+        super();
+        /**
+         * @type {number}
+         * @default 0
+         * @private
+         */
+        this._$bytesLoaded = 0;
+        /**
+         * @type {number}
+         * @default 0
+         * @private
+         */
+        this._$bytesTotal = 0;
+        /**
+         * @type {AudioBuffer}
+         * @default null
+         * @private
+         */
+        this._$arrayBuffer = null;
+        /**
+         * @type {Uint8Array}
+         * @default null
+         * @private
+         */
+        this._$audioBuffer = null;
+        /**
+         * @type {object}
+         * @default null
+         * @private
+         */
+        this._$character = null;
+        /**
+         * @type {array}
+         * @private
+         */
+        this._$sources = $getArray();
+        /**
+         * @type {number}
+         * @default 1
+         * @private
+         */
+        this._$volume = 1;
+        /**
+         * @type {number}
+         * @default 0
+         * @private
+         */
+        this._$currentCount = 0;
+        /**
+         * @type {number}
+         * @default 0
+         * @private
+         */
+        this._$loopCount = 0;
+        /**
+         * @type {boolean}
+         * @default true
+         * @private
+         */
+        this._$stopFlag = true;
+        /**
+         * @type {string}
+         * @default ""
+         * @private
+         */
+        this._$src = "";
+    }
+    /**
+     * @description 指定されたクラスのストリングを返します。
+     *              Returns the string representation of the specified class.
+     *
+     * @return  {string}
+     * @default [class Sound]
+     * @method
+     * @static
+     */
+    static toString() {
+        return "[class Sound]";
+    }
+    /**
+     * @description 指定されたクラスの空間名を返します。
+     *              Returns the space name of the specified class.
+     *
+     * @return  {string}
+     * @default next2d.media.Sound
+     * @const
+     * @static
+     */
+    static get namespace() {
+        return "next2d.media.Sound";
+    }
+    /**
+     * @description 指定されたオブジェクトのストリングを返します。
+     *              Returns the string representation of the specified object.
+     *
+     * @return  {string}
+     * @default [object Sound]
+     * @method
+     * @public
+     */
+    toString() {
+        return "[object Sound]";
+    }
+    /**
+     * @description 指定されたオブジェクトの空間名を返します。
+     *              Returns the space name of the specified object.
+     *
+     * @return  {string}
+     * @default next2d.media.Sound
+     * @const
+     * @public
+     */
+    get namespace() {
+        return "next2d.media.Sound";
+    }
+    /**
+     * @description 既にアプリケーションにロードされているデータのバイト数です。
+     *              The number of bytes of data that have been loaded into the application.
+     *
+     * @member {number}
+     * @default 0
+     * @readonly
+     * @public
+     */
+    get bytesLoaded() {
+        return this._$bytesLoaded;
+    }
+    /**
+     * @description アプリケーションにロードされるファイルの総バイト数。
+     *              The total size in bytes of the file being loaded into the application.
+     *
+     * @member {number}
+     * @default 0
+     * @readonly
+     * @public
+     */
+    get bytesTotal() {
+        return this._$bytesTotal;
+    }
+    /**
+     * @description ループ回数の設定
+     *              Loop count setting.
+     *
+     * @member {number}
+     * @default 0
+     * @public
+     */
+    get loopCount() {
+        return this._$loopCount;
+    }
+    set loopCount(loop_count) {
+        this._$loopCount = loop_count;
+    }
+    /**
+     * @description 外部サウンドのURL
+     *              URL for external sound.
+     *
+     * @member {string}
+     * @default ""
+     * @public
+     */
+    get src() {
+        return this._$src;
+    }
+    set src(url) {
+        this.load(new URLRequest(url));
+    }
+    /**
+     * @description ボリュームです。範囲は 0（無音）～ 1（フルボリューム）です。
+     *              The volume, ranging from 0 (silent) to 1 (full volume).
+     *
+     * @member {number}
+     * @default 1
+     * @public
+     */
+    get volume() {
+        return this._$volume;
+    }
+    set volume(volume) {
+        this._$volume = $Math.min(SoundMixer.volume, $clamp(volume, 0, 1, 1));
+        const length = this._$sources.length;
+        if (length && $audioContext) {
+            for (let idx = 0; idx < length; ++idx) {
+                const source = this._$sources[idx];
+                if (source._$gainNode) {
+                    source._$gainNode.gain.value = this._$volume;
+                    source._$volume = this._$volume;
+                }
+            }
+        }
+    }
+    /**
+     * @description Sound クラスを複製します。
+     *              Duplicate the Sound class.
+     *
+     * @return {Sound}
+     * @method
+     * @public
+     */
+    clone() {
+        const sound = new Sound();
+        sound.volume = this.volume;
+        sound._$loopCount = this._$loopCount;
+        if (this._$character) {
+            sound._$character = this._$character;
+        }
+        else {
+            sound._$audioBuffer = this._$audioBuffer;
+        }
+        return sound;
+    }
+    /**
+     * @description 指定した URL から外部 MP3 ファイルのロードを開始します。
+     *              Initiates loading of an external MP3 file from the specified URL.
+     *
+     * @param {URLRequest} request
+     * @return {void}
+     * @method
+     * @public
+     */
+    load(request) {
+        this._$src = request.url;
+        $ajax({
+            "format": "arraybuffer",
+            "url": request.url,
+            "method": request.method,
+            "data": request.data,
+            "headers": request.headers,
+            "withCredentials": request.withCredentials,
+            "event": {
+                "loadstart": (event) => {
+                    this._$loadStart(event);
+                },
+                "progress": (event) => {
+                    this._$progress(event);
+                },
+                "loadend": (event) => {
+                    this._$loadEnd(event);
+                }
+            }
+        });
+    }
+    /**
+     * @param  {ProgressEvent} event
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$loadStart(event) {
+        this._$bytesLoaded = event.loaded;
+        this._$bytesTotal = event.total;
+        if (this.willTrigger(Next2DEvent.OPEN)) {
+            this.dispatchEvent(new Next2DEvent(Next2DEvent.OPEN));
+        }
+        if (this.willTrigger(Next2DProgressEvent.PROGRESS)) {
+            this.dispatchEvent(new Next2DProgressEvent(Next2DProgressEvent.PROGRESS, false, false, event.loaded, event.total));
+        }
+    }
+    /**
+     * @param  {ProgressEvent} event
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$progress(event) {
+        this._$bytesLoaded = event.loaded;
+        this._$bytesTotal = event.total;
+        if (this.willTrigger(Next2DProgressEvent.PROGRESS)) {
+            this.dispatchEvent(new Next2DProgressEvent(Next2DProgressEvent.PROGRESS, false, false, event.loaded, event.total));
+        }
+    }
+    /**
+     * @param  {ProgressEvent} event
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$loadEnd(event) {
+        this._$bytesLoaded = event.loaded;
+        this._$bytesTotal = event.total;
+        if (this.willTrigger(Next2DProgressEvent.PROGRESS)) {
+            this.dispatchEvent(new Next2DProgressEvent(Next2DProgressEvent.PROGRESS, false, false, event.loaded, event.total));
+        }
+        const target = event.target;
+        if (!target) {
+            throw new Error("the Sound target is null.");
+        }
+        if (199 < target.status && 400 > target.status) {
+            this._$arrayBuffer = target.response;
+            if ($audioContext) {
+                $decodeAudioData(this)
+                    .then((sound) => {
+                    if (sound.hasEventListener(Next2DEvent.INIT)
+                        || sound.hasEventListener(Next2DEvent.COMPLETE)) {
+                        const player = $currentPlayer();
+                        player._$loaders.push(sound);
+                    }
+                });
+            }
+            else {
+                $audios.push(this);
+            }
+        }
+        else {
+            if (this.willTrigger(IOErrorEvent.IO_ERROR)) {
+                this.dispatchEvent(new IOErrorEvent(IOErrorEvent.IO_ERROR, false, false, target.statusText));
+            }
+        }
+    }
+    /**
+     * @description サウンドを再生します。
+     *              Play a sound.
+     *
+     * @param   {number} [start_time=0]
+     * @return  {void}
+     * @method
+     * @public
+     */
+    play(start_time = 0) {
+        const buffer = this._$character
+            ? this._$character.audioBuffer
+            : this._$audioBuffer;
+        // execute
+        if (!$audioContext || !buffer) {
+            const now = $performance.now();
+            const wait = () => {
+                const buffer = this._$character
+                    ? this._$character.audioBuffer
+                    : this._$audioBuffer;
+                if (buffer !== null && $audioContext !== null) {
+                    const offset = ($performance.now() - now) / 1000;
+                    this._$createBufferSource(start_time, offset);
+                    return;
+                }
+                $requestAnimationFrame(wait);
+            };
+            $requestAnimationFrame(wait);
+        }
+        else {
+            this._$createBufferSource(start_time);
+        }
+    }
+    /**
+     * @description チャンネルで再生しているサウンドを停止します。
+     *              Stops the sound playing in the channel.
+     *
+     * @return {void}
+     * @method
+     * @public
+     */
+    stop() {
+        this._$stopFlag = true;
+        const length = this._$sources.length;
+        if (length) {
+            const player = $currentPlayer();
+            if ($audioContext) {
+                for (let idx = 0; idx < length; ++idx) {
+                    const source = this._$sources[idx];
+                    if (source._$gainNode) {
+                        source._$gainNode.gain.value = 0;
+                        source._$gainNode.disconnect();
+                        source._$gainNode = null;
+                    }
+                    source.onended = null;
+                    source.disconnect();
+                }
+            }
+            player._$sources.splice(player._$sources.indexOf(this), 1);
+            this._$currentCount = 0;
+            this._$sources.length = 0;
+        }
+    }
+    /**
+     * @param  {object} tag
+     * @param  {MovieClip} parent
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$build(tag, parent) {
+        const loaderInfo = parent.loaderInfo;
+        if (!loaderInfo || !loaderInfo._$data) {
+            throw new Error("the loaderInfo or data is null.");
+        }
+        this._$character = loaderInfo
+            ._$data
+            .characters[tag.characterId];
+        if (!this._$character) {
+            throw new Error("character is null.");
+        }
+        // load AudioBuffer
+        if (!this._$character.audioBuffer) {
+            if ($audioContext) {
+                $decodeAudioData(this)
+                    .then((sound) => {
+                    if (sound.hasEventListener(Next2DEvent.INIT)
+                        || sound.hasEventListener(Next2DEvent.COMPLETE)) {
+                        const player = $currentPlayer();
+                        player._$loaders.push(sound);
+                    }
+                });
+            }
+            else {
+                $audios.push(this);
+            }
+        }
+        this._$loopCount = tag.loopCount | 0;
+        this._$volume = $Math.min(SoundMixer.volume, tag.volume);
+    }
+    /**
+     * @param  {number}  [start_time=0]
+     * @param  {number}  [offset=0]
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$createBufferSource(start_time = 0, offset = 0) {
+        if (!$audioContext) {
+            throw new Error("the Audio Context is null.");
+        }
+        // setup
+        const source = $audioContext.createBufferSource();
+        source.onended = (event) => {
+            return this._$endEventHandler(event);
+        };
+        // main
+        source.buffer = this._$character
+            ? this._$character.audioBuffer
+            : this._$audioBuffer;
+        source._$gainNode = $audioContext.createGain();
+        source._$gainNode.connect($audioContext.destination);
+        const volume = $Math.min(SoundMixer.volume, this._$volume);
+        source._$gainNode.gain.value = volume;
+        source._$volume = volume;
+        source.connect(source._$gainNode);
+        source.start(start_time | 0, offset);
+        const player = $currentPlayer();
+        if (player._$sources.indexOf(this) === -1) {
+            player._$sources.push(this);
+        }
+        this._$sources.push(source);
+        this._$stopFlag = false;
+    }
+    /**
+     * @param  {Event} event
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$endEventHandler(event) {
+        const source = event.target;
+        this._$sources.splice(this._$sources.indexOf(source), 1);
+        if (!this._$stopFlag && this._$loopCount > this._$currentCount) {
+            this._$createBufferSource();
+            this._$currentCount++;
+        }
+        else {
+            this._$currentCount = 0;
+            if ($audioContext) {
+                if (source._$gainNode) {
+                    source._$gainNode.gain.value = 0;
+                    source._$gainNode.disconnect();
+                    source._$gainNode = null;
+                }
+                // Firefoxにて、disconnectした時にonendedが呼び出されるのを回避
+                source.onended = null;
+                source.disconnect();
+            }
+            if (!this._$sources.length) {
+                const player = $currentPlayer();
+                player._$sources.splice(player._$sources.indexOf(this), 1);
+            }
+            if (this.willTrigger(Next2DEvent.SOUND_COMPLETE)) {
+                this.dispatchEvent(new Next2DEvent(Next2DEvent.SOUND_COMPLETE));
+            }
+        }
+    }
+}

package/dist/player/next2d/media/SoundMixer.d.ts

@@ -0,0 +1,68 @@
+/**
+ * SoundMixer クラスには、静的プロパティやアプリケーションのグローバルサウンドコントロールのメソッドが含まれます。
+ * SoundMixer クラスは、アプリケーションの埋め込みおよびストリーミングサウンド、及び、Video クラスの音声を制御します。
+ *
+ * @class
+ * @memberOf next2d.media
+ */
+export declare class SoundMixer {
+    /**
+     * @description 指定されたクラスのストリングを返します。
+     *              Returns the string representation of the specified class.
+     *
+     * @return  {string}
+     * @default [class SoundMixer]
+     * @method
+     * @static
+     */
+    static toString(): string;
+    /**
+     * @description 指定されたクラスの空間名を返します。
+     *              Returns the space name of the specified class.
+     *
+     * @return  {string}
+     * @default next2d.media.SoundMixer
+     * @const
+     * @static
+     */
+    static get namespace(): string;
+    /**
+     * @description 指定されたオブジェクトのストリングを返します。
+     *              Returns the string representation of the specified object.
+     *
+     * @return  {string}
+     * @default [object SoundMixer]
+     * @method
+     * @public
+     */
+    toString(): string;
+    /**
+     * @description 指定されたオブジェクトの空間名を返します。
+     *              Returns the space name of the specified object.
+     *
+     * @return  {string}
+     * @default next2d.media.SoundMixer
+     * @const
+     * @public
+     */
+    get namespace(): string;
+    /**
+     * @description ボリュームです。範囲は 0（無音）～ 1（フルボリューム）です。
+     *              The volume, ranging from 0 (silent) to 1 (full volume).
+     *
+     * @member {number}
+     * @default 1
+     * @static
+     */
+    static get volume(): number;
+    static set volume(volume: number);
+    /**
+     * @description 再生中のサウンドとビデオをすべて停止します。
+     *              Stops all sound and video that is playing.
+     *
+     * @return {void}
+     * @method
+     * @static
+     */
+    static stopAll(): void;
+}

package/dist/player/next2d/media/SoundMixer.js

@@ -0,0 +1,115 @@
+import { $currentPlayer } from "../../util/Util";
+import { $clamp, $Math } from "../../util/RenderUtil";
+import { $getSoundMixerVolume, $setSoundMixerVolume } from "../../util/Global";
+/**
+ * SoundMixer クラスには、静的プロパティやアプリケーションのグローバルサウンドコントロールのメソッドが含まれます。
+ * SoundMixer クラスは、アプリケーションの埋め込みおよびストリーミングサウンド、及び、Video クラスの音声を制御します。
+ *
+ * @class
+ * @memberOf next2d.media
+ */
+export class SoundMixer {
+    /**
+     * @description 指定されたクラスのストリングを返します。
+     *              Returns the string representation of the specified class.
+     *
+     * @return  {string}
+     * @default [class SoundMixer]
+     * @method
+     * @static
+     */
+    static toString() {
+        return "[class SoundMixer]";
+    }
+    /**
+     * @description 指定されたクラスの空間名を返します。
+     *              Returns the space name of the specified class.
+     *
+     * @return  {string}
+     * @default next2d.media.SoundMixer
+     * @const
+     * @static
+     */
+    static get namespace() {
+        return "next2d.media.SoundMixer";
+    }
+    /**
+     * @description 指定されたオブジェクトのストリングを返します。
+     *              Returns the string representation of the specified object.
+     *
+     * @return  {string}
+     * @default [object SoundMixer]
+     * @method
+     * @public
+     */
+    toString() {
+        return "[object SoundMixer]";
+    }
+    /**
+     * @description 指定されたオブジェクトの空間名を返します。
+     *              Returns the space name of the specified object.
+     *
+     * @return  {string}
+     * @default next2d.media.SoundMixer
+     * @const
+     * @public
+     */
+    get namespace() {
+        return "next2d.media.SoundMixer";
+    }
+    /**
+     * @description ボリュームです。範囲は 0（無音）～ 1（フルボリューム）です。
+     *              The volume, ranging from 0 (silent) to 1 (full volume).
+     *
+     * @member {number}
+     * @default 1
+     * @static
+     */
+    static get volume() {
+        return $getSoundMixerVolume();
+    }
+    static set volume(volume) {
+        $setSoundMixerVolume($clamp(volume, 0, 1, 1));
+        const soundMixerVolume = $getSoundMixerVolume();
+        const player = $currentPlayer();
+        const sounds = player._$sources;
+        for (let idx = 0; idx < sounds.length; ++idx) {
+            const sound = sounds[idx];
+            for (let idx = 0; idx < sound._$sources.length; ++idx) {
+                const source = sound._$sources[idx];
+                if (source._$gainNode) {
+                    source._$gainNode.gain.value = $Math.min(soundMixerVolume, source._$volume);
+                }
+            }
+        }
+        const videos = player._$videos;
+        for (let idx = 0; idx < videos.length; ++idx) {
+            const video = videos[idx];
+            if (video._$video) {
+                video._$video.volume = $Math.min(soundMixerVolume, video.volume);
+            }
+        }
+    }
+    /**
+     * @description 再生中のサウンドとビデオをすべて停止します。
+     *              Stops all sound and video that is playing.
+     *
+     * @return {void}
+     * @method
+     * @static
+     */
+    static stopAll() {
+        const player = $currentPlayer();
+        // sounds
+        const sources = player._$sources;
+        for (let idx = 0; idx < sources.length; ++idx) {
+            sources[idx].stop();
+        }
+        const videos = player._$videos;
+        for (let idx = 0; idx < videos.length; ++idx) {
+            videos[idx].pause();
+        }
+        player._$sources.length = 0;
+        player._$videos.length = 0;
+    }
+}