@needle-tools/gltf-build-pipeline 2.2.1-alpha.2 → 2.2.1-alpha.3

package/dist/transforms/toktx.d.ts

@@ -1,52 +1,52 @@
-import { Document, ILogger, vec2, Texture } from '@gltf-transform/core';
-import { ETC1SOptions, UASTCOptions } from './toktx_types.js';
-export declare const KTX_SOFTWARE_VERSION_MIN = "4.3.0";
-export declare const Filter: {
-    BOX: string;
-    TENT: string;
-    BELL: string;
-    BSPLINE: string;
-    MITCHELL: string;
-    LANCZOS3: string;
-    LANCZOS4: string;
-    LANCZOS6: string;
-    LANCZOS12: string;
-    BLACKMAN: string;
-    KAISER: string;
-    GAUSSIAN: string;
-    CATMULLROM: string;
-    QUADRATIC_INTERP: string;
-    QUADRATIC_APPROX: string;
-    QUADRATIC_MIX: string;
-};
-/**********************************************************************************************
- * Interfaces.
- */
-export declare const Mode: {
-    ETC1S: string;
-    UASTC: string;
-};
-export type TextureModeArgs = {
-    doc: Document;
-    texture: Texture;
-    index: number;
-    options: ETC1SOptions | UASTCOptions;
-};
-export type TextureParamsArgs = {
-    doc: Document;
-    texture: Texture;
-    index: number;
-    params: Array<string | number>;
-};
-export interface ToktxOptions {
-    toktxPath?: string;
-    /** return false if texture should not be compressed */
-    modifyOptions?: (args: TextureModeArgs) => void | boolean;
-    modifyParams?: (args: TextureParamsArgs) => void;
-}
-/**********************************************************************************************
- * Utilities.
- */
-/** Create CLI parameters from the given options. Attempts to write only non-default options. */
-export declare function createParams(texture: Texture, slots: string[], channels: number, size: vec2, logger: ILogger, numTextures: number, options: ETC1SOptions | UASTCOptions): (string | number)[];
-export declare function checkKTXSoftware(logger: ILogger, env?: any): Promise<string | null>;
+import { Document, ILogger, vec2, Texture } from '@gltf-transform/core';
+import { ETC1SOptions, UASTCOptions } from './toktx_types.js';
+export declare const KTX_SOFTWARE_VERSION_MIN = "4.3.0";
+export declare const Filter: {
+    BOX: string;
+    TENT: string;
+    BELL: string;
+    BSPLINE: string;
+    MITCHELL: string;
+    LANCZOS3: string;
+    LANCZOS4: string;
+    LANCZOS6: string;
+    LANCZOS12: string;
+    BLACKMAN: string;
+    KAISER: string;
+    GAUSSIAN: string;
+    CATMULLROM: string;
+    QUADRATIC_INTERP: string;
+    QUADRATIC_APPROX: string;
+    QUADRATIC_MIX: string;
+};
+/**********************************************************************************************
+ * Interfaces.
+ */
+export declare const Mode: {
+    ETC1S: string;
+    UASTC: string;
+};
+export type TextureModeArgs = {
+    doc: Document;
+    texture: Texture;
+    index: number;
+    options: ETC1SOptions | UASTCOptions;
+};
+export type TextureParamsArgs = {
+    doc: Document;
+    texture: Texture;
+    index: number;
+    params: Array<string | number>;
+};
+export interface ToktxOptions {
+    toktxPath?: string;
+    /** return false if texture should not be compressed */
+    modifyOptions?: (args: TextureModeArgs) => void | boolean;
+    modifyParams?: (args: TextureParamsArgs) => void;
+}
+/**********************************************************************************************
+ * Utilities.
+ */
+/** Create CLI parameters from the given options. Attempts to write only non-default options. */
+export declare function createParams(texture: Texture, slots: string[], channels: number, size: vec2, logger: ILogger, numTextures: number, options: ETC1SOptions | UASTCOptions): (string | number)[];
+export declare function checkKTXSoftware(logger: ILogger, env?: any): Promise<string | null>;

