[cli][functions] Replace @squoosh/lib with sharp (#752)

package.json

@@ -31,6 +31,7 @@
     "@types/ndarray": "1.0.11",
     "@types/node": "18.11.18",
     "@types/node-gzip": "1.1.0",
+    "@types/sharp": "^0.31.0",
     "@types/tape": "4.13.2",
     "@typescript-eslint/eslint-plugin": "5.47.1",
     "@typescript-eslint/parser": "5.47.1",

packages/cli/package.json

@@ -28,7 +28,6 @@
 		"@gltf-transform/core": "^2.5.1",
 		"@gltf-transform/extensions": "^2.5.1",
 		"@gltf-transform/functions": "^2.5.1",
-		"@squoosh/lib": "^0.4.0",
 		"@types/inquirer": "^8.2.1",
 		"@types/language-tags": "^1.0.0",
 		"@types/micromatch": "^4.0.2",
@@ -48,6 +47,7 @@
 		"node-gzip": "^1.1.2",
 		"p-limit": "3.1.0",
 		"semver": "^7.3.7",
+		"sharp": "^0.31.2",
 		"spdx-correct": "^3.1.1",
 		"tmp": "^0.2.1"
 	},
@@ -60,5 +60,5 @@
 		"package.json",
 		"package-lock.json"
 	],
-	"gitHead": "5cc8d10b5de17633b6a63a4fa5e10e0e60c71e84"
+	"gitHead": "381ba367afd6179de695be1e4a771b337ccdabad"
 }

packages/cli/src/cli.ts

@@ -6,20 +6,20 @@ import { gzip } from 'node-gzip';
 import { program } from '@caporal/core';
 import { Logger, NodeIO, PropertyType, VertexLayout, vec2 } from '@gltf-transform/core';
 import { ALL_EXTENSIONS } from '@gltf-transform/extensions';
-import { CenterOptions, InstanceOptions, PartitionOptions, PruneOptions, QUANTIZE_DEFAULTS, ResampleOptions, SequenceOptions, TEXTURE_RESIZE_DEFAULTS, TextureResizeFilter, UnweldOptions, WeldOptions, center, dedup, instance, metalRough, partition, prune, quantize, resample, sequence, tangents, textureResize, unweld, weld, reorder, dequantize, oxipng, mozjpeg, webp, unlit, meshopt, DRACO_DEFAULTS, draco, DracoOptions, simplify, SIMPLIFY_DEFAULTS, WELD_DEFAULTS } from '@gltf-transform/functions';
+import { CenterOptions, InstanceOptions, PartitionOptions, PruneOptions, QUANTIZE_DEFAULTS, ResampleOptions, SequenceOptions, TEXTURE_RESIZE_DEFAULTS, TextureResizeFilter, UnweldOptions, WeldOptions, center, dedup, instance, metalRough, partition, prune, quantize, resample, sequence, tangents, textureResize, unweld, weld, reorder, dequantize, unlit, meshopt, DRACO_DEFAULTS, draco, DracoOptions, simplify, SIMPLIFY_DEFAULTS, WELD_DEFAULTS, textureCompress, TEXTURE_COMPRESS_DEFAULTS } from '@gltf-transform/functions';
 import { InspectFormat, inspect } from './inspect';
 import { ETC1S_DEFAULTS, Filter, Mode, UASTC_DEFAULTS, ktxfix, merge, toktx, XMPOptions, xmp } from './transforms';
 import { formatBytes, MICROMATCH_OPTIONS, underline } from './util';
 import { Session } from './session';
 import { ValidateOptions, validate } from './validate';
-import * as squoosh from '@squoosh/lib';
 
 let io: NodeIO;
 
 // Use require() so microbundle doesn't compile these.
 const fetch = require('node-fetch');
 const draco3d = require('draco3dgltf');
 const mikktspace = require('mikktspace');
