zedbar 0.1.0 → 0.2.0

package/README.md

@@ -9,6 +9,7 @@ A port of the [ZBar](http://zbar.sourceforge.net/) barcode scanning library from
 - **Fast**: Native-speed scanning via WebAssembly
 - **No native dependencies**: Works on any platform Node.js supports
 - **Multiple formats**: QR Code, EAN-13, EAN-8, UPC-A, UPC-E, Code 128, Code 93, Code 39, Codabar, Interleaved 2 of 5, DataBar, SQ Code
+- **CLI tool**: Command-line `zedbarimg` binary for scanning images (similar to `zbarimg`)
 
 ## Installation
 
@@ -16,31 +17,79 @@ A port of the [ZBar](http://zbar.sourceforge.net/) barcode scanning library from
 npm install zedbar
 ```
 
-## Usage
+## Command-line Usage
+
+The package includes a `zedbarimg` command-line tool:
+
+```bash
+# Scan a single image
+zedbarimg barcode.png
+
+# Scan multiple images
+zedbarimg image1.png image2.jpg image3.webp
+
+# Quiet mode (only output barcode data)
+zedbarimg --quiet qrcode.png
+
+# Show help
+zedbarimg --help
+```
+
+After installing globally, you can use it directly:
+
+```bash
+npm install -g zedbar
+zedbarimg barcode.png
+```
+
+## Library Usage
+
+### Scan from image file bytes
 
 ```javascript
-import { scanGrayscale } from 'zedbar';
-import sharp from 'sharp';
+import { scanImageBytes } from 'zedbar';
+import { readFileSync } from 'fs';
 
-// Load image and convert to grayscale
-const { data, info } = await sharp('barcode.png')
-  .grayscale()
-  .raw()
-  .toBuffer({ resolveWithObject: true });
+// Read image file (PNG, JPEG, WebP, BMP)
+const imageBytes = readFileSync('barcode.png');
 
 // Scan for barcodes
-for (const { symbolType, text } of scanGrayscale(data, info.width, info.height)) {
+for (const { symbolType, text } of scanImageBytes(imageBytes)) {
+  console.log(`${symbolType}: ${text}`);
+}
+```
+
+### Scan from grayscale data
+
+If you already have grayscale image data:
+
+```javascript
+import { scanGrayscale } from 'zedbar';
+
+// data is Uint8Array of grayscale pixels (1 byte per pixel, row-major)
+for (const { symbolType, text } of scanGrayscale(data, width, height)) {
   console.log(`${symbolType}: ${text}`);
 }
 ```
 
 ## API
 
+### `scanImageBytes(bytes)`
+
+Scans an encoded image (PNG, JPEG, WebP, BMP) for barcodes and QR codes.
+
+**Parameters:**
+
+- `bytes` (`Uint8Array` or `Buffer`) - Raw bytes of an image file
+
+**Returns:** `DecodeResult[]` - Array of decoded barcodes
+
 ### `scanGrayscale(data, width, height)`
 
 Scans grayscale image data for barcodes and QR codes.
 
 **Parameters:**
+
 - `data` (`Uint8Array`) - Grayscale pixel data, 1 byte per pixel, row-major order
 - `width` (`number`) - Image width in pixels
 - `height` (`number`) - Image height in pixels

package/bin/zedbarimg.mjs

@@ -0,0 +1,147 @@
+#!/usr/bin/env node
+
+/**
+ * zedbarimg - Scan and decode barcodes from image files
+ *
+ * A command-line tool for scanning barcodes and QR codes from images.
+ * Powered by the zedbar Rust library compiled to WebAssembly.
+ */
+
+import { readFileSync } from "fs";
+import { dirname, join } from "path";
+import { fileURLToPath } from "url";
+import { createRequire } from "module";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+const require = createRequire(import.meta.url);
+
+// Import the CommonJS WASM module
+const zedbar = require("../zedbar.js");
+
+// Parse command-line arguments
+function parseArgs() {
+  const args = process.argv.slice(2);
+  const options = {
+    quiet: false,
+    raw: false,
+    files: [],
+  };
+
+  for (let i = 0; i < args.length; i++) {
+    const arg = args[i];
+
+    if (arg === "-q" || arg === "--quiet") {
+      options.quiet = true;
+    } else if (arg === "--raw") {
+      options.raw = true;
+    } else if (arg === "-h" || arg === "--help") {
+      showHelp();
+      process.exit(0);
+    } else if (arg === "-v" || arg === "--version") {
+      const pkgPath = join(__dirname, "..", "package.json");
+      const pkg = JSON.parse(readFileSync(pkgPath, "utf8"));
+      console.log(`zedbarimg ${pkg.version}`);
+      process.exit(0);
+    } else if (!arg.startsWith("-")) {
+      options.files.push(arg);
+    } else {
+      console.error(`Unknown option: ${arg}`);
+      showHelp();
+      process.exit(1);
+    }
+  }
+
+  if (options.files.length === 0) {
+    console.error("Error: No image files specified\n");
+    showHelp();
+    process.exit(1);
+  }
+
+  return options;
+}
+
+function showHelp() {
+  console.log(`
+Usage: zedbarimg [OPTIONS] <IMAGE_FILES...>
+
+Scan and decode barcodes from one or more image files
+
+Options:
+  -q, --quiet      Minimal output, only print decoded symbol data
+  --raw            Output decoded symbol data without converting charsets
+  -h, --help       Print help information
+  -v, --version    Print version information
+
+Supported formats:
+  - Images: PNG, JPEG, BMP, WebP
+  - Barcodes: QR Code, EAN-13, EAN-8, UPC-A, UPC-E, Code 128, Code 93,
+              Code 39, Codabar, Interleaved 2/5, DataBar, SQ Code
+
+Examples:
+  zedbarimg barcode.png
+  zedbarimg --quiet qrcode.jpg
+  zedbarimg image1.png image2.jpg image3.gif
+`);
+}
+
+function main() {
+  const options = parseArgs();
+  let totalSymbols = 0;
+
+  for (const filename of options.files) {
+    // Read the image file as raw bytes
+    let imageBytes;
+    try {
+      imageBytes = readFileSync(filename);
+    } catch (err) {
+      if (!options.quiet) {
+        console.error(`Failed to read file '${filename}': ${err.message}`);
+      }
+      process.exit(1);
+    }
+
+    // Scan the image using the WASM library
+    let results;
+    try {
+      results = zedbar.scanImageBytes(imageBytes);
+    } catch (err) {
+      if (!options.quiet) {
+        console.error(`Failed to scan image '${filename}': ${err.message}`);
+      }
+      process.exit(1);
+    }
+
+    totalSymbols += results.length;
+
+    // Print results
+    for (const symbol of results) {
+      if (options.raw) {
+        // Raw mode: just output the data bytes with newline
+        process.stdout.write(Buffer.from(symbol.data));
+        process.stdout.write("\n");
+      } else {
+        // Normal mode: include symbol type
+        const text = symbol.text || Buffer.from(symbol.data).toString("utf8");
+        console.log(`${symbol.symbolType}:${text}`);
+      }
+    }
+  }
+
+  // Print statistics unless quiet mode
+  if (!options.quiet) {
+    if (totalSymbols === 0) {
+      console.error("No barcodes found");
+      process.exit(1);
+    } else {
+      console.error(
+        `scanned ${totalSymbols} barcode symbol${totalSymbols === 1 ? "" : "s"} from ${options.files.length} image${options.files.length === 1 ? "" : "s"}`,
+      );
+    }
+  } else if (totalSymbols === 0) {
+    // In quiet mode, still exit with error if no barcodes found
+    process.exit(1);
+  }
+}
+
+main();

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "zedbar",
   "description": "Fast QR code and barcode scanner for Node.js, powered by WebAssembly",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "license": "LGPL-3.0-or-later",
   "repository": {
     "type": "git",
@@ -33,5 +33,8 @@
   },
   "engines": {
     "node": ">=16.0.0"
+  },
+  "bin": {
+    "zedbarimg": "./bin/zedbarimg.mjs"
   }
 }

package/zedbar.d.ts

@@ -1,5 +1,17 @@
 /* tslint:disable */
 /* eslint-disable */
+/**
+ * Scan an encoded image (PNG, JPEG, BMP, WebP) for barcodes and QR codes.
+ *
+ * `bytes` should contain the raw bytes of an image file in one of the
+ * supported formats: PNG, JPEG, BMP, or WebP.
+ *
+ * The image will be automatically decoded and converted to grayscale
+ * before scanning.
+ *
+ * Returns an array of `DecodeResult` objects.
+ */
+export function scanImageBytes(bytes: Uint8Array): DecodeResult[];
 /**
  * Scan grayscale image data for barcodes and QR codes.
  *

package/zedbar.js

@@ -63,6 +63,31 @@ function getArrayJsValueFromWasm0(ptr, len) {
     wasm.__externref_drop_slice(ptr, len);
     return result;
 }
+/**
+ * Scan an encoded image (PNG, JPEG, BMP, WebP) for barcodes and QR codes.
+ *
+ * `bytes` should contain the raw bytes of an image file in one of the
+ * supported formats: PNG, JPEG, BMP, or WebP.
+ *
+ * The image will be automatically decoded and converted to grayscale
+ * before scanning.
+ *
+ * Returns an array of `DecodeResult` objects.
+ * @param {Uint8Array} bytes
+ * @returns {DecodeResult[]}
+ */
+exports.scanImageBytes = function(bytes) {
+    const ptr0 = passArray8ToWasm0(bytes, wasm.__wbindgen_malloc);
+    const len0 = WASM_VECTOR_LEN;
+    const ret = wasm.scanImageBytes(ptr0, len0);
+    if (ret[3]) {
+        throw takeFromExternrefTable0(ret[2]);
+    }
+    var v2 = getArrayJsValueFromWasm0(ret[0], ret[1]).slice();
+    wasm.__wbindgen_free(ret[0], ret[1] * 4, 4);
+    return v2;
+};
+
 /**
  * Scan grayscale image data for barcodes and QR codes.
  *