termivox 0.1.3

Voice Recognition Bridge for Linux - Speak naturally, control your system, type hands-free

Termivox

Voice Recognition Bridge for Linux — Speak naturally, control your system, type hands-free.

---

🎯 Overview

Termivox is a Linux-based voice recognition system that transforms your speech into text and system commands. Using offline voice recognition (Vosk), it provides:

• Hands-free dictation - Speak and watch your words appear
• Voice-controlled system commands - Copy, paste, click, scroll by voice
• Multi-language support - English and French recognition
• Toggle control - Pause/resume recognition instantly like a guitar pedal
• Privacy-first - All processing happens locally, no cloud required

---

✨ Features

🎤 Voice Recognition

• Offline speech-to-text powered by Vosk
• Bilingual support: English (en) and French (fr)
• Punctuation by voice - Say "comma", "period", "question mark"
• Edit commands - "new line", "tab", "new paragraph"
• System commands - "copy", "paste", "click", "scroll up/down"

🤖 AI Enhancement (NEW!)

Transform raw speech into natural, fluent text with AI-powered refinement:

• Multi-provider support - Google Gemini or OpenAI GPT
• Intelligent understanding - Handles natural speech patterns, hesitations, mixed languages
• Multilingual mastery - Perfect French/English detection and grammar
• Smart punctuation - Voice commands applied intelligently
• Context preservation - Maintains your intent and style
• Buffering modes - Realtime, sentence, or paragraph-based refinement

How it works:

Your speech → Vosk transcription → AI refinement → Perfect text output

The AI understands:

• Natural speaking rhythm (pauses, "euh", "um")
• Mixed French/English in same sentence
• Technical terms preservation (Termivox, toggle, etc.)
• Voice punctuation commands ("comma", "virgule", "period")

Example transformations:

🎤 "ok là j'suis dans le métro euh attends... oui bref fais un paragraphe pour dire que Termivox fonctionne parfaitement virgule et que je vais l'utiliser pour écrire mes notes"

✨ "Termivox fonctionne parfaitement, et je vais l'utiliser pour écrire mes notes."

🎛️ Toggle Control

Control voice recognition ON/OFF with multiple interfaces:

⌨️ Global Hotkey

• Press Ctrl+Alt+V from anywhere to toggle
• Customizable key combination
• Works across all applications

🖱️ Desktop Widget

• Minimal floating window (160×70px)
• One-click toggle button
• Visual status: "LISTENING" (green) / "MUTED" (gray)
• Draggable, always-on-top
• Never steals cursor focus

🎛️ System Tray Icon

• Green/red status indicator
• Click to toggle
• Right-click menu

🎮 Hardware Support (Coming Soon)

• USB foot pedal support
• MIDI controller integration
• Custom button devices

---

📦 Installation

Prerequisites

System Requirements:

• Linux (tested on Ubuntu 24.04)
• Python 3.8+
• Microphone input

System Dependencies:

sudo apt install python3-pyaudio xdotool sox portaudio19-dev -y

Quick Install (Recommended)

Using pipx (isolated installation):

# Install pipx if needed
sudo apt install pipx
pipx ensurepath

# Install Termivox (includes AI support)
pipx install termivox

# Run first-time setup
termivox init

Using pip (global/venv installation):

# Install Termivox (includes AI support)
pip install termivox

# Run first-time setup
termivox init

From Source (Development)

1. Clone the repository:

   git clone https://github.com/Gerico1007/termivox.git
   cd termivox
   

2. Create virtual environment:

   python3 -m venv termivox-env
   source termivox-env/bin/activate
   

3. Install in development mode:

   # Install with all dependencies (includes AI support)
   pip install -e .
   

4. Run first-time setup:

   termivox init
   

First-Time Setup Wizard

The termivox init command provides an interactive setup wizard that:

1. ✅ Checks system dependencies
2. 🌍 Lets you choose language (English/French)
3. 📥 Downloads voice recognition model
4. 🤖 Optionally configures AI enhancement
   • Choose provider (Gemini/OpenAI)
   • Add API key
5. 📝 Creates configuration files

Example:

$ termivox init

============================================================
🎤 Termivox - First-Time Setup Wizard
============================================================

Welcome to Termivox!
This wizard will help you set up voice recognition on your system.

📦 Checking dependencies...
✓ All dependencies found

🌍 Choose voice recognition language:
  → 1. English (en)
    2. French (fr)

Choice [1-2] (default: 1): 1

📥 Downloading voice model (en)...
✓ Voice model downloaded successfully

