# mgcrea/vision-camera-barcode-scanner architecture

> Architecture diagram of the GitHub repository mgcrea/vision-camera-barcode-scanner, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/mgcrea/vision-camera-barcode-scanner
- Repository: https://github.com/mgcrea/vision-camera-barcode-scanner

## Overview

##### Project Type and Purpose
- This is an open-source React Native library (“vision-camera-barcode-scanner”) that provides a high-performance barcode scanner for mobile apps.
- It leverages the React Native Vision Camera’s frame-processor plugin system and native SDKs (Google ML Kit on Android, Apple Vision on iOS) to detect barcodes at up to 30 fps.
- The project ships:
- A TypeScript/JS core (in `src/`) exposing hooks and components (`useBarcodeScanner`, `CameraHighlights`).
- Native modules in `android/src/...` and `ios/` implementing the frame processor.
- An `example/` React Native app demonstrating usage.

##### Analyzing the File Structure
- Top-level directories:
- `src/`: JS/TS source code (components, hooks, constants, types, utils).
- `android/`: Native Android plugin module (Java classes mapping barcodes, exposing R-N module).
- `ios/`: Native iOS plugin (Objective-C code registering `VisionCameraCodeScanner`).
- `example/`: Full React Native app illustrating integration on both platforms.
- `test/`, configs (`.eslintrc`, `tsconfig.json`), CI workflows, and packaging (`podspec`, `package.json`).
- Pattern: a hybrid architecture where the JS layer dispatches camera frames to a native worklet plugin, which executes heavy computation via platform SDKs, returning results to the JS/UI layer.

##### Key Insights from the README
- Core dependencies:
- `react-native-vision-camera` (camera + frame-processor API)
- `react-native-worklets-core` (enables JS worklets on UI thread)
- Features: hooks-based API, customizable FPS, selective barcode formats.
- Native implementations: Google ML Kit (Android) and Apple’s Vision framework (iOS).

