From 95ac063ccf424e8a7cd1a824b940d378b792b7fa Mon Sep 17 00:00:00 2001 From: yqz562 <158135022+yqz562@users.noreply.github.com> Date: Fri, 16 Jan 2026 14:34:58 +0800 Subject: [PATCH 1/4] FAQ added --- .../configuration/adaptive-wasm-loading 1.md | 81 +++++++++++++++++++ barcode-reader/web/configuration/index.md | 2 + .../what-is-in-the-dist-folder-of-dbrb.md | 63 +++++++++++++++ barcode-reader/web/index.md | 2 + 4 files changed, 148 insertions(+) create mode 100644 barcode-reader/web/configuration/adaptive-wasm-loading 1.md create mode 100644 barcode-reader/web/configuration/what-is-in-the-dist-folder-of-dbrb.md diff --git a/barcode-reader/web/configuration/adaptive-wasm-loading 1.md b/barcode-reader/web/configuration/adaptive-wasm-loading 1.md new file mode 100644 index 0000000..7fbdb26 --- /dev/null +++ b/barcode-reader/web/configuration/adaptive-wasm-loading 1.md @@ -0,0 +1,81 @@ +--- +layout: default-layout +title: About Adaptive WebAssembly (Wasm) Loading +keywords: Dynamsoft Barcode Reader, FAQ, JavaScript, tech basic, wasm, loading +description: How to enable -SIMD-Pthread Wasm for accelerated deep learning computation? +needAutoGenerateSidebar: false +--- + +# About Adaptive WebAssembly (Wasm) Loading + +## What is adaptive Wasm loading? + +Dynamsoft Barcode Reader(JavaScript) includes **three optimized WebAssembly (Wasm) variants** — *-Baseline*, *-Pthread*, and *-SIMD-Pthread* — which can be **dynamically loaded based on the runtime environment**. +This adaptive loading mechanism ensures the SDK automatically selects the **most compatible and highest-performing** Wasm module available in each browser, further improving performance in modern environments. + +--- + +## Comparison of the three Wasm variants + +| Feature | Baseline Wasm | SIMD Wasm | SIMD + Pthread Wasm | +| -------- | -------------- | ---------- | -------------------- | +| **Parallelism** | Single-threaded | Single Instruction Multiple Data (CPU vector instruction set) | Multi-threaded(via Web Workers + SharedArrayBuffer) + SIMD | +| **Performance Characteristics** | Simple, limited by single-core performance | Leverages CPU vectorized parallelism to speed up data processing | Combines SIMD vectorization and multi-core acceleration for maximum performance | +| **Compatibility** | Supported in all Wasm environments | Requires browser support for Wasm SIMD instruction set | Requires browser support for both Wasm SIMD and Wasm threads (cross-origin isolation) | +| **Minimum Supported Browser Versions** | Chrome 78+
Edge 79+
Safari 14.5+
Firefox 68+ | Chrome 91+
Edge 91+
Safari 16.4+
Firefox 89+ | Chrome 91+
Edge 91+
Safari 16.4+
Firefox 89+ | +| **Wasm Size** | 5588 KB | 6974 KB | 8225 KB | +| **Transfer Size** | 2.11 MB | 2.55 MB | 2.81 MB | + +--- + +## How to enable -SIMD-Pthread Wasm for accelerated deep learning computation? + +To unlock multi-threaded performance with the **-SIMD-Pthread Wasm** variant, configure your server to enable **cross-origin isolation** by adding the following HTTP headers to all responses: + +```text +Cross-Origin-Opener-Policy: same-origin +Cross-Origin-Embedder-Policy: require-corp +``` + +Then, ensure that all SDK resources are **served under the same origin**. + +Once correctly configured, the SDK will automatically detect the environment and load the `-SIMD-Pthread Wasm` to leverage multi-core acceleration. + +>[!TIP] +>You can verify whether your site is correctly isolated by checking the browser console for cross-origin isolation status or by calling window.crossOriginIsolated in DevTools. + +## How to manually specify which Wasm variant to load? + +By default, the SDK automatically determines the most suitable WebAssembly (Wasm) variant to load based on the browser's capabilities. +However, developers can **manually override** this behavior and explicitly specify which Wasm module to load through the `wasmLoadOptions` property. + +### Example + +```javascript +Dynamsoft.Core.CoreModule.wasmLoadOptions = { + wasmType: "ml-simd-pthread", + pthreadPoolSize: 5, +}; +``` + +### Supported Wasm Types + +```javascript +type WasmType = + | "baseline" // Basic single-threaded variant + | "ml-simd" // SIMD-optimized variant + | "ml-simd-pthread" // Multi-threaded + SIMD optimized variant + | "auto"; // Automatically select based on environment +``` + +>[!NOTE] +>Setting wasmType to "auto" (default) allows the SDK to automatically choose the optimal Wasm based on runtime capability detection. +> +>When using "ml-simd-pthread", ensure that cross-origin isolation is properly configured as described in [How to enable `-SIMD-Pthread Wasm` for accelerated deep learning computation](#how-to-enable--simd-pthread-wasm-for-accelerated-deep-learning-computation). +> +>If the specified Wasm variant is not supported in the current browser, the SDK will gracefully fall back to a compatible variant. + +## Why isn't -SIMD-Pthread Wasm enabled by default on iOS? + +Due to iOS's strict memory allocation and management limitations, loading `-SIMD-Pthread Wasm` can sometimes lead to “out of memory” errors on older devices or iOS versions. +To ensure stability and compatibility, the SDK does not load `-SIMD-Pthread Wasm` by default on iOS. Instead, it automatically falls back to the most suitable Baseline or SIMD variant depending on the environment. \ No newline at end of file diff --git a/barcode-reader/web/configuration/index.md b/barcode-reader/web/configuration/index.md index d5eccbc..496417d 100644 --- a/barcode-reader/web/configuration/index.md +++ b/barcode-reader/web/configuration/index.md @@ -23,3 +23,5 @@ noTitleIndex: true - [Upgrade old to new version](upgrade-old-to-new.html) - [Use of onFrameRead and onUnduplicateRead](use-of-onFrameRead-and-onUnduplicateRead.html) - [Ways to copy DBR-JS deployable files](ways-to-copy-dbr-js-deployable-files.html) +- [What's in the dist Folder of dynamsoft-barcode-reader-bundle?](what-is-in-the-dist-folder-of-dbrb.html) +- [About Adaptive WebAssembly (Wasm) Loading](about-adaptive-wasm-loading.html) \ No newline at end of file diff --git a/barcode-reader/web/configuration/what-is-in-the-dist-folder-of-dbrb.md b/barcode-reader/web/configuration/what-is-in-the-dist-folder-of-dbrb.md new file mode 100644 index 0000000..edeb0d0 --- /dev/null +++ b/barcode-reader/web/configuration/what-is-in-the-dist-folder-of-dbrb.md @@ -0,0 +1,63 @@ +--- +layout: default-layout +title: What's in the dist Folder of dynamsoft-barcode-reader-bundle? +keywords: Dynamsoft Barcode Reader, FAQ, JavaScript, tech basic, wasm, dist, files +description: How to enable -SIMD-Pthread Wasm for accelerated deep learning computation? +needAutoGenerateSidebar: false +--- + +# What's in the dist Folder of dynamsoft-barcode-reader-bundle? + +When you install or extract the `dynamsoft-barcode-reader-bundle` package (from npm, CDN or zip installer), the `dist/` directory contains all the compiled, ready-to-use JavaScript/WebAssembly assets necessary to run the barcode reader in a browser or web app. + +Below are the common files you'll find and their purposes. + + +## 1. dbr.bundle.js + +- The main bundled JavaScript file for the barcode reader SDK +- Include this in your web page to use the SDK without separate imports + + +## 2. dbr.bundle.mjs (ES Module) + +- An ES Module version of the bundled SDK +- Useful when using modern build tools like Webpack, Vite, or Rollup + +## 3. dbr.bundle.d.ts + +- Type definitions for TypeScript support +- Provides autocompletion and improves developer experience in TypeScript projects + + +## 4. dbr.bundle.worker.js + +- Used for handling CPU-intensive barcode scanning and recognition tasks. Runs in a background thread without blocking the main thread UI + +- Communicates with the main thread through message passing + +## 5. WebAssembly Engine Files + +`dynamsoft-barcode-reader-bundle` requires WASM and Worker scripts to work together in order to achieve highly efficient decoding capabilities. + +| File | Purpose | +|------|---------| +| `*.wasm` | Core barcode reading logic compiled to WebAssembly | +| `*.wasm.js` | JavaScript loader/bootstrap for the `.wasm` file | +| `*.worker.js` | Offloads processing to a background thread | + +> [!IMPORTANT] +> The dbr-bundle dynamically selects the most suitable WebAssembly variant based on the current browser environment, in order to maximize browser performance as much as possible. This means that in most cases, only one set of `*.wasm` + `*.wasm.js` files will actually be used at runtime. +> For details about the different WASM variants, please refer to [What Is Adaptive WebAssembly (Wasm) Loading and How Does It Work?](adaptive-wasm-loading.md). + + +## 6. Other Auxiliary Resources + +These folders collectively compose the runtime environment for a JavaScript-based barcode scanner application, providing all necessary assets for ML-based scanning, data parsing, result rendering, and user interaction. + +| Folder | Purpose | +|------|---------| +| `models/` | Contains pre-trained machine learning models used for barcode detection and recognition. These models enable the scanner to identify and decode various barcode formats from images and video streams in real-time. | +| `parser-resources/` | Stores resources required for data parsing and interpretation. | +| `templates/` | Contains preset CaptureVisionTemplates used for different barcode scanning scenarios. | +| `ui/` | Preset ui in `.html` files. | \ No newline at end of file diff --git a/barcode-reader/web/index.md b/barcode-reader/web/index.md index 0a4df74..ff3b057 100644 --- a/barcode-reader/web/index.md +++ b/barcode-reader/web/index.md @@ -45,6 +45,8 @@ Welcome! Browse the sections below for answers to common questions, configuratio - [Scan US driver's license](configuration/scan-US-drivers-license.html) - [Upgrade old to new version](configuration/upgrade-old-to-new.html) - [Ways to copy DBR-JS deployable files](configuration/ways-to-copy-dbr-js-deployable-files.html) +- [What's in the dist Folder of dynamsoft-barcode-reader-bundle?](configuration/what-is-in-the-dist-folder-of-dbrb.html) +- [About Adaptive WebAssembly (Wasm) Loading](configuration/about-adaptive-wasm-loading.html) ## Debug From 013f8f02b6b35fd77ee12ebe5848b49305300506 Mon Sep 17 00:00:00 2001 From: yqz562 <158135022+yqz562@users.noreply.github.com> Date: Fri, 16 Jan 2026 14:49:59 +0800 Subject: [PATCH 2/4] fix --- .../adaptive-wasm-loading.md} | 0 barcode-reader/web/capabilities/index.md | 2 + .../ways-to-copy-dbr-js-deployable-files.md | 0 barcode-reader/web/configuration/index.md | 2 - .../what-is-in-the-dist-folder-of-dbrb.md | 63 ------------------- barcode-reader/web/index.md | 4 +- 6 files changed, 4 insertions(+), 67 deletions(-) rename barcode-reader/web/{configuration/adaptive-wasm-loading 1.md => capabilities/adaptive-wasm-loading.md} (100%) rename barcode-reader/web/{configuration => capabilities}/ways-to-copy-dbr-js-deployable-files.md (100%) delete mode 100644 barcode-reader/web/configuration/what-is-in-the-dist-folder-of-dbrb.md diff --git a/barcode-reader/web/configuration/adaptive-wasm-loading 1.md b/barcode-reader/web/capabilities/adaptive-wasm-loading.md similarity index 100% rename from barcode-reader/web/configuration/adaptive-wasm-loading 1.md rename to barcode-reader/web/capabilities/adaptive-wasm-loading.md diff --git a/barcode-reader/web/capabilities/index.md b/barcode-reader/web/capabilities/index.md index 45d2467..467f675 100644 --- a/barcode-reader/web/capabilities/index.md +++ b/barcode-reader/web/capabilities/index.md @@ -14,3 +14,5 @@ noTitleIndex: true - [Is HTTPS Required?](is-https-required.html) - [Pros and Cons of CDN](pros-and-cons-of-cdn.html) - [System Requirement](system-requirement.html) +- [What's in the dist Folder of dynamsoft-barcode-reader-bundle?](what-is-in-the-dist-folder-of-dbrb.html) +- [About Adaptive WebAssembly (Wasm) Loading](about-adaptive-wasm-loading.html) \ No newline at end of file diff --git a/barcode-reader/web/configuration/ways-to-copy-dbr-js-deployable-files.md b/barcode-reader/web/capabilities/ways-to-copy-dbr-js-deployable-files.md similarity index 100% rename from barcode-reader/web/configuration/ways-to-copy-dbr-js-deployable-files.md rename to barcode-reader/web/capabilities/ways-to-copy-dbr-js-deployable-files.md diff --git a/barcode-reader/web/configuration/index.md b/barcode-reader/web/configuration/index.md index 496417d..d5eccbc 100644 --- a/barcode-reader/web/configuration/index.md +++ b/barcode-reader/web/configuration/index.md @@ -23,5 +23,3 @@ noTitleIndex: true - [Upgrade old to new version](upgrade-old-to-new.html) - [Use of onFrameRead and onUnduplicateRead](use-of-onFrameRead-and-onUnduplicateRead.html) - [Ways to copy DBR-JS deployable files](ways-to-copy-dbr-js-deployable-files.html) -- [What's in the dist Folder of dynamsoft-barcode-reader-bundle?](what-is-in-the-dist-folder-of-dbrb.html) -- [About Adaptive WebAssembly (Wasm) Loading](about-adaptive-wasm-loading.html) \ No newline at end of file diff --git a/barcode-reader/web/configuration/what-is-in-the-dist-folder-of-dbrb.md b/barcode-reader/web/configuration/what-is-in-the-dist-folder-of-dbrb.md deleted file mode 100644 index edeb0d0..0000000 --- a/barcode-reader/web/configuration/what-is-in-the-dist-folder-of-dbrb.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -layout: default-layout -title: What's in the dist Folder of dynamsoft-barcode-reader-bundle? -keywords: Dynamsoft Barcode Reader, FAQ, JavaScript, tech basic, wasm, dist, files -description: How to enable -SIMD-Pthread Wasm for accelerated deep learning computation? -needAutoGenerateSidebar: false ---- - -# What's in the dist Folder of dynamsoft-barcode-reader-bundle? - -When you install or extract the `dynamsoft-barcode-reader-bundle` package (from npm, CDN or zip installer), the `dist/` directory contains all the compiled, ready-to-use JavaScript/WebAssembly assets necessary to run the barcode reader in a browser or web app. - -Below are the common files you'll find and their purposes. - - -## 1. dbr.bundle.js - -- The main bundled JavaScript file for the barcode reader SDK -- Include this in your web page to use the SDK without separate imports - - -## 2. dbr.bundle.mjs (ES Module) - -- An ES Module version of the bundled SDK -- Useful when using modern build tools like Webpack, Vite, or Rollup - -## 3. dbr.bundle.d.ts - -- Type definitions for TypeScript support -- Provides autocompletion and improves developer experience in TypeScript projects - - -## 4. dbr.bundle.worker.js - -- Used for handling CPU-intensive barcode scanning and recognition tasks. Runs in a background thread without blocking the main thread UI - -- Communicates with the main thread through message passing - -## 5. WebAssembly Engine Files - -`dynamsoft-barcode-reader-bundle` requires WASM and Worker scripts to work together in order to achieve highly efficient decoding capabilities. - -| File | Purpose | -|------|---------| -| `*.wasm` | Core barcode reading logic compiled to WebAssembly | -| `*.wasm.js` | JavaScript loader/bootstrap for the `.wasm` file | -| `*.worker.js` | Offloads processing to a background thread | - -> [!IMPORTANT] -> The dbr-bundle dynamically selects the most suitable WebAssembly variant based on the current browser environment, in order to maximize browser performance as much as possible. This means that in most cases, only one set of `*.wasm` + `*.wasm.js` files will actually be used at runtime. -> For details about the different WASM variants, please refer to [What Is Adaptive WebAssembly (Wasm) Loading and How Does It Work?](adaptive-wasm-loading.md). - - -## 6. Other Auxiliary Resources - -These folders collectively compose the runtime environment for a JavaScript-based barcode scanner application, providing all necessary assets for ML-based scanning, data parsing, result rendering, and user interaction. - -| Folder | Purpose | -|------|---------| -| `models/` | Contains pre-trained machine learning models used for barcode detection and recognition. These models enable the scanner to identify and decode various barcode formats from images and video streams in real-time. | -| `parser-resources/` | Stores resources required for data parsing and interpretation. | -| `templates/` | Contains preset CaptureVisionTemplates used for different barcode scanning scenarios. | -| `ui/` | Preset ui in `.html` files. | \ No newline at end of file diff --git a/barcode-reader/web/index.md b/barcode-reader/web/index.md index ff3b057..5b2e705 100644 --- a/barcode-reader/web/index.md +++ b/barcode-reader/web/index.md @@ -29,6 +29,8 @@ Welcome! Browse the sections below for answers to common questions, configuratio - [Is HTTPS Required?](capabilities/is-https-required.html) - [Pros and Cons of CDN](capabilities/pros-and-cons-of-cdn.html) - [System Requirement](capabilities/system-requirement.html) +- [What's in the dist Folder of dynamsoft-barcode-reader-bundle?](configuration/what-is-in-the-dist-folder-of-dbrb.html) +- [About Adaptive WebAssembly (Wasm) Loading](configuration/about-adaptive-wasm-loading.html) ## Configuration @@ -45,8 +47,6 @@ Welcome! Browse the sections below for answers to common questions, configuratio - [Scan US driver's license](configuration/scan-US-drivers-license.html) - [Upgrade old to new version](configuration/upgrade-old-to-new.html) - [Ways to copy DBR-JS deployable files](configuration/ways-to-copy-dbr-js-deployable-files.html) -- [What's in the dist Folder of dynamsoft-barcode-reader-bundle?](configuration/what-is-in-the-dist-folder-of-dbrb.html) -- [About Adaptive WebAssembly (Wasm) Loading](configuration/about-adaptive-wasm-loading.html) ## Debug From 4651d6912f5fdd6e43c99b879c0b6210cf08f2b2 Mon Sep 17 00:00:00 2001 From: yqz562 <158135022+yqz562@users.noreply.github.com> Date: Fri, 16 Jan 2026 15:16:26 +0800 Subject: [PATCH 3/4] fix --- barcode-reader/web/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/barcode-reader/web/index.md b/barcode-reader/web/index.md index 5b2e705..c31c8cd 100644 --- a/barcode-reader/web/index.md +++ b/barcode-reader/web/index.md @@ -29,8 +29,8 @@ Welcome! Browse the sections below for answers to common questions, configuratio - [Is HTTPS Required?](capabilities/is-https-required.html) - [Pros and Cons of CDN](capabilities/pros-and-cons-of-cdn.html) - [System Requirement](capabilities/system-requirement.html) -- [What's in the dist Folder of dynamsoft-barcode-reader-bundle?](configuration/what-is-in-the-dist-folder-of-dbrb.html) -- [About Adaptive WebAssembly (Wasm) Loading](configuration/about-adaptive-wasm-loading.html) +- [What's in the dist Folder of dynamsoft-barcode-reader-bundle?](capabilities/what-is-in-the-dist-folder-of-dbrb.html) +- [About Adaptive WebAssembly (Wasm) Loading](capabilities/about-adaptive-wasm-loading.html) ## Configuration From ff7fcea0f86f97acdf557650f4bde5d03c14ad95 Mon Sep 17 00:00:00 2001 From: yqz562 <158135022+yqz562@users.noreply.github.com> Date: Fri, 16 Jan 2026 15:25:37 +0800 Subject: [PATCH 4/4] fix --- .../what-is-in-the-dist-folder-of-dbr.md | 63 +++++++++++++++++++ barcode-reader/web/index.md | 4 +- 2 files changed, 65 insertions(+), 2 deletions(-) create mode 100644 barcode-reader/web/capabilities/what-is-in-the-dist-folder-of-dbr.md diff --git a/barcode-reader/web/capabilities/what-is-in-the-dist-folder-of-dbr.md b/barcode-reader/web/capabilities/what-is-in-the-dist-folder-of-dbr.md new file mode 100644 index 0000000..edeb0d0 --- /dev/null +++ b/barcode-reader/web/capabilities/what-is-in-the-dist-folder-of-dbr.md @@ -0,0 +1,63 @@ +--- +layout: default-layout +title: What's in the dist Folder of dynamsoft-barcode-reader-bundle? +keywords: Dynamsoft Barcode Reader, FAQ, JavaScript, tech basic, wasm, dist, files +description: How to enable -SIMD-Pthread Wasm for accelerated deep learning computation? +needAutoGenerateSidebar: false +--- + +# What's in the dist Folder of dynamsoft-barcode-reader-bundle? + +When you install or extract the `dynamsoft-barcode-reader-bundle` package (from npm, CDN or zip installer), the `dist/` directory contains all the compiled, ready-to-use JavaScript/WebAssembly assets necessary to run the barcode reader in a browser or web app. + +Below are the common files you'll find and their purposes. + + +## 1. dbr.bundle.js + +- The main bundled JavaScript file for the barcode reader SDK +- Include this in your web page to use the SDK without separate imports + + +## 2. dbr.bundle.mjs (ES Module) + +- An ES Module version of the bundled SDK +- Useful when using modern build tools like Webpack, Vite, or Rollup + +## 3. dbr.bundle.d.ts + +- Type definitions for TypeScript support +- Provides autocompletion and improves developer experience in TypeScript projects + + +## 4. dbr.bundle.worker.js + +- Used for handling CPU-intensive barcode scanning and recognition tasks. Runs in a background thread without blocking the main thread UI + +- Communicates with the main thread through message passing + +## 5. WebAssembly Engine Files + +`dynamsoft-barcode-reader-bundle` requires WASM and Worker scripts to work together in order to achieve highly efficient decoding capabilities. + +| File | Purpose | +|------|---------| +| `*.wasm` | Core barcode reading logic compiled to WebAssembly | +| `*.wasm.js` | JavaScript loader/bootstrap for the `.wasm` file | +| `*.worker.js` | Offloads processing to a background thread | + +> [!IMPORTANT] +> The dbr-bundle dynamically selects the most suitable WebAssembly variant based on the current browser environment, in order to maximize browser performance as much as possible. This means that in most cases, only one set of `*.wasm` + `*.wasm.js` files will actually be used at runtime. +> For details about the different WASM variants, please refer to [What Is Adaptive WebAssembly (Wasm) Loading and How Does It Work?](adaptive-wasm-loading.md). + + +## 6. Other Auxiliary Resources + +These folders collectively compose the runtime environment for a JavaScript-based barcode scanner application, providing all necessary assets for ML-based scanning, data parsing, result rendering, and user interaction. + +| Folder | Purpose | +|------|---------| +| `models/` | Contains pre-trained machine learning models used for barcode detection and recognition. These models enable the scanner to identify and decode various barcode formats from images and video streams in real-time. | +| `parser-resources/` | Stores resources required for data parsing and interpretation. | +| `templates/` | Contains preset CaptureVisionTemplates used for different barcode scanning scenarios. | +| `ui/` | Preset ui in `.html` files. | \ No newline at end of file diff --git a/barcode-reader/web/index.md b/barcode-reader/web/index.md index c31c8cd..af830b4 100644 --- a/barcode-reader/web/index.md +++ b/barcode-reader/web/index.md @@ -29,8 +29,8 @@ Welcome! Browse the sections below for answers to common questions, configuratio - [Is HTTPS Required?](capabilities/is-https-required.html) - [Pros and Cons of CDN](capabilities/pros-and-cons-of-cdn.html) - [System Requirement](capabilities/system-requirement.html) -- [What's in the dist Folder of dynamsoft-barcode-reader-bundle?](capabilities/what-is-in-the-dist-folder-of-dbrb.html) -- [About Adaptive WebAssembly (Wasm) Loading](capabilities/about-adaptive-wasm-loading.html) +- [What's in the dist Folder of dynamsoft-barcode-reader-bundle?](capabilities/what-is-in-the-dist-folder-of-dbr.html) +- [About Adaptive WebAssembly (Wasm) Loading](capabilities/adaptive-wasm-loading.html) ## Configuration