@adatechnology/game-animals-three 0.1.4 → 0.2.0

package/dist/index.d.ts

@@ -1,7 +1,8 @@
 import { AnimalSpecies, QuadrupedSpec, TextureMarker, AnimalVisualState } from '@adatechnology/game-animals';
 import { NodeSkin } from '@adatechnology/game-props3d';
 import * as THREE_NS from 'three';
-import { TestableModule } from '@adatechnology/game-contracts';
+import { SoundRecipe, SoundBank } from '@adatechnology/game-audio';
+import { Vec3, SoundRequest, TestableModule } from '@adatechnology/game-contracts';
 
 /** What the animation needs each frame. */
 type AnimateParams = {
@@ -98,6 +99,56 @@ type AnimalRig = {
     triangles: number;
 };
 
+/** `latido`: two square clicks 0.22 s apart, 520 Hz falling to 0.6, 0.12 s each. */
+declare const DOG_BARK: SoundRecipe;
+/** `queroquero`: three squares 0.14 s apart, 2400 Hz falling to 0.6, 0.09 s each. */
+declare const LAPWING_CALL: SoundRecipe;
+/** `cacarejo`: four squares 0.14 s apart, 900 Hz falling to 0.6, 0.09 s each. */
+declare const HEN_CLUCK: SoundRecipe;
+/** `mugido`: one sawtooth, 140 Hz falling to 0.8, 1.2 s. */
+declare const COW_MOO: SoundRecipe;
+declare const ANIMAL_SOUNDS: readonly SoundRecipe[];
+declare const ANIMAL_SOUND_BANK: SoundBank;
+
+/** The call of a species: the recipe, the seconds the page waits before the same animal calls again, and the metres its noise reaches the AI (`emitNoise`). */
+type AnimalCall = {
+    readonly sound: string;
+    readonly cooldown: number;
+    readonly noiseMetres: number;
+};
+/** The calls the page delivered, by species id. The other species (horse, pig, boar, capybara, jaguar, cat, vulture, snake, rat) have none: the page gives them no sound. */
+declare const ANIMAL_CALLS: Readonly<Record<string, AnimalCall>>;
+declare const ANIMAL_CALL_SOURCES: readonly string[];
+/** The part of the host's sound an animal needs: `play`, and `register` to put the bank in its engine (`createAudioSink(...)` has both). */
+type AnimalSoundSink = {
+    play(request: SoundRequest): unknown;
+    register?(bank: unknown): void;
+};
+type AnimalSoundOptions = {
+    /** Replaces a species' call; `null` silences it. */
+    readonly calls?: Readonly<Record<string, AnimalCall | null>>;
+};
+type AnimalSound = {
+    /** The call of a species, if it has one. */
+    callOf(speciesId: string): AnimalCall | undefined;
+    /**
+     * Makes the species call where the animal is. `key` is the animal (default the species): the same animal waits out its cooldown, and the call is
+     * refused (false) until then. Returns whether a sound was asked for.
+     */
+    call(speciesId: string, position: Vec3, options?: {
+        readonly volume?: number;
+        readonly key?: string;
+    }): boolean;
+    /** Counts the cooldowns down: call it each frame. */
+    update(dt: number): void;
+    dispose(): void;
+};
+/**
+ * Plays the calls of the animals on the host's sound: the four of the Bichos do Vale (hen, lapwing, cow, dog), positional with the page's linear 70 m
+ * fall, each animal waiting out the page's cooldown. The bank is registered in the host's engine.
+ */
+declare function createAnimalSound(sink: AnimalSoundSink, options?: AnimalSoundOptions): AnimalSound;
+
 type MaterialExtras = Partial<THREE_NS.MeshStandardMaterialParameters>;
 /** The part builders of the page's `Animal` (`M`, `ball`, `limb`, `joint`, `pivot`), bound to one rig. */
 type RigTools = {
@@ -210,6 +261,8 @@ type AnimalsTestOptions = {
         readonly timeScale: number;
     }) => OutbreakLike;
     readonly document?: DocumentLike;
+    /** The calls of the animals on the room's engine (`host.audio`); `false` leaves the area silent. */
+    readonly sound?: false | AnimalSoundOptions;
     /** Seed of the draws of the area (default 7, the page's). */
     readonly seed?: number;
 };
