@loaders.gl/gltf 4.0.0-alpha.5 → 4.0.0-alpha.7

package/dist/lib/parsers/parse-glb.js

@@ -1,128 +1,166 @@
-import { padToNBytes, assert } from '@loaders.gl/loader-utils';
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseGLBSync = exports.isGLB = void 0;
+const loader_utils_1 = require("@loaders.gl/loader-utils");
+/** Binary GLTF is little endian. */
+const LITTLE_ENDIAN = true;
+/** 'glTF' in Big-Endian ASCII */
 const MAGIC_glTF = 0x676c5446;
 const GLB_FILE_HEADER_SIZE = 12;
 const GLB_CHUNK_HEADER_SIZE = 8;
 const GLB_CHUNK_TYPE_JSON = 0x4e4f534a;
 const GLB_CHUNK_TYPE_BIN = 0x004e4942;
+const GLB_V1_CONTENT_FORMAT_JSON = 0x0;
+/** @deprecated - Backward compatibility for old xviz files */
 const GLB_CHUNK_TYPE_JSON_XVIZ_DEPRECATED = 0;
+/** @deprecated - Backward compatibility for old xviz files */
 const GLB_CHUNK_TYPE_BIX_XVIZ_DEPRECATED = 1;
-const GLB_V1_CONTENT_FORMAT_JSON = 0x0;
-const LE = true;
-
 function getMagicString(dataView, byteOffset = 0) {
-  return "".concat(String.fromCharCode(dataView.getUint8(byteOffset + 0))).concat(String.fromCharCode(dataView.getUint8(byteOffset + 1))).concat(String.fromCharCode(dataView.getUint8(byteOffset + 2))).concat(String.fromCharCode(dataView.getUint8(byteOffset + 3)));
+    return `\
+${String.fromCharCode(dataView.getUint8(byteOffset + 0))}\
+${String.fromCharCode(dataView.getUint8(byteOffset + 1))}\
+${String.fromCharCode(dataView.getUint8(byteOffset + 2))}\
+${String.fromCharCode(dataView.getUint8(byteOffset + 3))}`;
 }
