# an-k4/handar architecture

> Architecture diagram of the GitHub repository an-k4/handar, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/an-k4/handar
- Repository: https://github.com/an-k4/handar

## Overview

HandAr is an Android app for recording camera video with hand-tracked AR effects, effect audio, and in-app playback and sharing. The main workflow is camera capture → hand landmark detection and gesture-based effect state → live/recorded rendering → MP4 encoding and muxing → preview, library playback, and sharing. The README documents these responsibilities and interactions; source excerpts are not available, so edges below reflect README-documented relationships rather than inspected call sites. Other UI capabilities are represented where they form meaningful user workflows.

Main entry points: [`app/src/main/java/com/example/handar/ui/camera/CameraRecordFragment.kt`](https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/ui/camera/CameraRecordFragment.kt) (Camera screen), [`app/src/main/java/com/example/handar/effect/model/EffectState.kt`](https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/effect/model/EffectState.kt) (Effect state), [`app/src/main/java/com/example/handar/recording/VideoRecorder.kt`](https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/recording/VideoRecorder.kt) (Video recorder), [`app/src/main/java/com/example/handar/ui/player/VideoPlayerFragment.kt`](https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/ui/player/VideoPlayerFragment.kt) (Video playback)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_capture["Capture and navigation"]
  node_main["App navigation<br/>[MainActivity.kt]"]
  node_camera_ui["Camera screen"]
  node_camera_vm["Camera state"]
  node_effect_list["Effect browsing"]
  node_effect_preview["Effect preview"]
  node_effect_picker["Effect picker"]
end

subgraph group_effects["Hand effects"]
  node_landmarker["Hand detection"]
  node_gesture["Gesture recognition"]
  node_effect_state["Effect state<br/>[EffectState.kt]"]
  node_effect_repo["Effect definitions"]
  node_effect_catalog["Effect catalog"]
  node_overlay["Live overlay<br/>[OverlayView.kt]"]
  node_backgrounds["Effect backgrounds"]
end

subgraph group_recording["Recording pipeline"]
  node_audio["Effect audio"]
  node_recorder["Video recorder<br/>[VideoRecorder.kt]"]
  node_video_encoder["Video encoding"]
  node_audio_mixer["Audio mixing<br/>[AudioMixer.kt]"]
  node_audio_clock["Effect audio clock"]
  node_audio_encoder["Audio encoding"]
  node_muxer["MP4 muxing"]
end

subgraph group_media["Video library and sharing"]
  node_video_files[("Recorded videos")]
  node_preview["Recorded preview"]
  node_library["Video library"]
  node_player["Video playback"]
  node_share["Share screen<br/>[ShareFragment.kt]"]
  node_social["Social sharing<br/>[SocialShare.kt]"]
end

subgraph group_preferences["Onboarding and preferences"]
  node_onboarding["Onboarding survey"]
  node_settings["Settings"]
  node_language["Language selection"]
end

node_user(("User"))
node_camera(("Camera sensor"))
node_social_apps(("Social apps"))

node_user -->|"opens app"| node_main
node_user -->|"starts recording"| node_camera_ui
node_camera -->|"supplies frames"| node_landmarker
node_landmarker -->|"provides landmarks"| node_gesture
node_gesture -->|"selects state"| node_effect_state
node_effect_repo -.->|"provides definitions"| node_effect_catalog
node_camera_ui -->|"uses selected effect"| node_effect_state
node_effect_state -->|"drives rendering"| node_overlay
node_effect_state -->|"selects background"| node_backgrounds
node_camera_ui -->|"plays effect sounds"| node_audio
node_camera_ui -->|"starts recording"| node_recorder
node_recorder -->|"encodes frames"| node_video_encoder
node_recorder -->|"synchronizes audio"| node_audio_clock
node_audio_clock -->|"provides timing"| node_audio_mixer
node_audio_mixer -->|"mixes PCM"| node_audio_encoder
node_video_encoder -->|"sends video track"| node_muxer
node_audio_encoder -->|"sends audio track"| node_muxer
node_muxer -->|"writes MP4"| node_video_files
node_camera_ui -->|"opens after recording"| node_preview
node_preview -->|"saves to"| node_share
node_library -->|"lists recordings"| node_video_files
node_library -->|"opens video"| node_player
node_player -->|"plays recording"| node_video_files
node_player -->|"opens sharing"| node_share
node_share -->|"shares video"| node_social
node_social -->|"passes video"| node_social_apps
node_user -->|"browses effects"| node_effect_list
node_effect_list -->|"previews effect"| node_effect_preview
node_effect_preview -->|"creates with effect"| node_camera_ui
node_camera_ui -->|"changes effect"| node_effect_picker
node_effect_picker -->|"previews selection"| node_effect_preview
node_user -->|"completes onboarding"| node_onboarding
node_user -->|"opens settings"| node_settings
node_settings -->|"chooses language"| node_language

