@carbonenginejs/runtime-resource 0.8.0 → 0.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (259) hide show
  1. package/LICENSE +21 -21
  2. package/NOTICE +29 -29
  3. package/README.md +67 -548
  4. package/dist/CjsMotherLode.js +1271 -1271
  5. package/dist/CjsResMan.js +3005 -3005
  6. package/dist/CjsResManQueue.js +214 -214
  7. package/dist/CjsResource.js +566 -566
  8. package/dist/CjsResourceSource.js +59 -59
  9. package/dist/_virtual/_rollupPluginBabelHelpers.js +153 -153
  10. package/dist/format/CjsBlueReader.js +269 -269
  11. package/dist/format/CjsFormat.js +192 -192
  12. package/dist/format/CjsReader.js +18 -18
  13. package/dist/format/CjsResourceProbe.js +277 -277
  14. package/dist/format/payloadContract.js +173 -173
  15. package/dist/formats/black/CjsBlackFormat.js +278 -278
  16. package/dist/formats/black/core/CjsBlackBinaryReader.js +153 -153
  17. package/dist/formats/black/core/CjsBlackPropertyReaders.js +382 -382
  18. package/dist/formats/black/core/CjsBlackReader.js +639 -639
  19. package/dist/formats/black/core/CjsBlackSchemaRegistry.js +433 -433
  20. package/dist/formats/black/core/black-schema-v1-2026-07-11.json.js +4 -4
  21. package/dist/formats/black/core/blackConstants.js +7 -7
  22. package/dist/formats/black/core/blackDefinitions.js +10 -10
  23. package/dist/formats/black/core/blackEnums.js +6 -6
  24. package/dist/formats/black/core/blackSchema.js +3 -3
  25. package/dist/formats/black/core/blackVersion.js +22 -22
  26. package/dist/formats/black/core/helpers.js +182 -182
  27. package/dist/formats/black/core/schema.js +4 -4
  28. package/dist/formats/black/index.js +2 -2
  29. package/dist/formats/bnk/CjsBnkFormat.js +125 -125
  30. package/dist/formats/bnk/core/graph.js +140 -140
  31. package/dist/formats/bnk/core/helpers.js +409 -409
  32. package/dist/formats/bnk/core/musicNodes.js +489 -489
  33. package/dist/formats/bnk/core/soundbanksInfo.js +246 -246
  34. package/dist/formats/bnk/index.js +2 -2
  35. package/dist/formats/cmf/CjsCmfFormat.js +497 -497
  36. package/dist/formats/cmf/core/binary.js +118 -118
  37. package/dist/formats/cmf/core/buffers.js +233 -233
  38. package/dist/formats/cmf/core/constants.js +47 -47
  39. package/dist/formats/cmf/core/gr2Anim.js +453 -453
  40. package/dist/formats/cmf/core/helpers.js +287 -287
  41. package/dist/formats/cmf/core/pack.js +276 -276
  42. package/dist/formats/cmf/core/schema.js +364 -364
  43. package/dist/formats/cmf/core/shared.js +268 -268
  44. package/dist/formats/cmf/core/writer.js +517 -517
  45. package/dist/formats/cmf/index.js +2 -2
  46. package/dist/formats/dds/CjsDdsFormat.js +193 -193
  47. package/dist/formats/dds/core/bc6h.js +288 -288
  48. package/dist/formats/dds/core/bc7.js +251 -251
  49. package/dist/formats/dds/core/helpers.js +815 -815
  50. package/dist/formats/dds/index.js +2 -2
  51. package/dist/formats/fbx/CjsFbxFormat.js +266 -266
  52. package/dist/formats/fbx/core/helpers.js +3901 -3901
  53. package/dist/formats/fbx/index.js +2 -2
  54. package/dist/formats/flac/CjsFlacFormat.js +87 -87
  55. package/dist/formats/flac/core/helpers.js +295 -295
  56. package/dist/formats/flac/index.js +2 -2
  57. package/dist/formats/gif/CjsGifFormat.js +87 -87
  58. package/dist/formats/gif/core/helpers.js +360 -360
  59. package/dist/formats/gif/index.js +2 -2
  60. package/dist/formats/gltf/CjsGltfFormat.js +290 -290
  61. package/dist/formats/gltf/core/helpers.js +292 -292
  62. package/dist/formats/gltf/core/json.js +79 -79
  63. package/dist/formats/gltf/core/parser.js +666 -666
  64. package/dist/formats/gltf/core/targets.js +163 -163
  65. package/dist/formats/gltf/index.js +2 -2
  66. package/dist/formats/gr2/CjsGr2Format.js +46 -0
  67. package/dist/formats/gr2/CjsGr2Format.js.map +1 -0
  68. package/dist/formats/gr2/core/CjsFormatGr2.js +273 -0
  69. package/dist/formats/gr2/core/CjsFormatGr2.js.map +1 -0
  70. package/dist/formats/gr2/core/bitknit2.js +280 -0
  71. package/dist/formats/gr2/core/bitknit2.js.map +1 -0
  72. package/dist/formats/gr2/core/curves.js +1047 -0
  73. package/dist/formats/gr2/core/curves.js.map +1 -0
  74. package/dist/formats/gr2/core/gsf.js +72 -0
  75. package/dist/formats/gr2/core/gsf.js.map +1 -0
  76. package/dist/formats/gr2/core/helpers.js +332 -0
  77. package/dist/formats/gr2/core/helpers.js.map +1 -0
  78. package/dist/formats/gr2/core/json.js +622 -0
  79. package/dist/formats/gr2/core/json.js.map +1 -0
  80. package/dist/formats/gr2/core/oodle1.js +388 -0
  81. package/dist/formats/gr2/core/oodle1.js.map +1 -0
  82. package/dist/formats/gr2/core/reader.js +617 -0
  83. package/dist/formats/gr2/core/reader.js.map +1 -0
  84. package/dist/formats/gr2/core/tangents.js +48 -0
  85. package/dist/formats/gr2/core/tangents.js.map +1 -0
  86. package/dist/formats/gr2/core/targets.js +351 -0
  87. package/dist/formats/gr2/core/targets.js.map +1 -0
  88. package/dist/formats/gr2/index.js +3 -0
  89. package/dist/formats/gr2/index.js.map +1 -0
  90. package/dist/formats/index.js +30 -23
  91. package/dist/formats/index.js.map +1 -1
  92. package/dist/formats/jpeg/CjsJpegFormat.js +206 -206
  93. package/dist/formats/jpeg/core/helpers.js +350 -350
  94. package/dist/formats/jpeg/core/jpeg.js +377 -377
  95. package/dist/formats/jpeg/index.js +2 -2
  96. package/dist/formats/mp3/CjsMp3Format.js +192 -192
  97. package/dist/formats/mp3/core/helpers.js +338 -338
  98. package/dist/formats/mp3/index.js +2 -2
  99. package/dist/formats/mp4/CjsMp4Format.js +191 -191
  100. package/dist/formats/mp4/core/helpers.js +449 -449
  101. package/dist/formats/mp4/index.js +2 -2
  102. package/dist/formats/obj/CjsObjFormat.js +253 -253
  103. package/dist/formats/obj/core/helpers.js +573 -573
  104. package/dist/formats/obj/core/json.js +64 -64
  105. package/dist/formats/obj/core/parser.js +321 -321
  106. package/dist/formats/obj/index.js +2 -2
  107. package/dist/formats/ogg/CjsOggFormat.js +88 -88
  108. package/dist/formats/ogg/core/helpers.js +387 -387
  109. package/dist/formats/ogg/core/imdct.js +178 -178
  110. package/dist/formats/ogg/core/vorbis.js +999 -999
  111. package/dist/formats/ogg/index.js +2 -2
  112. package/dist/formats/png/CjsPngFormat.js +195 -195
  113. package/dist/formats/png/core/helpers.js +583 -583
  114. package/dist/formats/png/index.js +2 -2
  115. package/dist/formats/red/CjsRedFormat.js +261 -261
  116. package/dist/formats/red/core/CjsRedReader.js +194 -194
  117. package/dist/formats/red/core/blackDefinitions.js +3 -3
  118. package/dist/formats/red/core/helpers.js +139 -139
  119. package/dist/formats/red/core/redGraph.js +68 -68
  120. package/dist/formats/red/core/schema.js +4 -4
  121. package/dist/formats/red/index.js +2 -2
  122. package/dist/formats/stl/CjsStlFormat.js +365 -365
  123. package/dist/formats/stl/core/helpers.js +261 -261
  124. package/dist/formats/stl/core/json.js +51 -51
  125. package/dist/formats/stl/core/stl.js +629 -629
  126. package/dist/formats/stl/core/targets.js +163 -163
  127. package/dist/formats/stl/index.js +2 -2
  128. package/dist/formats/tga/CjsTgaFormat.js +192 -192
  129. package/dist/formats/tga/core/helpers.js +446 -446
  130. package/dist/formats/tga/index.js +2 -2
  131. package/dist/formats/wav/CjsWavFormat.js +192 -192
  132. package/dist/formats/wav/core/helpers.js +328 -328
  133. package/dist/formats/wav/index.js +2 -2
  134. package/dist/formats/webm/CjsWebmFormat.js +191 -191
  135. package/dist/formats/webm/core/helpers.js +537 -537
  136. package/dist/formats/webm/index.js +2 -2
  137. package/dist/formats/webp/CjsWebpFormat.js +86 -86
  138. package/dist/formats/webp/core/helpers.js +214 -214
  139. package/dist/formats/webp/index.js +2 -2
  140. package/dist/formats/wem/CjsWemFormat.js +241 -241
  141. package/dist/formats/wem/core/bitStream.js +259 -259
  142. package/dist/formats/wem/core/codebookLibrary.js +164 -164
  143. package/dist/formats/wem/core/helpers.js +417 -417
  144. package/dist/formats/wem/core/packedCodebooksAotuv603.js +30 -30
  145. package/dist/formats/wem/core/ptadpcm.js +77 -77
  146. package/dist/formats/wem/core/resolve.js +121 -121
  147. package/dist/formats/wem/core/wemToOgg.js +485 -485
  148. package/dist/formats/wem/index.js +2 -2
  149. package/dist/formats/yaml/CjsYamlFormat.js +83 -83
  150. package/dist/formats/yaml/core/CjsYamlReader.js +305 -305
  151. package/dist/formats/yaml/core/helpers.js +160 -160
  152. package/dist/formats/yaml/index.js +2 -2
  153. package/dist/index.js +49 -48
  154. package/dist/index.js.map +1 -1
  155. package/dist/resourcePath.js +18 -18
  156. package/dist/resourceStates.js +9 -9
  157. package/dist/resources/AudioGeometryResData.js +47 -47
  158. package/dist/resources/GStateBindingCallbackData.js +31 -31
  159. package/dist/resources/MeshDecalData.js +37 -37
  160. package/dist/resources/MeshDecalLodData.js +34 -34
  161. package/dist/resources/Tr2EffectRes.js +71 -71
  162. package/dist/resources/Tr2GrannyIntersectionResult.js +60 -60
  163. package/dist/resources/Tr2GrannyStateRes.js +44 -44
  164. package/dist/resources/Tr2ImageRes.js +114 -114
  165. package/dist/resources/Tr2LightProfileRes.js +40 -40
  166. package/dist/resources/Tr2MaterialArea.js +34 -34
  167. package/dist/resources/Tr2MaterialMesh.js +31 -31
  168. package/dist/resources/Tr2MaterialRes.js +34 -34
  169. package/dist/resources/Tr2ShaderPermutation.js +43 -43
  170. package/dist/resources/Tr2TextureLodManager.js +80 -80
  171. package/dist/resources/Tr2TextureLodUpdateRequest.js +37 -37
  172. package/dist/resources/Tr2TexturePackChannel.js +37 -37
  173. package/dist/resources/Tr2TexturePipeline.js +52 -52
  174. package/dist/resources/Tr2TexturePipelineParams.js +34 -34
  175. package/dist/resources/Tr2TexturePipelineStepCompress.js +40 -40
  176. package/dist/resources/Tr2TexturePipelineStepGenerateMips.js +22 -0
  177. package/dist/resources/Tr2TexturePipelineStepGenerateMips.js.map +1 -0
  178. package/dist/resources/Tr2TexturePipelineStepLimitSize.js +34 -34
  179. package/dist/resources/Tr2TexturePipelineStepLoad.js +31 -31
  180. package/dist/resources/Tr2TexturePipelineStepPack.js +43 -43
  181. package/dist/resources/TriGeometryRes.js +239 -239
  182. package/dist/resources/TriGeometryResAreaData.js +59 -59
  183. package/dist/resources/TriGeometryResJointData.js +38 -38
  184. package/dist/resources/TriGeometryResLodData.js +88 -88
  185. package/dist/resources/TriGeometryResMeshData.js +63 -63
  186. package/dist/resources/TriGeometryResSkeletonData.js +34 -34
  187. package/dist/resources/TriGrannyRes.js +43 -43
  188. package/dist/resources/TriJointBinding.js +38 -38
  189. package/dist/resources/TriMorphTargetGeometryConstants.js +46 -46
  190. package/dist/resources/TriRtGeometryConstants.js +88 -88
  191. package/dist/resources/TriTextureRes.js +304 -304
  192. package/dist/resources/enums.js +18 -18
  193. package/dist/resources/resourceBoundary.js +47 -47
  194. package/dist/resources/texturePipelineBehavior.js +308 -308
  195. package/dist/texture/CjsTextureArrayRes.js +406 -406
  196. package/dist/texture/CjsTextureParameterProxy.js +133 -133
  197. package/docs/README.md +69 -0
  198. package/docs/architecture.md +86 -0
  199. package/docs/concepts/resource-lifecycle.md +217 -0
  200. package/docs/formats/README.md +104 -0
  201. package/{FORMAT-PROVENANCE.md → docs/formats/provenance.md} +173 -155
  202. package/docs/formats/stl.md +37 -0
  203. package/docs/formats/wwise.md +44 -0
  204. package/docs/reference/events.md +92 -0
  205. package/docs/reference/motherlode-cache.md +244 -0
  206. package/docs/reference/queues.md +102 -0
  207. package/docs/reference/reload.md +107 -0
  208. package/docs/reference/texture-arrays.md +113 -0
  209. package/docs/reference/texture-pipeline.md +53 -0
  210. package/docs/roadmap.md +104 -0
  211. package/format-notices/black/LICENSE +21 -21
  212. package/format-notices/black/NOTICE +47 -47
  213. package/format-notices/bnk/LICENSE +21 -21
  214. package/format-notices/bnk/NOTICE +20 -20
  215. package/format-notices/cmf/LICENSE +21 -21
  216. package/format-notices/cmf/NOTICE +36 -36
  217. package/format-notices/dds/LICENSE +21 -21
  218. package/format-notices/dds/NOTICE +14 -14
  219. package/format-notices/fbx/LICENSE +21 -21
  220. package/format-notices/fbx/NOTICE +14 -14
  221. package/format-notices/flac/LICENSE +21 -21
  222. package/format-notices/flac/NOTICE +14 -14
  223. package/format-notices/gif/LICENSE +21 -21
  224. package/format-notices/gif/NOTICE +14 -14
  225. package/format-notices/gltf/LICENSE +21 -21
  226. package/format-notices/gltf/NOTICE +27 -27
  227. package/format-notices/gr2/LICENSE +21 -0
  228. package/format-notices/gr2/NOTICE +60 -0
  229. package/format-notices/gr2/THIRD-PARTY-NOTICES.md +93 -0
  230. package/format-notices/jpeg/LICENSE +21 -21
  231. package/format-notices/jpeg/NOTICE +14 -14
  232. package/format-notices/mp3/LICENSE +21 -21
  233. package/format-notices/mp3/NOTICE +14 -14
  234. package/format-notices/mp4/LICENSE +21 -21
  235. package/format-notices/mp4/NOTICE +14 -14
  236. package/format-notices/obj/LICENSE +21 -21
  237. package/format-notices/obj/NOTICE +26 -26
  238. package/format-notices/ogg/LICENSE +21 -21
  239. package/format-notices/ogg/NOTICE +28 -28
  240. package/format-notices/png/LICENSE +21 -21
  241. package/format-notices/png/NOTICE +14 -14
  242. package/format-notices/red/LICENSE +21 -21
  243. package/format-notices/red/NOTICE +31 -31
  244. package/format-notices/stl/LICENSE +21 -21
  245. package/format-notices/stl/NOTICE +21 -21
  246. package/format-notices/tga/LICENSE +21 -21
  247. package/format-notices/tga/NOTICE +14 -14
  248. package/format-notices/wav/LICENSE +21 -21
  249. package/format-notices/wav/NOTICE +14 -14
  250. package/format-notices/webm/LICENSE +21 -21
  251. package/format-notices/webm/NOTICE +14 -14
  252. package/format-notices/webp/LICENSE +21 -21
  253. package/format-notices/webp/NOTICE +14 -14
  254. package/format-notices/wem/LICENSE +57 -57
  255. package/format-notices/wem/NOTICE +33 -33
  256. package/format-notices/yaml/LICENSE +21 -21
  257. package/format-notices/yaml/NOTICE +44 -44
  258. package/package.json +52 -51
  259. package/resource-lifecycle.md +0 -679
