Add KTX2 support and remove KTX/CRN

.vscode/settings.json

@@ -17,7 +17,10 @@
         "Source/Shaders/**/*.js": true
     },
     "files.associations": {
-        "*.czml": "json"
+        "*.czml": "json",
+        "array": "cpp",
+        "string": "cpp",
+        "string_view": "cpp"
     },
     "eslint.enable": true,
     "javascript.format.insertSpaceAfterCommaDelimiter": true,

Apps/Sandcastle/gallery/3D Models.html

@@ -133,6 +133,15 @@
               );
             },
           },
+          {
+            text: "KTX2 Compressed Balloon",
+            onselect: function () {
+              createModel(
+                "../../SampleData/models/CesiumBalloonKTX2/CesiumBalloonKTX2.glb",
+                1000.0
+              );
+            },
+          },
         ];
 
         Sandcastle.addToolbarMenu(options);

Source/Core/getUint64FromDataView.js

@@ -23,10 +23,10 @@ function getUint64FromDataView(view, byteOffset, littleEndian) {
     ? left + Math.pow(2, 32) * right
     : Math.pow(2, 32) * left + right;
 
-  if (!combined > Number.MAX_SAFE_INTEGER) {
-    //9007199254740991) { // MAX_SAFE_INTEGER not available in IE11
-    console.warn(combined, "exceeds MAX_SAFE_INTEGER. Precision may be lost");
-  }
+  // if (!combined > Number.MAX_SAFE_INTEGER) {
+  //   //9007199254740991) { // MAX_SAFE_INTEGER not available in IE11
+  //   console.warn(combined, "exceeds MAX_SAFE_INTEGER. Precision may be lost");
+  // }
 
   return combined;
 }

Source/Core/loadKTX2.js

@@ -1,6 +1,6 @@
 import arraySlice from "./arraySlice.js";
-import Check from "./Check";
-import defined from "./defined";
+import Check from "./Check.js";
+import defined from "./defined.js";
 import Resource from "./Resource.js";
 import RuntimeError from "./RuntimeError.js";
 import KTX2Transcoder from "../Scene/KTX2Transcoder.js";

Source/Scene/KTX2Transcoder.js

@@ -19,8 +19,8 @@ KTX2Transcoder._readyPromise = undefined;
 function makeReadyPromise() {
   var readyPromise = KTX2Transcoder._transcodeTaskProcessor
     .initWebAssemblyModule({
-      modulePath: "ThirdParty/Workers/msc_basis_transcoder.js",
-      wasmBinaryFile: "ThirdParty/msc_basis_transcoder.wasm",
+      modulePath: "ThirdParty/Workers/basis_transcoder.js",
+      wasmBinaryFile: "ThirdParty/basis_transcoder.wasm",
     })
     .then(function () {
       return KTX2Transcoder._transcodeTaskProcessor;
@@ -70,7 +70,11 @@ KTX2Transcoder.transcode = function (ktx2Buffer, supportedTargetFormats) {
           result = result[0];
         }
       }
+      console.log(result);
       return result;
+    })
+    .otherwise(function (error) {
+      console.log(error.message);
     });
 };
 

Source/Scene/ModelUtility.js

