speechd: 0.8.5 -> 0.8.8, refactored #32924

berce · 2017-12-21T07:49:09Z

Motivation for this change

Add support for pulseaudio.
Add support for espeak-ng.
Apply best packaging practices I know so far.

Things done

Tested using sandboxing (nix.useSandbox on NixOS, or option build-use-sandbox in nix.conf on non-NixOS)
Built on platform(s)
- NixOS
- macOS
- other Linux distributions
Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
Tested compilation of all pkgs that depend on this change using nix-shell -p nox --run "nox-review wip"
Tested execution of all binary files (usually in ./result/bin/)
Fits CONTRIBUTING.md.

jtojnar · 2017-12-21T07:56:09Z

pkgs/development/libraries/speechd/default.nix

 }:

-stdenv.mkDerivation rec {
+with lib;
+buildPythonApplication rec {


This is definitely not a python application, it is a C library.

But it worked so well :-(.

spd-conf is a python application, and doesn't work after the requested change.
spd-say and speech-dispatcher work with both approaches.

Right, you would also need to revert the previous python wrapping.

jtojnar · 2017-12-21T07:58:46Z

pkgs/development/libraries/speechd/default.nix

+  buildInputs = [ libtool glib dotconf libsndfile libao libpulseaudio alsaLib ]
+    ++ optionals withEspeak-ng [ espeak-ng sonic pcaudiolib ]
+    ++ optional withPico svox
+    # TODO: add flint/festival support with festival-freebsoft-utils package


flite is separate from festival and it is already packaged.

Added flite.
flint is (related to) festival.

jtojnar · 2017-12-21T07:59:33Z

pkgs/development/libraries/speechd/default.nix

+    "--with-alsa"
+    "--with-libao"
+    "--with-oss"
+    "--with-default-audio-method=\"pulse,alsa,libao,oss\""


I think only one method can be default

It's documented in the source. It will automatically fallback from left to right.

jtojnar · 2017-12-21T08:08:25Z

pkgs/development/libraries/speechd/default.nix

+
+  propagatedBuildInputs = [ pyxdg ];
+
+  buildInputs = [ libtool glib dotconf libsndfile libao libpulseaudio alsaLib ]


It would be better to disable the other back-ends by default. libao already takes care of pulseaudio support and who uses alsa nowadays.

jtojnar · 2017-12-21T08:08:46Z

Hmm, that was fast. While at it, you can also update espeak master...jtojnar:speechd

I also suspect that the reason default speech synthesizer did not work is DefaultModule espeak in config/speechd.conf. We will probably want to patch it.

berce · 2017-12-21T09:26:13Z

You also had done quite some part of the work already.
I think it's ready for squash and merge. Do you agree? Or can you convince me to not use buildPythonApplication?

jtojnar · 2017-12-21T09:51:12Z

pkgs/development/libraries/speechd/default.nix

@@ -52,7 +58,7 @@ buildPythonApplication rec {

  meta = with stdenv.lib; {
    description = "Common interface to speech synthesis";
-    homepage = http://www.freebsoft.org/speechd;
+    homepage = http://devel.freebsoft.org/speechd;


It is HTTPS.

berce · 2017-12-21T10:21:51Z

espeak-ng (many languages) and flite (en only) work fine.
pico is available, but has no sound output.

jtojnar · 2017-12-21T11:53:20Z

I think it's ready for squash and merge. Do you agree? Or can you convince me to not use buildPythonApplication?

Basically the issue lies in semantics, speechd is not a python application with a binary component, it is a library with a python helper.

jtojnar · 2017-12-21T13:52:59Z

This fixes the default module: dbbefea

berce · 2017-12-21T14:35:52Z

Setting the default module looks fine in the speechd.conf file, but I still have no sound by default.
spd-conf seems outdated: espeak-ng can't be selected.

jtojnar · 2017-12-21T16:48:28Z

You might want to delete ~/.config/speech-dispatcher/ generated by the spd-conf for the bundled config to be used. As for the missing espeak-ng, I also noticed that, will check the source code.

jtojnar · 2017-12-22T17:02:49Z

pkgs/development/libraries/speechd/default.nix

+, withAlsa ? false, alsaLib
+, withOss ? false
+, withFlite ? true, flite
+, withFestival ? false # TODO: , festival-freebsoft-utils


I would comment out the whole attribute, since it does nothing.

Idem for Ivona.
Then also in the configureFlags the optional arguments.
Done.

jtojnar · 2017-12-22T17:05:11Z

pkgs/development/libraries/speechd/default.nix

+, withOss ? false
+, withFlite ? true, flite
+, withFestival ? false # TODO: , festival-freebsoft-utils
+, withEspeak-ng ? true, espeak-ng, sonic, pcaudiolib


Nix calls espeak-ng espeak, the old one is espeak-classic. We should respect the Nix convention here.

Done.
It makes the file contents confusing however: where to write -ng and where not?

jtojnar · 2017-12-22T17:09:51Z

pkgs/development/libraries/speechd/default.nix

 , withPico ? true, svox
+, withIvona ? false # TODO: , libdumbtts
+, defaultModule ? null
+, defaultLang ? "en"


I would leave this for a NixOS module. Actually, I would even remove the defaultModule argument since selectedDefaultModule is more of a bugfix, i intend to send a pull request fixing this upstream.

jtojnar · 2017-12-22T17:13:00Z

pkgs/development/libraries/speechd/default.nix

-stdenv.mkDerivation rec {
+with lib;
+let
+  selectedDefaultModule =


Please add here a comment like “speechd hard-codes espeak even when built without a support for it.”

jtojnar · 2017-12-22T17:21:44Z

pkgs/development/libraries/speechd/default.nix


-  hardeningDisable = [ "format" ];
+  propagatedBuildInputs = [ pyxdg ];


pyxdg is already listed in pythonPath below.

jtojnar · 2017-12-22T21:41:57Z

@GrahamcOfBorg build speechd

GrahamcOfBorg

Failure for system: x86_64-darwin

Package ‘speech-dispatcher-0.8.8’ in /Users/graham/nix-borg/repo/38dca4e3aa6bca43ea96d2fcc04e8229/builder/grahamc-zoidberg/pkgs/development/libraries/speechd/default.nix:75 is not supported on ‘x86_64-darwin’, refusing to evaluate.

a) For `nixos-rebuild` you can set
  { nixpkgs.config.allowBroken = true; }
in configuration.nix to override this.

b) For `nix-env`, `nix-build`, `nix-shell` or any other Nix command you can add
  { allowBroken = true; }
to ~/.config/nixpkgs/config.nix.

GrahamcOfBorg

Success for system: x86_64-linux

shrinking /nix/store/fn2cik14aignfmz2jy5krq3ccz1cbhxq-speech-dispatcher-0.8.8/lib/speech-dispatcher-modules/sd_cicero
shrinking /nix/store/fn2cik14aignfmz2jy5krq3ccz1cbhxq-speech-dispatcher-0.8.8/lib/speech-dispatcher-modules/sd_pico
shrinking /nix/store/fn2cik14aignfmz2jy5krq3ccz1cbhxq-speech-dispatcher-0.8.8/lib/speech-dispatcher/spd_pulse.so
shrinking /nix/store/fn2cik14aignfmz2jy5krq3ccz1cbhxq-speech-dispatcher-0.8.8/lib/speech-dispatcher/spd_oss.so
shrinking /nix/store/fn2cik14aignfmz2jy5krq3ccz1cbhxq-speech-dispatcher-0.8.8/lib/speech-dispatcher/spd_libao.so
shrinking /nix/store/fn2cik14aignfmz2jy5krq3ccz1cbhxq-speech-dispatcher-0.8.8/lib/speech-dispatcher/spd_alsa.so
stripping (with flags -S) in /nix/store/fn2cik14aignfmz2jy5krq3ccz1cbhxq-speech-dispatcher-0.8.8/lib  /nix/store/fn2cik14aignfmz2jy5krq3ccz1cbhxq-speech-dispatcher-0.8.8/bin 
patching script interpreter paths in /nix/store/fn2cik14aignfmz2jy5krq3ccz1cbhxq-speech-dispatcher-0.8.8
checking for references to /tmp/nix-build-speech-dispatcher-0.8.8.drv-0 in /nix/store/fn2cik14aignfmz2jy5krq3ccz1cbhxq-speech-dispatcher-0.8.8...
/nix/store/fn2cik14aignfmz2jy5krq3ccz1cbhxq-speech-dispatcher-0.8.8

GrahamcOfBorg

Success for system: aarch64-linux

shrinking /nix/store/qnbn0sxsci6nkzwxxvidphk5ffh5wsq6-speech-dispatcher-0.8.8/lib/speech-dispatcher/spd_oss.so
shrinking /nix/store/qnbn0sxsci6nkzwxxvidphk5ffh5wsq6-speech-dispatcher-0.8.8/lib/speech-dispatcher/spd_libao.so
shrinking /nix/store/qnbn0sxsci6nkzwxxvidphk5ffh5wsq6-speech-dispatcher-0.8.8/lib/speech-dispatcher/spd_alsa.so
shrinking /nix/store/qnbn0sxsci6nkzwxxvidphk5ffh5wsq6-speech-dispatcher-0.8.8/bin/spdsend
shrinking /nix/store/qnbn0sxsci6nkzwxxvidphk5ffh5wsq6-speech-dispatcher-0.8.8/bin/spd-say
shrinking /nix/store/qnbn0sxsci6nkzwxxvidphk5ffh5wsq6-speech-dispatcher-0.8.8/bin/speech-dispatcher
stripping (with flags -S) in /nix/store/qnbn0sxsci6nkzwxxvidphk5ffh5wsq6-speech-dispatcher-0.8.8/lib  /nix/store/qnbn0sxsci6nkzwxxvidphk5ffh5wsq6-speech-dispatcher-0.8.8/bin
patching script interpreter paths in /nix/store/qnbn0sxsci6nkzwxxvidphk5ffh5wsq6-speech-dispatcher-0.8.8
checking for references to /build in /nix/store/qnbn0sxsci6nkzwxxvidphk5ffh5wsq6-speech-dispatcher-0.8.8...
/nix/store/qnbn0sxsci6nkzwxxvidphk5ffh5wsq6-speech-dispatcher-0.8.8

jtojnar · 2017-12-22T21:52:11Z

I re-added python dependency to build python bindings and changed python3Packages.callPackage back to callPackage.

jtojnar · 2017-12-22T21:54:15Z

Thanks for your great work!

berce · 2017-12-23T08:38:51Z

It's done with pleasure. Thanks for the support, and constructive feedback.

berce mentioned this pull request Dec 21, 2017

Orca: init 3.26.0 #32866

Merged

8 tasks

jtojnar requested changes Dec 21, 2017

View reviewed changes

GrahamcOfBorg added 10.rebuild-darwin: 0 10.rebuild-linux: 1-10 labels Dec 21, 2017

jtojnar reviewed Dec 21, 2017

View reviewed changes

GrahamcOfBorg added 10.rebuild-darwin: 1-10 and removed 10.rebuild-darwin: 0 labels Dec 21, 2017

jtojnar reviewed Dec 21, 2017

View reviewed changes

berce force-pushed the speechd branch from 2122861 to 31ec7ec Compare December 21, 2017 10:10

jtojnar added the 6.topic: accessibility label Dec 21, 2017

jtojnar requested changes Dec 22, 2017

View reviewed changes

jtojnar reviewed Dec 22, 2017

View reviewed changes

berce added 2 commits December 22, 2017 22:35

espeak: 2016-08-28 → 1.49.2

e0a356d

speechd: 0.8.5 -> 0.8.8, refactored

857a71c

jtojnar force-pushed the speechd branch from 3fc0d17 to 857a71c Compare December 22, 2017 21:41

GrahamcOfBorg reviewed Dec 22, 2017

View reviewed changes

jtojnar approved these changes Dec 22, 2017

View reviewed changes

GrahamcOfBorg reviewed Dec 22, 2017

View reviewed changes

jtojnar merged commit 857a71c into NixOS:master Dec 22, 2017

berce deleted the speechd branch December 23, 2017 10:07


		propagatedBuildInputs = [ pyxdg ];

		buildInputs = [ libtool glib dotconf libsndfile libao libpulseaudio alsaLib ]


		hardeningDisable = [ "format" ];
		propagatedBuildInputs = [ pyxdg ];

speechd: 0.8.5 -> 0.8.8, refactored #32924

speechd: 0.8.5 -> 0.8.8, refactored #32924

Conversation

berce commented Dec 21, 2017

Motivation for this change

Things done

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jtojnar commented Dec 21, 2017

berce commented Dec 21, 2017

Choose a reason for hiding this comment

berce commented Dec 21, 2017

jtojnar commented Dec 21, 2017

jtojnar commented Dec 21, 2017

berce commented Dec 21, 2017

jtojnar commented Dec 21, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jtojnar commented Dec 22, 2017

GrahamcOfBorg left a comment

Choose a reason for hiding this comment

GrahamcOfBorg left a comment

Choose a reason for hiding this comment

GrahamcOfBorg left a comment

Choose a reason for hiding this comment

jtojnar commented Dec 22, 2017

jtojnar commented Dec 22, 2017

berce commented Dec 23, 2017