@loaders.gl/textures 4.0.0-alpha.5 → 4.0.0-alpha.6

package/dist/npy-worker.js

@@ -1,14 +1,12 @@
 (() => {
   // src/lib/utils/version.ts
-  var VERSION = true ? "4.0.0-alpha.5" : "beta";
+  var VERSION = true ? "4.0.0-alpha.6" : "beta";
 
   // src/lib/parsers/parse-npy.ts
-  function systemIsLittleEndian() {
-    const a = new Uint32Array([305419896]);
-    const b = new Uint8Array(a.buffer, a.byteOffset, a.byteLength);
-    return !(b[0] === 18);
-  }
-  var LITTLE_ENDIAN_OS = systemIsLittleEndian();
+  var a = new Uint32Array([305419896]);
+  var b = new Uint8Array(a.buffer, a.byteOffset, a.byteLength);
+  var isLittleEndian = !(b[0] === 18);
+  var LITTLE_ENDIAN_OS = isLittleEndian;
   var DTYPES = {
     u1: Uint8Array,
     i1: Int8Array,
@@ -20,22 +18,21 @@
     f8: Float64Array
   };
   function parseNPY(arrayBuffer, options) {
-    if (!arrayBuffer) {
-      return null;
-    }
     const view = new DataView(arrayBuffer);
     const { header, headerEndOffset } = parseHeader(view);
     const numpyType = header.descr;
     const ArrayType = DTYPES[numpyType.slice(1, 3)];
     if (!ArrayType) {
-      console.warn(`Decoding of npy dtype not implemented: ${numpyType}`);
-      return null;
+      throw new Error(`Unimplemented type ${numpyType}`);
     }
-    const nArrayElements = header.shape?.reduce((a, b) => a * b);
+    const nArrayElements = header.shape?.reduce((a2, b2) => a2 * b2);
     const arrayByteLength = nArrayElements * ArrayType.BYTES_PER_ELEMENT;
+    if (arrayBuffer.byteLength < headerEndOffset + arrayByteLength) {
+      throw new Error("Buffer overflow");
+    }
     const data = new ArrayType(arrayBuffer.slice(headerEndOffset, headerEndOffset + arrayByteLength));
     if (numpyType[0] === ">" && LITTLE_ENDIAN_OS || numpyType[0] === "<" && !LITTLE_ENDIAN_OS) {
-      console.warn("Data is wrong endianness, byte swapping not yet implemented.");
+      throw new Error("Incorrect endianness");
     }
     return {
       data,
@@ -47,10 +44,10 @@
     let offset = 8;
     let headerLength;
     if (majorVersion >= 2) {
-      headerLength = view.getUint32(8, true);
+      headerLength = view.getUint32(offset, true);
       offset += 4;
     } else {
-      headerLength = view.getUint16(8, true);
+      headerLength = view.getUint16(offset, true);
       offset += 2;
     }
     const encoding = majorVersion <= 2 ? "latin1" : "utf-8";
@@ -119,16 +116,33 @@
   }
 
   // ../worker-utils/src/lib/worker-farm/worker-body.ts
+  function getParentPort() {
+    let parentPort;
+    try {
+      eval("globalThis.parentPort = require('worker_threads').parentPort");
+      parentPort = globalThis.parentPort;
+    } catch {
+    }
+    return parentPort;
+  }
   var onMessageWrapperMap = new Map();
   var WorkerBody = class {
+    static inWorkerThread() {
+      return typeof self !== "undefined" || Boolean(getParentPort());
+    }
     static set onmessage(onMessage) {
-      self.onmessage = (message) => {
-        if (!isKnownMessage(message)) {
-          return;
-        }
-        const { type, payload } = message.data;
+      function handleMessage(message) {
+        const parentPort3 = getParentPort();
+        const { type, payload } = parentPort3 ? message : message.data;
         onMessage(type, payload);
-      };
+      }
+      const parentPort2 = getParentPort();
+      if (parentPort2) {
+        parentPort2.on("message", handleMessage);
+        parentPort2.on("exit", () => console.debug("Node worker closing"));
+      } else {
+        globalThis.onmessage = handleMessage;
+      }
     }
     static addEventListener(onMessage) {
       let onMessageWrapper = onMessageWrapperMap.get(onMessage);
@@ -137,22 +151,36 @@
           if (!isKnownMessage(message)) {
             return;
           }
-          const { type, payload } = message.data;
+          const parentPort3 = getParentPort();
+          const { type, payload } = parentPort3 ? message : message.data;
           onMessage(type, payload);
         };
       }
-      self.addEventListener("message", onMessageWrapper);
+      const parentPort2 = getParentPort();
+      if (parentPort2) {
+        console.error("not implemented");
+      } else {
+        globalThis.addEventListener("message", onMessageWrapper);
+      }
     }
     static removeEventListener(onMessage) {
       const onMessageWrapper = onMessageWrapperMap.get(onMessage);
       onMessageWrapperMap.delete(onMessage);
-      self.removeEventListener("message", onMessageWrapper);
+      const parentPort2 = getParentPort();
+      if (parentPort2) {
+        console.error("not implemented");
+      } else {
+        globalThis.removeEventListener("message", onMessageWrapper);
+      }
     }
     static postMessage(type, payload) {
-      if (self) {
-        const data = { source: "loaders.gl", type, payload };
-        const transferList = getTransferList(payload);
-        self.postMessage(data, transferList);
+      const data = { source: "loaders.gl", type, payload };
+      const transferList = getTransferList(payload);
+      const parentPort2 = getParentPort();
+      if (parentPort2) {
+        parentPort2.postMessage(data, transferList);
+      } else {
+        globalThis.postMessage(data, transferList);
       }
     }
   };
@@ -164,19 +192,20 @@
   // ../loader-utils/src/lib/worker-loader-utils/create-loader-worker.ts
   var requestId = 0;
   function createLoaderWorker(loader) {
-    if (typeof self === "undefined") {
+    if (!WorkerBody.inWorkerThread()) {
       return;
     }
     WorkerBody.onmessage = async (type, payload) => {
       switch (type) {
         case "process":
           try {
-            const { input, options = {} } = payload;
+            const { input, options = {}, context = {} } = payload;
             const result = await parseData({
               loader,
               arrayBuffer: input,
               options,
               context: {
+                ...context,
                 parse: parseOnMainThread
               }
             });

package/dist/types.js

@@ -1,2 +1 @@
-
-//# sourceMappingURL=types.js.map
+"use strict";

package/dist/workers/basis-nodejs-worker.d.ts

@@ -0,0 +1,2 @@
+import '@loaders.gl/polyfills';
+//# sourceMappingURL=basis-nodejs-worker.d.ts.map

package/dist/workers/basis-nodejs-worker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"basis-nodejs-worker.d.ts","sourceRoot":"","sources":["../../src/workers/basis-nodejs-worker.ts"],"names":[],"mappings":"AACA,OAAO,uBAAuB,CAAC"}

package/dist/workers/basis-nodejs-worker.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const loader_utils_1 = require("@loaders.gl/loader-utils");
+require("@loaders.gl/polyfills");
+const basis_loader_1 = require("../basis-loader");
+(0, loader_utils_1.createLoaderWorker)(basis_loader_1.BasisLoader);

package/dist/workers/basis-worker.js

@@ -1,4 +1,5 @@
-import { createLoaderWorker } from '@loaders.gl/loader-utils';
-import { BasisLoader } from '../basis-loader';
-createLoaderWorker(BasisLoader);
-//# sourceMappingURL=basis-worker.js.map
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const loader_utils_1 = require("@loaders.gl/loader-utils");
+const basis_loader_1 = require("../basis-loader");
+(0, loader_utils_1.createLoaderWorker)(basis_loader_1.BasisLoader);

package/dist/workers/compressed-texture-worker.js

@@ -1,4 +1,5 @@
-import { createLoaderWorker } from '@loaders.gl/loader-utils';
-import { CompressedTextureLoader } from '../compressed-texture-loader';
-createLoaderWorker(CompressedTextureLoader);
-//# sourceMappingURL=compressed-texture-worker.js.map
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const loader_utils_1 = require("@loaders.gl/loader-utils");
+const compressed_texture_loader_1 = require("../compressed-texture-loader");
+(0, loader_utils_1.createLoaderWorker)(compressed_texture_loader_1.CompressedTextureLoader);

package/dist/workers/crunch-worker.js

@@ -1,8 +1,14 @@
-import { createLoaderWorker } from '@loaders.gl/loader-utils';
-import { CrunchLoader } from '../crunch-loader';
-import { parseCrunch } from '../lib/parsers/parse-crunch';
-export const CrunchLoaderWithParser = { ...CrunchLoader,
-  parse: parseCrunch
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CrunchLoaderWithParser = void 0;
+const loader_utils_1 = require("@loaders.gl/loader-utils");
+const crunch_loader_1 = require("../crunch-loader");
+const parse_crunch_1 = require("../lib/parsers/parse-crunch");
+/**
+ * Loader for the Crunch compressed texture container format
+ */
+exports.CrunchLoaderWithParser = {
+    ...crunch_loader_1.CrunchLoader,
+    parse: parse_crunch_1.parseCrunch
 };
-createLoaderWorker(CrunchLoaderWithParser);
-//# sourceMappingURL=crunch-worker.js.map
+(0, loader_utils_1.createLoaderWorker)(exports.CrunchLoaderWithParser);

package/dist/workers/ktx2-basis-writer-nodejs-worker.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ktx2-basis-writer-nodejs-worker.d.ts.map

package/dist/workers/ktx2-basis-writer-nodejs-worker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ktx2-basis-writer-nodejs-worker.d.ts","sourceRoot":"","sources":["../../src/workers/ktx2-basis-writer-nodejs-worker.ts"],"names":[],"mappings":""}

package/dist/workers/ktx2-basis-writer-nodejs-worker.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const worker_utils_1 = require("@loaders.gl/worker-utils");
+const ktx2_basis_writer_nodejs_1 = require("../ktx2-basis-writer-nodejs");
+(() => {
+    // Check that we are actually in a worker thread
+    if (!worker_utils_1.WorkerBody.inWorkerThread()) {
+        return;
+    }
+    worker_utils_1.WorkerBody.onmessage = async (type, payload) => {
+        switch (type) {
+            case 'process':
+                try {
+                    const { input, options } = payload;
+                    const result = await ktx2_basis_writer_nodejs_1.KTX2BasisWriterNodeJS.encode?.(input, options);
+                    worker_utils_1.WorkerBody.postMessage('done', { result });
+                }
+                catch (error) {
+                    const message = error instanceof Error ? error.message : '';
+                    worker_utils_1.WorkerBody.postMessage('error', { error: message });
+                }
+                break;
+            default:
+        }
+    };
+})();

package/dist/workers/ktx2-basis-writer-worker.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ktx2-basis-writer-worker.d.ts.map

package/dist/workers/ktx2-basis-writer-worker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ktx2-basis-writer-worker.d.ts","sourceRoot":"","sources":["../../src/workers/ktx2-basis-writer-worker.ts"],"names":[],"mappings":""}

package/dist/workers/ktx2-basis-writer-worker.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const worker_utils_1 = require("@loaders.gl/worker-utils");
+const ktx2_basis_writer_1 = require("../ktx2-basis-writer");
+(() => {
+    // Check that we are actually in a worker thread
+    if (!worker_utils_1.WorkerBody.inWorkerThread()) {
+        return;
+    }
+    worker_utils_1.WorkerBody.onmessage = async (type, payload) => {
+        switch (type) {
+            case 'process':
+                try {
+                    const { input, options } = payload;
+                    const result = await ktx2_basis_writer_1.KTX2BasisWriter.encode?.(input, options);
+                    worker_utils_1.WorkerBody.postMessage('done', { result });
+                }
+                catch (error) {
+                    const message = error instanceof Error ? error.message : '';
+                    worker_utils_1.WorkerBody.postMessage('error', { error: message });
+                }
+                break;
+            default:
+        }
+    };
+})();

package/dist/workers/npy-worker.js

@@ -1,4 +1,5 @@
-import { NPYLoader } from '../npy-loader';
-import { createLoaderWorker } from '@loaders.gl/loader-utils';
-createLoaderWorker(NPYLoader);
-//# sourceMappingURL=npy-worker.js.map
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const npy_loader_1 = require("../npy-loader");
+const loader_utils_1 = require("@loaders.gl/loader-utils");
+(0, loader_utils_1.createLoaderWorker)(npy_loader_1.NPYLoader);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loaders.gl/textures",
-  "version": "4.0.0-alpha.5",
+  "version": "4.0.0-alpha.6",
   "description": "Framework-independent loaders for compressed and super compressed (basis) textures ",
   "license": "MIT",
   "publishConfig": {
@@ -22,8 +22,8 @@
     "basis"
   ],
   "types": "dist/index.d.ts",
-  "main": "dist/index.js",
-  "module": "dist/index.js",
+  "main": "dist/es5/index.js",
+  "module": "dist/esm/index.js",
   "sideEffects": false,
   "files": [
     "src",
@@ -35,19 +35,25 @@
     "pre-build": "npm run copy-libs && npm run build-worker && npm run build-bundle",
     "copy-libs": "cp -rf ./src/libs ./dist/libs",
     "build-bundle": "esbuild src/bundle.ts --bundle --outfile=dist/dist.min.js",
-    "build-worker": "npm run build-basis-worker && npm run build-npy-worker && npm run build-compressed-texture-worker && npm run build-crunch-worker",
+    "build-worker": "npm run build-basis-worker && npm run build-basis-nodejs-worker && npm run build-npy-worker && npm run build-compressed-texture-worker && npm run build-crunch-worker && npm run build-ktx2-basis-writer-worker && npm run build-ktx2-basis-writer-nodejs-worker",
     "build-basis-worker": "esbuild src/workers/basis-worker.ts --bundle --outfile=dist/basis-worker.js --define:__VERSION__=\\\"$npm_package_version\\\"",
+    "build-basis-nodejs-worker": "esbuild src/workers/basis-nodejs-worker.ts --platform=node --target=esnext,node12 --bundle --outfile=dist/basis-nodejs-worker.js --define:__VERSION__=\\\"$npm_package_version\\\"",
     "build-npy-worker": "esbuild src/workers/npy-worker.ts --bundle --outfile=dist/npy-worker.js --define:__VERSION__=\\\"$npm_package_version\\\"",
     "build-compressed-texture-worker": "esbuild src/workers/compressed-texture-worker.ts --bundle --outfile=dist/compressed-texture-worker.js --define:__VERSION__=\\\"$npm_package_version\\\"",
-    "build-crunch-worker": "esbuild src/workers/crunch-worker.ts --bundle --outfile=dist/crunch-worker.js --define:__VERSION__=\\\"$npm_package_version\\\""
+    "build-crunch-worker": "esbuild src/workers/crunch-worker.ts --bundle --outfile=dist/crunch-worker.js --define:__VERSION__=\\\"$npm_package_version\\\"",
+    "build-ktx2-basis-writer-worker": "esbuild src/workers/ktx2-basis-writer-worker.ts --bundle --outfile=dist/ktx2-basis-writer-worker.js --define:__VERSION__=\\\"$npm_package_version\\\"",
+    "build-ktx2-basis-writer-nodejs-worker": "esbuild src/workers/ktx2-basis-writer-nodejs-worker.ts --platform=node --target=esnext,node12 --bundle --outfile=dist/ktx2-basis-writer-nodejs-worker.js --define:__VERSION__=\\\"$npm_package_version\\\""
   },
   "dependencies": {
-    "@loaders.gl/images": "4.0.0-alpha.5",
-    "@loaders.gl/loader-utils": "4.0.0-alpha.5",
-    "@loaders.gl/schema": "4.0.0-alpha.5",
-    "@loaders.gl/worker-utils": "4.0.0-alpha.5",
+    "@loaders.gl/images": "4.0.0-alpha.6",
+    "@loaders.gl/loader-utils": "4.0.0-alpha.6",
+    "@loaders.gl/schema": "4.0.0-alpha.6",
+    "@loaders.gl/worker-utils": "4.0.0-alpha.6",
     "ktx-parse": "^0.0.4",
     "texture-compressor": "^1.0.2"
   },
-  "gitHead": "7a71a54bdf1ddf985cc3af3db90b82e7fa97d025"
+  "devDependencies": {
+    "@loaders.gl/polyfills": "4.0.0-alpha.6"
+  },
+  "gitHead": "acc1985050dfaa0f1f0c066f8da5bce7454a046c"
 }

package/src/basis-loader.ts

@@ -1,13 +1,17 @@
-import type {Loader, LoaderWithParser} from '@loaders.gl/loader-utils';
+// loaders.gl, MIT license
+
+import type {Loader, LoaderOptions, LoaderWithParser} from '@loaders.gl/loader-utils';
+import type {TextureLevel} from '@loaders.gl/schema';
+import {isBrowser} from '@loaders.gl/worker-utils';
 import {VERSION} from './lib/utils/version';
 import parseBasis from './lib/parsers/parse-basis';
 
 /**
  * Worker loader for Basis super compressed textures
  */
-export const BasisWorkerLoader = {
+export const BasisWorkerLoader: Loader<TextureLevel[][], never, LoaderOptions> = {
   name: 'Basis',
-  id: 'basis',
+  id: isBrowser ? 'basis' : 'basis-nodejs',
   module: 'textures',
   version: VERSION,
   worker: true,
@@ -28,11 +32,7 @@ export const BasisWorkerLoader = {
 /**
  * Loader for Basis super compressed textures
  */
-export const BasisLoader = {
+export const BasisLoader: LoaderWithParser<TextureLevel[][], never, LoaderOptions> = {
   ...BasisWorkerLoader,
   parse: parseBasis
 };
-
-// TYPE TESTS - TODO find a better way than exporting junk
-export const _TypecheckBasisWorkerLoader: Loader = BasisWorkerLoader;
-export const _TypecheckBasisLoader: LoaderWithParser = BasisLoader;

package/src/compressed-texture-writer.ts

@@ -1,11 +1,23 @@
-import type {Writer} from '@loaders.gl/loader-utils';
+import type {Writer, WriterOptions} from '@loaders.gl/loader-utils';
 import {VERSION} from './lib/utils/version';
 import {encodeImageURLToCompressedTextureURL} from './lib/encoders/encode-texture';
 
+export type CompressedTextureWriterOptions = WriterOptions & {
+  cwd?: string;
+  texture?: {
+    format: string;
+    compression: string;
+    quality: string;
+    mipmap: boolean;
+    flipY: boolean;
+    toolFlags: string;
+  };
+};
+
 /**
  * DDS Texture Container Exporter
  */
-export const CompressedTextureWriter = {
+export const CompressedTextureWriter: Writer<unknown, unknown, CompressedTextureWriterOptions> = {
   name: 'DDS Texture Container',
   id: 'dds',
   module: 'textures',
@@ -28,4 +40,10 @@ export const CompressedTextureWriter = {
 };
 
 // TYPE TESTS - TODO find a better way than exporting junk
-export const _TypecheckCompressedTextureWriter: Writer = CompressedTextureWriter;
+// export const _TypecheckCompressedTextureWriter: typeof CompressedTextureWriter & {
+//   encodeURLtoURL: (
+//     inputUrl: string,
+//     outputUrl: string,
+//     options?: CompressedTextureWriterOptions
+//   ) => Promise<string>;
+// } = CompressedTextureWriter;

package/src/index.ts

@@ -1,3 +1,6 @@
+import {isBrowser} from '@loaders.gl/loader-utils';
+import {VERSION} from './lib/utils/version';
+
 // Types
 export type {GPUTextureFormat} from '@loaders.gl/schema';
 export type {TextureLoaderOptions} from './compressed-texture-loader';
@@ -10,7 +13,22 @@ export {NPYLoader, NPYWorkerLoader} from './npy-loader';
 
 // Writers
 export {CompressedTextureWriter} from './compressed-texture-writer';
-export {KTX2BasisUniversalTextureWriter} from './ktx2-basis-universal-texture-writer';
+export {KTX2BasisWriter} from './ktx2-basis-writer';
+
+export const KTX2BasisWriterWorker = {
+  name: 'Basis Universal Supercompressed GPU Texture',
+  id: isBrowser ? 'ktx2-basis-writer' : 'ktx2-basis-writer-nodejs',
+  module: 'textures',
+  version: VERSION,
+  extensions: ['ktx2'],
+  worker: true,
+  options: {
+    useSRGB: false,
+    qualityLevel: 10,
+    encodeUASTC: false,
+    mipmaps: false
+  }
+};
 
 // Texture Loading API
 export {loadImageTexture} from './lib/texture-api/load-image';

package/src/ktx2-basis-writer-nodejs.ts

@@ -0,0 +1,4 @@
+// Polyfills increases the bundle size significantly. Use it for NodeJS worker only
+import '@loaders.gl/polyfills';
+
+export {KTX2BasisWriter as KTX2BasisWriterNodeJS} from './ktx2-basis-writer';

package/src/{ktx2-basis-universal-texture-writer.ts → ktx2-basis-writer.ts}

@@ -1,14 +1,25 @@
+// loaders.gl, MIT license
+
 import type {Writer} from '@loaders.gl/loader-utils';
 import {VERSION} from './lib/utils/version';
+import type {ImageDataType} from '@loaders.gl/images';
 import {encodeKTX2BasisTexture} from './lib/encoders/encode-ktx2-basis-texture';
 
+/** @todo should be in basis sub-object */
+export type KTX2BasisWriterOptions = {
+  useSRGB?: boolean;
+  qualityLevel?: number;
+  encodeUASTC?: boolean;
+  mipmaps?: boolean;
+};
+
 /**
  *  Basis Universal Supercompressed GPU Texture.
  *  Spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.8/textureSetDefinitionFormat.cmn.md
  */
-export const KTX2BasisUniversalTextureWriter = {
+export const KTX2BasisWriter: Writer<ImageDataType, unknown, KTX2BasisWriterOptions> = {
   name: 'Basis Universal Supercompressed GPU Texture',
-  id: 'ktx2-basis-supercompressed-texture',
+  id: 'ktx2-basis-writer',
   module: 'textures',
   version: VERSION,
 
@@ -24,4 +35,4 @@ export const KTX2BasisUniversalTextureWriter = {
 };
 
 // TYPE TESTS - TODO find a better way than exporting junk
-export const _TypecheckKTX2TextureWriter: Writer = KTX2BasisUniversalTextureWriter;
+export const _TypecheckKTX2TextureWriter: Writer = KTX2BasisWriter;

package/src/lib/encoders/encode-texture.ts

@@ -1,4 +1,5 @@
 import {ChildProcessProxy} from '@loaders.gl/worker-utils';
+import {CompressedTextureWriterOptions} from '../../compressed-texture-writer';
 
 /*
  * @see https://github.com/TimvanScherpenzeel/texture-compressor
@@ -6,7 +7,7 @@ import {ChildProcessProxy} from '@loaders.gl/worker-utils';
 export async function encodeImageURLToCompressedTextureURL(
   inputUrl: string,
   outputUrl: string,
-  options?: {cwd?: string}
+  options?: CompressedTextureWriterOptions
 ): Promise<string> {
   // prettier-ignore
   const args = [

package/src/lib/parsers/parse-basis.ts

@@ -254,7 +254,7 @@ function transcodeKTX2Image(ktx2File, levelIndex: number, options): TextureLevel
     compressed,
 
     // Additional fields
-    // Add levelSize field.
+    levelSize: decodedSize,
     hasAlpha: alphaFlag,
     format
   };