+const sharp = require('sharp');
 const { MeshoptDecoder, MeshoptEncoder, MeshoptSimplifier } = require('meshoptimizer');
 
 const programReady = new Promise<void>((resolve) => {
@@ -1009,31 +1009,19 @@ affects only the container metadata.`.trim())
 			.transform(ktxfix())
 	);
 
-const SQUOOSH_SUMMARY = `
-Compresses textures with {VARIANT}, using @squoosh/lib. Reduces transmitted file
+const TEXTURE_COMPRESS_SUMMARY = `
+Compresses textures with {VARIANT}, using sharp. Reduces transmitted file
 size. Compared to GPU texture compression like KTX/Basis, PNG/JPEG/WebP must
 be fully decompressed in GPU memory — this makes texture GPU upload much
 slower, and may consume 4-8x more GPU memory. However, the PNG/JPEG/WebP
 compression methods are typically more forgiving than GPU texture compression,
 and require less tuning to achieve good visual and filesize results.
-
-The experimental auto-optimization mode, --auto, can be used to iteratively
-refine and optimize encoder settings against perceptual metrics (Butteraugli
-distance). Slower, with typically higher-quality and larger images compared to
-the default encoder settings.
-
-${underline('NOTICE')}: Only a small subset of the available @squoosh/lib
-encoder configuration options are currently exposed by this commandline. If any
-contributors would like to recommend, test, and document additional encoder
-options, please open a pull request.
-
-See: https://github.com/GoogleChromeLabs/squoosh/blob/dev/libsquoosh/src/codecs.ts
 `.trim();
 
 // WEBP
 program
 	.command('webp', 'WebP texture compression')
-	.help(SQUOOSH_SUMMARY.replace(/{VARIANT}/g, 'WebP'))
+	.help(TEXTURE_COMPRESS_SUMMARY.replace(/{VARIANT}/g, 'WebP'))
 	.argument('<input>', INPUT_DESC)
 	.argument('<output>', OUTPUT_DESC)
 	.option(
@@ -1046,24 +1034,17 @@ program
 		'Texture slots to include (glob)',
 		{validator: program.STRING, default: '*'}
 	)
-	.option(
-		'--auto',
-		'Enables experimental auto-optimization with perceptual metrics.'
-		+ ' Slower, with typically higher-quality and larger images'
-		+ ' compared to the default encoder settings.',
-		{validator: program.BOOLEAN, default: false}
-	)
 	.action(({args, options, logger}) => {
 		const formats = micromatch.makeRe(String(options.formats), MICROMATCH_OPTIONS);
 		const slots = micromatch.makeRe(String(options.slots), MICROMATCH_OPTIONS);
 		return Session.create(io, logger, args.input, args.output)
-			.transform(webp({...options, formats, slots, squoosh}));
+			.transform(textureCompress({targetFormat: 'webp', encoder: sharp, formats, slots}));
 	});
 
-// OXIPNG
+// PNG
 program
-	.command('oxipng', 'OxiPNG texture compression')
-	.help(SQUOOSH_SUMMARY.replace(/{VARIANT}/g, 'OxiPNG'))
+	.command('png', 'PNG texture compression')
+	.help(TEXTURE_COMPRESS_SUMMARY.replace(/{VARIANT}/g, 'PNG'))
 	.argument('<input>', INPUT_DESC)
 	.argument('<output>', OUTPUT_DESC)
 	.option(
@@ -1076,24 +1057,17 @@ program
 		'Texture slots to include (glob)',
 		{validator: program.STRING, default: '*'}
 	)
-	.option(
-		'--auto',
-		'Enables experimental auto-optimization with perceptual metrics.'
-		+ ' Slower, with typically higher-quality and larger images'
-		+ ' compared to the default encoder settings.',
-		{validator: program.BOOLEAN, default: false}
-	)
 	.action(({args, options, logger}) => {
 		const formats = micromatch.makeRe(String(options.formats), MICROMATCH_OPTIONS);
 		const slots = micromatch.makeRe(String(options.slots), MICROMATCH_OPTIONS);
 		return Session.create(io, logger, args.input, args.output)
-			.transform(oxipng({...options, formats, slots, squoosh}));
+			.transform(textureCompress({targetFormat: 'png', encoder: sharp, formats, slots}));
 	});
 
-// MOZJPEG
+// JPEG
 program
-	.command('mozjpeg', 'MozJPEG texture compression')
-	.help(SQUOOSH_SUMMARY.replace(/{VARIANT}/g, 'MozJPEG'))
+	.command('jpeg', 'JPEG texture compression')
+	.help(TEXTURE_COMPRESS_SUMMARY.replace(/{VARIANT}/g, 'JPEG'))
 	.argument('<input>', INPUT_DESC)
 	.argument('<output>', OUTPUT_DESC)
 	.option(
@@ -1106,18 +1080,11 @@ program
 		'Texture slots to include (glob)',
 		{validator: program.STRING, default: '*'}
 	)
-	.option(
-		'--auto',
-		'Enables experimental auto-optimization with perceptual metrics.'
-		+ ' Slower, with typically higher-quality and larger images'
-		+ ' compared to the default encoder settings.',
-		{validator: program.BOOLEAN, default: false}
-	)
 	.action(({args, options, logger}) => {
 		const formats = micromatch.makeRe(String(options.formats), MICROMATCH_OPTIONS);
 		const slots = micromatch.makeRe(String(options.slots), MICROMATCH_OPTIONS);
 		return Session.create(io, logger, args.input, args.output)
-			.transform(mozjpeg({...options, formats, slots, squoosh}));
+			.transform(textureCompress({targetFormat: 'jpeg', encoder: sharp, formats, slots}));
 	});
 
 program.command('', '\n\n⏯  ANIMATION ────────────────────────────────────────');

packages/cli/src/types/global.d.ts

@@ -1,5 +1,2 @@
 // See: https://github.com/KhronosGroup/glTF-Validator/issues/114
 declare module 'gltf-validator';
-
-// See: https://github.com/GoogleChromeLabs/squoosh/issues/1211
-declare module '@squoosh/lib';

packages/core/package.json

@@ -46,5 +46,5 @@
 	"mangle": {
 		"regex": "^_"
 	},
-	"gitHead": "5cc8d10b5de17633b6a63a4fa5e10e0e60c71e84"
+	"gitHead": "381ba367afd6179de695be1e4a771b337ccdabad"
 }

packages/core/src/properties/texture.ts

@@ -71,7 +71,8 @@ export class Texture extends ExtensibleProperty<ITexture> {
 	 */
 	public setURI(uri: string): this {
 		this.set('uri', uri);
-		this.set('mimeType', ImageUtils.extensionToMimeType(FileUtils.extension(uri)));
+		const mimeType = ImageUtils.extensionToMimeType(FileUtils.extension(uri));
+		if (mimeType) this.set('mimeType', mimeType);
 		return this;
 	}
 

packages/core/src/utils/image-utils.ts

@@ -161,6 +161,7 @@ export class ImageUtils {
 	/** Returns the MIME type for the given file extension. */
 	public static extensionToMimeType(extension: string): string {
 		if (extension === 'jpg') return 'image/jpeg';
+		if (!extension) return '';
 		return `image/${extension}`;
 	}
 }

packages/extensions/package.json

@@ -38,5 +38,5 @@
 		"README.md",
 		"package.json"
 	],
-	"gitHead": "5cc8d10b5de17633b6a63a4fa5e10e0e60c71e84"
+	"gitHead": "381ba367afd6179de695be1e4a771b337ccdabad"
 }

packages/functions/package.json

@@ -47,5 +47,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "5cc8d10b5de17633b6a63a4fa5e10e0e60c71e84"
+	"gitHead": "381ba367afd6179de695be1e4a771b337ccdabad"
 }

packages/functions/src/index.ts

@@ -55,7 +55,7 @@ export * from './reorder';
 export * from './sequence';
 export * from './simplify';
 export * from './sort-primitive-weights';
-export * from './squoosh';
+export * from './texture-compress';
 export * from './tangents';
 export * from './texture-resize';
 export * from './transform-mesh';