##### Details to Capture
- Explicitly note the hook’s config parameters (`fps`, `barcodeTypes`) flowing into the native plugin.
- Shared `CameraHighlights` component consuming output.
- Separate Android/iOS paths converging to the same JS callback (`onBarcodeScanned`).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Example App Layer
    subgraph "Example App" 
        direction TB
        EA1["Entry Point\n(example/index.js)"]:::example
        EA2["Main App Component\n(example/src/App.tsx)"]:::example
        EA3["BarcodeScannerHookExamplePage\n(example/src/pages/BarcodeScannerHookExamplePage.tsx)"]:::example
        EA4["VisonCameraCodeScannerExamplePage\n(example/src/pages/VisonCameraCodeScannerExamplePage.tsx)"]:::example
        EA5["CameraOverlay\n(example/src/components/CameraOverlay.tsx)"]:::example
    end

    %% JS Core Library Layer
    subgraph "JS Core Library"
        direction TB
        JS1["useBarcodeScanner Hook\n(src/hooks/useBarcodeScanner.ts)"]:::js
        JS2["CameraHighlights Component\n(src/components/CameraHighlights.tsx)"]:::js
        JS3["Main Entry\n(src/index.ts)"]:::js
        JS4["Frame Processor Registration\n(src/module.ts)"]:::js
    end

    %% React Native Framework Layer
    subgraph "React Native Framework"
        direction TB
        RN1["<Camera> Component\n(react-native-vision-camera)"]:::rn
        RN2["Worklets Core Engine\n(react-native-worklets-core)"]:::rn
    end

    %% Native Plugin Modules
    subgraph "Native Plugin Modules"
        direction TB
        subgraph "Android Plugin" 
            direction TB
            A1["VisionCameraCodeScannerModule\n(android/src/.../VisionCameraCodeScannerModule.java)"]:::native
            A2["CodeScannerProcessorPlugin\n(android/src/.../CodeScannerProcessorPlugin.java)"]:::native
            A3["BarcodeConverter\n(android/src/.../BarcodeConverter.java)"]:::native
            A4["BarcodeFormatMapper\n(android/src/.../BarcodeFormatMapper.java)"]:::native
        end
        subgraph "iOS Plugin"
            direction TB
            I1["VisionCameraCodeScanner\n(ios/VisionCameraCodeScanner.h/.m)"]:::native
            I2["CodeScannerProcessorPlugin\n(ios/CodeScannerProcessorPlugin.h/.m)"]:::native
        end
    end

    %% Platform SDKs
    subgraph "Platform SDKs"
        direction TB
        SDK1["Google ML Kit\n(Barcode API)"]:::sdk
        SDK2["Apple Vision\n(VNDetectBarcodesRequest)"]:::sdk
    end

    %% Connections
    EA1 --> EA2
    EA2 --> EA3
    EA2 --> EA4
    EA2 --> EA5

    EA3 -->|"calls useBarcodeScanner"| JS1
    EA4 -->|"calls useBarcodeScanner"| JS1

    JS1 -->|"register plugin"| JS4
    JS4 -->|"provides frame processor"| RN1

    RN1 -->|"stream frames"| RN2
    RN2 -->|"dispatch frames"| A2
    RN2 -->|"dispatch frames"| I2

    A2 -->|"detectBarcodes"| SDK1
    SDK1 -->|"return results"| A2
    A2 -->|"convert data"| A3
    A3 -->|"map formats"| A4
    A4 -->|"return results"| RN2

    I2 -->|"detectBarcodes"| SDK2
    SDK2 -->|"return results"| I2
    I2 -->|"return results"| RN2

    RN2 -->|"onBarcodeScanned"| JS1
    JS1 -->|"updates highlights"| JS2
    EA3 -->|"renders highlights"| JS2
    EA4 -->|"renders highlights"| JS2

    %% Click Events
    click EA1 "https://github.com/mgcrea/vision-camera-barcode-scanner/blob/master/example/index.js"
    click EA2 "https://github.com/mgcrea/vision-camera-barcode-scanner/blob/master/example/src/App.tsx"
    click EA3 "https://github.com/mgcrea/vision-camera-barcode-scanner/blob/master/example/src/pages/BarcodeScannerHookExamplePage.tsx"
    click EA4 "https://github.com/mgcrea/vision-camera-barcode-scanner/blob/master/example/src/pages/VisonCameraCodeScannerExamplePage.tsx"
    click EA5 "https://github.com/mgcrea/vision-camera-barcode-scanner/blob/master/example/src/components/CameraOverlay.tsx"
    click JS1 "https://github.com/mgcrea/vision-camera-barcode-scanner/blob/master/src/hooks/useBarcodeScanner.ts"
    click JS2 "https://github.com/mgcrea/vision-camera-barcode-scanner/blob/master/src/components/CameraHighlights.tsx"
    click JS3 "https://github.com/mgcrea/vision-camera-barcode-scanner/blob/master/src/index.ts"
    click JS4 "https://github.com/mgcrea/vision-camera-barcode-scanner/blob/master/src/module.ts"
    click A1 "https://github.com/mgcrea/vision-camera-barcode-scanner/blob/master/android/src/main/java/com/visioncameracodescanner/VisionCameraCodeScannerModule.java"
    click A2 "https://github.com/mgcrea/vision-camera-barcode-scanner/blob/master/android/src/main/java/com/visioncameracodescanner/CodeScannerProcessorPlugin.java"
    click A3 "https://github.com/mgcrea/vision-camera-barcode-scanner/blob/master/android/src/main/java/com/visioncameracodescanner/BarcodeConverter.java"
    click A4 "https://github.com/mgcrea/vision-camera-barcode-scanner/blob/master/android/src/main/java/com/visioncameracodescanner/BarcodeFormatMapper.java"
    click I1 "https://github.com/mgcrea/vision-camera-barcode-scanner/blob/master/ios/VisionCameraCodeScanner.h"
    click I1 "https://github.com/mgcrea/vision-camera-barcode-scanner/blob/master/ios/VisionCameraCodeScanner.m"
    click I2 "https://github.com/mgcrea/vision-camera-barcode-scanner/blob/master/ios/CodeScannerProcessorPlugin.h"
    click I2 "https://github.com/mgcrea/vision-camera-barcode-scanner/blob/master/ios/CodeScannerProcessorPlugin.m"

    %% Styles
    classDef example fill:#e5ccff,stroke:#a583c1
    classDef js fill:#ccffcc,stroke:#3c9d21
    classDef rn fill:#cce5ff,stroke:#2176c2
    classDef native fill:#ffe5cc,stroke:#d66f17
    classDef sdk fill:#ffcccc,stroke:#c72c41
```
