format-png 0.1.2 → 0.3.0

package/dist/wasm/format_png_wasm.d.ts

@@ -184,9 +184,18 @@ export class Encoder {
     /**
      * `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".
+     * "paeth"; `palette` is "keep" or "auto"; `strip` is "keep", "safe" or
+     * "all"; `threads` is "single" or "auto". WebAssembly has no threads, so
+     * "auto" compresses the image data in segments on this thread: the same
+     * file as `format_png::Threads::Auto` writes natively.
      */
-    constructor(compression: number, compression_strategy: string, filter: string, keep_unsafe_chunks: boolean, palette: string, strip: string);
+    constructor(compression: number, compression_strategy: string, filter: string, keep_unsafe_chunks: boolean, palette: string, strip: string, threads: string);
+    /**
+     * Everything `encode` does except compressing the image data, which is
+     * left in segments to compress anywhere, such as in other Web Workers.
+     * Always in segments, whatever `threads` says.
+     */
+    prepare(image: EncodeImage): Prepared;
 }
 
 /**
@@ -264,6 +273,44 @@ export class Metadata {
     readonly time: Uint16Array | undefined;
 }
 
+/**
+ * An image from `Encoder.prepare`, waiting for its segments to be compressed.
+ * Copy each `segment(i)` out, compress it with `compressSegment`, pass the
+ * results to `pushCompressed` in segment order, then call `finish()`. Call
+ * `free()` when done with it, finished or not.
+ */
+export class Prepared {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Joins the compressed segments into the PNG. Only once: afterwards the
+     * other methods throw.
+     */
+    finish(): Uint8Array;
+    /**
+     * Adds the next compressed segment, in segment order.
+     */
+    pushCompressed(segment: Uint8Array): void;
+    /**
+     * Segment `index`, copied out of WebAssembly memory.
+     */
+    segment(index: number): Uint8Array;
+    /**
+     * The level to pass to `compressSegment`.
+     */
+    readonly compressionLevel: number;
+    /**
+     * The strategy to pass to `compressSegment`: "dynamic", "fixed" or "stored".
+     */
+    readonly compressionStrategy: string;
+    /**
+     * 0 for images with 1 MiB of filtered data or less, which are already
+     * encoded: call `finish()` for the PNG.
+     */
+    readonly segmentCount: number;
+}
+
 /**
  * A decoded image in the file's own format, from `decode`. JavaScript reads
  * the header, palette, transparency, `metadata()` and `takeChunks()`, then
@@ -324,6 +371,12 @@ export class Text {
     readonly translatedKeyword: string;
 }
 
+/**
+ * Compresses one segment of a `Prepared`, with its `compressionLevel` and
+ * `compressionStrategy`. The same result in any WebAssembly instance.
+ */
+export function compressSegment(segment: Uint8Array, level: number, strategy: string): Uint8Array;
+
 /**
  * Decodes a PNG in its own format with a one-off decoder.
  */
