@thi.ng/pixel-io-netpbm 2.1.89 → 2.1.91

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2023-12-09T19:12:03Z
+- **Last updated**: 2023-12-11T10:07:09Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/pixel-io-netpbm",
-  "version": "2.1.89",
+  "version": "2.1.91",
   "description": "Multi-format NetPBM reader & writer support for @thi.ng/pixel",
   "type": "module",
   "module": "./index.js",
@@ -24,7 +24,9 @@
   "author": "Karsten Schmidt (https://thi.ng)",
   "license": "Apache-2.0",
   "scripts": {
-    "build": "yarn clean && tsc --declaration",
+    "build": "yarn build:esbuild && yarn build:decl",
+    "build:decl": "tsc --declaration --emitDeclarationOnly",
+    "build:esbuild": "esbuild --format=esm --platform=neutral --target=es2022 --tsconfig=tsconfig.json --outdir=. src/**/*.ts",
     "clean": "rimraf --glob '*.js' '*.d.ts' '*.map' doc",
     "doc": "typedoc --excludePrivate --excludeInternal --out doc src/index.ts",
     "doc:ae": "mkdir -p .ae/doc .ae/temp && api-extractor run --local --verbose",
@@ -33,12 +35,13 @@
     "test": "bun test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.9.11",
-    "@thi.ng/errors": "^2.4.5",
-    "@thi.ng/pixel": "^5.0.3"
+    "@thi.ng/api": "^8.9.12",
+    "@thi.ng/errors": "^2.4.6",
+    "@thi.ng/pixel": "^5.0.5"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.38.3",
+    "esbuild": "^0.19.8",
     "rimraf": "^5.0.5",
     "tools": "^0.0.1",
     "typedoc": "^0.25.4",
@@ -84,5 +87,5 @@
     "parent": "@thi.ng/pixel",
     "year": 2021
   },
-  "gitHead": "25f2ac8ff795a432a930119661b364d4d93b59a0\n"
+  "gitHead": "22e36fa838e5431d40165384918b395603bbd92f\n"
 }

package/read.js

@@ -4,207 +4,125 @@ import { GRAY16 } from "@thi.ng/pixel/format/gray16";
 import { GRAY8 } from "@thi.ng/pixel/format/gray8";
 import { RGB888 } from "@thi.ng/pixel/format/rgb888";
 import { intBuffer } from "@thi.ng/pixel/int";
