@next2d/media 1.18.12 → 2.0.0

package/src/Sound.d.ts

@@ -0,0 +1,136 @@
+import type { ISoundCharacter } from "./interface/ISoundCharacter";
+import type { URLRequest } from "@next2d/net";
+import { EventDispatcher } from "@next2d/events";
+/**
+ * @description 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 declare class Sound extends EventDispatcher {
+    /**
+     * @type {AudioBufferSourceNode}
+     * @default null
+     * @private
+     */
+    private _$source;
+    /**
+     * @type {GainNode}
+     * @default null
+     * @private
+     */
+    private _$gainNode;
+    /**
+     * @type {boolean}
+     * @default true
+     * @private
+     */
+    private _$stopFlag;
+    /**
+     * @type {number}
+     * @default 0
+     * @private
+     */
+    private _$currentCount;
+    /**
+     * @type {number}
+     * @default 1
+     * @private
+     */
+    private _$volume;
+    /**
+     * @description AudioBuffer
+     *              AudioBuffer
+     *
+     * @type {AudioBuffer}
+     * @default null
+     * @public
+     */
+    audioBuffer: AudioBuffer | null;
+    /**
+     * @description ループ回数の設定
+     *              Loop count setting.
+     *
+     * @type {string}
+     * @default 0
+     * @public
+     */
+    loopCount: number;
+    /**
+     * @constructor
+     * @public
+     */
+    constructor();
+    /**
+     * @description ボリュームです。範囲は 0（無音）～ 1（フルボリューム）です。
+     *              The volume, ranging from 0 (silent) to 1 (full volume).
+     *
+     * @member {number}
+     * @default 1
+     * @public
+     */
+    get volume(): number;
+    set volume(volume: number);
+    /**
+     * @description サウンドがループするかどうかを示します。
+     *              Indicates whether the sound loops.
+     *
+     * @member {boolean}
+     * @readonly
+     * @public
+     */
+    get canLoop(): boolean;
+    /**
+     * @description Sound クラスを複製します。
+     *              Duplicate the Sound class.
+     *
+     * @return {Sound}
+     * @method
+     * @public
+     */
+    clone(): Sound;
+    /**
+     * @description 指定した URL から外部 MP3 ファイルのロードを開始します。
+     *              Initiates loading of an external MP3 file from the specified URL.
+     *
+     * @param  {URLRequest} request
+     * @return {Promise}
+     * @method
+     * @public
+     */
+    load(request: URLRequest): Promise<void>;
+    /**
+     * @description サウンドを再生します。
+     *              Play a sound.
+     *
+     * @param   {number} [start_time=0]
+     * @return  {void}
+     * @method
+     * @public
+     */
+    play(start_time?: number): void;
+    /**
+     * @description チャンネルで再生しているサウンドを停止します。
+     *              Stops the sound playing in the channel.
+     *
+     * @return {void}
+     * @method
+     * @public
+     */
+    stop(): void;
+    /**
+     * @description Character DataからSoundを作成
+     *              Create Sound from Character Data
+     *
+     * @param  {Character} character
+     * @return {Promise}
+     * @method
+     * @protected
+     */
+    $build(character: ISoundCharacter): Promise<void>;
+}

package/src/Sound.js

