@carbonenginejs/runtime-resource 0.7.0 → 0.8.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 (219) hide show
  1. package/FORMAT-PROVENANCE.md +155 -144
  2. package/LICENSE +21 -21
  3. package/NOTICE +29 -29
  4. package/README.md +11 -0
  5. package/dist/CjsMotherLode.js +1271 -1271
  6. package/dist/CjsResMan.js +3005 -3005
  7. package/dist/CjsResManQueue.js +214 -214
  8. package/dist/CjsResource.js +566 -566
  9. package/dist/CjsResourceSource.js +59 -59
  10. package/dist/_virtual/_rollupPluginBabelHelpers.js +153 -153
  11. package/dist/format/CjsBlueReader.js +269 -269
  12. package/dist/format/CjsFormat.js +192 -192
  13. package/dist/format/CjsReader.js +18 -18
  14. package/dist/format/CjsResourceProbe.js +277 -277
  15. package/dist/format/payloadContract.js +173 -173
  16. package/dist/formats/black/CjsBlackFormat.js +278 -278
  17. package/dist/formats/black/core/CjsBlackBinaryReader.js +153 -153
  18. package/dist/formats/black/core/CjsBlackPropertyReaders.js +382 -382
  19. package/dist/formats/black/core/CjsBlackReader.js +639 -639
  20. package/dist/formats/black/core/CjsBlackSchemaRegistry.js +433 -433
  21. package/dist/formats/black/core/black-schema-v1-2026-07-11.json.js +4 -4
  22. package/dist/formats/black/core/blackConstants.js +7 -7
  23. package/dist/formats/black/core/blackDefinitions.js +10 -10
  24. package/dist/formats/black/core/blackEnums.js +6 -6
  25. package/dist/formats/black/core/blackSchema.js +3 -3
  26. package/dist/formats/black/core/blackVersion.js +22 -22
  27. package/dist/formats/black/core/helpers.js +182 -182
  28. package/dist/formats/black/core/schema.js +4 -4
  29. package/dist/formats/black/index.js +2 -2
  30. package/dist/formats/bnk/CjsBnkFormat.js +125 -125
  31. package/dist/formats/bnk/core/graph.js +140 -140
  32. package/dist/formats/bnk/core/helpers.js +409 -409
  33. package/dist/formats/bnk/core/musicNodes.js +489 -489
  34. package/dist/formats/bnk/core/soundbanksInfo.js +246 -246
  35. package/dist/formats/bnk/index.js +2 -2
  36. package/dist/formats/cmf/CjsCmfFormat.js +497 -497
  37. package/dist/formats/cmf/core/binary.js +118 -118
  38. package/dist/formats/cmf/core/buffers.js +233 -233
  39. package/dist/formats/cmf/core/constants.js +47 -47
  40. package/dist/formats/cmf/core/gr2Anim.js +453 -453
  41. package/dist/formats/cmf/core/helpers.js +287 -287
  42. package/dist/formats/cmf/core/pack.js +276 -276
  43. package/dist/formats/cmf/core/schema.js +364 -364
  44. package/dist/formats/cmf/core/shared.js +268 -268
  45. package/dist/formats/cmf/core/writer.js +517 -517
  46. package/dist/formats/cmf/index.js +2 -2
  47. package/dist/formats/dds/CjsDdsFormat.js +193 -193
  48. package/dist/formats/dds/core/bc6h.js +288 -0
  49. package/dist/formats/dds/core/bc6h.js.map +1 -0
  50. package/dist/formats/dds/core/bc7.js +251 -0
  51. package/dist/formats/dds/core/bc7.js.map +1 -0
  52. package/dist/formats/dds/core/helpers.js +815 -812
  53. package/dist/formats/dds/core/helpers.js.map +1 -1
  54. package/dist/formats/dds/index.js +2 -2
  55. package/dist/formats/fbx/CjsFbxFormat.js +266 -266
  56. package/dist/formats/fbx/core/helpers.js +3901 -3901
  57. package/dist/formats/fbx/index.js +2 -2
  58. package/dist/formats/flac/CjsFlacFormat.js +87 -87
  59. package/dist/formats/flac/core/helpers.js +295 -295
  60. package/dist/formats/flac/index.js +2 -2
  61. package/dist/formats/gif/CjsGifFormat.js +87 -87
  62. package/dist/formats/gif/core/helpers.js +360 -360
  63. package/dist/formats/gif/index.js +2 -2
  64. package/dist/formats/gltf/CjsGltfFormat.js +290 -290
  65. package/dist/formats/gltf/core/helpers.js +292 -292
  66. package/dist/formats/gltf/core/json.js +79 -79
  67. package/dist/formats/gltf/core/parser.js +666 -666
  68. package/dist/formats/gltf/core/targets.js +163 -163
  69. package/dist/formats/gltf/index.js +2 -2
  70. package/dist/formats/index.js +23 -23
  71. package/dist/formats/jpeg/CjsJpegFormat.js +206 -206
  72. package/dist/formats/jpeg/core/helpers.js +350 -350
  73. package/dist/formats/jpeg/core/jpeg.js +377 -377
  74. package/dist/formats/jpeg/index.js +2 -2
  75. package/dist/formats/mp3/CjsMp3Format.js +192 -192
  76. package/dist/formats/mp3/core/helpers.js +338 -338
  77. package/dist/formats/mp3/index.js +2 -2
  78. package/dist/formats/mp4/CjsMp4Format.js +191 -191
  79. package/dist/formats/mp4/core/helpers.js +449 -449
  80. package/dist/formats/mp4/index.js +2 -2
  81. package/dist/formats/obj/CjsObjFormat.js +253 -253
  82. package/dist/formats/obj/core/helpers.js +573 -573
  83. package/dist/formats/obj/core/json.js +64 -64
  84. package/dist/formats/obj/core/parser.js +321 -321
  85. package/dist/formats/obj/index.js +2 -2
  86. package/dist/formats/ogg/CjsOggFormat.js +88 -88
  87. package/dist/formats/ogg/core/helpers.js +387 -387
  88. package/dist/formats/ogg/core/imdct.js +178 -178
  89. package/dist/formats/ogg/core/vorbis.js +999 -999
  90. package/dist/formats/ogg/index.js +2 -2
  91. package/dist/formats/png/CjsPngFormat.js +195 -195
  92. package/dist/formats/png/core/helpers.js +583 -583
  93. package/dist/formats/png/index.js +2 -2
  94. package/dist/formats/red/CjsRedFormat.js +261 -261
  95. package/dist/formats/red/core/CjsRedReader.js +194 -194
  96. package/dist/formats/red/core/blackDefinitions.js +3 -3
  97. package/dist/formats/red/core/helpers.js +139 -139
  98. package/dist/formats/red/core/redGraph.js +68 -68
  99. package/dist/formats/red/core/schema.js +4 -4
  100. package/dist/formats/red/index.js +2 -2
  101. package/dist/formats/stl/CjsStlFormat.js +365 -365
  102. package/dist/formats/stl/core/helpers.js +261 -261
  103. package/dist/formats/stl/core/json.js +51 -51
  104. package/dist/formats/stl/core/stl.js +629 -629
  105. package/dist/formats/stl/core/targets.js +163 -163
  106. package/dist/formats/stl/index.js +2 -2
  107. package/dist/formats/tga/CjsTgaFormat.js +192 -192
  108. package/dist/formats/tga/core/helpers.js +446 -446
  109. package/dist/formats/tga/index.js +2 -2
  110. package/dist/formats/wav/CjsWavFormat.js +192 -192
  111. package/dist/formats/wav/core/helpers.js +328 -328
  112. package/dist/formats/wav/index.js +2 -2
  113. package/dist/formats/webm/CjsWebmFormat.js +191 -191
  114. package/dist/formats/webm/core/helpers.js +537 -537
  115. package/dist/formats/webm/index.js +2 -2
  116. package/dist/formats/webp/CjsWebpFormat.js +86 -86
  117. package/dist/formats/webp/core/helpers.js +214 -214
  118. package/dist/formats/webp/index.js +2 -2
  119. package/dist/formats/wem/CjsWemFormat.js +241 -241
  120. package/dist/formats/wem/core/bitStream.js +259 -259
  121. package/dist/formats/wem/core/codebookLibrary.js +164 -164
  122. package/dist/formats/wem/core/helpers.js +417 -417
  123. package/dist/formats/wem/core/packedCodebooksAotuv603.js +30 -30
  124. package/dist/formats/wem/core/ptadpcm.js +77 -77
  125. package/dist/formats/wem/core/resolve.js +121 -121
  126. package/dist/formats/wem/core/wemToOgg.js +485 -485
  127. package/dist/formats/wem/index.js +2 -2
  128. package/dist/formats/yaml/CjsYamlFormat.js +83 -83
  129. package/dist/formats/yaml/core/CjsYamlReader.js +305 -305
  130. package/dist/formats/yaml/core/helpers.js +160 -160
  131. package/dist/formats/yaml/index.js +2 -2
  132. package/dist/index.js +48 -48
  133. package/dist/resourcePath.js +18 -18
  134. package/dist/resourceStates.js +9 -9
  135. package/dist/resources/AudioGeometryResData.js +47 -47
  136. package/dist/resources/GStateBindingCallbackData.js +31 -31
  137. package/dist/resources/MeshDecalData.js +37 -37
  138. package/dist/resources/MeshDecalLodData.js +34 -34
  139. package/dist/resources/Tr2EffectRes.js +71 -71
  140. package/dist/resources/Tr2GrannyIntersectionResult.js +60 -60
  141. package/dist/resources/Tr2GrannyStateRes.js +44 -44
  142. package/dist/resources/Tr2ImageRes.js +114 -114
  143. package/dist/resources/Tr2LightProfileRes.js +40 -40
  144. package/dist/resources/Tr2MaterialArea.js +34 -34
  145. package/dist/resources/Tr2MaterialMesh.js +31 -31
  146. package/dist/resources/Tr2MaterialRes.js +34 -34
  147. package/dist/resources/Tr2ShaderPermutation.js +43 -43
  148. package/dist/resources/Tr2TextureLodManager.js +80 -80
  149. package/dist/resources/Tr2TextureLodUpdateRequest.js +37 -37
  150. package/dist/resources/Tr2TexturePackChannel.js +37 -37
  151. package/dist/resources/Tr2TexturePipeline.js +52 -52
  152. package/dist/resources/Tr2TexturePipelineParams.js +34 -34
  153. package/dist/resources/Tr2TexturePipelineStepCompress.js +40 -40
  154. package/dist/resources/Tr2TexturePipelineStepLimitSize.js +34 -34
  155. package/dist/resources/Tr2TexturePipelineStepLoad.js +31 -31
  156. package/dist/resources/Tr2TexturePipelineStepPack.js +43 -43
  157. package/dist/resources/TriGeometryRes.js +239 -216
  158. package/dist/resources/TriGeometryRes.js.map +1 -1
  159. package/dist/resources/TriGeometryResAreaData.js +59 -59
  160. package/dist/resources/TriGeometryResJointData.js +38 -38
  161. package/dist/resources/TriGeometryResLodData.js +88 -88
  162. package/dist/resources/TriGeometryResMeshData.js +63 -63
  163. package/dist/resources/TriGeometryResSkeletonData.js +34 -34
  164. package/dist/resources/TriGrannyRes.js +43 -43
  165. package/dist/resources/TriJointBinding.js +38 -38
  166. package/dist/resources/TriMorphTargetGeometryConstants.js +46 -46
  167. package/dist/resources/TriRtGeometryConstants.js +88 -88
  168. package/dist/resources/TriTextureRes.js +304 -304
  169. package/dist/resources/enums.js +18 -18
  170. package/dist/resources/resourceBoundary.js +47 -47
  171. package/dist/resources/texturePipelineBehavior.js +308 -308
  172. package/dist/texture/CjsTextureArrayRes.js +406 -406
  173. package/dist/texture/CjsTextureParameterProxy.js +133 -133
  174. package/format-notices/black/LICENSE +21 -21
  175. package/format-notices/black/NOTICE +47 -47
  176. package/format-notices/bnk/LICENSE +21 -21
  177. package/format-notices/bnk/NOTICE +20 -20
  178. package/format-notices/cmf/LICENSE +21 -21
  179. package/format-notices/cmf/NOTICE +36 -36
  180. package/format-notices/dds/LICENSE +21 -21
  181. package/format-notices/dds/NOTICE +14 -14
  182. package/format-notices/fbx/LICENSE +21 -21
  183. package/format-notices/fbx/NOTICE +14 -14
  184. package/format-notices/flac/LICENSE +21 -21
  185. package/format-notices/flac/NOTICE +14 -14
  186. package/format-notices/gif/LICENSE +21 -21
  187. package/format-notices/gif/NOTICE +14 -14
  188. package/format-notices/gltf/LICENSE +21 -21
  189. package/format-notices/gltf/NOTICE +27 -27
  190. package/format-notices/jpeg/LICENSE +21 -21
  191. package/format-notices/jpeg/NOTICE +14 -14
  192. package/format-notices/mp3/LICENSE +21 -21
  193. package/format-notices/mp3/NOTICE +14 -14
  194. package/format-notices/mp4/LICENSE +21 -21
  195. package/format-notices/mp4/NOTICE +14 -14
  196. package/format-notices/obj/LICENSE +21 -21
  197. package/format-notices/obj/NOTICE +26 -26
  198. package/format-notices/ogg/LICENSE +21 -21
  199. package/format-notices/ogg/NOTICE +28 -28
  200. package/format-notices/png/LICENSE +21 -21
  201. package/format-notices/png/NOTICE +14 -14
  202. package/format-notices/red/LICENSE +21 -21
  203. package/format-notices/red/NOTICE +31 -31
  204. package/format-notices/stl/LICENSE +21 -21
  205. package/format-notices/stl/NOTICE +21 -21
  206. package/format-notices/tga/LICENSE +21 -21
  207. package/format-notices/tga/NOTICE +14 -14
  208. package/format-notices/wav/LICENSE +21 -21
  209. package/format-notices/wav/NOTICE +14 -14
  210. package/format-notices/webm/LICENSE +21 -21
  211. package/format-notices/webm/NOTICE +14 -14
  212. package/format-notices/webp/LICENSE +21 -21
  213. package/format-notices/webp/NOTICE +14 -14
  214. package/format-notices/wem/LICENSE +57 -57
  215. package/format-notices/wem/NOTICE +33 -33
  216. package/format-notices/yaml/LICENSE +21 -21
  217. package/format-notices/yaml/NOTICE +44 -44
  218. package/package.json +2 -2
  219. package/resource-lifecycle.md +679 -679