click node_main "https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/MainActivity.kt"
click node_camera_ui "https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/ui/camera/CameraRecordFragment.kt"
click node_camera_vm "https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/ui/camera/CameraRecordViewModel.kt"
click node_landmarker "https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/effect/HandLandmarkerProvider.kt"
click node_gesture "https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/effect/gesture/GestureRecognizer.kt"
click node_effect_state "https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/effect/model/EffectState.kt"
click node_effect_repo "https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/effect/EffectRepository.kt"
click node_effect_catalog "https://github.com/an-k4/handar/tree/main/app/src/main/java/com/example/handar/effect/catalog"
click node_overlay "https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/OverlayView.kt"
click node_backgrounds "https://github.com/an-k4/handar/tree/main/app/src/main/java/com/example/handar/effect/background"
click node_audio "https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/audio/SoundEffectPlayer.kt"
click node_recorder "https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/recording/VideoRecorder.kt"
click node_video_encoder "https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/recording/VideoEncoderWrapper.kt"
click node_audio_mixer "https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/recording/AudioMixer.kt"
click node_audio_clock "https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/recording/EffectAudioClock.kt"
click node_audio_encoder "https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/recording/AudioEncoderWrapper.kt"
click node_muxer "https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/recording/MuxerCoordinator.kt"
click node_video_files "https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/ui/videolist/VideoFileRepository.kt"
click node_preview "https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/ui/recordedpreview/RecordedPreviewFragment.kt"
click node_library "https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/ui/videolist/VideoListFragment.kt"
click node_player "https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/ui/player/VideoPlayerFragment.kt"
click node_share "https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/ui/share/ShareFragment.kt"
click node_social "https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/utils/SocialShare.kt"
click node_effect_list "https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/ui/effectlist/EffectListFragment.kt"
click node_effect_preview "https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/ui/effectpreview/EffectPreviewFragment.kt"
click node_effect_picker "https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/ui/effectpicker/EffectPickerFragment.kt"
click node_onboarding "https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/ui/onboarding/Onboarding1Fragment.kt"
click node_settings "https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/ui/settings/SettingsFragment.kt"
click node_language "https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/ui/language/LanguageFragment.kt"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_main,node_camera_ui,node_camera_vm,node_effect_list,node_effect_preview,node_effect_picker,node_user toneBlue
class node_landmarker,node_gesture,node_effect_state,node_effect_repo,node_effect_catalog,node_overlay,node_backgrounds toneAmber
class node_audio,node_recorder,node_video_encoder,node_audio_mixer,node_audio_clock,node_audio_encoder,node_muxer toneMint
class node_video_files,node_preview,node_library,node_player,node_share,node_social toneRose
class node_onboarding,node_settings,node_language,node_camera,node_social_apps toneIndigo
```

## Components

### Capture and navigation

- [App navigation](https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/MainActivity.kt): `app/src/main/java/com/example/handar/MainActivity.kt`
- [Camera screen](https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/ui/camera/CameraRecordFragment.kt): `app/src/main/java/com/example/handar/ui/camera/CameraRecordFragment.kt`
- [Camera state](https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/ui/camera/CameraRecordViewModel.kt): `app/src/main/java/com/example/handar/ui/camera/CameraRecordViewModel.kt`
- [Effect browsing](https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/ui/effectlist/EffectListFragment.kt): `app/src/main/java/com/example/handar/ui/effectlist/EffectListFragment.kt`
- [Effect preview](https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/ui/effectpreview/EffectPreviewFragment.kt): `app/src/main/java/com/example/handar/ui/effectpreview/EffectPreviewFragment.kt`
- [Effect picker](https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/ui/effectpicker/EffectPickerFragment.kt): `app/src/main/java/com/example/handar/ui/effectpicker/EffectPickerFragment.kt`

### Hand effects

- [Hand detection](https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/effect/HandLandmarkerProvider.kt): `app/src/main/java/com/example/handar/effect/HandLandmarkerProvider.kt`
- [Gesture recognition](https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/effect/gesture/GestureRecognizer.kt): `app/src/main/java/com/example/handar/effect/gesture/GestureRecognizer.kt`
- [Effect state](https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/effect/model/EffectState.kt): `app/src/main/java/com/example/handar/effect/model/EffectState.kt`
- [Effect definitions](https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/effect/EffectRepository.kt): `app/src/main/java/com/example/handar/effect/EffectRepository.kt`
- [Effect catalog](https://github.com/an-k4/handar/tree/main/app/src/main/java/com/example/handar/effect/catalog): `app/src/main/java/com/example/handar/effect/catalog`
- [Live overlay](https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/OverlayView.kt): `app/src/main/java/com/example/handar/OverlayView.kt`
- [Effect backgrounds](https://github.com/an-k4/handar/tree/main/app/src/main/java/com/example/handar/effect/background): `app/src/main/java/com/example/handar/effect/background`

### Recording pipeline

- [Effect audio](https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/audio/SoundEffectPlayer.kt): `app/src/main/java/com/example/handar/audio/SoundEffectPlayer.kt`
- [Video recorder](https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/recording/VideoRecorder.kt): `app/src/main/java/com/example/handar/recording/VideoRecorder.kt`
- [Video encoding](https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/recording/VideoEncoderWrapper.kt): `app/src/main/java/com/example/handar/recording/VideoEncoderWrapper.kt`
- [Audio mixing](https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/recording/AudioMixer.kt): `app/src/main/java/com/example/handar/recording/AudioMixer.kt`
- [Effect audio clock](https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/recording/EffectAudioClock.kt): `app/src/main/java/com/example/handar/recording/EffectAudioClock.kt`
- [Audio encoding](https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/recording/AudioEncoderWrapper.kt): `app/src/main/java/com/example/handar/recording/AudioEncoderWrapper.kt`
- [MP4 muxing](https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/recording/MuxerCoordinator.kt): `app/src/main/java/com/example/handar/recording/MuxerCoordinator.kt`

### Video library and sharing

- [Recorded videos](https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/ui/videolist/VideoFileRepository.kt): `app/src/main/java/com/example/handar/ui/videolist/VideoFileRepository.kt`
- [Recorded preview](https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/ui/recordedpreview/RecordedPreviewFragment.kt): `app/src/main/java/com/example/handar/ui/recordedpreview/RecordedPreviewFragment.kt`
- [Video library](https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/ui/videolist/VideoListFragment.kt): `app/src/main/java/com/example/handar/ui/videolist/VideoListFragment.kt`
- [Video playback](https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/ui/player/VideoPlayerFragment.kt): `app/src/main/java/com/example/handar/ui/player/VideoPlayerFragment.kt`
- [Share screen](https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/ui/share/ShareFragment.kt): `app/src/main/java/com/example/handar/ui/share/ShareFragment.kt`
- [Social sharing](https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/utils/SocialShare.kt): `app/src/main/java/com/example/handar/utils/SocialShare.kt`

### Onboarding and preferences

- [Onboarding survey](https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/ui/onboarding/Onboarding1Fragment.kt): `app/src/main/java/com/example/handar/ui/onboarding/Onboarding1Fragment.kt`
- [Settings](https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/ui/settings/SettingsFragment.kt): `app/src/main/java/com/example/handar/ui/settings/SettingsFragment.kt`
- [Language selection](https://github.com/an-k4/handar/blob/main/app/src/main/java/com/example/handar/ui/language/LanguageFragment.kt): `app/src/main/java/com/example/handar/ui/language/LanguageFragment.kt`

### Other components

- **User**
- **Camera sensor**
- **Social apps**

## Connections

- User → App navigation: opens app (evidence: `README.md`)
- User → Camera screen: starts recording (evidence: `README.md`)
- Camera sensor → Hand detection: supplies frames (evidence: `README.md`)
- Hand detection → Gesture recognition: provides landmarks (evidence: `README.md`)
- Gesture recognition → Effect state: selects state (evidence: `README.md`)
- Effect definitions → Effect catalog: provides definitions
- Camera screen → Effect state: uses selected effect (evidence: `README.md`)
- Effect state → Live overlay: drives rendering (evidence: `README.md`)
- Effect state → Effect backgrounds: selects background (evidence: `README.md`)
- Camera screen → Effect audio: plays effect sounds (evidence: `README.md`)
- Camera screen → Video recorder: starts recording (evidence: `README.md`)
- Video recorder → Video encoding: encodes frames (evidence: `README.md`)
- Video recorder → Effect audio clock: synchronizes audio (evidence: `README.md`)
- Effect audio clock → Audio mixing: provides timing (evidence: `README.md`)
- Audio mixing → Audio encoding: mixes PCM (evidence: `README.md`)
- Video encoding → MP4 muxing: sends video track (evidence: `README.md`)
- Audio encoding → MP4 muxing: sends audio track (evidence: `README.md`)
- MP4 muxing → Recorded videos: writes MP4 (evidence: `README.md`)
- Camera screen → Recorded preview: opens after recording (evidence: `README.md`)
- Recorded preview → Share screen: saves to (evidence: `README.md`)
- Video library → Recorded videos: lists recordings (evidence: `README.md`)
- Video library → Video playback: opens video (evidence: `README.md`)
- Video playback → Recorded videos: plays recording (evidence: `README.md`)
- Video playback → Share screen: opens sharing (evidence: `README.md`)
- Share screen → Social sharing: shares video (evidence: `README.md`)
- Social sharing → Social apps: passes video (evidence: `README.md`)
- User → Effect browsing: browses effects (evidence: `README.md`)
- Effect browsing → Effect preview: previews effect (evidence: `README.md`)
- Effect preview → Camera screen: creates with effect (evidence: `README.md`)
- Camera screen → Effect picker: changes effect (evidence: `README.md`)
- Effect picker → Effect preview: previews selection (evidence: `README.md`)
- User → Onboarding survey: completes onboarding (evidence: `README.md`)
- User → Settings: opens settings (evidence: `README.md`)
- Settings → Language selection: chooses language (evidence: `README.md`)
