How devemperor/dictate works
Project Type and Purpose
• This is a single‑module Android application implementing a custom input method (keyboard) that captures user speech, sends it to OpenAI’s Whisper API for transcription, optionally post‑processes it via GPT‑4 Omni, and then injects the resulting text into any focused input field. It also provides onboarding, settings, prompt management and usage‑tracking UIs, backed by local SQLite databases and SharedPreferences.
Main Components
a. Android Framework (the container)
– InputMethodService lifecycle and UI hosting
– Activity stack hosting onboarding, settings, prompts, usage screens
– SharedPreferences for user settings
– SQLite databases (PromptsDatabaseHelper, UsageDatabaseHelper)
b. App‑specific Modules
– DictateInputMethodService (core IME service: audio capture → network → result insertion)
– Onboarding flow (OnboardingActivity + adapter + assets)
– Prompt management (PromptModel, PromptEditActivity, PromptsOverviewActivity + DB)
– Usage tracking (UsageModel, UsageActivity + DB)
– Settings UI (PreferencesFragment + DictateSettingsActivity + “how‑to” assets)
c. Local Storage
– SharedPreferences (via PreferencesFragment)
– Prompts SQLite DB
– Usage SQLite DB
– Static assets (HTML/TXT in assets/)
d. External Services
– OpenAI Whisper Speech‑to‑Text API
– OpenAI GPT‑4 Omni API for optional rewording
Relationships & Data Flows
• User taps mic on the custom keyboard → DictateInputMethodService
• Service records audio → streams to Whisper API → receives transcript
• (Optional) Service posts transcript to GPT‑4 Omni → receives reworded text
• Service inserts final text into host app via InputConnection
• Service logs each transcription event into Usage DB
• Prompt editing UIs read/write prompts into Prompts DB
• Settings UI reads/writes SharedPreferences
• Onboarding UI reads static assets to guide user through permissions, API‑key entry
Architectural Patterns & Principles
• Modular separation between UI (Activities/Fragments), service logic, data persistence, and networking
• Use of Android’s InputMethodService to isolate keyboard implementation
• Repository‑like pattern: database helper classes encapsulate DB operations
• Lean network layer: direct HTTP calls to OpenAI REST endpoints
• Asset‑driven static content for “how‑to” and key info