On-device audio transcripts that capture the words and how they were said.
Project description
A standard transcript gives you the words. It misses the undertones: where the pauses and overlaps fall, who interrupted whom, filler words, speaking pace, talk balance, and per-speaker voice quality such as pitch, jitter, and shimmer. Undertone captures both, and stores them as one structured, speaker-attributed transcript.
It ingests audio from local files or source connectors (YouTube, podcasts, Quill, Google Meet), then runs transcription, diarization, speaker embeddings, and enrichment locally through FluidAudio. Results are stored in SQLite, exportable as JSON, Markdown, text, or CSV, and can trigger a webhook when a transcript is ready. Audio never leaves the machine.
What You Get
Each transcript is stored with three layers.
Words and speakers. Diarized, speaker-attributed text with per-segment and optional per-word timings, plus stable cross-recording speaker fingerprints.
Per-segment enrichment (SegmentEnrichment):
is_interruption,overlap_with_prev_ms: who cut in, and by how muchgap_before_ms: the silence before a segmentfillers: counted "um", "uh", and similarsentiment,tone_tags,linguistic: text-derived enrichment
Per-speaker metrics (SpeakerVoiceMetrics):
talk_ratio,talk_time_ms,word_count,wpm: how much each speaker held the floor and how fastpause_count,avg_pause_ms: hesitation profileinterruptions_made,interruptions_received: turn dynamicsfiller_count,filler_rate: disfluencyf0_mean_hz,f0_stdev_hz,jitter_local,shimmer_local,voiced_duration_s,articulation_rate: acoustic voice quality, when voice metrics are enabled
Requirements
- macOS on Apple Silicon
- Python 3.11+
fluidaudiocli, built from FluidInference/FluidAudio (see Install). FluidAudio is a Swift SDK for on-device audio AI using Core ML and the Apple Neural Engine. Undertone does not vendor it; it shells out to the CLI that FluidAudio builds.yt-dlp, only for the YouTube connector- Google Application Default Credentials, only for Google Meet
- A local Quill database and recordings, only for Quill ingest
Install
1. Build the FluidAudio CLI
git clone https://github.com/FluidInference/FluidAudio.git
cd FluidAudio
swift build -c release --product fluidaudiocli
Then put it on PATH:
mkdir -p "$HOME/bin"
ln -sf "$PWD/.build/release/fluidaudiocli" "$HOME/bin/fluidaudiocli"
export PATH="$HOME/bin:$PATH"
or point Undertone at it directly:
export UNDERTONE_FLUIDAUDIO_CLI="$PWD/.build/release/fluidaudiocli"
FluidAudio downloads model assets from Hugging Face on first run. Upstream honors REGISTRY_URL / MODEL_REGISTRY_URL for mirrors and https_proxy for proxy routing, which matters on locked-down networks.
2. Install Undertone
From PyPI:
pip install undertone-audio
Optional extras:
pip install 'undertone-audio[voice]' # Parselmouth acoustic metrics
pip install 'undertone-audio[meet]' # Google Meet auth helpers
pip install 'undertone-audio[connectors]' # YouTube connector via yt-dlp
pip install 'undertone-audio[voice,meet,connectors]'
Or from source, for development:
pip install -e '.[dev]'
pip install -e '.[dev,voice,meet,connectors]'
3. Verify
command -v fluidaudiocli
undertone --help
undertone models
Quick Start
Run a local audio file:
UNDERTONE_WEBHOOK_ENABLED=0 undertone --db ./undertone.db run-wav ./meeting.wav \
--transcript-id meeting-1 \
--engine fluidaudio-hybrid \
--voice-metrics optional \
--output-format json \
--output-detail standard \
--output ./meeting.json
Load it later:
undertone --db ./undertone.db load meeting-1 --output-format text --output-detail minimal
undertone --db ./undertone.db list --limit 20
Operator browse/status commands print human-readable output by default. For agents and scripts, add --json for machine-readable output.
Search transcript text:
undertone --db ./undertone.db search "next steps"
undertone --db ./undertone.db search "next steps" --json
List persisted speaker fingerprints:
undertone --db ./undertone.db fingerprints
undertone --db ./undertone.db fingerprints --unnamed --excerpts
undertone --db ./undertone.db fingerprint-label VP-abc123 "Speaker Name"
Inspect effective model and backend selections:
undertone --db ./undertone.db models
undertone --db ./undertone.db doctor
undertone --db ./undertone.db doctor --all
Source commands are always visible. There is no per-source enable switch; a source becomes ready when its optional dependency, credentials, or local data exists. doctor shows optional source readiness, and source commands print fix-oriented messages when a dependency is missing.
Common maintenance commands:
undertone --db ./undertone.db reenrich meeting-1 --turn-gap-ms 600
undertone --db ./undertone.db webhook-preview meeting-1
undertone --db ./undertone.db fingerprint-label VP-abc123 "Speaker Name"
undertone --db ./undertone.db stats
undertone --db ./undertone.db delete meeting-1 --yes
Ingest commands fail instead of silently overwriting an existing transcript id. Pass --force to overwrite or --skip-existing to no-op when the target id already exists.
Engines
fluidaudio-hybrid is the default. It runs FluidAudio transcription, FluidAudio processing, and Sortformer-style diarization, then combines the outputs into Undertone's transcript schema. The default local stack is:
- ASR: FluidAudio Parakeet TDT
- diarization: FluidAudio Sortformer plus process output
- VAD: FluidAudio / Silero VAD
- speaker embeddings: FluidAudio pyannote-derived embeddings
- fingerprinting: undertone SQLite
speaker_fingerprints - acoustic metrics (optional): Parselmouth F0, jitter, shimmer, voiced duration, articulation rate
fluidaudio-cli is the simpler FluidAudio process path:
undertone --db ./undertone.db run-wav ./meeting.wav --engine fluidaudio-cli
Override model labels per command:
undertone run-wav ./meeting.wav \
--asr-model "FluidAudio Parakeet TDT" \
--diarization-model "FluidAudio Sortformer + process" \
--vad-model "FluidAudio/Silero VAD" \
--embedding-model "FluidAudio pyannote-derived speaker embeddings" \
--voice-metrics required
Non-default model flags are passed to the FluidAudio boundary. Unsupported combinations fail at audio processing time.
Source Rule
When audio is available, Undertone uses audio. Captions, feed notes, source text, and external speaker labels are provenance or fallback only. Population always goes through local ASR, diarization, embeddings, fingerprints, and enrichment.
This matters most for YouTube and podcasts. Caption pulls and plain podcast scripts produce searchable text but no reliable speaker attribution, so Undertone downloads the media and runs its own local pipeline.
Sources
YouTube
pip install -e '.[connectors,voice]'
UNDERTONE_WEBHOOK_ENABLED=0 undertone --db ./undertone.db youtube-ingest \
'https://www.youtube.com/watch?v=jNQXAC9IVRw' \
--download-dir ./downloads/youtube \
--engine fluidaudio-hybrid \
--voice-metrics optional \
--output ./youtube.json
Flags: --yt-dlp-bin (non-default binary), --audio-format wav, --include-playlist, --dry-run (select media and print metadata without ingesting).
Podcasts
undertone podcast-list 'https://example.com/feed.xml' --limit 20
undertone --db ./undertone.db podcast-ingest 'https://example.com/feed.xml' --episode 0
undertone --db ./undertone.db podcast-ingest 'https://example.com/feed.xml' --title-contains 'interview'
undertone --db ./undertone.db podcast-ingest 'https://cdn.example.com/episode.mp3'
Episodes are selected by zero-based --episode index or first --title-contains match. Direct media URLs skip RSS parsing.
Quill
undertone quill-list --limit 20
undertone --db ./undertone.db quill-ingest <quill-meeting-id> --engine fluidaudio-hybrid
undertone --db ./undertone.db quill-ingest --limit 10 --dry-run
Precedence: combined.m4a when present, otherwise a mix of mic.m4a and system.m4a. Quill ASR and SPK-* labels are ignored when audio exists. Override locations with --quill-db and --meetings-dir.
Google Meet
pip install -e '.[meet]'
gcloud auth application-default login \
--scopes="https://www.googleapis.com/auth/meetings.space.readonly,https://www.googleapis.com/auth/drive.meet.readonly"
undertone --db ./undertone.db meet-discover --google-account you@example.com
undertone --db ./undertone.db meet-ingest conferenceRecords/... --audio ./recording.mp4
undertone --db ./undertone.db meet-ingest conferenceRecords/... --adc-file ./google-adc.json
Prerequisites: install the .[meet] extra, install the Google Cloud CLI, enable the Google Meet API for the credential's project, and create ADC with the scopes above. meetings.space.readonly is used for conference records, transcript lists, transcript entries, participants, and recording metadata. drive.meet.readonly is used only when Undertone downloads a Meet recording file. The authenticated account must have access to the conference/artifact; it does not have to be the organizer for every artifact, but it cannot read arbitrary meetings.
Precedence: explicit --audio, then a downloadable Meet Drive recording, then Meet API text. Text fallback is marked diarization_state=text-fallback and produces no voice fingerprints. Use --no-text-fallback to fail instead of persisting text-only output. For multiple Google accounts, --adc-file selects credentials explicitly. Use --no-probe on meet-discover to skip per-record recording/transcript probes after listing conference records; Meet discovery still requires Google auth.
Configurable Paths
No command needs a machine-specific absolute path. Defaults are portable:
- database:
UNDERTONE_DB_PATHor--db(default./undertone.db) - connector downloads:
UNDERTONE_DOWNLOAD_DIR,--download-dir,XDG_CACHE_HOME/undertone/downloads, or~/.cache/undertone/downloads - FluidAudio binary:
UNDERTONE_FLUIDAUDIO_CLI,FLUIDAUDIO_CLI, orfluidaudioclionPATH
Output Formats
Every ingest and load command can choose a format and a detail level:
undertone --db ./undertone.db load meeting-1 --output-format md --output-detail minimal --output meeting.md
undertone --db ./undertone.db load meeting-1 --output-format jsonl --output-detail full
undertone --db ./undertone.db run-wav ./meeting.wav --output-format text --output-detail standard
Formats:
json: enriched transcriptraw-json: pre-enrichment raw transcriptjsonl: one segment per linecsv: speaker metrics tabletext: readable speaker summary and transcriptmd: Markdown speaker summary and transcript
Detail levels:
minimal: transcript text, timing, and speaker basicsstandard: adds enrichment and non-acoustic speaker metricsfull: adds per-word timings and acoustic metrics
Python API
Run the pipeline directly:
import asyncio
from undertone_audio import AudioPipeline
from undertone_audio.engines import create_engine
from undertone_audio.storage import TranscriptStore
store = TranscriptStore("undertone.db")
pipeline = AudioPipeline(store=store, engine=create_engine()) # defaults to fluidaudio-hybrid
transcript = asyncio.run(pipeline.run("./meeting.wav", transcript_id="meeting-1"))
Save a raw transcript built elsewhere:
from undertone_audio import AudioPipeline, Segment, Speaker
from undertone_audio.engines.base import RawTranscript
from undertone_audio.storage import TranscriptStore
store = TranscriptStore("undertone.db")
pipeline = AudioPipeline(store=store)
pipeline.finalize_raw(
RawTranscript(
duration_ms=1000,
language="en",
engine="example",
speakers=[Speaker(speaker_id="S1")],
segments=[Segment(segment_id="seg1", speaker_id="S1", start_ms=0, end_ms=1000, text="hello")],
),
transcript_id="meeting-1",
)
transcript = store.load("meeting-1")
The same raw shape can be saved through the CLI:
undertone --db ./undertone.db finalize-json raw-transcript.json \
--transcript-id meeting-1 \
--diarization-state ok
Plugging In A Diarization Backend
The backend boundary is small. An engine implements the TranscriptionEngine protocol from undertone_audio.engines.base:
from pathlib import Path
from undertone_audio.engines.base import RawTranscript
class MyEngine:
name = "my-engine"
async def healthcheck(self) -> bool:
return True
async def transcribe(self, audio_path: Path) -> RawTranscript:
...
transcribe() returns a RawTranscript. For diarized output, populate:
speakers: stable source speaker IDs, optional display names, optional embeddingssegments: speaker-attributed text withstart_ms,end_ms, and optional word timingsengine: a backend name that makes the source clear in persisted metadata
If the backend can produce speaker embeddings, set them on Speaker.embedding; Undertone assigns and persists cross-recording fingerprint_id values. If the backend only produces ASR text, use a single speaker and set a degraded diarization_state when finalizing, so downstream consumers do not mistake ASR-only output for speaker-attributed output.
Pass a custom engine to the pipeline directly:
pipeline = AudioPipeline(store=store, engine=MyEngine())
To make a backend selectable from undertone run-wav --engine ..., add it to undertone_audio.engines.create_engine() and add the engine name to the shared pipeline argument choices in src/undertone_audio/commands/common.py. src/undertone_audio/cli.py only wires command modules.
Webhook
export UNDERTONE_WEBHOOK_URL=https://example.com/webhooks/meeting-ready
export UNDERTONE_WEBHOOK_SECRET=shared-secret
export UNDERTONE_WEBHOOK_ENABLED=1
When enabled, a ready transcript emits:
{
"event": "meeting.transcript.ready",
"transcript_id": "meeting-1",
"source": "undertone",
"recorded_at": null,
"store_ref": "sqlite:/abs/path/undertone.db#meeting-1"
}
The signature header is x-zen-signature-256, a SHA-256 HMAC over the payload body. Re-emit readiness for a saved transcript with undertone emit-ready <transcript-id>.
Configuration
UNDERTONE_DB_PATH=./undertone.db
UNDERTONE_ENGINE=fluidaudio-hybrid
UNDERTONE_FLUIDAUDIO_CLI=/path/to/fluidaudiocli
UNDERTONE_DOWNLOAD_DIR=./downloads
UNDERTONE_VOICE_METRICS=optional
UNDERTONE_OUTPUT_FORMAT=json
UNDERTONE_OUTPUT_DETAIL=full
UNDERTONE_WEBHOOK_ENABLED=0
Models and thresholds:
UNDERTONE_ASR_MODEL="FluidAudio Parakeet TDT"
UNDERTONE_DIARIZATION_MODEL="FluidAudio Sortformer + process"
UNDERTONE_VAD_MODEL="FluidAudio/Silero VAD"
UNDERTONE_EMBEDDING_MODEL="FluidAudio pyannote-derived speaker embeddings"
UNDERTONE_FINGERPRINT_BACKEND=undertone-speaker-fingerprints
UNDERTONE_CLUSTERING_THRESHOLD=0.7045655
UNDERTONE_SPEAKER_MERGE_THRESHOLD=0.82
UNDERTONE_MIN_TALK_SECONDS=1.5
UNDERTONE_FINGERPRINT_SIMILARITY_THRESHOLD=0.78
UNDERTONE_TURN_GAP_MS=800
Feature toggles:
UNDERTONE_ENABLE_TURN_TAKING=1
UNDERTONE_ENABLE_FILLERS=1
UNDERTONE_ENABLE_LINGUISTIC=1
UNDERTONE_ENABLE_MEETING_TYPE=1
Validation
pip install -e '.[dev]'
pytest -q tests
python -m compileall -q src tests
End-to-end smoke test against a real video:
RUN_DIR="$(mktemp -d)"
UNDERTONE_WEBHOOK_ENABLED=0 undertone --db "$RUN_DIR/undertone.db" youtube-ingest \
'https://www.youtube.com/watch?v=Aq5WXmQQooo' \
--download-dir "$RUN_DIR/downloads" \
--engine fluidaudio-hybrid \
--voice-metrics optional \
--output "$RUN_DIR/transcript.json"
undertone --db "$RUN_DIR/undertone.db" load youtube-Aq5WXmQQooo \
--output-format text --output-detail minimal
Operator Skills
Agent and operator workflows live under skills/:
undertone-ingest: local audio, raw transcript JSON, model flagsundertone-meetings-ingest: Quill and Google Meet recordings, source precedence, text fallbackundertone-connectors: YouTube, podcasts, RSS feeds, direct media URLs, connector pathsundertone-exports: output formats, detail levels, search, load, webhook re-emissionundertone-ops: install, tests, package checks, models, fingerprints
A Claude-compatible dispatcher lives at .claude/skills/undertone/SKILL.md.
License
Apache-2.0. See LICENSE.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file undertone_audio-0.1.1.tar.gz.
File metadata
- Download URL: undertone_audio-0.1.1.tar.gz
- Upload date:
- Size: 73.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ff5544d35e335ea750db1763d1c2446dc031088e7032f35240b30179607f0160
|
|
| MD5 |
cfbc57ffa086108e554c8d37222ac37d
|
|
| BLAKE2b-256 |
3c4d5b38e250e03e918fb2cd71b27cb6bf20df66fbd4b844eaa91dddd07963c6
|
Provenance
The following attestation bundles were made for undertone_audio-0.1.1.tar.gz:
Publisher:
publish.yml on zm2231/undertone
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
undertone_audio-0.1.1.tar.gz -
Subject digest:
ff5544d35e335ea750db1763d1c2446dc031088e7032f35240b30179607f0160 - Sigstore transparency entry: 1921045326
- Sigstore integration time:
-
Permalink:
zm2231/undertone@4e4c637ec2c402349b0a29505d2de4d06f0edc5f -
Branch / Tag:
refs/tags/v0.1.1 - Owner: https://github.com/zm2231
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@4e4c637ec2c402349b0a29505d2de4d06f0edc5f -
Trigger Event:
release
-
Statement type:
File details
Details for the file undertone_audio-0.1.1-py3-none-any.whl.
File metadata
- Download URL: undertone_audio-0.1.1-py3-none-any.whl
- Upload date:
- Size: 82.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8d0f7e3aedecee1866a41c896d7030390773d713de279761e510ffb90be65193
|
|
| MD5 |
a124d133902bdba5ca500969015c27a9
|
|
| BLAKE2b-256 |
b8b04669ed04fd9236d001b02fd8370a2ed593fce22d6e20d6f9d862465be4d8
|
Provenance
The following attestation bundles were made for undertone_audio-0.1.1-py3-none-any.whl:
Publisher:
publish.yml on zm2231/undertone
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
undertone_audio-0.1.1-py3-none-any.whl -
Subject digest:
8d0f7e3aedecee1866a41c896d7030390773d713de279761e510ffb90be65193 - Sigstore transparency entry: 1921045416
- Sigstore integration time:
-
Permalink:
zm2231/undertone@4e4c637ec2c402349b0a29505d2de4d06f0edc5f -
Branch / Tag:
refs/tags/v0.1.1 - Owner: https://github.com/zm2231
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@4e4c637ec2c402349b0a29505d2de4d06f0edc5f -
Trigger Event:
release
-
Statement type: