@carbonenginejs/runtime-resource 0.12.1 → 0.13.0

package/dist/formats/hlsl/core/tr2/resources/HlslEffectRes.js

@@ -1,314 +1,320 @@
-import { HlslReader } from '../../HlslReader.js';
-import { asUint8Array } from '@carbonenginejs/runtime-utils/bytes';
-import { HlslEffectStateManager } from '../../HlslEffectStateManager.js';
-import { HlslShader } from '../shader/HlslShader.js';
-import { HlslShaderOption } from '../shader/HlslShaderOption.js';
-import { HlslShaderPermutation } from './HlslShaderPermutation.js';
-
-const MIN_SUPPORTED_EFFECT_VERSION = 8;
-const MAX_SUPPORTED_EFFECT_VERSION = 15;
-
-/**
- * Carbon/Trinity effect resource reader for compiled shader metadata.
- */
-class HlslEffectRes {
-  static globalEffectOptions = [];
-
-  /**
-  * Creates an empty effect resource ready to load a compiled `.sm_*` payload.
-  */
-  constructor() {
-    this.m_data = new Uint8Array(0);
-    this.m_version = 0;
-    this.m_stringTable = new Uint8Array(0);
-    this.m_stringTableSize = 0;
-    this.m_offsets = [];
-    this.m_offsetCount = 0;
-    this.m_permutations = [];
-    this.m_shaders = new Map();
-    this.m_compilerVersion = null;
-    this.m_compilerVersionBytes = null;
-    this.m_hash = new Uint8Array(0);
-    this.sourcePath = "";
-    this.loadError = null;
-    this.effectStateManager = new HlslEffectStateManager();
-  }
-
-  /**
-  * Reads the effect header, string table, permutation axes, and body offsets.
-  *
-  * @param {ArrayBuffer|ArrayBufferView|Uint8Array} source Compiled effect bytes.
-  * @param {object} [options] Load metadata and dependency overrides.
-  * @param {string} [options.sourcePath] Source path used in reports.
-  * @param {string} [options.source] Alternate source label.
-  * @param {HlslEffectStateManager} [options.effectStateManager] Registry to receive decoded state.
-  * @returns {boolean} True when the header was decoded successfully.
-  */
-  DoLoad(source, options = {}) {
-    this._reset();
-    this.sourcePath = options.sourcePath || options.source || "";
-    this.effectStateManager = options.effectStateManager || new HlslEffectStateManager();
-    try {
-      // Carbon owns a memcpy of the loaded resource. Keep the JS graph
-      // equally isolated from later caller mutation.
-      this.m_data = Uint8Array.from(asUint8Array(source));
-      const stream = new HlslReader(this.m_data, {
-        source: this.sourcePath || "HlslEffectRes"
-      });
-      this.m_version = stream.readUint32();
-      if (this.m_version < MIN_SUPPORTED_EFFECT_VERSION || this.m_version > MAX_SUPPORTED_EFFECT_VERSION) {
-        throw new Error(`Unsupported HlslEffectRes version ${this.m_version}; expected ${MIN_SUPPORTED_EFFECT_VERSION}..${MAX_SUPPORTED_EFFECT_VERSION}`);
-      }
-      if (this.m_version >= 15) {
-        // The header slot is four bytes, not a u32:
-        // `constexpr uint8_t ShaderCompilerVersion[4]` = {major, minor,
-        // patch, tweak} (ShaderCompilerConfig.h.in:5), of which Carbon's
-        // rebuild check compares only the first three
-        // (ModifiedTime.cpp:77). A shipped v15 header reads `01 02 06 00`
-        // — compiler 1.2.6.0, matching the ShaderCompiler project
-        // version. As a u32 that is 0x00060201, which means nothing.
-        //
-        // `m_compilerVersionBytes` is the truthful reading and is what new
-        // code should use. `m_compilerVersion` keeps the dword form because
-        // it is republished as `source.compilerVersion` in the portable
-        // reflection, where it is asserted to be an unsigned integer
-        // (portableReflection.js:645) and covered by a package digest —
-        // changing its shape changes package bytes, which belongs with the
-        // format rewrite rather than here.
-        const compilerVersionBytes = stream.readRaw(4);
-        this.m_compilerVersionBytes = Array.from(compilerVersionBytes);
-        this.m_compilerVersion = new DataView(compilerVersionBytes.buffer, compilerVersionBytes.byteOffset, 4).getUint32(0, true);
-        this.m_hash = stream.readRaw(32);
-      }
-      this.m_stringTableSize = stream.readUint32();
-      if (this.m_stringTableSize > this.m_data.length || stream.offset + this.m_stringTableSize > this.m_data.length) {
-        throw new Error("Invalid effect string table size");
-      }
-      this.m_stringTable = this.m_data.subarray(stream.offset, stream.offset + this.m_stringTableSize);
-      stream.skip(this.m_stringTableSize);
-      stream.setStringTable(this.m_stringTable, this.m_stringTableSize);
-      const permutationCount = stream.readUint8();
-      for (let index = 0; index < permutationCount; index += 1) {
-        const permutation = new HlslShaderPermutation();
-        permutation.name = stream.readString();
-        permutation.defaultOption = stream.readUint8();
-        permutation.description = stream.readString();
-        permutation.type = this.m_version > 5 ? stream.readUint8() : 0;
-        const optionCount = stream.readUint8();
-        for (let optionIndex = 0; optionIndex < optionCount; optionIndex += 1) {
-          permutation.options.push(stream.readString());
-        }
-        this.m_permutations.push(permutation);
-      }
-      const headerSize = stream.readUint32();
-      if (headerSize === 0) {
-        throw new Error("Effect contains no compiled shader bodies");
-      }
-      this.m_offsetCount = headerSize;
-      for (let index = 0; index < headerSize; index += 1) {
-        const record = {
-          index: stream.readUint32(),
-          offset: stream.readUint32(),
-          size: stream.readUint32()
-        };
-        record.end = record.offset + record.size;
-        if (record.end > this.m_data.length) {
-          throw new Error(`Invalid effect body record ${index}`);
-        }
-        this.m_offsets.push(record);
-      }
-      return true;
-    } catch (error) {
-      this.loadError = error;
-      this.m_shaders.clear();
-      return false;
-    }
-  }
-
-  /**
-  * Mirrors Carbon's prepare hook by clearing cached shader bodies.
-  *
-  * @returns {boolean} True when preparation completed.
-  */
-  DoPrepare() {
-    this.m_shaders.clear();
-    return true;
-  }
-
-  /**
-  * Resolves a permutation option set to a decoded `HlslShader`.
-  *
-  * @param {Array<HlslShaderOption|object>|Map<string, string>} [options] Local option choices.
-  * @param {number|null} [count] Number of local option entries to consider.
-  * @returns {HlslShader|null} Decoded shader or null when no matching body exists.
-  */
-  GetShader(options = [], count = null) {
-    if (!this.IsGood()) {
-      return null;
-    }
-    const normalizedOptions = normalizeShaderOptions(options);
-    const optionCount = Number.isInteger(count) ? Math.min(count, normalizedOptions.length) : normalizedOptions.length;
-    let multiplier = 1;
-    let index = 0;
-    for (const permutation of this.m_permutations) {
-      let value = permutation.defaultOption;
-      const globalOption = HlslEffectRes.globalEffectOptions.find(entry => entry.name === permutation.name);
-      const localOption = normalizedOptions.slice(0, optionCount).find(entry => entry.name === permutation.name);
-      const selected = globalOption || localOption;
-      if (selected) {
-        const selectedIndex = permutation.options.findIndex(option => option === selected.value);
-        if (selectedIndex >= 0) {
-          value = selectedIndex;
-        }
-      }
-      index += value * multiplier;
-      multiplier *= permutation.options.length || 1;
-    }
-    return this.GetShaderByIndex(index);
-  }
-
-  /**
-  * Decodes the body at an exact permutation-table index without applying
-  * global or local option overrides.
-  *
-  * @param {number} index Exact zero-based permutation-table index.
-  * @returns {HlslShader|null} Decoded shader or null when the index/body is unavailable.
-  */
-  GetShaderByIndex(index) {
-    if (!Number.isSafeInteger(index) || index < 0) {
-      throw new TypeError("HlslEffectRes body index must be a non-negative safe integer");
-    }
-    if (!this.IsGood()) {
-      return null;
-    }
-    if (this.m_shaders.has(index)) {
-      return this.m_shaders.get(index);
-    }
-    const offset = this.m_offsets[index];
-    if (!offset) {
-      return null;
-    }
-    const shader = new HlslShader();
-    const buffer = this.m_data.subarray(offset.offset, offset.end);
-    const ok = shader.GetEffect().Read(buffer, offset.size, this.m_version, this.m_stringTable, this.m_stringTableSize, this.sourcePath, {
-      effectStateManager: this.effectStateManager
-    });
-    if (!ok) {
-      return null;
-    }
-    shader.ProcessEffect();
-    this.m_shaders.set(index, shader);
-    return shader;
-  }
-
-  /**
-  * Reports whether the effect header has been loaded without error.
-  *
-  * @returns {boolean} True when this resource has usable effect data.
-  */
-  IsGood() {
-    return !this.loadError && this.m_data.length > 0 && this.m_version >= MIN_SUPPORTED_EFFECT_VERSION;
-  }
-
-  /**
-  * Reports whether byte memory usage is known for this resource.
-  *
-  * @returns {boolean} Always true for byte-backed JavaScript resources.
-  */
-  IsMemoryUsageKnown() {
-    return true;
-  }
-
-  /**
-  * Returns the byte size of the loaded effect payload.
-  *
-  * @returns {number} Loaded byte count.
-  */
-  GetMemoryUsage() {
-    return this.m_data.length;
-  }
-
-  /**
-  * Clears decoded shader body caches while keeping the loaded header data.
-  */
-  ReleaseResources() {
-    this.m_shaders.clear();
-  }
-
-  /**
-  * Returns JSON-safe permutation metadata for tooling and reports.
-  *
-  * @returns {object[]} Permutation descriptions.
-  */
-  GetPermutationDescription() {
-    return this.m_permutations.map(permutation => permutation.toJSON());
-  }
-
-  /**
-  * Returns a JSON-safe summary of the loaded effect resource.
-  *
-  * @returns {object} Serializable effect resource summary.
-  */
-  toJSON() {
-    return {
-      version: this.m_version,
-      compilerVersion: this.m_compilerVersion,
-      compilerVersionBytes: this.m_compilerVersionBytes,
-      sourcePath: this.sourcePath,
-      stringTableSize: this.m_stringTableSize,
-      offsetCount: this.m_offsetCount,
-      permutations: this.m_permutations.map(entry => entry.toJSON()),
-      offsets: this.m_offsets.map(entry => ({
-        ...entry
-      })),
-      loadError: this.loadError ? {
-        name: this.loadError.name,
-        message: this.loadError.message
-      } : null
-    };
-  }
-
-  /**
-  * Resets loaded state before a new `DoLoad` attempt.
-  *
-  * @private
-  */
-  _reset() {
-    this.m_data = new Uint8Array(0);
-    this.m_version = 0;
-    this.m_stringTable = new Uint8Array(0);
-    this.m_stringTableSize = 0;
-    this.m_offsets = [];
-    this.m_offsetCount = 0;
-    this.m_permutations = [];
-    this.m_shaders = new Map();
-    this.m_compilerVersion = null;
-    this.m_compilerVersionBytes = null;
-    this.m_hash = new Uint8Array(0);
-    this.loadError = null;
-  }
-}
-
-/**
- * Converts supported option input shapes to `HlslShaderOption` instances.
- *
- * @param {Array<HlslShaderOption|object>|Map<string, string>} options Option input.
- * @returns {HlslShaderOption[]} Normalized option list.
- */
-function normalizeShaderOptions(options) {
-  if (options instanceof Map) {
-    return Array.from(options.entries()).map(([name, value]) => new HlslShaderOption(name, value));
-  }
-  if (!Array.isArray(options)) {
-    return [];
-  }
-  return options.map(entry => {
-    if (entry instanceof HlslShaderOption) {
-      return entry;
-    }
-    return new HlslShaderOption(entry?.name || "", entry?.value || "");
-  });
-}
-
-export { HlslEffectRes };
-//# sourceMappingURL=HlslEffectRes.js.map
+import { asUint8Array } from '@carbonenginejs/runtime-utils/bytes';
+import { HlslEffectStateManager } from '../../HlslEffectStateManager.js';
+import { HlslShader } from '../shader/HlslShader.js';
+import { HlslShaderBytecode } from '../../HlslShaderBytecode.js';
+import { HlslShaderOption } from '../shader/HlslShaderOption.js';
+import { HlslShaderPermutation } from './HlslShaderPermutation.js';
+import { hlslShaderStageName } from '../HlslRenderContextEnum.js';
+import { runtimeDescriptionFromCarbon } from '../../carbonDescriptionToRuntime.js';
+import { CjsCarbonEffectReader } from '../../../../../format/carbonEffect/CjsCarbonEffectReader.js';
+import { CARBON_EFFECT_MIN_DATA_VERSION } from '../../../../../format/carbonEffect/carbonEffectRecords.js';
+
+/**
+ * Carbon/Trinity effect resource reader for compiled shader metadata.
+ */
+class HlslEffectRes {
+  static globalEffectOptions = [];
+
+  /**
+  * Creates an empty effect resource ready to load a compiled `.sm_*` payload.
+  */
+  constructor() {
+    this.m_data = new Uint8Array(0);
+    this.m_reader = null;
+    this.m_version = 0;
+    this.m_stringTable = new Uint8Array(0);
+    this.m_stringTableSize = 0;
+    this.m_offsets = [];
+    this.m_offsetCount = 0;
+    this.m_permutations = [];
+    this.m_shaders = new Map();
+    this.m_compilerVersion = null;
+    this.m_compilerVersionBytes = null;
+    this.m_hash = new Uint8Array(0);
+    this.sourcePath = "";
+    this.loadError = null;
+    this.effectStateManager = new HlslEffectStateManager();
+  }
+
+  /**
+  * Reads the effect header, string table, permutation axes, and body offsets.
+  *
+  * @param {ArrayBuffer|ArrayBufferView|Uint8Array} source Compiled effect bytes.
+  * @param {object} [options] Load metadata and dependency overrides.
+  * @param {string} [options.sourcePath] Source path used in reports.
+  * @param {string} [options.source] Alternate source label.
+  * @param {HlslEffectStateManager} [options.effectStateManager] Registry to receive decoded state.
+  * @returns {boolean} True when the header was decoded successfully.
+  */
+  DoLoad(source, options = {}) {
+    this._reset();
+    this.sourcePath = options.sourcePath || options.source || "";
+    this.effectStateManager = options.effectStateManager || new HlslEffectStateManager();
+    try {
+      // Carbon owns a memcpy of the loaded resource. Keep the JS graph
+      // equally isolated from later caller mutation.
+      this.m_data = Uint8Array.from(asUint8Array(source));
+
+      // One header walk, for every accepted version. This header -
+      // version, compiler version and source hash where present, arena,
+      // permutation axes, offset table - is the layout
+      // `CjsCarbonEffectReader` parses, and two hand-written copies of
+      // one layout are two chances to disagree. Reading it there also
+      // brings three checks a local walk never had: the offset table
+      // must be dense and positionally indexed, and the body region must
+      // begin exactly where the header ends. Carbon indexes that table
+      // positionally without ever reading the stored index, so a sparse
+      // or misordered table does not fail there - it silently returns
+      // the wrong shader body, which is the failure class the container
+      // port exists to close.
+      const reader = new CjsCarbonEffectReader(this.m_data, {
+        source: this.sourcePath || "HlslEffectRes"
+      });
+      this.m_reader = reader;
+      this.m_version = reader.version;
+      if (reader.compilerVersion) {
+        this.m_compilerVersionBytes = reader.compilerVersion;
+        this.m_compilerVersion = new DataView(Uint8Array.from(reader.compilerVersion).buffer).getUint32(0, true);
+      }
+      this.m_hash = reader.sourceHash ?? new Uint8Array(0);
+      this.m_stringTableSize = reader.stringTableSize;
+      this.m_stringTable = reader.stringTableBytes;
+      for (const axis of reader.permutations) {
+        const permutation = new HlslShaderPermutation();
+        permutation.name = axis.name.value;
+        permutation.defaultOption = axis.defaultOption;
+        permutation.description = axis.description.value;
+        permutation.type = axis.type;
+        for (const option of axis.options) permutation.options.push(option.value);
+        this.m_permutations.push(permutation);
+      }
+      this.m_offsetCount = reader.records.length;
+      for (const record of reader.records) {
+        this.m_offsets.push({
+          index: record.index,
+          offset: record.offset,
+          size: record.size,
+          end: record.offset + record.size
+        });
+      }
+      return true;
+    } catch (error) {
+      this.loadError = error;
+      this.m_shaders.clear();
+      return false;
+    }
+  }
+
+  /**
+  * Mirrors Carbon's prepare hook by clearing cached shader bodies.
+  *
+  * @returns {boolean} True when preparation completed.
+  */
+  DoPrepare() {
+    this.m_shaders.clear();
+    return true;
+  }
+
+  /**
+  * Resolves a permutation option set to a decoded `HlslShader`.
+  *
+  * @param {Array<HlslShaderOption|object>|Map<string, string>} [options] Local option choices.
+  * @param {number|null} [count] Number of local option entries to consider.
+  * @returns {HlslShader|null} Decoded shader or null when no matching body exists.
+  */
+  GetShader(options = [], count = null) {
+    if (!this.IsGood()) {
+      return null;
+    }
+    const normalizedOptions = normalizeShaderOptions(options);
+    const optionCount = Number.isInteger(count) ? Math.min(count, normalizedOptions.length) : normalizedOptions.length;
+    let multiplier = 1;
+    let index = 0;
+    for (const permutation of this.m_permutations) {
+      let value = permutation.defaultOption;
+      const globalOption = HlslEffectRes.globalEffectOptions.find(entry => entry.name === permutation.name);
+      const localOption = normalizedOptions.slice(0, optionCount).find(entry => entry.name === permutation.name);
+      const selected = globalOption || localOption;
+      if (selected) {
+        const selectedIndex = permutation.options.findIndex(option => option === selected.value);
+        if (selectedIndex >= 0) {
+          value = selectedIndex;
+        }
+      }
+      index += value * multiplier;
+      multiplier *= permutation.options.length || 1;
+    }
+    return this.GetShaderByIndex(index);
+  }
+
+  /**
+  * Decodes the body at an exact permutation-table index without applying
+  * global or local option overrides.
+  *
+  * @param {number} index Exact zero-based permutation-table index.
+  * @returns {HlslShader|null} Decoded shader or null when the index/body is unavailable.
+  */
+  GetShaderByIndex(index) {
+    if (!Number.isSafeInteger(index) || index < 0) {
+      throw new TypeError("HlslEffectRes body index must be a non-negative safe integer");
+    }
+    if (!this.IsGood()) {
+      return null;
+    }
+    if (this.m_shaders.has(index)) {
+      return this.m_shaders.get(index);
+    }
+    const offset = this.m_offsets[index];
+    if (!offset || !this.m_reader) {
+      return null;
+    }
+
+    // The retained container reader decodes the body's record tree - the
+    // single byte-reading implementation - and the corpus-proven adapter
+    // maps those records onto the runtime shape. The record tree is a
+    // transient internal handoff, never exposed or persisted.
+    try {
+      const records = this.m_reader.readDescription(index);
+      const built = runtimeDescriptionFromCarbon(records, {
+        effectName: this.sourcePath,
+        version: this.m_version,
+        effectStateManager: this.effectStateManager,
+        bytecodeFor: (stage, stageType) => new HlslShaderBytecode({
+          stageType,
+          stageName: hlslShaderStageName(stageType),
+          bytes: stage.shaderData.bytes,
+          shaderSize: stage.shaderData.size,
+          stringTableOffset: stage.shaderData.offset,
+          effectName: this.sourcePath
+        })
+      });
+      const shader = new HlslShader();
+      const description = shader.GetEffect();
+      description.version = this.m_version;
+      description.effectName = this.sourcePath;
+      description.effectStateManager = built.effectStateManager;
+      description.techniques = built.techniques;
+      description.annotations = built.annotations;
+      shader.ProcessEffect();
+      this.m_shaders.set(index, shader);
+      return shader;
+    } catch {
+      // Mirrors the historical reader contract: an undecodable body is
+      // reported as absent rather than thrown, and is not cached so a
+      // later caller sees the same result.
+      return null;
+    }
+  }
+
+  /**
+  * Reports whether the effect header has been loaded without error.
+  *
+  * @returns {boolean} True when this resource has usable effect data.
+  */
+  IsGood() {
+    return !this.loadError && this.m_data.length > 0 && this.m_version >= CARBON_EFFECT_MIN_DATA_VERSION;
+  }
+
+  /**
+  * Reports whether byte memory usage is known for this resource.
+  *
+  * @returns {boolean} Always true for byte-backed JavaScript resources.
+  */
+  IsMemoryUsageKnown() {
+    return true;
+  }
+
+  /**
+  * Returns the byte size of the loaded effect payload.
+  *
+  * @returns {number} Loaded byte count.
+  */
+  GetMemoryUsage() {
+    return this.m_data.length;
+  }
+
+  /**
+  * Clears decoded shader body caches while keeping the loaded header data.
+  */
+  ReleaseResources() {
+    this.m_shaders.clear();
+  }
+
+  /**
+  * Returns JSON-safe permutation metadata for tooling and reports.
+  *
+  * @returns {object[]} Permutation descriptions.
+  */
+  GetPermutationDescription() {
+    return this.m_permutations.map(permutation => permutation.toJSON());
+  }
+
+  /**
+  * Returns a JSON-safe summary of the loaded effect resource.
+  *
+  * @returns {object} Serializable effect resource summary.
+  */
+  toJSON() {
+    return {
+      version: this.m_version,
+      compilerVersion: this.m_compilerVersion,
+      compilerVersionBytes: this.m_compilerVersionBytes,
+      sourcePath: this.sourcePath,
+      stringTableSize: this.m_stringTableSize,
+      offsetCount: this.m_offsetCount,
+      permutations: this.m_permutations.map(entry => entry.toJSON()),
+      offsets: this.m_offsets.map(entry => ({
+        ...entry
+      })),
+      loadError: this.loadError ? {
+        name: this.loadError.name,
+        message: this.loadError.message
+      } : null
+    };
+  }
+
+  /**
+  * Resets loaded state before a new `DoLoad` attempt.
+  *
+  * @private
+  */
+  _reset() {
+    this.m_data = new Uint8Array(0);
+    this.m_reader = null;
+    this.m_version = 0;
+    this.m_stringTable = new Uint8Array(0);
+    this.m_stringTableSize = 0;
+    this.m_offsets = [];
+    this.m_offsetCount = 0;
+    this.m_permutations = [];
+    this.m_shaders = new Map();
+    this.m_compilerVersion = null;
+    this.m_compilerVersionBytes = null;
+    this.m_hash = new Uint8Array(0);
+    this.loadError = null;
+  }
+}
+
+/**
+ * Converts supported option input shapes to `HlslShaderOption` instances.
+ *
+ * @param {Array<HlslShaderOption|object>|Map<string, string>} options Option input.
+ * @returns {HlslShaderOption[]} Normalized option list.
+ */
+function normalizeShaderOptions(options) {
+  if (options instanceof Map) {
+    return Array.from(options.entries()).map(([name, value]) => new HlslShaderOption(name, value));
+  }
+  if (!Array.isArray(options)) {
+    return [];
+  }
+  return options.map(entry => {
+    if (entry instanceof HlslShaderOption) {
+      return entry;
+    }
+    return new HlslShaderOption(entry?.name || "", entry?.value || "");
+  });
+}
+
+export { HlslEffectRes };
+//# sourceMappingURL=HlslEffectRes.js.map