# miniailive/facerecognition-livenessdetection-android architecture

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

- Interactive diagram: https://gitdiagram.com/miniailive/facerecognition-livenessdetection-android
- Repository: https://github.com/miniailive/facerecognition-livenessdetection-android

## Overview

##### Main Components of the System
- User Interface (UI) Layer:
- Activities such as CameraActivity, MainActivity, AboutActivity, IdentifyActivity, SplashActivity, etc.
- Layout XML files in the res/layout folder that define the UI screens.

- Face Recognition and Liveness Detection Engine:
- Core face recognition logic is implemented in classes like FrameAnalyser, FrameInterface, BitmapUtils, and BoundingBoxOverlay.
- External native/core functionality is packaged in the AAR library (miniai_face.aar under app/libs) that encapsulates the complex algorithms.

- Camera and Image Processing Module:
- CameraActivity provides the entry point for capturing images.
- Utilities such as ImageRotator and other transformation services.

- Data Management:
- User data handling through files like UserDB.java, UserInfo.java, and adapter components like UsersAdapter.java.

- Testing and Quality Assurance:
- Instrumented tests under app/src/androidTest.
- Unit tests under app/src/test.

- Build and Configuration System:
- Gradle build files (build.gradle, settings.gradle, gradle.properties) and proguard configuration (proguard-rules.pro).
- Project configuration folders (.idea, .gitignore) that define environment and versioning settings.

##### Relationships and Interactions
- UI components (Activities) serve as the entry point where user interactions trigger camera capture, face recognition, and liveness checks.
- Activities and fragments connect to business logic classes (like FrameAnalyser) for real-time image processing.
- Utility classes (e.g., BitmapUtils, BoundingBoxOverlay) perform pre/post-processing before passing images and results between the UI and core processing layers.
- Data managers (UserDB and related classes) persist and retrieve user data as needed.
- Tests are separated but interact with various components (UI, business logic) to ensure correct operation.

##### Architectural Patterns and Design Principles
- Layered Architecture: Clearly separate UI, core processing (face recognition & liveness detection), and data persistence.
- Modularity: Each activity focuses on a distinct function (enrollment, identification, liveness testing, etc.), enabling a plug-and-play modular design.
- Use of External Libraries: The integration of the precompiled miniai_face.aar helps encapsulate complex AI functionalities, easing maintenance.
- Platform Conventions: Follows Android’s standard project organization (src/main, src/test, etc.) and build tooling (Gradle).

##### Technologies, Frameworks, and Libraries
- Android SDK & Kotlin/Java for application logic.
- Gradle for build automation.
- External AAR (miniai_face.aar) containing face recognition and liveness detection algorithms.
- Standard Android components (Activities, Layouts, Resources) and possible compatibility libraries for UI.
- Testing frameworks provided by Android for both unit and instrumented tests.

## Diagram (Mermaid)

