@forgeax/engine-image 0.1.4 → 0.1.7

package/src/parse-image.ts

@@ -45,7 +45,7 @@ export interface ParseImageOptions {
 
 const DEFAULT_MAX_DIMENSION = 16384;
 
-const SUPPORTED_MIMES: readonly string[] = ['image/png', 'image/jpeg', 'image/x-tga'];
+const SUPPORTED_MIMES: readonly string[] = ['image/png', 'image/jpeg'];
 
 interface UpngDecoded {
   readonly width: number;
@@ -69,7 +69,6 @@ interface JpegDecoded {
  * Decoder selection follows the mime hint:
  * - `image/png` -> upng-js `UPNG.decode` + `UPNG.toRGBA8`
  * - `image/jpeg` -> jpeg-js `decode` with `formatAsRGBA: true`
- * - `image/x-tga` -> the built-in TGA true-color/grayscale decoder
  * - other -> `image-format-unsupported`
  *
  * Decoded bytes are always tight-packed RGBA (`bytes.length === width *
@@ -119,7 +118,7 @@ export function parseImage(
         );
       }
       rgba = new Uint8Array(first);
-    } else if (mime === 'image/jpeg') {
+    } else {
       // image/jpeg
       const jpegMod: {
         decode: (
@@ -136,11 +135,6 @@ export function parseImage(
       width = decoded.width;
       height = decoded.height;
       rgba = decoded.data;
-    } else {
-      const decoded = decodeTga(bytes);
-      width = decoded.width;
-      height = decoded.height;
-      rgba = decoded.bytes;
     }
   } catch (e) {
     return err(
@@ -175,102 +169,8 @@ export function parseImage(
     bytes: rgba,
     width,
     height,
-    mime: mime as 'image/png' | 'image/jpeg' | 'image/x-tga',
+    mime: mime as 'image/png' | 'image/jpeg',
     colorSpace: opts.colorSpace ?? 'srgb',
     mipmap: opts.mipmap ?? true,
   });
 }
-
-interface TgaDecoded {
-  readonly width: number;
-  readonly height: number;
-  readonly bytes: Uint8Array;
-}
-
-/**
- * Decode the portable TGA subset used by common FBX exports.
- *
- * The decoder owns the format boundary instead of trusting the extension: it
- * validates the header, supports uncompressed and RLE true-colour (24/32-bit)
- * plus grayscale (8-bit), and applies the origin bits from the image
- * descriptor while producing a top-left RGBA POD.
- */
-function decodeTga(bytes: Uint8Array): TgaDecoded {
-  if (bytes.length < 18) throw new Error('TGA header is truncated');
-
-  const colorMapType = bytes[1];
-  const imageType = bytes[2];
-  const idLength = bytes[0] ?? 0;
-  const width = (bytes[12] ?? 0) | ((bytes[13] ?? 0) << 8);
-  const height = (bytes[14] ?? 0) | ((bytes[15] ?? 0) << 8);
-  const pixelDepth = bytes[16] ?? 0;
-  const descriptor = bytes[17] ?? 0;
-  if (colorMapType !== 0) throw new Error('color-mapped TGA is unsupported');
-  if (width < 1 || height < 1) throw new Error('TGA dimensions must be positive');
-
-  const isTrueColor = imageType === 2 || imageType === 10;
-  const isGray = imageType === 3 || imageType === 11;
-  if (!isTrueColor && !isGray) throw new Error(`TGA image type ${imageType} is unsupported`);
-  if (isTrueColor && pixelDepth !== 24 && pixelDepth !== 32) {
-    throw new Error(`TGA true-color depth ${pixelDepth} is unsupported`);
-  }
-  if (isGray && pixelDepth !== 8)
-    throw new Error(`TGA grayscale depth ${pixelDepth} is unsupported`);
-
-  const bytesPerPixel = pixelDepth / 8;
-  let offset = 18 + idLength;
-  const pixelCount = width * height;
-  const out = new Uint8Array(pixelCount * 4);
-  const topOrigin = (descriptor & 0x20) !== 0;
-  const rightOrigin = (descriptor & 0x10) !== 0;
-  let filePixel = 0;
-
-  const writePixel = (pixel: Uint8Array): void => {
-    if (filePixel >= pixelCount) throw new Error('TGA pixel data has too many pixels');
-    const fileX = filePixel % width;
-    const fileY = Math.floor(filePixel / width);
-    const x = rightOrigin ? width - 1 - fileX : fileX;
-    const y = topOrigin ? fileY : height - 1 - fileY;
-    const destination = (y * width + x) * 4;
-    if (isGray) {
-      const value = pixel[0] ?? 0;
-      out[destination] = value;
-      out[destination + 1] = value;
-      out[destination + 2] = value;
-      out[destination + 3] = 255;
-    } else {
-      out[destination] = pixel[2] ?? 0;
-      out[destination + 1] = pixel[1] ?? 0;
-      out[destination + 2] = pixel[0] ?? 0;
-      out[destination + 3] = bytesPerPixel === 4 ? (pixel[3] ?? 255) : 255;
-    }
-    filePixel += 1;
-  };
-
-  const readPixel = (): Uint8Array => {
-    if (offset + bytesPerPixel > bytes.length) throw new Error('TGA pixel data is truncated');
-    const pixel = bytes.slice(offset, offset + bytesPerPixel);
-    offset += bytesPerPixel;
-    return pixel;
-  };
-
-  if (imageType === 2 || imageType === 3) {
-    while (filePixel < pixelCount) writePixel(readPixel());
-  } else {
-    while (filePixel < pixelCount) {
-      if (offset >= bytes.length) throw new Error('TGA RLE packet header is truncated');
-      const packet = bytes[offset++] ?? 0;
-      const count = (packet & 0x7f) + 1;
-      if (filePixel + count > pixelCount) throw new Error('TGA RLE packet exceeds image bounds');
-      if ((packet & 0x80) !== 0) {
-        const pixel = readPixel();
-        for (let i = 0; i < count; i++) writePixel(pixel);
-      } else {
-        for (let i = 0; i < count; i++) writePixel(readPixel());
-      }
-    }
-  }
-
-  if (filePixel !== pixelCount) throw new Error('TGA pixel count mismatch');
-  return { width, height, bytes: out };
-}

package/dist/__tests__/ktx2-encode-mode-owner.test-d.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=ktx2-encode-mode-owner.test-d.d.ts.map

package/dist/__tests__/ktx2-encode-mode-owner.test-d.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ktx2-encode-mode-owner.test-d.d.ts","sourceRoot":"","sources":["../../src/__tests__/ktx2-encode-mode-owner.test-d.ts"],"names":[],"mappings":""}

package/dist/__tests__/runtime-decode.unit.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=runtime-decode.unit.test.d.ts.map

package/dist/__tests__/runtime-decode.unit.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"runtime-decode.unit.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/runtime-decode.unit.test.ts"],"names":[],"mappings":""}

package/dist/__tests__/tga.unit.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=tga.unit.test.d.ts.map

package/dist/__tests__/tga.unit.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"tga.unit.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/tga.unit.test.ts"],"names":[],"mappings":""}

package/dist/runtime/__tests__/asset-decoders.unit.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=asset-decoders.unit.test.d.ts.map

package/dist/runtime/__tests__/asset-decoders.unit.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"asset-decoders.unit.test.d.ts","sourceRoot":"","sources":["../../../src/runtime/__tests__/asset-decoders.unit.test.ts"],"names":[],"mappings":""}

package/dist/runtime/decode-image-bytes.d.ts

@@ -1,7 +0,0 @@
-import type { ImageError, Result, TextureAsset } from '@forgeax/engine-types';
-/** Image-owned runtime boundary from encoded bytes to a TextureAsset POD. */
-export declare function decodeImageBytes(bytes: Uint8Array | ArrayBuffer, mime: string, opts?: {
-    readonly colorSpace?: 'srgb' | 'linear';
-    readonly mipmap?: boolean;
-}): Promise<Result<TextureAsset, ImageError>>;
-//# sourceMappingURL=decode-image-bytes.d.ts.map

package/dist/runtime/decode-image-bytes.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"decode-image-bytes.d.ts","sourceRoot":"","sources":["../../src/runtime/decode-image-bytes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAgB9E,6EAA6E;AAC7E,wBAAsB,gBAAgB,CACpC,KAAK,EAAE,UAAU,GAAG,WAAW,EAC/B,IAAI,EAAE,MAAM,EACZ,IAAI,GAAE;IAAE,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAC;IAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAA;CAAO,GAChF,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC,CAmB3C"}

package/dist/runtime/image-error.d.ts

@@ -1,3 +0,0 @@
-import type { ImageErrorCode, ImageErrorDetailFor, ImageErrorFor } from '@forgeax/engine-types';
-export declare function runtimeImageError<C extends ImageErrorCode>(detail: ImageErrorDetailFor<C>): ImageErrorFor<C>;
-//# sourceMappingURL=image-error.d.ts.map

package/dist/runtime/image-error.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"image-error.d.ts","sourceRoot":"","sources":["../../src/runtime/image-error.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,mBAAmB,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAGhG,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,cAAc,EACxD,MAAM,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAC7B,aAAa,CAAC,CAAC,CAAC,CAElB"}

package/src/__tests__/ktx2-encode-mode-owner.test-d.ts

@@ -1,70 +0,0 @@
-/// <reference types="node" />
-
-import { readFileSync } from 'node:fs';
-import type { BasisEncodeMode } from '@forgeax/engine-codec/encode';
-import { describe, expect, expectTypeOf, it } from 'vitest';
-import type {
-  BasisEncodeParams,
-  CompressionMode,
-  EncodeTextureResult,
-  ResolvedEncodeMode,
-} from '../ktx2-encode.js';
-
-type ExpectedCompressionMode = 'auto' | 'etc1s' | 'uastc' | 'none';
-type ExpectedResolvedEncodeMode = 'etc1s' | 'uastc' | 'uastc-hdr' | 'none';
-type EncodedMode = Extract<EncodeTextureResult, { readonly ok: true }>['value']['mode'];
-type FailedMode = Extract<EncodeTextureResult, { readonly ok: false }>['error']['mode'];
-
-const encodeSource = readFileSync(new URL('../ktx2-encode.ts', import.meta.url), 'utf8');
-
-describe('image KTX2 encode mode owner', () => {
-  it('keeps both exact image-side vocabularies and their public projections', () => {
-    expectTypeOf<CompressionMode>().toEqualTypeOf<ExpectedCompressionMode>();
-    expectTypeOf<ExpectedCompressionMode>().toEqualTypeOf<CompressionMode>();
-    expectTypeOf<ResolvedEncodeMode>().toEqualTypeOf<ExpectedResolvedEncodeMode>();
-    expectTypeOf<ExpectedResolvedEncodeMode>().toEqualTypeOf<ResolvedEncodeMode>();
-
-    const acceptsCompressionMode = (mode: CompressionMode): CompressionMode => mode;
-    acceptsCompressionMode('auto');
-    acceptsCompressionMode('etc1s');
-    acceptsCompressionMode('uastc');
-    acceptsCompressionMode('none');
-    // @ts-expect-error Delivery modes are not sidecar control-plane values.
-    acceptsCompressionMode('uastc-hdr');
-
-    const acceptsResolvedMode = (mode: ResolvedEncodeMode): ResolvedEncodeMode => mode;
-    acceptsResolvedMode('etc1s');
-    acceptsResolvedMode('uastc');
-    acceptsResolvedMode('uastc-hdr');
-    acceptsResolvedMode('none');
-    // @ts-expect-error The control-plane-only auto mode is not a resolved encoding.
-    acceptsResolvedMode('auto');
-
-    expectTypeOf<EncodedMode>().toEqualTypeOf<ResolvedEncodeMode>();
-    expectTypeOf<FailedMode>().toEqualTypeOf<ResolvedEncodeMode>();
-    expectTypeOf<BasisEncodeParams['mode']>().toEqualTypeOf<BasisEncodeMode>();
-  });
-
-  it('keeps the runtime tuples as the single image-side mode owners', () => {
-    expect(encodeSource).toContain(
-      "const COMPRESSION_MODES = ['auto', 'etc1s', 'uastc', 'none'] as const;",
-    );
-    expect(encodeSource).toContain(
-      'export type CompressionMode = (typeof COMPRESSION_MODES)[number];',
-    );
-    expect(encodeSource).toContain(
-      "const RESOLVED_ENCODE_MODES = ['etc1s', 'uastc', 'uastc-hdr', 'none'] as const;",
-    );
-    expect(encodeSource).toContain(
-      'export type ResolvedEncodeMode = (typeof RESOLVED_ENCODE_MODES)[number];',
-    );
-    expect(encodeSource).toContain('case COMPRESSION_MODES[3]:');
-    expect(encodeSource).toContain('case RESOLVED_ENCODE_MODES[2]:');
-    expect(encodeSource).not.toContain(
-      "export type CompressionMode = 'auto' | 'etc1s' | 'uastc' | 'none';",
-    );
-    expect(encodeSource).not.toContain(
-      "export type ResolvedEncodeMode = 'etc1s' | 'uastc' | 'uastc-hdr' | 'none';",
-    );
-  });
-});

package/src/__tests__/runtime-decode.unit.test.ts

@@ -1,22 +0,0 @@
-import { describe, expect, it } from 'vitest';
-import { decodeImageBytes } from '../runtime/decode-image-bytes';
-
-describe('image runtime decode owner', () => {
-  it('returns a closed failure when the host has no browser decoder', async () => {
-    const result = await decodeImageBytes(new Uint8Array([0x89, 0x50]), 'image/png');
-
-    expect(result.ok).toBe(false);
-    if (result.ok) return;
-    expect(result.error.code).toBe('image-decode-failed');
-    expect(result.error.expected).toContain('decodes successfully');
-    expect(result.error.hint).toBeTruthy();
-  });
-
-  it('does not silently reinterpret a codec MIME as a different image kind', async () => {
-    const result = await decodeImageBytes(new Uint8Array([1, 2, 3]), 'image/jpeg');
-
-    expect(result.ok).toBe(false);
-    if (result.ok) return;
-    expect(result.error.detail.code).toBe('image-decode-failed');
-  });
-});

package/src/__tests__/tga.unit.test.ts

@@ -1,59 +0,0 @@
-import { describe, expect, it } from 'vitest';
-import { parseImage } from '../parse-image.js';
-
-function makeTga24(
-  width: number,
-  height: number,
-  bgrPixels: readonly number[],
-  imageDescriptor = 0,
-): Uint8Array {
-  const header = new Uint8Array(18);
-  header[2] = 2; // uncompressed true-color
-  header[12] = width & 0xff;
-  header[13] = (width >>> 8) & 0xff;
-  header[14] = height & 0xff;
-  header[15] = (height >>> 8) & 0xff;
-  header[16] = 24;
-  header[17] = imageDescriptor;
-  return new Uint8Array([...header, ...bgrPixels]);
-}
-
-describe('parseImage TGA', () => {
-  it('decodes 24-bit true-color pixels to RGBA and honours bottom-left origin', () => {
-    // File order is bottom row first: blue, green, then top row red, yellow.
-    // The descriptor has no top bit, so the decoded image must be top row
-    // first while preserving left-to-right order.
-    const tga = makeTga24(2, 2, [255, 0, 0, 0, 255, 0, 0, 0, 255, 0, 255, 255]);
-    const result = parseImage(tga, 'image/x-tga', { mipmap: false });
-
-    expect(result.ok).toBe(true);
-    if (!result.ok) return;
-    expect(result.value.mime).toBe('image/x-tga');
-    expect(Array.from(result.value.bytes)).toEqual([
-      255, 0, 0, 255, 255, 255, 0, 255, 0, 0, 255, 255, 0, 255, 0, 255,
-    ]);
-    expect(result.value.width).toBe(2);
-    expect(result.value.height).toBe(2);
-  });
-
-  it('decodes 32-bit RLE pixels and preserves alpha', () => {
-    const header = new Uint8Array(18);
-    header[2] = 10; // RLE true-color
-    header[12] = 2;
-    header[14] = 1;
-    header[16] = 32;
-    const tga = new Uint8Array([
-      ...header,
-      0x81, // run of two pixels
-      10,
-      20,
-      30,
-      40,
-    ]);
-    const result = parseImage(tga, 'image/x-tga');
-
-    expect(result.ok).toBe(true);
-    if (!result.ok) return;
-    expect(Array.from(result.value.bytes)).toEqual([30, 20, 10, 40, 30, 20, 10, 40]);
-  });
-});

package/src/runtime/__tests__/asset-decoders.unit.test.ts

@@ -1,66 +0,0 @@
-import { ok } from '@forgeax/engine-types';
-import { describe, expect, it, vi } from 'vitest';
-
-vi.mock('@forgeax/engine-codec', () => ({
-  parseKtx2: vi.fn(async () => ({ ok: true, value: {} })),
-  transcodeBasis: vi.fn(),
-  transcodeKtx2: vi.fn(async (_parsed: unknown, target: string) => ({
-    ok: true,
-    value: {
-      format: target,
-      width: 2,
-      height: 2,
-      mips: [{ level: 0, width: 2, height: 2, data: new Uint8Array(16) }],
-    },
-  })),
-}));
-
-import { textureContribution } from '../asset-decoders.js';
-
-describe('runtime image asset decoder', () => {
-  it('transcodes Basis KTX2 artifacts to the uncompressed TextureAsset baseline', async () => {
-    const result = await textureContribution.decoder.decode({
-      envelope: {
-        guid: '019e3969-1d47-760f-982e-7bad1ffd969c',
-        kind: 'texture',
-        payload: {
-          kind: 'texture',
-          width: 4,
-          height: 4,
-          format: 'rgba8unorm-srgb',
-          colorSpace: 'srgb',
-          mipmap: true,
-          data: new Uint8Array(64),
-        },
-        refs: [],
-        artifacts: {
-          body: {
-            path: 'body.bin',
-            mediaType: 'image/ktx2',
-            assetCodec: { name: 'basis', container: 'ktx2', profile: 'etc1s' },
-            contentEncoding: 'identity',
-            byteLength: 4,
-            integrity: { algorithm: 'sha256', digest: `sha256:${'0'.repeat(64)}` },
-          },
-        },
-      },
-      artifacts: {
-        read: async () => ok(new Uint8Array([1, 2, 3, 4])),
-      },
-      signal: new AbortController().signal,
-    });
-
-    expect(result).toEqual({
-      ok: true,
-      value: expect.objectContaining({
-        kind: 'texture',
-        width: 2,
-        height: 2,
-        format: 'rgba8unorm-srgb',
-        colorSpace: 'srgb',
-        mipmap: true,
-        data: expect.any(Uint8Array),
-      }),
-    });
-  });
-});

package/src/runtime/decode-image-bytes.ts

@@ -1,41 +0,0 @@
-import type { ImageError, Result, TextureAsset } from '@forgeax/engine-types';
-import { err, ok } from '@forgeax/engine-types';
-import { decodeImageInBrowser } from '../image-decoder-browser';
-import { runtimeImageError } from './image-error';
-
-const SUPPORTED_MIMES = ['image/png', 'image/jpeg'] as const;
-type SupportedMime = (typeof SUPPORTED_MIMES)[number];
-
-function isSupportedMime(mime: string): mime is SupportedMime {
-  return SUPPORTED_MIMES.some((supportedMime) => supportedMime === mime);
-}
-
-function mipLevels(width: number, height: number): number {
-  return Math.floor(Math.log2(Math.max(width, height))) + 1;
-}
-
-/** Image-owned runtime boundary from encoded bytes to a TextureAsset POD. */
-export async function decodeImageBytes(
-  bytes: Uint8Array | ArrayBuffer,
-  mime: string,
-  opts: { readonly colorSpace?: 'srgb' | 'linear'; readonly mipmap?: boolean } = {},
-): Promise<Result<TextureAsset, ImageError>> {
-  if (!isSupportedMime(mime)) {
-    return err(runtimeImageError({ code: 'image-format-unsupported', actualMime: mime }));
-  }
-  const colorSpace = opts.colorSpace ?? 'srgb';
-  const mipmap = opts.mipmap ?? true;
-  const input = bytes instanceof Uint8Array ? bytes : new Uint8Array(bytes);
-  const decoded = await decodeImageInBrowser(input, mime as SupportedMime, { colorSpace, mipmap });
-  if (!decoded.ok) return err(decoded.error);
-  return ok({
-    kind: 'texture',
-    width: decoded.value.width,
-    height: decoded.value.height,
-    format: colorSpace === 'srgb' ? 'rgba8unorm-srgb' : 'rgba8unorm',
-    data: decoded.value.bytes,
-    colorSpace,
-    mipmap,
-    mipLevelCount: mipmap ? mipLevels(decoded.value.width, decoded.value.height) : 1,
-  });
-}

package/src/runtime/image-error.ts

@@ -1,8 +0,0 @@
-import type { ImageErrorCode, ImageErrorDetailFor, ImageErrorFor } from '@forgeax/engine-types';
-import { imageError } from '../errors';
-
-export function runtimeImageError<C extends ImageErrorCode>(
-  detail: ImageErrorDetailFor<C>,
-): ImageErrorFor<C> {
-  return imageError(detail);
-}