rxing-wasm 0.1.2 → 0.1.4

package/README.md

@@ -1,7 +1,30 @@
 # rxing-wasm
-WASM bindings for common rxing functions
+WASM bindings for common rxing functions. The NPM link is [https://www.npmjs.com/package/rxing-wasm](https://www.npmjs.com/package/rxing-wasm) and the rust source is [https://github.com/hschimke/rxing-wasm](https://github.com/hschimke/rxing-wasm).
+
+## Data
+The `convert_js_image_to_luma` function is used to convert canvas image data to the luma 8
+format that rxing expects. An example might look like to below.
+
+```javascript
+function decodeBarcode(canvas) {
+    let context = canvas.getContext('2d');
+    let height = canvas.height;
+    let width = canvas.width;
+    let imageData = context.getImageData(0, 0, width, height);
+
+    let data = imageData.data;
+    let luma8Data = convert_js_image_to_luma(data);
+    let parsedBarcode = decode_barcode(luma8Data, width, height);
+    
+    return parsedBarcode;
+}
+```
 
 ## Functions
+```rust
+pub fn convert_js_image_to_luma(data: &[u8]) -> Vec<u8>;
+```
+
 ```rust
 pub fn encode_barcode(
     data: &str,
@@ -18,4 +41,13 @@ pub fn decode_barcode(
     height: u32,
     try_harder: Option<bool>,
 ) -> Result<BarcodeResult, String>;
+```
+
+```rust
+pub fn decode_barcode_with_hints(
+    data: Vec<u8>,
+    width: u32,
+    height: u32,
+    hints: &mut decode_hints::DecodeHintDictionary,
+) -> Result<BarcodeResult, String>;
 ```

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "rxing-wasm",
   "description": "wasm bindings for rxing to provide commong barcode operations (decode/encode)",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "license": "Apache 2.0",
   "repository": {
     "type": "git",

package/rxing_wasm.d.ts

@@ -19,6 +19,17 @@ export function encode_barcode(data: string, width: number, height: number, bc_t
 */
 export function decode_barcode(data: Uint8Array, width: number, height: number, try_harder?: boolean): BarcodeResult;
 /**
+* Convert a javascript image context's data into luma 8.
+*
+* Data for this function can be found from any canvas object
+* using the `data` property of an `ImageData` object.
+* Such an object could be obtained using the `getImageData`
+* method of a `CanvasRenderingContext2D` object.
+* @param {Uint8Array} data
+* @returns {Uint8Array}
+*/
+export function convert_js_image_to_luma(data: Uint8Array): Uint8Array;
+/**
 * Decode a barcode from an array of rgba data.
 * Pixel data is in the form of:
 *     Each pixel is one u32, [r,g,b].
@@ -30,6 +41,14 @@ export function decode_barcode(data: Uint8Array, width: number, height: number,
 */
 export function decode_barcode_rgb(data: Uint32Array, width: number, height: number, try_harder?: boolean): BarcodeResult;
 /**
+* @param {Uint8Array} data
+* @param {number} width
+* @param {number} height
+* @param {DecodeHintDictionary} hints
+* @returns {BarcodeResult}
+*/
+export function decode_barcode_with_hints(data: Uint8Array, width: number, height: number, hints: DecodeHintDictionary): BarcodeResult;
+/**
 * Available barcode types
 */
 export enum BarcodeFormat {
@@ -105,6 +124,96 @@ export enum BarcodeFormat {
 }
 /**
 */
+export enum DecodeHintTypes {
+/**
+*
+*     * Unspecified, application-specific hint. Maps to an unspecified {@link Object}.
+*     
+*/
+  Other,
+/**
+*
+*     * Image is a pure monochrome image of a barcode. Doesn't matter what it maps to;
+*     * use {@link Boolean#TRUE}.
+*     
+*/
+  PureBarcode,
+/**
+*
+*     * Image is known to be of one of a few possible formats.
+*     * Maps to a {@link List} of {@link BarcodeFormat}s.
+*     
+*/
+  PossibleFormats,
+/**
+*
+*     * Spend more time to try to find a barcode; optimize for accuracy, not speed.
+*     * Doesn't matter what it maps to; use {@link Boolean#TRUE}.
+*     
+*/
+  TryHarder,
+/**
+*
+*     * Specifies what character encoding to use when decoding, where applicable (type String)
+*     
+*/
+  CharacterSet,
+/**
+*
+*     * Allowed lengths of encoded data -- reject anything else. Maps to an {@code int[]}.
+*     
+*/
+  AllowedLengths,
+/**
+*
+*     * Assume Code 39 codes employ a check digit. Doesn't matter what it maps to;
+*     * use {@link Boolean#TRUE}.
+*     
+*/
+  AssumeCode39CheckDigit,
+/**
+*
+*     * Assume the barcode is being processed as a GS1 barcode, and modify behavior as needed.
+*     * For example this affects FNC1 handling for Code 128 (aka GS1-128). Doesn't matter what it maps to;
+*     * use {@link Boolean#TRUE}.
+*     
+*/
+  AssumeGs1,
+/**
+*
+*     * If true, return the start and end digits in a Codabar barcode instead of stripping them. They
+*     * are alpha, whereas the rest are numeric. By default, they are stripped, but this causes them
+*     * to not be. Doesn't matter what it maps to; use {@link Boolean#TRUE}.
+*     
+*/
+  ReturnCodabarStartEnd,
+/**
+*
+*     * The caller needs to be notified via callback when a possible {@link RXingResultPoint}
+*     * is found. Maps to a {@link RXingResultPointCallback}.
+*     
+*/
+  NeedResultPointCallback,
+/**
+*
+*     * Allowed extension lengths for EAN or UPC barcodes. Other formats will ignore this.
+*     * Maps to an {@code int[]} of the allowed extension lengths, for example [2], [5], or [2, 5].
+*     * If it is optional to have an extension, do not set this hint. If this is set,
+*     * and a UPC or EAN barcode is found but an extension is not, then no result will be returned
+*     * at all.
+*     
+*/
+  AllowedEanExtensions,
+/**
+*
+*     * If true, also tries to decode as inverted image. All configured decoders are simply called a
+*     * second time with an inverted image. Doesn't matter what it maps to; use {@link Boolean#TRUE}.
+*     
+*/
+  AlsoInverted,
+}
+/**
+*/
 export class BarcodeResult {
   free(): void;
 /**
@@ -133,3 +242,27 @@ export class BarcodeResult {
 */
   text(): string;
 }
+/**
+*/
+export class DecodeHintDictionary {
+  free(): void;
+/**
+*/
+  constructor();
+/**
+* @param {number} hint
+* @returns {string}
+*/
+  get_hint(hint: number): string;
+/**
+* @param {number} hint
+* @param {string} value
+* @returns {boolean}
+*/
+  set_hint(hint: number, value: string): boolean;
+/**
+* @param {number} hint
+* @returns {boolean}
+*/
+  remove_hint(hint: number): boolean;
+}

package/rxing_wasm_bg.js

@@ -197,6 +197,32 @@ export function decode_barcode(data, width, height, try_harder) {
     }
 }
 
+/**
+* Convert a javascript image context's data into luma 8.
+*
+* Data for this function can be found from any canvas object
+* using the `data` property of an `ImageData` object.
+* Such an object could be obtained using the `getImageData`
+* method of a `CanvasRenderingContext2D` object.
+* @param {Uint8Array} data
+* @returns {Uint8Array}
+*/
+export function convert_js_image_to_luma(data) {
+    try {
+        const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+        const ptr0 = passArray8ToWasm0(data, wasm.__wbindgen_malloc);
+        const len0 = WASM_VECTOR_LEN;
+        wasm.convert_js_image_to_luma(retptr, ptr0, len0);
+        var r0 = getInt32Memory0()[retptr / 4 + 0];
+        var r1 = getInt32Memory0()[retptr / 4 + 1];
+        var v1 = getArrayU8FromWasm0(r0, r1).slice();
+        wasm.__wbindgen_free(r0, r1 * 1);
+        return v1;
+    } finally {
+        wasm.__wbindgen_add_to_stack_pointer(16);
+    }
+}
+
 let cachedUint32Memory0 = new Uint32Array();
 
 function getUint32Memory0() {
@@ -240,6 +266,38 @@ export function decode_barcode_rgb(data, width, height, try_harder) {
     }
 }
 
+function _assertClass(instance, klass) {
+    if (!(instance instanceof klass)) {
+        throw new Error(`expected instance of ${klass.name}`);
+    }
+    return instance.ptr;
+}
+/**
+* @param {Uint8Array} data
+* @param {number} width
+* @param {number} height
+* @param {DecodeHintDictionary} hints
+* @returns {BarcodeResult}
+*/
+export function decode_barcode_with_hints(data, width, height, hints) {
+    try {
+        const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+        const ptr0 = passArray8ToWasm0(data, wasm.__wbindgen_malloc);
+        const len0 = WASM_VECTOR_LEN;
+        _assertClass(hints, DecodeHintDictionary);
+        wasm.decode_barcode_with_hints(retptr, ptr0, len0, width, height, hints.ptr);
+        var r0 = getInt32Memory0()[retptr / 4 + 0];
+        var r1 = getInt32Memory0()[retptr / 4 + 1];
+        var r2 = getInt32Memory0()[retptr / 4 + 2];
+        if (r2) {
+            throw takeObject(r1);
+        }
+        return BarcodeResult.__wrap(r0);
+    } finally {
+        wasm.__wbindgen_add_to_stack_pointer(16);
+    }
+}
+
 /**
 * Available barcode types
 */
@@ -314,6 +372,95 @@ UpcE:15,"15":"UpcE",
 UpcEanExtension:16,"16":"UpcEanExtension",UnsuportedFormat:17,"17":"UnsuportedFormat", });
 /**
 */
+export const DecodeHintTypes = Object.freeze({
+/**
+*
+*     * Unspecified, application-specific hint. Maps to an unspecified {@link Object}.
+*
+*/
+Other:0,"0":"Other",
+/**
+*
+*     * Image is a pure monochrome image of a barcode. Doesn't matter what it maps to;
+*     * use {@link Boolean#TRUE}.
+*
+*/
+PureBarcode:1,"1":"PureBarcode",
+/**
+*
+*     * Image is known to be of one of a few possible formats.
+*     * Maps to a {@link List} of {@link BarcodeFormat}s.
+*
+*/
+PossibleFormats:2,"2":"PossibleFormats",
+/**
+*
+*     * Spend more time to try to find a barcode; optimize for accuracy, not speed.
+*     * Doesn't matter what it maps to; use {@link Boolean#TRUE}.
+*
+*/
+TryHarder:3,"3":"TryHarder",
+/**
+*
+*     * Specifies what character encoding to use when decoding, where applicable (type String)
+*
+*/
+CharacterSet:4,"4":"CharacterSet",
+/**
+*
+*     * Allowed lengths of encoded data -- reject anything else. Maps to an {@code int[]}.
+*
+*/
+AllowedLengths:5,"5":"AllowedLengths",
+/**
+*
+*     * Assume Code 39 codes employ a check digit. Doesn't matter what it maps to;
+*     * use {@link Boolean#TRUE}.
+*
+*/
+AssumeCode39CheckDigit:6,"6":"AssumeCode39CheckDigit",
+/**
+*
+*     * Assume the barcode is being processed as a GS1 barcode, and modify behavior as needed.
+*     * For example this affects FNC1 handling for Code 128 (aka GS1-128). Doesn't matter what it maps to;
+*     * use {@link Boolean#TRUE}.
+*
+*/
+AssumeGs1:7,"7":"AssumeGs1",
+/**
+*
+*     * If true, return the start and end digits in a Codabar barcode instead of stripping them. They
+*     * are alpha, whereas the rest are numeric. By default, they are stripped, but this causes them
+*     * to not be. Doesn't matter what it maps to; use {@link Boolean#TRUE}.
+*
+*/
+ReturnCodabarStartEnd:8,"8":"ReturnCodabarStartEnd",
+/**
+*
+*     * The caller needs to be notified via callback when a possible {@link RXingResultPoint}
+*     * is found. Maps to a {@link RXingResultPointCallback}.
+*
+*/
+NeedResultPointCallback:9,"9":"NeedResultPointCallback",
+/**
+*
+*     * Allowed extension lengths for EAN or UPC barcodes. Other formats will ignore this.
+*     * Maps to an {@code int[]} of the allowed extension lengths, for example [2], [5], or [2, 5].
+*     * If it is optional to have an extension, do not set this hint. If this is set,
+*     * and a UPC or EAN barcode is found but an extension is not, then no result will be returned
+*     * at all.
+*
+*/
+AllowedEanExtensions:10,"10":"AllowedEanExtensions",
+/**
+*
+*     * If true, also tries to decode as inverted image. All configured decoders are simply called a
+*     * second time with an inverted image. Doesn't matter what it maps to; use {@link Boolean#TRUE}.
+*
+*/
+AlsoInverted:11,"11":"AlsoInverted", });
+/**
+*/
 export class BarcodeResult {
 
     static __wrap(ptr) {
@@ -404,6 +551,70 @@ export class BarcodeResult {
         }
     }
 }
+/**
+*/
+export class DecodeHintDictionary {
+
+    static __wrap(ptr) {
+        const obj = Object.create(DecodeHintDictionary.prototype);
+        obj.ptr = ptr;
+
+        return obj;
+    }
+
+    __destroy_into_raw() {
+        const ptr = this.ptr;
+        this.ptr = 0;
+
+        return ptr;
+    }
+
+    free() {
+        const ptr = this.__destroy_into_raw();
+        wasm.__wbg_decodehintdictionary_free(ptr);
+    }
+    /**
+    */
+    constructor() {
+        const ret = wasm.decodehintdictionary_new();
+        return DecodeHintDictionary.__wrap(ret);
+    }
+    /**
+    * @param {number} hint
+    * @returns {string}
+    */
+    get_hint(hint) {
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            wasm.decodehintdictionary_get_hint(retptr, this.ptr, hint);
+            var r0 = getInt32Memory0()[retptr / 4 + 0];
+            var r1 = getInt32Memory0()[retptr / 4 + 1];
+            return getStringFromWasm0(r0, r1);
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+            wasm.__wbindgen_free(r0, r1);
+        }
+    }
+    /**
+    * @param {number} hint
+    * @param {string} value
+    * @returns {boolean}
+    */
+    set_hint(hint, value) {
+        const ptr0 = passStringToWasm0(value, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ret = wasm.decodehintdictionary_set_hint(this.ptr, hint, ptr0, len0);
+        return ret !== 0;
+    }
+    /**
+    * @param {number} hint
+    * @returns {boolean}
+    */
+    remove_hint(hint) {
+        const ret = wasm.decodehintdictionary_remove_hint(this.ptr, hint);
+        return ret !== 0;
+    }
+}
 
 export function __wbindgen_string_new(arg0, arg1) {
     const ret = getStringFromWasm0(arg0, arg1);