package/dist/transforms/toktx.js

@@ -1,221 +1,221 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
-import micromatch from 'micromatch';
-import os from 'os';
-import semver from 'semver';
-import tmp from 'tmp';
-import { TextureChannel } from '@gltf-transform/core';
-import { execSync } from 'child_process';
-import { spawn, commandExists, waitExit, MICROMATCH_OPTIONS } from './util.js';
-import { TextureResizeFilter, getTextureColorSpace } from '@gltf-transform/functions';
-import { ETC1S_DEFAULTS, UASTC_DEFAULTS } from './toktx_types.js';
-tmp.setGracefulCleanup();
-const NUM_CPUS = os.cpus().length || 1; // microsoft/vscode#112122
-export const KTX_SOFTWARE_VERSION_MIN = '4.3.0';
-export const Filter = {
-    BOX: 'box',
-    TENT: 'tent',
-    BELL: 'bell',
-    BSPLINE: 'b-spline',
-    MITCHELL: 'mitchell',
-    LANCZOS3: 'lanczos3',
-    LANCZOS4: 'lanczos4',
-    LANCZOS6: 'lanczos6',
-    LANCZOS12: 'lanczos12',
-    BLACKMAN: 'blackman',
-    KAISER: 'kaiser',
-    GAUSSIAN: 'gaussian',
-    CATMULLROM: 'catmullrom',
-    QUADRATIC_INTERP: 'quadratic_interp',
-    QUADRATIC_APPROX: 'quadratic_approx',
-    QUADRATIC_MIX: 'quadratic_mix',
-};
-const GLOBAL_DEFAULTS = {
-    resizeFilter: TextureResizeFilter.LANCZOS3,
-    filter: Filter.LANCZOS4,
-    filterScale: 1,
-    pattern: null,
-    slots: null,
-    // See: https://github.com/donmccurdy/glTF-Transform/pull/389#issuecomment-1089842185
-    jobs: 2 * NUM_CPUS,
-    cleanup: true,
-    limitInputPixels: true,
-};
-const { R, G, A } = TextureChannel;
-/**********************************************************************************************
- * Interfaces.
- */
-export const Mode = {
-    ETC1S: 'etc1s',
-    UASTC: 'uastc',
-};
-/**********************************************************************************************
- * Utilities.
- */
-/** Create CLI parameters from the given options. Attempts to write only non-default options. */
-export function createParams(texture, slots, channels, size, logger, numTextures, options) {
-    const colorSpace = getTextureColorSpace(texture);
-    const params = ['--generate-mipmap'];
-    if (options.filter !== GLOBAL_DEFAULTS.filter) {
-        params.push('--mipmap-filter', options.filter);
-    }
-    if (options.filterScale !== GLOBAL_DEFAULTS.filterScale) {
-        params.push('--mipmap-filter-scale', options.filterScale);
-    }
-    // See: https://github.com/KhronosGroup/KTX-Software/issues/600
-    const isNormalMap = slots.find((slot) => micromatch.isMatch(slot, '*normal*', MICROMATCH_OPTIONS));
-    if (options.mode === Mode.UASTC) {
-        const _options = options;
-        params.push('--encode', 'uastc');
-        params.push('--uastc-quality', _options.level);
-        if (_options.rdo && !isNormalMap) {
-            params.push('--uastc-rdo');
-            if (_options.rdoLambda !== UASTC_DEFAULTS.rdoLambda) {
-                params.push('--uastc-rdo-l', _options.rdoLambda);
-            }
-            if (_options.rdoDictionarySize !== UASTC_DEFAULTS.rdoDictionarySize) {
-                params.push('--uastc-rdo-d', _options.rdoDictionarySize);
-            }
-            if (_options.rdoBlockScale !== UASTC_DEFAULTS.rdoBlockScale) {
-                params.push('--uastc-rdo-b', _options.rdoBlockScale);
-            }
-            if (_options.rdoStdDev !== UASTC_DEFAULTS.rdoStdDev) {
-                params.push('--uastc-rdo-s', _options.rdoStdDev);
-            }
-            if (!_options.rdoMultithreading) {
-                params.push('--uastc-rdo-m');
-            }
-        }
-        if (_options.zstd && _options.zstd > 0) {
-            params.push('--zstd', _options.zstd);
-        }
-    }
-    else {
-        const _options = options;
-        params.push('--encode', 'basis-lz');
-        if (_options.quality !== ETC1S_DEFAULTS.quality) {
-            params.push('--qlevel', _options.quality);
-        }
-        if (_options.compression !== ETC1S_DEFAULTS.compression) {
-            params.push('--clevel', _options.compression);
-        }
-        if (_options.rdo && !isNormalMap) {
-            if (_options.maxEndpoints !== ETC1S_DEFAULTS.maxEndpoints) {
-                params.push('--max-endpoints', _options.maxEndpoints);
-            }
-            if (_options.maxSelectors !== ETC1S_DEFAULTS.maxSelectors) {
-                params.push('--max-selectors', _options.maxSelectors);
-            }
-            if (_options.rdoThreshold !== ETC1S_DEFAULTS.rdoThreshold) {
-                params.push('--endpoint-rdo-threshold', _options.rdoThreshold);
-                params.push('--selector-rdo-threshold', _options.rdoThreshold);
-            }
-        }
-        else {
-            params.push('--no-endpoint-rdo', '--no-selector-rdo');
-        }
-    }
-    // See: https://github.com/donmccurdy/glTF-Transform/issues/215
-    if (colorSpace === 'srgb') {
-        params.push('--assign-oetf', 'srgb', '--assign-primaries', 'bt709');
-    }
-    else if (colorSpace === 'srgb-linear') {
-        params.push('--assign-oetf', 'linear', '--assign-primaries', 'bt709');
-    }
-    else if (slots.length && !colorSpace) {
-        params.push('--assign-oetf', 'linear', '--assign-primaries', 'none');
-    }
-    if (channels === R) {
-        params.push('--format', 'R8_UNORM');
-    }
-    else if (channels === G || channels === (R | G)) {
-        params.push('--format', 'R8G8_UNORM');
-    }
-    else if (!(channels & A)) {
-        params.push('--format', colorSpace === 'srgb' ? 'R8G8B8_SRGB' : 'R8G8B8_UNORM');
-    }
-    else {
-        params.push('--format', colorSpace === 'srgb' ? 'R8G8B8A8_SRGB' : 'R8G8B8A8_UNORM');
-    }
-    if (options.jobs && options.jobs > 1 && numTextures > 1) {
-        // See: https://github.com/donmccurdy/glTF-Transform/pull/389#issuecomment-1089842185
-        const threads = Math.max(2, Math.min(NUM_CPUS, Math.round((3 * NUM_CPUS) / numTextures)));
-        params.push('--threads', threads);
-    }
-    return params;
-}
-let didLogToktxVersion = false;
-export async function checkKTXSoftware(logger, env) {
-    let failedFindingToktx = false;
-    const proc = spawn('toktx', ['--version'], { env: env });
-    proc.on('error', (err) => {
-        if (err.message.endsWith("ENOENT")) {
-            failedFindingToktx = true;
-        }
-    });
-    const [status, stdout, stderr] = await waitExit(proc);
-    if (failedFindingToktx) {
-        console.log(`WARN: Unable to find "toktx". Confirm KTX-Software is installed from: https://github.com/KhronosGroup/KTX-Software.`);
-        return null;
-    }
-    const version = (stdout || stderr)
-        .replace(/toktx\s+/, '')
-        .replace(/~\d+/, '')
-        .trim();
-    if (status !== 0 || !semver.valid(semver.clean(version))) {
-        throw new Error('Unable to find "toktx" version. Confirm KTX-Software is installed from:\n\nhttps://github.com/KhronosGroup/KTX-Software.');
-    }
-    else if (semver.lt(semver.clean(version), KTX_SOFTWARE_VERSION_MIN)) {
-        logger.warn(`toktx: Expected KTX-Software >= v${KTX_SOFTWARE_VERSION_MIN}, found ${version}.`);
-        return null;
-    }
-    else {
-        if (!didLogToktxVersion)
-            logger.debug(`toktx: Found KTX-Software ${version}.`);
-        didLogToktxVersion = true;
-    }
-    return semver.clean(version);
-}
-async function toktxCommandExistsSync(env) {
-    if (env) {
-        // if env is defined use that to check if toktx is installed
-        try {
-            execSync('toktx --version', { encoding: 'utf-8', env: env });
-            return true;
-        }
-        catch (error) {
-            return false;
-        }
-    }
-    else if (!await commandExists('toktx')) {
-        return false;
-    }
-    return true;
-}
-function isPowerOfTwo(value) {
-    if (value <= 2)
-        return true;
-    return (value & (value - 1)) === 0 && value !== 0;
-}
-function preferredPowerOfTwo(value) {
-    if (value <= 4)
-        return 4;
-    const lo = floorPowerOfTwo(value);
-    const hi = ceilPowerOfTwo(value);
-    if (hi - value > value - lo)
-        return lo;
-    return hi;
-}
-function floorPowerOfTwo(value) {
-    return Math.pow(2, Math.floor(Math.log(value) / Math.LN2));
-}
-function ceilPowerOfTwo(value) {
-    return Math.pow(2, Math.ceil(Math.log(value) / Math.LN2));
-}
-function isMultipleOfFour(value) {
-    return value % 4 === 0;
-}
-function ceilMultipleOfFour(value) {
-    if (value <= 4)
-        return 4;
-    return value % 4 ? value + 4 - (value % 4) : value;
-}
+/* eslint-disable @typescript-eslint/no-var-requires */
+import micromatch from 'micromatch';
+import os from 'os';
+import semver from 'semver';
+import tmp from 'tmp';
+import { TextureChannel } from '@gltf-transform/core';
+import { execSync } from 'child_process';
+import { spawn, commandExists, waitExit, MICROMATCH_OPTIONS } from './util.js';
+import { TextureResizeFilter, getTextureColorSpace } from '@gltf-transform/functions';
+import { ETC1S_DEFAULTS, UASTC_DEFAULTS } from './toktx_types.js';
+tmp.setGracefulCleanup();
+const NUM_CPUS = os.cpus().length || 1; // microsoft/vscode#112122
+export const KTX_SOFTWARE_VERSION_MIN = '4.3.0';
+export const Filter = {
+    BOX: 'box',
+    TENT: 'tent',
+    BELL: 'bell',
+    BSPLINE: 'b-spline',
+    MITCHELL: 'mitchell',
+    LANCZOS3: 'lanczos3',
+    LANCZOS4: 'lanczos4',
+    LANCZOS6: 'lanczos6',
+    LANCZOS12: 'lanczos12',
+    BLACKMAN: 'blackman',
+    KAISER: 'kaiser',
+    GAUSSIAN: 'gaussian',
+    CATMULLROM: 'catmullrom',
+    QUADRATIC_INTERP: 'quadratic_interp',
+    QUADRATIC_APPROX: 'quadratic_approx',
+    QUADRATIC_MIX: 'quadratic_mix',
+};
+const GLOBAL_DEFAULTS = {
+    resizeFilter: TextureResizeFilter.LANCZOS3,
+    filter: Filter.LANCZOS4,
+    filterScale: 1,
+    pattern: null,
+    slots: null,
+    // See: https://github.com/donmccurdy/glTF-Transform/pull/389#issuecomment-1089842185
+    jobs: 2 * NUM_CPUS,
+    cleanup: true,
+    limitInputPixels: true,
+};
+const { R, G, A } = TextureChannel;
+/**********************************************************************************************
+ * Interfaces.
+ */
+export const Mode = {
+    ETC1S: 'etc1s',
+    UASTC: 'uastc',
+};
+/**********************************************************************************************
+ * Utilities.
+ */
+/** Create CLI parameters from the given options. Attempts to write only non-default options. */
+export function createParams(texture, slots, channels, size, logger, numTextures, options) {
+    const colorSpace = getTextureColorSpace(texture);
+    const params = ['--generate-mipmap'];
+    if (options.filter !== GLOBAL_DEFAULTS.filter) {
+        params.push('--mipmap-filter', options.filter);
+    }
+    if (options.filterScale !== GLOBAL_DEFAULTS.filterScale) {
+        params.push('--mipmap-filter-scale', options.filterScale);
+    }
+    // See: https://github.com/KhronosGroup/KTX-Software/issues/600
+    const isNormalMap = slots.find((slot) => micromatch.isMatch(slot, '*normal*', MICROMATCH_OPTIONS));
+    if (options.mode === Mode.UASTC) {
+        const _options = options;
+        params.push('--encode', 'uastc');
+        params.push('--uastc-quality', _options.level);
+        if (_options.rdo && !isNormalMap) {
+            params.push('--uastc-rdo');
+            if (_options.rdoLambda !== UASTC_DEFAULTS.rdoLambda) {
+                params.push('--uastc-rdo-l', _options.rdoLambda);
+            }
+            if (_options.rdoDictionarySize !== UASTC_DEFAULTS.rdoDictionarySize) {
+                params.push('--uastc-rdo-d', _options.rdoDictionarySize);
+            }
+            if (_options.rdoBlockScale !== UASTC_DEFAULTS.rdoBlockScale) {
+                params.push('--uastc-rdo-b', _options.rdoBlockScale);
+            }
+            if (_options.rdoStdDev !== UASTC_DEFAULTS.rdoStdDev) {
+                params.push('--uastc-rdo-s', _options.rdoStdDev);
+            }
+            if (!_options.rdoMultithreading) {
+                params.push('--uastc-rdo-m');
+            }
+        }
+        if (_options.zstd && _options.zstd > 0) {
+            params.push('--zstd', _options.zstd);
+        }
+    }
+    else {
+        const _options = options;
+        params.push('--encode', 'basis-lz');
+        if (_options.quality !== ETC1S_DEFAULTS.quality) {
+            params.push('--qlevel', _options.quality);
+        }
+        if (_options.compression !== ETC1S_DEFAULTS.compression) {
+            params.push('--clevel', _options.compression);
+        }
+        if (_options.rdo && !isNormalMap) {
+            if (_options.maxEndpoints !== ETC1S_DEFAULTS.maxEndpoints) {
+                params.push('--max-endpoints', _options.maxEndpoints);
+            }
+            if (_options.maxSelectors !== ETC1S_DEFAULTS.maxSelectors) {
+                params.push('--max-selectors', _options.maxSelectors);
+            }
+            if (_options.rdoThreshold !== ETC1S_DEFAULTS.rdoThreshold) {
+                params.push('--endpoint-rdo-threshold', _options.rdoThreshold);
+                params.push('--selector-rdo-threshold', _options.rdoThreshold);
+            }
+        }
+        else {
+            params.push('--no-endpoint-rdo', '--no-selector-rdo');
+        }
+    }
+    // See: https://github.com/donmccurdy/glTF-Transform/issues/215
+    if (colorSpace === 'srgb') {
+        params.push('--assign-oetf', 'srgb', '--assign-primaries', 'bt709');
+    }
+    else if (colorSpace === 'srgb-linear') {
+        params.push('--assign-oetf', 'linear', '--assign-primaries', 'bt709');
+    }
+    else if (slots.length && !colorSpace) {
+        params.push('--assign-oetf', 'linear', '--assign-primaries', 'none');
+    }
+    if (channels === R) {
+        params.push('--format', 'R8_UNORM');
+    }
+    else if (channels === G || channels === (R | G)) {
+        params.push('--format', 'R8G8_UNORM');
+    }
+    else if (!(channels & A)) {
+        params.push('--format', colorSpace === 'srgb' ? 'R8G8B8_SRGB' : 'R8G8B8_UNORM');
+    }
+    else {
+        params.push('--format', colorSpace === 'srgb' ? 'R8G8B8A8_SRGB' : 'R8G8B8A8_UNORM');
+    }
+    if (options.jobs && options.jobs > 1 && numTextures > 1) {
+        // See: https://github.com/donmccurdy/glTF-Transform/pull/389#issuecomment-1089842185
+        const threads = Math.max(2, Math.min(NUM_CPUS, Math.round((3 * NUM_CPUS) / numTextures)));
+        params.push('--threads', threads);
+    }
+    return params;
+}
+let didLogToktxVersion = false;
+export async function checkKTXSoftware(logger, env) {
+    let failedFindingToktx = false;
+    const proc = spawn('toktx', ['--version'], { env: env });
+    proc.on('error', (err) => {
+        if (err.message.endsWith("ENOENT")) {
+            failedFindingToktx = true;
+        }
+    });
+    const [status, stdout, stderr] = await waitExit(proc);
+    if (failedFindingToktx) {
+        console.log(`WARN: Unable to find "toktx". Confirm KTX-Software is installed from: https://github.com/KhronosGroup/KTX-Software.`);
+        return null;
+    }
+    const version = (stdout || stderr)
+        .replace(/toktx\s+/, '')
+        .replace(/~\d+/, '')
+        .trim();
+    if (status !== 0 || !semver.valid(semver.clean(version))) {
+        throw new Error('Unable to find "toktx" version. Confirm KTX-Software is installed from:\n\nhttps://github.com/KhronosGroup/KTX-Software.');
+    }
+    else if (semver.lt(semver.clean(version), KTX_SOFTWARE_VERSION_MIN)) {
+        logger.warn(`toktx: Expected KTX-Software >= v${KTX_SOFTWARE_VERSION_MIN}, found ${version}.`);
+        return null;
+    }
+    else {
+        if (!didLogToktxVersion)
+            logger.debug(`toktx: Found KTX-Software ${version}.`);
+        didLogToktxVersion = true;
+    }
+    return semver.clean(version);
+}
+async function toktxCommandExistsSync(env) {
+    if (env) {
+        // if env is defined use that to check if toktx is installed
+        try {
+            execSync('toktx --version', { encoding: 'utf-8', env: env });
+            return true;
+        }
+        catch (error) {
+            return false;
+        }
+    }
+    else if (!await commandExists('toktx')) {
+        return false;
+    }
+    return true;
+}
+function isPowerOfTwo(value) {
+    if (value <= 2)
+        return true;
+    return (value & (value - 1)) === 0 && value !== 0;
+}
+function preferredPowerOfTwo(value) {
+    if (value <= 4)
+        return 4;
+    const lo = floorPowerOfTwo(value);
+    const hi = ceilPowerOfTwo(value);
+    if (hi - value > value - lo)
+        return lo;
+    return hi;
+}
+function floorPowerOfTwo(value) {
+    return Math.pow(2, Math.floor(Math.log(value) / Math.LN2));
+}
+function ceilPowerOfTwo(value) {
+    return Math.pow(2, Math.ceil(Math.log(value) / Math.LN2));
+}
+function isMultipleOfFour(value) {
+    return value % 4 === 0;
+}
+function ceilMultipleOfFour(value) {
+    if (value <= 4)
+        return 4;
+    return value % 4 ? value + 4 - (value % 4) : value;
+}