-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathspeechd.el
1245 lines (1091 loc) · 48.2 KB
/
speechd.el
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
;;; speechd.el --- Library for accessing Speech Dispatcher -*- lexical-binding: t -*-
;; Copyright (C) 2012-2025 Milan Zamazal <[email protected]>
;; Copyright (C) 2003-2010 Brailcom, o.p.s.
;; Author: Milan Zamazal <[email protected]>
;; COPYRIGHT NOTICE
;;
;; This program is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;;
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;;
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;; This library allows you to communicate with Speech Dispatcher.
;; Usually, the communication goes like this:
;;
;; (speechd-open)
;; ...
;; (speechd-say-text "Hello, world!")
;; ...
;; (speechd-close)
;;
;; Functions and variables starting with the prefix `speechd--' are considered
;; internal and you shouldn't use them outside this file.
;;
;; See docstrings and the Texinfo manual for full details.
;;; Code:
(require 'cl-lib)
(require 'xml)
(require 'speechd-common)
;;; User variables
(defun speechd--speechd-address ()
(let ((address (getenv "SPEECHD_ADDRESS")))
(if address
(split-string address ":")
'(nil nil nil))))
(defgroup speechd ()
"SSIP interface."
:group 'speechd-el)
(defcustom speechd-connection-method
(if-let ((method-string (cl-first (speechd--speechd-address)))
(method (intern (string-replace "_" "-" method-string)))
(valid-p (memq method '(unix-socket inet-socket))))
method
'unix-socket)
"Connection method to Speech Dispatcher.
Possible values are `unix-socket' for Unix domain sockets and
`inet-socket' for Internet sockets on a given host and port (see
`speechd-host' and `speechd-port' variables)."
:type '(choice (const :tag "Unix domain socket" unix-socket)
(const :tag "Internet socket" inet-socket))
:group 'speechd)
(defcustom speechd-host
(or (and (eq speechd-connection-method 'inet-socket)
(cl-second (speechd--speechd-address)))
"localhost")
"Name of the default host running speechd to connect to.
Value of this variable matters only when Internet sockets are
used for communication with Speech Dispatcher."
:type 'string
:group 'speechd)
(defcustom speechd-port
(if-let ((port-string (cl-third (speechd--speechd-address)))
(port (ignore-errors (car (read-from-string port-string)))))
port
6560)
"Default port of speechd.
Value of this variable matters only when Internet sockets are
used for communication with Speech Dispatcher."
:type 'integer
:group 'speechd)
(defcustom speechd-socket-name
(and (eq speechd-connection-method 'unix-socket)
(cl-second (speechd--speechd-address)))
"Name of the default socket running speechd to connect to.
If nil, use the Speech Dispatcher default socket.
Value of this variable matters only when Unix domain sockets are
used for communication with Speech Dispatcher."
:type '(choice (const :tag "Default" nil)
(string :tag "Socket file"))
:group 'speechd)
(defcustom speechd-autospawn t
"If non-nil, Emacs will attempt to automatically start Speech Dispatcher.
This means that if speechd-el gets a speech request and the
Speech Dispatcher server is not running already, speechd-el will
launch it."
:type 'boolean
:group 'speechd)
(defcustom speechd-timeout 3
"Number of seconds to wait for speechd response."
:type 'integer
:group 'speechd)
(define-widget 'speechd-priority-tag 'choice
"Radio group for selecting a speechd priority tag."
:args '((const :tag "Important" :value important)
(const :tag "Message" :value message)
(const :tag "Text" :value text)
(const :tag "Notification" :value notification)
(const :tag "Progress" :value progress)))
(define-widget 'speechd-voice-tag 'choice
"Voice selector."
:args '((const :tag "Default" nil)
(symbol :tag "Named" :value nil
:match (lambda (w value)
(or (eq value nil)
(assoc value speechd-voices))))))
(defmacro speechd--generate-customization-options (var)
(let ((value (symbol-value var)))
`(quote (choice :value ,(cdr (cl-first value))
,@(mapcar #'(lambda (o)
`(const :tag ,(car o) ,(cdr o)))
value)))))
(defconst speechd--punctuation-modes '(("none" . none)
("some" . some)
("all" . all)))
(defconst speechd--capital-character-modes '(("none" . none)
("spell" . spell)
("icon" . icon)))
(defun speechd--set-variable-and-reopen (name value)
(let ((orig-value (when (default-boundp name) (default-value name))))
(set-default name value)
(when (and (not (equal orig-value value))
(fboundp 'speechd-reopen))
(speechd-reopen))))
(defcustom speechd-voices '()
"Alist of voice identifiers and their parameters.
Each element of the list is of the form (VOICE-ID . PARAMETERS), where VOICE-ID
is a symbol under which the voice will be accessed and PARAMETERS is an alist
of parameter identifiers and parameter values. Valid parameter names are the
following symbols: language, gender, age, style, name, rate, pitch, volume,
punctuation-mode, capital-character-mode, message-priority, output-module.
Please note that any parameter entry present will change the corresponding
parameter, even if the parameter value is nil or empty; if you don't want to
change the parameter in any way by the voice, don't put it to the list (and
don't enable its entry in customize).
Name is a string identifying Speech Dispatcher voice name. If it is not given,
the parameters gender, age, and style are considered to select a Speech
Dispatcher voice. Gender can be one of the symbols `male', `female',
`neutral'. Age can be one of the symbols `middle-adult', `child'. `neutral'.
Style can be one of the numbers 1, 2, 3 (style values are likely to be changed
in future).
The message-priority parameter sets priority of any message of the voice. Its
value is any of the message priority symbols.
See the corresponding speechd-set-* functions for valid values of other
parameters.
The voice named nil is special, it defines a default voice. Explicit
definition of its parameters is optional."
:type `(repeat
(cons
:tag "Voice"
(speechd-voice-tag :tag "Voice")
(set
:tag "Parameters"
;;
(cons :tag "Language" (const :format "" language)
string)
(cons :tag "Gender" (const :format "" gender)
(choice (const male) (const female) (const neutral)))
(cons :tag "Age" (const :format "" age)
(choice (const middle-adult) (const child) (const neutral)))
(cons :tag "Style" (const :format "" style)
(choice (const 1) (const 2) (const 3)))
(cons :tag "SSIP voice identifier" (const :format "" name)
(choice (const "male1") (const "male2") (const "male3")
(const "female1") (const "female2") (const "female3")
(const "child_male") (const "child_female")
(string :tag "Other")))
;;
(cons :tag "Rate" (const :format "" rate)
integer)
(cons :tag "Pitch" (const :format "" pitch)
integer)
(cons :tag "Volume" (const :format "" volume)
integer)
;;
(cons :tag "Punctuation mode" (const :format "" punctuation-mode)
,(speechd--generate-customization-options
speechd--punctuation-modes))
(cons :tag "Capital character mode"
(const :format "" capital-character-mode)
,(speechd--generate-customization-options
speechd--capital-character-modes))
;;
(cons :tag "SSML mode" (const :format "" ssml-mode) boolean)
(cons :tag "Index marks" (const :format "" index-marks) boolean)
;;
(cons :tag "Message priority" (const :format "" message-priority)
(speechd-priority-tag :value text))
(cons :tag "Output module" (const :format "" output-module)
string))))
:set #'speechd--set-variable-and-reopen
:group 'speechd)
(defcustom speechd-connection-voices '()
"Alist of connection names and corresponding voices.
Each element of the list is of the form (CONNECTION-NAME . VOICE-ID), where
CONNECTION-NAME is a string naming a connection and VOICE-ID is a voice
identifier defined in the variable `speechd-voices'.
For connections that are not specified here, the voice named nil is used.
You must reopen the connections to apply the changes to this variable."
:type '(alist :key-type (string :tag "Connection name")
:value-type (speechd-voice-tag :tag "Voice"))
:set #'speechd--set-variable-and-reopen
:group 'speechd)
(defcustom speechd-cancelable-connections '()
"List of names of connections on which cancel operation applies by default."
:type '(repeat (string :tag "Connection name"))
:group 'speechd)
(defcustom speechd-face-voices '()
"Alist mapping faces to voices.
Each of the alist element is of the form (FACE . VOICE) where FACE is a face
and string is a voice identifier defined in `speechd-voices'. Each face is
spoken in the corresponding voice.
If there's no item for a given face in this variable, the face is spoken in the
current voice."
:type '(alist :key-type face :value-type (speechd-voice-tag :tag "Voice"))
:group 'speechd)
;;; External variables
(defvar speechd-spell nil
"If non-nil, any spoken text is spelled.")
;;; Internal constants and configuration variables
(defconst speechd--buffer " *speechd*"
"Name of the buffer associated with speechd connections.")
(defconst speechd--application-name "Emacs"
"Name of the client as set to speechd.")
(defvar speechd--language-codes
'(("czech" . "cs")
("english" . "en")
("french" . "fr")
("german" . "de")))
(defvar speechd--default-language (or (cdr (assoc current-language-environment
speechd--language-codes))
"en"))
(defvar speechd--default-connection-parameters
'(punctuation-mode some
spelling-mode nil
capital-character-mode none
voice male1
rate 0
pitch 0
volume 100
index-marks t
ssml-mode nil))
(defconst speechd--coding-system (if (featurep 'xemacs)
'no-conversion-dos ;; No utf yet
'utf-8-dos))
(defconst speechd--parameter-names
'((client-name . "CLIENT_NAME")
(language . "LANGUAGE")
(message-priority . "PRIORITY")
(punctuation-mode . "PUNCTUATION")
(pause-context . "PAUSE_CONTEXT")
(capital-character-mode . "CAP_LET_RECOGN")
(voice . "VOICE")
(synthesizer-voice . "SYNTHESIS_VOICE")
(rate . "RATE")
(pitch . "PITCH")
(volume . "VOLUME")
(spelling-mode . "SPELLING")
(index-marks . "NOTIFICATION INDEX_MARKS")
(ssml-mode . "SSML_MODE")
(output-module . "OUTPUT_MODULE") ; TODO: to be removed sometimes
))
(defconst speechd--list-parameters
'((voices
"VOICES" identity)
(synthesis-voices
"SYNTHESIS_VOICES" (lambda (line) (cl-first (split-string line))))))
(defconst speechd--parameter-value-mappings
'((message-priority
(important . "IMPORTANT")
(message . "MESSAGE")
(text . "TEXT")
(notification . "NOTIFICATION")
(progress . "PROGRESS")
)
(punctuation-mode
(none . "none")
(some . "some")
(all . "all"))
(capital-character-mode
(none . "none")
(spell . "spell")
(icon . "icon"))
(spelling-mode
(t . "on")
(nil . "off"))
(index-marks
(t . "on")
(nil . "off"))
(ssml-mode
(t . "on")
(nil . "off"))))
(defconst speechd--volatile-parameters '(output-module))
;;; Internal variables
(cl-defstruct speechd--connection
name
host
port
(failure-p nil)
(last-try-time nil)
process
(process-output "")
(paused-p nil)
(in-block nil)
(parameters ())
(forced-priority nil)
(last-command nil))
(cl-defstruct speechd--request
string)
(defvar speechd--connections (make-hash-table :test 'equal)
"Hash table mapping client names to `speechd-connection' instances.")
(defvar speechd--retry-time 1.0)
(defvar speechd-client-name)
(defvar speechd--current-connection)
;;; Utilities
(defmacro speechd--iterate-connections (&rest body)
`(maphash #'(lambda (_ connection)
(let ((speechd--current-connection connection))
,@body))
speechd--connections))
(defmacro speechd--iterate-clients (&rest body)
`(maphash #'(lambda (name _)
(let ((speechd-client-name name))
,@body))
speechd--connections))
(defun speechd-connection-names ()
"Return the list of all present connection names."
(let ((names '()))
(speechd--iterate-clients
(push speechd-client-name names))
names))
(defmacro speechd--with-current-connection (&rest body)
`(let ((speechd--current-connection (speechd--connection)))
(when (and (speechd--connection-failure-p speechd--current-connection)
(>= (- (float-time) (speechd--connection-last-try-time speechd--current-connection))
speechd--retry-time))
(ignore-errors (speechd-reopen t))
(setq speechd--current-connection (speechd--connection)))
(unless (speechd--connection-failure-p speechd--current-connection)
,@body)))
(defmacro speechd--with-connection-setting (var value &rest body)
(let ((accessor (intern (concat "speechd--connection-" (symbol-name var))))
(orig-value (gensym)))
`(let ((,orig-value (,accessor connection)))
(setf (,accessor connection) ,value)
(unwind-protect
(progn
,@body)
(setf (,accessor connection) ,orig-value)))))
(defmacro speechd--with-connection-parameters (parameters &rest body)
(let (($parameters (gensym))
($orig-parameters (gensym))
($cparameters (gensym))
($p (gensym))
($v (gensym))
($orig-v (gensym))
($pv (gensym)))
`(let* ((,$parameters ,parameters)
(,$orig-parameters ()))
(unwind-protect
(let ((,$cparameters (speechd--connection-parameters speechd--current-connection)))
(while ,$parameters
(let* ((,$p (cl-first ,$parameters))
(,$v (cl-second ,$parameters))
(,$orig-v (plist-get ,$cparameters ,$p)))
(when (and (not (equal ,$v ,$orig-v))
(or ,$v
(not (memq ,$p '(language)))))
(when (and (plist-member ,$cparameters ,$p)
(not (memq ,$p '(message-priority))))
(push (cons ,$p ,$orig-v) ,$orig-parameters))
(speechd--set-parameter ,$p ,$v)))
(setq ,$parameters (nthcdr 2 ,$parameters)))
,@body)
(dolist (,$pv ,$orig-parameters)
(speechd--set-parameter (car ,$pv) (cdr ,$pv)))))))
(defun speechd--voice-name (parameters)
(or (cdr (assoc 'name parameters))
(let ((gender (cdr (assoc 'gender parameters)))
(age (cdr (assoc 'age parameters)))
(style (cdr (assoc 'style parameters))))
(format "%s%s%s"
(if (eq age 'child) "child_" "")
(if (eq gender 'female) "female" "male")
(or style "1")))))
(defun speechd--voice-parameters (voice)
(let* ((parameters (cdr (assoc voice speechd-voices)))
(voice-name (speechd--voice-name parameters))
(result (if voice-name (list 'voice voice-name) '())))
(dolist (p parameters)
(unless (memq (car p) '(name gender age style))
(plist-put result (car p) (cdr p))))
result))
(defmacro speechd--with-voice (voice &rest body)
`(speechd--with-connection-parameters (speechd--voice-parameters ,voice)
,@body))
(defun speechd--current-language ()
speechd-language)
;;; Process management functions
(cl-defun speechd--connection (&optional (name speechd-client-name) (create-if-needed t))
(or (gethash name speechd--connections)
(and create-if-needed
(let ((speechd-client-name name))
(speechd-open)))))
(defun speechd--jump-to-marker (index-mark)
(let ((marker (cdr (assoc index-mark speechd--markers))))
(when marker
(let ((buffer (marker-buffer marker))
(position (marker-position marker)))
(when buffer
(select-window (or (get-buffer-window buffer) (selected-window)))
(unless (eq (window-buffer) buffer)
(switch-to-buffer buffer))
(goto-char position))))))
(defun speechd--process-notifications (output)
;; 700-msg_id
;; 700-client_id
;; 700-index_mark
;; 700 END
(let ((notifications '())
(pos 0))
(while (string-match speechd--notification-regexp output pos)
(push (list (match-string 1 output) (match-string 2 output) (match-string 3 output))
notifications)
(setq pos (match-end 0)))
;; There can be additional index marks inserted by Speech Dispatcher,
;; let's skip them and find the first meaningful index mark.
(while notifications
(cl-destructuring-bind (code separator _message) (car notifications)
(setq notifications (cdr notifications))
(when (and (equal code speechd--index-mark-code)
(equal separator " "))
(when notifications
(cl-destructuring-bind (code separator message) (car notifications)
(when (and (equal code speechd--index-mark-code)
(equal separator "-"))
(speechd--jump-to-marker message)
(setq notifications nil))))))))
output)
(defun speechd--process-filter (_process output)
(speechd--with-current-connection
(setf (speechd--connection-process-output speechd--current-connection)
(speechd--process-notifications
(concat (speechd--connection-process-output speechd--current-connection) output)))))
(defun speechd--open-connection (method host port socket-name)
(let ((process
(cond
((eq method 'unix-socket)
(make-network-process
:name "speechd" :family "local"
:remote (or socket-name
(expand-file-name
(let ((runtime-dir (getenv "XDG_RUNTIME_DIR")))
(concat (if runtime-dir (concat runtime-dir "/") "~/.")
"speech-dispatcher/speechd.sock"))))))
((eq method 'inet-socket)
(open-network-stream "speechd" nil host port))
(t (error "Invalid communication method: `%s'" method)))))
(when process
(set-process-coding-system process
speechd--coding-system
speechd--coding-system)
(if (fboundp 'set-process-query-on-exit-flag)
(set-process-query-on-exit-flag process nil)
(set-process-query-on-exit-flag process nil))
(set-process-filter process #'speechd--process-filter))
process))
(defun speechd--close-connection (connection)
(let ((process (speechd--connection-process connection)))
(when process
(delete-process (speechd--connection-process connection))
(setf (speechd--connection-process connection) nil))))
(defun speechd--send-connection (connection command)
(let ((process (speechd--connection-process connection)))
(when process
(with-speechd-coding-protection
(condition-case _
(progn
(process-send-string process command)
(let ((output (speechd--connection-process-output connection)))
(while (not (string-match speechd--end-regexp output))
(unless (accept-process-output process speechd-timeout nil 1)
(signal 'ssip-connection-error
"Timeout in communication with Speech Dispatcher"))
(setq output (speechd--connection-process-output connection)))
(let ((pos (match-end 0)))
;; If there are more responses, try to get in sync:
(while (string-match speechd--end-regexp output pos)
(setq output (substring output pos))
(setq pos (- (match-end 0) pos)))
(setf (speechd--connection-process-output connection)
(substring output pos))
(substring output 0 pos))))
(error
(speechd--permanent-connection-failure connection)
(signal 'ssip-connection-error
"Error in communication with Speech Dispatcher")))))))
(put 'ssip-connection-error 'error-conditions
'(error speechd-connection-error ssip-connection-error))
(put 'ssip-connection-error 'error-message
"Error on opening Speech Dispatcher connection")
;;;###autoload
(cl-defun speechd-open (&optional method &key host port socket-name quiet force-reopen)
"Open connection to Speech Dispatcher using the given method.
If the connection corresponding to the current `speechd-client-name' value
already exists, close it and reopen again, with the same connection parameters.
Available methods are `unix-socket' and `inet-socket' for communication
over Unix sockets and TCP sockets respectively. Default is `unix-socket'.
The key arguments HOST and PORT are only relevant to the `inet-socket'
communication method and identify the speechd server location. They can
override default values stored in the variables `speechd-host' and
`speechd-port'.
The SOCKET-NAME argument is only relevant to the `unix-socket' communication
method and can override the default path to the Dispatcher's Unix socket for
the given user.
If the key argument QUIET is non-nil, don't report failures and quit silently.
If the key argument FORCE-REOPEN is non-nil, try to reopen an existent
connection even if it previously failed.
Return the opened connection on success, nil otherwise."
(interactive)
(let ((connection (gethash speechd-client-name speechd--connections)))
(let ((method (or method speechd-connection-method))
(host (or host speechd-host))
(socket-name (or socket-name speechd-socket-name))
(port (or port speechd-port)))
(when connection
(speechd--close-connection connection)
(setq host (speechd--connection-host connection)
port (speechd--connection-port connection)))
(when speechd-autospawn
(when (eql (ignore-errors
(call-process "speech-dispatcher" nil nil nil "--spawn"))
0)
(sleep-for 1)))
(let* ((name speechd-client-name)
(voice (cdr (assoc name speechd-connection-voices)))
(default-parameters (append
(speechd--voice-parameters voice)
speechd--default-connection-parameters))
(parameters (cond
((and connection force-reopen)
(append
default-parameters
(speechd--connection-parameters connection)))
(connection
(append
(speechd--connection-parameters connection)
default-parameters))
(t
default-parameters)))
(connection-error nil)
(process (when (or (not connection)
(not (speechd--connection-failure-p connection))
force-reopen)
(condition-case err (speechd--open-connection
(or method 'unix-socket)
host port socket-name)
(file-error
(setq connection-error err)
nil)))))
(when (or process (not quiet))
(setq connection (make-speechd--connection
:name name :host host :port port :process process))
(puthash name connection speechd--connections))
(when (and (not process) (not quiet))
(speechd--permanent-connection-failure connection)
(signal 'ssip-connection-error connection-error))
(when process
(speechd--set-connection-name name)
(setq parameters (append parameters
(list 'language speechd--default-language)))
(let ((already-set '(client-name)))
(while parameters
(cl-destructuring-bind (parameter value . next) parameters
(unless (memq parameter already-set)
(push parameter already-set)
(speechd--set-parameter parameter value))
(setq parameters next)))))
(let ((priority (and
connection
(plist-get default-parameters 'message-priority))))
(when priority
(speechd--set-parameter 'message-priority priority)
(setf (speechd--connection-forced-priority connection) t)))))
connection))
(cl-defun speechd-close (&optional (name speechd-client-name))
"Close speechd connection named NAME."
(interactive)
(let ((connection (speechd--connection name nil)))
(when connection
(speechd--close-connection connection)
(remhash name speechd--connections))))
(defun speechd-close-all ()
"Close all speechd connections."
(speechd--iterate-clients (speechd-close)))
(defun speechd-reopen (&optional quiet)
"Close and open again all the connections to speechd.
If QUIET is non-nil, don't echo success report."
(interactive)
(let ((number-of-connections 0)
(number-of-failures 0))
(maphash #'(lambda (name _)
(let ((speechd-client-name name))
(if (speechd-open nil :quiet t :force-reopen t)
(cl-incf number-of-connections)
(cl-incf number-of-failures))))
speechd--connections)
(unless quiet
(message (format "%d connections successfully reopened, %d failures"
number-of-connections number-of-failures)))))
;;; Process communication functions
(defconst speechd--eol "\n")
(defconst speechd--end-regexp (format "^[0-6][0-9][0-9] .*%s" speechd--eol))
(defconst speechd--result-regexp
(format "\\`[0-9][0-9][0-9]-\\(.*\\)%s" speechd--eol))
(defconst speechd--success-regexp
(format "^[1-2][0-9][0-9] .*%s" speechd--eol))
(defconst speechd--notification-regexp
(format "^\\(7[0-9][0-9]\\)\\([- ]\\)\\(.*\\)%s" speechd--eol))
(defconst speechd--index-mark-code "700")
(defun speechd--permanent-connection-failure (connection)
(speechd--close-connection connection)
(setf (speechd--connection-failure-p connection) t
(speechd--connection-last-try-time connection) (float-time)
(speechd--connection-paused-p connection) nil
(speechd--connection-parameters connection) ()))
(defun speechd--send-request (request)
(speechd--with-current-connection
(save-match-data
(let ((answer (speechd--send-connection
speechd--current-connection (speechd--request-string request))))
(let ((data '())
success)
(while (and answer
(string-match speechd--result-regexp answer))
(push (match-string 1 answer) data)
(setq answer (substring answer (match-end 0))))
(setq success (and answer
(string-match speechd--success-regexp answer)))
(unless success
(setq data nil))
(list success
data
(and success (substring answer 0 3))
(and success (substring answer 4))))))))
(defconst speechd--block-commands
'(("speak")
(".")
("sound_icon")
("char")
("key")
("quit")
("block" ("end"))
("set" ("self" ("rate") ("pitch") ("volume") ("voice") ("language")
("punctuation") ("cap_let_recogn") ("ssml_mode")))))
(defun speechd--block-command-p (command &optional allowed)
(unless allowed
(setq allowed speechd--block-commands))
(let* ((match (assoc (downcase (cl-first command)) allowed))
(rest-allowed (cdr match)))
(and match
(or (not rest-allowed)
(speechd--block-command-p (cl-rest command) rest-allowed)))))
(cl-defun speechd--send-command (command)
(unless (listp command)
(setq command (list command)))
(speechd--with-current-connection
(when (or (not (speechd--connection-in-block speechd--current-connection))
(speechd--block-command-p command))
(setf (speechd--connection-last-command speechd--current-connection) command)
(speechd--send-request
(make-speechd--request
:string (concat (mapconcat #'identity command " ") speechd--eol))))))
(defun speechd--send-text (text)
(when (cl-first (or (speechd--send-command "SPEAK") '(t)))
;; We must be careful here. There is no answer from SSIP until all data
;; including the terminator is sent. Thus, if we send the data in pieces,
;; there may be noticeable delays when waiting for TCP packet
;; acknowledgments. So we send all data, including the final dot
;; terminator, in a single piece.
(save-match-data
(let ((i 0))
(while (string-match "[\200-\377]" text i)
(let ((char (string-to-char (match-string 0 text))))
(if (char-charset char '(eight-bit))
(setq text (replace-match (format "\\%o" (encode-char char 'eight-bit)) t t text))
(setq i (match-end 0))))))
(let ((i 0))
(while (and (> (length text) 0)
(string-match
"\\(\\`\\|\n\\)\\(\\(\\.\\).*\\)\\(\n\\|\\'\\)"
text i))
(setq text (replace-match ".." nil nil text 3))
(setq i (1+ (match-end 0))))))
;; We must remove text properties from the string, otherwise Emacs does
;; strange things when recoding non-ASCII characters to UTF-8.
(set-text-properties 0 (length text) nil text)
(unless (cl-first (or (speechd--send-request
(make-speechd--request
:string (concat text speechd--eol "." speechd--eol)))
'(t)))
;; We must reset the connection on failure, to bring it back to the
;; command state from the text reading state.
(speechd-close))))
;;; Value retrieval functions
(defun speechd--list (parameter)
(cl-multiple-value-bind (command processor)
(cdr (assoc parameter speechd--list-parameters))
(mapcar processor (cl-second (speechd--send-command (list "LIST" command))))))
;;; Parameter setting functions
(defun speechd--convert-numeric (number)
(cond ((< number -100) -100)
((> number 100) 100)
(t number)))
(defun speechd--transform-parameter-value (parameter value)
(cond
((stringp value)
value)
((integerp value)
(number-to-string (speechd--convert-numeric value)))
((symbolp value)
(cdr (assoc value
(cdr (assoc parameter speechd--parameter-value-mappings)))))))
(defun speechd--call-set-parameter (parameter value globally)
(let ((p (or (cdr (assoc parameter speechd--parameter-names))
(error "Invalid parameter name: `%s'" parameter)))
(v (or (speechd--transform-parameter-value parameter value)
(error "Invalid parameter value: %s=%s" parameter value))))
(speechd--send-command (list "SET" (if globally "all" "self") p v))))
(defun speechd--set-connection-parameter (parameter value)
(let* ((plist (speechd--connection-parameters speechd--current-connection))
(orig-value (if (plist-member plist parameter)
(plist-get plist parameter)
'unknown)))
(when (or (memq parameter speechd--volatile-parameters)
(and (not (equal orig-value value))
(or
(not (eq parameter 'message-priority))
(not (speechd--connection-forced-priority speechd--current-connection)))))
(let ((answer (speechd--call-set-parameter parameter value nil)))
(setq speechd--current-connection (speechd--connection))
(when (cl-first answer)
(setf (speechd--connection-parameters speechd--current-connection)
(plist-put (speechd--connection-parameters speechd--current-connection)
parameter value))))
;; Speech Dispatcher bug work-around
(when (eq parameter 'language)
(let ((output-module (plist-get
(speechd--connection-parameters speechd--current-connection)
'output-module)))
(when output-module
(speechd--set-connection-parameter 'output-module
output-module)))))))
(defun speechd--set-parameter (parameter value &optional all)
(if all
(progn
;; We must iterate clients even on global all, to update speechd-el
;; connection parameters.
(speechd--iterate-connections
(speechd--set-connection-parameter parameter value))
(when (consp all)
(speechd--with-current-connection
(speechd--call-set-parameter parameter value t))))
(speechd--with-current-connection
(speechd--set-connection-parameter parameter value))))
(defun speechd--set-connection-name (name)
(speechd--set-parameter
'client-name
(format "%s:%s:%s" (user-login-name) speechd--application-name name)))
(defun speechd-set-language (language)
"Set language of the current client connection to LANGUAGE.
Language must be an RFC 1766 language code, as a string."
(interactive (list (read-string "Language: ")))
(speechd--set-parameter 'language language))
(defun speechd-set-ssml-mode (value)
"Set SSML mode value.
SSML is reset to \"off\" when connection is reopened."
(speechd--set-parameter 'ssml-mode value))
(defmacro speechd--generate-set-command (parameter prompt argdesc)
(let* ((prompt* (concat prompt ": "))
(argdesc* (eval argdesc))
(docstring
(format "Set %s of the current connection.
VALUE must be %s.
If called with a prefix argument, set it for all connections."
(downcase prompt)
(cond
((integerp argdesc*)
"a number between -100 and 100")
((not argdesc*)
"a string")
((listp argdesc*)
(concat "one of the symbols "
(mapconcat #'(lambda (x) (symbol-name (cdr x)))
argdesc* ", ")))
(t
(concat "one of the strings allowed by your "
"Speech Dispatcher\ninstallation"))))))
`(defun ,(intern (concat "speechd-set-" (symbol-name parameter)))
(value &optional all)
,docstring
(interactive
,(cond
((integerp argdesc*)
(concat "n" prompt* "\nP"))
((not argdesc*)
(concat "s" prompt* "\nP"))
((listp argdesc*)
`(list
(cdr (assoc (completing-read ,prompt* ,argdesc nil t) ,argdesc))
current-prefix-arg))
(t
`(list
(completing-read ,prompt*
(mapcar #'list
(speechd--list (quote ,argdesc*))))
current-prefix-arg))))
(when value
(speechd--set-parameter (quote ,parameter) value all)
(message "%s set to %s." ,prompt value)))))
(speechd--generate-set-command capital-character-mode "Capital character mode"
speechd--capital-character-modes)
(speechd--generate-set-command pitch "Pitch" 0)
(speechd--generate-set-command volume "Volume" 0)
(speechd--generate-set-command rate "Rate" 0)
(speechd--generate-set-command voice "Voice" 'voices)
(speechd--generate-set-command synthesizer-voice "Synthesizer voice" 'synthesis-voices)
(speechd--generate-set-command punctuation-mode "Punctuation mode"
speechd--punctuation-modes)
(speechd--generate-set-command pause-context "Pause context" 0)
;; TODO: Remove this one once proper output module setting is defined.
(speechd--generate-set-command output-module "Output module" nil)
(defun speechd-add-connection-settings (voice)
"Add current connection and its settings to `speechd-connection-voices'."
(interactive "SNew voice name: ")
(if (or (not (assoc voice speechd-voices))
(y-or-n-p "Voice already exists, replace it? "))
(setq ;; the voice
speechd-voices
(cons
(speechd--with-current-connection
(cons voice
(let ((voice-parameters ())
(connection-parameters
(speechd--connection-parameters speechd--current-connection)))
(while connection-parameters
(cl-destructuring-bind (p v . next) connection-parameters
(unless (memq p '(client-name message-priority
spelling-mode))
(push
(cons
(cl-case p
(voice 'name)
(t p))
v)
voice-parameters))
(setq connection-parameters next)))
(nreverse voice-parameters))))
(remove (assoc speechd-client-name speechd-voices)
speechd-voices))
;; the connection
speechd-connection-voices
(cons (cons speechd-client-name voice)
(remove
(assoc speechd-client-name speechd-connection-voices)
speechd-connection-voices)))
(message "Settings NOT added")))