@@ -335,9 +388,9 @@ export function decode(bytes: Uint8Array, validate_crc: boolean, preserve_metada
 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.
+ * Encodes an image with a one-off encoder: the image, then `Encoder`'s options.
  */
-export function encode(image: EncodeImage, compression: number, compression_strategy: string, filter: string, keep_unsafe_chunks: boolean, palette: string, strip: string): Uint8Array;
+export function encode(image: EncodeImage, compression: number, compression_strategy: string, filter: string, keep_unsafe_chunks: boolean, palette: string, strip: string, threads: string): Uint8Array;
 
 /**
  * Parses the data of a `tEXt`, `zTXt` or `iTXt` chunk on its own.
@@ -372,82 +425,88 @@ export interface InitOutput {
     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_prepared_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 chunk_chunkType: (a: number, b: number) => void;
+    readonly chunk_intoData: (a: number, b: number) => void;
+    readonly chunk_position: (a: number, b: number) => void;
+    readonly chunklist_crcs: (a: number, b: number) => void;
     readonly chunklist_header: (a: number) => number;
-    readonly chunklist_known: (a: number) => [number, number];
-    readonly chunklist_lengths: (a: number) => [number, number];
+    readonly chunklist_known: (a: number, b: number) => void;
+    readonly chunklist_lengths: (a: number, b: number) => void;
     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 chunklist_offsets: (a: number, b: number) => void;
+    readonly chunklist_palette: (a: number, b: number) => void;
+    readonly chunklist_transparencyKind: (a: number, b: number) => void;
+    readonly chunklist_transparencyValues: (a: number, b: number) => void;
+    readonly chunklist_types: (a: number, b: number) => void;
+    readonly compressSegment: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
+    readonly decode: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
+    readonly decodeRgba8: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
+    readonly decodedimage_intoPixels: (a: number, b: number) => void;
     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 decodedimage_takeChunks: (a: number, b: number) => void;
+    readonly decoder_decode: (a: number, b: number, c: number, d: number) => void;
+    readonly decoder_decodeRgba8: (a: number, b: number, c: number, d: number) => void;
     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 decoder_readChunks: (a: number, b: number, c: number, d: number) => void;
+    readonly encode: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number, l: number, m: number, n: number) => void;
+    readonly encodeimage_addChunk: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => void;
+    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, m: number) => void;
+    readonly encodeimage_new: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number) => void;
+    readonly encodeimage_setChromaticities: (a: number, b: number, c: number, d: number) => void;
     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_setExif: (a: number, b: number, c: number, d: number) => void;
+    readonly encodeimage_setGamma: (a: number, b: number, c: number) => void;
     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_setPalette: (a: number, b: number, c: number, d: number) => void;
+    readonly encodeimage_setPhysicalDimensions: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
+    readonly encodeimage_setSrgb: (a: number, b: number, c: number, d: number) => void;
     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 encodeimage_setTransparency: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
+    readonly encoder_encode: (a: number, b: number, c: number) => void;
+    readonly encoder_new: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number, l: number, m: number) => void;
+    readonly encoder_prepare: (a: number, b: number, c: number) => void;
+    readonly header_colorType: (a: number, b: number) => void;
+    readonly metadata_chromaticities: (a: number, b: number) => void;
+    readonly metadata_cicp: (a: number, b: number) => void;
+    readonly metadata_exif: (a: number, b: number) => void;
+    readonly metadata_exifByteOrder: (a: number, b: number) => void;
+    readonly metadata_gamma: (a: number, b: number) => void;
+    readonly metadata_iccProfile: (a: number, b: number) => void;
+    readonly metadata_iccProfileName: (a: number, b: number) => void;
+    readonly metadata_physicalPixelsPerUnit: (a: number, b: number) => void;
+    readonly metadata_physicalUnit: (a: number, b: number) => void;
+    readonly metadata_srgb: (a: number, b: number) => void;
+    readonly metadata_text: (a: number, b: number) => void;
+    readonly metadata_time: (a: number, b: number) => void;
+    readonly parseText: (a: number, b: number, c: number, d: number, e: number) => void;
+    readonly prepared_compressionLevel: (a: number) => number;
+    readonly prepared_compressionStrategy: (a: number, b: number) => void;
+    readonly prepared_finish: (a: number, b: number) => void;
+    readonly prepared_pushCompressed: (a: number, b: number, c: number) => void;
+    readonly prepared_segment: (a: number, b: number, c: number) => void;
+    readonly prepared_segmentCount: (a: number) => number;
     readonly rawimage_header: (a: number) => number;
-    readonly rawimage_intoData: (a: number) => [number, number];
+    readonly rawimage_intoData: (a: number, b: number) => void;
     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 rawimage_palette: (a: number, b: number) => void;
+    readonly rawimage_takeChunks: (a: number, b: number) => void;
+    readonly rawimage_transparencyKind: (a: number, b: number) => void;
+    readonly rawimage_transparencyValues: (a: number, b: number) => void;
+    readonly readChunks: (a: number, b: number, c: number, d: number, e: number) => void;
+    readonly readHeader: (a: number, b: number, c: number) => void;
+    readonly text_chunkType: (a: number, b: number) => void;
     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;
+    readonly text_keyword: (a: number, b: number) => void;
+    readonly text_languageTag: (a: number, b: number) => void;
+    readonly text_text: (a: number, b: number) => void;
+    readonly text_translatedKeyword: (a: number, b: number) => void;
+    readonly __wbindgen_add_to_stack_pointer: (a: number) => number;
+    readonly __wbindgen_export: (a: number, b: number, c: number) => void;
+    readonly __wbindgen_export2: (a: number, b: number) => number;
+    readonly __wbindgen_export3: (a: number, b: number, c: number, d: number) => number;
 }
 
 export type SyncInitInput = BufferSource | WebAssembly.Module;