barcode-detector 1.0.3 → 2.0.0

package/src/BarcodeDetectorZXing.ts

@@ -1,114 +0,0 @@
-// spec: https://wicg.github.io/shape-detection-api/#barcode-detection-api  
-
-import { BarcodeDetectorOptions, BarcodeFormat, DetectedBarcode } from "./basic-types"
-import { imageDataFrom } from "./image-data"
-import * as ZXing from "@zxing/library"
-
-const mapFormat = new Map<BarcodeFormat, ZXing.BarcodeFormat>([
-
-  [ "aztec", ZXing.BarcodeFormat.AZTEC ],
-  // [ "codabar", ZXing.BarcodeFormat.CODABAR ],
-  [ "code_39", ZXing.BarcodeFormat.CODE_39 ],
-  // [ "code_93", ZXing.BarcodeFormat.CODE_93 ],
-  [ "code_128", ZXing.BarcodeFormat.CODE_128 ],
-  [ "data_matrix", ZXing.BarcodeFormat.DATA_MATRIX ],
-  [ "ean_8", ZXing.BarcodeFormat.EAN_8 ],
-  [ "ean_13", ZXing.BarcodeFormat.EAN_13 ],
-  [ "itf", ZXing.BarcodeFormat.ITF ],
-  [ "pdf417", ZXing.BarcodeFormat.PDF_417 ],
-  [ "qr_code", ZXing.BarcodeFormat.QR_CODE ],
-  [ "upc_a", ZXing.BarcodeFormat.UPC_A ],
-  [ "upc_e", ZXing.BarcodeFormat.UPC_E ]
-
-]) 
-
-const mapFormatInv = new Map<ZXing.BarcodeFormat, BarcodeFormat>(
-  Array.from(mapFormat).map(([key, val]) => [val, key])
-)
-
-const allSupportedFormats : BarcodeFormat[] = Array.from(mapFormat.keys())
-
-const mapResult = (result : ZXing.Result) : DetectedBarcode => {
-  const format = mapFormatInv.get(result.getBarcodeFormat())
-  const rawValue = result.getText()
-
-  const cornerPoints = Object.freeze(
-    result
-      .getResultPoints()
-      .map(point => ({ x: point.getX(), y: point.getY() }))
-  )
-
-  const x_min = Math.min(...cornerPoints.map(point => point.x))
-  const x_max = Math.max(...cornerPoints.map(point => point.x))
-  const y_min = Math.min(...cornerPoints.map(point => point.y))
-  const y_max = Math.max(...cornerPoints.map(point => point.y))
-
-  const boundingBox = DOMRectReadOnly.fromRect({
-    x: x_min,
-    y: y_min,
-    width: x_max - x_min,
-    height: y_max - y_min
-  }) 
-
-  return { format, rawValue, cornerPoints, boundingBox }
-}
-
-export default class BarcodeDetector {
-
-  reader : ZXing.MultiFormatReader
-
-  constructor (barcodeDetectorOptions? : BarcodeDetectorOptions) {
-    // SPEC: A series of BarcodeFormats to search for in the subsequent detect() calls. If not present then the UA SHOULD 
-    // search for all supported formats.
-    const formats = barcodeDetectorOptions?.formats ?? allSupportedFormats
-
-    // SPEC: If barcodeDetectorOptions.formats is present and empty, then throw a new TypeError.
-    if (formats.length === 0) {
-      throw new TypeError("") // TODO pick message
-    }
-
-    // SPEC: If barcodeDetectorOptions.formats is present and contains unknown, then throw a new TypeError.
-    if (formats.includes("unknown")) {
-      throw new TypeError("") // TODO pick message
-    }
-
-    const hints = new Map([
-      [ ZXing.DecodeHintType.POSSIBLE_FORMATS, formats.map(format => mapFormat.get(format)) ]
-    ])
-
-    this.reader = new ZXing.MultiFormatReader()
-    this.reader.setHints(hints)
-  }
-
-  static async getSupportedFormats() : Promise<BarcodeFormat[]> {
-    return allSupportedFormats
-  }
-
-  // INVESTIGATE: 
-  // * native api on Mac Chrome gives "Source not supported" for Blob
-  // * only two corner points for code_39
-  async detect(image : ImageBitmapSource) : Promise<DetectedBarcode[]> {
-    // TODO: [SPEC]
-    // Note that if the ImageBitmapSource is an object with either a horizontal dimension or a vertical dimension equal
-    // to zero, then the Promise will be simply resolved with an empty sequence of detected objects.
-
-    const imageData = await imageDataFrom(image)
-    const canvas = document.createElement("canvas");
-    const canvasCtx = canvas.getContext("2d");
-    canvas.width = imageData.width;
-    canvas.height = imageData.height;
-    canvasCtx.putImageData(imageData, 0, 0);
-
-    try {
-      const luminanceSource = new ZXing.HTMLCanvasElementLuminanceSource(canvas);
-      const binaryBitmap = new ZXing.BinaryBitmap(new ZXing.HybridBinarizer(luminanceSource));
-      const result = this.reader.decode(binaryBitmap);
-
-      return [ mapResult(result) ] 
-    } catch (error) {
-      console.error(error);
-      
-      return []
-    }
-  }
-}

