SixLabors / SixLabors/ImageSharp.Textures

Add support for Apple KTX format

Open
#39 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C#
Stars
67
Forks
17
PR merge metrics
No merged PRs in 30d

Description

Would there be any interest in adding support for the Apple KTX format? It would be very useful, at least for us, to be able to use this directly in ImageSharp. I saw that a request for adding support for CgBI images (another internal Apple image format) had been accepted, and this is a very similar situation.

It is a supercompressed variant of KTX1 using LZFSE. Once decrompressed from LZFSE, the textures can be decompressed as a standard ASTC compressed KTX texture.

The main challenge would be incorporating an LZFSE decoder in ImageSharp.Textures. I have an implementation that could, with a little improvement, be incorporated in ImageSharp.Textures as I have done for ASTC. LZFSE is thankfully a lot simpler and the scope is therefore much smaller than ASTC.

The other challenge is that this is an internal Apple variant with no published spec (that I could find).

I have made a proof of concept implementation: https://github.com/Erik-White/ImageSharp.Textures/commit/163f828bd9801917e5fd542e59a1fff5f37c8c17

Layout
[8 bytes]  Magic: AAPL\r\n\x1A\n  (0x4141504C 0D0A1A0A)
[chunks]   Sequence of tagged chunks until end of file

Each chunk has an 8-byte header:

[4 bytes]  Data size (little-endian uint32)
[4 bytes]  Identifier (ASCII, e.g. "HEAD", "LZFS", "FILL")
[N bytes]  Chunk data

HEAD chunk (84 bytes) contains texture metadata. Key fields at byte offsets within the
chunk data:

Offset Size Field
16 4 Internal pixel format (OpenGL enum, e.g. 0x93B0 = ASTC 4x4)
24 4 Width
28 4 Height
32 4 Depth
36 4 Number of array elements
40 4 Number of faces
44 4 Number of mipmap levels

LZFS chunk holds the texture payload. The first 4 bytes after the chunk header are skipped,
and the remainder is LZFSE-compressed ASTC block data.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the ImageSharp.Textures code and the proof-of-concept commit, then inspect the linked LzfseSharp implementation and the existing ASTC support. Done means loading the documented Apple KTX chunks, decoding the LZFSE payload, and exposing the result as standard ASTC texture data despite the unpublished format specification.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
computer-graphics
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.