```mermaid
graph TD
    %% UI Layer
    subgraph "UI Layer"
        A1["CameraActivity"]:::ui
        A2["MainActivity"]:::ui
        A3["AboutActivity"]:::ui
        A4["IdentifyActivity"]:::ui
        A5["SplashActivity"]:::ui
        A6["InitialActivity"]:::ui
        A7["LearnMoreActivity"]:::ui
        A8["LivenessTestActivity"]:::ui
        A9["ResultActivity"]:::ui
        A10["UserActivity"]:::ui
        L["Layouts"]:::ui
    end

    %% Processing Layer
    subgraph "Processing Layer"
        P1["FrameAnalyser"]:::processing
        P2["FrameInterface"]:::processing
        P3["BitmapUtils"]:::processing
        P4["BoundingBoxOverlay"]:::processing
        EX["miniai_face.aar"]:::external
        IR["ImageRotator"]:::processing
    end

    %% Data Management
    subgraph "Data Management"
        D1["UserDB"]:::data
        D2["UserInfo"]:::data
        D3["UsersAdapter"]:::data
    end

    %% Testing
    subgraph "Testing"
        T1["InstrumentedTests"]:::test
        T2["UnitTests"]:::test
    end

    %% Build and Configuration
    subgraph "Build & Config"
        B1["Build & Config Files"]:::config
    end

    %% Connections from UI Layer to Processing Layer
    A1 -->|"capture"| IR
    IR  -->|"rotate"| P1
    A4 -->|"process"| P1
    A8 -->|"liveness"| P1

    %% Processing Layer interactions
    P1 -->|"analyze"| EX
    P1 -->|"storeResult"| D1

    %% Testing interactions
    T1 -->|"validate"| A1
    T2 -->|"check"| P1

    %% Build/Config dependencies
    B1 -->|"build"| A1
    B1 -->|"build"| P1

    %% Styles
    classDef ui fill:#f9f,stroke:#333,stroke-width:2px;
    classDef processing fill:#bbf,stroke:#333,stroke-width:2px;
    classDef external fill:#aaf,stroke:#333,stroke-width:2px;
    classDef data fill:#cff,stroke:#333,stroke-width:2px;
    classDef test fill:#efe,stroke:#333,stroke-width:2px;
    classDef config fill:#ffc,stroke:#333,stroke-width:2px;

    %% Click Events for UI Layer
    click A1 "https://github.com/miniailive/facerecognition-livenessdetection-android/blob/main/app/src/main/java/com/miniai/facerecognition/CameraActivity.kt"
    click A2 "https://github.com/miniailive/facerecognition-livenessdetection-android/blob/main/app/src/main/java/com/miniai/facerecognition/MainActivity.kt"
    click A3 "https://github.com/miniailive/facerecognition-livenessdetection-android/blob/main/app/src/main/java/com/miniai/facerecognition/AboutActivity.kt"
    click A4 "https://github.com/miniailive/facerecognition-livenessdetection-android/blob/main/app/src/main/java/com/miniai/facerecognition/IdentifyActivity.kt"
    click A5 "https://github.com/miniailive/facerecognition-livenessdetection-android/blob/main/app/src/main/java/com/miniai/facerecognition/SplashActivity.kt"
    click A6 "https://github.com/miniailive/facerecognition-livenessdetection-android/blob/main/app/src/main/java/com/miniai/facerecognition/InitialActivity.kt"
    click A7 "https://github.com/miniailive/facerecognition-livenessdetection-android/blob/main/app/src/main/java/com/miniai/facerecognition/LearnMoreActivity.kt"
    click A8 "https://github.com/miniailive/facerecognition-livenessdetection-android/blob/main/app/src/main/java/com/miniai/facerecognition/LivenessTestActivity.kt"
    click A9 "https://github.com/miniailive/facerecognition-livenessdetection-android/blob/main/app/src/main/java/com/miniai/facerecognition/ResultActivity.kt"
    click A10 "https://github.com/miniailive/facerecognition-livenessdetection-android/blob/main/app/src/main/java/com/miniai/facerecognition/UserActivity.kt"
    click L "https://github.com/miniailive/facerecognition-livenessdetection-android/tree/main/app/src/main/res/layout"

    %% Click Events for Processing Layer
    click P1 "https://github.com/miniailive/facerecognition-livenessdetection-android/blob/main/app/src/main/java/com/miniai/facerecognition/FrameAnalyser.kt"
    click P2 "https://github.com/miniailive/facerecognition-livenessdetection-android/blob/main/app/src/main/java/com/miniai/facerecognition/FrameInferface.kt"
    click P3 "https://github.com/miniailive/facerecognition-livenessdetection-android/blob/main/app/src/main/java/com/miniai/facerecognition/BitmapUtils.kt"
    click P4 "https://github.com/miniailive/facerecognition-livenessdetection-android/blob/main/app/src/main/java/com/miniai/facerecognition/BoundingBoxOverlay.kt"
    click EX "https://github.com/miniailive/facerecognition-livenessdetection-android/blob/main/app/libs/miniai_face.aar"
    click IR "https://github.com/miniailive/facerecognition-livenessdetection-android/blob/main/app/src/main/java/com/miniai/facerecognition/ImageRotator.java"

    %% Click Events for Data Management
    click D1 "https://github.com/miniailive/facerecognition-livenessdetection-android/blob/main/app/src/main/java/com/miniai/facerecognition/UserDB.java"
    click D2 "https://github.com/miniailive/facerecognition-livenessdetection-android/blob/main/app/src/main/java/com/miniai/facerecognition/UserInfo.java"
    click D3 "https://github.com/miniailive/facerecognition-livenessdetection-android/blob/main/app/src/main/java/com/miniai/facerecognition/UsersAdapter.java"

    %% Click Events for Testing
    click T1 "https://github.com/miniailive/facerecognition-livenessdetection-android/blob/main/app/src/androidTest/java/com/miniai/facerecognition/ExampleInstrumentedTest.java"
    click T2 "https://github.com/miniailive/facerecognition-livenessdetection-android/blob/main/app/src/test/java/com/miniai/facerecognition/ExampleUnitTest.java"

    %% Click Event for Build & Config
    click B1 "https://github.com/miniailive/facerecognition-livenessdetection-android/blob/main/app/build.gradle"
```