@@ -248,4 +301,4 @@ type AnimalsThree = {
 };
 declare const createAnimalsThree: (THREE: Three, options?: AnimalsThreeOptions) => AnimalsThree;
 
-export { ANIMALS_AREA_ID, ANIMAL_ITEM_PREFIX, type AnimalLeg, type AnimalPivot, type AnimalRig, type AnimalWing, type AnimalsContext, type AnimalsTestOptions, type AnimalsThree, type AnimalsThreeOptions, type AnimateParams, BIRD_EXTRAS, type BirdExtra, type BirdParts, type CanvasLike, type DocumentLike, type ExtraContext, type LineUpOptions, type OutbreakLike, QUADRUPED_EXTRAS, type QuadrupedExtra, type QuadrupedParts, type Three, applyVisualState, createAnimalsTestModule, createAnimalsThree, createCoatTexture, lineUpAnimals, profileGeometry, setJointView, setSplit, updateSplit };
+export { ANIMALS_AREA_ID, ANIMAL_CALLS, ANIMAL_CALL_SOURCES, ANIMAL_ITEM_PREFIX, ANIMAL_SOUNDS, ANIMAL_SOUND_BANK, type AnimalCall, type AnimalLeg, type AnimalPivot, type AnimalRig, type AnimalSound, type AnimalSoundOptions, type AnimalSoundSink, type AnimalWing, type AnimalsContext, type AnimalsTestOptions, type AnimalsThree, type AnimalsThreeOptions, type AnimateParams, BIRD_EXTRAS, type BirdExtra, type BirdParts, COW_MOO, type CanvasLike, DOG_BARK, type DocumentLike, type ExtraContext, HEN_CLUCK, LAPWING_CALL, type LineUpOptions, type OutbreakLike, QUADRUPED_EXTRAS, type QuadrupedExtra, type QuadrupedParts, type Three, applyVisualState, createAnimalSound, createAnimalsTestModule, createAnimalsThree, createCoatTexture, lineUpAnimals, profileGeometry, setJointView, setSplit, updateSplit };

package/dist/index.global.js

