ibus-speech-to-text engine fails to run (?)

I can add `ibus-speech-to-text` (aka IBus STT) to my input methods, and set it up, but once selected for input, it doesn't work.

## STEPS TO REPRODUCE

1. `guix install ibus ibus-speech-to-text`

2. In GNOME Settings → Keyboard, add IBus STT to the list of input methods (it is displayed as `Other (Speech To Text)`)

3. In IBus STT Settings → General:

+ Preload models: ON

+ Active on start: ON

+ System locale: OFF

+ Locales: Select the lightweight model for English (USA)

4. In the desktop, start an app and place the text cursor in a text field (tried on IceCat, Ungoogled Chromium, GNOME Text Editor, GNOME Shell)

5. Switch to IBus STT input method using Super+Space (give it about 1 second to load).

6. Dictate to the machine.

## EXPECTED RESULT

Text is typed magically as you speak in the text field selected in step 4.

## UNEXPECTED RESULT

No text is added to the text field I selected in step 4.

## SYSTEM INFORMATION

~~~

OS: Guix System x86_64 fb3085e

Kernel: 6.1.5-gnu

DE: GNOME 42.4 (tried on Wayland and Xorg)

ibus: 1.5.27

ibus-speech-to-text: 0.4.0

~~~

## ADDITIONAL INFORMATION

Could it be that the speech-to-text engine is failing to run because it can't find the GTK 4.0 namespace through Gobject Introspection. For example, after being pointed to the following command by IBus STT developer (https://github.com/PhilippeRo/IBus-Speech-To-Text/discussions/7)I see the following error:

~~~

$ /gnu/store/HASH-ibus-speech-to-text-0.4.0/libexec/ibus-engine-stt --gapplication-replace -g

Traceback (most recent call last):

File "/gnu/store/87dgkps8sp1jb4z2w4m1dnp0zvnq050l-ibus-speech-to-text-0.4.0/share/ibus-stt/main.py", line 38, in <module>

from sttenginefactory import STTEngineFactory

File "/gnu/store/87dgkps8sp1jb4z2w4m1dnp0zvnq050l-ibus-speech-to-text-0.4.0/share/ibus-stt/sttenginefactory.py", line 26, in <module>

from sttengine import STTEngine

File "/gnu/store/87dgkps8sp1jb4z2w4m1dnp0zvnq050l-ibus-speech-to-text-0.4.0/share/ibus-stt/sttengine.py", line 29, in <module>

gi.require_version('Gtk', '4.0')

File "/gnu/store/5ijhwr127smgxrp5dls7dxnr9jwa4m8p-python-pygobject-3.40.1/lib/python3.9/site-packages/gi/__init__.py", line 129, in require_version

raise ValueError('Namespace %s not available for version %s' %

ValueError: Namespace Gtk not available for version 4.0

~~~

In the command above, HASH is the hash corresponding to `ibus-speech-to-text-0.4.0` in my user profile.

## WORKAROUND

The input method works after making sure `gtk` and `python-pygobject` are in the environment where `ibus-engine-stt` is run:

1. Start an augmented shell:

guix shell ibus-speech-to-text gtk python-pygobject

2. Run `ibus-engine-stt` as follows (where HASH is the hash for ibus-speech-to-text-0.4.0 in the profile created for the shell in step one):

/gnu/store/HASH-ibus-speech-to-text-0.4.0/libexec/ibus-engine-stt --gapplication-replace -g

After this, you should see INFO and DEBUG information printed out. You can now launch an application, place the caret in any text box, switch to speech-to-text input method, and start dictating to the machine. Selecting other languages in "IBus STT settings → General → Locale" also work (I tried dictating in English, Japanese and Spanish).

---

Luis Felipe López Acevedo

Am Donnerstag, dem 02.02.2023 um 19:46 +0000 schrieb Luis Felipe:

Since this workaround works for you, I am fairly certain that the

package is simply missing a wrapper for GI_TYPELIB_PATH. IMHO we

should more generally add some code to handle that in glib-or-gtk-

build-system, but that'd be a core-updates change.

Cheers

On Friday, February 3rd, 2023 at 07:14, Liliana Marie Prikler <liliana.prikler@ist.tugraz.at> wrote:

The funny thing is that the package already wraps programs and augment GI_TYPELIB_PATH. Although I don't understand why ibus' "/lib/girepository-1.0" is also added to GUIX_PYTHONPATH.

Now, that the build system could handle all this in the future sounds great to me.

Hi,

The attached patch fixed the issue for me. Now ibus-engine-stt seems to be running correctly and I can switch to the input method without the workaround indicated in the initial report.

I noticed that there are some lint issues from the original package definition though. I didn't fixed those:

$ ./pre-inst-env guix lint ibus-speech-to-text

/home/yo/guix/gnu/packages/ibus.scm:899:5: ibus-speech-to-text@0.4.0:

[1] 'desktop-file-utils' should probably be a native input

/home/yo/guix/gnu/packages/ibus.scm:899:5: ibus-speech-to-text@0.4.0:

[2] 'glib:bin' should probably be a native input

/home/yo/guix/gnu/packages/ibus.scm:899:5: ibus-speech-to-text@0.4.0:

[3] 'gobject-introspection' should probably be a native input

/home/yo/guix/gnu/packages/ibus.scm:899:5: ibus-speech-to-text@0.4.0:

[4] label 'glib' does not match package name 'glib:bin'

/home/yo/guix/gnu/packages/ibus.scm:856:2: ibus-speech-to-text@0.4.0:

[5] "bash-minimal" should be in 'inputs' when 'wrap-program' is used

Am Dienstag, dem 07.02.2023 um 16:41 +0000 schrieb Luis Felipe:

All but [4] should be fixed. Can you attach a separate patch to do so?

(If possible, use `git send-email` with a reroll count of 2, so that CI

and mumi-based workflows behave as intended.)

Should probably be #:phases.

Should probably be "Use getenv to set GUIX_PYTHONPATH."

I think you should also use getenv here. I think we should mimic

python-build-system here and add the output directory to

GUIX_PYTHONPATH before it gets wrapped.

I don't think it's necessary to remove them ;)

