feat(emscripten): load and decode .wasm.zstd

InsightSoftwareConsortium · Sep 6, 2023 · 3456c69 · 3456c69
1 parent 7baa1cf
commit 3456c69
Show file tree

Hide file tree

Showing 5 changed files with 42 additions and 9 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -167,7 +167,8 @@
     "markdown-table": "^3.0.3",
     "mime-types": "^2.1.35",
     "wasm-feature-detect": "^1.5.1",
-    "webworker-promise": "^0.4.2"
+    "webworker-promise": "^0.4.2",
+    "@thewtex/zstddec": "^0.1.1"
   },
   "bin": {
     "itk-wasm": "./src/itk-wasm-cli.js"

diff --git a/src/bindgen/typescript/typescript-bindings.js b/src/bindgen/typescript/typescript-bindings.js
@@ -87,6 +87,7 @@ function typescriptBindings (outputDir, buildDir, wasmBinaries, options, forNode
       if (err.code !== 'EEXIST') throw err
     }
     fs.copyFileSync(wasmBinaryRelativePath, path.join(distPipelinesDir, path.basename(wasmBinaryRelativePath)))
+    fs.copyFileSync(`${wasmBinaryRelativePath}.zstd`, path.join(distPipelinesDir, `${path.basename(wasmBinaryRelativePath)}.zstd`))
     const prefix = wasmBinaryRelativePath.substring(0, wasmBinaryRelativePath.length-5)
     fs.copyFileSync(`${prefix}.js`, path.join(distPipelinesDir, `${path.basename(prefix)}.js`))
     fs.copyFileSync(`${prefix}.umd.js`, path.join(distPipelinesDir, `${path.basename(prefix)}.umd.js`))

diff --git a/src/build-emscripten.js b/src/build-emscripten.js
@@ -140,7 +140,9 @@ if (options.copyBuildArtifacts) {
   }
   let imageIOFiles = glob.sync(path.join(buildDir, 'image-io', '*.js'))
   imageIOFiles = imageIOFiles.concat(glob.sync(path.join(buildDir, 'image-io', '*.wasm')))
+  imageIOFiles = imageIOFiles.concat(glob.sync(path.join(buildDir, 'image-io', '*.wasm.zstd')))
   imageIOFiles = imageIOFiles.filter((fn) => !fn.endsWith('.umd.wasm'))
+  imageIOFiles = imageIOFiles.filter((fn) => !fn.endsWith('.umd.wasm.zstd'))
   const copyImageIOModules = function (imageIOFile, callback) {
     const io = path.basename(imageIOFile)
     const output = path.join('dist', 'image-io', io)
@@ -154,7 +156,9 @@ if (options.copyBuildArtifacts) {
   }
   let meshIOFiles = glob.sync(path.join(buildDir, 'mesh-io', '*.js'))
   meshIOFiles = meshIOFiles.concat(glob.sync(path.join(buildDir, 'mesh-io', '*.wasm')))
+  meshIOFiles = meshIOFiles.concat(glob.sync(path.join(buildDir, 'mesh-io', '*.wasm.zstd')))
   meshIOFiles = meshIOFiles.filter((fn) => !fn.endsWith('.umd.wasm'))
+  meshIOFiles = meshIOFiles.filter((fn) => !fn.endsWith('.umd.wasm.zstd'))
   const copyMeshIOModules = function (meshIOFile, callback) {
     const io = path.basename(meshIOFile)
     const output = path.join('dist', 'mesh-io', io)
@@ -168,7 +172,9 @@ if (options.copyBuildArtifacts) {
   }
   let dicomFiles = glob.sync(path.join(buildDir, 'dicom', '*.js'))
   dicomFiles = dicomFiles.concat(glob.sync(path.join(buildDir, 'dicom', '*.wasm')))
+  dicomFiles = dicomFiles.concat(glob.sync(path.join(buildDir, 'dicom', '*.wasm.zstd')))
   dicomFiles = dicomFiles.filter((fn) => !fn.endsWith('.umd.wasm'))
+  dicomFiles = dicomFiles.filter((fn) => !fn.endsWith('.umd.wasm.zstd'))
   const copyDICOMModules = function (dicomFile, callback) {
     const io = path.basename(dicomFile)
     const output = path.join('dist', 'dicom', 'public', 'pipelines', io)
@@ -219,6 +225,7 @@ if (options.buildTestPipelines) {
     }
     let pipelineFiles = glob.sync(path.join(pipelinePath, 'emscripten-build', '*.js'))
     pipelineFiles = pipelineFiles.concat(glob.sync(path.join(pipelinePath, 'emscripten-build', '*.wasm')))
+    pipelineFiles = pipelineFiles.concat(glob.sync(path.join(pipelinePath, 'emscripten-build', '*.wasm.zstd')))
     pipelineFiles.forEach((file) => {
       const filename = path.basename(file)
       const output = path.join('dist', 'pipelines', filename)

diff --git a/src/core/internal/loadEmscriptenModuleWebWorker.ts b/src/core/internal/loadEmscriptenModuleWebWorker.ts
@@ -1,5 +1,9 @@
 import axios from 'axios'
 
+import { ZSTDDecoder } from '@thewtex/zstddec'
+const decoder = new ZSTDDecoder()
+let decoderInitialized = false
+
 import ITKWasmEmscriptenModule from '../ITKWasmEmscriptenModule.js'
 import camelCase from './camelCase.js'
 
@@ -26,8 +30,13 @@ async function loadEmscriptenModuleWebWorker(moduleRelativePathOrURL: string | U
   // adds worker dynamic import support:
   // https://bugzilla.mozilla.org/show_bug.cgi?id=1540913
   const wasmBinaryPath = `${modulePrefix}.wasm`
-  const response = await axios.get(wasmBinaryPath, { responseType: 'arraybuffer' })
-  const wasmBinary = response.data
+  const response = await axios.get(`${wasmBinaryPath}.zstd`, { responseType: 'arraybuffer' })
+  if (!decoderInitialized) {
+    await decoder.init()
+    decoderInitialized = true
+  }
+  const decompressedArray = decoder.decode(new Uint8Array(response.data))
+  const wasmBinary = decompressedArray.buffer
   const modulePath = `${modulePrefix}.umd.js`
   importScripts(modulePath)
   const moduleBaseName: string = camelCase(modulePrefix.replace(/.*\//, ''))