feat: removes wasm dependency and implements pure-js JPG encoder (#73)

Author: daniele-pelagatti

.github/workflows/ci.yml

@@ -26,47 +26,6 @@ jobs:
           with:
             submodules: recursive
 
-        - name: 'Setup Emscripten'
-          uses: mymindstorm/setup-emsdk@v11
-          with:
-            version: 3.1.47
-
-        - name: 'Setup Python'
-          uses: actions/setup-python@v4
-          with:
-            python-version: '3.10'
-
-        - name: 'Install Meson & Ninja'
-          uses: BSFishy/pip-action@v1
-          with:
-            packages: |
-              meson
-              ninja
-
-        - name: Write em.txt
-          uses: "DamianReeves/write-file-action@master"
-          with:
-            path: libultrahdr-wasm/em.txt
-            write-mode: overwrite
-            contents: |
-              [binaries]
-              c = 'emcc'
-              cpp = 'em++'
-              ar = 'emar'
-              nm = 'emnm'
-
-              [host_machine]
-              system = 'emscripten'
-              cpu_family = 'wasm32'
-              cpu = 'wasm32'
-              endian = 'little'
-
-        - name: 'Build libultrahdr WASM'
-          run: |
-            cd libultrahdr-wasm
-            meson setup build --cross-file=em.txt
-            meson compile -C build
-
         - name: 'Setup Nodejs'
           uses: actions/setup-node@v3
           with:
@@ -85,10 +44,6 @@ jobs:
             name: build-artifact
             if-no-files-found: error
             path: |
-              libultrahdr-wasm/build/*.ts
-              libultrahdr-wasm/build/*.js
-              libultrahdr-wasm/build/*.map
-              libultrahdr-wasm/build/*.wasm
               dist/
 
     ################################
@@ -110,6 +65,7 @@ jobs:
           uses: actions/download-artifact@v4
           with:
             name: build-artifact
+            path: dist
 
         - name: 'Setup Nodejs'
           uses: actions/setup-node@v3
@@ -154,11 +110,11 @@ jobs:
           uses: actions/checkout@v4
           with:
             submodules: recursive
-
         - name: 'Download build artifacts'
           uses: actions/download-artifact@v4
           with:
             name: build-artifact
+            path: dist
 
         - name: 'Setup Nodejs'
           uses: actions/setup-node@v3

.github/workflows/publish-wiki.yml

@@ -30,6 +30,7 @@ jobs:
           uses: dawidd6/action-download-artifact@v6
           with:
             name: build-artifact
+            path: dist
             run_id: ${{ github.event.workflow_run.id }}
             workflow_conclusion: success
 

.github/workflows/release.yml

@@ -38,6 +38,7 @@ jobs:
           uses: dawidd6/action-download-artifact@v6 # download artifacts
           with:
             name: build-artifact
+            path: dist
             run_id: ${{ github.event.workflow_run.id }}
             workflow_conclusion: success
 

.github/workflows/report.yml

@@ -28,6 +28,7 @@ jobs:
         uses: dawidd6/action-download-artifact@v6 # download artifacts
         with:
           name: build-artifact
+          path: dist
           run_id: ${{ github.event.workflow_run.id }}
 
       - name: 'Download check artifacts'

.gitmodules

@@ -7,7 +7,3 @@ src
 reports
 examples
 wiki
-libultrahdr-wasm/**/*
-!libultrahdr-wasm/build/*.ts
-!libultrahdr-wasm/build/*.js
-!libultrahdr-wasm/build/*.wasm

.npmignore

@@ -0,0 +1,21 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Launch Program",
+            "runtimeExecutable": "/home/daniele/.nvm/versions/node/v22.21.0/bin/node",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "program": "${workspaceFolder}/tests/encode/encode.test.ts",
+            "outFiles": [
+                "${workspaceFolder}/**/*.js"
+            ]
+        }
+    ]
+}

.vscode/launch.json

@@ -316,7 +316,7 @@ const metadata = encodingResult.getMetadata()
 
 // embed the compressed images + metadata into a single
 // JPEG file
-const jpeg = await encodeJPEGMetadata({
+const jpeg = encodeJPEGMetadata({
   ...encodingResult,
   ...metadata,
   sdr,
@@ -350,62 +350,14 @@ module.exports = defineConfig({
 ```
 
 
-## Building with full encoding support (libultrahdr-wasm)
+## Building
 
-Clone the repository with git submodules recursively:
-```bash
-$ git clone --recurse-submodules git@github.com:MONOGRID/gainmap-js.git
-```
-
-Proceed to build the libultrahdr-wasm module following the [documentation found here](https://github.com/MONOGRID/libultrahdr-wasm#building), here's a quick summary
-
-```bash
-$ cd gainmap-js/libultrahdr-wasm/
-```
-Create a meson "cross compile config" named em.txt and place the following content inside:
-```ini
-[binaries]
-c = 'emcc'
-cpp = 'em++'
-ar = 'emar'
-nm = 'emnm'
-
-[host_machine]
-system = 'emscripten'
-cpu_family = 'wasm32'
-cpu = 'wasm32'
-endian = 'little'
-```
-Then execute
-
-```bash
-$ meson setup build --cross-file=em.txt
-$ meson compile -C build
-```
-
-After compiling the WASM, head back to the main repository
-
-```bash
-$ cd ..
-$ npm i
-$ npm run build
-```
-
-## Building with no encoding support (requires no wasm)
-
-> :warning: Building the library with decode only capabilities will not allow to run playwright e2e tests with `npm run test`
-> this method should only be used by people who would like to customize the "decoding" part of the library but are unable to build the WASM module for some reason (emscripten can be tricky sometimes, I've been there)
-
-Clone the repository normally:
+Clone the repository:
 ```bash
 $ git clone git@github.com:MONOGRID/gainmap-js.git
 $ cd gainmap-js
 $ npm i
-```
-
-build with
-```bash
-$ npm run build --config rollup.config.decodeonly.mjs
+$ npm run build
 ```
 
 

README.md

@@ -29,8 +29,7 @@ const config = defineConfig([
     ignores: [
       'node_modules/**/*',
       'dist/**/*',
-      '.vscode/**/*',
-      'libultrahdr-wasm/build/**/*'
+      '.vscode/**/*'
     ]
   }
 ])

eslint.config.mjs

@@ -20,7 +20,7 @@ const encodingResult = await encodeAndCompress({
 
 // embed the compressed images + metadata into a single
 // JPEG file
-const jpeg = await encodeJPEGMetadata({
+const jpeg = encodeJPEGMetadata({
   ...encodingResult,
   sdr: encodingResult.sdr,
   gainMap: encodingResult.gainMap