@@ -1,409 +1,409 @@
1
- const OUTPUT_RAW = "raw";
2
- const OUTPUT_JSON = "json";
3
- const OUTPUT_BNK_JSON = "bnkJson";
4
- const OUTPUT_MEDIA = "media";
5
- const DEFAULT_VALUES = Object.freeze({
6
- emit: OUTPUT_RAW,
7
- inputType: "bnk",
8
- source: ""
9
- });
10
-
11
- /**
12
- * Advisory names for classic HIRC object type ids.
13
- *
14
- * Type ids shifted in later Wwise releases, so these names are hints for
15
- * debugging and inventory work, not a version-exact schema. Unknown ids are
16
- * reported as `hirc-type-<n>`.
17
- */
18
- const HIRC_TYPE_NAMES = Object.freeze({
19
- 1: "settings",
20
- 2: "sound",
21
- 3: "event-action",
22
- 4: "event",
23
- 5: "random-sequence-container",
24
- 6: "switch-container",
25
- 7: "actor-mixer",
26
- 8: "audio-bus",
27
- 9: "blend-container",
28
- 10: "music-segment",
29
- 11: "music-track",
30
- 12: "music-switch-container",
31
- 13: "music-playlist-container",
32
- 14: "attenuation",
33
- 15: "dialogue-event",
34
- 16: "motion-bus",
35
- 17: "motion-fx",
36
- 18: "effect",
37
- 19: "auxiliary-bus",
38
- 20: "lfo",
39
- 21: "envelope",
40
- 22: "audio-device"
41
- });
42
- function normalizeValues(base = DEFAULT_VALUES, options = {}, readerName = "CjsBnkFormat") {
43
- const values = {
44
- ...DEFAULT_VALUES,
45
- ...(base || {}),
46
- ...(options || {})
47
- };
48
- values.inputType = values.inputType ? String(values.inputType).replace(/^\./u, "").toLowerCase() : "bnk";
49
- values.emit = normalizeEmit(values.emit, readerName);
50
- return values;
51
- }
52
- function normalizeEmit(emit, readerName) {
53
- if (emit === undefined || emit === null) return OUTPUT_RAW;
54
- if (emit === OUTPUT_JSON) return OUTPUT_BNK_JSON;
55
- if ([OUTPUT_RAW, OUTPUT_BNK_JSON, OUTPUT_MEDIA].includes(emit)) return emit;
56
- throw new TypeError(`${readerName}: unknown emit value ${JSON.stringify(emit)}`);
57
- }
58
- function toBytes(input) {
59
- if (input instanceof Uint8Array) return input;
60
- if (input instanceof ArrayBuffer) return new Uint8Array(input);
61
- if (ArrayBuffer.isView(input)) return new Uint8Array(input.buffer, input.byteOffset, input.byteLength);
62
- throw new TypeError("Bnk input must be Uint8Array, ArrayBuffer, or DataView");
63
- }
64
-
65
- /**
66
- * Test for a Wwise soundbank BKHD signature.
67
- *
68
- * @param {Uint8Array} bytes Candidate bytes.
69
- * @returns {boolean} True when the bank header chunk is present.
70
- */
71
- function isBNK(bytes) {
72
- return bytes.byteLength >= 8 && fourCc(bytes, 0) === "BKHD";
73
- }
74
-
75
- /**
76
- * Inspect Wwise soundbank bytes without copying media payloads.
77
- *
78
- * Walks the chunk sequence and decodes the bank header (BKHD), embedded media
79
- * index (DIDX/DATA), object hierarchy listing (HIRC), and referenced bank
80
- * names (STID). Unknown chunks are recorded, never rejected; a truncated
81
- * trailing chunk stops the walk and is flagged.
82
- *
83
- * Wwise soundbanks are written little-endian on all platforms EVE ships on;
84
- * this reader assumes little-endian data.
85
- *
86
- * @param {Uint8Array} bytes Soundbank bytes.
87
- * @returns {object} Soundbank metadata.
88
- */
89
- function inspectBNK(bytes) {
90
- const info = {
91
- sourceFormat: "bnk",
92
- bankVersion: 0,
93
- bankId: 0,
94
- languageId: 0,
95
- media: [],
96
- hirc: [],
97
- names: [],
98
- chunks: []
99
- };
100
- let dataChunkOffset = 0;
101
- let dataChunkSize = 0;
102
- let mediaIndex = [];
103
- let offset = 0;
104
- while (offset + 8 <= bytes.byteLength) {
105
- const id = fourCc(bytes, offset);
106
- const size = readU32(bytes, offset + 4);
107
- const dataOffset = offset + 8;
108
- if (dataOffset + size > bytes.byteLength) {
109
- info.chunks.push({
110
- id,
111
- offset,
112
- dataOffset,
113
- size,
114
- truncated: true
115
- });
116
- break;
117
- }
118
- info.chunks.push({
119
- id,
120
- offset,
121
- dataOffset,
122
- size
123
- });
124
- if (id === "BKHD" && size >= 12) {
125
- info.bankVersion = readU32(bytes, dataOffset);
126
- info.bankId = readU32(bytes, dataOffset + 4);
127
- info.languageId = readU32(bytes, dataOffset + 8);
128
- }
129
- if (id === "DIDX") {
130
- mediaIndex = readMediaIndex(bytes, dataOffset, size);
131
- }
132
- if (id === "DATA") {
133
- dataChunkOffset = dataOffset;
134
- dataChunkSize = size;
135
- }
136
- if (id === "HIRC") {
137
- info.hirc = readHircListing(bytes, dataOffset, size);
138
- }
139
- if (id === "STID") {
140
- info.names = readNameTable(bytes, dataOffset, size);
141
- }
142
- offset = dataOffset + size;
143
- }
144
- info.media = mediaIndex.map(entry => {
145
- const absoluteOffset = dataChunkOffset + entry.offset;
146
- const available = dataChunkOffset > 0 && entry.offset + entry.length <= dataChunkSize && absoluteOffset + entry.length <= bytes.byteLength;
147
- return {
148
- id: entry.id,
149
- offset: entry.offset,
150
- absoluteOffset: dataChunkOffset > 0 ? absoluteOffset : 0,
151
- length: entry.length,
152
- available
153
- };
154
- });
155
- info.mediaCount = info.media.length;
156
- info.hircCount = info.hirc.length;
157
- return info;
158
- }
159
- function readMediaIndex(bytes, dataOffset, size) {
160
- const entries = [];
161
- const count = Math.floor(size / 12);
162
- for (let i = 0; i < count; i++) {
163
- const entryOffset = dataOffset + i * 12;
164
- entries.push({
165
- id: readU32(bytes, entryOffset),
166
- offset: readU32(bytes, entryOffset + 4),
167
- length: readU32(bytes, entryOffset + 8)
168
- });
169
- }
170
- return entries;
171
- }
172
- function readHircListing(bytes, dataOffset, size) {
173
- const entries = [];
174
- if (size < 4) return entries;
175
- const count = readU32(bytes, dataOffset);
176
- const end = dataOffset + size;
177
- let offset = dataOffset + 4;
178
- for (let i = 0; i < count; i++) {
179
- if (offset + 9 > end) break;
180
- const type = bytes[offset];
181
- const entrySize = readU32(bytes, offset + 1);
182
- const payloadOffset = offset + 5;
183
- if (entrySize < 4 || payloadOffset + entrySize > end) break;
184
- const entry = {
185
- type,
186
- typeName: HIRC_TYPE_NAMES[type] || `hirc-type-${type}`,
187
- id: readU32(bytes, payloadOffset),
188
- offset: payloadOffset,
189
- size: entrySize,
190
- // View over the object body AFTER the leading u32 id; not a copy.
191
- payload: bytes.subarray(payloadOffset + 4, payloadOffset + entrySize)
192
- };
193
- decodeHircFields(entry);
194
- entries.push(entry);
195
- offset = payloadOffset + entrySize;
196
- }
197
- return entries;
198
- }
199
-
200
- /**
201
- * Decode the version-stable typed fields of common HIRC object types in
202
- * place. Field layouts verified by hexdump against EVE soundbanks (bank
203
- * generator version 150 / Wwise 2022.1); every read is bounds-checked, and a
204
- * body too short for its type's layout simply keeps the raw payload only.
205
- *
206
- * - event (4): `u8 actionCount` + `actionCount x u32` -> `actionIds`.
207
- * - event-action (3): `u16 actionType` (high byte = family: 0x04 play,
208
- * 0x01 stop, 0x02 pause, 0x03 resume) + `u32 targetId`.
209
- * - sound (2): `u32 pluginId, u8 streamType, u32 sourceId (wem id),
210
- * u32 inMemoryMediaSize` (streamType 0 = embedded, 1 = streamed).
211
- * - music-track (11): `u8 flags, u32 sourceCount`, then per source the same
212
- * plugin/stream/source/size quad as sound -> `sources`.
213
- *
214
- * Deeper structures (container children, positioning, RTPC curves) remain
215
- * undecoded; consumers interpret `payload` themselves.
216
- */
217
- function decodeHircFields(entry) {
218
- const body = entry.payload;
219
- if (entry.type === 4 && body.byteLength >= 1) {
220
- const actionIds = [];
221
- const actionCount = body[0];
222
- for (let i = 0; i < actionCount && 1 + i * 4 + 4 <= body.byteLength; i++) {
223
- actionIds.push(readU32(body, 1 + i * 4));
224
- }
225
- entry.actionIds = actionIds;
226
- } else if (entry.type === 3 && body.byteLength >= 6) {
227
- entry.actionType = body[0] | body[1] << 8;
228
- entry.targetId = readU32(body, 2);
229
- } else if (entry.type === 2 && body.byteLength >= 13) {
230
- entry.pluginId = readU32(body, 0);
231
- entry.streamType = body[4];
232
- entry.sourceId = readU32(body, 5);
233
- entry.inMemoryMediaSize = readU32(body, 9);
234
- } else if (entry.type === 11 && body.byteLength >= 5) {
235
- const sources = [];
236
- const sourceCount = readU32(body, 1);
237
- for (let i = 0; i < sourceCount; i++) {
238
- const at = 5 + i * 14;
239
- if (at + 13 > body.byteLength) break;
240
- sources.push({
241
- pluginId: readU32(body, at),
242
- streamType: body[at + 4],
243
- sourceId: readU32(body, at + 5),
244
- inMemoryMediaSize: readU32(body, at + 9)
245
- });
246
- }
247
- entry.sources = sources;
248
- }
249
- }
250
- function readNameTable(bytes, dataOffset, size) {
251
- const names = [];
252
- if (size < 8) return names;
253
- const count = readU32(bytes, dataOffset + 4);
254
- const end = dataOffset + size;
255
- let offset = dataOffset + 8;
256
- for (let i = 0; i < count; i++) {
257
- if (offset + 5 > end) break;
258
- const bankId = readU32(bytes, offset);
259
- const length = bytes[offset + 4];
260
- if (offset + 5 + length > end) break;
261
- names.push({
262
- bankId,
263
- name: asciiString(bytes, offset + 5, length)
264
- });
265
- offset += 5 + length;
266
- }
267
- return names;
268
- }
269
- function inspectWithValues(input, values = DEFAULT_VALUES) {
270
- const bytes = toBytes(input);
271
- if (!isBNK(bytes)) {
272
- throw new TypeError("CjsBnkFormat: expected a Wwise soundbank starting with a BKHD chunk");
273
- }
274
- return {
275
- payloadType: "audio",
276
- mediaTypes: ["audio"],
277
- byteLength: bytes.byteLength,
278
- source: values.source || "buffer",
279
- ...inspectBNK(bytes)
280
- };
281
- }
282
-
283
- /**
284
- * Extract embedded media payloads as views over the soundbank bytes.
285
- *
286
- * Returned `bytes` are subarray views, not copies; callers that outlive the
287
- * source buffer should copy them.
288
- *
289
- * @param {Uint8Array} bytes Soundbank bytes.
290
- * @param {object} metadata Inspection result for those bytes.
291
- * @param {number} [mediaId] Optional single media id filter.
292
- * @returns {Array<object>} Extracted media items.
293
- */
294
- function extractMedia(bytes, metadata, mediaId) {
295
- const items = [];
296
- for (const entry of metadata.media) {
297
- if (mediaId !== undefined && entry.id !== mediaId) continue;
298
- if (!entry.available) continue;
299
- const payload = bytes.subarray(entry.absoluteOffset, entry.absoluteOffset + entry.length);
300
- items.push({
301
- id: entry.id,
302
- length: entry.length,
303
- isWem: payload.length >= 12 && (fourCc(payload, 0) === "RIFF" || fourCc(payload, 0) === "RIFX") && fourCc(payload, 8) === "WAVE",
304
- bytes: payload
305
- });
306
- }
307
- return items;
308
- }
309
- function isSupportedWithValues(input, values = DEFAULT_VALUES) {
310
- try {
311
- const metadata = inspectWithValues(input, values);
312
- const extractable = metadata.media.some(entry => entry.available);
313
- return {
314
- format: "bnk",
315
- source: values.source || "buffer",
316
- supported: "partial",
317
- confidence: 1,
318
- preferred: extractable ? OUTPUT_MEDIA : "raw",
319
- reason: extractable ? "Soundbank recognized; embedded media can be extracted undecoded." : "Soundbank recognized; it carries no extractable embedded media.",
320
- metadata,
321
- variants: [{
322
- kind: "raw",
323
- payloadType: "raw",
324
- codec: "wwise-soundbank",
325
- mimeType: "application/octet-stream",
326
- supported: true,
327
- containerOnly: true,
328
- isDecoded: false,
329
- pcmDecodeSupported: false
330
- }, {
331
- kind: OUTPUT_MEDIA,
332
- payloadType: OUTPUT_MEDIA,
333
- codec: "wem",
334
- supported: extractable,
335
- containerOnly: true,
336
- isDecoded: false,
337
- reason: extractable ? "" : "No DIDX/DATA media entries are present."
338
- }],
339
- warnings: [],
340
- errors: []
341
- };
342
- } catch (error) {
343
- return {
344
- format: "bnk",
345
- source: values.source || "buffer",
346
- supported: "none",
347
- confidence: 0,
348
- preferred: "",
349
- reason: error.message,
350
- metadata: null,
351
- variants: [],
352
- warnings: [],
353
- errors: [error.message]
354
- };
355
- }
356
- }
357
- function readWithValues(input, values = DEFAULT_VALUES) {
358
- const bytes = toBytes(input);
359
- const metadata = inspectWithValues(bytes, values);
360
- if (values.emit === OUTPUT_BNK_JSON) return metadata;
361
- if (values.emit === OUTPUT_MEDIA) {
362
- return {
363
- payloadType: OUTPUT_MEDIA,
364
- sourceFormat: "bnk",
365
- containerOnly: true,
366
- isDecoded: false,
367
- metadata,
368
- items: extractMedia(bytes, metadata)
369
- };
370
- }
371
- return {
372
- payloadType: "raw",
373
- sourceFormat: "bnk",
374
- mimeType: "application/octet-stream",
375
- containerOnly: true,
376
- isDecoded: false,
377
- pcmDecodeSupported: false,
378
- metadata,
379
- bytes
380
- };
381
- }
382
- function toJsonValue(value) {
383
- if (value instanceof Uint8Array) return {
384
- byteLength: value.byteLength
385
- };
386
- if (Array.isArray(value)) return value.map(toJsonValue);
387
- if (value && typeof value === "object") {
388
- const output = {};
389
- for (const [key, entry] of Object.entries(value)) output[key] = toJsonValue(entry);
390
- return output;
391
- }
392
- return value;
393
- }
394
- function asciiString(bytes, offset, length) {
395
- let value = "";
396
- for (let i = 0; i < length; i++) value += String.fromCharCode(bytes[offset + i]);
397
- return value;
398
- }
399
- function fourCc(bytes, offset, length = 4) {
400
- let value = "";
401
- for (let i = 0; i < length; i++) value += String.fromCharCode(bytes[offset + i] || 0);
402
- return value;
403
- }
404
- function readU32(bytes, offset) {
405
- return (bytes[offset] | bytes[offset + 1] << 8 | bytes[offset + 2] << 16 | bytes[offset + 3] * 0x1000000) >>> 0;
406
- }
407
-
408
- export { DEFAULT_VALUES, HIRC_TYPE_NAMES, OUTPUT_BNK_JSON, OUTPUT_JSON, OUTPUT_MEDIA, OUTPUT_RAW, extractMedia, inspectBNK, inspectWithValues, isBNK, isSupportedWithValues, normalizeEmit, normalizeValues, readWithValues, toBytes, toJsonValue };
409
- //# sourceMappingURL=helpers.js.map
1
+ const OUTPUT_RAW = "raw";
2
+ const OUTPUT_JSON = "json";
3
+ const OUTPUT_BNK_JSON = "bnkJson";
4
+ const OUTPUT_MEDIA = "media";
5
+ const DEFAULT_VALUES = Object.freeze({
6
+ emit: OUTPUT_RAW,
7
+ inputType: "bnk",
8
+ source: ""
9
+ });
10
+
11
+ /**
12
+ * Advisory names for classic HIRC object type ids.
13
+ *
14
+ * Type ids shifted in later Wwise releases, so these names are hints for
15
+ * debugging and inventory work, not a version-exact schema. Unknown ids are
16
+ * reported as `hirc-type-<n>`.
17
+ */
18
+ const HIRC_TYPE_NAMES = Object.freeze({
19
+ 1: "settings",
20
+ 2: "sound",
21
+ 3: "event-action",
22
+ 4: "event",
23
+ 5: "random-sequence-container",
24
+ 6: "switch-container",
25
+ 7: "actor-mixer",
26
+ 8: "audio-bus",
27
+ 9: "blend-container",
28
+ 10: "music-segment",
29
+ 11: "music-track",
30
+ 12: "music-switch-container",
31
+ 13: "music-playlist-container",
32
+ 14: "attenuation",
33
+ 15: "dialogue-event",
34
+ 16: "motion-bus",
35
+ 17: "motion-fx",
36
+ 18: "effect",
37
+ 19: "auxiliary-bus",
38
+ 20: "lfo",
39
+ 21: "envelope",
40
+ 22: "audio-device"
41
+ });
42
+ function normalizeValues(base = DEFAULT_VALUES, options = {}, readerName = "CjsBnkFormat") {
43
+ const values = {
44
+ ...DEFAULT_VALUES,
45
+ ...(base || {}),
46
+ ...(options || {})
47
+ };
48
+ values.inputType = values.inputType ? String(values.inputType).replace(/^\./u, "").toLowerCase() : "bnk";
49
+ values.emit = normalizeEmit(values.emit, readerName);
50
+ return values;
51
+ }
52
+ function normalizeEmit(emit, readerName) {
53
+ if (emit === undefined || emit === null) return OUTPUT_RAW;
54
+ if (emit === OUTPUT_JSON) return OUTPUT_BNK_JSON;
55
+ if ([OUTPUT_RAW, OUTPUT_BNK_JSON, OUTPUT_MEDIA].includes(emit)) return emit;
56
+ throw new TypeError(`${readerName}: unknown emit value ${JSON.stringify(emit)}`);
57
+ }
58
+ function toBytes(input) {
59
+ if (input instanceof Uint8Array) return input;
60
+ if (input instanceof ArrayBuffer) return new Uint8Array(input);
61
+ if (ArrayBuffer.isView(input)) return new Uint8Array(input.buffer, input.byteOffset, input.byteLength);
62
+ throw new TypeError("Bnk input must be Uint8Array, ArrayBuffer, or DataView");
63
+ }
64
+
65
+ /**
66
+ * Test for a Wwise soundbank BKHD signature.
67
+ *
68
+ * @param {Uint8Array} bytes Candidate bytes.
69
+ * @returns {boolean} True when the bank header chunk is present.
70
+ */
71
+ function isBNK(bytes) {
72
+ return bytes.byteLength >= 8 && fourCc(bytes, 0) === "BKHD";
73
+ }
74
+
75
+ /**
76
+ * Inspect Wwise soundbank bytes without copying media payloads.
77
+ *
78
+ * Walks the chunk sequence and decodes the bank header (BKHD), embedded media
79
+ * index (DIDX/DATA), object hierarchy listing (HIRC), and referenced bank
80
+ * names (STID). Unknown chunks are recorded, never rejected; a truncated
81
+ * trailing chunk stops the walk and is flagged.
82
+ *
83
+ * Wwise soundbanks are written little-endian on all platforms EVE ships on;
84
+ * this reader assumes little-endian data.
85
+ *
86
+ * @param {Uint8Array} bytes Soundbank bytes.
87
+ * @returns {object} Soundbank metadata.
88
+ */
89
+ function inspectBNK(bytes) {
90
+ const info = {
91
+ sourceFormat: "bnk",
92
+ bankVersion: 0,
93
+ bankId: 0,
94
+ languageId: 0,
95
+ media: [],
96
+ hirc: [],
97
+ names: [],
98
+ chunks: []
99
+ };
100
+ let dataChunkOffset = 0;
101
+ let dataChunkSize = 0;
102
+ let mediaIndex = [];
103
+ let offset = 0;
104
+ while (offset + 8 <= bytes.byteLength) {
105
+ const id = fourCc(bytes, offset);
106
+ const size = readU32(bytes, offset + 4);
107
+ const dataOffset = offset + 8;
108
+ if (dataOffset + size > bytes.byteLength) {
109
+ info.chunks.push({
110
+ id,
111
+ offset,
112
+ dataOffset,
113
+ size,
114
+ truncated: true
115
+ });
116
+ break;
117
+ }
118
+ info.chunks.push({
119
+ id,
120
+ offset,
121
+ dataOffset,
122
+ size
123
+ });
124
+ if (id === "BKHD" && size >= 12) {
125
+ info.bankVersion = readU32(bytes, dataOffset);
126
+ info.bankId = readU32(bytes, dataOffset + 4);
127
+ info.languageId = readU32(bytes, dataOffset + 8);
128
+ }
129
+ if (id === "DIDX") {
130
+ mediaIndex = readMediaIndex(bytes, dataOffset, size);
131
+ }
132
+ if (id === "DATA") {
133
+ dataChunkOffset = dataOffset;
134
+ dataChunkSize = size;
135
+ }
136
+ if (id === "HIRC") {
137
+ info.hirc = readHircListing(bytes, dataOffset, size);
138
+ }
139
+ if (id === "STID") {
140
+ info.names = readNameTable(bytes, dataOffset, size);
141
+ }
142
+ offset = dataOffset + size;
143
+ }
144
+ info.media = mediaIndex.map(entry => {
145
+ const absoluteOffset = dataChunkOffset + entry.offset;
146
+ const available = dataChunkOffset > 0 && entry.offset + entry.length <= dataChunkSize && absoluteOffset + entry.length <= bytes.byteLength;
147
+ return {
148
+ id: entry.id,
149
+ offset: entry.offset,
150
+ absoluteOffset: dataChunkOffset > 0 ? absoluteOffset : 0,
151
+ length: entry.length,
152
+ available
153
+ };
154
+ });
155
+ info.mediaCount = info.media.length;
156
+ info.hircCount = info.hirc.length;
157
+ return info;
158
+ }
159
+ function readMediaIndex(bytes, dataOffset, size) {
160
+ const entries = [];
161
+ const count = Math.floor(size / 12);
162
+ for (let i = 0; i < count; i++) {
163
+ const entryOffset = dataOffset + i * 12;
164
+ entries.push({
165
+ id: readU32(bytes, entryOffset),
166
+ offset: readU32(bytes, entryOffset + 4),
167
+ length: readU32(bytes, entryOffset + 8)
168
+ });
169
+ }
170
+ return entries;
171
+ }
172
+ function readHircListing(bytes, dataOffset, size) {
173
+ const entries = [];
174
+ if (size < 4) return entries;
175
+ const count = readU32(bytes, dataOffset);
176
+ const end = dataOffset + size;
177
+ let offset = dataOffset + 4;
178
+ for (let i = 0; i < count; i++) {
179
+ if (offset + 9 > end) break;
180
+ const type = bytes[offset];
181
+ const entrySize = readU32(bytes, offset + 1);
182
+ const payloadOffset = offset + 5;
183
+ if (entrySize < 4 || payloadOffset + entrySize > end) break;
184
+ const entry = {
185
+ type,
186
+ typeName: HIRC_TYPE_NAMES[type] || `hirc-type-${type}`,
187
+ id: readU32(bytes, payloadOffset),
188
+ offset: payloadOffset,
189
+ size: entrySize,
190
+ // View over the object body AFTER the leading u32 id; not a copy.
191
+ payload: bytes.subarray(payloadOffset + 4, payloadOffset + entrySize)
192
+ };
193
+ decodeHircFields(entry);
194
+ entries.push(entry);
195
+ offset = payloadOffset + entrySize;
196
+ }
197
+ return entries;
198
+ }
199
+
200
+ /**
201
+ * Decode the version-stable typed fields of common HIRC object types in
202
+ * place. Field layouts verified by hexdump against EVE soundbanks (bank
203
+ * generator version 150 / Wwise 2022.1); every read is bounds-checked, and a
204
+ * body too short for its type's layout simply keeps the raw payload only.
205
+ *
206
+ * - event (4): `u8 actionCount` + `actionCount x u32` -> `actionIds`.
207
+ * - event-action (3): `u16 actionType` (high byte = family: 0x04 play,
208
+ * 0x01 stop, 0x02 pause, 0x03 resume) + `u32 targetId`.
209
+ * - sound (2): `u32 pluginId, u8 streamType, u32 sourceId (wem id),
210
+ * u32 inMemoryMediaSize` (streamType 0 = embedded, 1 = streamed).
211
+ * - music-track (11): `u8 flags, u32 sourceCount`, then per source the same
212
+ * plugin/stream/source/size quad as sound -> `sources`.
213
+ *
214
+ * Deeper structures (container children, positioning, RTPC curves) remain
215
+ * undecoded; consumers interpret `payload` themselves.
216
+ */
217
+ function decodeHircFields(entry) {
218
+ const body = entry.payload;
219
+ if (entry.type === 4 && body.byteLength >= 1) {
220
+ const actionIds = [];
221
+ const actionCount = body[0];
222
+ for (let i = 0; i < actionCount && 1 + i * 4 + 4 <= body.byteLength; i++) {
223
+ actionIds.push(readU32(body, 1 + i * 4));
224
+ }
225
+ entry.actionIds = actionIds;
226
+ } else if (entry.type === 3 && body.byteLength >= 6) {
227
+ entry.actionType = body[0] | body[1] << 8;
228
+ entry.targetId = readU32(body, 2);
229
+ } else if (entry.type === 2 && body.byteLength >= 13) {
230
+ entry.pluginId = readU32(body, 0);
231
+ entry.streamType = body[4];
232
+ entry.sourceId = readU32(body, 5);
233
+ entry.inMemoryMediaSize = readU32(body, 9);
234
+ } else if (entry.type === 11 && body.byteLength >= 5) {
235
+ const sources = [];
236
+ const sourceCount = readU32(body, 1);
237
+ for (let i = 0; i < sourceCount; i++) {
238
+ const at = 5 + i * 14;
239
+ if (at + 13 > body.byteLength) break;
240
+ sources.push({
241
+ pluginId: readU32(body, at),
242
+ streamType: body[at + 4],
243
+ sourceId: readU32(body, at + 5),
244
+ inMemoryMediaSize: readU32(body, at + 9)
245
+ });
246
+ }
247
+ entry.sources = sources;
248
+ }
249
+ }
250
+ function readNameTable(bytes, dataOffset, size) {
251
+ const names = [];
252
+ if (size < 8) return names;
253
+ const count = readU32(bytes, dataOffset + 4);
254
+ const end = dataOffset + size;
255
+ let offset = dataOffset + 8;
256
+ for (let i = 0; i < count; i++) {
257
+ if (offset + 5 > end) break;
258
+ const bankId = readU32(bytes, offset);
259
+ const length = bytes[offset + 4];
260
+ if (offset + 5 + length > end) break;
261
+ names.push({
262
+ bankId,
263
+ name: asciiString(bytes, offset + 5, length)
264
+ });
265
+ offset += 5 + length;
266
+ }
267
+ return names;
268
+ }
269
+ function inspectWithValues(input, values = DEFAULT_VALUES) {
270
+ const bytes = toBytes(input);
271
+ if (!isBNK(bytes)) {
272
+ throw new TypeError("CjsBnkFormat: expected a Wwise soundbank starting with a BKHD chunk");
273
+ }
274
+ return {
275
+ payloadType: "audio",
276
+ mediaTypes: ["audio"],
277
+ byteLength: bytes.byteLength,
278
+ source: values.source || "buffer",
279
+ ...inspectBNK(bytes)
280
+ };
281
+ }
282
+
283
+ /**
284
+ * Extract embedded media payloads as views over the soundbank bytes.
285
+ *
286
+ * Returned `bytes` are subarray views, not copies; callers that outlive the
287
+ * source buffer should copy them.
288
+ *
289
+ * @param {Uint8Array} bytes Soundbank bytes.
290
+ * @param {object} metadata Inspection result for those bytes.
291
+ * @param {number} [mediaId] Optional single media id filter.
292
+ * @returns {Array<object>} Extracted media items.
293
+ */
294
+ function extractMedia(bytes, metadata, mediaId) {
295
+ const items = [];
296
+ for (const entry of metadata.media) {
297
+ if (mediaId !== undefined && entry.id !== mediaId) continue;
298
+ if (!entry.available) continue;
299
+ const payload = bytes.subarray(entry.absoluteOffset, entry.absoluteOffset + entry.length);
300
+ items.push({
301
+ id: entry.id,
302
+ length: entry.length,
303
+ isWem: payload.length >= 12 && (fourCc(payload, 0) === "RIFF" || fourCc(payload, 0) === "RIFX") && fourCc(payload, 8) === "WAVE",
304
+ bytes: payload
305
+ });
306
+ }
307
+ return items;
308
+ }
309
+ function isSupportedWithValues(input, values = DEFAULT_VALUES) {
310
+ try {
311
+ const metadata = inspectWithValues(input, values);
312
+ const extractable = metadata.media.some(entry => entry.available);
313
+ return {
314
+ format: "bnk",
315
+ source: values.source || "buffer",
316
+ supported: "partial",
317
+ confidence: 1,
318
+ preferred: extractable ? OUTPUT_MEDIA : "raw",
319
+ reason: extractable ? "Soundbank recognized; embedded media can be extracted undecoded." : "Soundbank recognized; it carries no extractable embedded media.",
320
+ metadata,
321
+ variants: [{
322
+ kind: "raw",
323
+ payloadType: "raw",
324
+ codec: "wwise-soundbank",
325
+ mimeType: "application/octet-stream",
326
+ supported: true,
327
+ containerOnly: true,
328
+ isDecoded: false,
329
+ pcmDecodeSupported: false
330
+ }, {
331
+ kind: OUTPUT_MEDIA,
332
+ payloadType: OUTPUT_MEDIA,
333
+ codec: "wem",
334
+ supported: extractable,
335
+ containerOnly: true,
336
+ isDecoded: false,
337
+ reason: extractable ? "" : "No DIDX/DATA media entries are present."
338
+ }],
339
+ warnings: [],
340
+ errors: []
341
+ };
342
+ } catch (error) {
343
+ return {
344
+ format: "bnk",
345
+ source: values.source || "buffer",
346
+ supported: "none",
347
+ confidence: 0,
348
+ preferred: "",
349
+ reason: error.message,
350
+ metadata: null,
351
+ variants: [],
352
+ warnings: [],
353
+ errors: [error.message]
354
+ };
355
+ }
356
+ }
357
+ function readWithValues(input, values = DEFAULT_VALUES) {
358
+ const bytes = toBytes(input);
359
+ const metadata = inspectWithValues(bytes, values);
360
+ if (values.emit === OUTPUT_BNK_JSON) return metadata;
361
+ if (values.emit === OUTPUT_MEDIA) {
362
+ return {
363
+ payloadType: OUTPUT_MEDIA,
364
+ sourceFormat: "bnk",
365
+ containerOnly: true,
366
+ isDecoded: false,
367
+ metadata,
368
+ items: extractMedia(bytes, metadata)
369
+ };
370
+ }
371
+ return {
372
+ payloadType: "raw",
373
+ sourceFormat: "bnk",
374
+ mimeType: "application/octet-stream",
375
+ containerOnly: true,
376
+ isDecoded: false,
377
+ pcmDecodeSupported: false,
378
+ metadata,
379
+ bytes
380
+ };
381
+ }
382
+ function toJsonValue(value) {
383
+ if (value instanceof Uint8Array) return {
384
+ byteLength: value.byteLength
385
+ };
386
+ if (Array.isArray(value)) return value.map(toJsonValue);
387
+ if (value && typeof value === "object") {
388
+ const output = {};
389
+ for (const [key, entry] of Object.entries(value)) output[key] = toJsonValue(entry);
390
+ return output;
391
+ }
392
+ return value;
393
+ }
394
+ function asciiString(bytes, offset, length) {
395
+ let value = "";
396
+ for (let i = 0; i < length; i++) value += String.fromCharCode(bytes[offset + i]);
397
+ return value;
398
+ }
399
+ function fourCc(bytes, offset, length = 4) {
400
+ let value = "";
401
+ for (let i = 0; i < length; i++) value += String.fromCharCode(bytes[offset + i] || 0);
402
+ return value;
403
+ }
404
+ function readU32(bytes, offset) {
405
+ return (bytes[offset] | bytes[offset + 1] << 8 | bytes[offset + 2] << 16 | bytes[offset + 3] * 0x1000000) >>> 0;
406
+ }
407
+
408
+ export { DEFAULT_VALUES, HIRC_TYPE_NAMES, OUTPUT_BNK_JSON, OUTPUT_JSON, OUTPUT_MEDIA, OUTPUT_RAW, extractMedia, inspectBNK, inspectWithValues, isBNK, isSupportedWithValues, normalizeEmit, normalizeValues, readWithValues, toBytes, toJsonValue };
409
+ //# sourceMappingURL=helpers.js.map