@@ -1,246 +1,246 @@
1
- /**
2
- * Readers for Wwise SoundbanksInfo metadata (the `soundbanksinfo.json` file
3
- * generated next to soundbanks).
4
- *
5
- * SoundbanksInfo is the authoring-name authority for soundbank content: it
6
- * maps media ids to original source paths and lists per-bank events, switch
7
- * groups, state groups, and game parameters. These helpers normalize that
8
- * document and join it against `CjsBnkFormat` inspection output; they never
9
- * touch audio bytes.
10
- */
11
-
12
- /**
13
- * Compute the Wwise 32-bit id for a name.
14
- *
15
- * Wwise derives bank, event, and language ids as the FNV-1 32-bit hash of the
16
- * lowercased name (verified against EVE build 3421648 bank and language ids).
17
- *
18
- * @param {string} name Bank, event, switch, or language name.
19
- * @returns {number} Unsigned 32-bit Wwise id.
20
- */
21
- function wwiseIdFromName(name) {
22
- let hash = 2166136261 >>> 0;
23
- const text = String(name).toLowerCase();
24
- for (let i = 0; i < text.length; i++) {
25
- hash = Math.imul(hash, 16777619) >>> 0;
26
- hash = (hash ^ text.charCodeAt(i)) >>> 0;
27
- }
28
- return hash;
29
- }
30
- function toSoundbanksInfoDocument(input) {
31
- let value = input;
32
- if (value instanceof ArrayBuffer) value = new Uint8Array(value);
33
- if (ArrayBuffer.isView(value)) value = new Uint8Array(value.buffer, value.byteOffset, value.byteLength);
34
- if (value instanceof Uint8Array) value = utf8String(value);
35
- if (typeof value === "string") {
36
- try {
37
- value = JSON.parse(value);
38
- } catch (error) {
39
- throw new TypeError(`CjsBnkFormat: SoundbanksInfo input is not valid JSON (${error.message})`);
40
- }
41
- }
42
- if (!value || typeof value !== "object" || Array.isArray(value)) {
43
- throw new TypeError("CjsBnkFormat: SoundbanksInfo input must be JSON bytes, text, or an object");
44
- }
45
- const document = value.SoundBanksInfo || value;
46
- if (!document || typeof document !== "object" || !Array.isArray(document.SoundBanks)) {
47
- throw new TypeError("CjsBnkFormat: input has no SoundBanksInfo.SoundBanks document");
48
- }
49
- return document;
50
- }
51
-
52
- /**
53
- * Test whether input looks like a Wwise SoundbanksInfo document.
54
- *
55
- * @param {Uint8Array|ArrayBuffer|DataView|string|object} input Candidate document.
56
- * @returns {boolean} True when a SoundBanksInfo bank list is present.
57
- */
58
- function isSoundbanksInfo(input) {
59
- try {
60
- toSoundbanksInfoDocument(input);
61
- return true;
62
- } catch {
63
- return false;
64
- }
65
- }
66
-
67
- /**
68
- * Parse SoundbanksInfo into a normalized camelCase summary.
69
- *
70
- * @param {Uint8Array|ArrayBuffer|DataView|string|object} input SoundbanksInfo JSON bytes, text, or object.
71
- * @returns {object} Normalized document summary with per-bank details.
72
- */
73
- function parseSoundbanksInfo(input) {
74
- const document = toSoundbanksInfoDocument(input);
75
- const banks = document.SoundBanks.map(normalizeBank);
76
- const summary = {
77
- platform: document.Platform || "",
78
- basePlatform: document.BasePlatform || "",
79
- schemaVersion: document.SchemaVersion || "",
80
- soundBankVersion: document.SoundBankVersion || "",
81
- bankCount: banks.length,
82
- mediaCount: 0,
83
- streamingMediaCount: 0,
84
- eventCount: 0,
85
- languages: [],
86
- banks
87
- };
88
- const languages = new Set();
89
- for (const bank of banks) {
90
- summary.mediaCount += bank.media.length;
91
- summary.streamingMediaCount += bank.media.filter(entry => entry.streaming).length;
92
- summary.eventCount += bank.events.length;
93
- if (bank.language) languages.add(bank.language);
94
- }
95
- summary.languages = [...languages].sort();
96
- return summary;
97
- }
98
- function normalizeBank(bank) {
99
- return {
100
- id: String(bank.Id ?? ""),
101
- type: bank.Type || "",
102
- language: bank.Language || "",
103
- shortName: bank.ShortName || "",
104
- path: bank.Path || "",
105
- media: (bank.Media || []).map(entry => ({
106
- id: String(entry.Id ?? ""),
107
- shortName: entry.ShortName || "",
108
- cachePath: entry.CachePath || "",
109
- language: entry.Language || "",
110
- streaming: entry.Streaming === "true",
111
- location: entry.Location || ""
112
- })),
113
- events: (bank.Events || []).map(entry => ({
114
- id: String(entry.Id ?? ""),
115
- name: entry.Name || ""
116
- })),
117
- switchGroups: (bank.SwitchGroups || []).map(group => ({
118
- id: String(group.Id ?? ""),
119
- name: group.Name || "",
120
- switches: (group.Switches || []).map(entry => ({
121
- id: String(entry.Id ?? ""),
122
- name: entry.Name || ""
123
- }))
124
- })),
125
- stateGroups: (bank.StateGroups || []).map(group => ({
126
- id: String(group.Id ?? ""),
127
- name: group.Name || "",
128
- states: (group.States || []).map(entry => ({
129
- id: String(entry.Id ?? ""),
130
- name: entry.Name || ""
131
- }))
132
- })),
133
- gameParameters: (bank.GameParameters || []).map(entry => ({
134
- id: String(entry.Id ?? ""),
135
- name: entry.Name || ""
136
- }))
137
- };
138
- }
139
-
140
- /**
141
- * Build id-keyed lookup tables from SoundbanksInfo.
142
- *
143
- * Media ids repeat across language variants of the same bank, so
144
- * `mediaById[id]` is an array of entries; event ids are unique.
145
- *
146
- * @param {Uint8Array|ArrayBuffer|DataView|string|object} input SoundbanksInfo JSON bytes, text, or object.
147
- * @returns {object} Catalog with banksById, mediaById, eventsById, and eventsByName.
148
- */
149
- function buildSoundbanksCatalog(input) {
150
- const parsed = parseSoundbanksInfo(input);
151
- const catalog = {
152
- platform: parsed.platform,
153
- soundBankVersion: parsed.soundBankVersion,
154
- bankCount: parsed.bankCount,
155
- mediaCount: parsed.mediaCount,
156
- eventCount: parsed.eventCount,
157
- languages: parsed.languages,
158
- banksById: {},
159
- bankVariantsById: {},
160
- mediaById: {},
161
- eventsById: {},
162
- eventsByName: {}
163
- };
164
- for (const bank of parsed.banks) {
165
- if (!catalog.banksById[bank.id]) catalog.banksById[bank.id] = bank;
166
- if (!catalog.bankVariantsById[bank.id]) catalog.bankVariantsById[bank.id] = [];
167
- catalog.bankVariantsById[bank.id].push(bank);
168
- for (const entry of bank.media) {
169
- const reference = {
170
- ...entry,
171
- bankId: bank.id,
172
- bankName: bank.shortName
173
- };
174
- if (!catalog.mediaById[entry.id]) catalog.mediaById[entry.id] = [];
175
- catalog.mediaById[entry.id].push(reference);
176
- }
177
- for (const entry of bank.events) {
178
- const reference = {
179
- ...entry,
180
- bankId: bank.id,
181
- bankName: bank.shortName
182
- };
183
- catalog.eventsById[entry.id] = reference;
184
- catalog.eventsByName[entry.name] = reference;
185
- }
186
- }
187
- return catalog;
188
- }
189
-
190
- /**
191
- * Join a `CjsBnkFormat` inspection result with a SoundbanksInfo catalog.
192
- *
193
- * Annotates the bank's embedded media and HIRC event listing with authoring
194
- * names. Entries with no catalog match keep `null` name fields rather than
195
- * being dropped, so counts stay aligned with the inspected bank. Language
196
- * variants of a bank share one bank id; the inspected BKHD `languageId`
197
- * (an FNV-1 hash of the language name) selects the exact variant.
198
- *
199
- * @param {object} bankInfo `CjsBnkFormat` inspect output.
200
- * @param {object} catalog `buildSoundbanksCatalog` output.
201
- * @returns {object} Bank/media/event annotations for the inspected bank.
202
- */
203
- function joinSoundbanksInfo(bankInfo, catalog) {
204
- const bankId = String(bankInfo.bankId ?? "");
205
- const variants = catalog.bankVariantsById[bankId] || [];
206
- const bank = variants.find(variant => wwiseIdFromName(variant.language) === bankInfo.languageId) || catalog.banksById[bankId] || null;
207
- const bankLanguage = bank ? bank.language : "";
208
- const media = (bankInfo.media || []).map(entry => {
209
- const references = catalog.mediaById[String(entry.id)] || [];
210
- const match = references.find(reference => reference.bankId === bankId && reference.language === bankLanguage) || references.find(reference => reference.bankId === bankId) || references[0] || null;
211
- return {
212
- id: entry.id,
213
- length: entry.length,
214
- available: entry.available,
215
- shortName: match ? match.shortName : null,
216
- cachePath: match ? match.cachePath : null,
217
- language: match ? match.language : null,
218
- streaming: match ? match.streaming : null
219
- };
220
- });
221
- const events = (bankInfo.hirc || []).filter(entry => entry.typeName === "event").map(entry => {
222
- const match = catalog.eventsById[String(entry.id)] || null;
223
- return {
224
- id: entry.id,
225
- name: match ? match.name : null,
226
- bankName: match ? match.bankName : null
227
- };
228
- });
229
- return {
230
- bankId,
231
- bank,
232
- media,
233
- namedMediaCount: media.filter(entry => entry.shortName !== null).length,
234
- events,
235
- namedEventCount: events.filter(entry => entry.name !== null).length
236
- };
237
- }
238
- function utf8String(bytes) {
239
- if (typeof TextDecoder !== "undefined") return new TextDecoder("utf-8").decode(bytes);
240
- let value = "";
241
- for (let i = 0; i < bytes.length; i++) value += String.fromCharCode(bytes[i]);
242
- return value;
243
- }
244
-
245
- export { buildSoundbanksCatalog, isSoundbanksInfo, joinSoundbanksInfo, parseSoundbanksInfo, toSoundbanksInfoDocument, wwiseIdFromName };
246
- //# sourceMappingURL=soundbanksInfo.js.map
1
+ /**
2
+ * Readers for Wwise SoundbanksInfo metadata (the `soundbanksinfo.json` file
3
+ * generated next to soundbanks).
4
+ *
5
+ * SoundbanksInfo is the authoring-name authority for soundbank content: it
6
+ * maps media ids to original source paths and lists per-bank events, switch
7
+ * groups, state groups, and game parameters. These helpers normalize that
8
+ * document and join it against `CjsBnkFormat` inspection output; they never
9
+ * touch audio bytes.
10
+ */
11
+
12
+ /**
13
+ * Compute the Wwise 32-bit id for a name.
14
+ *
15
+ * Wwise derives bank, event, and language ids as the FNV-1 32-bit hash of the
16
+ * lowercased name (verified against EVE build 3421648 bank and language ids).
17
+ *
18
+ * @param {string} name Bank, event, switch, or language name.
19
+ * @returns {number} Unsigned 32-bit Wwise id.
20
+ */
21
+ function wwiseIdFromName(name) {
22
+ let hash = 2166136261 >>> 0;
23
+ const text = String(name).toLowerCase();
24
+ for (let i = 0; i < text.length; i++) {
25
+ hash = Math.imul(hash, 16777619) >>> 0;
26
+ hash = (hash ^ text.charCodeAt(i)) >>> 0;
27
+ }
28
+ return hash;
29
+ }
30
+ function toSoundbanksInfoDocument(input) {
31
+ let value = input;
32
+ if (value instanceof ArrayBuffer) value = new Uint8Array(value);
33
+ if (ArrayBuffer.isView(value)) value = new Uint8Array(value.buffer, value.byteOffset, value.byteLength);
34
+ if (value instanceof Uint8Array) value = utf8String(value);
35
+ if (typeof value === "string") {
36
+ try {
37
+ value = JSON.parse(value);
38
+ } catch (error) {
39
+ throw new TypeError(`CjsBnkFormat: SoundbanksInfo input is not valid JSON (${error.message})`);
40
+ }
41
+ }
42
+ if (!value || typeof value !== "object" || Array.isArray(value)) {
43
+ throw new TypeError("CjsBnkFormat: SoundbanksInfo input must be JSON bytes, text, or an object");
44
+ }
45
+ const document = value.SoundBanksInfo || value;
46
+ if (!document || typeof document !== "object" || !Array.isArray(document.SoundBanks)) {
47
+ throw new TypeError("CjsBnkFormat: input has no SoundBanksInfo.SoundBanks document");
48
+ }
49
+ return document;
50
+ }
51
+
52
+ /**
53
+ * Test whether input looks like a Wwise SoundbanksInfo document.
54
+ *
55
+ * @param {Uint8Array|ArrayBuffer|DataView|string|object} input Candidate document.
56
+ * @returns {boolean} True when a SoundBanksInfo bank list is present.
57
+ */
58
+ function isSoundbanksInfo(input) {
59
+ try {
60
+ toSoundbanksInfoDocument(input);
61
+ return true;
62
+ } catch {
63
+ return false;
64
+ }
65
+ }
66
+
67
+ /**
68
+ * Parse SoundbanksInfo into a normalized camelCase summary.
69
+ *
70
+ * @param {Uint8Array|ArrayBuffer|DataView|string|object} input SoundbanksInfo JSON bytes, text, or object.
71
+ * @returns {object} Normalized document summary with per-bank details.
72
+ */
73
+ function parseSoundbanksInfo(input) {
74
+ const document = toSoundbanksInfoDocument(input);
75
+ const banks = document.SoundBanks.map(normalizeBank);
76
+ const summary = {
77
+ platform: document.Platform || "",
78
+ basePlatform: document.BasePlatform || "",
79
+ schemaVersion: document.SchemaVersion || "",
80
+ soundBankVersion: document.SoundBankVersion || "",
81
+ bankCount: banks.length,
82
+ mediaCount: 0,
83
+ streamingMediaCount: 0,
84
+ eventCount: 0,
85
+ languages: [],
86
+ banks
87
+ };
88
+ const languages = new Set();
89
+ for (const bank of banks) {
90
+ summary.mediaCount += bank.media.length;
91
+ summary.streamingMediaCount += bank.media.filter(entry => entry.streaming).length;
92
+ summary.eventCount += bank.events.length;
93
+ if (bank.language) languages.add(bank.language);
94
+ }
95
+ summary.languages = [...languages].sort();
96
+ return summary;
97
+ }
98
+ function normalizeBank(bank) {
99
+ return {
100
+ id: String(bank.Id ?? ""),
101
+ type: bank.Type || "",
102
+ language: bank.Language || "",
103
+ shortName: bank.ShortName || "",
104
+ path: bank.Path || "",
105
+ media: (bank.Media || []).map(entry => ({
106
+ id: String(entry.Id ?? ""),
107
+ shortName: entry.ShortName || "",
108
+ cachePath: entry.CachePath || "",
109
+ language: entry.Language || "",
110
+ streaming: entry.Streaming === "true",
111
+ location: entry.Location || ""
112
+ })),
113
+ events: (bank.Events || []).map(entry => ({
114
+ id: String(entry.Id ?? ""),
115
+ name: entry.Name || ""
116
+ })),
117
+ switchGroups: (bank.SwitchGroups || []).map(group => ({
118
+ id: String(group.Id ?? ""),
119
+ name: group.Name || "",
120
+ switches: (group.Switches || []).map(entry => ({
121
+ id: String(entry.Id ?? ""),
122
+ name: entry.Name || ""
123
+ }))
124
+ })),
125
+ stateGroups: (bank.StateGroups || []).map(group => ({
126
+ id: String(group.Id ?? ""),
127
+ name: group.Name || "",
128
+ states: (group.States || []).map(entry => ({
129
+ id: String(entry.Id ?? ""),
130
+ name: entry.Name || ""
131
+ }))
132
+ })),
133
+ gameParameters: (bank.GameParameters || []).map(entry => ({
134
+ id: String(entry.Id ?? ""),
135
+ name: entry.Name || ""
136
+ }))
137
+ };
138
+ }
139
+
140
+ /**
141
+ * Build id-keyed lookup tables from SoundbanksInfo.
142
+ *
143
+ * Media ids repeat across language variants of the same bank, so
144
+ * `mediaById[id]` is an array of entries; event ids are unique.
145
+ *
146
+ * @param {Uint8Array|ArrayBuffer|DataView|string|object} input SoundbanksInfo JSON bytes, text, or object.
147
+ * @returns {object} Catalog with banksById, mediaById, eventsById, and eventsByName.
148
+ */
149
+ function buildSoundbanksCatalog(input) {
150
+ const parsed = parseSoundbanksInfo(input);
151
+ const catalog = {
152
+ platform: parsed.platform,
153
+ soundBankVersion: parsed.soundBankVersion,
154
+ bankCount: parsed.bankCount,
155
+ mediaCount: parsed.mediaCount,
156
+ eventCount: parsed.eventCount,
157
+ languages: parsed.languages,
158
+ banksById: {},
159
+ bankVariantsById: {},
160
+ mediaById: {},
161
+ eventsById: {},
162
+ eventsByName: {}
163
+ };
164
+ for (const bank of parsed.banks) {
165
+ if (!catalog.banksById[bank.id]) catalog.banksById[bank.id] = bank;
166
+ if (!catalog.bankVariantsById[bank.id]) catalog.bankVariantsById[bank.id] = [];
167
+ catalog.bankVariantsById[bank.id].push(bank);
168
+ for (const entry of bank.media) {
169
+ const reference = {
170
+ ...entry,
171
+ bankId: bank.id,
172
+ bankName: bank.shortName
173
+ };
174
+ if (!catalog.mediaById[entry.id]) catalog.mediaById[entry.id] = [];
175
+ catalog.mediaById[entry.id].push(reference);
176
+ }
177
+ for (const entry of bank.events) {
178
+ const reference = {
179
+ ...entry,
180
+ bankId: bank.id,
181
+ bankName: bank.shortName
182
+ };
183
+ catalog.eventsById[entry.id] = reference;
184
+ catalog.eventsByName[entry.name] = reference;
185
+ }
186
+ }
187
+ return catalog;
188
+ }
189
+
190
+ /**
191
+ * Join a `CjsBnkFormat` inspection result with a SoundbanksInfo catalog.
192
+ *
193
+ * Annotates the bank's embedded media and HIRC event listing with authoring
194
+ * names. Entries with no catalog match keep `null` name fields rather than
195
+ * being dropped, so counts stay aligned with the inspected bank. Language
196
+ * variants of a bank share one bank id; the inspected BKHD `languageId`
197
+ * (an FNV-1 hash of the language name) selects the exact variant.
198
+ *
199
+ * @param {object} bankInfo `CjsBnkFormat` inspect output.
200
+ * @param {object} catalog `buildSoundbanksCatalog` output.
201
+ * @returns {object} Bank/media/event annotations for the inspected bank.
202
+ */
203
+ function joinSoundbanksInfo(bankInfo, catalog) {
204
+ const bankId = String(bankInfo.bankId ?? "");
205
+ const variants = catalog.bankVariantsById[bankId] || [];
206
+ const bank = variants.find(variant => wwiseIdFromName(variant.language) === bankInfo.languageId) || catalog.banksById[bankId] || null;
207
+ const bankLanguage = bank ? bank.language : "";
208
+ const media = (bankInfo.media || []).map(entry => {
209
+ const references = catalog.mediaById[String(entry.id)] || [];
210
+ const match = references.find(reference => reference.bankId === bankId && reference.language === bankLanguage) || references.find(reference => reference.bankId === bankId) || references[0] || null;
211
+ return {
212
+ id: entry.id,
213
+ length: entry.length,
214
+ available: entry.available,
215
+ shortName: match ? match.shortName : null,
216
+ cachePath: match ? match.cachePath : null,
217
+ language: match ? match.language : null,
218
+ streaming: match ? match.streaming : null
219
+ };
220
+ });
221
+ const events = (bankInfo.hirc || []).filter(entry => entry.typeName === "event").map(entry => {
222
+ const match = catalog.eventsById[String(entry.id)] || null;
223
+ return {
224
+ id: entry.id,
225
+ name: match ? match.name : null,
226
+ bankName: match ? match.bankName : null
227
+ };
228
+ });
229
+ return {
230
+ bankId,
231
+ bank,
232
+ media,
233
+ namedMediaCount: media.filter(entry => entry.shortName !== null).length,
234
+ events,
235
+ namedEventCount: events.filter(entry => entry.name !== null).length
236
+ };
237
+ }
238
+ function utf8String(bytes) {
239
+ if (typeof TextDecoder !== "undefined") return new TextDecoder("utf-8").decode(bytes);
240
+ let value = "";
241
+ for (let i = 0; i < bytes.length; i++) value += String.fromCharCode(bytes[i]);
242
+ return value;
243
+ }
244
+
245
+ export { buildSoundbanksCatalog, isSoundbanksInfo, joinSoundbanksInfo, parseSoundbanksInfo, toSoundbanksInfoDocument, wwiseIdFromName };
246
+ //# sourceMappingURL=soundbanksInfo.js.map
@@ -1,2 +1,2 @@
1
- export { CjsBnkFormat, CjsBnkFormat as default } from './CjsBnkFormat.js';
2
- //# sourceMappingURL=index.js.map
1
+ export { CjsBnkFormat, CjsBnkFormat as default } from './CjsBnkFormat.js';
2
+ //# sourceMappingURL=index.js.map