@needle-tools/gltf-build-pipeline 1.5.0-alpha.6 → 1.5.0-alpha.8

package/CHANGELOG.md

@@ -4,8 +4,16 @@ All notable changes to this package will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [1.5.0-alpha.8] - 2023-05-16
+- fix: issue where updating ktx compressed texture extension also flattened the path
+
+## [1.5.0-alpha.7] - 2023-05-16
+- fix: external resources that are KTX2 compressed are now saved with a `.ktx2` extension
+- change: toktx now uses compression "auto" mode to select uastc or etc1s 
+- change: toktx now checks the slots and increases quality for `metallicRoughnessTexture` and `normalTexture` but keeps using ETC1S for smaller file size
+
 ## [1.5.0-alpha.6] - 2023-05-15
-- fix: If not further specified then automatically use UASTC for textures that are in either `normalTexture` or `metallicOcclusionTexture` slots
+- fix: If not further specified then automatically use UASTC for textures that are in either `normalTexture` or `metallicRoughnessTexture` slots
 
 ## [1.5.0-alpha.5] - 2023-05-04
 - fix: NEEDLE_opaque should handle if VRM texture index is negative

package/dist/transforms/needle_common.d.ts

@@ -1,6 +1,7 @@
 import { Document, Texture } from '@gltf-transform/core';
 import { NEEDLE_compression_texture_schema } from '../extensions/index.js';
 export interface NeedleTransformContext {
+    /** full path to the file being processed */
     file: string;
     debug?: boolean;
     useCache: boolean;

package/dist/transforms/needle_texture_transform.js

@@ -5,6 +5,8 @@ import { addToCache, getKey, tryGetFromCache } from "../cache/index.js";
 import { NeedleWebPContext } from "./needle_webp.js";
 import { NeedleToktxContext } from "./needle_toktx.js";
 import { createTransform } from "@gltf-transform/functions";
+import { dirname } from "path";
+import { existsSync, rmSync } from "fs";
 export async function resizeTextureIfNecessary(texture) {
     const ext = texture.getExtension(NEEDLE_compression_texture.EXTENSION_NAME);
     if (ext?.model) {
@@ -96,6 +98,7 @@ async function processTexture(texture, index, document, logger, context) {
     }
     let successFullyProcessed = false;
     const canRunToktx = context.noToktx !== true;
+    const originalUri = texture.getURI();
     if (compressionSettings && compressionSettings.mode !== "auto") {
         switch (compressionSettings.mode) {
             case "webp":
@@ -167,4 +170,15 @@ async function processTexture(texture, index, document, logger, context) {
         if (data)
             addToCache(key, data);
     }
+    if (successFullyProcessed) {
+        const newUri = texture.getURI();
+        if (originalUri && originalUri != newUri) {
+            const fileDirectory = dirname(context.file);
+            const originalPath = fileDirectory + "/" + originalUri;
+            if (existsSync(originalPath)) {
+                console.log(`INFO: Texture moved \"${originalUri}\" → \"${newUri}\"`);
+                rmSync(originalPath);
+            }
+        }
+    }
 }

package/dist/transforms/needle_toktx.js

@@ -8,6 +8,7 @@ import fs from 'fs/promises';
 import os from 'os';
 import tmp from 'tmp';
 import pLimit from 'p-limit';
+import { replaceExtension } from "../utils/fileutils.js";
 const NUM_CPUS = os.cpus().length || 1; // microsoft/vscode#112122
 let didLogEnvironmentInfo = false;
 export class NeedleToktxContext {
@@ -114,16 +115,29 @@ export class NeedleToktxContext {
             // const inBytes = image.byteLength;
             await fs.writeFile(inPath, Buffer.from(image));
             let mode = Mode.ETC1S;
+            let quality = 128;
+            let compression = 1;
             if (settings) {
-                mode = settings.mode === "ETC1S" ? Mode.ETC1S : Mode.UASTC;
+                if (settings.mode === "auto") {
+                    const useUASTC = slots.includes("normalTexture") || slots.includes("metallicRoughnessTexture");
+                    mode = useUASTC ? Mode.UASTC : Mode.ETC1S;
+                }
+                else {
+                    mode = settings.mode === "ETC1S" ? Mode.ETC1S : Mode.UASTC;
+                }
             }
             else if (slots) {
-                const useUASTC = slots.includes("normalTexture") || slots.includes("metallicRoughnessTexture");
-                mode = useUASTC ? Mode.UASTC : Mode.ETC1S;
+                const betterQuality = slots.includes("normalTexture") || slots.includes("metallicRoughnessTexture");
+                // mode = useUASTC ? Mode.UASTC : Mode.ETC1S;
+                mode = Mode.ETC1S;
+                // https://github.khronos.org/KTX-Software/ktxtools/toktx.html
+                quality = betterQuality ? 255 : 128;
+                // ETC1S / BasisLZ compression level, an encoding speed vs. quality tradeoff. Range is [0,5], default is 1. Higher values are slower but give higher quality.
+                compression = betterQuality ? 4 : 1;
             }
             const defaults = mode === Mode.ETC1S ? ETC1S_DEFAULTS : UASTC_DEFAULTS;
             //@ts-ignore
-            const toktxParams = createParams(slots, channels, size, logger, this.numTextures, { ...defaults, mode }, this.version);
+            const toktxParams = createParams(slots, channels, size, logger, this.numTextures, { ...defaults, mode, quality, compression }, this.version);
             const params = [
                 ...toktxParams,
                 outPath,
@@ -141,6 +155,13 @@ export class NeedleToktxContext {
                 else {
                     const result = await fs.readFile(outPath);
                     texture.setImage(result).setMimeType('image/ktx2');
+                    // TODO: we also need to remove the old file when the extension has changed - this should probably be done outside of this method to also support webp
+                    // If this is a texture that was loaded from a file, we need to update the URI
+                    if (texture.getURI()) {
+                        const oldUri = texture.getURI();
+                        const newUri = replaceExtension(oldUri, 'ktx2');
+                        texture.setURI(newUri);
+                    }
                     return true;
                 }
             }

package/dist/utils/fileutils.d.ts

@@ -1,2 +1,3 @@
 export declare type GLTFFileCallback = (file: string) => void | Promise<void>;
 export declare function foreachGLTF(args: string | string[], callback: GLTFFileCallback): Promise<void>;
+export declare function replaceExtension(filepath: string, newExtension: string): string;

package/dist/utils/fileutils.js

@@ -113,3 +113,8 @@ async function testEntry(entry, callback, context) {
         }
     }
 }
+export function replaceExtension(filepath, newExtension) {
+    const parts = filepath.split(".");
+    parts.pop();
+    return parts.join(".") + "." + newExtension;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@needle-tools/gltf-build-pipeline",
-  "version": "1.5.0-alpha.6",
+  "version": "1.5.0-alpha.8",
   "description": "Pipeline and tools for optimizing gltf files using gltf-transform and compression settings within glTF extensions",
   "main": "index.mjs",
   "type": "module",