Speech2Text Service

A D-Bus service that provides speech-to-text functionality for the GNOME Shell Speech2Text extension.

Overview

This service handles the actual speech recognition processing using OpenAI's Whisper model locally. It runs as a D-Bus service and communicates with the GNOME Shell extension to provide seamless speech-to-text functionality.

Features

• Real-time speech recognition using OpenAI Whisper
• D-Bus integration for seamless desktop integration
• Audio recording with configurable duration
• Multiple output modes (clipboard, text insertion, preview)
• Error handling and recovery
• Session management for multiple concurrent recordings

Installation

System Dependencies

This service requires several system packages to be installed (e.g. ffmpeg, clipboard tools). See the main README.md for the complete list of system dependencies.

Service Installation

The service is available on PyPI and is typically installed into a per-user virtual environment by the extension’s installer.

pip install speech2text-extension-service

PyPI Package: speech2text-extension-service

Or from the source repository:

cd service/
pip install .

D-Bus Registration

After installation, you need to register the D-Bus service and desktop entry. Recommended options:

1. Using the repository (local source install)

# From the repo root
./service/install-service.sh --local

2. Using the bundled installer (PyPI install)

# From the repo root
./service/install-service.sh --pypi

The installer will:

• Create a per-user virtual environment under ~/.local/share/speech2text-extension-service/venv
• Install the speech2text-extension-service package
• Register the D-Bus service at ~/.local/share/dbus-1/services/org.gnome.Shell.Extensions.Speech2Text.service
• Create a desktop entry at ~/.local/share/applications/speech2text-extension-service.desktop

Usage

Starting the Service

The service is D-Bus activated and starts automatically when requested by the extension. You can also start it manually:

# If the entry point is on PATH (pip install)
speech2text-extension-service

# Or via the per-user wrapper created by the installer
~/.local/share/speech2text-extension-service/speech2text-extension-service

Configuration

The service uses OpenAI's Whisper model locally for speech recognition. No API key is required. All processing happens on your local machine for complete privacy.

D-Bus Interface

The service provides the following D-Bus interface (stable; used by the GNOME extension):

Methods:

• StartRecording(duration, copy_to_clipboard, preview_mode) → recording_id
• StopRecording(recording_id) → success
• CancelRecording(recording_id) → success
• TypeText(text, copy_to_clipboard) → success
• GetServiceStatus() → status
• CheckDependencies() → all_available, missing_dependencies[]

Signals:

• RecordingStarted(recording_id)
• RecordingStopped(recording_id, reason)
• TranscriptionReady(recording_id, text)
• RecordingError(recording_id, error_message)
• TextTyped(text, success)

Requirements

• Python: 3.8–3.13 (Python 3.14+ not supported yet)
• System: Linux with D-Bus support
• Desktop: GNOME Shell (tested on GNOME 46+)

License

This project is licensed under the GPL-3.0-or-later license. See the LICENSE file for details.

Contributing

Contributions are welcome! Please see the main repository for contribution guidelines: https://github.com/kavehtehrani/speech2text-extension