# dm77/barcodescanner architecture

> Architecture diagram of the GitHub repository dm77/barcodescanner, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-16). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/dm77/barcodescanner
- Repository: https://github.com/dm77/barcodescanner

## Overview

##### Project Overview
This is an Android library project that provides barcode scanning functionality using two different scanning engines: ZXing and ZBar. The project is structured as a multi-module Android library with core functionality and two separate implementations.

##### Main Components

A. Core Module (Base Layer):
- Camera handling components (CameraPreview, CameraHandlerThread)
- Base scanner view (BarcodeScannerView)
- View finder interface (IViewFinder)

B. Scanner Implementations (Middle Layer):
1. ZXing Module:
- ZXingScannerView
- ZXing processing engine
2. ZBar Module:
- ZBarScannerView
- ZBar native libraries (JNI)

C. Sample Applications (Top Layer):
- ZXing Sample App
- ZBar Sample App

**Rectangle: Modules**
**Rounded Rectangle: Components**
**Hexagon: Native Libraries**

##### Component Relationships

A. Vertical Relationships:
- Core → Scanner Implementations (inheritance)
- Scanner Implementations → Sample Apps (usage)

B. Horizontal Relationships:
- Camera Preview → Scanner View
- Native Libraries → Scanner Implementation
- UI Components → Scanner View

##### Key Technical Elements to Highlight

A. Camera Layer:
- Camera Preview
- Frame Processing
- Handler Thread

B. Processing Layer:
- Barcode Format Handling
- Native Code Integration
- Result Processing

C. UI Layer:
- View Finder
- Scanner View
- Activity/Fragment Integration

##### Top Layer: Sample Applications

Specific technical details:
- Camera preview data flow
- Frame processing pipeline
- Result handling callbacks
- UI component hierarchy

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Styles and Classes
    classDef core fill:#b3d1ff,stroke:#333,stroke-width:2px
    classDef zxing fill:#90EE90,stroke:#333,stroke-width:2px
    classDef zbar fill:#FFB366,stroke:#333,stroke-width:2px
    classDef sample fill:#E0E0E0,stroke:#333,stroke-width:2px
    classDef native fill:#FF9999,stroke:#333,stroke-width:2px

    %% Core Layer
    subgraph CoreLayer["Core Components"]
        CameraPreview["Camera Preview"]:::core
        CameraHandler["Camera Handler Thread"]:::core
        CameraUtils["Camera Utilities"]:::core
        BaseScannerView["Base Scanner View"]:::core
        ViewFinder["View Finder Interface"]:::core
        ViewFinderImpl["View Finder Implementation"]:::core
    end

    %% Scanner Implementations Layer
    subgraph ScannerLayer["Scanner Implementations"]
        %% ZXing Implementation
        ZXingScanner["ZXing Scanner View"]:::zxing
        ZXingEngine["ZXing Processing Engine"]:::zxing

        %% ZBar Implementation
        ZBarScanner["ZBar Scanner View"]:::zbar
        ZBarEngine["ZBar Processing Engine"]:::zbar
        ZBarNative["ZBar Native Libraries"]:::native
    end

    %% Sample Applications Layer
    subgraph SampleLayer["Sample Applications"]
        ZXingSample["ZXing Sample App"]:::sample
        ZBarSample["ZBar Sample App"]:::sample
    end

    %% Relationships
    CameraPreview --> BaseScannerView
    CameraHandler --> CameraPreview
    CameraUtils --> CameraPreview
    ViewFinder --> BaseScannerView
    ViewFinderImpl --> ViewFinder

    BaseScannerView --> ZXingScanner
    BaseScannerView --> ZBarScanner
    
    ZBarNative --> ZBarEngine
    ZBarEngine --> ZBarScanner
    ZXingEngine --> ZXingScanner

    ZXingScanner --> ZXingSample
    ZBarScanner --> ZBarSample

    %% Click Events
    click CameraPreview "https://github.com/dm77/barcodescanner/blob/master/core/src/main/java/me/dm7/barcodescanner/core/CameraPreview.java"
    click CameraHandler "https://github.com/dm77/barcodescanner/blob/master/core/src/main/java/me/dm7/barcodescanner/core/CameraHandlerThread.java"
    click CameraUtils "https://github.com/dm77/barcodescanner/blob/master/core/src/main/java/me/dm7/barcodescanner/core/CameraUtils.java"
    click BaseScannerView "https://github.com/dm77/barcodescanner/blob/master/core/src/main/java/me/dm7/barcodescanner/core/BarcodeScannerView.java"
    click ViewFinder "https://github.com/dm77/barcodescanner/blob/master/core/src/main/java/me/dm7/barcodescanner/core/IViewFinder.java"
    click ViewFinderImpl "https://github.com/dm77/barcodescanner/blob/master/core/src/main/java/me/dm7/barcodescanner/core/ViewFinderView.java"
    click ZXingScanner "https://github.com/dm77/barcodescanner/blob/master/zxing/src/main/java/me/dm7/barcodescanner/zxing/ZXingScannerView.java"
    click ZBarScanner "https://github.com/dm77/barcodescanner/blob/master/zbar/src/main/java/me/dm7/barcodescanner/zbar/ZBarScannerView.java"
    click ZBarNative "https://github.com/dm77/barcodescanner/tree/master/zbar/src/main/jniLibs/"
    click ZXingSample "https://github.com/dm77/barcodescanner/tree/master/zxing-sample/src/main/java/me/dm7/barcodescanner/zxing/sample/"
    click ZBarSample "https://github.com/dm77/barcodescanner/tree/master/zbar-sample/src/main/java/me/dm7/barcodescanner/zbar/sample/"

    %% Legend
    subgraph Legend
        CoreComp["Core Component"]:::core
        ZXingComp["ZXing Component"]:::zxing
        ZBarComp["ZBar Component"]:::zbar
        NativeComp["Native Library"]:::native
        SampleComp["Sample Application"]:::sample
    end
```
