@adatechnology/game-audio 0.3.6 → 0.5.0

package/dist/testing.d.ts

@@ -0,0 +1,82 @@
+import { aC as SfxBlow, aF as SfxMaterial, ar as SampleEnvironment, aH as SfxState, D as CriterionId, o as AudioScenarioLike, j as AudioEngine, E as CriterionResult, aT as VoiceStartEvent, aO as VoiceHandle, c as SoundBank, a as SampleLoader, aE as SfxEntry, k as ActionCheck } from './locale-BugSe8dA.js';
+export { l as AudioBenchText, q as AudioTestModule, r as AudioTestModuleOptions, t as BENCH_BANK, aV as audioBenchTextOf, aZ as createAudioTestModule } from './locale-BugSe8dA.js';
+import { TestableModule } from '@adatechnology/game-contracts';
+
+type Strength = 'light' | 'medium' | 'heavy';
+type SoundCheckText = {
+    readonly group: string;
+    readonly name: string;
+    readonly controls: Readonly<Record<'category' | 'sound' | 'play' | 'material' | 'blow' | 'strike' | 'distance' | 'bearing' | 'environment' | 'strength' | 'wall' | 'burst' | 'play_a' | 'play_b' | 'ab_cycle' | 'blind' | 'reveal' | 'prefer_a' | 'prefer_b' | 'measure' | 'record' | 'approve', string>>;
+    readonly hints: Readonly<Record<'sound' | 'strike' | 'wall' | 'burst' | 'ab_cycle' | 'blind' | 'measure' | 'record' | 'approve', string>>;
+    readonly categories: Readonly<Record<string, string>>;
+    readonly blows: Readonly<Record<SfxBlow, string>>;
+    readonly materials: Readonly<Record<SfxMaterial, string>>;
+    readonly environments: Readonly<Record<SampleEnvironment, string>>;
+    readonly strengths: Readonly<Record<Strength, string>>;
+    readonly states: Readonly<Record<SfxState, string>>;
+    readonly criteria: Readonly<Record<CriterionId, string>>;
+    readonly metrics: Readonly<Record<'chosen' | 'matrix' | 'last' | 'ab' | 'blind' | 'verdicts' | 'state' | 'count', string>>;
+    readonly run: Readonly<Record<'idle' | 'measuring' | 'done' | 'failed' | 'recording' | 'recorded', string>>;
+    readonly words: Readonly<Record<'none' | 'hidden' | 'prefers' | 'approved', string>>;
+    readonly probe: string;
+    readonly wall: string;
+    readonly scenarios: Readonly<Record<'pipeline' | 'criteria' | 'loop' | 'panel', string>>;
+};
+declare const soundCheckTextOf: (locale: string) => SoundCheckText;
+
+declare const SOUND_STRENGTHS: {
+    readonly light: 0.1;
+    readonly medium: 0.5;
+    readonly heavy: 0.9;
+};
+type SoundStrength = keyof typeof SOUND_STRENGTHS;
+declare const CALIBRATION_CATEGORY = "calibracao";
+type SoundCheckModuleOptions = {
+    /** Banks with sample sounds to try (the calibration sound is always there); registered in the host's engine when it lends one. */
+    readonly banks?: readonly SoundBank[];
+    /** Where the files of those banks come from (default `fetch`). */
+    readonly loader?: SampleLoader;
+    /** The engine to use (default the host's in `host.audio`, else a new one). */
+    readonly engine?: AudioEngine;
+    readonly locale?: string;
+    /** First sound chosen (default the calibration sound). */
+    readonly sound?: string;
+    /** The sounds by category (default the kit's catalogue, `SFX_CATALOG` and the impact matrix). */
+    readonly catalog?: readonly SfxEntry[];
+    /** C2: the actions and the sounds they must play, per sound id. */
+    readonly actions?: Readonly<Record<string, readonly ActionCheck[]>>;
+    /** C6: sound ids loudest first. */
+    readonly loudnessOrder?: readonly string[];
+    /** Draws the source of the sound in the area (a portable radio of the items catalogue, say). Without it no source is drawn. */
+    readonly probe?: (THREE: unknown) => unknown;
+    /** Draws the wall that goes between the listener and the source (a house wall of the floorplan renderer). Without it no wall is drawn. */
+    readonly wall?: (THREE: unknown) => unknown;
+};
+type SoundCheckModule = TestableModule<AudioScenarioLike> & {
+    readonly engine: AudioEngine;
+    /** Measures the chosen sound (every criterion) and keeps the results for the bench. */
+    measure(): Promise<readonly CriterionResult[]>;
+    results(): readonly CriterionResult[];
+    /** Every voice the engine started while the module was attached (the event log of C1/C2). */
+    events(): readonly VoiceStartEvent[];
+    /** Plays the chosen sound (its file when there is one, else the current sound). */
+    play(): VoiceHandle | null;
+    /** The A/B pair of the chosen sound: the current (synthesized) id and the new (file) id. */
+    pair(): {
+        readonly a: string | null;
+        readonly b: string | null;
+    };
+    /** The preferences given (`sound → 'A' | 'B'`). */
+    verdicts(): Readonly<Record<string, 'A' | 'B'>>;
+    /** The sounds whose C10 the owner approved. */
+    approvals(): readonly string[];
+};
+/**
+ * The sound panel of the test room, in the five blocks the owner approved: (1) the sounds of each category with their state (file, synthesized, missing),
+ * (2) the material × blow matrix, (3) where and how it plays (distance, bearing, indoor or outdoor, strength, behind the house wall, a burst), (4) A/B of the
+ * current sound against the new file (alternating and blind, with the preference kept) and (5) the measurement of C1–C10 with a 3 s recording and the
+ * owner's approval for C10. It uses the host's engine (every bank of the room) and lends it the calibration takes.
+ */
+declare function createSoundCheckModule(options?: SoundCheckModuleOptions): SoundCheckModule;
+
+export { AudioScenarioLike, CALIBRATION_CATEGORY, SOUND_STRENGTHS, type SoundCheckModule, type SoundCheckModuleOptions, type SoundCheckText, type SoundStrength, createSoundCheckModule, soundCheckTextOf };

