@qvac/ocr-ggml 0.0.1 → 0.1.1

package/LICENSE

@@ -0,0 +1,179 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+Copyright 2026 Tether Data, S.A. de C.V.

package/NOTICE

@@ -0,0 +1,63 @@
+@qvac/ocr-ggml
+Copyright (C) Tether Operations Limited
+
+Licensed under the Apache License, Version 2.0 (the "License"). You may
+obtain a copy of the License at:
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+License for the specific language governing permissions and limitations
+under the License.
+
+----------------------------------------------------------------------
+Third-party components and provenance
+----------------------------------------------------------------------
+
+This package incorporates source code lifted, with adaptation, from the
+following projects. Each component retains its own license; the project
+links cited below contain the canonical license text.
+
+1. EasyOCR (Apache License 2.0)
+   https://github.com/JaidedAI/EasyOCR
+   The detection (CRAFT) and recognition (CRNN gen-2) pipeline shape,
+   pre/post-processing math, and language tables in
+   `addon/src/pipeline/*` and `addon/src/easyocr-ggml/*` are derived
+   from the upstream EasyOCR Python reference.
+
+2. EasyOcr-ggml (Apache License 2.0)
+   https://github.com/tetherto/easy-ocr-ggml
+   The GGML graph builders, GGUF weight loaders, and BN-folded weight
+   tables in `addon/src/ggml/*` and `addon/src/easyocr-ggml/*` are
+   lifted verbatim (with minor namespace adjustments) from this sibling
+   project.
+
+3. ggml (MIT License)
+   https://github.com/ggml-org/ggml
+   Consumed at build time via `qvac-fabric`'s vcpkg port. The dynamic
+   backend shared libraries shipped under `prebuilds/` (CPU, Vulkan,
+   OpenCL, …) are ggml's outputs and inherit ggml's MIT license.
+
+4. OpenCV (Apache License 2.0)
+   https://github.com/opencv/opencv
+   Consumed at build time via vcpkg's `opencv4` port. Used for image
+   decode, geometric transforms, and connected-component analysis in
+   the detection / bounding-box pipeline.
+
+5. @qvac/inference-addon-cpp (Apache License 2.0)
+   https://github.com/tetherto/qvac-lib-inference-addon-cpp
+   Provides the `IModel`, `JsInterface`, and output-handler base
+   classes that the C++ side of this addon inherits from.
+
+6. @qvac/translation-nmtcpp (Apache License 2.0)
+   https://github.com/tetherto/qvac/tree/main/packages/translation-nmtcpp
+   Build / vcpkg / triplet / bare-module plumbing in this package is
+   adapted from the sibling translation addon.
+
+7. @qvac/ocr-onnx (Apache License 2.0)
+   https://github.com/tetherto/qvac/tree/main/packages/ocr-onnx
+   The JS-side public surface (constructor shape, image-decode
+   convention, output row schema) is modelled after this sibling so
+   downstream callers can swap engines transparently.

package/README.md