-const isLinebreak = (c) => c === 0xa;
-const isWS = (c) => c === 0x20 || (c >= 9 && c <= 13);
+const isLinebreak = (c) => c === 10;
+const isWS = (c) => c === 32 || c >= 9 && c <= 13;
 const readUntil = (src, i, end = isLinebreak) => {
-    let res = "";
-    for (; i < src.length; i++) {
-        let c = src[i];
-        if (end(c)) {
-            i++;
-            break;
-        }
-        res += String.fromCharCode(c);
+  let res = "";
+  for (; i < src.length; i++) {
+    let c = src[i];
+    if (end(c)) {
+      i++;
+      break;
     }
-    return [res, i];
+    res += String.fromCharCode(c);
+  }
+  return [res, i];
 };
 const readComments = (src, acc, i) => {
-    while (src[i] === 0x23) {
-        // @ts-ignore
-        const [comment, j] = readUntil(src, i);
-        assert(j !== i, `EOF reached`);
-        acc.push(comment.substring(1).trim());
-        i = j;
-    }
-    return i;
+  while (src[i] === 35) {
+    const [comment, j] = readUntil(src, i);
+    assert(j !== i, `EOF reached`);
+    acc.push(comment.substring(1).trim());
+    i = j;
+  }
+  return i;
 };
-/**
- * Parses header information from given NetPBM file byte buffer.
- *
- * @param src -
- */
-export const parseHeader = (src) => {
-    let type;
-    let sw, sh;
-    let norm;
-    let max;
-    const comments = [];
-    let i = readComments(src, comments, 0);
-    [type, i] = readUntil(src, i);
-    i = readComments(src, comments, i);
-    [sw, i] = readUntil(src, i, isWS);
-    [sh, i] = readUntil(src, i, isWS);
-    const width = parseInt(sw);
-    const height = parseInt(sh);
-    assert(width > 0 && height > 0, `invalid NetPBM header`);
-    if (type === "P5" || type === "P6") {
-        [norm, i] = readUntil(src, i);
-        max = parseInt(norm);
-    }
-    return {
-        type,
-        width,
-        height,
-        max,
-        start: i,
-        comments,
-    };
+const parseHeader = (src) => {
+  let type;
+  let sw, sh;
+  let norm;
+  let max;
+  const comments = [];
+  let i = readComments(src, comments, 0);
+  [type, i] = readUntil(src, i);
+  i = readComments(src, comments, i);
+  [sw, i] = readUntil(src, i, isWS);
+  [sh, i] = readUntil(src, i, isWS);
+  const width = parseInt(sw);
+  const height = parseInt(sh);
+  assert(width > 0 && height > 0, `invalid NetPBM header`);
+  if (type === "P5" || type === "P6") {
+    [norm, i] = readUntil(src, i);
+    max = parseInt(norm);
+  }
+  return {
+    type,
+    width,
+    height,
+    max,
+    start: i,
+    comments
+  };
 };
-/**
- * Takes a PBM/PGM/PPM file as byte array and parses it into a
- * [`IntBuffer`](https://docs.thi.ng/umbrella/pixel/classes/IntBuffer.html) of
- * corresponding format.
- *
- * @remarks
- * Depending on header information, the following rules apply:
- *
- * - only binary NetPBM formats are supported (P4,P5,P6 types)
- * - 1bit PBM (P4) => {@link readPBM}
- * - grayscale PGM (P5) => {@link readPGM8} or {@link readPGM16}
- * - 24bit RGB (P6) => {@link readPPM}
- *
- * Function will throw an error if image is of any other type or header is
- * corrupt otherwise. Any embedded comments will be discarded.
- *
- * @param src -
- */
-export const read = (src) => {
-    const { type, width, height, max, start } = parseHeader(src);
-    switch (type) {
-        case "P4":
-            return readPBM(src, start, width, height);
-        case "P5":
-            return max < 0x100
-                ? readPGM8(src, start, width, height, max)
-                : readPGM16(src, start, width, height, max);
-        case "P6":
-            return readPPM(src, start, width, height, max);
-        default:
-            unsupported(`PBM type: ${type}`);
-    }
+const read = (src) => {
+  const { type, width, height, max, start } = parseHeader(src);
+  switch (type) {
+    case "P4":
+      return readPBM(src, start, width, height);
+    case "P5":
+      return max < 256 ? readPGM8(src, start, width, height, max) : readPGM16(src, start, width, height, max);
+    case "P6":
+      return readPPM(src, start, width, height, max);
+    default:
+      unsupported(`PBM type: ${type}`);
+  }
 };
-/**
- * Reads pixels from given 1bit PBM file byte buffer, starting at index `i` and
- * returns
- * [`IntBuffer`](https://docs.thi.ng/umbrella/pixel/classes/IntBuffer.html) in
- * `GRAY8` format (due to current lack of true 1bit format).
- *
- * @param src -
- * @param i -
- * @param width -
- * @param height -
- */
-export const readPBM = (src, i, width, height) => {
-    const buf = intBuffer(width, height, GRAY8);
-    const data = buf.data;
-    const w1 = width - 1;
-    for (let y = 0, j = 0; y < height; y++) {
-        for (let x = 0; x < width; x++, j++) {
-            data[j] = src[i] & (1 << (~x & 7)) ? 0 : 0xff;
-            if ((x & 7) === 7 || x === w1)
-                i++;
-        }
+const readPBM = (src, i, width, height) => {
+  const buf = intBuffer(width, height, GRAY8);
+  const data = buf.data;
+  const w1 = width - 1;
+  for (let y = 0, j = 0; y < height; y++) {
+    for (let x = 0; x < width; x++, j++) {
+      data[j] = src[i] & 1 << (~x & 7) ? 0 : 255;
+      if ((x & 7) === 7 || x === w1)
+        i++;
     }
-    return buf;
+  }
+  return buf;
 };
-/**
- * Reads pixels from given 8bit PGM file byte buffer, starting at index `i` and
- * returns
- * [`IntBuffer`](https://docs.thi.ng/umbrella/pixel/classes/IntBuffer.html) in
- * `GRAY8` format. If needed, pixel values are rescaled given `max` value
- * defined in PGM header (MUST be <= 0xff).
- *
- * @remarks
- * Reference: http://netpbm.sourceforge.net/doc/pbm.html
- *
- * @param src -
- * @param i -
- * @param width -
- * @param height -
- * @param max -
- */
-export const readPGM8 = (src, i, width, height, max = 0xff) => {
-    const buf = intBuffer(width, height, GRAY8);
-    const data = buf.data;
-    if (max === 0xff) {
-        data.set(src.subarray(i));
+const readPGM8 = (src, i, width, height, max = 255) => {
+  const buf = intBuffer(width, height, GRAY8);
+  const data = buf.data;
+  if (max === 255) {
+    data.set(src.subarray(i));
+  } else {
+    max = 255 / max;
+    for (let j = 0, n = data.length; j < n; i++, j++) {
+      data[j] = src[i] * max | 0;
     }
-    else {
-        max = 0xff / max;
-        for (let j = 0, n = data.length; j < n; i++, j++) {
-            data[j] = (src[i] * max) | 0;
-        }
-    }
-    return buf;
+  }
+  return buf;
 };
-/**
- * Reads pixels from given 16bit PGM file byte buffer, starting at index `i` and
- * returns
- * [`IntBuffer`](https://docs.thi.ng/umbrella/pixel/classes/IntBuffer.html) in
- * `GRAY16` format. Pixel values are rescaled given `max` value defined in PGM
- * header (MUST be <= 0xffff).
- *
- * @remarks
- * Reference: http://netpbm.sourceforge.net/doc/pgm.html
- *
- * @param src -
- * @param i -
- * @param width -
- * @param height -
- * @param max -
- */
-export const readPGM16 = (src, i, width, height, max = 0xffff) => {
-    const buf = intBuffer(width, height, GRAY16);
-    const data = buf.data;
-    max = 0xffff / max;
-    for (let j = 0, n = data.length; j < n; i += 2, j++) {
-        data[j] = (((src[i] << 8) | src[i + 1]) * max) | 0;
-    }
-    return buf;
+const readPGM16 = (src, i, width, height, max = 65535) => {
+  const buf = intBuffer(width, height, GRAY16);
+  const data = buf.data;
+  max = 65535 / max;
+  for (let j = 0, n = data.length; j < n; i += 2, j++) {
+    data[j] = (src[i] << 8 | src[i + 1]) * max | 0;
+  }
+  return buf;
 };
-/**
- * Reads pixels from given 24bit PPM file byte buffer, starting at index `i` and
- * returns
- * [`IntBuffer`](https://docs.thi.ng/umbrella/pixel/classes/IntBuffer.html) in
- * `RGB888` format. Color channel values are rescaled given `max` value defined
- * in PGM header (MUST be <= 0xff).
- *
- * @remarks
- * Reference: http://netpbm.sourceforge.net/doc/pgm.html
- *
- * @param src -
- * @param i -
- * @param width -
- * @param height -
- * @param max -
- */
-export const readPPM = (src, i, width, height, max = 0xff) => {
-    const buf = intBuffer(width, height, RGB888);
-    const data = buf.data;
-    assert(max <= 0xff, `unsupported max value: ${max}`);
-    if (max === 0xff) {
-        for (let j = 0, n = data.length; j < n; i += 3, j++) {
-            data[j] = (src[i] << 16) | (src[i + 1] << 8) | src[i + 2];
-        }
+const readPPM = (src, i, width, height, max = 255) => {
+  const buf = intBuffer(width, height, RGB888);
+  const data = buf.data;
+  assert(max <= 255, `unsupported max value: ${max}`);
+  if (max === 255) {
+    for (let j = 0, n = data.length; j < n; i += 3, j++) {
+      data[j] = src[i] << 16 | src[i + 1] << 8 | src[i + 2];
     }
-    else {
-        max = 0xff / max;
-        for (let j = 0, n = data.length; j < n; i += 3, j++) {
-            data[j] =
-                ((src[i] * max) << 16) |
-                    ((src[i + 1] * max) << 8) |
-                    (src[i + 2] * max);
-        }
+  } else {
+    max = 255 / max;
+    for (let j = 0, n = data.length; j < n; i += 3, j++) {
+      data[j] = src[i] * max << 16 | src[i + 1] * max << 8 | src[i + 2] * max;
     }
-    return buf;
+  }
+  return buf;
+};
+export {
+  parseHeader,
+  read,
+  readPBM,
+  readPGM16,
+  readPGM8,
+  readPPM
 };

package/write.js

@@ -1,114 +1,95 @@
 import { GRAY16 } from "@thi.ng/pixel/format/gray16";
 const formatComments = (comments = ["generated by @thi.ng/pixel-io-netpbm"]) => comments.map((x) => `# ${x}`).join("\n");
-/**
- * Initializes byte array & PBM header for given {@link IntBuffer} and format
- * details.
- *
- * @param magic -
- * @param limits -
- * @param size -
- * @param buf -
- *
- * @internal
- */
 const initHeader = (magic, limits, size, buf, comments) => {
-    const { width, height } = buf;
-    let header = magic + "\n";
-    const comm = formatComments(comments);
-    if (comm.length)
-        header += comm + "\n";
-    header += `${width} ${height}\n`;
-    if (limits > 0)
-        header += limits + "\n";
-    const dest = new Uint8Array(size + header.length);
-    dest.set([...header].map((x) => x.charCodeAt(0)));
-    return { dest, start: header.length, abgr: buf.format.toABGR };
+  const { width, height } = buf;
+  let header = magic + "\n";
+  const comm = formatComments(comments);
+  if (comm.length)
+    header += comm + "\n";
+  header += `${width} ${height}
+`;
+  if (limits > 0)
+    header += limits + "\n";
+  const dest = new Uint8Array(size + header.length);
+  dest.set([...header].map((x) => x.charCodeAt(0)));
+  return { dest, start: header.length, abgr: buf.format.toABGR };
 };
-/**
- * Converts a {@link IntBuffer} into a 1bit PBM byte array (binary format).
- *
- * @remarks
- * Reference: http://netpbm.sourceforge.net/doc/pbm.html
- *
- * @param buf -
- * @param comments -
- */
-export const asPBM = (buf, comments) => {
-    const { data, width, height } = buf;
-    const { dest, start, abgr } = initHeader("P4", 0, Math.ceil(width / 8) * height, buf, comments);
-    const w1 = width - 1;
-    for (let y = 0, i = start, j = 0; y < height; y++) {
-        for (let x = 0, b = 0; x <= w1; x++, j++) {
-            const xx = ~x & 7;
-            if (luminance(abgr(data[j])) < 128) {
-                b |= 1 << xx;
-            }
-            if (xx === 0 || x === w1) {
-                dest[i++] = b;
-                b = 0;
-            }
-        }
+const asPBM = (buf, comments) => {
+  const { data, width, height } = buf;
+  const { dest, start, abgr } = initHeader(
+    "P4",
+    0,
+    Math.ceil(width / 8) * height,
+    buf,
+    comments
+  );
+  const w1 = width - 1;
+  for (let y = 0, i = start, j = 0; y < height; y++) {
+    for (let x = 0, b = 0; x <= w1; x++, j++) {
+      const xx = ~x & 7;
+      if (luminance(abgr(data[j])) < 128) {
+        b |= 1 << xx;
+      }
+      if (xx === 0 || x === w1) {
+        dest[i++] = b;
+        b = 0;
+      }
     }
-    return dest;
+  }
+  return dest;
 };
-/**
- * Converts a {@link IntBuffer} into a 8bit grayscale PGM byte array (binary
- * format).
- *
- * @remarks
- * Reference: http://netpbm.sourceforge.net/doc/pgm.html
- *
- * @param buf -
- * @param comments -
- */
-export const asPGM = (buf, comments) => {
-    const { data, width, height } = buf;
-    const { dest, start, abgr } = initHeader("P5", 0xff, width * height, buf, comments);
-    for (let i = start, j = 0; j < data.length; i++, j++) {
-        dest[i] = luminance(abgr(data[j]));
-    }
-    return dest;
+const asPGM = (buf, comments) => {
+  const { data, width, height } = buf;
+  const { dest, start, abgr } = initHeader(
+    "P5",
+    255,
+    width * height,
+    buf,
+    comments
+  );
+  for (let i = start, j = 0; j < data.length; i++, j++) {
+    dest[i] = luminance(abgr(data[j]));
+  }
+  return dest;
 };
-/**
- * Converts a {@link IntBuffer} into a 16bit grayscale PGM byte array (binary
- * format).
- *
- * @remarks
- * Reference: http://netpbm.sourceforge.net/doc/pgm.html
- *
- * @param buf -
- * @param comments -
- */
-export const asPGM16 = (buf, comments) => {
-    if (buf.format !== GRAY16)
-        buf = buf.as(GRAY16);
-    const { data, width, height } = buf;
-    const { dest, start } = initHeader("P5", 0xffff, width * height * 2, buf, comments);
-    for (let i = start, j = 0; j < data.length; i += 2, j++) {
-        dest[i] = data[j] >> 8;
-        dest[i + 1] = data[j] & 0xff;
-    }
-    return dest;
+const asPGM16 = (buf, comments) => {
+  if (buf.format !== GRAY16)
+    buf = buf.as(GRAY16);
+  const { data, width, height } = buf;
+  const { dest, start } = initHeader(
+    "P5",
+    65535,
+    width * height * 2,
+    buf,
+    comments
+  );
+  for (let i = start, j = 0; j < data.length; i += 2, j++) {
+    dest[i] = data[j] >> 8;
+    dest[i + 1] = data[j] & 255;
+  }
+  return dest;
 };
-/**
- * Converts a {@link IntBuffer} into a 24bit PPM byte array (binary format).
- *
- * @remarks
- * Reference: http://netpbm.sourceforge.net/doc/ppm.html
- *
- * @param buf -
- * @param comments -
- */
-export const asPPM = (buf, comments) => {
-    const { data, width, height } = buf;
-    const { dest, start, abgr } = initHeader("P6", 255, width * 3 * height, buf, comments);
-    for (let i = start, j = 0; j < data.length; i += 3, j++) {
-        const col = abgr(data[j]);
-        dest[i] = col & 0xff;
-        dest[i + 1] = (col >> 8) & 0xff;
-        dest[i + 2] = (col >> 16) & 0xff;
-    }
-    return dest;
+const asPPM = (buf, comments) => {
+  const { data, width, height } = buf;
+  const { dest, start, abgr } = initHeader(
+    "P6",
+    255,
+    width * 3 * height,
+    buf,
+    comments
+  );
+  for (let i = start, j = 0; j < data.length; i += 3, j++) {
+    const col = abgr(data[j]);
+    dest[i] = col & 255;
+    dest[i + 1] = col >> 8 & 255;
+    dest[i + 2] = col >> 16 & 255;
+  }
+  return dest;
+};
+const luminance = (c) => ((c >>> 16 & 255) * 29 + (c >>> 8 & 255) * 150 + (c & 255) * 76) / 255;
+export {
+  asPBM,
+  asPGM,
+  asPGM16,
+  asPPM
 };
-const luminance = (c) => (((c >>> 16) & 0xff) * 29 + ((c >>> 8) & 0xff) * 150 + (c & 0xff) * 76) /
-    255;