Cheers

Hi Liliana,

I'm not sure I understand this part. Do you mean something like this (set GUIX_PYTHONPATH in the let definitions)?:

(let* ((out (assoc-ref outputs "out"))

(ibus-stt-dir (string-append out "/share/ibus-stt"))

(guix-pythonpath

(setenv "GUIX_PYTHONPATH"

(string-append ibus-stt-dir ":"

(getenv "GUIX_PYTHONPATH")))))

(for-each (lambda (prog)

(wrap-program prog

`("GST_PLUGIN_PATH" ":" prefix

(,(string-append (assoc-ref inputs "gst-vosk")

"/lib/gstreamer-1.0")

,(getenv "GST_PLUGIN_SYSTEM_PATH")))

`("GUIX_PYTHONPATH" =

(,(getenv "GUIX_PYTHONPATH")))

`("GI_TYPELIB_PATH" =

(,(getenv "GI_TYPELIB_PATH")))))

(list (string-append out "/libexec/ibus-engine-stt")

(string-append out "/libexec/ibus-setup-stt"))))

In the meantime, I just sent a new version of the patch using git send-email to refresh my memory (haven't used it in years) and check whether automatic tasks are triggered in the infrastructure. The new patch amends the commit message and puts delimiters back. I will send another version later once I understand what is left to be done, together with the other patch to fix lint issues, as you suggested.

Fixes https://issues.guix.gnu.org/61236.

set GUIX_PYTHONPATH and GI_TYPELIB_PATH.

---

gnu/packages/ibus.scm | 13 ++++---------

1 file changed, 4 insertions(+), 9 deletions(-)

Am Donnerstag, dem 09.02.2023 um 19:33 +0000 schrieb Luis Felipe:

No, I meant more like

(add-after 'set-paths 'add-output-to-pythonpath

(lambda* (#:key outputs #:allow-other-keys)

(setenv ...)))

Confer %standard-phases in (guix build python-build-system) or

(guix build pyproject-build-system) for the ordering of phases there.

I'm fairly certain that GUIX_PYTHONPATH is configured rather soon-ish.

When you do, don't forget to CC <liliana.prikler@gmail.com>.

Thanks

Fixes https://issues.guix.gnu.org/61236.

set GUIX_PYTHONPATH and GI_TYPELIB_PATH.

---

gnu/packages/ibus.scm | 23 ++++++++++++-----------

1 file changed, 12 insertions(+), 11 deletions(-)

bash-minimal. Move desktop-file-utils, glib:bin and

gobject-introspection to native-inputs.

---

gnu/packages/ibus.scm | 10 ++++++----

1 file changed, 6 insertions(+), 4 deletions(-)

Am Freitag, dem 10.02.2023 um 13:49 -0500 schrieb sirgazil@zoho.com:

Updated commit messages and pushed.

Cheers