@@ -0,0 +1,247 @@
+import { SoundMixer } from "./SoundMixer";
+import { execute as soundEndedEventService } from "./Sound/service/SoundEndedEventService";
+import { execute as soundLoadUseCase } from "./Sound/usecase/SoundLoadUseCase";
+import { execute as soundBuildFromCharacterUseCase } from "./Sound/usecase/SoundBuildFromCharacterUseCase";
+import { EventDispatcher } from "@next2d/events";
+import { $clamp, $getAudioContext, $getPlayingSounds } from "./MediaUtil";
+/**
+ * @description 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 {
+    /**
+     * @constructor
+     * @public
+     */
+    constructor() {
+        super();
+        /**
+         * @type {AudioBufferSourceNode}
+         * @default null
+         * @private
+         */
+        Object.defineProperty(this, "_$source", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @type {GainNode}
+         * @default null
+         * @private
+         */
+        Object.defineProperty(this, "_$gainNode", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @type {boolean}
+         * @default true
+         * @private
+         */
+        Object.defineProperty(this, "_$stopFlag", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @type {number}
+         * @default 0
+         * @private
+         */
+        Object.defineProperty(this, "_$currentCount", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @type {number}
+         * @default 1
+         * @private
+         */
+        Object.defineProperty(this, "_$volume", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @description AudioBuffer
+         *              AudioBuffer
+         *
+         * @type {AudioBuffer}
+         * @default null
+         * @public
+         */
+        Object.defineProperty(this, "audioBuffer", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @description ループ回数の設定
+         *              Loop count setting.
+         *
+         * @type {string}
+         * @default 0
+         * @public
+         */
+        Object.defineProperty(this, "loopCount", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.loopCount = 0;
+        this.audioBuffer = null;
+        // private
+        this._$volume = 1;
+        this._$currentCount = 0;
+        this._$stopFlag = true;
+        this._$source = null;
+        this._$gainNode = null;
+    }
+    /**
+     * @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 = $clamp(Math.min(SoundMixer.volume, volume), 0, 1, 1);
+        if (this._$gainNode) {
+            this._$gainNode.gain.value = this._$volume;
+        }
+    }
+    /**
+     * @description サウンドがループするかどうかを示します。
+     *              Indicates whether the sound loops.
+     *
+     * @member {boolean}
+     * @readonly
+     * @public
+     */
+    get canLoop() {
+        return !this._$stopFlag && this.loopCount >= this._$currentCount;
+    }
+    /**
+     * @description Sound クラスを複製します。
+     *              Duplicate the Sound class.
+     *
+     * @return {Sound}
+     * @method
+     * @public
+     */
+    clone() {
+        const sound = new Sound();
+        sound.volume = this._$volume;
+        sound.loopCount = this.loopCount;
+        sound.audioBuffer = this.audioBuffer;
+        return sound;
+    }
+    /**
+     * @description 指定した URL から外部 MP3 ファイルのロードを開始します。
+     *              Initiates loading of an external MP3 file from the specified URL.
+     *
+     * @param  {URLRequest} request
+     * @return {Promise}
+     * @method
+     * @public
+     */
+    async load(request) {
+        await soundLoadUseCase(this, request);
+    }
+    /**
+     * @description サウンドを再生します。
+     *              Play a sound.
+     *
+     * @param   {number} [start_time=0]
+     * @return  {void}
+     * @method
+     * @public
+     */
+    play(start_time = 0) {
+        // 再生中なら終了
+        if (!this._$stopFlag) {
+            return;
+        }
+        if (!this.audioBuffer) {
+            return;
+        }
+        // 初期化
+        this.stop();
+        const audioContext = $getAudioContext();
+        this._$gainNode = audioContext.createGain();
+        this._$gainNode.connect(audioContext.destination);
+        this._$gainNode.gain.value = Math.min(SoundMixer.volume, this._$volume);
+        this._$source = audioContext.createBufferSource();
+        this._$source.addEventListener("ended", () => {
+            soundEndedEventService(this);
+        });
+        this._$source.buffer = this.audioBuffer;
+        this._$source.connect(this._$gainNode);
+        this._$source.start(start_time);
+        this._$stopFlag = false;
+        this._$currentCount++;
+        $getPlayingSounds().push(this);
+    }
+    /**
+     * @description チャンネルで再生しているサウンドを停止します。
+     *              Stops the sound playing in the channel.
+     *
+     * @return {void}
+     * @method
+     * @public
+     */
+    stop() {
+        if (this._$stopFlag) {
+            return;
+        }
+        this._$stopFlag = true;
+        this._$currentCount = 0;
+        if (this._$source) {
+            this._$source.disconnect();
+            this._$source = null;
+        }
+        if (this._$gainNode) {
+            this._$gainNode.gain.value = 0;
+            this._$gainNode.disconnect();
+            this._$gainNode = null;
+        }
+        const playingSounds = $getPlayingSounds();
+        const index = playingSounds.indexOf(this);
+        if (index > -1) {
+            playingSounds.splice(index, 1);
+        }
+    }
+    /**
+     * @description Character DataからSoundを作成
+     *              Create Sound from Character Data
+     *
+     * @param  {Character} character
+     * @return {Promise}
+     * @method
+     * @protected
+     */
+    async $build(character) {
+        await soundBuildFromCharacterUseCase(this, character);
+    }
+}

package/src/SoundMixer/service/SoundMixerStopAllService.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @description 再生中のサウンドとビデオの全ての再生を停止
+ *              Stops all playing sounds and videos.
+ *
+ * @return {void}
+ * @method
+ * @public
+ */
+export declare const execute: () => void;

package/src/SoundMixer/service/SoundMixerStopAllService.js

@@ -0,0 +1,32 @@
+import { $getPlayingSounds, $getPlayingVideos } from "../../MediaUtil";
+/**
+ * @description 再生中のサウンドとビデオの全ての再生を停止
+ *              Stops all playing sounds and videos.
+ *
+ * @return {void}
+ * @method
+ * @public
+ */
+export const execute = () => {
+    // sounds
+    const playingSounds = $getPlayingSounds();
+    for (let idx = 0; idx < playingSounds.length; ++idx) {
+        const sound = playingSounds[idx];
+        if (!sound) {
+            continue;
+        }
+        sound.stop();
+    }
+    // videos
+    const playingVideos = $getPlayingVideos();
+    for (let idx = 0; idx < playingVideos.length; ++idx) {
+        const video = playingVideos[idx];
+        if (!video) {
+            continue;
+        }
+        video.pause();
+    }
+    // reset
+    playingSounds.length = 0;
+    playingVideos.length = 0;
+};

package/src/SoundMixer/service/SoundMixerUpdateVolumeService.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @description 再生中のサウンドとビデオの全ての音量を更新
+ *              Updates the volume of all playing sounds and videos.
+ *
+ * @param {number} volume
+ * @method
+ * @public
+ */
+export declare const execute: (volume: number) => void;

package/src/SoundMixer/service/SoundMixerUpdateVolumeService.js

@@ -0,0 +1,29 @@
+import { $setVolume, $getPlayingSounds, $getPlayingVideos } from "../../MediaUtil";
+/**
+ * @description 再生中のサウンドとビデオの全ての音量を更新
+ *              Updates the volume of all playing sounds and videos.
+ *
+ * @param {number} volume
+ * @method
+ * @public
+ */
+export const execute = (volume) => {
+    // update volume
+    $setVolume(volume);
+    const playingSounds = $getPlayingSounds();
+    for (let idx = 0; idx < playingSounds.length; ++idx) {
+        const sound = playingSounds[idx];
+        if (!sound) {
+            continue;
+        }
+        sound.volume = volume;
+    }
+    const playingVideos = $getPlayingVideos();
+    for (let idx = 0; idx < playingVideos.length; ++idx) {
+        const video = playingVideos[idx];
+        if (!video) {
+            continue;
+        }
+        video.volume = volume;
+    }
+};

package/src/SoundMixer.d.ts

@@ -0,0 +1,28 @@
+/**
+ * SoundMixer クラスには、静的プロパティやアプリケーションのグローバルサウンドコントロールのメソッドが含まれます。
+ * SoundMixer クラスは、アプリケーションの埋め込みおよびストリーミングサウンド、及び、Video クラスの音声を制御します。
+ *
+ * @class
+ * @memberOf next2d.media
+ */
+export declare class SoundMixer {
+    /**
+     * @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/src/SoundMixer.js

@@ -0,0 +1,37 @@
+import { execute as soundMixerUpdateVolumeService } from "./SoundMixer/service/SoundMixerUpdateVolumeService";
+import { execute as soundMixerStopAllService } from "./SoundMixer/service/SoundMixerStopAllService";
+import { $getVolume } from "./MediaUtil";
+/**
+ * SoundMixer クラスには、静的プロパティやアプリケーションのグローバルサウンドコントロールのメソッドが含まれます。
+ * SoundMixer クラスは、アプリケーションの埋め込みおよびストリーミングサウンド、及び、Video クラスの音声を制御します。
+ *
+ * @class
+ * @memberOf next2d.media
+ */
+export class SoundMixer {
+    /**
+     * @description ボリュームです。範囲は 0（無音）～ 1（フルボリューム）です。
+     *              The volume, ranging from 0 (silent) to 1 (full volume).
+     *
+     * @member {number}
+     * @default 1
+     * @static
+     */
+    static get volume() {
+        return $getVolume();
+    }
+    static set volume(volume) {
+        soundMixerUpdateVolumeService(volume);
+    }
+    /**
+     * @description 再生中のサウンドとビデオをすべて停止します。
+     *              Stops all sound and video that is playing.
+     *
+     * @return {void}
+     * @method
+     * @static
+     */
+    static stopAll() {
+        soundMixerStopAllService();
+    }
+}

package/src/SoundTransform.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @description SoundTransform クラスにはボリュームとループのプロパティが含まれます。
+ *              The SoundTransform class contains properties for volume and loop.
+ *
+ * @class
+ * @memberOf next2d.media
+ */
+export declare class SoundTransform {
+    /**
+     * @description ボリュームです。範囲は 0（無音）～ 1（フルボリューム）です。
+     *              The volume, ranging from 0 (silent) to 1 (full volume).
+     *
+     * @member {number}
+     * @default 1
+     * @public
+     */
+    volume: number;
+    /**
+     * @description ループ回数の設定
+     *              Loop count setting.
+     *
+     * @type {boolean}
+     * @default false
+     * @public
+     */
+    loopCount: number;
+    /**
+     * @param {number} [volume=1]
+     * @param {number} [loop_count=0]
+     *
+     * @constructor
+     * @public
+     */
+    constructor(volume?: number, loop_count?: number);
+}

package/src/SoundTransform.js

@@ -0,0 +1,48 @@
+/**
+ * @description SoundTransform クラスにはボリュームとループのプロパティが含まれます。
+ *              The SoundTransform class contains properties for volume and loop.
+ *
+ * @class
+ * @memberOf next2d.media
+ */
+export class SoundTransform {
+    /**
+     * @param {number} [volume=1]
+     * @param {number} [loop_count=0]
+     *
+     * @constructor
+     * @public
+     */
+    constructor(volume = 1, loop_count = 0) {
+        /**
+         * @description ボリュームです。範囲は 0（無音）～ 1（フルボリューム）です。
+         *              The volume, ranging from 0 (silent) to 1 (full volume).
+         *
+         * @member {number}
+         * @default 1
+         * @public
+         */
+        Object.defineProperty(this, "volume", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @description ループ回数の設定
+         *              Loop count setting.
+         *
+         * @type {boolean}
+         * @default false
+         * @public
+         */
+        Object.defineProperty(this, "loopCount", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.volume = volume;
+        this.loopCount = loop_count;
+    }
+}

package/src/Video/service/VideoApplyChangesService.d.ts

@@ -0,0 +1,11 @@
+import type { DisplayObject } from "@next2d/display";
+/**
+ * @description DisplayObjectの更新フラグを立てる
+ *              Set the update flag of DisplayObject
+ *
+ * @param  {DisplayObject} display_object
+ * @return {void}
+ * @method
+ * @protected
+ */
+export declare const execute: <D extends DisplayObject>(display_object: D) => void;

package/src/Video/service/VideoApplyChangesService.js

@@ -0,0 +1,16 @@
+/**
+ * @description DisplayObjectの更新フラグを立てる
+ *              Set the update flag of DisplayObject
+ *
+ * @param  {DisplayObject} display_object
+ * @return {void}
+ * @method
+ * @protected
+ */
+export const execute = (display_object) => {
+    display_object.changed = true;
+    const parent = display_object.parent;
+    if (parent && !parent.changed) {
+        execute(parent);
+    }
+};

package/src/Video/service/VideoCreateElementService.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @description HTMLVideoElementを作成して、各種イベントを設定する
+ *              Create an HTMLVideoElement and set various events
+ *
+ * @return {HTMLVideoElement}
+ * @method
+ * @protected
+ */
+export declare const execute: () => HTMLVideoElement;

package/src/Video/service/VideoCreateElementService.js

@@ -0,0 +1,16 @@
+/**
+ * @description HTMLVideoElementを作成して、各種イベントを設定する
+ *              Create an HTMLVideoElement and set various events
+ *
+ * @return {HTMLVideoElement}
+ * @method
+ * @protected
+ */
+export const execute = () => {
+    const element = document.createElement("video");
+    element.autoplay = false;
+    element.crossOrigin = "anonymous";
+    // Required for iOS
+    element.setAttribute("playsinline", "");
+    return element;
+};

package/src/Video/service/VideoEndedEventService.d.ts

@@ -0,0 +1,11 @@
+import type { Video } from "../../Video";
+/**
+ * @description ビデオが最終フレームに達したときの処理
+ *              Processing when the video reaches the last frame
+ *
+ * @param  {Video} video
+ * @return {void}
+ * @method
+ * @protected
+ */
+export declare const execute: (video: Video) => void;