# myzel394/alibi architecture

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

- Interactive diagram: https://gitdiagram.com/myzel394/alibi
- Repository: https://github.com/myzel394/alibi

## Overview

##### Project type and purpose
- Mobile, offline-first Android application
- Core feature: continuous circular buffering of audio & video
- Exposes UI (Jetpack Compose) for configuration, preview, and saving clips
- Background recording implemented as Android Services

##### Main architectural layers & components
1. Presentation Layer (UI)
– MainActivity + Jetpack Compose screens & Navigation
– UI components organized by feature (RecorderScreen, SettingsScreen, etc.)
– ViewModels / Models: AudioRecorderModel, VideoRecorderModel, BaseRecorderModel
2. Domain / Business Logic
– RecorderService, AudioRecorderService, VideoRecorderService, IntervalRecorderService
– Helpers: MediaConverter, BatchesFolder (AudioBatchesFolder & VideoBatchesFolder), Doctor, AppLockHelper
– Notification helpers: NotificationHelper, RecorderNotificationHelper
3. Data Layer
– AppSettings persisted via custom serializer (AppSettingsSerializer) into a local file or DataStore
– File System storage: circular buffer folders on device (managed by BatchesFolder classes)
– SQLite or DataStore for settings (AppSettings.kt)
4. Platform / OS
– Android OS: MediaRecorder / Camera2 / AudioRecord APIs
– BroadcastReceiver (LocalChangeReceiver) for detecting system changes (e.g., storage availability)
– Notification channels for foreground service compliance

##### Relationships & interactions
- UI → Domain: user taps “Start”, UI sends an Intent or ViewModel call to start the appropriate RecorderService
- Domain → Storage: RecorderService writes media chunks into rotating batch folders (AudioBatchesFolder, VideoBatchesFolder)
- Domain → Notification: RecorderNotificationHelper updates the foreground service notification with recording status
- UI / Settings → Data Layer: reading/writing AppSettings via AppSettingsSerializer
- BroadcastReceiver → Domain / UI: LocalChangeReceiver listens for storage changes and forwards events to UI or service
- Save-on-demand flow: UI triggers “save last 30 min” → Domain logic copies files from batch folders to user’s export directory via MediaConverter

##### Architectural patterns & design principles
- Layered separation (Presentation / Domain / Data / Platform)
- MVVM-style organization (Models + UI composables)
- Dependency inversion (services interact via interfaces/helpers)
- Single responsibility (each folder/helper/service has one focused role)
- Resource management pattern: circular file buffer to bound storage

##### Technologies & frameworks
- Kotlin + Android SDK
- Jetpack Compose (UI, Navigation)
- Android Services + BroadcastReceiver
- Local file I/O (batch folders) & local persistence (DataStore or custom serialization)
- fastlane & GitHub Actions (CI/CD – you may show this as a side note or deployment pipeline if desired)