🤖 AI Enhancement Setup

AI enhancement refines your voice transcription:
  • Corrects grammar naturally
  • Handles bilingual input (French/English)
  • Removes filler words
  • Processes voice commands

Enable AI enhancement? [Y/n]: y

Choose AI provider:
  → 1. Google Gemini (recommended, free tier available)
    2. OpenAI GPT (requires paid account)
    3. Skip for now

Choice [1-3] (default: 1): 1

📝 GEMINI API Key
Get your API key at: https://makersuite.google.com/app/apikey

Enter your GEMINI API key: AIza...

✓ Created .env file
✓ Created config file

============================================================
✅ Setup Complete!
============================================================

Next steps:
  1. Run: termivox
  2. Press Ctrl+Alt+V to toggle voice recognition
  3. Speak naturally - your words will be typed!

🤖 AI Enhancement: GEMINI (enabled)

For help: termivox --help

---

🚀 Usage

Quick Start

After installation, simply run:

termivox

CLI Commands

First-time setup:

termivox init                    # Interactive setup wizard

Normal operation:

termivox                         # Run with default settings
termivox --lang fr               # Use French
termivox --no-toggle             # Disable toggle (always-on mode)

AI configuration:

termivox --ai                    # Configure AI enhancement

Help and version:

termivox --help                  # Show help
termivox --version               # Show version

From source (development):

source termivox-env/bin/activate
python src/cli.py               # Main entry point
python src/cli.py init          # Run setup wizard

Toggle Control

Once Termivox is running, control it using:

Hotkey:

• Press Ctrl+Alt+V → Pauses/resumes voice recognition
• Works from any window, keeps cursor position

Widget:

• Click the floating "LISTENING" or "MUTED" button
• Drag the title bar to reposition
• Right-click to close widget

Indicator:

• Green = Voice recognition ACTIVE (listening)
• Gray/Red = Voice recognition MUTED (paused)

Voice Commands

Dictation:

"Hello world" → types: Hello world

Punctuation:

"Hello comma world period" → types: Hello, world.

Available punctuation:

• comma, period, question mark, exclamation mark
• colon, semicolon, dash, quote, apostrophe

Editing:

"new line"       → ↵
"new paragraph"  → ↵↵
"tab"            → ⇥

System Commands:

"copy"           → Ctrl+C
"paste"          → Ctrl+V
"select all"     → Ctrl+A
"click"          → Mouse click
"scroll up"      → Scroll wheel up
"scroll down"    → Scroll wheel down

Language Selection

English (default):

./run.sh
# or
python src/main.py --lang en

French:

python src/main.py --lang fr

---

⚙️ Configuration

Edit config/settings.json to customize behavior:

{
  "interfaces": {
    "hotkey": {
      "enabled": true,
      "key": "ctrl+alt+v"        // Change hotkey here
    },
    "tray": {
      "enabled": false            // Enable system tray icon
    },
    "widget": {
      "enabled": true,            // Desktop widget
      "position": {"x": 100, "y": 100},
      "size": {"width": 160, "height": 70},
      "always_on_top": true
    }
  },
  "voice": {
    "language": "en",             // Default language
    "auto_space": true            // Auto-add spaces
  },
  "ai": {
    "enabled": true,              // Enable AI enhancement
    "provider": "gemini",         // "gemini" or "openai"
    "model": null,                // null = use default model
    "buffer_mode": "sentence",    // "realtime", "sentence", "paragraph"
    "buffer_size": 50             // Max characters before forcing refinement
  }
}

AI Configuration Options

Providers:

• "gemini" - Google Gemini (default: gemini-2.0-flash-exp)
• "openai" - OpenAI GPT (default: gpt-4o-mini)

Buffer Modes:

• "realtime" - Refine every phrase immediately (slower, most accurate)
• "sentence" - Wait for sentence completion (balanced)
• "paragraph" - Wait for paragraph breaks (faster, less frequent)

Environment Variables:

# In .env file
GEMINI_API_KEY=your_gemini_key_here
OPENAI_API_KEY=your_openai_key_here

Custom Hotkey Examples:

• "ctrl+shift+v"
• "ctrl+alt+t"
• "super+v"

---

📁 Project Structure

