# dqh147258/facerecognition architecture

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

- Interactive diagram: https://gitdiagram.com/dqh147258/facerecognition
- Repository: https://github.com/dqh147258/facerecognition

## Overview

##### Project type and purpose
- This is a mobile face-recognition authentication sample for Android, composed of two Gradle modules:
- “app” – a reference Android application (Activities, layouts, camera UI).
- “facerecognition” – a Kotlin/Android library implementing the ML face-recognition engine (uses TensorFlow Lite).
- The README confirms the goal: “Face recognition for authentication (1:1)”.

##### File structure
- Top-level modules:
- app/
– UI Activities under src/main/java (MainActivity, AddFaceActivity, FaceRecognitionActivity)
– Android resources (layouts, drawables, themes)
– Tests under src/androidTest and src/test
- facerecognition/
– Core classes: FaceRecognition.kt, FaceModelManager.kt
– Processor subpackage (chain of pipeline handlers for detection, alignment, comparison, etc.)
– tflite subpackage (TensorFlowLiteAnalyzer)
– model & util subpackages
– assets (mobile_face_net.tflite)
– Tests under src/androidTest and src/test
- Build scripts: build.gradle in each module, settings.gradle, wrapper under gradle/, proguard rules.

##### README
- Confirms 1:1 face-recognition focus, no server side. All processing happens on device with the .tflite model.

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Android Framework"
        Camera["Camera (Camera2/CameraX)"]:::framework
    end

    subgraph "App Module (app)"
        MA["MainActivity"]:::frontend
        AFA["AddFaceActivity"]:::frontend
        FRA["FaceRecognitionActivity"]:::frontend
    end

    subgraph "FaceRecognition Library (facerecognition)"
        FR["FaceRecognition API"]:::backend
        FM["FaceModelManager"]:::backend
        TFL["TensorFlowLiteAnalyzer"]:::backend

        subgraph "Pipeline (Chain of Responsibility)"
            FP["FaceProcessor"]:::backend
            H1["FacePipelineHandler"]:::backend
            H2["FaceRectPipelineHandler"]:::backend
            H3["LandMarkPipelineHandler"]:::backend
            H4["AngleZPipelineHandler"]:::backend
            H5["RangePipelineHandler"]:::backend
            H6["LivePipelineHandler"]:::backend
            H7["WinkPipelineHandler"]:::backend
            H8["HintPipelineHandler"]:::backend
            H9["FaceComparePipelineHandler"]:::backend
            H10["AddRecentFaceInfoPipelineHandler"]:::backend
            H11["SaveToPngPipelineHandler"]:::backend
            H12["FaceTrackingPipeHandler"]:::backend

            H1 --> H2 --> H3 --> H4 --> H5 --> H6 --> H7 --> H8 --> H9 --> H10 --> H11 --> H12
        end

        UTIL["FaceRecognitionUtil"]:::util
        Asset["mobile_face_net.tflite"]:::asset
        Info["FaceInfo"]:::data
        Model["FaceModel"]:::data
    end

    Camera --> MA
    Camera --> AFA
    Camera --> FRA

    MA -->|"enroll/authenticate"| FR
    AFA --> FR
    FRA --> FR

    FR --> FP
    FP --> FM
    FM --> Asset
    FM --> TFL
    TFL --> H1

    H12 -->|"result callback"| FRA
    H12 --> MA
    H12 --> AFA

    click MA "https://github.com/dqh147258/facerecognition/blob/master/app/src/main/java/com/yxf/facerecognitionsample/MainActivity.kt"
    click AFA "https://github.com/dqh147258/facerecognition/blob/master/app/src/main/java/com/yxf/facerecognitionsample/AddFaceActivity.kt"
    click FRA "https://github.com/dqh147258/facerecognition/blob/master/app/src/main/java/com/yxf/facerecognitionsample/FaceRecognitionActivity.kt"
    click FR "https://github.com/dqh147258/facerecognition/blob/master/facerecognition/src/main/java/com/yxf/facerecognition/FaceRecognition.kt"
    click FM "https://github.com/dqh147258/facerecognition/blob/master/facerecognition/src/main/java/com/yxf/facerecognition/FaceModelManager.kt"
    click TFL "https://github.com/dqh147258/facerecognition/blob/master/facerecognition/src/main/java/com/yxf/facerecognition/tflite/TensorFlowLiteAnalyzer.kt"
    click FP "https://github.com/dqh147258/facerecognition/blob/master/facerecognition/src/main/java/com/yxf/facerecognition/processor/FaceProcessor.kt"
    click H1 "https://github.com/dqh147258/facerecognition/blob/master/facerecognition/src/main/java/com/yxf/facerecognition/processor/FacePipelineHandler.kt"
    click H2 "https://github.com/dqh147258/facerecognition/blob/master/facerecognition/src/main/java/com/yxf/facerecognition/processor/FaceRectPipelineHandler.kt"
    click H3 "https://github.com/dqh147258/facerecognition/blob/master/facerecognition/src/main/java/com/yxf/facerecognition/processor/LandMarkPipelineHandler.kt"
    click H4 "https://github.com/dqh147258/facerecognition/blob/master/facerecognition/src/main/java/com/yxf/facerecognition/processor/AngleZPipelineHandler.kt"
    click H5 "https://github.com/dqh147258/facerecognition/blob/master/facerecognition/src/main/java/com/yxf/facerecognition/processor/RangePipelineHandler.kt"
    click H6 "https://github.com/dqh147258/facerecognition/blob/master/facerecognition/src/main/java/com/yxf/facerecognition/processor/LivePipelineHandler.kt"
    click H7 "https://github.com/dqh147258/facerecognition/blob/master/facerecognition/src/main/java/com/yxf/facerecognition/processor/WinkPipelineHandler.kt"
    click H8 "https://github.com/dqh147258/facerecognition/blob/master/facerecognition/src/main/java/com/yxf/facerecognition/processor/HintPipelineHandler.kt"
    click H9 "https://github.com/dqh147258/facerecognition/blob/master/facerecognition/src/main/java/com/yxf/facerecognition/processor/FaceComparePipelineHandler.kt"
    click H10 "https://github.com/dqh147258/facerecognition/blob/master/facerecognition/src/main/java/com/yxf/facerecognition/processor/AddRecentFaceInfoPipelineHandler.kt"
    click H11 "https://github.com/dqh147258/facerecognition/blob/master/facerecognition/src/main/java/com/yxf/facerecognition/processor/SaveToPngPipelineHandler.kt"
    click H12 "https://github.com/dqh147258/facerecognition/blob/master/facerecognition/src/main/java/com/yxf/facerecognition/processor/FaceTrackingPipeHandler.kt"
    click UTIL "https://github.com/dqh147258/facerecognition/blob/master/facerecognition/src/main/java/com/yxf/facerecognition/util/FaceRecognitionUtil.kt"
    click Asset "https://github.com/dqh147258/facerecognition/blob/master/facerecognition/src/main/assets/mobile_face_net.tflite"
    click Info "https://github.com/dqh147258/facerecognition/blob/master/facerecognition/src/main/java/com/yxf/facerecognition/model/FaceInfo.kt"
    click Model "https://github.com/dqh147258/facerecognition/blob/master/facerecognition/src/main/java/com/yxf/facerecognition/model/FaceModel.kt"

    classDef framework fill:#f0f0f0,stroke:#333,stroke-width:1px
    classDef frontend fill:#cce5ff,stroke:#333,stroke-width:1px
    classDef backend fill:#d4edda,stroke:#333,stroke-width:1px
    classDef util fill:#ffe5b4,stroke:#333,stroke-width:1px
    classDef asset fill:#fff3cd,stroke:#333,stroke-width:1px,stroke-dasharray: 5, 5
    classDef data fill:#f8d7da,stroke:#333,stroke-width:1px
```
