scribe-cli 0.7.10__tar.gz → 0.8.0__tar.gz

{scribe_cli-0.7.10/scribe_cli.egg-info → scribe_cli-0.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: scribe-cli
-Version: 0.7.10
+Version: 0.8.0
 Summary: scribe is a local speech recognition tool that provides real-time transcription using vosk and whisper AI, with the goal of serving as a virtual keyboard on a computer
 Author-email: Mahé Perrette <mahe.perrette@gmail.com>
 License: MIT License
@@ -104,7 +104,7 @@ pip install -e .[all]
 You can leave the optional dependencies (leave out `[all]`) but must install at least one of `vosk` or `openai-whisper` packages (see Usage below).
 
 The `vosk` language models will download on-the-fly.
-The default download folder is `$XDG_CACHE_HOME/{backend}` where `$XDG_CACHE_HOME` defaults to `$HOME/.cache` (note for the `whisker` backend
+The default download folder is `$XDG_CACHE_HOME/{backend}` where `$XDG_CACHE_HOME` defaults to `$HOME/.cache` (note for the `whisper` backend
 the default is left to the `openai-whisper` package and might change in the future).
 
 
@@ -118,12 +118,12 @@ scribe
 and the script will guide you through the choice of backend (`whisper` or `vosk`) and the specific language model.
 After this, you will be prompted to start recording your microphone and print the transcribed text in real-time (`vosk`)
 or until after recording is complete (`whisper`).
-You can interrupt the recording via Ctrl + C and start again or change model. The full content of the transcription will be pasted to the clipboard by default, until interruption.
+You can interrupt the recording via Ctrl + C and start again or change model.
 
 The default (`whisper`) is excellent at transcribing a full-length audio sequences in [many languages](https://github.com/openai/whisper?tab=readme-ov-file#available-models-and-languages). It is really impressive,
 but it cannot do real-time, and depending on the model can have relatively long execution time, especially with the `turbo` model (at least on my laptop with CPU only). The `small` model is also excellent and runs much faster. It is selected as default in `scribe` for that reason.
-With the `whisker` model you need to stop the registration manually before the transcription occurs (Ctrl + C), though
-there is a maximum duration after which it will stop by itself, which is setup to 60s by default (unless `--duration` is set to something else).
+With the `whisper` model the registration stops after a 2-second silence is detected. You can also stop the registration manually before the transcription occurs (Ctrl + C or Stop in the `--app` mode).
+By default, the recording will only last 120 seconds. You can fine-tune this behaviour via the `--silence`, `--duration` and `--restart-after-silence` parameters.
 
 The `vosk` backend is much faster and very good at doing real-time transcription for one language, but tended to make more mistakes in my tests and it does not do punctuation.
 It becomes really powerful when used for longer or interactive typing session with the [keyboard](#virtual-keyboard-experimental) option, e.g. to make notes or chat with an AI.
@@ -135,19 +135,38 @@ scribe --backend whisper --model small --no-prompt
 ```
 where `--no-prompt` jumps right to the recording (after the first interruption, you can still choose to change the backend and model).
 
-### Virtual keyboard (experimental)
+## Output media
+
+By default the transcription is printed on the terminal, but other output media are supported.
+
+### Clipboard
+
+The most straightforward is the clipboard:
+
+```bash
+scribe --clipboard
+```
+The content of the (full) transcription is then pasted to the clipboard, and it is up to the user to paste (e.g. Ctrl + V).
+
+### Output file
+
+Alternatively an output file can be indicated:
+
+```bash
+ --keyboard -o transcription.txt
+```
 
-By default the content of the transcription is pasted to the clipboard, and it is up to the user to paste (e.g. Ctrl + V).
-However with the `vosk` backend and its realtime transcription, it is very handy to have the keys sent directly to the keyboard.
-That can be achieve with the `--keyboard` option.
+### Virtual keyboard (experimental)
 
-With the `--keyboard` option `scribe` will attempt to simulate a keyboard and send transcribed characters to the applcation under focus:
+With the `--keyboard` option `scribe` will attempt to simulate a keyboard and send transcribed characters to the application under focus:
 
 ```bash
 scribe --keyboard
 ```
 
-It relies on the optional `pynput` dependency (installed together with `scribe` if you used the `[all]` or `[keyboard]` option).
+This can be extremely useful with the `vosk` backend and its realtime transcription, or alternatively with the `--restart` option with the `whisper` backend.
+
+The `--keyboard` option relies on the optional `pynput` dependency (installed together with `scribe` if you used the `[all]` or `[keyboard]` option).
 Depending on your operating system, `pynput` may require additional configuration to work around its [limitations](https://pynput.readthedocs.io/en/latest/limitations.html).
 
 #### Use the keyboard with Wayland (default for Ubuntu 24.04)
@@ -164,7 +183,7 @@ sudo HOME=$HOME XDG_RUNTIME_DIR=$XDG_RUNTIME_DIR PYNPUT_BACKEND_KEYBOARD=uinput
 ```
 You're on the right path :)
 
-### System tray icon (experimental) <img src="scribe_data/share/icon.png" width=48px>
+## System tray icon (experimental) <img src="scribe_data/share/icon.png" width=48px>
 
 To avoid switching back and forth with the terminal, it's possible to interact with the program via an icon tray.
 To activate start with:
@@ -179,7 +198,7 @@ sudo apt install libcairo-dev libgirepository1.0-dev gir1.2-appindicator3-0.1
 pip install PyGObject
 ```
 
-### Start as an application in GNOME
+## Start as an application in GNOME
 
 If you run Ubuntu (or else?) with GNOME, the script `scribe-install [...]` will create a `scribe.desktop` file and place it under `$HOME/.local/share/applications`
 to make it available from the quick launch menu. Any option will be passed on to `scribe`.
@@ -187,7 +206,17 @@ to make it available from the quick launch menu. Any option will be passed on to
 e.g.
 
 ```bash
-scribe-install --backend whisper --model small
+scribe-install --backend whisper --model small --clipboard --keyboard --restart-after-silence
 ```
 
-After that just typing Cmd + scri... at any time from any where will conveniently start the app in its own terminal with the prescribed options.
+After that just typing Super + scri... at any time from any where will conveniently start the app in its own terminal with the prescribed options.
+
+
+## Fine tuning
+
+There are a number of options to control the silence threshold, duration and more.
+Best is to check the available options in the online help:
+
+```bash
+scribe --help
+```

{scribe_cli-0.7.10 → scribe_cli-0.8.0}/README.md

@@ -41,7 +41,7 @@ pip install -e .[all]
 You can leave the optional dependencies (leave out `[all]`) but must install at least one of `vosk` or `openai-whisper` packages (see Usage below).
 
 The `vosk` language models will download on-the-fly.
-The default download folder is `$XDG_CACHE_HOME/{backend}` where `$XDG_CACHE_HOME` defaults to `$HOME/.cache` (note for the `whisker` backend
+The default download folder is `$XDG_CACHE_HOME/{backend}` where `$XDG_CACHE_HOME` defaults to `$HOME/.cache` (note for the `whisper` backend
 the default is left to the `openai-whisper` package and might change in the future).
 
 
@@ -55,12 +55,12 @@ scribe
 and the script will guide you through the choice of backend (`whisper` or `vosk`) and the specific language model.
 After this, you will be prompted to start recording your microphone and print the transcribed text in real-time (`vosk`)
 or until after recording is complete (`whisper`).
-You can interrupt the recording via Ctrl + C and start again or change model. The full content of the transcription will be pasted to the clipboard by default, until interruption.
+You can interrupt the recording via Ctrl + C and start again or change model.
 
 The default (`whisper`) is excellent at transcribing a full-length audio sequences in [many languages](https://github.com/openai/whisper?tab=readme-ov-file#available-models-and-languages). It is really impressive,
 but it cannot do real-time, and depending on the model can have relatively long execution time, especially with the `turbo` model (at least on my laptop with CPU only). The `small` model is also excellent and runs much faster. It is selected as default in `scribe` for that reason.
-With the `whisker` model you need to stop the registration manually before the transcription occurs (Ctrl + C), though
-there is a maximum duration after which it will stop by itself, which is setup to 60s by default (unless `--duration` is set to something else).
+With the `whisper` model the registration stops after a 2-second silence is detected. You can also stop the registration manually before the transcription occurs (Ctrl + C or Stop in the `--app` mode).
+By default, the recording will only last 120 seconds. You can fine-tune this behaviour via the `--silence`, `--duration` and `--restart-after-silence` parameters.
 
 The `vosk` backend is much faster and very good at doing real-time transcription for one language, but tended to make more mistakes in my tests and it does not do punctuation.
 It becomes really powerful when used for longer or interactive typing session with the [keyboard](#virtual-keyboard-experimental) option, e.g. to make notes or chat with an AI.
@@ -72,19 +72,38 @@ scribe --backend whisper --model small --no-prompt
 ```
 where `--no-prompt` jumps right to the recording (after the first interruption, you can still choose to change the backend and model).
 
-### Virtual keyboard (experimental)
+## Output media
+
+By default the transcription is printed on the terminal, but other output media are supported.
+
+### Clipboard
+
+The most straightforward is the clipboard:
+
+```bash
+scribe --clipboard
+```
+The content of the (full) transcription is then pasted to the clipboard, and it is up to the user to paste (e.g. Ctrl + V).
 
-By default the content of the transcription is pasted to the clipboard, and it is up to the user to paste (e.g. Ctrl + V).
-However with the `vosk` backend and its realtime transcription, it is very handy to have the keys sent directly to the keyboard.
-That can be achieve with the `--keyboard` option.
+### Output file
 
-With the `--keyboard` option `scribe` will attempt to simulate a keyboard and send transcribed characters to the applcation under focus:
+Alternatively an output file can be indicated:
+
+```bash
+ --keyboard -o transcription.txt
+```
+
+### Virtual keyboard (experimental)
+
+With the `--keyboard` option `scribe` will attempt to simulate a keyboard and send transcribed characters to the application under focus:
 
 ```bash
 scribe --keyboard
 ```
 
-It relies on the optional `pynput` dependency (installed together with `scribe` if you used the `[all]` or `[keyboard]` option).
+This can be extremely useful with the `vosk` backend and its realtime transcription, or alternatively with the `--restart` option with the `whisper` backend.
+
+The `--keyboard` option relies on the optional `pynput` dependency (installed together with `scribe` if you used the `[all]` or `[keyboard]` option).
 Depending on your operating system, `pynput` may require additional configuration to work around its [limitations](https://pynput.readthedocs.io/en/latest/limitations.html).
 
 #### Use the keyboard with Wayland (default for Ubuntu 24.04)
@@ -101,7 +120,7 @@ sudo HOME=$HOME XDG_RUNTIME_DIR=$XDG_RUNTIME_DIR PYNPUT_BACKEND_KEYBOARD=uinput
 ```
 You're on the right path :)
 
-### System tray icon (experimental) <img src="scribe_data/share/icon.png" width=48px>
+## System tray icon (experimental) <img src="scribe_data/share/icon.png" width=48px>
 
 To avoid switching back and forth with the terminal, it's possible to interact with the program via an icon tray.
 To activate start with:
@@ -116,7 +135,7 @@ sudo apt install libcairo-dev libgirepository1.0-dev gir1.2-appindicator3-0.1
 pip install PyGObject
 ```
 
-### Start as an application in GNOME
+## Start as an application in GNOME
 
 If you run Ubuntu (or else?) with GNOME, the script `scribe-install [...]` will create a `scribe.desktop` file and place it under `$HOME/.local/share/applications`
 to make it available from the quick launch menu. Any option will be passed on to `scribe`.
@@ -124,7 +143,17 @@ to make it available from the quick launch menu. Any option will be passed on to
 e.g.
 
 ```bash
-scribe-install --backend whisper --model small
+scribe-install --backend whisper --model small --clipboard --keyboard --restart-after-silence
 ```
 
-After that just typing Cmd + scri... at any time from any where will conveniently start the app in its own terminal with the prescribed options.
+After that just typing Super + scri... at any time from any where will conveniently start the app in its own terminal with the prescribed options.
+
+
+## Fine tuning
+
+There are a number of options to control the silence threshold, duration and more.
+Best is to check the available options in the online help:
+
+```bash
+scribe --help
+```

{scribe_cli-0.7.10 → scribe_cli-0.8.0}/scribe/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.7.10'
-__version_tuple__ = version_tuple = (0, 7, 10)
+__version__ = version = '0.8.0'
+__version_tuple__ = version_tuple = (0, 8, 0)

{scribe_cli-0.7.10 → scribe_cli-0.8.0}/scribe/app.py

@@ -1,5 +1,6 @@
 from pathlib import Path
 import tomllib
+import re
 import time
 import argparse
 from scribe.audio import Microphone
@@ -147,7 +148,8 @@ def get_transcriber(o, prompt=True):
 
     elif backend == "whisper":
         transcriber = WhisperTranscriber(model_name=model, language=o.language, samplerate=o.samplerate,
-                                         timeout=o.duration, silence_duration=o.silence, restart_after_silence=o.restart_after_silence,
+                                         timeout=o.duration, silence_duration=o.silence, silence_thresh=o.silence_db,
+                                         restart_after_silence=o.restart_after_silence,
                                          model_kwargs={"download_root": o.download_folder_whisper})
 
     else:
@@ -176,15 +178,22 @@ def get_parser():
 
     parser.add_argument("--samplerate", default=16000, type=int, help=argparse.SUPPRESS)
     parser.add_argument("--microphone-device", help="The device index of the microphone to use.", type=int)
-    parser.add_argument("--keyboard", action="store_true")
-    parser.add_argument("--no-clipboard", dest="clipboard", action="store_false")
-    parser.add_argument("--latency", default=0, type=float, help="keyboard latency")
-    parser.add_argument("--ascii", action="store_true", help="Use unidecode for keyboard typing in ascii")
+
+    group = parser.add_argument_group("transcription output")
+    group.add_argument("-c", "--clipboard", dest="clipboard", action="store_true")
+    # group.add_argument("--no-clipboard", dest="clipboard", action="store_false", help=argparse.SUPPRESS)
+    group.add_argument("-k", "--keyboard", action="store_true")
+    group.add_argument("-o", "--output-file")
+
+    group = parser.add_argument_group("keyboard options")
+    group.add_argument("--latency", default=0.01, type=float, help="keyboard latency (default %(default)s s)")
+    group.add_argument("--ascii", action="store_true", help="Use unidecode for keyboard typing in ascii")
 
     group = parser.add_argument_group("whisper options")
-    group.add_argument("--duration", default=120, type=int, help="Max duration of the whisper recording (default %(default)ss)")
-    group.add_argument("--silence", default=2, type=float, help="silence duration that prompt transcription (whisper) (default %(default)ss)")
-    group.add_argument("--restart-after-silence", action="store_true", help="Restart the recording after a transcription triggered by a silence")
+    group.add_argument("--duration", default=120, type=float, help="Max duration of the whisper recording (default %(default)s s)")
+    group.add_argument("--silence", default=2, type=float, help="silence duration (default %(default)s s)")
+    group.add_argument("--silence-db", default=-30, type=float, help="silence magnitude in decibel (default %(default)s db)")
+    group.add_argument("-a", "--restart-after-silence", action="store_true", help="Restart the recording after a transcription triggered by a silence")
 
     parser.add_argument("--download-folder-vosk", help="Folder to store Vosk models.")
     parser.add_argument("--download-folder-whisper", help="Folder to store Whisper models.")
@@ -193,18 +202,16 @@ def get_parser():
 
 
 # Commencer l'enregistrement
-def start_recording(micro, transcriber, clipboard=True, keyboard=False, latency=0, ascii=False, callback=None, **greetings):
+def start_recording(micro, transcriber, clipboard=True, keyboard=False, latency=0, ascii=False, output_file=None, callback=None, **greetings):
 
     if keyboard:
         from scribe.keyboard import type_text
         print("\nChange focus to target app during transcription.")
 
-
     if clipboard:
         import pyperclip
         print("\nThe full transcription will be copied to clipboard as it becomes available.")
 
-
     fulltext = ""
 
     for result in transcriber.start_recording(micro, **greetings):
@@ -215,6 +222,10 @@ def start_recording(micro, transcriber, clipboard=True, keyboard=False, latency=
             if keyboard:
                 type_text(result['text'] + " ", interval=latency, ascii=ascii) # Simulate typing
 
+            if output_file:
+                with open(output_file, "a") as f:
+                    f.write(result['text'] + "\n")
+
             if clipboard:
                 fulltext += result['text'] + " "
                 pyperclip.copy(fulltext.strip())
@@ -222,9 +233,6 @@ def start_recording(micro, transcriber, clipboard=True, keyboard=False, latency=
         else:
             print_partial(result.get('partial', ''))
 
-    if clipboard:
-        print("Copied to clipboard.")
-
     if callback:
         callback()
 
@@ -249,7 +257,15 @@ def create_app(micro, transcriber, **kwargs):
         image_recording = Image.alpha_composite(image_recording.convert("RGBA"), image_writing.convert("RGBA"))
 
     def update_icon(icon, force=False):
-        if transcriber.recording:
+        if transcriber.recording and transcriber.waiting:
+            # this is the situation with the whisper backend when the microphone is recording
+            # but we wait for the speaker to speak (silence)
+            if force or getattr(icon, "_icon_label", None) != None:
+                icon.icon = image
+                icon._icon_label = None
+                icon.update_menu()
+
+        elif transcriber.recording:
             if force or getattr(icon, "_icon_label", None) != "recording":
                 icon.icon = image_recording
                 icon._icon_label = "recording"
@@ -345,22 +361,30 @@ def main(args=None):
         if transcriber is None:
             transcriber = get_transcriber(o, prompt=o.prompt)
         print(f"Model [{colored(transcriber.model_name, 'light_blue', attrs=['bold'])}] from [{colored(transcriber.backend, 'light_blue', attrs=['bold'])}] selected.")
-        show_options = ["clipboard", "keyboard", "ascii", "app"]
-        activated_options = [colored(option, 'light_blue') for option in show_options if getattr(o, option)]
-        print(f"Options: {' | '.join(activated_options)}")
+        show_output = ["clipboard", "keyboard", "output_file"]
+        show_options = ["ascii", "app"]
+        activated_output = [colored(option if type(getattr(o, option)) is bool else f'{option}={getattr(o, option)}', 'light_blue') for option in show_output if getattr(o, option)]
+        activated_options = [colored(option if type(getattr(o, option)) is bool else f'{option}={getattr(o, option)}', 'light_blue') for option in show_options if getattr(o, option)]
+        if activated_output:
+            print(f"Output: {' | '.join(activated_output)}")
+        else:
+            print(colored(f"No output selected -> terminal only", "light_red"))
+        if activated_options:
+            print(f"Options: {' | '.join(activated_options)}")
         if o.prompt:
             print(f"Choose any of the following actions")
-            print(f"{colored('[q]', 'light_yellow')} quit")
             print(f"{colored('[e]', 'light_yellow')} change model")
+            print(f"{colored('[f]', 'light_yellow')} output file is {colored(repr(o.output_file), 'light_blue')}")
+            print(f"{colored('[c]', 'light_yellow')} clipboard is {colored(o.clipboard, 'light_blue')} toggle?")
+            print(f"{colored('[k]', 'light_yellow')} keyboard is {colored(o.keyboard, 'light_blue')} toggle?")
+            print(f"{colored('[x]', 'light_yellow')} app is {colored(o.app, 'light_blue')} toggle?")
             if details:
-                print(f"{colored('[x]', 'light_yellow')} app is {colored(o.app, 'light_blue')} toggle?")
-                print(f"{colored('[c]', 'light_yellow')} clipboard is {colored(o.clipboard, 'light_blue')} toggle?")
-                print(f"{colored('[k]', 'light_yellow')} keyboard is {colored(o.keyboard, 'light_blue')} toggle?")
                 if o.keyboard:
                     print(f"{colored('[latency]', 'light_yellow')} between keystrokes is {colored(o.latency, 'light_blue')} s")
                 if transcriber.backend == "whisper":
                     print(f"{colored('[t]', 'light_yellow')} change duration (currently {colored(transcriber.timeout, 'light_blue')} s)")
                     print(f"{colored('[b]', 'light_yellow')} change silence (currently {colored(transcriber.silence_duration, 'light_blue')} s)")
+                    print(f"{colored('[db]', 'light_yellow')} change backround noise (currently {colored(transcriber.silence_thresh, 'light_blue')} db)")
                     print(f"{colored('[a]', 'light_yellow')} auto-restart after silence is {colored(transcriber.restart_after_silence, 'light_blue')} toggle?")
                 exclude_flags = ["keyboard", "clipboard", "app", "prompt", "restart_after_silence"]
                 display_flags = [a.dest for a in parser._actions if a.help != argparse.SUPPRESS]
@@ -368,21 +392,22 @@ def main(args=None):
                     if key not in display_flags or key in exclude_flags or not isinstance(value, bool):
                         continue
                     print(f"{colored(f'[{key}]', 'light_yellow')} is {colored(value, 'light_blue')} toggle?")
-                print(f"{colored('[o]', 'light_yellow')} hide options")
+                print(f"{colored('[-]', 'light_yellow')} hide options")
             else:
-                print(f"{colored('[o]', 'light_yellow')} show options")
-
+                print(f"{colored('[-]', 'light_yellow')} show more options")
+            print(f"{colored('[q]', 'light_yellow')} quit")
             print(colored(f"Press [Enter] to start recording.", attrs=["bold"]))
 
             key = input()
             if key == "q":
                 exit(0)
-            if key == "o":
+            if len(key) > 0 and key.strip() in ["", ".", "-", "+", 'o', '\x1b[A', '\x1b[B', '\x1b[C', '\x1b[D']:  # arrow keys
                 details = not details
                 continue
             if key == "e":
                 transcriber = None
                 o.model = None
+                o.dummy = False
                 o.backend = None
                 o.language = None
                 continue
@@ -401,9 +426,9 @@ def main(args=None):
             if key == "t":
                 ans = input(f"Enter new duration in seconds (current: {transcriber.timeout}): ")
                 try:
-                    o.duration = transcriber.timeout = int(ans)
+                    o.duration = transcriber.timeout = float(ans)
                 except:
-                    print("Invalid duration. Must be an integer.")
+                    print("Invalid duration. Must be a float.")
                 continue
             if key == "latency":
                 ans = input(f"Enter new keyboard latency in seconds (current: {o.latency}): ")
@@ -415,22 +440,38 @@ def main(args=None):
             if key == "b":
                 ans = input(f"Enter new silence break duration in seconds (current: {transcriber.silence_duration}): ")
                 try:
-                    o.silence = transcriber.silence_duration = int(ans)
+                    o.silence = transcriber.silence_duration = float(ans)
                 except:
-                    print("Invalid duration. Must be an integer.")
+                    print("Invalid duration. Must be a float.")
+                continue
+            if key == "db":
+                ans = input(f"Enter new background noise threshold to detect silence (current: {transcriber.silence_thresh}): ")
+                try:
+                    o.silence_db = transcriber.silence_thresh = float(ans)
+                except:
+                    print("Invalid duration. Must be a float.")
+                continue
+            if key == "f":
+                ans = input(f"Enter output file (current: {o.output_file}): ")
+                invalid_regex = re.compile(r'[^A-Za-z0-9_\-\\\/\.]')
+                if not invalid_regex.search(ans):
+                    o.output_file = ans
+                else:
+                    print(f"Invalid characters: {' '.join(map(repr, invalid_regex.findall(ans)))}")
+                    print(f"Invalid file name: {repr(ans)}")
                 continue
             if key:
                 if hasattr(o, key) and isinstance(getattr(o, key), bool):
                     setattr(o, key, not getattr(o, key))
                     print(f"Toggle {key} to [{getattr(o, key)}].")
-                print(f"Invalid choice: {key}.")
+                print(f"Invalid choice: {repr(key)}")
                 continue
 
         if o.app:
             greetings = dict(
                 start_message = "Listening... Use the try icon menu to stop.",
             )
-            app = create_app(micro, transcriber, clipboard=o.clipboard,
+            app = create_app(micro, transcriber, clipboard=o.clipboard, output_file=o.output_file,
                              keyboard=o.keyboard, latency=o.latency, ascii=o.ascii, **greetings)
             print("Starting app...")
             app.run()
@@ -438,7 +479,7 @@ def main(args=None):
             greetings = dict(
                 start_message = "Listening... Press Ctrl+C to stop.",
             )
-            start_recording(micro, transcriber, clipboard=o.clipboard,
+            start_recording(micro, transcriber, clipboard=o.clipboard, output_file=o.output_file,
                             keyboard=o.keyboard, latency=o.latency, ascii=o.ascii, **greetings)
 
         # if we arrived so far, that means we pressed Ctrl + C anyway, and need Enter to move on.

{scribe_cli-0.7.10 → scribe_cli-0.8.0}/scribe/models.py

@@ -34,6 +34,7 @@ class AbstractTranscriber:
         self.restart_after_silence = restart_after_silence
         self.recording = False
         self.busy = False
+        self.waiting = False
         self.reset()
 
     def get_elapsed(self):
@@ -52,7 +53,6 @@ class AbstractTranscriber:
     def reset(self):
         self.audio_buffer = b''
         self.start_time = time.time()
-        self.last_sound_time = time.time()
 
     def start_recording(self, microphone,
                         start_message="Recording... Press Ctrl+C to stop.",
@@ -60,7 +60,13 @@ class AbstractTranscriber:
 
         self.reset()
         self.recording = True
+        self.waiting = True
         self.busy = True
+        if self.silence_duration is not None:
+            self.last_sound_time = time.time() - self.silence_duration
+        else:
+            self.last_sound_time = time.time()
+        previous_waiting = self.waiting
 
         try:
 
@@ -75,19 +81,31 @@ class AbstractTranscriber:
                         if is_silent(data, self.silence_thresh):
                             silence_duration = time.time() - self.last_sound_time
 
-                            if self.silence_duration is not None and silence_duration >= self.silence_duration and len(self.audio_buffer) > 0:
+                            previous_waiting = self.waiting
+                            self.waiting = self.silence_duration is not None and silence_duration >= self.silence_duration
+
+                            if self.waiting and len(self.audio_buffer) > 0:
                                 if self.restart_after_silence:
+                                    self.recording = False # for the system tray icon
                                     result = self.finalize()
                                     microphone.q.queue.clear()
                                     self.reset()
                                     yield result
+                                    self.recording = True # for the system tray icon
                                 else:
                                     raise StopRecording("Silence detected: {:.2f} seconds".format(silence_duration))
 
                         else:
                             self.last_sound_time = time.time()
+                            self.waiting = False
 
-                        yield self.transcribe_realtime_audio(data)
+                        # don't accumulate very long silences
+                        if not self.waiting:
+                            yield self.transcribe_realtime_audio(data)
+
+                        else:
+                            if not previous_waiting:
+                                print("Silence detected...waiting for more audio")
 
                         if self.is_overtime():
                             raise StopRecording("Overtime: {:.2f} seconds".format(self.get_elapsed()))
@@ -98,6 +116,7 @@ class AbstractTranscriber:
             pass
 
         finally:
+            self.waiting = False
             self.recording = False
             result = self.finalize()
             microphone.q.queue.clear()

{scribe_cli-0.7.10 → scribe_cli-0.8.0/scribe_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: scribe-cli
-Version: 0.7.10
+Version: 0.8.0
 Summary: scribe is a local speech recognition tool that provides real-time transcription using vosk and whisper AI, with the goal of serving as a virtual keyboard on a computer
 Author-email: Mahé Perrette <mahe.perrette@gmail.com>
 License: MIT License
@@ -104,7 +104,7 @@ pip install -e .[all]
 You can leave the optional dependencies (leave out `[all]`) but must install at least one of `vosk` or `openai-whisper` packages (see Usage below).
 
 The `vosk` language models will download on-the-fly.
-The default download folder is `$XDG_CACHE_HOME/{backend}` where `$XDG_CACHE_HOME` defaults to `$HOME/.cache` (note for the `whisker` backend
+The default download folder is `$XDG_CACHE_HOME/{backend}` where `$XDG_CACHE_HOME` defaults to `$HOME/.cache` (note for the `whisper` backend
 the default is left to the `openai-whisper` package and might change in the future).
 
 
@@ -118,12 +118,12 @@ scribe
 and the script will guide you through the choice of backend (`whisper` or `vosk`) and the specific language model.
 After this, you will be prompted to start recording your microphone and print the transcribed text in real-time (`vosk`)
 or until after recording is complete (`whisper`).
-You can interrupt the recording via Ctrl + C and start again or change model. The full content of the transcription will be pasted to the clipboard by default, until interruption.
+You can interrupt the recording via Ctrl + C and start again or change model.
 
 The default (`whisper`) is excellent at transcribing a full-length audio sequences in [many languages](https://github.com/openai/whisper?tab=readme-ov-file#available-models-and-languages). It is really impressive,
 but it cannot do real-time, and depending on the model can have relatively long execution time, especially with the `turbo` model (at least on my laptop with CPU only). The `small` model is also excellent and runs much faster. It is selected as default in `scribe` for that reason.
-With the `whisker` model you need to stop the registration manually before the transcription occurs (Ctrl + C), though
-there is a maximum duration after which it will stop by itself, which is setup to 60s by default (unless `--duration` is set to something else).
+With the `whisper` model the registration stops after a 2-second silence is detected. You can also stop the registration manually before the transcription occurs (Ctrl + C or Stop in the `--app` mode).
+By default, the recording will only last 120 seconds. You can fine-tune this behaviour via the `--silence`, `--duration` and `--restart-after-silence` parameters.
 
 The `vosk` backend is much faster and very good at doing real-time transcription for one language, but tended to make more mistakes in my tests and it does not do punctuation.
 It becomes really powerful when used for longer or interactive typing session with the [keyboard](#virtual-keyboard-experimental) option, e.g. to make notes or chat with an AI.
@@ -135,19 +135,38 @@ scribe --backend whisper --model small --no-prompt
 ```
 where `--no-prompt` jumps right to the recording (after the first interruption, you can still choose to change the backend and model).
 
-### Virtual keyboard (experimental)
+## Output media
+
+By default the transcription is printed on the terminal, but other output media are supported.
+
+### Clipboard
+
+The most straightforward is the clipboard:
+
+```bash
+scribe --clipboard
+```
+The content of the (full) transcription is then pasted to the clipboard, and it is up to the user to paste (e.g. Ctrl + V).
+
+### Output file
+
+Alternatively an output file can be indicated:
+
+```bash
+ --keyboard -o transcription.txt
+```
 
-By default the content of the transcription is pasted to the clipboard, and it is up to the user to paste (e.g. Ctrl + V).
-However with the `vosk` backend and its realtime transcription, it is very handy to have the keys sent directly to the keyboard.
-That can be achieve with the `--keyboard` option.
+### Virtual keyboard (experimental)
 
-With the `--keyboard` option `scribe` will attempt to simulate a keyboard and send transcribed characters to the applcation under focus:
+With the `--keyboard` option `scribe` will attempt to simulate a keyboard and send transcribed characters to the application under focus:
 
 ```bash
 scribe --keyboard
 ```
 
-It relies on the optional `pynput` dependency (installed together with `scribe` if you used the `[all]` or `[keyboard]` option).
+This can be extremely useful with the `vosk` backend and its realtime transcription, or alternatively with the `--restart` option with the `whisper` backend.
+
+The `--keyboard` option relies on the optional `pynput` dependency (installed together with `scribe` if you used the `[all]` or `[keyboard]` option).
 Depending on your operating system, `pynput` may require additional configuration to work around its [limitations](https://pynput.readthedocs.io/en/latest/limitations.html).
 
 #### Use the keyboard with Wayland (default for Ubuntu 24.04)
@@ -164,7 +183,7 @@ sudo HOME=$HOME XDG_RUNTIME_DIR=$XDG_RUNTIME_DIR PYNPUT_BACKEND_KEYBOARD=uinput
 ```
 You're on the right path :)
 
-### System tray icon (experimental) <img src="scribe_data/share/icon.png" width=48px>
+## System tray icon (experimental) <img src="scribe_data/share/icon.png" width=48px>
 
 To avoid switching back and forth with the terminal, it's possible to interact with the program via an icon tray.
 To activate start with:
@@ -179,7 +198,7 @@ sudo apt install libcairo-dev libgirepository1.0-dev gir1.2-appindicator3-0.1
 pip install PyGObject
 ```
 
-### Start as an application in GNOME
+## Start as an application in GNOME
 
 If you run Ubuntu (or else?) with GNOME, the script `scribe-install [...]` will create a `scribe.desktop` file and place it under `$HOME/.local/share/applications`
 to make it available from the quick launch menu. Any option will be passed on to `scribe`.
@@ -187,7 +206,17 @@ to make it available from the quick launch menu. Any option will be passed on to
 e.g.
 
 ```bash
-scribe-install --backend whisper --model small
+scribe-install --backend whisper --model small --clipboard --keyboard --restart-after-silence
 ```
 
-After that just typing Cmd + scri... at any time from any where will conveniently start the app in its own terminal with the prescribed options.
+After that just typing Super + scri... at any time from any where will conveniently start the app in its own terminal with the prescribed options.
+
+
+## Fine tuning
+
+There are a number of options to control the silence threshold, duration and more.
+Best is to check the available options in the online help:
+
+```bash
+scribe --help
+```