@@ -22,10 +22,19 @@ var GameAnimalsThree = (() => {
   var index_exports = {};
   __export(index_exports, {
     ANIMALS_AREA_ID: () => ANIMALS_AREA_ID,
+    ANIMAL_CALLS: () => ANIMAL_CALLS,
+    ANIMAL_CALL_SOURCES: () => ANIMAL_CALL_SOURCES,
     ANIMAL_ITEM_PREFIX: () => ANIMAL_ITEM_PREFIX,
+    ANIMAL_SOUNDS: () => ANIMAL_SOUNDS,
+    ANIMAL_SOUND_BANK: () => ANIMAL_SOUND_BANK,
     BIRD_EXTRAS: () => BIRD_EXTRAS,
+    COW_MOO: () => COW_MOO,
+    DOG_BARK: () => DOG_BARK,
+    HEN_CLUCK: () => HEN_CLUCK,
+    LAPWING_CALL: () => LAPWING_CALL,
     QUADRUPED_EXTRAS: () => QUADRUPED_EXTRAS,
     applyVisualState: () => applyVisualState,
+    createAnimalSound: () => createAnimalSound,
     createAnimalsTestModule: () => createAnimalsTestModule,
     createAnimalsThree: () => createAnimalsThree,
     createCoatTexture: () => createCoatTexture,
@@ -971,6 +980,213 @@ uniform mat4 uNodes[${nodes.length}]; attribute float aNodeIndex; attribute vec3
     });
   };
 
+  // ../game-audio/dist/index.js
+  var DISTANCE_CURVES = {
+    /** The game's `sfx`: `vol / (1 + d² × 0.004)`, cutoff `/ (1 + d × 0.01)`, silent below 0.01 (jogo L62091–62092, L62101). */
+    game_sfx: { model: "inverse_square", k: 4e-3, cutoffK: 0.01, minGain: 0.01 },
+    /** The game's `grito`: `1 / (1 + d² × 0.006)`, silent below 0.02 (jogo L62129–62130). */
+    game_scream: { model: "inverse_square", k: 6e-3, minGain: 0.02 },
+    /** The game's `voz`: `1 / (1 + d² × 0.01)`, silent below 0.02 (jogo L62146–62147). */
+    game_voice: { model: "inverse_square", k: 0.01, minGain: 0.02 },
+    /** The game's `boom`: `1.4 / (1 + d² × 0.002)`, never silent (jogo L68280). */
+    game_boom: { model: "inverse_square", k: 2e-3, scale: 1.4 },
+    /** The art scene's `outAt`: `vol / (1 + d² × 0.008)` (cena L1320). */
+    art_scene: { model: "inverse_square", k: 8e-3 },
+    /** The game's animal calls: `max(0, 1 − d / 70) × 0.25`, silent at or below 0.005 (jogo L66627–66628). */
+    animals: { model: "linear", range: 70, scale: 0.25, minGain: 5e-3 }
+  };
+  var mix_profiles_default = [
+    {
+      id: "game",
+      master: 0.5,
+      noise: { seconds: 1.5, create: "lazy" },
+      sources: ["jogo:L62077-62081 master 0.5 to the output", "jogo:L62082-62088 noise 1.5 s made by the first sound that needs it"]
+    },
+    {
+      id: "art_scene",
+      master: 0.85,
+      compressor: { threshold: -12, ratio: 5 },
+      reverb: { seconds: 2.2, decay: 3.4, wet: 0.4 },
+      noise: { seconds: 2, create: "eager" },
+      sources: [
+        "cena:L1308 compressor -12 dB, ratio 5",
+        "cena:L1309 master 0.85",
+        "cena:L1310 convolver, impulse 2.2 s of (1 - i/len)^3.4",
+        "cena:L1311 wet 0.4",
+        "cena:L1312 noise 2 s made with the chain"
+      ]
+    }
+  ];
+  var MIX_PROFILES = Object.fromEntries(
+    mix_profiles_default.map((profile) => [profile.id, profile])
+  );
+  var game_sfx_default = {
+    sources: ["jogo:L62089-62107"],
+    note: "The game's sfx table P: [lowpass cutoff Hz, peak gain, seconds]. Played as a noise burst with the game's distance curve (falloff game_sfx) and a 0.05 s tail. Team names in `team`.",
+    classes: [
+      { id: "pistol", team: "pistola", bus: "weapons", cutoff: 1800, gain: 0.9, seconds: 0.18 },
+      { id: "shotgun", team: "escopeta", bus: "weapons", cutoff: 900, gain: 1.2, seconds: 0.35 },
+      { id: "rifle", team: "fuzil", bus: "weapons", cutoff: 1400, gain: 1.1, seconds: 0.28 },
+      { id: "long_rifle", team: "rifle", bus: "weapons", cutoff: 1100, gain: 1.3, seconds: 0.45 },
+      { id: "impact", team: "impacto", bus: "world", cutoff: 2500, gain: 0.25, seconds: 0.05 },
+      { id: "flesh", team: "carne", bus: "world", cutoff: 600, gain: 0.35, seconds: 0.08 },
+      { id: "step", team: "passo", bus: "world", cutoff: 400, gain: 0.08, seconds: 0.05 },
+      { id: "glass", team: "vidro", bus: "world", cutoff: 5e3, gain: 0.5, seconds: 0.3 },
+      { id: "wood", team: "madeira", bus: "world", cutoff: 700, gain: 0.5, seconds: 0.2 },
+      { id: "reload", team: "recarga", bus: "weapons", cutoff: 3e3, gain: 0.15, seconds: 0.06 },
+      { id: "empty", team: "vazio", bus: "weapons", cutoff: 4e3, gain: 0.12, seconds: 0.03 },
+      { id: "explosion", team: "explosao", bus: "world", cutoff: 200, gain: 1.6, seconds: 1.4 }
+    ],
+    fallback: { id: "unknown", team: "(any other name)", bus: "world", cutoff: 1e3, gain: 0.5, seconds: 0.1 }
+  };
+  var GAME_SFX = game_sfx_default;
+  var GAME_SFX_CLASSES = GAME_SFX.classes;
+  var GAME_SFX_FALLBACK = GAME_SFX.fallback;
+  function noiseClassRecipe(row, id = `sfx_${row.id}`) {
+    return {
+      id,
+      bus: row.bus,
+      order: "burst",
+      duration: row.seconds,
+      tail: 0.05,
+      layers: [
+        {
+          source: { kind: "noise", offset: "random" },
+          filters: { mode: "serial", bank: [{ type: "lowpass", frequency: { set: row.cutoff } }] },
+          envelope: [
+            [0, row.gain, "set"],
+            ["1d", 1e-3, "exp", "fixed"]
+          ]
+        }
+      ],
+      falloff: DISTANCE_CURVES.game_sfx,
+      sources: [...GAME_SFX.sources.map((source) => `${source} ${row.team}`)]
+    };
+  }
+  var GAME_SFX_BANK = { id: "game_sfx", sounds: [...GAME_SFX_CLASSES, GAME_SFX_FALLBACK].map((row) => noiseClassRecipe(row)) };
+  var BENCH_BANK = {
+    id: "audio_bench",
+    sounds: [
+      {
+        id: "bench_ping",
+        bus: "ui",
+        pan: true,
+        duration: 0.25,
+        layers: [
+          {
+            gain: 0.5,
+            wet: 0.3,
+            source: { kind: "osc", wave: "sine", frequency: { from: 880 } },
+            envelope: [
+              [0, 1e-4, "set", "fixed"],
+              [2e-3, 1, "exp"],
+              ["1d", 1e-4, "exp", "fixed"]
+            ]
+          }
+        ],
+        falloff: DISTANCE_CURVES.art_scene,
+        sources: ["sdk: bench probe, a 880 Hz ping through the art scene output stage"]
+      },
+      {
+        id: "bench_hiss",
+        bus: "ui",
+        pan: true,
+        duration: [0.3, 0.9],
+        layers: [
+          {
+            gain: 0.4,
+            source: { kind: "noise", offset: "random", offsetScale: 1.5, loop: true },
+            filters: { mode: "serial", bank: [{ type: "highpass", frequency: { set: 3e3 }, q: 0.7 }] },
+            envelope: [
+              [0, 1e-4, "set", "fixed"],
+              [2e-3, 1, "exp"],
+              ["1d", 1e-4, "exp", "fixed"]
+            ]
+          }
+        ],
+        falloff: DISTANCE_CURVES.art_scene,
+        sources: ["sdk: bench probe, a highpass hiss of random length"]
+      }
+    ]
+  };
+
+  // src/audio/recipes.ts
+  var call = (o) => ({
+    id: o.id,
+    bus: "world",
+    order: "calls",
+    duration: o.seconds,
+    tail: 0.02,
+    // the page makes its gain and filter before it looks at the level
+    keepSilent: true,
+    layers: [
+      {
+        repeat: { count: o.count, spacing: o.spacing },
+        source: { kind: "osc", wave: o.wave, frequency: { from: o.frequency, to: o.frequency * o.drop, curve: "exp", over: "duration" } },
+        filters: { mode: "serial", bank: [{ type: "bandpass", frequency: { set: o.frequency * 1.2 }, q: 3 }] },
+        envelope: [
+          [0, 1e-4, "set", "fixed"],
+          [0.015, 1, "exp"],
+          ["1d", 1e-4, "exp", "fixed"]
+        ]
+      }
+    ],
+    falloff: DISTANCE_CURVES.animals,
+    sources: [`jogo:L66625-66639 bichoSom('${o.team}')`]
+  });
+  var DOG_BARK = call({ id: "dog_bark", team: "latido", count: 2, spacing: 0.22, seconds: 0.12, wave: "square", frequency: 520, drop: 0.6 });
+  var LAPWING_CALL = call({ id: "lapwing_call", team: "queroquero", count: 3, spacing: 0.14, seconds: 0.09, wave: "square", frequency: 2400, drop: 0.6 });
+  var HEN_CLUCK = call({ id: "hen_cluck", team: "cacarejo", count: 4, spacing: 0.14, seconds: 0.09, wave: "square", frequency: 900, drop: 0.6 });
+  var COW_MOO = call({ id: "cow_moo", team: "mugido", count: 1, spacing: 0.14, seconds: 1.2, wave: "sawtooth", frequency: 140, drop: 0.8 });
+  var ANIMAL_SOUNDS = [DOG_BARK, LAPWING_CALL, HEN_CLUCK, COW_MOO];
+  var ANIMAL_SOUND_BANK = { id: "animals_three", sounds: ANIMAL_SOUNDS };
+
+  // src/audio/calls.json
+  var calls_default = {
+    sources: [
+      "jogo:L66677 galinha: cacarejo, 6 s between calls, noise 30 m",
+      "jogo:L66680 quero-quero: queroquero when the player is near (alarme), 8 s, noise 40 m",
+      "jogo:L66681 vaca: mugido, 30 s, noise 80 m",
+      "jogo:L66683 cachorro: latido when a zombie is within 12 m, 3 s, noise 60 m"
+    ],
+    species: {
+      chicken: { sound: "hen_cluck", cooldown: 6, noiseMetres: 30 },
+      southern_lapwing: { sound: "lapwing_call", cooldown: 8, noiseMetres: 40 },
+      cow: { sound: "cow_moo", cooldown: 30, noiseMetres: 80 },
+      dog: { sound: "dog_bark", cooldown: 3, noiseMetres: 60 }
+    }
+  };
+
+  // src/audio/sound.ts
+  var DATA = calls_default;
+  var ANIMAL_CALLS = DATA.species;
+  var ANIMAL_CALL_SOURCES = DATA.sources;
+  function createAnimalSound(sink, options = {}) {
+    sink.register?.(ANIMAL_SOUND_BANK);
+    const calls = { ...ANIMAL_CALLS, ...options.calls };
+    const waiting = /* @__PURE__ */ new Map();
+    const callOf = (speciesId) => calls[speciesId] ?? void 0;
+    return {
+      callOf,
+      call(speciesId, position, o = {}) {
+        const found = callOf(speciesId);
+        if (!found) return false;
+        const key = o.key ?? speciesId;
+        if ((waiting.get(key) ?? 0) > 0) return false;
+        waiting.set(key, found.cooldown);
+        sink.play({ sound: found.sound, position, ...o.volume === void 0 ? {} : { volume: o.volume } });
+        return true;
+      },
+      update(dt) {
+        for (const [key, seconds] of waiting) {
+          if (seconds - dt <= 0) waiting.delete(key);
+          else waiting.set(key, seconds - dt);
+        }
+      },
+      dispose: () => waiting.clear()
+    };
+  }
+
   // src/line-up.ts
   var lineUpAnimals = (rigs, options = {}) => {
     const start = options.start ?? -19;
@@ -1073,7 +1289,7 @@ uniform mat4 uNodes[${nodes.length}]; attribute float aNodeIndex; attribute vec3
         time_scale: "Game seconds per real second for the bite timers (60: ten minutes pass in ten seconds)"
       },
       options: { visual_state: { alive: "Alive", infected: "Infected", dead: "Dead" }, gait: { idle: "Idle", walk: "Walk", run: "Run" } },
-      actions: { bite_all: "Bite every animal", recover: "Heal every animal", skin_40: "Add 40 animals as node skins", clear_skins: "Remove the skins" },
+      actions: { bite_all: "Bite every animal", recover: "Heal every animal", call: "Make the animals with a call call (hen, lapwing, cow, dog)", skin_40: "Add 40 animals as node skins", clear_skins: "Remove the skins" },
       layers: { joints: "Joints", split: "Split view", sound_range: "Sound range", carcass_lure: "Carcass lure radius" },
       metrics: { animals: "Animals", draw_calls: "Draw calls", triangles: "Triangles", nodes_per_skin: "Nodes per skin", incubating: "Incubating", turned: "Turned", dead: "Dead" },
       scenarios: {
@@ -1096,7 +1312,7 @@ uniform mat4 uNodes[${nodes.length}]; attribute float aNodeIndex; attribute vec3
         time_scale: "Segundos de jogo por segundo real nos prazos da mordida (60: dez minutos passam em dez segundos)"
       },
       options: { visual_state: { alive: "Vivo", infected: "Infectado", dead: "Morto" }, gait: { idle: "Parado", walk: "Andando", run: "Correndo" } },
-      actions: { bite_all: "Morder todos os bichos", recover: "Curar todos os bichos", skin_40: "P\xF4r 40 bichos como pele de n\xF3s", clear_skins: "Tirar as peles" },
+      actions: { bite_all: "Morder todos os bichos", recover: "Curar todos os bichos", call: "Fazer os bichos com chamado chamarem (galinha, quero-quero, vaca, cachorro)", skin_40: "P\xF4r 40 bichos como pele de n\xF3s", clear_skins: "Tirar as peles" },
       layers: { joints: "Juntas", split: "Vista aberta", sound_range: "Alcance do som", carcass_lure: "Raio de atra\xE7\xE3o da carca\xE7a" },
       metrics: { animals: "Bichos", draw_calls: "Chamadas de desenho", triangles: "Tri\xE2ngulos", nodes_per_skin: "N\xF3s por pele", incubating: "Incubando", turned: "Viraram", dead: "Morreram" },
       scenarios: {
@@ -1125,6 +1341,7 @@ uniform mat4 uNodes[${nodes.length}]; attribute float aNodeIndex; attribute vec3
     let animals = null;
     let host = null;
     let outbreak = null;
+    let sound = null;
     let time = 0;
     let clock = 0;
     let skinGroup = null;
@@ -1227,6 +1444,11 @@ uniform mat4 uNodes[${nodes.length}]; attribute float aNodeIndex; attribute vec3
             delete entry.counted;
             animals?.setVisualState(entry.rig, settings.visual);
           }
+        } else if (change.id === "call" && sound) {
+          for (const [id, entry] of placed) {
+            const at = entry.rig.root.getWorldPosition(new three.Vector3());
+            sound.call(entry.rig.species.id, [at.x, at.y + 0.5, at.z], { key: id });
+          }
         } else if (change.id === "skin_40") addSkins();
         else if (change.id === "clear_skins") clearSkins();
         return;