termivox/
├── src/
│   ├── main.py                    # Main entry point with toggle support
│   ├── test_voice_script.py       # Standalone testing utility
│   ├── voice/
│   │   ├── recognizer.py          # Vosk voice recognition engine
│   │   └── __init__.py
│   ├── ai/                        # AI enhancement layer (NEW!)
│   │   ├── ai_service.py          # Multi-provider AI abstraction
│   │   └── __init__.py
│   ├── bridge/
│   │   ├── xdotool_bridge.py      # System command executor
│   │   └── __init__.py
│   ├── ui/                        # Toggle control interfaces
│   │   ├── toggle_controller.py   # Central state management
│   │   ├── hotkey_interface.py    # Global hotkey listener
│   │   ├── tray_interface.py      # System tray icon
│   │   ├── widget_interface.py    # Desktop widget
│   │   ├── hardware_interface.py  # Hardware button stub
│   │   ├── config_loader.py       # Configuration system
│   │   └── __init__.py
│   └── utils/
│       └── __init__.py
├── config/
│   └── settings.json              # User configuration
├── voice_models/                  # Vosk language models
│   └── vosk-model-small-en-us-0.15/
├── .env.example                   # API key template (NEW!)
├── requirements.txt               # Python dependencies
├── run.sh                         # Launch script
├── download_model.py              # Model downloader
└── README.md

---

🛠️ Dependencies

Python Packages:

• Vosk - Offline speech recognition
• pyaudio - Microphone input
• numpy - Audio processing
• pynput - Global hotkey support
• pystray - System tray icon
• Pillow - Icon generation
• xdotool - System command execution
• google-generativeai - Gemini AI (optional)
• openai - OpenAI GPT (optional)

System Packages:

• python3-pyaudio - PyAudio bindings
• xdotool - Keyboard/mouse automation
• sox - Audio utilities
• portaudio19-dev - Audio development headers

---

🎨 Toggle Widget Design

Minimal Professional Aesthetic:

┌─────────────────────┐
│ TERMIVOX         ● │  ← Dark title bar (draggable)
├─────────────────────┤
│                     │
│    LISTENING        │  ← Green button (active state)
│                     │
└─────────────────────┘

Features:

• Compact: 160×70 pixels
• Unfocusable: Never steals cursor
• Draggable: Reposition anywhere
• Color-coded: Green (ON) / Gray (OFF)
• Always-on-top: Stays visible

---

🧪 Testing

Test voice recognition without typing:

source termivox-env/bin/activate
python src/test_voice_script.py --lang en

Test with toggle control:

./run.sh
# Then try:
# 1. Speak something
# 2. Press Ctrl+Alt+V
# 3. Speak again (should not type)
# 4. Press Ctrl+Alt+V
# 5. Speak (should type again)

Test different languages:

python src/test_voice_script.py --lang fr  # French
python src/test_voice_script.py --lang en  # English

---

🐛 Troubleshooting

Hotkey doesn't work:

• Check terminal for errors
• Try different hotkey in config/settings.json
• Ensure pynput is installed: pip list | grep pynput

No voice recognition:

• Check microphone: arecord -l
• Test PyAudio: python -c "import pyaudio; print('OK')"
• Verify Vosk model downloaded in voice_models/

Widget not visible:

• Enable in config: "widget": {"enabled": true}
• Check if tkinter available: python -c "import tkinter"

System tray icon missing:

• Desktop environment may not support system tray
• Use widget or hotkey instead
• Try enabling: "tray": {"enabled": true}

---

🤝 Contributing

Contributions welcome! Areas for enhancement:

• Additional language models
• Custom wake word detection
• Audio feedback on toggle
• Hardware button integration
• Voice command macros
• GUI configuration tool

To contribute:

1. Fork the repository
2. Create feature branch: git checkout -b feature/amazing-feature
3. Commit changes: git commit -m 'Add amazing feature'
4. Push to branch: git push origin feature/amazing-feature
5. Open Pull Request

---

📄 License

MIT License - See LICENSE file for details

---

🙏 Acknowledgments

• Vosk - Offline speech recognition engine
• pynput - Cross-platform input control
• pystray - System tray integration
• xdotool - X11 automation

---

🔮 Roadmap

• AI-powered transcription enhancement (Gemini, OpenAI)
• Multilingual AI understanding (French/English)
• Voice command macros
• Custom wake word support
• GUI settings editor
• Hardware button integration (foot pedal, MIDI)
• Audio feedback options
• Additional language models (Spanish, German, etc.)
• Plugin system for custom commands
• Cloud sync for settings (optional)
• Real-time AI streaming (word-by-word refinement)

---

♠️ Nyro - Structural foundation, modular architecture 🌿 Aureon - Flow preservation, accessibility focus 🎸 JamAI - Musical encoding, harmonic design

Built with recursive intention. Speak, toggle, flow.