@@ -564,6 +564,7 @@ ModelUtility.supportedExtensions = {
   EXT_texture_webp: true,
   KHR_blend: true,
   KHR_binary_glTF: true,
+  KHR_texture_basisu: true,
   KHR_draco_mesh_compression: true,
   KHR_materials_common: true,
   KHR_techniques_webgl: true,

Source/Scene/parseKTX2.js

@@ -98,7 +98,7 @@ function parseKTX2(data, supportedTargetFormats, transcoderModule) {
   };
   byteOffset += sizeOfUint32;
 
-  // Index
+  // 1 -- Index
   var dfdByteOffset = view.getUint32(byteOffset, true);
   byteOffset += sizeOfUint32;
   // var dfdByteLength = view.getUint32(byteOffset, true);
@@ -260,139 +260,98 @@ function transcodeEtc1s(
   transcoderModule,
   result
 ) {
-  var ktx2Offset = defined(data.buffer) ? data.byteOffset : 0;
-  var byteOffset = ktx2Offset + sgdIndex.byteOffset;
-  var isVideo = header.layerCount !== 0; // Should be false until video support is added
-
-  // Read rest of SGD data
-  var endpointCount = view.getUint16(byteOffset, true);
-  byteOffset += sizeOfUint16;
-  var selectorCount = view.getUint16(byteOffset, true);
-  byteOffset += sizeOfUint16;
-  var endpointsByteLength = view.getUint32(byteOffset, true);
-  byteOffset += sizeOfUint32;
-  var selectorsByteLength = view.getUint32(byteOffset, true);
-  byteOffset += sizeOfUint32;
-  var tablesByteLength = view.getUint32(byteOffset, true);
-  byteOffset += sizeOfUint32;
-  var extendedByteLength = view.getUint32(byteOffset, true);
-  byteOffset += sizeOfUint32;
-
-  var imageDescs = [];
-  for (var imDescs = 0; imDescs < header.levelCount; ++imDescs) {
-    imageDescs.push({
-      imageFlags: view.getUint32(byteOffset, true),
-      rgbSliceByteOffset: view.getUint32((byteOffset += sizeOfUint32), true),
-      rgbSliceByteLength: view.getUint32((byteOffset += sizeOfUint32), true),
-      alphaSliceByteOffset: view.getUint32((byteOffset += sizeOfUint32), true),
-      alphaSliceByteLength: view.getUint32((byteOffset += sizeOfUint32), true),
-    });
-    byteOffset += sizeOfUint32;
+  var dataBuffer = defined(data.buffer) ? data.buffer : data;
+  var ktx2File = new transcoderModule.KTX2File(new Uint8Array(dataBuffer));
+  var width = ktx2File.getWidth();
+  var height = ktx2File.getHeight();
+  var layers = ktx2File.getLayers();
+  var levels = ktx2File.getLevels();
+  var faces = ktx2File.getFaces();
+  var hasAlpha = ktx2File.getHasAlpha();
+
+  if (!width || !height || !levels) {
+    ktx2File.close();
+    ktx2File.delete();
+    throw new RuntimeError("Invalid .ktx2 file");
   }
 
-  var hasAlphaSlices = imageDescs[0].alphaSliceByteLength > 0;
-
   // Determine target format based on platform support
   var internalFormat, transcoderFormat;
-  var TranscodeTarget = transcoderModule.TranscodeTarget;
-  if (supportedTargetFormats.etc1 && !hasAlphaSlices) {
+  var BasisFormat = transcoderModule.transcoder_texture_format;
+  if (supportedTargetFormats.etc1 && !hasAlpha) {
     internalFormat = PixelFormat.RGB_ETC1;
-    transcoderFormat = TranscodeTarget.ETC1_RGB;
+    transcoderFormat = BasisFormat.cTFETC1_RGB;
   } else if (supportedTargetFormats.s3tc) {
-    internalFormat = hasAlphaSlices
-      ? PixelFormat.RGBA_DXT5
-      : PixelFormat.RGB_DXT1;
-    transcoderFormat = hasAlphaSlices
-      ? TranscodeTarget.BC3_RGBA
-      : TranscodeTarget.BC1_RGB;
+    internalFormat = hasAlpha ? PixelFormat.RGBA_DXT5 : PixelFormat.RGB_DXT1;
+    transcoderFormat = hasAlpha
+      ? BasisFormat.cTFBC3_RGBA
+      : BasisFormat.cTFBC1_RGB;
   } else if (supportedTargetFormats.pvrtc) {
-    internalFormat = hasAlphaSlices
+    internalFormat = hasAlpha
       ? PixelFormat.RGBA_PVRTC_4BPPV1
       : PixelFormat.RGB_PVRTC_4BPPV1;
-    transcoderFormat = hasAlphaSlices
-      ? TranscodeTarget.PVRTC1_4_RGBA
-      : TranscodeTarget.PVRTC1_4_RGB;
+    transcoderFormat = hasAlpha
+      ? BasisFormat.cTFPVRTC1_4_RGBA
+      : BasisFormat.cTFPVRTC1_4_RGB;
   } else {
     throw new RuntimeError("No transcoding format target available");
   }
 
-  var dataBuffer = defined(data.buffer) ? data.buffer : data;
-  var endpoints = new Uint8Array(dataBuffer, byteOffset, endpointsByteLength);
-  byteOffset += endpointsByteLength;
-  var selectors = new Uint8Array(dataBuffer, byteOffset, selectorsByteLength);
-  byteOffset += selectorsByteLength;
-
-  var transcoder = new transcoderModule.BasisLzEtc1sImageTranscoder();
-
-  transcoder.decodePalettes(endpointCount, endpoints, selectorCount, selectors);
+  if (!ktx2File.startTranscoding()) {
+    ktx2File.close();
+    ktx2File.delete();
+    throw new RuntimeError("startTranscoding failed");
+  }
 
-  var tables = new Uint8Array(dataBuffer, byteOffset, tablesByteLength);
-  byteOffset += tablesByteLength;
-  // var extendedByte = new Uint8Array(data, byteOffset, extendedByteLength);
-  byteOffset += extendedByteLength;
-  transcoder.decodeTables(tables);
+  var dstSize = ktx2File.getImageTranscodedSizeInBytes(
+    0,
+    0,
+    0,
+    transcoderFormat.value
+  );
+  var dst = new Uint8Array(dstSize);
 
   for (var i = 0; i < levelIndex.length; ++i) {
     var level = (result[i] = {});
-    var levelInfo = levelIndex[i];
-    var imageDesc = imageDescs[i];
 
     for (var j = 0; j < header.faceCount; ++j) {
-      var width = header.pixelWidth >> i;
-      var height = header.pixelHeight >> i;
-      var levelOffset = ktx2Offset + levelInfo.byteOffset;
-
-      var levelData = new Uint8Array(
-        dataBuffer,
-        levelOffset + imageDesc.rgbSliceByteOffset,
-        imageDesc.rgbSliceByteLength + imageDesc.alphaSliceByteLength
+      var transcoded = ktx2File.transcodeImage(
+        dst,
+        i, // level index
+        0, // layer index
+        j, // face index
+        transcoderFormat.value,
+        0, // get_alpha_for_opaque_formats
+        -1, // channel0
+        -1 // channel1
       );
 
-      var imageInfo = new transcoderModule.ImageInfo(
-        transcoderModule.TextureFormat.ETC1S,
-        width,
-        height,
-        i
-      );
-      imageInfo.flags = imageDesc.imageFlags;
-      imageInfo.rgbByteOffset = 0;
-      imageInfo.rgbByteLength = imageDesc.rgbSliceByteLength;
-      imageInfo.alphaByteOffset =
-        imageDesc.alphaSliceByteOffset > 0 ? imageDesc.rgbSliceByteLength : 0;
-      imageInfo.alphaByteLength = imageDesc.alphaSliceByteLength;
-
-      var transcoded = transcoder.transcodeImage(
-        transcoderFormat,
-        levelData,
-        imageInfo,
-        0,
-        isVideo
-      );
-
-      // Check Error Here
-      if (transcoded.transcodedImage === undefined) {
-        throw new RuntimeError("Error transcoding Image");
+      if (!transcoded) {
+        throw new RuntimeError("transcodeImage() failed");
       }
 
       // Create a copy and delete transcoder wasm allocated memory
-      //var levelBuffer = transcoded.transcodedImage
+      // var levelBuffer = transcoded.transcodedImage
       //  .get_typed_memory_view()
       //  .slice();
-      var levelBuffer = arraySlice(
-        transcoded.transcodedImage.get_typed_memory_view()
-      );
-      transcoded.transcodedImage.delete();
+      // var levelBuffer = arraySlice(
+      //   transcoded.transcodedImage.get_typed_memory_view()
+      // );
+      // transcoded.transcodedImage.delete();
 
       // console.log(levelBuffer.byteLength);
 
       level[faceOrder[j]] = {
         internalFormat: internalFormat,
         width: width,
         height: height,
-        levelBuffer: levelBuffer,
+        levelBuffer: dst,
       };
     }
   }
+
+  ktx2File.close();
+  ktx2File.delete();
 }
 
 export default parseKTX2;

Source/WorkersES6/transcodeKTX2.js

@@ -0,0 +1,48 @@
+/* global require */
+import defined from "../Core/defined.js";
+import parseKTX2 from "../Scene/parseKTX2.js";
+
+import createTaskProcessorWorker from "./createTaskProcessorWorker.js";
+
+var transcoderModule;
+
+function transcode(parameters) {
+  var ktx2Buffer = parameters.ktx2Buffer;
+  var supportedTargetFormats = parameters.supportedTargetFormats;
+  return parseKTX2(ktx2Buffer, supportedTargetFormats, transcoderModule);
+}
+
+function initWorker(compiledModule) {
+  transcoderModule = compiledModule;
+  // transcoderModule.initTranscoders();
+  transcoderModule.initializeBasis();
+
+  self.onmessage = createTaskProcessorWorker(transcode);
+  self.postMessage(true);
+}
+
+function transcodeKTX2(event) {
+  var data = event.data;
+
+  // Expect the first message to be to load a web assembly module
+  var wasmConfig = data.webAssemblyConfig;
+  if (defined(wasmConfig)) {
+    // Require and compile WebAssembly module, or use fallback if not supported
+    return require([wasmConfig.modulePath], function (mscBasisTranscoder) {
+      if (defined(wasmConfig.wasmBinaryFile)) {
+        if (!defined(mscBasisTranscoder)) {
+          mscBasisTranscoder = self.MSC_TRANSCODER;
+        }
+
+        mscBasisTranscoder(wasmConfig).then(function (compiledModule) {
+          initWorker(compiledModule);
+        });
+      } else {
+        return mscBasisTranscoder().then(function (transcoder) {
+          initWorker(transcoder);
+        });
+      }
+    });
+  }
+}
+export default transcodeKTX2;