@@ -1257,6 +1479,7 @@ uniform mat4 uNodes[${nodes.length}]; attribute float aNodeIndex; attribute vec3
     const frame = (dt) => {
       time += dt * settings.speed;
       clock += dt;
+      sound?.update(dt);
       for (const [id, entry] of placed) {
         if (!entry.rig.root.parent) {
           placed.delete(id);
@@ -1334,6 +1557,7 @@ uniform mat4 uNodes[${nodes.length}]; attribute float aNodeIndex; attribute vec3
         { kind: "number", id: "time_scale", name: text.controls.time_scale, hint: text.hints.time_scale, min: 1, max: 600, step: 1, default: DEFAULT_TIME_SCALE },
         { kind: "action", id: "bite_all", name: text.actions.bite_all },
         { kind: "action", id: "recover", name: text.actions.recover },
+        { kind: "action", id: "call", name: text.actions.call },
         { kind: "action", id: "skin_40", name: text.actions.skin_40 },
         { kind: "action", id: "clear_skins", name: text.actions.clear_skins }
       ],
@@ -1351,6 +1575,7 @@ uniform mat4 uNodes[${nodes.length}]; attribute float aNodeIndex; attribute vec3
       attach(lent) {
         host = lent;
         ensure(lent.THREE);
+        sound = lent.audio && options.sound !== false ? createAnimalSound(lent.audio, options.sound ?? {}) : null;
         const stopChange = lent.bench?.onChange(onChange);
         const stopFrame = lent.onFrame(frame);
         return () => {
@@ -1358,6 +1583,8 @@ uniform mat4 uNodes[${nodes.length}]; attribute float aNodeIndex; attribute vec3
           stopFrame();
           clearRings();
           clearSkins();
+          sound?.dispose();
+          sound = null;
           host = null;
         };
       }