WIP: parakeeet
This commit is contained in:
hueso
@@ -18,33 +18,23 @@ from __future__ import annotations
|
||||
import logging
|
||||
import typing
|
||||
from pathlib import Path
|
||||
from typing import TYPE_CHECKING
|
||||
from typing import TYPE_CHECKING, Any
|
||||
|
||||
try:
|
||||
import whisper
|
||||
import onnx_asr
|
||||
except ModuleNotFoundError:
|
||||
if typing.TYPE_CHECKING:
|
||||
import whisper
|
||||
import onnx_asr
|
||||
|
||||
try:
|
||||
import faster_whisper as fwhisper
|
||||
except ModuleNotFoundError:
|
||||
if typing.TYPE_CHECKING:
|
||||
import faster_whisper as fwhisper
|
||||
from gi.repository import Adw, Gtk
|
||||
|
||||
from gi.repository import Gtk
|
||||
|
||||
from gajim.common import app
|
||||
from gajim.common.app import Any
|
||||
from gajim.gtk.builder import get_builder
|
||||
from gajim.gtk.const import Setting, SettingKind, SettingType
|
||||
from gajim.gtk.settings import SettingsBox
|
||||
from gajim.gtk.sidebar_switcher import SideBarSwitcher
|
||||
from gajim.plugins.helpers import get_builder
|
||||
from gajim.gtk.filechoosers import Filter
|
||||
from gajim.gtk.settings import GajimPreferencesGroup, SettingsDialog
|
||||
from gajim.plugins.plugins_i18n import _
|
||||
|
||||
from ..models import faster_whisper, openai_whisper
|
||||
from ..models.model_settings import *
|
||||
from ..models import stt
|
||||
from ..models.model_settings import OnnxAsrSettings
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ..stt_voice_messages import STTVoiceMessagesPlugin
|
||||
@@ -52,271 +42,250 @@ if TYPE_CHECKING:
|
||||
log = logging.getLogger('gajim.p.sttvm_config_dialog')
|
||||
|
||||
|
||||
@dataclass
|
||||
class Model:
|
||||
name: str
|
||||
required_moduls: list[str]
|
||||
klass: object
|
||||
config: Any
|
||||
instance: typing.Optional[object] = None
|
||||
|
||||
|
||||
SUPPORTED_MODELS: dict[str, Model] = {
|
||||
'model_openaiwhisper': Model('OpenAI Whisper',
|
||||
['whisper'],
|
||||
openai_whisper.WhisperModel,
|
||||
OpenAIWhisperSettings),
|
||||
'model_faster-whisper': Model('Faster-Whisper',
|
||||
['faster_whisper'],
|
||||
faster_whisper.FasterWhisperModel,
|
||||
FasterWhisperSettings)
|
||||
}
|
||||
|
||||
|
||||
class Configuration:
|
||||
def __init__(self, plugin: STTVoiceMessagesPlugin):
|
||||
self._plugin = plugin
|
||||
|
||||
self._available_models: dict[str, Model] = {}
|
||||
self.check_available_moduls()
|
||||
|
||||
log.debug('config = %s', self._plugin.config)
|
||||
self._instance = None
|
||||
self._main_model_row = None
|
||||
self._preset_model_picker = None
|
||||
self._custom_model_id_entry = None
|
||||
self._local_model_file_picker = None
|
||||
self._status_group = None
|
||||
self._model_data: dict[str, str] = {}
|
||||
self._instance = stt.OnnxAsrModel()
|
||||
self._instance.set_config(OnnxAsrSettings(
|
||||
model_id=self.plugin.config['model_id'],
|
||||
model_path=self.plugin.config['model_path']
|
||||
))
|
||||
self._model_data = self._steal_model_list()
|
||||
|
||||
@property
|
||||
def plugin(self) -> STTVoiceMessagesPlugin:
|
||||
return self._plugin
|
||||
|
||||
@property
|
||||
def available_models(self) -> dict[str, Model]:
|
||||
return self._available_models
|
||||
def is_available(self) -> bool:
|
||||
return self._instance is not None
|
||||
|
||||
def unload_model(self) -> None:
|
||||
if self._instance is not None:
|
||||
self._instance.unload_now()
|
||||
|
||||
def _steal_model_list(self) -> dict[str, str]:
|
||||
# UGLY: Extract available model choices from onnx_asr type hints.
|
||||
ann = onnx_asr.load_model.__annotations__.get('model')
|
||||
return {
|
||||
v: v for arg in typing.get_args(ann)
|
||||
for v in typing.get_args(arg)
|
||||
if isinstance(v, str)
|
||||
}
|
||||
|
||||
def on_setting(self, value: Any, data: Any) -> None:
|
||||
if isinstance(value, str):
|
||||
value.strip()
|
||||
|
||||
log.debug('plugin config before:\n %s', self.plugin.config.data)
|
||||
value = value.strip()
|
||||
self.plugin.config[data] = value
|
||||
log.debug('plugin config after:\n %s', self.plugin.config.data)
|
||||
|
||||
def on_config_model(self, model: str, value: Any, data: Any) -> None:
|
||||
if isinstance(value, str):
|
||||
value.strip()
|
||||
def on_preset_changed(self, value: str, data: Any) -> None:
|
||||
if self._custom_model_id_entry is not None:
|
||||
entry_text = self._custom_model_id_entry.entry.get_text().strip()
|
||||
if entry_text:
|
||||
self._update_model_status()
|
||||
return # custom entry overrides; ignore preset change
|
||||
self._write_model_id(value)
|
||||
self._update_model_status()
|
||||
|
||||
log.debug('plugin config before:\n %s', self.plugin.config.data[model])
|
||||
setattr(self.plugin.config.data[model], data, value)
|
||||
log.debug('plugin config after:\n %s', self.plugin.config.data[model])
|
||||
def on_custom_model_id_changed(self, value: str, data: Any) -> None:
|
||||
value = value.strip()
|
||||
if value:
|
||||
self._write_model_id(value)
|
||||
elif self._preset_model_picker is not None:
|
||||
preset_key = self._preset_model_picker._dropdown.get_selected_key()
|
||||
if preset_key is not None:
|
||||
self._write_model_id(preset_key)
|
||||
self._apply_sensitivity_state()
|
||||
self._update_model_status()
|
||||
|
||||
self._plugin.config.data[model].instance.set_config(self.plugin.config.data[model])
|
||||
def on_model_file_picked(self, value: str, data: Any) -> None:
|
||||
self._write_model_path(str(Path(value).parent) if value else '')
|
||||
self._apply_sensitivity_state()
|
||||
self._update_model_status()
|
||||
|
||||
def create_model(self, model: Any) -> None:
|
||||
if (self.plugin.config.data[model].instance is None and
|
||||
self._available_models[model].klass is not None):
|
||||
self.plugin.config.data[model].instance = \
|
||||
self._available_models[model].klass()
|
||||
def _write_model_id(self, model_id: str) -> None:
|
||||
if self.plugin.config['model_id'] == model_id:
|
||||
return
|
||||
self.plugin.config['model_id'] = model_id
|
||||
if self._instance is not None:
|
||||
self._instance.set_config(OnnxAsrSettings(
|
||||
model_id=self.plugin.config['model_id'],
|
||||
model_path=self.plugin.config['model_path']
|
||||
))
|
||||
|
||||
def _write_model_path(self, model_path: str) -> None:
|
||||
if self.plugin.config['model_path'] == model_path:
|
||||
return
|
||||
self.plugin.config['model_path'] = model_path
|
||||
if self._instance is not None:
|
||||
self._instance.set_config(OnnxAsrSettings(
|
||||
model_id=self.plugin.config['model_id'],
|
||||
model_path=self.plugin.config['model_path']
|
||||
))
|
||||
|
||||
def sync_model_path_from_widget(self) -> None:
|
||||
if self._local_model_file_picker is None:
|
||||
return
|
||||
button = self._local_model_file_picker.get_activatable_widget()
|
||||
path = button.get_path()
|
||||
new_path = str(path.parent) if path else ''
|
||||
self._write_model_path(new_path)
|
||||
|
||||
def _apply_sensitivity_state(self) -> None:
|
||||
if self._preset_model_picker is None:
|
||||
return
|
||||
has_local = bool(self.plugin.config['model_path'])
|
||||
entry_text = (self._custom_model_id_entry.entry.get_text().strip()
|
||||
if self._custom_model_id_entry else '')
|
||||
has_entry = bool(entry_text)
|
||||
self._custom_model_id_entry.set_sensitive(not has_local)
|
||||
self._preset_model_picker.set_sensitive(not has_local and not has_entry)
|
||||
|
||||
def _update_model_status(self) -> None:
|
||||
if self._main_model_row is None:
|
||||
return
|
||||
entry_text = (self._custom_model_id_entry.entry.get_text().strip()
|
||||
if self._custom_model_id_entry else '')
|
||||
|
||||
if self.plugin.config['model_path']:
|
||||
path = Path(self.plugin.config['model_path'])
|
||||
summary = _('Local: {}').format(path.name or str(path))
|
||||
description = _('Loading model files from {}').format(path)
|
||||
if not (path / 'config.json').exists():
|
||||
description += '\n' + _(
|
||||
'config.json not found in this directory — onnx-asr will'
|
||||
' fall back to Model preset or Custom Model ID for the'
|
||||
' architecture.')
|
||||
elif entry_text:
|
||||
summary = _('Custom: {}').format(entry_text)
|
||||
description = _('Using custom model: {}').format(entry_text)
|
||||
else:
|
||||
log.debug('Could not create model %s', model)
|
||||
preset_key = (self._preset_model_picker._dropdown.get_selected_key()
|
||||
if self._preset_model_picker else '')
|
||||
summary = preset_key or _('(none)')
|
||||
description = (_('Using preset: {}').format(preset_key)
|
||||
if preset_key else '')
|
||||
|
||||
def on_set_model(self, model: Any, data: str = 'model') -> None:
|
||||
if isinstance(model, str):
|
||||
model.strip()
|
||||
|
||||
self.plugin.config['model'] = model
|
||||
log.debug('Created model %s with config %s', model, self.plugin.config.data[model])
|
||||
|
||||
def check_available_moduls(self):
|
||||
def is_module_available(module: str) -> bool:
|
||||
try:
|
||||
__import__(module)
|
||||
return True
|
||||
except ModuleNotFoundError:
|
||||
log.debug('Could not find module %s', module)
|
||||
return False
|
||||
except ImportError as ex:
|
||||
log.debug(str(ex))
|
||||
return False
|
||||
|
||||
for model in SUPPORTED_MODELS:
|
||||
available = True
|
||||
for modul in SUPPORTED_MODELS[model].required_moduls:
|
||||
if not is_module_available(modul):
|
||||
available = False
|
||||
continue
|
||||
if available:
|
||||
self._available_models[model] = SUPPORTED_MODELS[model]
|
||||
if SUPPORTED_MODELS[model].config is not None:
|
||||
log.debug('created config for model = %s: %s', model, self._available_models[model])
|
||||
log.debug('plugin config for model = %s', self.plugin.config[model])
|
||||
self.plugin.config.data[model].instance = None
|
||||
self._available_models[model].config = self.plugin.config[model]
|
||||
self.create_model(model)
|
||||
|
||||
self.on_set_model(self._plugin.config['model'])
|
||||
|
||||
log.debug('models = %s', self._available_models)
|
||||
self._main_model_row._label.set_text(summary)
|
||||
if self._status_group is not None:
|
||||
self._status_group.set_description(description)
|
||||
|
||||
|
||||
class PreferenceBox(SettingsBox):
|
||||
def __init__(self, settings: list[Setting]) -> None:
|
||||
SettingsBox.__init__(self, None)
|
||||
self.get_style_context().add_class('border')
|
||||
self.set_selection_mode(Gtk.SelectionMode.NONE)
|
||||
self.set_vexpand(False)
|
||||
self.set_valign(Gtk.Align.END)
|
||||
|
||||
for setting in settings:
|
||||
self.add_setting(setting)
|
||||
self.update_states()
|
||||
|
||||
|
||||
class STTVoiceMessagesConfigDialog(Gtk.ApplicationWindow):
|
||||
class STTVoiceMessagesConfigDialog(SettingsDialog):
|
||||
def __init__(self, config: Configuration, parent: Gtk.Window) -> None:
|
||||
Gtk.ApplicationWindow.__init__(self)
|
||||
|
||||
self.set_application(app.app)
|
||||
self.set_position(Gtk.WindowPosition.CENTER)
|
||||
self.set_show_menubar(False)
|
||||
self.set_name('PreferencesWindow')
|
||||
self.set_default_size(900, 650)
|
||||
self.set_resizable(True)
|
||||
self.set_title(_('STT Voice Messages - Preferences'))
|
||||
|
||||
ui_path = Path(__file__).parent
|
||||
self._ui = get_builder(str(ui_path.resolve() / 'config_dialog.ui'))
|
||||
|
||||
self._prefs: dict[str, PreferenceBox] = {}
|
||||
prefs: list[tuple[str, type[PreferenceBox]]] = [
|
||||
('stt_behaviour', self.STTBehaviour),
|
||||
('models', self.Models),
|
||||
]
|
||||
|
||||
if 'model_openaiwhisper' in config.available_models:
|
||||
prefs.append(('openaiwhisper_general', self.OpenAIWhisperGeneral))
|
||||
else:
|
||||
self._ui.stack.remove(getattr(self._ui, 'openai-whisper'))
|
||||
|
||||
if 'model_faster-whisper' in config.available_models:
|
||||
prefs.append(('fasterwhisper_general', self.FasterWhisperGeneral))
|
||||
else:
|
||||
self._ui.stack.remove(getattr(self._ui, 'faster-whisper'))
|
||||
|
||||
side_bar_switcher = SideBarSwitcher()
|
||||
side_bar_switcher.set_stack(self._ui.stack)
|
||||
self._ui.grid.attach(side_bar_switcher, 0, 0, 1, 1)
|
||||
self.add(self._ui.grid)
|
||||
|
||||
self.config = config
|
||||
self.plugin = self.config.plugin
|
||||
self._add_prefs(prefs)
|
||||
if not config.is_available:
|
||||
return
|
||||
|
||||
self.show_all()
|
||||
rows = [
|
||||
Setting(SettingKind.SWITCH,
|
||||
_('Auto Transcribe'),
|
||||
SettingType.VALUE,
|
||||
value=self.plugin.config['auto_transcribe'],
|
||||
data='auto_transcribe',
|
||||
callback=config.on_setting,
|
||||
desc=_('Transcribe messages as they appear')),
|
||||
Setting(SettingKind.SUBPAGE,
|
||||
_('Model'),
|
||||
SettingType.VALUE,
|
||||
value=None,
|
||||
name='main_model',
|
||||
props={'subpage': 'sttvm-model'}),
|
||||
]
|
||||
|
||||
def _add_prefs(self, prefs: list[tuple[str, type[PreferenceBox]]]):
|
||||
for ui_name, klass in prefs:
|
||||
pref_box = getattr(self._ui, ui_name)
|
||||
pref = klass(self) # pyright: ignore
|
||||
log.debug('ui_name = %s, klass = %s, pref_box = %s', ui_name, klass, pref_box)
|
||||
pref_box.add(pref)
|
||||
self._prefs[ui_name] = pref
|
||||
SettingsDialog.__init__(
|
||||
self,
|
||||
parent,
|
||||
_('STT Voice Messages'),
|
||||
Gtk.DialogFlags.MODAL,
|
||||
rows,
|
||||
'',
|
||||
)
|
||||
|
||||
config._main_model_row = self.get_setting('main_model')
|
||||
|
||||
use_custom = self.plugin.config['model_id'] not in config._model_data
|
||||
|
||||
|
||||
############################################################################
|
||||
# General Settings
|
||||
############################################################################
|
||||
class STTBehaviour(PreferenceBox):
|
||||
def __init__(self, config_dialog: STTVoiceMessagesConfigDialog) -> None:
|
||||
settings = [
|
||||
Setting(SettingKind.SWITCH,
|
||||
_('Auto Transcribe'),
|
||||
SettingType.VALUE,
|
||||
value=config_dialog.plugin.config['auto_transcribe'],
|
||||
data='auto_transcribe',
|
||||
callback=config_dialog.config.on_setting)
|
||||
]
|
||||
subpage_rows: list[Setting] = [
|
||||
Setting(SettingKind.DROPDOWN,
|
||||
_('Model'),
|
||||
SettingType.VALUE,
|
||||
value=self.plugin.config['model_id'],
|
||||
name='preset_model',
|
||||
callback=config.on_preset_changed,
|
||||
props={'data': config._model_data}),
|
||||
Setting(SettingKind.ENTRY,
|
||||
_('Custom Model'),
|
||||
SettingType.VALUE,
|
||||
value=self.plugin.config['model_id'] if use_custom else '',
|
||||
name='custom_model',
|
||||
callback=config.on_custom_model_id_changed,
|
||||
desc=_('Custom HF model path or model ID')),
|
||||
Setting(SettingKind.FILECHOOSER,
|
||||
_('Local File'),
|
||||
SettingType.VALUE,
|
||||
value='',
|
||||
name='local_model_file',
|
||||
callback=config.on_model_file_picked,
|
||||
desc=_('Model ID is taken from config.json if not set'),
|
||||
props={'filefilters': [
|
||||
Filter(_('ONNX model'), suffixes=['onnx'], default=True),
|
||||
]}),
|
||||
]
|
||||
|
||||
PreferenceBox.__init__(self, settings)
|
||||
controls_group = GajimPreferencesGroup('model_controls')
|
||||
for s in subpage_rows:
|
||||
controls_group.add_setting(s)
|
||||
|
||||
class Models(PreferenceBox):
|
||||
def __init__(self, config_dialog: STTVoiceMessagesConfigDialog) -> None:
|
||||
models: list[tuple[str, str]] = []
|
||||
for key, value in config_dialog.config.available_models.items():
|
||||
models.append(
|
||||
(key, str(value.name))
|
||||
)
|
||||
status_group = Adw.PreferencesGroup()
|
||||
|
||||
settings = [
|
||||
Setting(SettingKind.COMBO,
|
||||
_('Speech To Text Model'),
|
||||
SettingType.VALUE,
|
||||
value=config_dialog.plugin.config['model'],
|
||||
data='model',
|
||||
callback=config_dialog.config.on_set_model,
|
||||
props={'combo_items': models},
|
||||
desc=_('Choose Model to use')),
|
||||
]
|
||||
pref_page = Adw.PreferencesPage()
|
||||
pref_page.add(controls_group)
|
||||
pref_page.add(status_group)
|
||||
|
||||
PreferenceBox.__init__(self, settings)
|
||||
toolbar = Adw.ToolbarView(content=pref_page)
|
||||
toolbar.add_top_bar(Adw.HeaderBar())
|
||||
|
||||
############################################################################
|
||||
# OpenAI Whisper Settings
|
||||
############################################################################
|
||||
class OpenAIWhisperGeneral(PreferenceBox):
|
||||
def __init__(self, config_dialog: STTVoiceMessagesConfigDialog) -> None:
|
||||
page = Adw.NavigationPage(
|
||||
tag='sttvm-model', title=_('Model'), child=toolbar)
|
||||
self._nav.add(page)
|
||||
|
||||
self._model = 'model_openaiwhisper'
|
||||
self._config_dialog = config_dialog
|
||||
config._preset_model_picker = controls_group.get_setting('preset_model')
|
||||
config._custom_model_id_entry = controls_group.get_setting('custom_model')
|
||||
config._local_model_file_picker = controls_group.get_setting(
|
||||
'local_model_file')
|
||||
config._status_group = status_group
|
||||
|
||||
settings = [
|
||||
Setting(SettingKind.POPOVER,
|
||||
_('Language Model Size'),
|
||||
SettingType.VALUE,
|
||||
value=config_dialog.config.available_models[self._model].config.model_size,
|
||||
data='model_size',
|
||||
callback=self._set_config,
|
||||
props={'entries': whisper.available_models()}),
|
||||
config._custom_model_id_entry.entry.set_placeholder_text(
|
||||
_('onnx-community/whisper-large-v3-turbo'))
|
||||
|
||||
Setting(SettingKind.SWITCH,
|
||||
_('Translate'),
|
||||
SettingType.VALUE,
|
||||
value=config_dialog.config.available_models[self._model].config.translate_to_english,
|
||||
data='translate_to_english',
|
||||
callback=self._set_config)
|
||||
]
|
||||
button = config._local_model_file_picker.get_activatable_widget()
|
||||
button._label_text = _('.oonx')
|
||||
button.reset()
|
||||
|
||||
PreferenceBox.__init__(self, settings)
|
||||
if self.plugin.config['model_path']:
|
||||
onnx_in_dir = next(iter(Path(self.plugin.config['model_path']).glob('*.onnx')),
|
||||
None)
|
||||
if onnx_in_dir is not None:
|
||||
button.set_path(onnx_in_dir)
|
||||
|
||||
def _set_config(self, value: Any, data: Any):
|
||||
self._config_dialog.config.on_config_model(self._model, value, data)
|
||||
config._update_model_status()
|
||||
config._apply_sensitivity_state()
|
||||
|
||||
############################################################################
|
||||
# Faster Whisper Settings
|
||||
############################################################################
|
||||
class FasterWhisperGeneral(PreferenceBox):
|
||||
def __init__(self,
|
||||
config_dialog: STTVoiceMessagesConfigDialog) -> None:
|
||||
self._model = 'model_faster-whisper'
|
||||
self._config_dialog = config_dialog
|
||||
|
||||
settings = [
|
||||
Setting(SettingKind.POPOVER,
|
||||
_('Language Model Size'),
|
||||
SettingType.VALUE,
|
||||
value=config_dialog.config.available_models[
|
||||
self._model].config.model_size,
|
||||
data='model_size',
|
||||
callback=self._set_config,
|
||||
props={'entries': fwhisper.available_models()}),
|
||||
|
||||
Setting(SettingKind.SWITCH,
|
||||
_('Translate'),
|
||||
SettingType.VALUE,
|
||||
value=config_dialog.config.available_models[
|
||||
self._model].config.translate_to_english,
|
||||
data='translate_to_english',
|
||||
callback=self._set_config)
|
||||
]
|
||||
|
||||
PreferenceBox.__init__(self, settings)
|
||||
|
||||
def _set_config(self, value: Any, data: Any):
|
||||
self._config_dialog.config.on_config_model(self._model, value,
|
||||
data)
|
||||
def _cleanup(self) -> None:
|
||||
self.config.sync_model_path_from_widget()
|
||||
self.config._main_model_row = None
|
||||
self.config._preset_model_picker = None
|
||||
self.config._custom_model_id_entry = None
|
||||
self.config._local_model_file_picker = None
|
||||
self.config._status_group = None
|
||||
SettingsDialog._cleanup(self)
|
||||
|
||||
Reference in New Issue
Block a user