@@ -0,0 +1,330 @@
+# @qvac/ocr-ggml
+
+GGML-backed OCR addon for [QVAC](https://github.com/tetherto/qvac).
+Provides two inference pipelines on **`ggml` / `.gguf`** — no Python, no
+PyTorch, and no ONNX Runtime at runtime:
+
+| Pipeline | Detector | Recognizer | Notes |
+|---|---|---|---|
+| `easyocr` (default) | CRAFT | CRNN gen-2 (English / Latin) | Port of [EasyOCR](https://github.com/JaidedAI/EasyOCR) |
+| `doctr` | DBNet (MobileNetV3-Large) | CRNN (MobileNetV3-Small) | Port of [doctr](https://github.com/mindee/doctr) |
+
+Select the pipeline at construction time via `params.pipelineType`
+(default `'easyocr'`). Both pipelines emit the same output shape.
+
+Sibling of [`@qvac/ocr-onnx`](../ocr-onnx). Same input/output shape, same
+public surface — only the inference engine differs.
+
+| | `@qvac/ocr-onnx` | `@qvac/ocr-ggml` |
+|---|---|---|
+| Inference backend | ONNX Runtime | GGML |
+| Weight format | `.onnx` | `.gguf` |
+| Pre/post-processing | C++ + OpenCV (EasyOCR) | C++ + OpenCV (EasyOCR + doctr, lifted) |
+| Quantization | per-EP (limited) | block-quantized (Q8_0, Q4_K, …) out of the box |
+| Pipelines | EasyOCR | EasyOCR + Doctr |
+
+The C++ implementation is lifted from
+[`EasyOcr-ggml`](https://github.com/tetherto/easy-ocr-ggml); GGML is pulled
+from `qvac-fabric` (instead of the upstream submodule), matching how the
+sibling `translation-nmtcpp` addon consumes ggml.
+
+## Install
+
+```bash
+npm install @qvac/ocr-ggml
+```
+
+The package ships a Bare addon. Build prerequisites (clang-22, libc++,
+vcpkg, bare-make) match the rest of the QVAC monorepo — see the
+[root README](../../README.md) for the canonical setup.
+
+```bash
+cd packages/ocr-ggml
+npm install
+bare-make generate
+bare-make build
+bare-make install   # produces prebuilds/
+```
+
+## Usage
+
+```js
+const { OcrGgml } = require('@qvac/ocr-ggml')
+
+const ocr = new OcrGgml({
+  params: {
+    pathDetector: '/abs/path/craft_mlt_25k.gguf',
+    pathRecognizer: '/abs/path/english_g2.gguf',
+    langList: ['en'],
+    magRatio: 1.5
+  },
+  opts: { stats: true }
+})
+
+await ocr.load()
+
+const response = await ocr.run({
+  path: '/abs/path/photo.jpg',
+  options: { paragraph: false }
+})
+
+response.onUpdate(rows => {
+  for (const [box, text, conf] of rows) {
+    console.log(`[${conf.toFixed(2)}] ${text}`, box)
+  }
+})
+
+const stats = await response.await()
+console.log(stats)
+
+await ocr.unload()
+```
+
+### Quickstart example
+
+```bash
+bare examples/quickstart.js \
+  --image samples/english.png \
+  --detector models/craft_mlt_25k.gguf \
+  --recognizer models/english_g2.gguf \
+  --lang en
+```
+
+## API
+
+### `new OcrGgml({ params, opts?, logger? })`
+
+| Field | Type | Required | Default | Description |
+|---|---|:-:|---|---|
+| `params.pathDetector` | `string` | ✓ | — | detector `.gguf` (CRAFT for `easyocr`, DBNet for `doctr`) |
+| `params.pathRecognizer` | `string` | ✓ | — | recognizer `.gguf` (`english_g2`/`latin_g2` for `easyocr`, doctr CRNN for `doctr`) |
+| `params.langList` | `string[]` | ✓ | — | language codes (`['en']`, `['en','fr']`, …) — used by `easyocr`, ignored by `doctr` |
+| `params.pipelineType` | `'easyocr'` \| `'doctr'` | | `'easyocr'` | which pipeline backs the addon |
+| `params.magRatio` | `number` | | `1.5` | CRAFT input-image magnification (`easyocr` only) |
+| `params.defaultRotationAngles` | `number[]` | | `[90, 270]` | rotations tried on low-confidence boxes (`easyocr` only) |
+| `params.contrastRetry` | `boolean` | | `false` | retry low-confidence boxes with contrast adjustment (`easyocr` only) |
+| `params.lowConfidenceThreshold` | `number` | | `0.4` | retry threshold (`easyocr` only) |
+| `params.recognizerBatchSize` | `number` | | `32` | recognizer batch size (`easyocr` only) |
+| `params.nThreads` | `number` | | `0` (auto) | CPU thread count for GGML; `<0` leaves the GGML default |
+| `params.backendsDir` | `string` | | `<package>/prebuilds` | directory holding `libggml-*.so` backend shared libs |
+| `opts.stats` | `boolean` | | `false` | emit timing stats on `finish` |
+| `logger` | `Object` | | `null` | optional `{ info, warn, error, debug }` — receives C++ log lines |
+
+### Methods
+
+- `load(): Promise<void>` — loads both models, registers ggml backends, activates the addon
+- `run(input): Promise<QvacResponse>` — serialised; one job at a time
+- `unload(): Promise<void>` — frees the addon (destroys ggml contexts + backends)
+- `destroy(): Promise<void>` — marks the instance as destroyed (no further use)
+- `getState(): InferenceClientState`
+- `OcrGgml.getModelKey(): string` — `"ocr-ggml"`, used by the inference manager
+
+### `run(input)` shape
+
+```ts
+{
+  path: string,                    // JPEG / PNG / BMP file
+  options?: {
+    paragraph?: boolean,           // merge nearby boxes
+    boxMarginMultiplier?: number,  // padding around boxes
+    rotationAngles?: number[]      // override defaults for this call
+  }
+}
+```
+
+Output rows (delivered via `response.onUpdate`):
+
+```ts
+type InferredText = [
+  [[number, number], [number, number], [number, number], [number, number]],  // 4-point box
+  string,                                                                    // text
+  number                                                                     // confidence [0..1]
+]
+```
+
+This is byte-for-byte the same shape `@qvac/ocr-onnx` returns.
+
+### Stats (when `opts.stats=true`)
+
+```ts
+{
+  totalTime: number,        // seconds
+  detectionTime: number,    // seconds (CRAFT inference)
+  recognitionTime: number,  // seconds (CRNN inference)
+  numBoxes: number          // total boxes (aligned + unaligned)
+}
+```
+
+## Models
+
+The addon consumes GGUF weight files. Each pipeline expects its own
+detector + recognizer pair:
+
+### EasyOCR pipeline (`pipelineType: 'easyocr'`)
+
+| GGUF | Role |
+|---|---|
+| `craft_mlt_25k.gguf` / `*_q8_0.gguf` / `*_q4_k.gguf` | CRAFT detector |
+| `english_g2.gguf` / `*_q8_0.gguf` / `*_q4_k.gguf` | English recognizer (gen-2) |
+| `latin_g2.gguf` | Latin-script recognizer (gen-2; fr/de/it/es/pt/…) |
+
+Use the converter in the upstream
+[`tetherto/easy-ocr-ggml`](https://github.com/tetherto/easy-ocr-ggml/blob/main/scripts/pth_to_gguf.py)
+repo (`scripts/pth_to_gguf.py`) to produce these from EasyOCR PyTorch
+`.pth` checkpoints.
+
+This first release ships the **gen-2 recognizer family only** (English /
+Latin). Other language groups (Arabic, Bengali, Cyrillic, Devanagari, CJK)
+will land as GGUFs are produced.
+
+### Doctr pipeline (`pipelineType: 'doctr'`)
+
+| GGUF | Role |
+|---|---|
+| `db_mobilenet_v3_large.gguf` | DBNet detector (MobileNetV3-Large backbone) |
+| `crnn_mobilenet_v3_small.gguf` | doctr recognizer (MobileNetV3-Small backbone) |
+
+Doctr is language-agnostic: it recognises any Latin-script text the
+underlying CRNN was trained on, so it ignores `langList`, `magRatio` and
+the contrast-retry / rotation knobs.
+
+### CI distribution
+
+CI pulls pinned snapshots of both the EasyOCR and Doctr GGUFs from S3
+(see [`.github/workflows/integration-test-ocr-ggml.yml`](../../.github/workflows/integration-test-ocr-ggml.yml))
+and exposes them to the integration suite via the
+`OCR_GGML_DETECTOR` + `OCR_GGML_RECOGNIZER` env vars (EasyOCR) and
+`OCR_GGML_DOCTR_DETECTOR` + `OCR_GGML_DOCTR_RECOGNIZER` env vars
+(Doctr). Both pipelines are exercised end-to-end on every PR.
+
+## CLI
+
+A development-time CLI ships at the package root, `ocr-ggml-cli`, modelled
+on `@qvac/translation-nmtcpp`'s `nmt-cli`. It is **not** included in the
+npm artifact (same convention as `nmt-cli`); run it directly from the
+repository checkout:
+
+```bash
+# Default: OCR samples/english.png with bundled English weights (easyocr)
+bare ocr-ggml-cli
+
+# Doctr pipeline (DBNet detector + doctr recognizer)
+bare ocr-ggml-cli --pipeline-type doctr \
+                  --detector models/db_mobilenet_v3_large.gguf \
+                  --recognizer models/crnn_mobilenet_v3_small.gguf \
+                  --image /tmp/photo.jpg
+
+# Detail mode (index + confidence + box per recognised line)
+bare ocr-ggml-cli --detail 1
+
+# JSON output (matches EasyOCR Python's readtext shape)
+bare ocr-ggml-cli --output-format json | jq .
+
+# Custom image + Q8_0 quantized EasyOCR models
+bare ocr-ggml-cli --image /tmp/photo.jpg \
+                  --detector models/craft_mlt_25k_q8_0.gguf \
+                  --recognizer models/english_g2_q8_0.gguf
+
+# Force a specific CPU thread count, with verbose C++ logs
+bare ocr-ggml-cli --n-threads 8 --verbose
+
+# Show help / version
+bare ocr-ggml-cli --help
+bare ocr-ggml-cli --version
+```
+
+The CLI is functionally equivalent to upstream `EasyOcr-ggml`'s `ocr-cli`
+binary — same flag surface (`--image`, `--detector`, `--recognizer`,
+`--lang`, `--paragraph`, `--mag-ratio`, `--detail`, `--output-format`,
+`--n-threads`) plus `--pipeline-type {easyocr,doctr}` for the second
+pipeline, and the `nmt-cli` ergonomics (env-var fallbacks
+`OCR_GGML_{IMAGE,DETECTOR,RECOGNIZER,PIPELINE_TYPE}`, `-h/--help`,
+`-v/--version`, `--verbose` for C++ log forwarding). One deliberate
+omission for v1: `--debug-png` (annotated overlay) — print boxes via
+`--detail 1` or `--output-format json` and render externally instead.
+
+## Scripts
+
+| Script | Purpose |
+|---|---|
+| [`scripts/check_ggml_backends.sh`](./scripts/check_ggml_backends.sh) | Probe shipped ggml backends + BLAS/Vulkan/OpenCL paths in `prebuilds/` |
+
+Full usage in [`scripts/README.md`](./scripts/README.md). For weight
+conversion (PyTorch `.pth` → GGUF), use the upstream converter in
+[`tetherto/easy-ocr-ggml`](https://github.com/tetherto/easy-ocr-ggml/blob/main/scripts/pth_to_gguf.py).
+
+## Testing
+
+```bash
+npm run lint
+npm run test:unit          # JS unit tests (no models required)
+npm run test:integration   # end-to-end smoke; soft-skips when models absent
+npm run test:cpp           # C++ GoogleTest (BUILD_TESTING=ON)
+```
+
+The integration smoke test reads the following env vars and runs each
+case only when the corresponding GGUFs are present on disk:
+
+| Env var | Pipeline | Required for which test |
+|---|---|---|
+| `OCR_GGML_DETECTOR` | EasyOCR | EasyOCR case |
+| `OCR_GGML_RECOGNIZER` | EasyOCR | EasyOCR case (CI uses `latin_g2.gguf`) |
+| `OCR_GGML_DOCTR_DETECTOR` | Doctr | Doctr case |
+| `OCR_GGML_DOCTR_RECOGNIZER` | Doctr | Doctr case |
+| `OCR_GGML_IMAGE` | — | overrides the default sample image |
+
+CI sets these automatically; locally you can:
+
+```bash
+OCR_GGML_DETECTOR=$PWD/models/craft_mlt_25k.gguf \
+OCR_GGML_RECOGNIZER=$PWD/models/latin_g2.gguf \
+npm run test:integration
+```
+
+## Repository layout
+
+```
+packages/ocr-ggml/
+├── package.json             # @qvac/ocr-ggml (bare addon)
+├── CMakeLists.txt           # bare_module(ocr-ggml), links ggml + opencv4
+├── vcpkg.json               # ggml from qvac-fabric, opencv4, inference-addon-cpp
+├── vcpkg-configuration.json
+├── vcpkg/                   # custom triplets + toolchains
+├── ocr-ggml-cli             # dev-time CLI (mirrors nmt-cli), not shipped to npm
+├── binding.js               # require.addon() entry
+├── index.js, index.d.ts     # public JS surface (OcrGgml class)
+├── ocr-ggml.js              # thin wrapper over the bare binding
+├── addonLogging.{js,d.ts}   # setLogger / releaseLogger surface
+├── lib/error.js             # QvacErrorAddonOcrGgml + ERR_CODES
+├── examples/quickstart.js   # JS code example
+├── samples/                 # sample fixture images (english.png, …)
+├── scripts/                 # check_ggml_backends.sh diagnostic
+├── test/{unit,integration}
+└── addon/src/
+    ├── js-interface/binding.cpp                  # BARE_MODULE entry
+    ├── addon/AddonJs.hpp                         # createInstance / runJob / output handler
+    ├── model-interface/
+    │   ├── OcrTypes.hpp                          # shared OcrInput/OcrConfig + PipelineMode enum
+    │   └── Pipeline.{hpp,cpp}                    # unified IModel adapter (EasyOCR + DocTR via mode)
+    ├── ggml/                                     # gguf_loader, ops, craft, crnn, weights (lifted)
+    ├── pipeline/                                 # lang, steps, step_* (EasyOCR; lifted)
+    ├── easyocr-ggml/                             # headers for the EasyOCR lifted code
+    └── doctr-ggml/                               # MobileNetGraph + DBNet/CRNN steps
+```
+
+## Provenance
+
+- **C++ pipeline + GGML graph code** lifted from
+  [`tetherto/easy-ocr-ggml`](https://github.com/tetherto/easy-ocr-ggml)
+  (Apache-2.0).
+- **Build / addon plumbing** modelled on
+  [`@qvac/translation-nmtcpp`](../translation-nmtcpp) (ggml from
+  `qvac-fabric`, `cmake-bare` + `cmake-vcpkg`, `inference-addon-cpp` base
+  classes).
+- **Public JS surface** modelled on
+  [`@qvac/ocr-onnx`](../ocr-onnx) so callers can swap engines transparently.
+
+## License
+
+Apache-2.0 (matches upstream EasyOCR, `EasyOcr-ggml`, `@qvac/ocr-onnx`, and
+`@qvac/translation-nmtcpp`).

package/addonLogging.d.ts

@@ -0,0 +1,7 @@
+export interface AddonLogging {
+  setLogger(callback: (priority: number, message: string) => void): void
+  releaseLogger(): void
+}
+
+declare const addonLogging: AddonLogging
+export default addonLogging

package/addonLogging.js

@@ -0,0 +1,4 @@
+module.exports = {
+  get setLogger () { return require('./binding').setLogger },
+  get releaseLogger () { return require('./binding').releaseLogger }
+}

package/binding.js

@@ -0,0 +1,21 @@
+'use strict'
+
+try {
+  module.exports = require.addon()
+} catch (e) {
+  const c = e && e.cause
+  console.log('[OCR-DLOPEN-DEBUG] error:', e && e.message)
+  console.log('[OCR-DLOPEN-DEBUG] error.code:', e && e.code)
+  console.log('[OCR-DLOPEN-DEBUG] cause:', c)
+  console.log('[OCR-DLOPEN-DEBUG] cause.message:', c && c.message)
+  console.log('[OCR-DLOPEN-DEBUG] cause.code:', c && c.code)
+  console.log('[OCR-DLOPEN-DEBUG] cause.errno:', c && c.errno)
+  console.log('[OCR-DLOPEN-DEBUG] cause.path:', c && c.path)
+  console.log('[OCR-DLOPEN-DEBUG] cause.syscall:', c && c.syscall)
+  console.log('[OCR-DLOPEN-DEBUG] cause.stack:', c && c.stack)
+  try {
+    console.log('[OCR-DLOPEN-DEBUG] cause.keys:', c && Object.getOwnPropertyNames(c))
+    console.log('[OCR-DLOPEN-DEBUG] cause.JSON:', c && JSON.stringify(c, Object.getOwnPropertyNames(c)))
+  } catch (_) {}
+  throw e
+}