feat(music): finish music library and add an interface for mutable libraries

Author: MartinFillon

packages/common/src/library/libraries/abstracts/index.ts

@@ -4,3 +4,4 @@ export { BaseGraphicsLibrary } from "./graphics.library.abstract";
 export { BaseInputLibrary } from "./input.library.abstract";
 export { BaseSoundLibrary } from "./sound.library.abstract";
 export { BaseNetworkLibrary } from "./network.library.abstract";
+export { BaseMusicLibrary } from "./music.library.abstract";

packages/common/src/library/libraries/abstracts/music.library.abstract.ts

@@ -0,0 +1,14 @@
+import { type InitContext } from "../../../context";
+import { type IMusicLibrary } from "../interfaces";
+import { Library } from "../library";
+
+export abstract class BaseMusicLibrary extends Library implements IMusicLibrary {
+  public abstract init(context: InitContext): Promise<void>;
+
+  public abstract play(sound: string): void;
+
+  /**
+   * mutes or unmutes the sound.
+   */
+  public abstract mute(): void;
+}

packages/common/src/library/libraries/consts/library-label.const.ts

@@ -2,5 +2,6 @@ export const COMPONENT_SYSTEM_LIBRARY = Symbol("COMPONENT_SYSTEM_LIBRARY");
 export const GRAPHICS_LIBRARY = Symbol("GRAPHICS_LIBRARY");
 export const NETWORK_LIBRARY = Symbol("NETWORK_LIBRARY");
 export const SOUND_LIBRARY = Symbol("SOUND_LIBRARY");
+export const MUSIC_LIBRARY = Symbol("MUSIC_LIBRARY");
 export const ASSET_MANAGER_LIBRARY = Symbol("ASSET_MANAGER_LIBRARY");
 export const INPUT_LIBRARY = Symbol("INPUT_LIBRARY");

packages/common/src/library/libraries/interfaces/bases/mutable.library.type.ts

@@ -0,0 +1,8 @@
+import { type ILibrary } from "../../library.type";
+
+export interface IMutableLibrary extends ILibrary {
+  /**
+   * mutes or unmutes the sound.
+   */
+  mute(): void;
+}

packages/common/src/library/libraries/interfaces/finals/music.library.type.ts

@@ -0,0 +1,4 @@
+import { type IExposedLibrary } from "../bases/exposed.library.type";
+import { type IMutableLibrary } from "../bases/mutable.library.type";
+
+export interface IMusicLibrary extends IExposedLibrary, IMutableLibrary {}

packages/common/src/library/libraries/interfaces/finals/sound.library.type.ts

@@ -1,8 +1,4 @@
 import { type IExposedLibrary } from "../bases/exposed.library.type";
+import { type IMutableLibrary } from "../bases/mutable.library.type";
 
-export interface ISoundLibrary extends IExposedLibrary {
-  /**
-   * mutes or unmutes the sound.
-   */
-  mute(): void;
-}
+export interface ISoundLibrary extends IExposedLibrary, IMutableLibrary {}

packages/common/src/library/libraries/interfaces/index.ts

@@ -6,3 +6,5 @@ export { IGraphicsLibrary } from "./finals/graphics.library.type";
 export { IInputLibrary } from "./finals/input.library.type";
 export { ISoundLibrary } from "./finals/sound.library.type";
 export { INetworkLibrary } from "./finals/network.library.type";
+export { IMusicLibrary } from "./finals/music.library.type";
+export { IMutableLibrary } from "./bases/mutable.library.type";

packages/common/src/library/manager/managers/library.manager.ts

@@ -6,8 +6,10 @@ import {
   type IComponentSystemLibrary,
   type IGraphicsLibrary,
   type IInputLibrary,
+  type IMusicLibrary,
   type INetworkLibrary,
   type ISoundLibrary,
+  MUSIC_LIBRARY,
   NETWORK_LIBRARY,
   SOUND_LIBRARY,
 } from "../../libraries";
