Merge branch 'master' into feat--add_zstd

Author: Rdataflow

.eslintrc.cjs

@@ -13,6 +13,9 @@ module.exports = {
     ecmaVersion: 'latest',
     sourceType: 'module',
   },
+  globals: {
+    FinalizationRegistry: true,
+  },
   rules: {
     'no-underscore-dangle': 0,
     'class-methods-use-this': 0,

README.md

@@ -360,7 +360,7 @@ YCbCr, and CIE L*a*b.
 
 geotiff.js provides a method to automatically convert these images to RGB:
 `readRGB()`. This method is very similar to the `readRasters` method with
-distinction that the `interleave` option is now always `true` and the
+the distinction that the `interleave` option now defaults to `true` and the
 `samples` are automatically chosen.
 
 ```javascript

package-lock.json

@@ -87,8 +87,8 @@
     "pako": "^2.0.4",
     "parse-headers": "^2.0.2",
     "quick-lru": "^6.1.1",
-    "web-worker": "^1.2.0",
-    "xml-utils": "^1.0.2",
+    "web-worker": "^1.5.0",
+    "xml-utils": "^1.10.2",
     "zstddec": "^0.2.0-alpha.3"
   },
   "devDependencies": {
@@ -100,6 +100,7 @@
     "@rollup/plugin-commonjs": "^21.0.1",
     "@rollup/plugin-node-resolve": "^13.1.3",
     "chai": "^4.2.0",
+    "chai-as-promised": "^8.0.1",
     "chokidar-cli": "^3.0.0",
     "detect-node": "^2.0.4",
     "eslint": "^7.32.0",
@@ -125,25 +126,25 @@
     "typescript": "^4.5.5"
   },
   "scripts": {
-    "prebuild": "npm run build:clean && npm run build:module",
-    "build": "run-p build:browser build:node build:types",
-    "build:clean": "rimraf dist-node/ dist-browser/ dist-module/",
-    "build:node": "tsc --project tsconfig.build.json && shx echo \"{\\\"type\\\":\\\"commonjs\\\"}\" > dist-node/package.json",
+    "prebuild": "npm run build:clean",
+    "build": "npm run build:module && run-p build:browser build:node build:types",
+    "build:clean": "shx rm -rf dist-node/ dist-browser/ dist-module/",
+    "build:module": "shx mkdir -p dist-module && shx cp -rf src/* dist-module/ && rollup -c rollup.worker.config.js",
     "build:browser": "rollup -c rollup.config.js",
-    "build:module": "shx mkdir -p dist-module && shx cp -rf src/* dist-module/ && node scripts/serialize-workers.cjs",
+    "build:node": "tsc --project tsconfig.build.json && shx echo \"{\\\"type\\\":\\\"commonjs\\\"}\" > dist-node/package.json",
     "build:types": "tsc --outdir dist-module/",
-    "watch:browser": "chokidar \"dist-module/*.js\" -c \"npm run build:browser\"",
     "watch:module": "chokidar \"src/*.js\" -c \"npm run build:module\"",
+    "watch:browser": "chokidar \"dist-module/*.js\" -c \"npm run build:browser\"",
     "predev": "npm run build",
     "dev": "run-p watch:module watch:browser dev:serve",
     "dev:serve": "serve --listen 8090",
     "docs": "rm -rf docs/; jsdoc -c .jsdoc.json -r src README.md -d docs",
     "prelint": "npm run build:module",
-    "lint": "eslint src test scripts/*.cjs .eslintrc.cjs",
+    "lint": "eslint src test .eslintrc.cjs",
     "lint:fix": "npm run lint -- --fix",
     "prepare": "npm run build",
     "pretest": "npm run lint",
-    "test": "mocha --full-trace test/geotiff.spec.js"
+    "test": "mocha --full-trace test/*.spec.js"
   },
   "author": "Fabian Schindler",
   "browser": {

package.json

@@ -0,0 +1,30 @@
+/* eslint-disable import/no-extraneous-dependencies */
+
+import baseConfig from './rollup.config.js';
+
+export default {
+  ...baseConfig,
+  input: 'dist-module/worker/decoder.js',
+  output: {
+    file: 'dist-module/worker/create.js',
+    format: 'module',
+    inlineDynamicImports: true,
+  },
+  plugins: [
+    ...baseConfig.plugins,
+    {
+      name: 'serialize worker and export create function',
+      renderChunk(code) {
+        return `\
+import Worker from 'web-worker';
+
+export default function create() {
+  const source = ${JSON.stringify(code)};
+  return new Worker(typeof Buffer !== 'undefined' 
+    ? 'data:application/javascript;base64,' + Buffer.from(source, 'binary').toString('base64')
+    : URL.createObjectURL(new Blob([source], { type: 'application/javascript' })));
+}`;
+      },
+    },
+  ],
+};

rollup.worker.config.js

@@ -1,12 +1,32 @@
 const registry = new Map();
+const preferWorkerMap = new Map();
 
-export function addDecoder(cases, importFn) {
+/**
+ * Either a number or undefined.
+ * @typedef {(number|undefined)} NumberOrUndefined
+ */
+
+/**
+ * Register a decoder for a specific compression method or a range of compressions
+ * @param {(NumberOrUndefined|(NumberOrUndefined[]))} cases ids of the compression methods to register for
+ * @param {function():Promise} importFn the function to import the decoder
+ * @param {boolean} preferWorker_ Whether to prefer running the decoder in a worker
+ */
+export function addDecoder(cases, importFn, preferWorker_ = true) {
   if (!Array.isArray(cases)) {
     cases = [cases]; // eslint-disable-line no-param-reassign
   }
-  cases.forEach((c) => registry.set(c, importFn));
+  cases.forEach((c) => {
+    registry.set(c, importFn);
+    preferWorkerMap.set(c, preferWorker_);
+  });
 }
 
+/**
+ * Get a decoder for a specific file directory
+ * @param {object} fileDirectory the file directory of the image
+ * @returns {Promise<Decoder>}
+ */
 export async function getDecoder(fileDirectory) {
   const importFn = registry.get(fileDirectory.Compression);
   if (!importFn) {
@@ -16,8 +36,17 @@ export async function getDecoder(fileDirectory) {
   return new Decoder(fileDirectory);
 }
 
+/**
+ * Whether to prefer running the decoder in a worker
+ * @param {object} fileDirectory the file directory of the image
+ * @returns {boolean}
+ */
+export function preferWorker(fileDirectory) {
+  return preferWorkerMap.get(fileDirectory.Compression);
+}
+
 // Add default decoders to registry (end-user may override with other implementations)
-addDecoder([undefined, 1], () => import('./raw.js').then((m) => m.default));
+addDecoder([undefined, 1], () => import('./raw.js').then((m) => m.default), false);
 addDecoder(5, () => import('./lzw.js').then((m) => m.default));
 addDecoder(6, () => {
   throw new Error('old style JPEG compression is not supported.');
@@ -39,4 +68,4 @@ addDecoder(50000, () => import('./zstd.js')
   })
   .then((m) => m.default),
 );
-addDecoder(50001, () => import('./webimage.js').then((m) => m.default));
+addDecoder(50001, () => import('./webimage.js').then((m) => m.default), false);