package/dist/testing.js

@@ -0,0 +1,19 @@
+import {
+  BENCH_BANK,
+  CALIBRATION_CATEGORY,
+  SOUND_STRENGTHS,
+  audioBenchTextOf,
+  createAudioTestModule,
+  createSoundCheckModule,
+  soundCheckTextOf
+} from "./chunk-7TLFY7VO.js";
+export {
+  BENCH_BANK,
+  CALIBRATION_CATEGORY,
+  SOUND_STRENGTHS,
+  audioBenchTextOf,
+  createAudioTestModule,
+  createSoundCheckModule,
+  soundCheckTextOf
+};
+//# sourceMappingURL=testing.js.map

package/dist/testing.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@adatechnology/game-audio",
-  "version": "0.3.6",
+  "version": "0.5.0",
   "license": "MIT",
-  "description": "Sound as data for games: recipes planned into resolved, seeded sound plans, a WebAudio layer that builds them, distance curves, pan, a voice limiter, loops and mixing profiles taken from the teams (the game and the art scene). Knows nothing about any game.",
+  "description": "Sound as data for games: recipes planned into resolved, seeded sound plans, a WebAudio layer that builds them, distance curves, pan, a voice limiter, loops and mixing profiles taken from the teams (the game and the art scene). Sounds from recorded files too (.ogg takes with round-robin, pitch, near/far layers, indoor/outdoor tails and strength tiers), a converter for the files the team drops in, and a measuring harness of the sound criteria. Knows nothing about any game.",
   "keywords": [
     "game",
     "audio",
@@ -32,13 +32,19 @@
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
     },
-    "./global": "./dist/index.global.js"
+    "./testing": {
+      "types": "./dist/testing.d.ts",
+      "import": "./dist/testing.js"
+    },
+    "./global": "./dist/index.global.js",
+    "./assets/*": "./assets/*"
   },
   "files": [
-    "dist"
+    "dist",
+    "assets"
   ],
   "dependencies": {
-    "@adatechnology/game-contracts": "^0.21.0"
+    "@adatechnology/game-contracts": "^0.23.0"
   },
   "devDependencies": {
     "@types/node": "^22.10.7",
@@ -50,6 +56,7 @@
   "scripts": {
     "build": "tsup",
     "typecheck": "tsc -p tsconfig.json --noEmit",
-    "test": "vitest run"
+    "test": "vitest run",
+    "sfx:convert": "node scripts/sfx-convert.mjs"
   }
 }