package/src/SleepyWorker.ts

@@ -1,30 +0,0 @@
-
-export default class SleepyWorker extends EventTarget {
-  worker? : Worker;
-  timeout? : number;
-  stringUrl : string | URL;
-
-  constructor(stringUrl: string | URL) {
-    super()
-    this.stringUrl = stringUrl
-  }
-
-  postMessage(message : any, transfer? : Transferable[]) {
-    if (this.worker === undefined) {
-      this.worker = new Worker(this.stringUrl)
-      this.worker.onmessage = (event : MessageEvent) => {
-        this.dispatchEvent(new MessageEvent("message", { data: event.data }))
-      }
-    } else {
-      self.clearTimeout(this.timeout)
-    }
-
-    this.worker.postMessage(message, transfer)
-
-    this.timeout = self.setTimeout(() => {
-      this.worker.terminate()
-      this.worker = undefined
-    }, 2500)
-  }
-
-}

package/src/basic-types.ts

@@ -1,33 +0,0 @@
-// spec: https://wicg.github.io/shape-detection-api/#barcode-detection-api  
-
-export type BarcodeFormat
-  = "aztec"
-  | "code_128"
-  | "code_39"
-  | "code_93"
-  | "codabar"
-  | "data_matrix"
-  | "ean_13"
-  | "ean_8"
-  | "itf"
-  | "pdf417"
-  | "qr_code"
-  | "upc_a"
-  | "upc_e"
-  | "unknown"
-
-export interface BarcodeDetectorOptions {
-  formats? : Array<BarcodeFormat>
-};
-
-export interface Point2D {
-  x : Number, 
-  y : Number
-};
-
-export interface DetectedBarcode {
-  boundingBox : DOMRectReadOnly,
-  rawValue : String,
-  format : BarcodeFormat,
-  cornerPoints : ReadonlyArray<Point2D>
-};

package/src/image-data.ts

@@ -1,130 +0,0 @@
-
-function imageDataFromCanvas(image : CanvasImageSource, width : number, height : number) : ImageData {
-  const canvas = document.createElement("canvas");
-  const canvasCtx = canvas.getContext("2d");
-
-  canvas.width = width;
-  canvas.height = height;
-
-  canvasCtx.drawImage(image, 0, 0, width, height);
-
-  return canvasCtx.getImageData(0, 0, width, height);
-}
-
-async function imageDataFromBlob(blob : Blob) : Promise<ImageData> {
-  // turn blob into an img element and pass back to imageDataFrom
-  const url = URL.createObjectURL(blob)
-
-  const image = new Image()
-  image.src = url
-
-  await new Promise((resolve, reject) => {
-    image.onload = resolve
-    image.onerror = reject
-  })
-
-  URL.revokeObjectURL(url)
-
-  return imageDataFrom(image)
-}
-
-export async function imageDataFrom(image : ImageBitmapSource) : Promise<ImageData> {
-  // spec quoted from:
-  // https://wicg.github.io/shape-detection-api/#image-sources-for-detection
-
-  // [TODO]
-  // If any ImageBitmapSource have an effective script origin (origin) which is 
-  // not the same as the Document’s effective script origin, then reject the 
-  // Promise with a new DOMException whose name is SecurityError.
-
-  if (image instanceof HTMLImageElement) {
-
-    // [TODO]
-    // When an ImageBitmapSource object represents an HTMLImageElement, the 
-    // element’s image must be used as the source image. Specifically, when an 
-    // ImageBitmapSource object represents an animated image in an 
-    // HTMLImageElement, the user agent must use the default image of the 
-    // animation (the one that the format defines is to be used when animation 
-    // is not supported or is disabled), or, if there is no such image, the 
-    // first frame of the animation.
-
-    // [SPEC]
-    // If the ImageBitmapSource is an HTMLImageElement object that is in the 
-    // Broken (HTML Standard §img-error) state, then reject the Promise with a 
-    // new DOMException whose name is InvalidStateError, and abort any further 
-    // steps.
-    // [SPEC]
-    // If the ImageBitmapSource is an HTMLImageElement object that is not fully 
-    // decodable then reject the Promise with a new DOMException whose name is 
-    // InvalidStateError, and abort any further steps
-    try {
-      image.decode()
-    } catch (_) {
-      throw new DOMException("HTMLImageElement is not decodable", "InvalidStateError")
-    }
-
-    return imageDataFromCanvas(image, image.naturalWidth, image.naturalHeight)
-
-  } else if (image instanceof SVGImageElement) {
-
-    // TODO width/height is a little bit arbitrary
-    return imageDataFromCanvas(image, 640, 480)
-
-  } else if (image instanceof HTMLVideoElement) {
-
-    // [SPEC]
-    // If the ImageBitmapSource is an HTMLVideoElement object whose readyState 
-    // attribute is either HAVE_NOTHING or HAVE_METADATA then reject the Promise 
-    // with a new DOMException whose name is InvalidStateError, and abort any 
-    // further steps.
-    const HAVE_NOTHING = 0, HAVE_METADATA = 1;
-    if (image.readyState === HAVE_NOTHING || image.readyState === HAVE_METADATA) {
-      throw new DOMException("", "InvalidStateError")
-    }
-
-    // [SPEC]
-    // When an ImageBitmapSource object represents an HTMLVideoElement, then 
-    // the frame at the current playback position when the method with the 
-    // argument is invoked must be used as the source image when processing the 
-    // image, and the source image’s dimensions must be the intrinsic dimensions 
-    // of the media resource (i.e. after any aspect-ratio correction has been applied).
-    return imageDataFromCanvas(image, image.videoWidth, image.videoHeight)
-
-  } else if (image instanceof HTMLCanvasElement) {
-
-    // [TODO]
-    // When an ImageBitmapSource object represents an HTMLCanvasElement, the 
-    // element’s bitmap must be used as the source image.
-    
-    // [TODO]
-    // If the ImageBitmapSource argument is an HTMLCanvasElement whose bitmap’s 
-    // origin-clean (HTML Standard §concept-canvas-origin-clean) flag is false, 
-    // then reject the Promise with a new DOMException whose name is 
-    // SecurityError, and abort any further steps.
-
-    const canvasCtx = image.getContext("2d")
-    return canvasCtx.getImageData(0, 0, image.width, image.height)
-
-  } else if ('ImageBitmap' in window && image instanceof ImageBitmap) {
-
-    return imageDataFromCanvas(image, image.width, image.height)
-
-  // Can't perform instanceof check when OffscreenCanvas not supported. Thus
-  // need to feature detect first.
-  } else if ('OffscreenCanvas' in window && image instanceof OffscreenCanvas) {
-
-    const canvasCtx = image.getContext("2d")
-    return canvasCtx.getImageData(0, 0, image.width, image.height)
-
-  } else if (image instanceof Blob) {
-
-    return imageDataFromBlob(image)
-
-  } else if (image instanceof ImageData) {
-
-    return image
-
-  } else {
-    // TODO TypeError?
-  }
-}