-
-export function isGLB(arrayBuffer, byteOffset = 0, options = {}) {
-  const dataView = new DataView(arrayBuffer);
-  const {
-    magic = MAGIC_glTF
-  } = options;
-  const magic1 = dataView.getUint32(byteOffset, false);
-  return magic1 === magic || magic1 === MAGIC_glTF;
+/** Check if the contents of an array buffer contains GLB byte markers */
+function isGLB(arrayBuffer, byteOffset = 0, options = {}) {
+    const dataView = new DataView(arrayBuffer);
+    // Check that GLB Header starts with the magic number
+    const { magic = MAGIC_glTF } = options;
+    const magic1 = dataView.getUint32(byteOffset, false);
+    return magic1 === magic || magic1 === MAGIC_glTF;
 }
-export default function parseGLBSync(glb, arrayBuffer, byteOffset = 0, options = {}) {
-  const dataView = new DataView(arrayBuffer);
-  const type = getMagicString(dataView, byteOffset + 0);
-  const version = dataView.getUint32(byteOffset + 4, LE);
-  const byteLength = dataView.getUint32(byteOffset + 8, LE);
-  Object.assign(glb, {
-    header: {
-      byteOffset,
-      byteLength,
-      hasBinChunk: false
-    },
-    type,
-    version,
-    json: {},
-    binChunks: []
-  });
-  byteOffset += GLB_FILE_HEADER_SIZE;
-
-  switch (glb.version) {
-    case 1:
-      return parseGLBV1(glb, dataView, byteOffset);
-
-    case 2:
-      return parseGLBV2(glb, dataView, byteOffset, options = {});
-
-    default:
-      throw new Error("Invalid GLB version ".concat(glb.version, ". Only supports v1 and v2."));
-  }
+exports.isGLB = isGLB;
+/**
+ * Synchronously parse a GLB
+ * @param glb - Target, Output is stored there
+ * @param arrayBuffer - Input data
+ * @param byteOffset - Offset into arrayBuffer to start parsing from (for "embedded" GLBs, e.g. in 3D tiles)
+ * @param options
+ * @returns
+ */
+function parseGLBSync(glb, arrayBuffer, byteOffset = 0, options = {}) {
+    // Check that GLB Header starts with the magic number
+    const dataView = new DataView(arrayBuffer);
+    // Compare format with GLBLoader documentation
+    const type = getMagicString(dataView, byteOffset + 0);
+    const version = dataView.getUint32(byteOffset + 4, LITTLE_ENDIAN); // Version 2 of binary glTF container format
+    const byteLength = dataView.getUint32(byteOffset + 8, LITTLE_ENDIAN); // Total byte length of binary file
+    Object.assign(glb, {
+        // Put less important stuff in a header, to avoid clutter
+        header: {
+            byteOffset,
+            byteLength,
+            hasBinChunk: false
+        },
+        type,
+        version,
+        json: {},
+        binChunks: []
+    });
+    byteOffset += GLB_FILE_HEADER_SIZE;
+    switch (glb.version) {
+        case 1:
+            return parseGLBV1(glb, dataView, byteOffset);
+        case 2:
+            return parseGLBV2(glb, dataView, byteOffset, (options = {}));
+        default:
+            throw new Error(`Invalid GLB version ${glb.version}. Only supports version 1 and 2.`);
+    }
 }
-
+exports.parseGLBSync = parseGLBSync;
+/**
+ * Parse a V1 GLB
+ * @param glb - target, output is stored in this object
+ * @param dataView - Input, memory to be parsed
+ * @param byteOffset - Offset of first byte of GLB data in the data view
+ * @returns Number of bytes parsed (there could be additional non-GLB data after the GLB)
+ */
 function parseGLBV1(glb, dataView, byteOffset) {
-  assert(glb.header.byteLength > GLB_FILE_HEADER_SIZE + GLB_CHUNK_HEADER_SIZE);
-  const contentLength = dataView.getUint32(byteOffset + 0, LE);
-  const contentFormat = dataView.getUint32(byteOffset + 4, LE);
-  byteOffset += GLB_CHUNK_HEADER_SIZE;
-  assert(contentFormat === GLB_V1_CONTENT_FORMAT_JSON);
-  parseJSONChunk(glb, dataView, byteOffset, contentLength);
-  byteOffset += contentLength;
-  byteOffset += parseBINChunk(glb, dataView, byteOffset, glb.header.byteLength);
-  return byteOffset;
+    // Sanity: ensure file is big enough to hold at least the headers
+    (0, loader_utils_1.assert)(glb.header.byteLength > GLB_FILE_HEADER_SIZE + GLB_CHUNK_HEADER_SIZE);
+    // Explanation of GLB structure:
+    // https://cloud.githubusercontent.com/assets/3479527/22600725/36b87122-ea55-11e6-9d40-6fd42819fcab.png
+    const contentLength = dataView.getUint32(byteOffset + 0, LITTLE_ENDIAN); // Byte length of chunk
+    const contentFormat = dataView.getUint32(byteOffset + 4, LITTLE_ENDIAN); // Chunk format as uint32
+    byteOffset += GLB_CHUNK_HEADER_SIZE;
+    // GLB v1 only supports a single chunk type
+    (0, loader_utils_1.assert)(contentFormat === GLB_V1_CONTENT_FORMAT_JSON);
+    parseJSONChunk(glb, dataView, byteOffset, contentLength);
+    // No need to call the function padToBytes() from parseJSONChunk()
+    byteOffset += contentLength;
+    byteOffset += parseBINChunk(glb, dataView, byteOffset, glb.header.byteLength);
+    return byteOffset;
 }
-
+/**
+ * Parse a V2 GLB
+ * @param glb - target, output is stored in this object
+ * @param dataView - Input, memory to be parsed
+ * @param byteOffset - Offset of first byte of GLB data in the data view
+ * @returns Number of bytes parsed (there could be additional non-GLB data after the GLB)
+ */
 function parseGLBV2(glb, dataView, byteOffset, options) {
-  assert(glb.header.byteLength > GLB_FILE_HEADER_SIZE + GLB_CHUNK_HEADER_SIZE);
-  parseGLBChunksSync(glb, dataView, byteOffset, options);
-  return byteOffset + glb.header.byteLength;
+    // Sanity: ensure file is big enough to hold at least the first chunk header
+    (0, loader_utils_1.assert)(glb.header.byteLength > GLB_FILE_HEADER_SIZE + GLB_CHUNK_HEADER_SIZE);
+    parseGLBChunksSync(glb, dataView, byteOffset, options);
+    return byteOffset + glb.header.byteLength;
 }
-
+/** Iterate over GLB chunks and parse them */
 function parseGLBChunksSync(glb, dataView, byteOffset, options) {
-  while (byteOffset + 8 <= glb.header.byteLength) {
-    const chunkLength = dataView.getUint32(byteOffset + 0, LE);
-    const chunkFormat = dataView.getUint32(byteOffset + 4, LE);
-    byteOffset += GLB_CHUNK_HEADER_SIZE;
-
-    switch (chunkFormat) {
-      case GLB_CHUNK_TYPE_JSON:
-        parseJSONChunk(glb, dataView, byteOffset, chunkLength);
-        break;
-
-      case GLB_CHUNK_TYPE_BIN:
-        parseBINChunk(glb, dataView, byteOffset, chunkLength);
-        break;
-
-      case GLB_CHUNK_TYPE_JSON_XVIZ_DEPRECATED:
-        if (!options.strict) {
-          parseJSONChunk(glb, dataView, byteOffset, chunkLength);
-        }
-
-        break;
-
-      case GLB_CHUNK_TYPE_BIX_XVIZ_DEPRECATED:
-        if (!options.strict) {
-          parseBINChunk(glb, dataView, byteOffset, chunkLength);
+    // Per spec we must iterate over chunks, ignoring all except JSON and BIN
+    // Iterate as long as there is space left for another chunk header
+    while (byteOffset + 8 <= glb.header.byteLength) {
+        const chunkLength = dataView.getUint32(byteOffset + 0, LITTLE_ENDIAN); // Byte length of chunk
+        const chunkFormat = dataView.getUint32(byteOffset + 4, LITTLE_ENDIAN); // Chunk format as uint32
+        byteOffset += GLB_CHUNK_HEADER_SIZE;
+        // Per spec we must iterate over chunks, ignoring all except JSON and BIN
+        switch (chunkFormat) {
+            case GLB_CHUNK_TYPE_JSON:
+                parseJSONChunk(glb, dataView, byteOffset, chunkLength);
+                break;
+            case GLB_CHUNK_TYPE_BIN:
+                parseBINChunk(glb, dataView, byteOffset, chunkLength);
+                break;
+            // Backward compatibility for very old xviz files
+            case GLB_CHUNK_TYPE_JSON_XVIZ_DEPRECATED:
+                if (!options.strict) {
+                    parseJSONChunk(glb, dataView, byteOffset, chunkLength);
+                }
+                break;
+            case GLB_CHUNK_TYPE_BIX_XVIZ_DEPRECATED:
+                if (!options.strict) {
+                    parseBINChunk(glb, dataView, byteOffset, chunkLength);
+                }
+                break;
+            default:
+                // Ignore, per spec
+                // console.warn(`Unknown GLB chunk type`); // eslint-disable-line
+                break;
         }
-
-        break;
-
-      default:
-        break;
+        byteOffset += (0, loader_utils_1.padToNBytes)(chunkLength, 4);
     }
-
-    byteOffset += padToNBytes(chunkLength, 4);
-  }
-
-  return byteOffset;
+    return byteOffset;
 }
-
+/* Parse a GLB JSON chunk */
 function parseJSONChunk(glb, dataView, byteOffset, chunkLength) {
-  const jsonChunk = new Uint8Array(dataView.buffer, byteOffset, chunkLength);
-  const textDecoder = new TextDecoder('utf8');
-  const jsonText = textDecoder.decode(jsonChunk);
-  glb.json = JSON.parse(jsonText);
-  return padToNBytes(chunkLength, 4);
+    // 1. Create a "view" of the binary encoded JSON data inside the GLB
+    const jsonChunk = new Uint8Array(dataView.buffer, byteOffset, chunkLength);
+    // 2. Decode the JSON binary array into clear text
+    const textDecoder = new TextDecoder('utf8');
+    const jsonText = textDecoder.decode(jsonChunk);
+    // 3. Parse the JSON text into a JavaScript data structure
+    glb.json = JSON.parse(jsonText);
+    return (0, loader_utils_1.padToNBytes)(chunkLength, 4);
 }
-
+/** Parse a GLB BIN chunk */
 function parseBINChunk(glb, dataView, byteOffset, chunkLength) {
-  glb.header.hasBinChunk = true;
-  glb.binChunks.push({
-    byteOffset,
-    byteLength: chunkLength,
-    arrayBuffer: dataView.buffer
-  });
-  return padToNBytes(chunkLength, 4);
+    // Note: BIN chunk can be optional
+    glb.header.hasBinChunk = true;
+    glb.binChunks.push({
+        byteOffset,
+        byteLength: chunkLength,
+        arrayBuffer: dataView.buffer
+        // TODO - copy, or create typed array view?
+    });
+    return (0, loader_utils_1.padToNBytes)(chunkLength, 4);
 }
-//# sourceMappingURL=parse-glb.js.map

package/dist/lib/parsers/parse-gltf.d.ts

@@ -1,14 +1,18 @@
 import type { LoaderContext } from '@loaders.gl/loader-utils';
 import type { GLTFLoaderOptions } from '../../gltf-loader';
 import type { GLTFWithBuffers } from '../types/gltf-types';
-export declare type GLTFParseOptions = {
+import type { ParseGLBOptions } from './parse-glb';
+/**  */
+export type ParseGLTFOptions = ParseGLBOptions & {
     normalize?: boolean;
     loadImages?: boolean;
     loadBuffers?: boolean;
     decompressMeshes?: boolean;
-    postProcess?: boolean;
     excludeExtensions?: string[];
+    /** @deprecated not supported in v4. `postProcessGLTF()` must be called by the application */
+    postProcess?: false;
 };
-export declare function isGLTF(arrayBuffer: any, options?: any): boolean;
-export declare function parseGLTF(gltf: GLTFWithBuffers, arrayBufferOrString: any, byteOffset: number | undefined, options: GLTFLoaderOptions, context: LoaderContext): Promise<Record<string, any>>;
+/** Check if an array buffer appears to contain GLTF data */
+export declare function isGLTF(arrayBuffer: ArrayBuffer, options?: ParseGLTFOptions): boolean;
+export declare function parseGLTF(gltf: GLTFWithBuffers, arrayBufferOrString: any, byteOffset: number | undefined, options: GLTFLoaderOptions, context: LoaderContext): Promise<GLTFWithBuffers>;
 //# sourceMappingURL=parse-gltf.d.ts.map

package/dist/lib/parsers/parse-gltf.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parse-gltf.d.ts","sourceRoot":"","sources":["../../../src/lib/parsers/parse-gltf.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,0BAA0B,CAAC;AAE5D,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,mBAAmB,CAAC;AAEzD,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,qBAAqB,CAAC;AAYzD,oBAAY,gBAAgB,GAAG;IAC7B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC9B,CAAC;AAMF,wBAAgB,MAAM,CAAC,WAAW,KAAA,EAAE,OAAO,CAAC,KAAA,GAAG,OAAO,CAGrD;AAED,wBAAsB,SAAS,CAC7B,IAAI,EAAE,eAAe,EACrB,mBAAmB,KAAA,EACnB,UAAU,oBAAI,EACd,OAAO,EAAE,iBAAiB,EAC1B,OAAO,EAAE,aAAa,gCA4BvB"}
+{"version":3,"file":"parse-gltf.d.ts","sourceRoot":"","sources":["../../../src/lib/parsers/parse-gltf.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,0BAA0B,CAAC;AAC5D,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,qBAAqB,CAAC;AAEzD,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,aAAa,CAAC;AAajD,OAAO;AACP,MAAM,MAAM,gBAAgB,GAAG,eAAe,GAAG;IAC/C,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE7B,6FAA6F;IAC7F,WAAW,CAAC,EAAE,KAAK,CAAC;CACrB,CAAC;AAEF,4DAA4D;AAC5D,wBAAgB,MAAM,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAGpF;AAED,wBAAsB,SAAS,CAC7B,IAAI,EAAE,eAAe,EACrB,mBAAmB,KAAA,EACnB,UAAU,oBAAI,EACd,OAAO,EAAE,iBAAiB,EAC1B,OAAO,EAAE,aAAa,GACrB,OAAO,CAAC,eAAe,CAAC,CA0B1B"}