format-png 0.1.0

package/dist/wasm/format_png_wasm.d.ts

@@ -0,0 +1,473 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * A raw ancillary chunk. JavaScript reads `chunkType` and `position`, then calls
+ * `intoData()` once, which copies the data out and frees this object.
+ */
+export class Chunk {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * The chunk's data, without length, type and CRC. Consumes the chunk.
+     */
+    intoData(): Uint8Array;
+    /**
+     * The four-letter type, for example "tEXt".
+     */
+    readonly chunkType: string;
+    /**
+     * "before-palette", "before-image-data" or "after-image-data".
+     */
+    readonly position: string;
+}
+
+/**
+ * Every chunk of a PNG, from `read_chunks`. The raw chunks are flat arrays,
+ * one entry per chunk in file order, so JavaScript can view their data in the
+ * input it already has instead of copying it out of wasm memory.
+ */
+export class ChunkList {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    header(): Header;
+    metadata(): Metadata;
+    readonly crcs: Uint32Array;
+    /**
+     * 1 for each chunk this crate parses, 0 for unknown ones.
+     */
+    readonly known: Uint8Array;
+    /**
+     * The length of each chunk's data.
+     */
+    readonly lengths: Uint32Array;
+    /**
+     * Where each chunk starts in the input: its length field.
+     */
+    readonly offsets: Uint32Array;
+    /**
+     * `PLTE`: red, green and blue for each entry, in index order.
+     */
+    readonly palette: Uint8Array | undefined;
+    /**
+     * `tRNS`: "gray", "rgb" or "palette".
+     */
+    readonly transparencyKind: string | undefined;
+    /**
+     * `tRNS`: the transparent gray value, the transparent red, green and blue,
+     * or an alpha for each palette entry.
+     */
+    readonly transparencyValues: Uint16Array | undefined;
+    /**
+     * The four-letter types of every chunk, joined.
+     */
+    readonly types: string;
+}
+
+/**
+ * A decoded RGBA8 image. JavaScript reads `width`, `height`, `metadata()` and
+ * `takeChunks()`, then calls `intoPixels()` once, which copies the pixels out
+ * and frees this object.
+ */
+export class DecodedImage {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * The RGBA pixels, `width * height * 4` bytes. Consumes the image.
+     */
+    intoPixels(): Uint8Array;
+    /**
+     * The parsed ancillary chunks; empty unless `preserveMetadata` was set.
+     */
+    metadata(): Metadata;
+    /**
+     * The raw ancillary chunks; empty unless `preserveChunks` was set. Moves
+     * them out, so a second call returns none.
+     */
+    takeChunks(): Chunk[];
+    readonly height: number;
+    readonly width: number;
+}
+
+/**
+ * A decoder that keeps its buffers between images.
+ */
+export class Decoder {
+    free(): void;
+    [Symbol.dispose](): void;
+    decodeRgba8(bytes: Uint8Array): DecodedImage;
+    decode(bytes: Uint8Array): RawImage;
+    constructor(validate_crc: boolean, preserve_metadata: boolean, preserve_chunks: boolean, strict_ancillary: boolean);
+    readChunks(bytes: Uint8Array): ChunkList;
+}
+
+/**
+ * An image to encode, built up from JavaScript: the constructor takes the
+ * header and pixels, and each setter adds a chunk. Pass it to `encode` or
+ * `Encoder.encode`, then call `free()`.
+ */
+export class EncodeImage {
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Adds a raw chunk, written at `position`: one of the strings
+     * `Chunk.position` returns.
+     */
+    addChunk(chunk_type: string, data: Uint8Array, position: string): void;
+    /**
+     * Adds a `tEXt`, `zTXt` or `iTXt` chunk. `compressed` only matters for
+     * `iTXt`, and the language tag and translated keyword are only written
+     * there.
+     */
+    addText(chunk_type: string, keyword: string, text: string, language_tag: string, translated_keyword: string, compressed: boolean): void;
+    /**
+     * `colorType` is one of the strings `Header.colorType` returns. `data` is
+     * in the PNG's own pixel format; see `format_png::ImageRef`.
+     */
+    constructor(width: number, height: number, bit_depth: number, color_type: string, interlaced: boolean, data: Uint8Array);
+    /**
+     * `cHRM`: white, red, green and blue x and y, in that order, as fractions.
+     */
+    setChromaticities(values: Float64Array): void;
+    /**
+     * `cICP`: H.273 color primaries, transfer function and matrix coefficients,
+     * and whether samples use the full range.
+     */
+    setCicp(color_primaries: number, transfer_function: number, matrix_coefficients: number, full_range: boolean): void;
+    /**
+     * `eXIf`: Exif data, starting with its TIFF header, which is checked.
+     */
+    setExif(data: Uint8Array): void;
+    /**
+     * `gAMA`, for example 0.45455.
+     */
+    setGamma(gamma: number): void;
+    /**
+     * `iCCP`: an ICC profile, uncompressed, and its name. The encoder checks
+     * the name and compresses the profile.
+     */
+    setIccProfile(name: string, profile: Uint8Array): void;
+    /**
+     * `PLTE`: red, green and blue for each entry, in index order.
+     */
+    setPalette(colors: Uint8Array): void;
+    /**
+     * `pHYs`: pixels per unit, with unit "meter" or "unknown".
+     */
+    setPhysicalDimensions(x: number, y: number, unit: string): void;
+    /**
+     * `sRGB`, with one of the intents `Metadata.srgb` returns.
+     */
+    setSrgb(intent: string): void;
+    /**
+     * `tIME`: year, month, day, hour, minute and second, in UTC. The encoder
+     * checks the ranges.
+     */
+    setTime(year: number, month: number, day: number, hour: number, minute: number, second: number): void;
+    /**
+     * `tRNS`: `kind` is "gray", "rgb" or "palette", and `values` as
+     * `ChunkList.transparencyValues` returns them.
+     */
+    setTransparency(kind: string, values: Uint16Array): void;
+}
+
+/**
+ * An encoder that keeps its compressor and buffers between images.
+ */
+export class Encoder {
+    free(): void;
+    [Symbol.dispose](): void;
+    encode(image: EncodeImage): Uint8Array;
+    /**
+     * `compression` is 0 to 9. `compressionStrategy` is "dynamic", "fixed" or
+     * "stored"; `filter` is "adaptive", "none", "sub", "up", "average" or
+     * "paeth"; `palette` is "keep" or "auto"; `strip` is "keep", "safe" or "all".
+     */
+    constructor(compression: number, compression_strategy: string, filter: string, keep_unsafe_chunks: boolean, palette: string, strip: string);
+}
+
+/**
+ * The contents of the `IHDR` chunk.
+ */
+export class Header {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    readonly bitDepth: number;
+    readonly height: number;
+    readonly interlaced: boolean;
+    readonly width: number;
+    /**
+     * "grayscale", "rgb", "indexed", "grayscale-alpha" or "rgba".
+     */
+    readonly colorType: string;
+}
+
+/**
+ * The known ancillary chunks. Each getter is `undefined` if the chunk is absent.
+ */
+export class Metadata {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * `tEXt`, `zTXt` and `iTXt`, in file order.
+     */
+    text(): Text[];
+    /**
+     * `cHRM`: white, red, green and blue x and y, in that order, as fractions.
+     */
+    readonly chromaticities: Float64Array | undefined;
+    /**
+     * `cICP`: color primaries, transfer function, matrix coefficients and the
+     * full-range flag (1 or 0), in that order.
+     */
+    readonly cicp: Uint8Array | undefined;
+    /**
+     * `eXIf`: "big-endian" or "little-endian".
+     */
+    readonly exifByteOrder: string | undefined;
+    /**
+     * `eXIf`: the Exif data, raw, starting with its TIFF header.
+     */
+    readonly exif: Uint8Array | undefined;
+    /**
+     * `gAMA`, for example 0.45455.
+     */
+    readonly gamma: number | undefined;
+    /**
+     * `iCCP`: the profile's name.
+     */
+    readonly iccProfileName: string | undefined;
+    /**
+     * `iCCP`: the ICC profile, decompressed.
+     */
+    readonly iccProfile: Uint8Array | undefined;
+    /**
+     * `pHYs`: pixels per unit, x then y.
+     */
+    readonly physicalPixelsPerUnit: Uint32Array | undefined;
+    /**
+     * `pHYs` unit: "meter" or "unknown" (the values are only an aspect ratio).
+     */
+    readonly physicalUnit: string | undefined;
+    /**
+     * `sRGB`: "perceptual", "relative-colorimetric", "saturation" or "absolute-colorimetric".
+     */
+    readonly srgb: string | undefined;
+    /**
+     * `tIME`: year, month, day, hour, minute and second, in UTC.
+     */
+    readonly time: Uint16Array | undefined;
+}
+
+/**
+ * A decoded image in the file's own format, from `decode`. JavaScript reads
+ * the header, palette, transparency, `metadata()` and `takeChunks()`, then
+ * calls `intoData()` once, which copies the samples out and frees this object.
+ */
+export class RawImage {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    header(): Header;
+    /**
+     * The samples in the file's own layout: rows of the header's stride, 16-bit
+     * samples big-endian, pixels under 8 bits packed with each row padded to a
+     * whole byte, palette indices for indexed images. Consumes the image.
+     */
+    intoData(): Uint8Array;
+    /**
+     * The parsed ancillary chunks; empty unless `preserveMetadata` was set.
+     */
+    metadata(): Metadata;
+    /**
+     * The raw ancillary chunks; empty unless `preserveChunks` was set.
+     */
+    takeChunks(): Chunk[];
+    /**
+     * `PLTE`: red, green and blue for each entry, in index order.
+     */
+    readonly palette: Uint8Array | undefined;
+    /**
+     * `tRNS`: "gray", "rgb" or "palette".
+     */
+    readonly transparencyKind: string | undefined;
+    /**
+     * `tRNS`, as `ChunkList.transparencyValues`.
+     */
+    readonly transparencyValues: Uint16Array | undefined;
+}
+
+/**
+ * A `tEXt`, `zTXt` or `iTXt` chunk, decoded. JavaScript reads the getters, then
+ * calls `free()`.
+ */
+export class Text {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * "tEXt", "zTXt" or "iTXt".
+     */
+    readonly chunkType: string;
+    /**
+     * Whether the text was zlib-compressed in the file.
+     */
+    readonly compressed: boolean;
+    readonly keyword: string;
+    readonly languageTag: string;
+    readonly text: string;
+    readonly translatedKeyword: string;
+}
+
+/**
+ * Decodes a PNG in its own format with a one-off decoder.
+ */
+export function decode(bytes: Uint8Array, validate_crc: boolean, preserve_metadata: boolean, preserve_chunks: boolean, strict_ancillary: boolean): RawImage;
+
+/**
+ * Decodes a PNG to RGBA8 with a one-off decoder.
+ */
+export function decodeRgba8(bytes: Uint8Array, validate_crc: boolean, preserve_metadata: boolean, preserve_chunks: boolean, strict_ancillary: boolean): DecodedImage;
+
+/**
+ * Encodes an image with a one-off encoder.
+ */
+export function encode(image: EncodeImage, compression: number, compression_strategy: string, filter: string, keep_unsafe_chunks: boolean, palette: string, strip: string): Uint8Array;
+
+/**
+ * Parses the data of a `tEXt`, `zTXt` or `iTXt` chunk on its own.
+ */
+export function parseText(chunk_type: string, data: Uint8Array): Text;
+
+/**
+ * Reads and parses every chunk without decompressing the image data.
+ */
+export function readChunks(bytes: Uint8Array, validate_crc: boolean, strict_ancillary: boolean): ChunkList;
+
+/**
+ * Reads only the header.
+ */
+export function readHeader(bytes: Uint8Array): Header;
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+    readonly memory: WebAssembly.Memory;
+    readonly __wbg_chunk_free: (a: number, b: number) => void;
+    readonly __wbg_chunklist_free: (a: number, b: number) => void;
+    readonly __wbg_decodedimage_free: (a: number, b: number) => void;
+    readonly __wbg_decoder_free: (a: number, b: number) => void;
+    readonly __wbg_encodeimage_free: (a: number, b: number) => void;
+    readonly __wbg_encoder_free: (a: number, b: number) => void;
+    readonly __wbg_get_decodedimage_height: (a: number) => number;
+    readonly __wbg_get_decodedimage_width: (a: number) => number;
+    readonly __wbg_get_header_bitDepth: (a: number) => number;
+    readonly __wbg_get_header_height: (a: number) => number;
+    readonly __wbg_get_header_interlaced: (a: number) => number;
+    readonly __wbg_get_header_width: (a: number) => number;
+    readonly __wbg_header_free: (a: number, b: number) => void;
+    readonly __wbg_metadata_free: (a: number, b: number) => void;
+    readonly __wbg_rawimage_free: (a: number, b: number) => void;
+    readonly __wbg_text_free: (a: number, b: number) => void;
+    readonly chunk_chunkType: (a: number) => [number, number];
+    readonly chunk_intoData: (a: number) => [number, number];
+    readonly chunk_position: (a: number) => [number, number];
+    readonly chunklist_crcs: (a: number) => [number, number];
+    readonly chunklist_header: (a: number) => number;
+    readonly chunklist_known: (a: number) => [number, number];
+    readonly chunklist_lengths: (a: number) => [number, number];
+    readonly chunklist_metadata: (a: number) => number;
+    readonly chunklist_offsets: (a: number) => [number, number];
+    readonly chunklist_palette: (a: number) => [number, number];
+    readonly chunklist_transparencyKind: (a: number) => [number, number];
+    readonly chunklist_transparencyValues: (a: number) => [number, number];
+    readonly chunklist_types: (a: number) => [number, number];
+    readonly decode: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number, number];
+    readonly decodeRgba8: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number, number];
+    readonly decodedimage_intoPixels: (a: number) => [number, number];
+    readonly decodedimage_metadata: (a: number) => number;
+    readonly decodedimage_takeChunks: (a: number) => [number, number];
+    readonly decoder_decode: (a: number, b: number, c: number) => [number, number, number];
+    readonly decoder_decodeRgba8: (a: number, b: number, c: number) => [number, number, number];
+    readonly decoder_new: (a: number, b: number, c: number, d: number) => number;
+    readonly decoder_readChunks: (a: number, b: number, c: number) => [number, number, number];
+    readonly encode: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number) => [number, number, number, number];
+    readonly encodeimage_addChunk: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => [number, number];
+    readonly encodeimage_addText: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number, l: number) => [number, number];
+    readonly encodeimage_new: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => [number, number, number];
+    readonly encodeimage_setChromaticities: (a: number, b: number, c: number) => [number, number];
+    readonly encodeimage_setCicp: (a: number, b: number, c: number, d: number, e: number) => void;
+    readonly encodeimage_setExif: (a: number, b: number, c: number) => [number, number];
+    readonly encodeimage_setGamma: (a: number, b: number) => [number, number];
+    readonly encodeimage_setIccProfile: (a: number, b: number, c: number, d: number, e: number) => void;
+    readonly encodeimage_setPalette: (a: number, b: number, c: number) => [number, number];
+    readonly encodeimage_setPhysicalDimensions: (a: number, b: number, c: number, d: number, e: number) => [number, number];
+    readonly encodeimage_setSrgb: (a: number, b: number, c: number) => [number, number];
+    readonly encodeimage_setTime: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
+    readonly encodeimage_setTransparency: (a: number, b: number, c: number, d: number, e: number) => [number, number];
+    readonly encoder_encode: (a: number, b: number) => [number, number, number, number];
+    readonly encoder_new: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number) => [number, number, number];
+    readonly header_colorType: (a: number) => [number, number];
+    readonly metadata_chromaticities: (a: number) => [number, number];
+    readonly metadata_cicp: (a: number) => [number, number];
+    readonly metadata_exif: (a: number) => [number, number];
+    readonly metadata_exifByteOrder: (a: number) => [number, number];
+    readonly metadata_gamma: (a: number) => [number, number];
+    readonly metadata_iccProfile: (a: number) => [number, number];
+    readonly metadata_iccProfileName: (a: number) => [number, number];
+    readonly metadata_physicalPixelsPerUnit: (a: number) => [number, number];
+    readonly metadata_physicalUnit: (a: number) => [number, number];
+    readonly metadata_srgb: (a: number) => [number, number];
+    readonly metadata_text: (a: number) => [number, number];
+    readonly metadata_time: (a: number) => [number, number];
+    readonly parseText: (a: number, b: number, c: number, d: number) => [number, number, number];
+    readonly rawimage_header: (a: number) => number;
+    readonly rawimage_intoData: (a: number) => [number, number];
+    readonly rawimage_metadata: (a: number) => number;
+    readonly rawimage_palette: (a: number) => [number, number];
+    readonly rawimage_takeChunks: (a: number) => [number, number];
+    readonly rawimage_transparencyKind: (a: number) => [number, number];
+    readonly rawimage_transparencyValues: (a: number) => [number, number];
+    readonly readChunks: (a: number, b: number, c: number, d: number) => [number, number, number];
+    readonly readHeader: (a: number, b: number) => [number, number, number];
+    readonly text_chunkType: (a: number) => [number, number];
+    readonly text_compressed: (a: number) => number;
+    readonly text_keyword: (a: number) => [number, number];
+    readonly text_languageTag: (a: number) => [number, number];
+    readonly text_text: (a: number) => [number, number];
+    readonly text_translatedKeyword: (a: number) => [number, number];
+    readonly __wbindgen_externrefs: WebAssembly.Table;
+    readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+    readonly __wbindgen_malloc: (a: number, b: number) => number;
+    readonly __externref_table_dealloc: (a: number) => void;
+    readonly __externref_drop_slice: (a: number, b: number) => void;
+    readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+    readonly __wbindgen_start: () => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+
+/**
+ * Instantiates the given `module`, which can either be bytes or
+ * a precompiled `WebAssembly.Module`.
+ *
+ * @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+ *
+ * @returns {InitOutput}
+ */
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+ * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+ * for everything else, calls `WebAssembly.instantiate` directly.
+ *
+ * @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+ *
+ * @returns {Promise<InitOutput>}
+ */
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;