package/src/worker/build.sh

@@ -1,27 +0,0 @@
-#!/bin/bash
-
-set +e
-
-pushd $(dirname $0)
-
-../../node_modules/.bin/microbundle \
-  --entry worker.ts \
-  --output temp.umd.js \
-  --format umd \
-  --tsconfig tsconfig.json \
-  --sourcemap false \
-  --generateTypes false \
-  --external none
-
-rm -f inline-worker.js
-touch inline-worker.js
-
-echo 'export default URL.createObjectURL(new Blob([`' >> inline-worker.js
-cat temp.umd.js >> inline-worker.js
-echo '`], { type: "text/javascript" }));' >> inline-worker.js
-
-rm -f temp.umd.js
-# FIXME: don't generate these files:
-rm -rf worker
-
-popd

package/src/worker/tsconfig.json

@@ -1,6 +0,0 @@
-{
-  "compilerOptions": {
-    "sourceMap": false,
-    "lib": ["esnext", "webworker"],
-  }
-}

package/src/worker/worker.ts

@@ -1,57 +0,0 @@
-import jsQR, { QRCode } from "jsqr"
-import { DetectedBarcode } from "../basic-types"
-
-declare var self: DedicatedWorkerGlobalScope;
-export {};
-
-function detectWithJsQR(imageData : ImageData) : Array<DetectedBarcode> {
-  try {
-    const qrcode : QRCode = jsQR(
-      imageData.data, 
-      imageData.width, 
-      imageData.height, 
-      { inversionAttempts: "attemptBoth" }
-    );
-
-    if (qrcode === null || qrcode.data === "") {
-      return []
-    } else {
-      const { location, data } = qrcode
-
-      const cornerPoints = Object.freeze([
-        location.topLeftCorner,
-        location.topRightCorner,
-        location.bottomRightCorner,
-        location.bottomLeftCorner
-      ])
-
-      const x1 = Math.min(...cornerPoints.map(point => point.x))
-      const x2 = Math.max(...cornerPoints.map(point => point.x))
-      const y1 = Math.min(...cornerPoints.map(point => point.y))
-      const y2 = Math.max(...cornerPoints.map(point => point.y))
-
-      return [{ 
-        boundingBox: DOMRectReadOnly.fromRect({
-          x: x1,
-          y: y1,
-          width: x2 - x1,
-          height: y2 - y1
-        }), 
-        rawValue: data,
-        format: "qr_code",
-        cornerPoints         
-      }]
-    }
-  } catch (error) {
-    console.error(error)
-    return []
-  }
-}
-
-self.addEventListener("message", (event : MessageEvent) => {
-  const { id, imageData }= event.data 
-
-  const detectedBarcodes = detectWithJsQR(imageData)
-
-  self.postMessage({ id, detectedBarcodes })
-});

package/test/Dockerfile

@@ -1,7 +0,0 @@
-FROM webplatformtests/wpt:0.46
-
-RUN ./start.sh
-WORKDIR /home/test/web-platform-tests
-RUN ./wpt install firefox webdriver
-
-CMD ["./wpt", "run", "firefox", "shape-detection"]