first implementation of itxt on image.ts

This commit is contained in:
Gabriel Gomes 2025-03-29 20:23:12 +00:00
parent 04d0b00b95
commit 22869ee58c
2 changed files with 63 additions and 19 deletions

View file

@ -1,4 +1,5 @@
import tEXt from "png-chunk-text"; import tEXt from "png-chunk-text";
import { encode as encodeITXt, decode as decodeITXt } from "png-chunk-itxt";
import encodePng from "png-chunks-encode"; import encodePng from "png-chunks-encode";
import decodePng from "png-chunks-extract"; import decodePng from "png-chunks-extract";
@ -11,48 +12,89 @@ import { encode, decode } from "./encode";
// PNG // PNG
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
export const getTEXtChunk = async ( export const getMetadataChunk = async (
blob: Blob, blob: Blob,
): Promise<{ keyword: string; text: string } | null> => { ): Promise<{ keyword: string; text: string } | null> => {
const chunks = decodePng(new Uint8Array(await blobToArrayBuffer(blob))); const chunks = decodePng(new Uint8Array(await blobToArrayBuffer(blob)));
const metadataChunk = chunks.find((chunk) => chunk.name === "tEXt");
if (metadataChunk) { const iTXtChunk = chunks.find((chunk) => chunk.name === "iTXt");
return tEXt.decode(metadataChunk.data); if (iTXtChunk) {
try {
const decoded = decodeITXt(iTXtChunk.data);
return { keyword: decoded.keyword, text: decoded.text };
} catch (error) {
console.error("Failed to decode iTXt chunk:", error);
}
} }
const tEXtChunk = chunks.find((chunk) => chunk.name === "tEXt");
if (tEXtChunk) {
return tEXt.decode(tEXtChunk.data);
}
return null; return null;
}; };
export const encodePngMetadata = async ({ export const encodePngMetadata = async ({
blob, blob,
metadata, metadata,
useITXt = true,
}: { }: {
blob: Blob; blob: Blob;
metadata: string; metadata: string;
useITXt?: boolean;
}) => { }) => {
const chunks = decodePng(new Uint8Array(await blobToArrayBuffer(blob))); const chunks = decodePng(new Uint8Array(await blobToArrayBuffer(blob)));
const metadataChunk = tEXt.encode( const filteredChunks = chunks.filter(
MIME_TYPES.excalidraw, (chunk) =>
JSON.stringify( !(chunk.name === "tEXt" &&
encode({ tEXt.decode(chunk.data).keyword === MIME_TYPES.excalidraw) &&
text: metadata, !(chunk.name === "iTXt" &&
compress: true, decodeITXt(chunk.data).keyword === MIME_TYPES.excalidraw)
}), );
),
const encodedData = JSON.stringify(
encode({
text: metadata,
compress: true,
}),
); );
// insert metadata before last chunk (iEND)
chunks.splice(-1, 0, metadataChunk);
return new Blob([encodePng(chunks)], { type: MIME_TYPES.png }); let metadataChunk;
try {
if (useITXt) {
metadataChunk = encodeITXt(
MIME_TYPES.excalidraw,
encodedData,
{
compressed: false, //Already compressed in encode
language: "en",
translated: ""
}
);
} else {
throw new Error("Fallback to tEXt");
}
} catch (error) {
console.warn("iTXt encoding failed, falling back to tEXt:", error);
metadataChunk = tEXt.encode(
MIME_TYPES.excalidraw,
encodedData,
);
}
filteredChunks.splice(-1, 0, metadataChunk);
return new Blob([encodePng(filteredChunks)], { type: MIME_TYPES.png });
}; };
export const decodePngMetadata = async (blob: Blob) => { export const decodePngMetadata = async (blob: Blob) => {
const metadata = await getTEXtChunk(blob); const metadata = await getMetadataChunk(blob);
if (metadata?.keyword === MIME_TYPES.excalidraw) { if (metadata?.keyword === MIME_TYPES.excalidraw) {
try { try {
const encodedData = JSON.parse(metadata.text); const encodedData = JSON.parse(metadata.text);
if (!("encoded" in encodedData)) { if (!("encoded" in encodedData)) {
// legacy, un-encoded scene JSON
if ( if (
"type" in encodedData && "type" in encodedData &&
encodedData.type === EXPORT_DATA_TYPES.excalidraw encodedData.type === EXPORT_DATA_TYPES.excalidraw

View file

@ -101,9 +101,10 @@ export const exportToBlob = async (
mimeType?: string; mimeType?: string;
quality?: number; quality?: number;
exportPadding?: number; exportPadding?: number;
useITXt?: boolean;
}, },
): Promise<Blob> => { ): Promise<Blob> => {
let { mimeType = MIME_TYPES.png, quality } = opts; let { mimeType = MIME_TYPES.png, quality, useITXt = true } = opts;
if (mimeType === MIME_TYPES.png && typeof quality === "number") { if (mimeType === MIME_TYPES.png && typeof quality === "number") {
console.warn(`"quality" will be ignored for "${MIME_TYPES.png}" mimeType`); console.warn(`"quality" will be ignored for "${MIME_TYPES.png}" mimeType`);
@ -150,6 +151,7 @@ export const exportToBlob = async (
opts.files || {}, opts.files || {},
"local", "local",
), ),
useITXt,
}); });
} }
resolve(blob); resolve(blob);