yapsnap 0.1.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,234 @@
1
+ Metadata-Version: 2.4
2
+ Name: yapsnap
3
+ Version: 0.1.0
4
+ Summary: Snap any video URL or local audio/video into a plaintext transcript. CPU-first, offline, single command.
5
+ Author: yapsnap
6
+ License: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/kouhxp/yapsnap
8
+ Project-URL: Issues, https://github.com/kouhxp/yapsnap/issues
9
+ Keywords: asr,transcription,sherpa-onnx,kroko,yt-dlp,youtube,tiktok,instagram,transcribe
10
+ Classifier: Programming Language :: Python :: 3
11
+ Classifier: Operating System :: OS Independent
12
+ Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
13
+ Requires-Python: >=3.9
14
+ Description-Content-Type: text/markdown
15
+ License-File: LICENSE
16
+ Requires-Dist: sherpa-onnx>=1.10
17
+ Requires-Dist: numpy>=1.23
18
+ Requires-Dist: yt-dlp>=2026.3.17
19
+ Dynamic: license-file
20
+
21
+ # yapsnap
22
+
23
+ > **Snap any video URL or audio file into plaintext. No GPU. No cloud. One command.**
24
+
25
+ ![Python](https://img.shields.io/badge/python-3.9+-blue) ![License](https://img.shields.io/badge/license-Apache--2.0-green) ![Platforms](https://img.shields.io/badge/platforms-macOS%20%7C%20Linux%20%7C%20Windows-lightgrey)
26
+
27
+ ```bash
28
+ yapsnap "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
29
+ ```
30
+
31
+ That's it. You get a `.txt` next to your shell, transcribed on your CPU, in less time than it took the video to play.
32
+
33
+ ---
34
+
35
+ ## Why yapsnap
36
+
37
+ - ⚡ **Fast on CPU.** Streaming Zipformer transducer (Kroko English) chews through audio at several times realtime on a laptop. No CUDA. No M-series-only tricks. Plain old cores.
38
+ - 🌐 **Any video URL, plus local files.** YouTube. X. TikTok. Instagram Reels. Direct `.mp4`/`.mp3` links. Or just point it at a file on disk. yt-dlp handles the fetch, ffmpeg handles the decode, the rest is yours.
39
+ - 📴 **Offline after first run.** ~80 MB model downloads once to your cache and stays there. No API keys. No quotas. Your audio never leaves your machine.
40
+ - 🪶 **One file, three deps.** `sherpa-onnx`, `numpy`, `yt-dlp`. The whole tool is a single Python module.
41
+ - 🗣 **Ten-plus languages.** English out of the box; French, German, Spanish, Italian, Portuguese, Dutch, Swedish, Swiss German, Hebrew, and Turkish are a one-line `--model` swap away. See [Other languages](#other-languages).
42
+ - ⏱ **Sentence-level timestamps when you want them.** `--timestamps` adds `[MM:SS]` per sentence using Kroko's built-in punctuation. Timing stays correct even when you transcribe at 2x.
43
+
44
+ ---
45
+
46
+ ## Quickstart
47
+
48
+ ```bash
49
+ # 1. ffmpeg on PATH (one-time, per OS — see below)
50
+ # 2. Install (from PyPI, or `pip install .` from a clone)
51
+ pip install yapsnap
52
+
53
+ # 3. Snap something
54
+ yapsnap https://www.tiktok.com/@user/video/7234567890123456789
55
+ yapsnap meeting.mp4 --timestamps
56
+ yapsnap podcast.mp3 -o ~/notes/episode.txt
57
+ ```
58
+
59
+ The first run downloads the model (~80 MB). Every run after is offline.
60
+
61
+ ---
62
+
63
+ ## What it handles
64
+
65
+ Any URL `yt-dlp` understands works. The big ones:
66
+
67
+ | Source | Example |
68
+ |-------------------|---------------------------------------------------------|
69
+ | YouTube | `https://www.youtube.com/watch?v=...` |
70
+ | YouTube Shorts | `https://www.youtube.com/shorts/...` |
71
+ | X / Twitter | `https://x.com/user/status/.../video/1` |
72
+ | TikTok | `https://www.tiktok.com/@user/video/...` |
73
+ | Instagram Reels | `https://www.instagram.com/reel/.../` |
74
+ | Direct media URL | `https://example.com/clip.mp4` |
75
+
76
+ Plus any local file ffmpeg can decode: `.mp3`, `.mp4`, `.m4a`, `.wav`, `.webm`, `.mov`, `.mkv`, `.aac`, `.opus`, `.ogg`, `.flac`, and friends.
77
+
78
+ ---
79
+
80
+ ## Install
81
+
82
+ ### 1. ffmpeg
83
+
84
+ | OS | Command |
85
+ |---------|----------------------------------------------------------|
86
+ | macOS | `brew install ffmpeg` |
87
+ | Linux | `sudo apt install ffmpeg` *or* `sudo dnf install ffmpeg` |
88
+ | Windows | `winget install ffmpeg` *or* `choco install ffmpeg` |
89
+
90
+ ### 2. yapsnap
91
+
92
+ From PyPI (recommended):
93
+
94
+ ```bash
95
+ pip install yapsnap
96
+ ```
97
+
98
+ From source:
99
+
100
+ ```bash
101
+ git clone https://github.com/kouhxp/yapsnap
102
+ cd yapsnap
103
+ pip install .
104
+ ```
105
+
106
+ Installs two equivalent commands on your `PATH`: **`yapsnap`** (canonical) and **`transcribe`** (alias, for when the name slips your mind).
107
+
108
+ ---
109
+
110
+ ## Usage
111
+
112
+ ```bash
113
+ # Local file
114
+ yapsnap path/to/audio.mp3
115
+
116
+ # Any video URL
117
+ yapsnap "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
118
+
119
+ # Sentence-level timestamps
120
+ yapsnap input.mp4 --timestamps
121
+
122
+ # Custom output path
123
+ yapsnap input.mp4 -o ./transcripts/talk.txt
124
+
125
+ # Don't speed audio up before transcribing (default is 1.5x, pitch preserved)
126
+ yapsnap input.mp4 --speed 1.0
127
+
128
+ # Keep the downloaded audio (URL inputs only)
129
+ yapsnap "https://..." --keep-audio
130
+ ```
131
+
132
+ ---
133
+
134
+ ## Output
135
+
136
+ Plaintext, UTF-8. Default location is `./transcripts/` (created if missing) under the current working directory; override with `-o`. For URL inputs the filename is derived from the video ID (`dQw4w9WgXcQ_transcript.txt`, etc.).
137
+
138
+ **Without `--timestamps`** — one paragraph of recognized text:
139
+
140
+ ```
141
+ Welcome to the show. Today we're talking about transcription. Let's get started.
142
+ ```
143
+
144
+ **With `--timestamps`** — one sentence per line, timed against the original audio:
145
+
146
+ ```
147
+ [00:00] Welcome to the show.
148
+ [00:03] Today we're talking about transcription.
149
+ [00:08] Let's get started.
150
+ ```
151
+
152
+ Timestamps stay in original-audio time even at `--speed 1.5` or higher.
153
+
154
+ ---
155
+
156
+ ## Flags
157
+
158
+ | Flag | Description |
159
+ |-------------------|----------------------------------------------------------------------|
160
+ | `-o`, `--output` | Output `.txt` path. Default: `./transcripts/<input>_transcript.txt`. |
161
+ | `--timestamps` | Emit `[MM:SS] sentence.` lines instead of a single paragraph. |
162
+ | `--speed` | Pre-transcription speedup factor, pitch preserved. Default `1.5`. |
163
+ | `--keep-audio` | Keep the downloaded audio (URL inputs only). |
164
+ | `--model` | Override the model directory. Also reads `KROKO_MODEL` env var. |
165
+
166
+ ---
167
+
168
+ ## How it works
169
+
170
+ 1. **Fetch.** If the input is a URL, `yt-dlp` grabs the best audio-only stream to a temp directory. If it's a local path, this step is skipped.
171
+ 2. **Decode.** `ffmpeg` pipes the media into 16 kHz mono PCM. The optional `atempo` filter speeds it up without raising pitch.
172
+ 3. **Recognize.** A streaming Zipformer2 transducer (Kroko English, INT8 ONNX, ~80 MB) eats the PCM in chunks. CPU-only. Greedy decode.
173
+ 4. **Format.** Plain text by default. With `--timestamps`, token timestamps are grouped on `.!?` into sentences and scaled back to original-audio time.
174
+
175
+ No frame is sent anywhere. No state is kept between runs except the cached model.
176
+
177
+ ---
178
+
179
+ ## Model & cache
180
+
181
+ The default Kroko English model is downloaded on first run to:
182
+
183
+ - **macOS** — `~/Library/Caches/yapsnap/`
184
+ - **Linux** — `$XDG_CACHE_HOME/yapsnap/` (or `~/.cache/yapsnap/`)
185
+ - **Windows** — `%LOCALAPPDATA%\yapsnap\`
186
+
187
+ To use a different streaming transducer (other languages, larger Kroko variants, etc.), point `--model` at a directory containing `encoder(.int8).onnx`, `decoder(.int8).onnx`, `joiner(.int8).onnx`, and `tokens.txt`. Or set `KROKO_MODEL` in your environment.
188
+
189
+ ---
190
+
191
+ ## Other languages
192
+
193
+ The default model is English, but yapsnap isn't limited to it. To transcribe another language, just download the matching model and point yapsnap at it — no code changes, no reinstall.
194
+
195
+ Kroko publishes streaming models for a growing list of languages on Hugging Face: <https://huggingface.co/Banafo/Kroko-ASR/tree/main>. As of now that includes:
196
+
197
+ - Dutch
198
+ - French
199
+ - German
200
+ - Hebrew
201
+ - Italian
202
+ - Portuguese
203
+ - Spanish
204
+ - Swedish
205
+ - Swiss German
206
+ - Turkish
207
+
208
+ Download the one you need, unpack it into its own folder, and run:
209
+
210
+ ```bash
211
+ # Per-run: pass the model folder explicitly
212
+ yapsnap interview.mp3 --model /path/to/kroko-french
213
+
214
+ # Or set it once as your default for the session
215
+ export KROKO_MODEL=/path/to/kroko-french
216
+ yapsnap interview.mp3
217
+ ```
218
+
219
+ Each model is single-language, so to work across several languages keep them in separate folders and switch with `--model` (or re-export `KROKO_MODEL`) as you go. Any other sherpa-onnx streaming transducer with the standard `encoder` / `decoder` / `joiner` / `tokens.txt` layout works too, not just the Kroko ones.
220
+
221
+ ---
222
+
223
+ ## Notes & limits
224
+
225
+ - The default model is **English**. For other languages, download a matching model and pass it with `--model` — see [Other languages](#other-languages) for the current list and instructions.
226
+ - `--speed 1.5` shaves about a third off transcription time with minimal accuracy cost. Try `2.0` if you want it even faster, or `1.0` for noisy, mumbled, or fast-speech sources.
227
+ - Some social-media URLs are geo-locked or login-walled; `yt-dlp` will say so explicitly.
228
+ - This is a streaming model, so timestamps come from token positions in the recognized stream. They're accurate enough for navigation, not for subtitling-grade alignment.
229
+
230
+ ---
231
+
232
+ ## License
233
+
234
+ Apache-2.0 for this project. The Kroko model is distributed under its own license — see <https://huggingface.co/Banafo/Kroko-ASR>. Powered by [sherpa-onnx](https://github.com/k2-fsa/sherpa-onnx) and [yt-dlp](https://github.com/yt-dlp/yt-dlp).
@@ -0,0 +1,7 @@
1
+ yapsnap.py,sha256=seAP6DQMJuPvi3eBq9rRshNvuFl2Ct-1Deg_7OLe2v8,19703
2
+ yapsnap-0.1.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
3
+ yapsnap-0.1.0.dist-info/METADATA,sha256=TkKuEaDFrq8rltsFo03faWrvDVHXnZedvXGgxrjp8VI,9297
4
+ yapsnap-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
5
+ yapsnap-0.1.0.dist-info/entry_points.txt,sha256=JitfXD0bS1PD21mHbG8NKeoXzHXuVkutGR6eh1QffCQ,67
6
+ yapsnap-0.1.0.dist-info/top_level.txt,sha256=H2UXXeoQ0sz5UTQrlyBVjxFSbtgQwWPpDYOsMzuW2x8,8
7
+ yapsnap-0.1.0.dist-info/RECORD,,
@@ -0,0 +1,5 @@
1
+ Wheel-Version: 1.0
2
+ Generator: setuptools (82.0.1)
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
5
+
@@ -0,0 +1,3 @@
1
+ [console_scripts]
2
+ transcribe = yapsnap:main
3
+ yapsnap = yapsnap:main
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1 @@
1
+ yapsnap
yapsnap.py ADDED
@@ -0,0 +1,522 @@
1
+ #!/usr/bin/env python3
2
+ """
3
+ yapsnap — snap any video or audio into plaintext.
4
+
5
+ Transcribes a local audio/video file or a URL (YouTube, X, TikTok, Instagram,
6
+ or any direct mp3/mp4 URL) using the sherpa-onnx streaming Kroko English
7
+ transducer. Runs entirely on CPU.
8
+
9
+ Usage:
10
+ yapsnap INPUT [-o OUTPUT.txt] [--timestamps] [--speed 1.5] [--keep-audio] [--model DIR]
11
+
12
+ INPUT may be:
13
+ - a local file (.mp3, .mp4, .m4a, .wav, .webm, ...)
14
+ - a URL (YouTube, X/Twitter, TikTok, Instagram, generic mp4/mp3, ...)
15
+ """
16
+
17
+ from __future__ import annotations
18
+
19
+ import argparse
20
+ import os
21
+ import re
22
+ import shutil
23
+ import subprocess
24
+ import sys
25
+ import tempfile
26
+ import urllib.error
27
+ import urllib.request
28
+ from pathlib import Path
29
+ from typing import Optional
30
+
31
+ import numpy as np
32
+
33
+ SAMPLE_RATE = 16000
34
+ FEATURE_DIM = 80
35
+
36
+ # Auto-download source for the default Kroko English streaming model.
37
+ # The repo ships plain .onnx (no .int8 variants); find_model_file still prefers
38
+ # int8 if a custom --model dir provides them.
39
+ DEFAULT_MODEL_REPO = "csukuangfj/sherpa-onnx-streaming-zipformer-en-kroko-2025-08-06"
40
+ DEFAULT_MODEL_FILES = ("encoder.onnx", "decoder.onnx", "joiner.onnx", "tokens.txt")
41
+ HF_BASE = "https://huggingface.co"
42
+ HTTP_UA = "yapsnap/0.1 (+https://github.com/)"
43
+
44
+ URL_RE = re.compile(r"^https?://", re.IGNORECASE)
45
+
46
+
47
+ # ---------------------------------------------------------------------------
48
+ # Model resolution / auto-download
49
+ # ---------------------------------------------------------------------------
50
+
51
+ def user_cache_dir() -> Path:
52
+ """Return a per-user cache dir for storing the auto-downloaded model.
53
+ Cross-platform: XDG on Linux, ~/Library/Caches on macOS, %LOCALAPPDATA% on Windows.
54
+ """
55
+ if sys.platform == "win32":
56
+ base = os.environ.get("LOCALAPPDATA") or str(Path.home() / "AppData" / "Local")
57
+ return Path(base) / "yapsnap"
58
+ if sys.platform == "darwin":
59
+ return Path.home() / "Library" / "Caches" / "yapsnap"
60
+ xdg = os.environ.get("XDG_CACHE_HOME")
61
+ base = Path(xdg) if xdg else Path.home() / ".cache"
62
+ return base / "yapsnap"
63
+
64
+
65
+ def find_model_file(model_dir: Path, base: str) -> str:
66
+ """Find encoder/decoder/joiner ONNX, preferring int8."""
67
+ for name in (f"{base}.int8.onnx", f"{base}.onnx"):
68
+ p = model_dir / name
69
+ if p.is_file():
70
+ return str(p)
71
+ raise FileNotFoundError(f"No {base}(.int8).onnx found in {model_dir}")
72
+
73
+
74
+ def _download(url: str, dest: Path) -> None:
75
+ """Download a URL to a file, showing simple progress.
76
+
77
+ Sends a User-Agent (HuggingFace sometimes rejects the default urllib UA).
78
+ Sanity-checks tokens.txt as text and .onnx as binary > 1KB, so we fail loud
79
+ instead of writing an HTML error page to disk.
80
+ """
81
+ print(f" fetching {url}", file=sys.stderr)
82
+ dest.parent.mkdir(parents=True, exist_ok=True)
83
+ tmp = dest.with_suffix(dest.suffix + ".part")
84
+
85
+ req = urllib.request.Request(url, headers={"User-Agent": HTTP_UA})
86
+ try:
87
+ resp = urllib.request.urlopen(req)
88
+ except urllib.error.HTTPError as e:
89
+ raise RuntimeError(f"HTTP {e.code} {e.reason} for {url}") from e
90
+ except urllib.error.URLError as e:
91
+ raise RuntimeError(f"network error for {url}: {e.reason}") from e
92
+
93
+ with resp, open(tmp, "wb") as f:
94
+ total = int(resp.headers.get("Content-Length", 0))
95
+ read = 0
96
+ chunk = 1 << 16
97
+ while True:
98
+ buf = resp.read(chunk)
99
+ if not buf:
100
+ break
101
+ f.write(buf)
102
+ read += len(buf)
103
+ if total:
104
+ pct = 100.0 * read / total
105
+ print(f"\r {read/1e6:.1f} / {total/1e6:.1f} MB ({pct:.0f}%)",
106
+ end="", file=sys.stderr)
107
+ print("", file=sys.stderr)
108
+
109
+ # Sanity check: don't accept tiny HTML error pages as ONNX files.
110
+ size = tmp.stat().st_size
111
+ if dest.suffix == ".onnx" and size < 1024:
112
+ tmp.unlink(missing_ok=True)
113
+ raise RuntimeError(
114
+ f"downloaded {dest.name} is only {size} bytes \u2014 likely an error page, not a model"
115
+ )
116
+ tmp.replace(dest)
117
+
118
+
119
+ def ensure_default_model() -> Path:
120
+ """Download the default Kroko English model into the user cache if missing.
121
+ Returns the directory containing encoder/decoder/joiner/tokens."""
122
+ cache = user_cache_dir() / DEFAULT_MODEL_REPO.replace("/", "__")
123
+ cache.mkdir(parents=True, exist_ok=True)
124
+ missing = [f for f in DEFAULT_MODEL_FILES if not (cache / f).is_file()]
125
+ if not missing:
126
+ return cache
127
+
128
+ print(f"Downloading Kroko English model to {cache}", file=sys.stderr)
129
+ for fname in missing:
130
+ url = f"{HF_BASE}/{DEFAULT_MODEL_REPO}/resolve/main/{fname}"
131
+ try:
132
+ _download(url, cache / fname)
133
+ except Exception as e:
134
+ raise RuntimeError(
135
+ f"failed to download {fname} from {url}: {e}\n"
136
+ f"You can download the model manually from {HF_BASE}/{DEFAULT_MODEL_REPO} "
137
+ f"and pass its directory via --model."
138
+ ) from e
139
+ return cache
140
+
141
+
142
+ def resolve_model_dir(model_arg: Optional[Path]) -> Path:
143
+ """Resolve the model directory from CLI arg, env var, or auto-download."""
144
+ candidate = model_arg or (
145
+ Path(os.environ["KROKO_MODEL"]) if os.environ.get("KROKO_MODEL") else None
146
+ )
147
+ if candidate is not None:
148
+ if not candidate.is_dir():
149
+ raise FileNotFoundError(f"--model directory not found: {candidate}")
150
+ if not (candidate / "tokens.txt").is_file():
151
+ raise FileNotFoundError(f"tokens.txt not found in {candidate}")
152
+ return candidate
153
+ return ensure_default_model()
154
+
155
+
156
+ # ---------------------------------------------------------------------------
157
+ # Input handling: download URLs, decode any media to PCM
158
+ # ---------------------------------------------------------------------------
159
+
160
+ def _require_tool(name: str) -> None:
161
+ if shutil.which(name) is None:
162
+ raise RuntimeError(
163
+ f"required tool '{name}' not found in PATH. "
164
+ f"Install it and try again (see README)."
165
+ )
166
+
167
+
168
+ def is_url(s: str) -> bool:
169
+ return bool(URL_RE.match(s))
170
+
171
+
172
+ def download_url(url: str, workdir: Path) -> Path:
173
+ """Use yt-dlp to download audio from any supported URL.
174
+
175
+ Format selection is tuned to avoid TikTok's audio-stripped 'Playback video'
176
+ formats. The chain tries, in order:
177
+
178
+ 1. download_addr \u2014 TikTok's regular download format (always carries audio)
179
+ 2. h264 \u2014 TikTok's 'Direct video' h264 format (also has audio)
180
+ 3. bestaudio \u2014 audio-only stream when offered (YouTube etc.)
181
+ 4. best \u2014 generic fallback
182
+
183
+ The first two are TikTok-specific format IDs; on every other site they
184
+ simply don't match and yt-dlp falls through to bestaudio/best cleanly.
185
+
186
+ Returns path to a single media file in workdir.
187
+ """
188
+ _require_tool("yt-dlp")
189
+ workdir.mkdir(parents=True, exist_ok=True)
190
+ out_tpl = str(workdir / "%(id)s.%(ext)s")
191
+ cmd = [
192
+ "yt-dlp",
193
+ "--no-playlist",
194
+ "--no-warnings",
195
+ "-f", "download_addr/h264/bestaudio/best",
196
+ "-o", out_tpl,
197
+ url,
198
+ ]
199
+ try:
200
+ subprocess.run(cmd, check=True)
201
+ except subprocess.CalledProcessError as e:
202
+ raise RuntimeError(f"yt-dlp failed for {url}: exit {e.returncode}") from e
203
+
204
+ files = sorted(p for p in workdir.iterdir() if p.is_file())
205
+ if not files:
206
+ raise RuntimeError(f"yt-dlp produced no files for {url}")
207
+ files.sort(key=lambda p: p.stat().st_size, reverse=True)
208
+ return files[0]
209
+
210
+
211
+ def _has_audio_stream(media_path: Path) -> bool:
212
+ """Return True if ffprobe finds at least one audio stream."""
213
+ if shutil.which("ffprobe") is None:
214
+ # ffprobe ships with ffmpeg; if it's missing, skip the check.
215
+ return True
216
+ try:
217
+ proc = subprocess.run(
218
+ ["ffprobe", "-v", "error", "-select_streams", "a",
219
+ "-show_entries", "stream=codec_type", "-of", "csv=p=0",
220
+ str(media_path)],
221
+ capture_output=True, check=True, text=True,
222
+ )
223
+ except subprocess.CalledProcessError:
224
+ return False
225
+ return "audio" in proc.stdout.lower()
226
+
227
+
228
+ def decode_to_pcm(media_path: Path, speed: float = 1.0) -> np.ndarray:
229
+ """Decode any audio/video file ffmpeg understands to 16kHz mono float32.
230
+ `speed` applies atempo (pitch-preserving). atempo accepts 0.5..2.0 per stage.
231
+ """
232
+ _require_tool("ffmpeg")
233
+
234
+ if not _has_audio_stream(media_path):
235
+ raise RuntimeError(
236
+ f"{media_path.name} has no audio stream that ffmpeg can read. "
237
+ f"For TikTok this can happen when only the 'Playback video' format was "
238
+ f"available; updating yt-dlp (pip install -U yt-dlp) usually fixes it."
239
+ )
240
+
241
+ cmd = ["ffmpeg", "-nostdin", "-loglevel", "error", "-i", str(media_path)]
242
+ if abs(speed - 1.0) > 1e-5:
243
+ stages, remaining = [], float(speed)
244
+ while remaining > 2.0:
245
+ stages.append("atempo=2.0")
246
+ remaining /= 2.0
247
+ while remaining < 0.5:
248
+ stages.append("atempo=0.5")
249
+ remaining /= 0.5
250
+ if abs(remaining - 1.0) > 1e-5:
251
+ stages.append(f"atempo={remaining}")
252
+ if stages:
253
+ cmd += ["-filter:a", ",".join(stages)]
254
+
255
+ cmd += ["-f", "s16le", "-acodec", "pcm_s16le", "-ac", "1", "-ar", str(SAMPLE_RATE), "-"]
256
+
257
+ try:
258
+ proc = subprocess.run(cmd, capture_output=True, check=True)
259
+ except subprocess.CalledProcessError as e:
260
+ raise RuntimeError(
261
+ f"ffmpeg failed for {media_path}: {e.stderr.decode('utf-8', errors='ignore')}"
262
+ ) from e
263
+
264
+ if not proc.stdout:
265
+ return np.array([], dtype=np.float32)
266
+ return np.frombuffer(proc.stdout, dtype=np.int16).astype(np.float32) / 32768.0
267
+
268
+
269
+ # ---------------------------------------------------------------------------
270
+ # Transcription
271
+ # ---------------------------------------------------------------------------
272
+
273
+ def _format_mmss(seconds: float) -> str:
274
+ seconds = max(0.0, float(seconds))
275
+ m, s = divmod(int(seconds), 60)
276
+ return f"{m:02d}:{s:02d}"
277
+
278
+
279
+ def _join_tokens(tokens: list[str]) -> str:
280
+ """Reconstruct text from BPE-style tokens that use ▁ for word starts."""
281
+ out = []
282
+ for t in tokens:
283
+ if t.startswith("\u2581"):
284
+ out.append(" " + t[1:])
285
+ else:
286
+ out.append(t)
287
+ return "".join(out).strip()
288
+
289
+
290
+ def _group_into_sentences(tokens: list[str], timestamps: list[float], speed: float
291
+ ) -> list[tuple[float, str]]:
292
+ """Group tokens into sentences ending in .!? and tag each sentence with its
293
+ start time, scaled by `speed` to map back to original-audio time.
294
+ """
295
+ sentences: list[tuple[float, str]] = []
296
+ buf_tokens: list[str] = []
297
+ buf_start: Optional[float] = None
298
+ end_chars = (".", "!", "?")
299
+
300
+ for tok, ts in zip(tokens, timestamps):
301
+ if not buf_tokens:
302
+ buf_start = ts
303
+ buf_tokens.append(tok)
304
+ if tok and tok[-1] in end_chars:
305
+ text = _join_tokens(buf_tokens)
306
+ if text:
307
+ sentences.append(((buf_start or 0.0) * speed, text))
308
+ buf_tokens = []
309
+ buf_start = None
310
+
311
+ # Flush any trailing tokens with no terminal punctuation.
312
+ if buf_tokens:
313
+ text = _join_tokens(buf_tokens)
314
+ if text:
315
+ sentences.append(((buf_start or 0.0) * speed, text))
316
+ return sentences
317
+
318
+
319
+ def transcribe(samples: np.ndarray, model_dir: Path,
320
+ timestamps: bool, speed: float) -> str:
321
+ import json
322
+ import sherpa_onnx # imported lazily so --help is fast
323
+
324
+ if len(samples) == 0:
325
+ return ""
326
+
327
+ recognizer = sherpa_onnx.OnlineRecognizer.from_transducer(
328
+ encoder=find_model_file(model_dir, "encoder"),
329
+ decoder=find_model_file(model_dir, "decoder"),
330
+ joiner=find_model_file(model_dir, "joiner"),
331
+ tokens=str(model_dir / "tokens.txt"),
332
+ num_threads=os.cpu_count() or 1,
333
+ sample_rate=SAMPLE_RATE,
334
+ feature_dim=FEATURE_DIM,
335
+ decoding_method="greedy_search",
336
+ provider="cpu",
337
+ enable_endpoint_detection=False,
338
+ )
339
+
340
+ stream = recognizer.create_stream()
341
+ stream.accept_waveform(SAMPLE_RATE, samples)
342
+ # Tail padding flushes the final chunk through the streaming model.
343
+ tail_len = int(0.66 * SAMPLE_RATE)
344
+ if tail_len > 0:
345
+ stream.accept_waveform(SAMPLE_RATE, np.zeros(tail_len, dtype=np.float32))
346
+ stream.input_finished()
347
+
348
+ while recognizer.is_ready(stream):
349
+ recognizer.decode_stream(stream)
350
+
351
+ # In the Python wrapper, OnlineRecognizer.get_result(stream) returns a
352
+ # plain str (just the text). Different versions expose token/timestamp
353
+ # data through different paths; try each.
354
+ text_result = recognizer.get_result(stream)
355
+ text = (text_result if isinstance(text_result, str)
356
+ else getattr(text_result, "text", "") or "").strip()
357
+
358
+ if not timestamps:
359
+ return text
360
+
361
+ toks, times = _try_extract_timestamps(recognizer, stream, text_result)
362
+ if not toks or not times or len(toks) != len(times):
363
+ # No alignment data available for this build of sherpa-onnx; fall
364
+ # back to plain text and warn the user once.
365
+ print("warning: this sherpa-onnx build did not return timestamp data; "
366
+ "emitting plain text instead", file=sys.stderr)
367
+ return text
368
+
369
+ sentences = _group_into_sentences(toks, [float(t) for t in times], speed)
370
+ return "\n".join(f"[{_format_mmss(t)}] {s}" for t, s in sentences)
371
+
372
+
373
+ def _try_extract_timestamps(recognizer, stream, text_result):
374
+ """Best-effort extraction of (tokens, timestamps) across sherpa-onnx
375
+ Python wrapper versions. Returns ([], []) if nothing usable is found.
376
+ """
377
+ import json
378
+
379
+ # Path 1: recognizer.get_result_as_json_string(stream) (C-API parity)
380
+ json_method = getattr(recognizer, "get_result_as_json_string", None)
381
+ if callable(json_method):
382
+ try:
383
+ parsed = json.loads(json_method(stream))
384
+ toks = list(parsed.get("tokens") or [])
385
+ times = list(parsed.get("timestamps") or [])
386
+ if toks and times:
387
+ return toks, times
388
+ except Exception:
389
+ pass
390
+
391
+ # Path 2: stream.result.tokens / stream.result.timestamps
392
+ sresult = getattr(stream, "result", None)
393
+ if sresult is not None:
394
+ toks = list(getattr(sresult, "tokens", None) or [])
395
+ times = list(getattr(sresult, "timestamps", None) or [])
396
+ if toks and times:
397
+ return toks, times
398
+
399
+ # Path 3: text_result is itself a struct (some wrappers wrap a struct)
400
+ if not isinstance(text_result, str) and text_result is not None:
401
+ toks = list(getattr(text_result, "tokens", None) or [])
402
+ times = list(getattr(text_result, "timestamps", None) or [])
403
+ if toks and times:
404
+ return toks, times
405
+
406
+ return [], []
407
+
408
+
409
+ # ---------------------------------------------------------------------------
410
+ # CLI
411
+ # ---------------------------------------------------------------------------
412
+
413
+ def _default_output_name(input_arg: str) -> str:
414
+ """Pick a default output filename in cwd."""
415
+ if is_url(input_arg):
416
+ from urllib.parse import urlparse, parse_qs
417
+
418
+ parsed = urlparse(input_arg)
419
+ stem: Optional[str] = None
420
+
421
+ # Prefer ?v=<id> on YouTube watch URLs.
422
+ if "v" in parse_qs(parsed.query):
423
+ stem = parse_qs(parsed.query)["v"][0]
424
+ else:
425
+ # For sites like x.com/user/status/<id>/video/1, the last path segment
426
+ # is often "1"; pick the longest path segment instead (usually the ID).
427
+ segments = [s for s in parsed.path.split("/") if s]
428
+ if segments:
429
+ stem = max(segments, key=len)
430
+ # If it has a media extension (e.g. clip.mp4), drop it.
431
+ stem = re.sub(r"\.(mp3|mp4|m4a|wav|webm|mov|mkv|aac|opus|ogg|flac)$",
432
+ "", stem, flags=re.IGNORECASE)
433
+
434
+ stem = (stem or "transcript").strip()
435
+ stem = re.sub(r"[^A-Za-z0-9._-]+", "_", stem) or "transcript"
436
+ return f"{stem}_transcript.txt"
437
+ return f"{Path(input_arg).stem}_transcript.txt"
438
+
439
+
440
+ def main(argv: Optional[list[str]] = None) -> int:
441
+ ap = argparse.ArgumentParser(
442
+ prog="yapsnap",
443
+ description="Snap a local audio/video file or any video URL into a "
444
+ "plaintext transcript using sherpa-onnx (Kroko English streaming).",
445
+ )
446
+ ap.add_argument("input", help="Local file path or URL (YouTube, X, TikTok, Instagram, mp4/mp3 URL).")
447
+ ap.add_argument("-o", "--output", type=Path, default=None,
448
+ help="Output .txt path (default: ./transcripts/<input>_transcript.txt).")
449
+ ap.add_argument("--timestamps", action="store_true",
450
+ help="Include [MM:SS] sentence-level timestamps in output.")
451
+ ap.add_argument("--speed", type=float, default=1.5,
452
+ help="Audio speedup factor (default 1.5; pitch preserved).")
453
+ ap.add_argument("--keep-audio", action="store_true",
454
+ help="Keep the downloaded/intermediate audio file instead of deleting it.")
455
+ ap.add_argument("--model", type=Path, default=None,
456
+ help="Path to a sherpa-onnx streaming transducer model directory "
457
+ "(or set KROKO_MODEL). Default: auto-download Kroko English.")
458
+ args = ap.parse_args(argv)
459
+
460
+ if args.speed <= 0:
461
+ print("error: --speed must be > 0", file=sys.stderr)
462
+ return 2
463
+
464
+ # Resolve the model first so we fail fast if it can't be obtained.
465
+ try:
466
+ model_dir = resolve_model_dir(args.model)
467
+ except Exception as e:
468
+ print(f"model error: {e}", file=sys.stderr)
469
+ return 1
470
+
471
+ # Resolve input -> a local media path.
472
+ tmp_root: Optional[Path] = None
473
+ cleanup_root: Optional[Path] = None
474
+ try:
475
+ if is_url(args.input):
476
+ tmp_root = Path(tempfile.mkdtemp(prefix="transcribe-"))
477
+ cleanup_root = None if args.keep_audio else tmp_root
478
+ try:
479
+ media_path = download_url(args.input, tmp_root)
480
+ except Exception as e:
481
+ print(f"download error: {e}", file=sys.stderr)
482
+ return 1
483
+ if args.keep_audio:
484
+ print(f"audio kept at: {media_path}", file=sys.stderr)
485
+ else:
486
+ media_path = Path(args.input)
487
+ if not media_path.is_file():
488
+ print(f"error: file not found: {media_path}", file=sys.stderr)
489
+ return 1
490
+
491
+ try:
492
+ samples = decode_to_pcm(media_path, speed=args.speed)
493
+ except Exception as e:
494
+ print(f"decode error: {e}", file=sys.stderr)
495
+ return 1
496
+
497
+ try:
498
+ text = transcribe(samples, model_dir,
499
+ timestamps=args.timestamps, speed=args.speed)
500
+ except Exception as e:
501
+ print(f"transcription error: {e}", file=sys.stderr)
502
+ return 1
503
+
504
+ out_path = args.output if args.output else (
505
+ Path.cwd() / "transcripts" / _default_output_name(args.input)
506
+ )
507
+ out_path.parent.mkdir(parents=True, exist_ok=True)
508
+ try:
509
+ out_path.write_text(text + "\n", encoding="utf-8")
510
+ except Exception as e:
511
+ print(f"error writing output: {e}", file=sys.stderr)
512
+ return 1
513
+
514
+ print(out_path)
515
+ return 0
516
+ finally:
517
+ if cleanup_root is not None and cleanup_root.is_dir():
518
+ shutil.rmtree(cleanup_root, ignore_errors=True)
519
+
520
+
521
+ if __name__ == "__main__":
522
+ sys.exit(main())