Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# Changelog

## 1.2.0 — v1.2.0 · The microphone stays where you put it

- Add **Level** to Settings → Recording. Switched on, it starts at the level the microphone has now; the slider sets it from 0 to 100 %. While Utterform runs it looks every two seconds and sets the level back when Teams, Zoom, Chrome or anything else has changed it. Switched off, Utterform never touches the level.
- Windows: the microphone chosen for recordings, else the default one — the same slider as in Sound settings. Linux: the default input of PipeWire (`wpctl`) or PulseAudio (`pactl`). macOS: the default input.
- Choosing another microphone in the tray moves the held level to it.
- Where the level cannot be read, the switch stays off and says why.
- App version 1.2.0; the installers install v1.2.0 by default.

See [1.2.0 release notes](docs/releases/v1.2.0.md).

## 1.1.0 — v1.1.0 · The right microphone, one click away

- Add **Microphone** to the tray menu: **System default (name)** and every microphone, the one in use checked. A click makes it the microphone for the next recordings — the laptop's own while the headset for calls stays plugged in. It is the same setting as Settings → Recording → Microphone, saved at once, and the window follows.
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Utterform records a short voice clip, transcribes it with **OpenAI GPT Transcrib
the cursor. The window can stay out of the way while a global shortcut controls the
whole flow.

