How mpaepper/vibevoice works
Main Components
• CLI Interface Module – Represented by src/vibevoice/cli.py. This is the entry point that captures user input (the activation key press and release events) and triggers subsequent actions.
• Audio Processing & Transcription Service – Likely implemented in src/vibevoice/server.py and associated modules. This component handles:
• Capturing spoken audio
• Processing it utilizing the local Whisper model (with support for CUDA/CPU modes)
• Loading Indicator – Indicated by the module src/vibevoice/loading_indicator.py; this visual indicator provides feedback to the user during processing.
• AI Command Mode Engine – An extension to the core transcription function. When activated (using a different key, e.g., scroll_lock), it passes the transcribed text (and optionally a screenshot) to an external LLM:
• Integration with Ollama (an external service) is required to retrieve responses based on the current screen context.
• External Dependencies & Infrastructure – Note dependencies like CUDA, PortAudio, and external utilities (e.g., gnome-screenshot) as part of your platform’s environment. Also include the role of the CuDNN and cuBLAS libraries.
• Configuration & Environment – Highlight configuration through environment variables (e.g., VOICEKEY, VOICEKEY_CMD, OLLAMA_MODEL, etc.) that allow the application to be tuned at runtime.
Relationships and Data Flows
• While processing is underway, the Loading Indicator provides real-time feedback. This should be visually connected to the Audio Processing module.
Architectural Patterns & Design Principles
• Modularity: Clearly separate the concerns into distinct modules (CLI, Audio Processing, AI Command Mode, UI/Feedback).
• Configuration Driven: Highlight that many behaviors (especially keyboard controls and AI model selection) are configurable using environment variables.
• System Integration: Note the dependencies on GPU/CPU libraries (CUDA, cuDNN) and integration with external command-line utilities (such as gnome-screenshot for screen capture).