##### Essential elements
- Clear, human-readable labels on each component
- A note on retention policy: “keep last N minutes, purge older files”

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Presentation Layer
    subgraph "Presentation Layer"
        direction TB
        MainActivity["MainActivity"]:::frontend
        Navigation["Navigation (NavGraph)"]:::frontend
        WelcomeScreen["WelcomeScreen"]:::frontend
        RecorderScreen["RecorderScreen"]:::frontend
        SettingsScreen["SettingsScreen"]:::frontend
        AboutScreen["AboutScreen"]:::frontend
        CustomNotificationsScreen["CustomRecordingNotificationsScreen"]:::frontend
        BaseRecorderModel["BaseRecorderModel"]:::frontend
        AudioRecorderModel["AudioRecorderModel"]:::frontend
        VideoRecorderModel["VideoRecorderModel"]:::frontend
    end

    %% Domain Layer
    subgraph "Domain Layer"
        direction TB
        RecorderService["RecorderService"]:::domain
        AudioRecorderService["AudioRecorderService"]:::domain
        VideoRecorderService["VideoRecorderService"]:::domain
        IntervalRecorderService["IntervalRecorderService"]:::domain
        RecorderNotificationHelper["RecorderNotificationHelper"]:::domain
        LocalChangeReceiver["LocalChangeReceiver"]:::domain
        BatchesFolder["BatchesFolder"]:::domain
        AudioBatchesFolder["AudioBatchesFolder"]:::domain
        VideoBatchesFolder["VideoBatchesFolder"]:::domain
        MediaConverter["MediaConverter"]:::domain
        Doctor["Doctor"]:::domain
        AppLockHelper["AppLockHelper"]:::domain
        NotificationHelper["NotificationHelper"]:::domain
    end

    %% Data Layer
    subgraph "Data Layer"
        direction TB
        AppSettings["AppSettings"]:::data
        AppSettingsSerializer["AppSettingsSerializer"]:::data
        Constants["Constants"]:::data
        RecorderState["RecorderState"]:::data
    end

    %% Platform Layer
    subgraph "Platform / OS"
        direction TB
        AndroidOS["AndroidOS APIs\n(MediaRecorder/Camera2/AudioRecord)"]:::platform
        AndroidManifest["AndroidManifest.xml"]:::platform
        BackupRules["backup_rules.xml\n& data_extraction_rules.xml"]:::platform
        NotificationChannel["NotificationChannel"]:::platform
    end

    %% CI/CD
    subgraph "CI/CD"
        direction TB
        GitHubActions["GitHub Actions\nyml workflows"]:::ci
        Fastlane["fastlane metadata"]:::ci
    end

    %% Interactions
    MainActivity -->|"uses"| Navigation
    MainActivity -->|"viewModels"| BaseRecorderModel
    Navigation --> WelcomeScreen
    Navigation --> RecorderScreen
    Navigation --> SettingsScreen
    Navigation --> AboutScreen
    Navigation --> CustomNotificationsScreen

    RecorderScreen -->|"calls"| AudioRecorderModel
    RecorderScreen -->|"calls"| VideoRecorderModel

    WelcomeScreen -->|"Intent: START_RECORDING"| RecorderService
    SettingsScreen -->|"reads/writes settings"| AppSettingsSerializer

    RecorderService --> AudioRecorderService
    RecorderService --> VideoRecorderService
    RecorderService --> IntervalRecorderService

    AudioRecorderService -->|"writes .aac chunks"| AudioBatchesFolder
    VideoRecorderService -->|"writes .mp4 chunks"| VideoBatchesFolder
    IntervalRecorderService -->|"manages circular buffer"| BatchesFolder

    RecorderService -->|"update notification"| RecorderNotificationHelper
    RecorderNotificationHelper --> NotificationChannel

    LocalChangeReceiver -->|"broadcast"| RecorderService
    LocalChangeReceiver -->|"broadcast"| MainActivity

    RecorderService --> MediaConverter
    MediaConverter -->|"reads batches"| AudioBatchesFolder
    MediaConverter -->|"reads batches"| VideoBatchesFolder

    RecorderService --> Doctor
    RecorderService --> AppLockHelper

    AppSettingsSerializer --> AppSettings

    AppSettings --> Constants

    AndroidOS --> RecorderService
    AndroidOS --> LocalChangeReceiver
    AndroidOS --> NotificationChannel

    %% CI/CD connections
    GitHubActions --> Fastlane

    %% Click Events
    click MainActivity "https://github.com/myzel394/alibi/blob/master/app/src/main/java/app/myzel394/alibi/MainActivity.kt"
    click Navigation "https://github.com/myzel394/alibi/blob/master/app/src/main/java/app/myzel394/alibi/ui/Navigation.kt"
    click WelcomeScreen "https://github.com/myzel394/alibi/blob/master/app/src/main/java/app/myzel394/alibi/ui/screens/WelcomeScreen.kt"
    click RecorderScreen "https://github.com/myzel394/alibi/blob/master/app/src/main/java/app/myzel394/alibi/ui/screens/RecorderScreen.kt"
    click SettingsScreen "https://github.com/myzel394/alibi/blob/master/app/src/main/java/app/myzel394/alibi/ui/screens/SettingsScreen.kt"
    click AboutScreen "https://github.com/myzel394/alibi/blob/master/app/src/main/java/app/myzel394/alibi/ui/screens/AboutScreen.kt"
    click CustomNotificationsScreen "https://github.com/myzel394/alibi/blob/master/app/src/main/java/app/myzel394/alibi/ui/screens/CustomRecordingNotificationsScreen.kt"
    click BaseRecorderModel "https://github.com/myzel394/alibi/blob/master/app/src/main/java/app/myzel394/alibi/ui/models/BaseRecorderModel.kt"
    click AudioRecorderModel "https://github.com/myzel394/alibi/blob/master/app/src/main/java/app/myzel394/alibi/ui/models/AudioRecorderModel.kt"
    click VideoRecorderModel "https://github.com/myzel394/alibi/blob/master/app/src/main/java/app/myzel394/alibi/ui/models/VideoRecorderModel.kt"
    click RecorderService "https://github.com/myzel394/alibi/blob/master/app/src/main/java/app/myzel394/alibi/services/RecorderService.kt"
    click AudioRecorderService "https://github.com/myzel394/alibi/blob/master/app/src/main/java/app/myzel394/alibi/services/AudioRecorderService.kt"
    click VideoRecorderService "https://github.com/myzel394/alibi/blob/master/app/src/main/java/app/myzel394/alibi/services/VideoRecorderService.kt"
    click IntervalRecorderService "https://github.com/myzel394/alibi/blob/master/app/src/main/java/app/myzel394/alibi/services/IntervalRecorderService.kt"
    click RecorderNotificationHelper "https://github.com/myzel394/alibi/blob/master/app/src/main/java/app/myzel394/alibi/services/RecorderNotificationHelper.kt"
    click LocalChangeReceiver "https://github.com/myzel394/alibi/blob/master/app/src/main/java/app/myzel394/alibi/receivers/LocalChangeReceiver.kt"
    click BatchesFolder "https://github.com/myzel394/alibi/blob/master/app/src/main/java/app/myzel394/alibi/helpers/BatchesFolder.kt"
    click AudioBatchesFolder "https://github.com/myzel394/alibi/blob/master/app/src/main/java/app/myzel394/alibi/helpers/AudioBatchesFolder.kt"
    click VideoBatchesFolder "https://github.com/myzel394/alibi/blob/master/app/src/main/java/app/myzel394/alibi/helpers/VideoBatchesFolder.kt"
    click MediaConverter "https://github.com/myzel394/alibi/blob/master/app/src/main/java/app/myzel394/alibi/helpers/MediaConverter.kt"
    click Doctor "https://github.com/myzel394/alibi/blob/master/app/src/main/java/app/myzel394/alibi/helpers/Doctor.kt"
    click AppLockHelper "https://github.com/myzel394/alibi/blob/master/app/src/main/java/app/myzel394/alibi/helpers/AppLockHelper.kt"
    click NotificationHelper "https://github.com/myzel394/alibi/blob/master/app/src/main/java/app/myzel394/alibi/NotificationHelper.kt"
    click AppSettings "https://github.com/myzel394/alibi/blob/master/app/src/main/java/app/myzel394/alibi/db/AppSettings.kt"
    click AppSettingsSerializer "https://github.com/myzel394/alibi/blob/master/app/src/main/java/app/myzel394/alibi/db/AppSettingsSerializer.kt"
    click Constants "https://github.com/myzel394/alibi/blob/master/app/src/main/java/app/myzel394/alibi/Constants.kt"
    click RecorderState "https://github.com/myzel394/alibi/blob/master/app/src/main/java/app/myzel394/alibi/enums/RecorderState.kt"
    click AndroidManifest "https://github.com/myzel394/alibi/blob/master/app/src/main/AndroidManifest.xml"
    click BackupRules "https://github.com/myzel394/alibi/blob/master/app/src/main/res/xml/backup_rules.xml"
    click GitHubActions "https://github.com/myzel394/alibi/blob/master/.github/workflows/build-testing.yaml"
    click Fastlane "https://github.com/myzel394/alibi/tree/master/fastlane/metadata/android/"
    
    %% Styles
    classDef frontend fill:#D0E8FF,stroke:#0366D6,color:#0366D6
    classDef domain fill:#DFFFD0,stroke:#3C873A,color:#3C873A
    classDef data fill:#FFF8C6,stroke:#D4A017,color:#D4A017
    classDef platform fill:#E8E8E8,stroke:#636363,color:#636363
    classDef ci fill:#F3D3E7,stroke:#BE377C,color:#BE377C
```