> **1.1.0 — The right microphone, one click away** switches the microphone from the tray menu and brings everything since 0.8.0: a first-run assistant, Settings with search, ChatGPT text actions, Context, an action per app and audio files. The Apple-Silicon build is Developer ID signed and notarized; Windows remains unsigned. See the [release notes](docs/releases/v1.1.0.md) and [downloads](https://github.com/jli-software/utterform/releases/tag/v1.1.0).
> **1.2.0 — The microphone stays where you put it** holds the microphone level you choose, even when Teams or another app turns it up or down. 1.1.0 brought the microphone in the tray menu and everything since 0.8.0: a first-run assistant, Settings with search, ChatGPT text actions, Context, an action per app and audio files. The Apple-Silicon build is Developer ID signed and notarized; Windows remains unsigned. See the [release notes](docs/releases/v1.2.0.md) and [downloads](https://github.com/jli-software/utterform/releases/tag/v1.2.0).

## How it works

Expand Down Expand Up @@ -333,6 +333,7 @@ Push/PR CI runs Linux validation without release compilation. For a test binary
- A vocabulary of your own terms, and a reasoning effort for the text step
- Clipboard, TXT, Markdown, or combined output
- Selectable microphone with a system-default fallback, in Settings and in the tray menu
- Hold the microphone level, so other apps cannot change how loud you record
- Global dictation with a reserved key combination on Windows, macOS and X11, or a compositor binding on Wayland: either way without raising the window
- Optional typing of the finished text into the focused window, next to clipboard and file, as one paste or as keystrokes (Linux and Windows)
- A dictation key recorded by pressing it, read by physical key so the layout cannot change it
Expand Down
27 changes: 27 additions & 0 deletions docs/ARCHITECTURE.md
Original file line number Diff line number Diff line change
Expand Up @@ -294,6 +294,33 @@ Linux has no such hover event; there the list follows the window.
**Diagnostics.** `tray.microphone_chosen` (`default` or `device`) and
`tray.microphones_failed` (step). Device names are not logged.

## Microphone level (1.2.0)

**What it holds.** `settings.microphone_level`: a percentage, or `None` to leave the
level to the operating system (the default, and what an older settings file reads as).
`mic_level.rs` runs one thread, started in `setup`, that receives the target over a
channel — from `init` (the settings file), `save_settings`, `complete_onboarding` and the
tray's microphone choice — and, while a level is set, reads it every two seconds and
writes it back when it is more than one point away (rounding in the system moves it by
one). Nothing is read or written while no level is set.

**Per system.** Windows: `IMMDeviceEnumerator::GetDevice` with the endpoint id from the
cpal id `wasapi:<id>`, else the default capture endpoint, then
`IAudioEndpointVolume::{Get,Set}MasterVolumeLevelScalar` — the Sound settings slider;
COM is initialised once on the thread. Linux: `wpctl get-volume/set-volume
@DEFAULT_AUDIO_SOURCE@`, else `pactl get-source-volume/set-source-volume
@DEFAULT_SOURCE@`; the ALSA ids Utterform records from do not map to PipeWire nodes, so it
is always the default source. macOS: `osascript` `input volume of (get volume settings)` /
`set volume input volume`, the default input.

**Settings.** Recording → Level: the switch reads the current level
(`read_microphone_level`) and starts there; if that fails the switch stays off and the
reason is shown. The slider saves after 300 ms.

**Diagnostics.** `mic_level.target` (level or `off`), `mic_level.restored` (from, to; at
most once a minute), `mic_level.failed` once until it works again,
`mic_level.read_failed`. No device names.

## First-run assistant (0.14.0)

**Who sees it.** `settings.onboarding_completed`. `AppSettings::default()` — what `load`
Expand Down
14 changes: 13 additions & 1 deletion docs/DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,19 @@ proposals are in [plans/v1.0-roadmap.md](plans/v1.0-roadmap.md). The plan of 202
(reliability, assistant, finish) is superseded; 0.7.13 shipped, 0.7.14
(`feat/simple-settings`) was rejected and will not be merged.

## Current handoff — 1.1.0 Microphone in the tray
## Current handoff — 1.2.0 Hold the microphone level

Branch `work/utterform-1.2.0-hold-mic-level`. Jonas asked on 2026-11-13 for the
microphone to stay set (a RØDE NT-USB on Windows; its knobs only change the headphone
mix) without a separate tool, on Windows and Linux alike. Settings → Recording → Level
holds a level while Utterform runs. Design in
[ARCHITECTURE.md → Microphone level](ARCHITECTURE.md#microphone-level-120). Released
directly as 1.2.0 like 1.1.0. CBZIT007 has no Visual C++ Build Tools: the Windows code was
compiled by `Desktop builds`, the frontend and its Playwright tests ran locally (Edge via
`PLAYWRIGHT_CHROMIUM_EXECUTABLE`). Open: a real check with the NT-USB and Teams running,
and Linux on a PipeWire desktop.

## Previous handoff — 1.1.0 Microphone in the tray

Branch `work/utterform-1.1.0-tray-microphone`. Jonas asked on 2026-11-13 for a quick
microphone switch in the tray (headset plugged in for calls, but dictating into the
Expand Down
1 change: 1 addition & 0 deletions docs/plans/v1.0-roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ Proposals not yet confirmed by Jonas are marked **Proposal**.
| 0.14.0 | First-run assistant | merged, ships with 1.0 |
| 1.0.0 | Acceptance on Linux, Windows, macOS; release; WinGet | rc.1 published; not released on its own — ships as 1.1.0 |
| 1.1.0 | Microphone in the tray; first stable release since 0.8.0 | released (2026-11-13) |
| 1.2.0 | Hold the microphone level | released (2026-11-13) |

**Proposal (order):** the Omarchy backend first because it is small and the CLI already
exists; Settings next so every later feature gets a fixed place; Codex before context
Expand Down
32 changes: 32 additions & 0 deletions docs/releases/v1.2.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Utterform 1.2.0 — The microphone stays where you put it

**Hold the microphone level.** How loud a microphone records is set by the operating
system, and other programs change it without asking: Teams, Zoom and Chrome turn it up
and down on their own. Open Settings → Recording and switch on **Level**. It starts at the
level your microphone has now; move the slider to where it sounds right. From then on
Utterform keeps it there while it runs and sets it back within two seconds when something
else changed it — for dictation, for a call, for a video you record.

Switch it off and Utterform leaves the level alone again.

- **Windows:** the microphone chosen for recordings, otherwise the default one. It is the
same level as in Sound settings → Input.
- **Linux:** the default input of PipeWire or PulseAudio.
- **macOS:** the default input.

A tip for USB microphones with knobs, such as the RØDE NT-USB: the knobs set what you
hear in the headphones. What is recorded is set here.

## Install

Quit Utterform first.

- **Linux (Omarchy / Arch):**
`curl -fsSL https://github.com/jli-software/utterform/releases/download/v1.2.0/install-linux.sh | sh`
- **Windows (PowerShell):**
`irm https://github.com/jli-software/utterform/releases/download/v1.2.0/install-windows.ps1 | iex`
- **macOS:** the [DMG](https://github.com/jli-software/utterform/releases/download/v1.2.0/utterform-macos-aarch64.dmg),
Developer ID signed and notarized.

Windows builds remain unsigned and may trigger SmartScreen. Verify downloads against
`SHA256SUMS.txt`.
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "utterform",
"private": true,
"version": "1.1.0",
"version": "1.2.0",
"type": "module",
"scripts": {
"dev": "vite",
Expand Down
2 changes: 1 addition & 1 deletion scripts/install-linux.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

set -eu

version="${UTTERFORM_VERSION:-v1.1.0}"
version="${UTTERFORM_VERSION:-v1.2.0}"
release_base="${UTTERFORM_RELEASE_BASE_URL:-https://github.com/jli-software/utterform/releases/download/${version}}"
asset="utterform-linux-x86_64-system.tar.gz"
prefix="${UTTERFORM_PREFIX:-${HOME}/.local}"
Expand Down
2 changes: 1 addition & 1 deletion scripts/install-windows.ps1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Verify the NSIS setup before opening it; no elevation or forced app shutdown.
param(
[string]$Version = 'v1.1.0',
[string]$Version = 'v1.2.0',
[switch]$VerifyOnly
)

Expand Down
2 changes: 1 addition & 1 deletion src-tauri/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion src-tauri/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "utterform"
version = "1.1.0"
version = "1.2.0"
description = "Fast, lightweight voice-to-text transformation for the desktop"
authors = ["Jonas"]
edition = "2024"
Expand Down Expand Up @@ -66,6 +66,8 @@ zbus = "5.9"
[target.'cfg(target_os = "windows")'.dependencies]
windows-sys = { version = "0.61", features = ["Win32_UI_Input_KeyboardAndMouse", "Win32_UI_WindowsAndMessaging", "Win32_UI_Accessibility", "Win32_System_Threading", "Win32_Security", "Win32_Foundation"] }
winreg = "0.55"
# The microphone level (`mic_level`). Already in the build through cpal.
windows = { version = "0.62", features = ["Win32_Media_Audio", "Win32_Media_Audio_Endpoints", "Win32_System_Com", "Win32_System_Com_StructuredStorage"] }

[target.'cfg(target_os = "macos")'.dependencies]
# Typing at the cursor posts keyboard events through CoreGraphics; the frontmost
Expand Down
12 changes: 12 additions & 0 deletions src-tauri/src/commands.rs
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ pub fn save_settings(app: AppHandle, value: AppSettings) -> Result<(), String> {
app.state::<crate::Onboarding>()
.set(!value.onboarding_completed);
crate::tray_microphones::set_selected(&app, value.input_device.clone());
crate::mic_level::set(&app, value.microphone_level, value.input_device.clone());
diagnostics::info!(
"settings.saved",
engine = value.engine.as_str(),
Expand Down Expand Up @@ -152,6 +153,7 @@ pub fn complete_onboarding(
}
app.state::<crate::Onboarding>().set(false);
crate::tray_microphones::set_selected(&app, value.input_device.clone());
crate::mic_level::set(&app, value.microphone_level, value.input_device.clone());
if skipped {
diagnostics::info!("onboarding.skipped");
} else {
Expand All @@ -178,6 +180,16 @@ pub fn list_input_devices(app: AppHandle) -> Result<Vec<AudioDeviceInfo>, String
Ok(devices)
}

/// The microphone's level now, in percent, for Settings → Recording → Level
/// to start from. An error says why this system cannot hold the level.
#[tauri::command]
pub fn read_microphone_level(device: Option<String>) -> Result<u8, String> {
crate::mic_level::read(device.as_deref()).map_err(|error| {
diagnostics::warning!("mic_level.read_failed", error = error);
error
})
}

/// Open the microphone and play the start cue.
///
/// Asynchronous so the work leaves the main thread: a synchronous command runs
Expand Down
4 changes: 4 additions & 0 deletions src-tauri/src/domain.rs
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,9 @@ pub struct AppSettings {
pub engine: TranscriptionEngine,
pub cloud_model: CloudModel,
pub input_device: Option<String>,
/// The microphone level to hold, in percent; `None` leaves it to the
/// operating system. See `mic_level`.
pub microphone_level: Option<u8>,
pub output_directory: Option<String>,
pub copy_to_clipboard: bool,
pub save_to_file: bool,
Expand Down Expand Up @@ -227,6 +230,7 @@ impl Default for AppSettings {
engine: TranscriptionEngine::OpenAi,
cloud_model: CloudModel::GptTranscribe,
input_device: None,
microphone_level: None,
output_directory: None,
copy_to_clipboard: true,
save_to_file: false,
Expand Down
4 changes: 4 additions & 0 deletions src-tauri/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ mod hotkey;
mod live;
#[cfg(target_os = "macos")]
mod macos;
mod mic_level;
mod models;
mod output;
mod platform;
Expand Down Expand Up @@ -271,6 +272,7 @@ fn setup(app: &mut tauri::App, startup_intent: Intent) -> Result<(), Box<dyn std
}
tray::install(app.handle()).map_err(setup_stage("tray"))?;
tray_microphones::init(app.handle());
mic_level::init(app.handle());
Ok(())
}

Expand Down Expand Up @@ -319,6 +321,7 @@ pub fn run() {
.manage(feedback::DoneCues::default())
.manage(tray::TrayState::default())
.manage(tray_microphones::MicrophoneMenu::default())
.manage(mic_level::MicLevel::default())
.manage(live::LiveState::default())
.manage(StartupIntent::default())
.manage(Onboarding::default())
Expand Down Expand Up @@ -371,6 +374,7 @@ pub fn run() {
commands::save_settings,
commands::complete_onboarding,
commands::list_input_devices,
commands::read_microphone_level,
commands::start_recording,
commands::get_recording_status,
commands::get_live_status,
Expand Down
Loading
Loading