imagescript 1.3.1 → 3.1.0

package/dist/codecs/png.d.ts

@@ -0,0 +1,97 @@
+export interface EncodeOptions {
+    /** tEXt chunks, empty values are skipped */
+    text?: Record<string, string | undefined>;
+    width: number;
+    height: number;
+    channels: number;
+    depth?: number;
+    level?: number;
+    /** packed RGB palette, makes the data palette indices (1 channel) */
+    palette?: Uint8Array;
+    /** alpha per palette entry */
+    transparency?: Uint8Array;
+    /** whether to paeth filter the rows (pays off for truecolor and greyscale images) */
+    filter?: boolean;
+}
+export interface Decoded {
+    width: number;
+    height: number;
+    /** 8-bit RGBA */
+    pixels: Uint8Array;
+    /** Exif orientation (1-8) */
+    orientation: number;
+}
+/**
+ * Encodes raw pixel data into a PNG
+ * @param data Raw pixel data, rows packed MSB first for depths below 8
+ */
+export declare function encode(data: Uint8Array, { text, width, height, channels, depth, level, palette, transparency, filter: filterRows }: EncodeOptions): Promise<Uint8Array>;
+/**
+ * Encodes 8-bit RGBA pixels into a PNG with the smallest lossless color type (see {@link pixelFormat}).
+ * Rows of non-palette images are paeth filtered (unless the data isn't compressed), palette indices aren't
+ * filtered (like libpng recommends)
+ */
+export declare function encodeRGBA(rgba: Uint8Array, width: number, height: number, level: number, text?: EncodeOptions['text']): Promise<Uint8Array>;
+export interface APNGEncodeFrame {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    /** milliseconds (stored as a fraction of up to 65535/65535 seconds) */
+    duration: number;
+    /** 0 none, 1 background (transparent), 2 previous */
+    dispose: number;
+    /** RGBA */
+    pixels: Uint8Array;
+}
+/**
+ * Encodes frames into an APNG. Frames are alpha blended onto the canvas ("over"); the first frame is also the
+ * default image that viewers without APNG support show
+ * @param plays How often to play the animation, 0 = forever
+ */
+export declare function encodeAnimation(frames: APNGEncodeFrame[], width: number, height: number, plays: number, level: number): Promise<Uint8Array>;
+/**
+ * Decodes a PNG into 8-bit RGBA pixel data (for APNGs, the default image)
+ * Supports all color types, bit depths, tRNS transparency and adam7 interlacing
+ * The orientation comes from the eXIf chunk, or, if there is none, from the Exif text ImageMagick wrote before eXIf
+ * existed ("Raw profile type exif") or from the XMP packet
+ */
+export declare function decode(array: Uint8Array): Promise<Decoded>;
+export interface APNGFrame {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    /** milliseconds */
+    duration: number;
+    /** 0 none, 1 background (transparent), 2 previous */
+    dispose: number;
+    /** 0 source (replace), 1 over */
+    blend: number;
+    pixels: Uint8Array;
+}
+/** Whether the PNG is an APNG (has an acTL chunk) */
+export declare function isAnimated(array: Uint8Array): boolean;
+/**
+ * Decodes an APNG (https://wiki.mozilla.org/APNG_Specification) into its (uncomposited) frames; a plain PNG becomes
+ * a single frame
+ * @return plays: 0 = forever
+ */
+export declare function decodeAnimation(array: Uint8Array, onlyFirstFrame?: boolean): Promise<{
+    width: number;
+    height: number;
+    plays: number;
+    frames: APNGFrame[];
+}>;
+/**
+ * Composites APNG frames onto the canvas, as the APNG specification describes (the integer "over" operation of its
+ * blend_op section, https://wiki.mozilla.org/APNG_Specification)
+ */
+export declare function compositeAnimation({ width, height, frames }: {
+    width: number;
+    height: number;
+    frames: APNGFrame[];
+}): Array<{
+    pixels: Uint8Array;
+    duration: number;
+}>;