import { padToNBytes, assert } from '@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; function getMagicString(dataView, byteOffset = 0) { 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))}`; } /** Check if the contents of an array buffer contains GLB byte markers */ export 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; } /** * 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 */ export 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, // Byte offset into the initial arrayBuffer 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.`); } } /** * 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) { // Sanity: ensure file is big enough to hold at least the headers 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 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) { // Sanity: ensure file is big enough to hold at least the first chunk header 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) { // 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; } byteOffset += padToNBytes(chunkLength, 4); } return byteOffset; } /* Parse a GLB JSON chunk */ function parseJSONChunk(glb, dataView, byteOffset, chunkLength) { // 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 padToNBytes(chunkLength, 4); } /** Parse a GLB BIN chunk */ function parseBINChunk(glb, dataView, byteOffset, chunkLength) { // 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 padToNBytes(chunkLength, 4); }