@@ -21,6 +23,7 @@ export enum DefaultLibrariesEnum {
   INPUT,
   NETWORK,
   SOUND,
+  MUSIC,
 }
 
 const DEFAULT_LIBRARIES: { index: DefaultLibrariesEnum; sym: symbol }[] = [
@@ -29,6 +32,7 @@ const DEFAULT_LIBRARIES: { index: DefaultLibrariesEnum; sym: symbol }[] = [
   { index: DefaultLibrariesEnum.GRAPHICS, sym: GRAPHICS_LIBRARY },
   { index: DefaultLibrariesEnum.NETWORK, sym: NETWORK_LIBRARY },
   { index: DefaultLibrariesEnum.SOUND, sym: SOUND_LIBRARY },
+  { index: DefaultLibrariesEnum.MUSIC, sym: MUSIC_LIBRARY },
 ];
 
 export class LibraryManager extends BaseLibraryManager {
@@ -67,4 +71,8 @@ export class LibraryManager extends BaseLibraryManager {
   public getSound<T extends ISoundLibrary = ISoundLibrary>(): LibraryHandle<T> {
     return this._get<T>(DefaultLibrariesEnum.SOUND);
   }
+
+  public getMusic<T extends IMusicLibrary = IMusicLibrary>(): LibraryHandle<T> {
+    return this._get<T>(DefaultLibrariesEnum.MUSIC);
+  }
 }

packages/core/src/application/application-config.ts

@@ -4,6 +4,7 @@ import {
   type IGraphicsLibrary,
   type IInputLibrary,
   type ILibrary,
+  type IMusicLibrary,
   type INetworkLibrary,
   type ISoundLibrary,
   type LibraryHandle,
@@ -77,4 +78,16 @@ export class ApplicationConfig {
   public useSoundLibrary(library: ISoundLibrary) {
     this._libraryManager.setSound(library);
   }
+
+  public getMusicLibrary() {
+    return this._libraryManager.getMusic();
+  }
+
+  public useMusicLibrary(library: IMusicLibrary) {
+    this._libraryManager.setMusic(library);
+  }
+
+  public getMutableLibraries() {
+    return this._libraryManager.getMutableLibraries();
+  }
 }

packages/core/src/common/library/manager/library.manager.ts

@@ -8,12 +8,15 @@ import {
   type IGraphicsLibrary,
   type IInputLibrary,
   type ILibrary,
+  type IMusicLibrary,
+  type IMutableLibrary,
   INPUT_LIBRARY,
   type INetworkLibrary,
   type IRunnerLibrary,
   type ISoundLibrary,
   type LibraryHandle,
   LibraryManager,
+  MUSIC_LIBRARY,
   NETWORK_LIBRARY,
   SOUND_LIBRARY,
 } from "@nanoforge/common";
@@ -65,6 +68,10 @@ export class EditableLibraryManager extends LibraryManager {
     this._set(DefaultLibrariesEnum.SOUND, SOUND_LIBRARY, library, new EditableLibraryContext());
   }
 
+  public setMusic(library: IMusicLibrary): void {
+    this._set(DefaultLibrariesEnum.MUSIC, MUSIC_LIBRARY, library, new EditableLibraryContext());
+  }
+
   public getLibraries(): LibraryHandle[] {
     return this._libraries;
   }
@@ -81,6 +88,12 @@ export class EditableLibraryManager extends LibraryManager {
     return Relationship.getLibrariesByDependencies(this._libraries, true);
   }
 
+  public getMutableLibraries(): LibraryHandle<IMutableLibrary>[] {
+    return this._libraries.filter(
+      (handle) => handle && typeof handle.library["mute"] === "function",
+    ) as LibraryHandle<IMutableLibrary>[];
+  }
+
   private _getRunnerLibraries(): LibraryHandle<IRunnerLibrary>[] {
     return this._libraries.filter(
       (handle) => handle && typeof handle.library["run"] === "function",