�
�D�g�� � �� � S r SSKrSSKrSSKrSSKrSSKr SSKrSSKJ r " S S\
5 r " S S\ 5 r
" S S
\
5 r " S S \ 5 r " S
S\5 r " S S\5 r " S S\ 5 r " S S\
5 r " S S\
5 r " S S\
5 r " S S\
5 r " S S \
5 r " S S \
5 r " S S \
5 r " S! S"\
5 r " S# S$\5 r " S% S&\5 r " S' S(\
5 r g! SSKr N�= f))z�Python API to Speech Dispatcher
Basic Python client API to Speech Dispatcher is provided by the 'SSIPClient'
class. This interface maps directly to available SSIP commands and logic.
A more convenient interface is provided by the 'Speaker' class.
� N� )�pathsc �: � \ rS rSrSrSr Sr Sr Sr Sr Sr
S r g
) � CallbackType�$ z5Constants describing the available types of callbacks� index_marks�begin�end�cancel�pause�resume� N) �__name__�
__module__� __qualname__�__firstlineno__�__doc__�
INDEX_MARK�BEGIN�END�CANCEL�PAUSE�RESUME�__static_attributes__r � �0/usr/lib/python3/dist-packages/speechd/client.pyr r $ sE � �?� �J��
�E�&�
�C�;�
�F��
�E�4�
�F�)r r c � � \ rS rSrSrSrg)� SSIPError�; z;Common base class for exceptions during SSIP communication.r N�r r r r r r r r r r r ; s � �Er r c �R ^ � \ rS rSrSrSrS U 4S jjrS rS rS r S r
S r S
r U =r
$ ) �SSIPCommunicationError�> z?Exception raised when trying to operate on a closed connection.Nc �F >� X l Xl [ [ U ] " S0 UD6 g )Nr )�_original_exception� _description�superr �__init__)�self� description�original_exception�kwargs� __class__s �r r( � SSIPCommunicationError.__init__C s! �� �#5� � '��
�i��'�1�&�1r c � � U R $ )z�Return the original exception if any
If this exception is secondary, being caused by a lower
level exception, return this original exception, otherwise
None)r% �r) s r r+ �)SSIPCommunicationError.original_exceptionH s � � �'�'�'r c � � Xl g)z@Set an additional exception
See method additional_exception().
N��_additional_exception)r) � exceptions r �set_additional_exception�/SSIPCommunicationError.set_additional_exceptionP s
� �
&/�"r c � � U R $ )zoReturn an additional exception
Additional exceptions araise from failed attempts to resolve
the former problemr3 r0 s r �additional_exception�+SSIPCommunicationError.additional_exceptionW s � �
�)�)�)r c � � U R $ )zReturn error description)r& r0 s r r* �"SSIPCommunicationError.description^ s � �� � � r c � � / nU R 5 ( a UR U R 5 5 U R ( a+ UR S[ U R 5 5 - 5 U R ( a+ UR S[ U R 5 5 - 5 SR U5 $ )NzOriginal error: zAdditional error: �
)r* �appendr+ �strr9 �join)r) �msgss r �__str__� SSIPCommunicationError.__str__b s� � ��� � � � � � �K�K��(�(�*� +� � "� "� �K�K�*�S��1H�1H�1J�-K�K� L� � $� $� �K�K�,�s�4�3L�3L�3N�/O�O� P��y�y��� r )r4 r& r% �NN)r r r r r r4 r( r+ r6 r9 r* rC r �
__classcell__�r- s @r r" r" > s/ �� �I� ��2�
(�/�*�!� � r r" c �& � \ rS rSrS rS rS rSrg)�SSIPResponseError�l c �` � [ R X< SU< 35 Xl X l X0l g )Nz: )� Exceptionr( �_code�_msg�_data�r) �code�msg�datas r r( �SSIPResponseError.__init__m s& � ����4�T�3�!7�8��
�� ��
r c � � U R $ )z8Return the server response error code as integer number.)rM r0 s r rQ �SSIPResponseError.codes � � ��z�z�r c � � U R $ )z/Return server response error message as string.)rN r0 s r rR �SSIPResponseError.msgw s � ��y�y�r )rM rO rN N)r r r r r( rQ rR r r r r rI rI l s � �� �r rI c � � \ rS rSrSrS rSrg)�SSIPCommandError�| z9Exception raised on error response after sending command.c � � U R $ )z7Return the command string which resulted in this error.�rO r0 s r �command�SSIPCommandError.command rW r r N)r r r r r r_ r r r r r[ r[ | s
� �C�r r[ c � � \ rS rSrSrS rSrg)�
SSIPDataError� z6Exception raised on error response after sending data.c � � U R $ )z-Return the data which resulted in this error.r^ r0 s r rS �SSIPDataError.data� rW r r N)r r r r r rS r r r r rb rb � s
� �@�r rb c � � \ rS rSrSrSrg)�
SpawnError� z&Indicates failure in server autospawn.r Nr r r r rg rg � s � �0r rg c �" � \ rS rSrSrSr SrSrg)�CommunicationMethod� zBConstants describing the possible methods of connection to server.� unix_socket� inet_socketr N�r r r r r � UNIX_SOCKET� INET_SOCKETr r r r rj rj � s � �L� �K�;� �K�9r rj c � � \ rS rSrSrSrSrSr\\- \- r\\- \- r \\- r
\\- r \ R \ R \ R \ R \ R" \ R$ S.rS rS rS rS
rS rS rS
rS rS r Sr g)�_SSIP_Connection� z/Implementation of low level SSIP communication.s
� .s ..)i� i� i� i� i� i� c � � U[ R :X a [ R nUnOXU[ R :X a9 U( a U( d e[ R
n[ R " U5 U4nO [ S5 e [ R " U[ R 5 U l U R R U5 SU l
/ U l SU l [ R" " S5 U l [ R& " U R( 0 SSS 9U l U R* R- 5 g! [ R a n[ SU- US9eSnAff = f)
zhInit connection: open the socket to server,
initialize buffers, launch a communication handling
thread.
z Unsupported communication methodz Can't open socket using method )r+ Nr r z SSIP client communication threadT)�targetr, �name�daemon)rj ro �socket�AF_UNIXrp �AF_INET�
gethostbyname�
ValueError� SOCK_STREAM�_socket�connect�errorr" �_buffer� _com_buffer� _callback� threading� Semaphore�_ssip_reply_semaphore�Thread�_communication�_communication_thread�start)r) �communication_method� socket_path�host�port�
socket_family�socket_connect_args�exs r r( �_SSIP_Connection.__init__� s2 � � �#6�#B�#B� B� "�N�N�M�"-� �
!�%8�%D�%D�
D��D� �=� "�N�N�M�#)�#7�#7��#=�t�"D� � � ?�@� @� B�!�=�=� ��8J�8J�K�D�L� �L�L� � �!4� 5� �� � ��� ���%.�%8�%8��%;��"�� � ��(;�(;�B�&H�(,�.�
�"�
�"�"�(�(�*�� �|�|� B�(�)J�+?�*@�>@�B�
B�� B�s �AD7 �7E �
E�E c �� � U R R [ R 5 U R R 5 U R R 5 g! [ R a NKf = f)z>Close the server connection, destroy the communication thread.N)r �shutdownry � SHUT_RDWRr� �closer� rA r0 s r r� �_SSIP_Connection.close� s[ � � � �L�L� !� !�&�"2�"2� 3�
� � ��� � �"�"�'�'�)�� �|�|� � � �s �)A � A7�6A7c � � U R 5 u pnUS- S:w a9 U R R XU45 U R R 5 MW U R bV U R U nU[ R :X a SUS 0nO0 n[ [ USS 5 u pgU R " XgU40 UD6 M� ! [ a gf = f)a� Handle incoming socket communication.
Listens for all incoming communication on the socket, dispatches
events and puts all other replies into self._com_buffer list in the
already parsed form as (code, msg, data). Each time a new item is
appended to the _com_buffer list, the corresponding semaphore
'self._ssip_reply_semaphore' is incremented.
This method is designed to run in a separate thread. The thread can be
interrupted by closing the socket on which it is listening for
reading.N�d � �
index_mark� ) �
_recv_message�IOErrorr� r? r� �releaser� �_CALLBACK_TYPE_MAPr r �map�int)r) rQ rR rS �typer, �msg_id� client_ids r r� � _SSIP_Connection._communication� s� � � �
�"&�"4�"4�"6���4� �S�y�A�~�� � �'�'��D�(9�:��*�*�2�2�4���~�~�)��.�.�t�4���<�2�2�2� *�D��G� 4�F� �F�$'��T�"�1�X�$6�!�����v�$�A�&�A�) �� �
��
�s �B= �=
C
� C
c �� � U R R U R 5 nUS:X as U R R S5 n[
U5 S:X a [
eU =R U-
sl U R R U R 5 nUS:X a Ms U R SU nU R U[
U R 5 - S U l UR S5 $ ! [
e= f)z]Read one whole line from the socket.
Blocks until the line delimiter ('_NEWLINE') is read.
���i r N�utf-8)r� �find�_NEWLINEr �recvr� �len�decode)r) �pointer�d�lines r � _readline�_SSIP_Connection._readline� s� � � �,�,�#�#�D�M�M�2����m�
��L�L�%�%�d�+�� �1�v��{� �
� �L�L�A� �L��l�l�'�'��
�
�6�G� ��m� �|�|�H�W�%���|�|�G�C��
�
�,>�$>�$?�@�� ��{�{�7�#�#��
� �
�s �C) �)C1c �0 � / nSn U R 5 n[ U5 S:� d S5 eUSS US USS penUR 5 ( a Ub XB:X a US; d S5 eUS:X a Un[ U5 U[ U5 4$ UnUR U5 M� )zLRead server response or a callback
and return the triplet (code, msg, data).N� z$Malformed data received from server!� )�-� r� )r� r� �isalnumr� �tupler? )r) rS �cr� rQ �sep�textrR s r r� � _SSIP_Connection._recv_message s� � � �� ����>�>�#�D��t�9��>� I�#I� I�>� "�2�A�h��Q���a�b��t�D��<�<�>�>�q�y�D�I��*�$�
M�&L�
M� %��c�z����4�y�#�u�T�{�2�2��A� �K�K�� � r c � � U R R 5 ( d [ eU R R 5 U R
S nU R
S U$ )z\Read server response from the communication thread
and return the triplet (code, msg, data).r )r� �is_aliver" r� �acquirer� )r) �responses r �_recv_response� _SSIP_Connection._recv_response! sT � �
�)�)�2�2�4�4�(� (� �"�"�*�*�,��#�#�A�&�� � � �Q� ��r c � � US; aA US [ R [ R 4; d [ US [ 5 ( d eSR U4[
[ [ U5 5 - 5 n U R R UR S5 U R - 5 U R! 5 u pEnUS- S:w a [# XEU5 eXEU4$ ! [ R a [ S5 ef = f)ab Send SSIP command with given arguments and read server response.
Arguments can be of any data type -- they are all stringified before
being sent to the server.
Returns a triplet (code, msg, data), where 'code' is a numeric SSIP
response code as an integer, 'msg' is an SSIP rsponse message as string
and 'data' is a tuple of strings (all lines of response data) when a
response contains some data.
'SSIPCommandError' is raised in case of non 2xx return code. See SSIP
documentation for more information about server responses and codes.
'IOError' is raised when the socket was closed by the remote side.
)�SETr �STOPr r� r� �"Speech Dispatcher connection lost.r� r� )�Scope�SELF�ALL�
isinstancer� rA r� r� r@ r �send�encoder� ry r� r" r� r[ )r) r_ �args�cmdrQ rR rS s r � send_command� _SSIP_Connection.send_command. s� � �" ��4�4��A�w�5�:�:�u�y�y�"9�9�$�T�!�W�c�2�2�3� 3��h�h��z�E�#�c�4�.�$9�9�:�� O� �L�L� � �c�j�j�� 1�D�M�M� A� B� �-�-�/���4� ��9��>�"�4�c�2� 2��$�� �� �|�|� O�(�)M�N� N� O�s �67C � C9c �� � UR S5 nUR U R 5 ( a& [ U R 5 nU R XS - nUR U R U R 5 n U R R XR - 5 U R 5 u p4nUS- S:w a [ X4U5 eX4U4$ ! [ R a [ S5 ef = f)a8 Send multiline data and read server response.
Returned value is the same as for 'send_command()' method.
'SSIPDataError' is raised in case of non 2xx return code. See SSIP
documentation for more information about server responses and codes.
'IOError' is raised when the socket was closed by the remote side.
r� Nr� r� r� )r� �
startswith�_END_OF_DATA_MARKERr� �_END_OF_DATA_MARKER_ESCAPED�replace� _RAW_DOTLINE�_ESCAPED_DOTLINEr r� � _END_OF_DATAry r� r" r� rb )r) rS �lrQ rR �
response_datas r � send_data�_SSIP_Connection.send_dataM s� � � �{�{�7�#�� �?�?�4�3�3� 4� 4��D�,�,�-�A��3�3�d�2�h�>�D� �|�|�D� -� -�t�/D�/D�E�� O� �L�L� � �d�%6�%6� 6� 7� $(�#6�#6�#8� ��=� ��9��>� ��4�0� 0��-�'�'�� �|�|� O�(�)M�N� N� O�s �?'C � C2c � � Xl g)a Register a callback function for handling asynchronous events.
Arguments:
callback -- a callable object (function) which will be called to
handle asynchronous events (arguments described below). Passing
`None' results in removing the callback function and ignoring
events. Just one callback may be registered. Attempts to register
a second callback will result in the former callback being
replaced.
The callback function must accept three positional arguments
('message_id', 'client_id', 'event_type') and an optional keyword
argument 'index_mark' (when INDEX_MARK events are turned on).
Note, that setting the callback function doesn't turn the events on.
The user is responsible to turn them on by sending the appropriate `SET
NOTIFICATION' command.
N)r� )r) �callbacks r � set_callback� _SSIP_Connection.set_callbackn s � �( "�r )r� r� r� r� r r� N) r r r r r r� r� r� r� �_END_OF_DATA_ESCAPEDr� r� r r r r r r r r� r( r� r� r� r� r� r� r� r� r r r r rr rr � s� � �9��H� ��"'� �� 1�1�H�<�L�#�&A�A�H�L��� 1�1�L� �"=�=�� +� 6� 6� +� 1� 1� +� /� /� +� 2� 2� +� 1� 1� +� 2� 2� �� +�D
*�!B�H$�( �" � �> (�B"r rr c �* � \ rS rSrSrS rS rS rSrg)�_CallbackHandleri� z(Internal object which handles callbacks.c �R � Xl 0 U l [ R " 5 U l g �N)�
_client_id�
_callbacksr� �Lock�_lock)r) r� s r r( �_CallbackHandler.__init__� s � �#�� ��� �^�^�%��
r c � � X R :w a g U R R 5 U R U u pVUb X6; a U" U40 UD6 U[ R
[ R 4; a
U R U U R R 5 g ! [ a N'f = f! U R R 5 f = fr� ) r� r� r� r� r r r �KeyErrorr� )r) r� r� r� r, r� � event_typess r �__call__�_CallbackHandler.__call__� s� � � ��� '� � �
�
��� � !�
0�(,����(?�%�� �&�$�*=� �T�,�V�,��L� ,� ,�l�.A�.A�B�B� ����/� �J�J� � � �� �
��
��
�J�J� � � �s) �B �AB+ �
B(�%B+ �'B(�(B+ �+ Cc �� � U R R 5 X#4U R U' U R R 5 g ! U R R 5 f = fr� )r� r� r� r� )r) r� r� r� s r � add_callback� _CallbackHandler.add_callback� sI � � �
�
��� � !�'/�&=�D�O�O�F� #� �J�J� � � ��D�J�J� � � �s �A � A#)r� r� r� N) r r r r r r( r� r� r r r r r� r� � s � �2�&�
!�$!r r� c �" � \ rS rSrSrSr SrSrg)r� i� z�An enumeration of valid SSIP command scopes.
The constants of this class should be used to specify the 'scope' argument
for the 'Client' methods.
r) �allr N)r r r r r r� r� r r r r r� r� � s � �� �D�L�
�C�Kr r� c �, � \ rS rSrSrSrSrSrSrSr Sr
g )
�Priorityi� z�An enumeration of valid SSIP message priorities.
The constants of this class should be used to specify the 'priority'
argument for the 'Client' methods. For more information about message
priorities and their interaction, see the SSIP documentation.
� importantr� �message� notification�progressr N) r r r r r � IMPORTANT�TEXT�MESSAGE� NOTIFICATION�PROGRESSr r r r r� r� � s" � �� �I� �D��G�!�L��Hr r� c �. � \ rS rSrSrSr Sr Sr SrSr g) �PunctuationModei� zcConstants for selecting a punctuation mode.
The mode determines which characters should be read.
r� �none�some�mostr N)
r r r r r r� �NONE�SOME�MOSTr r r r r r � s+ � ��
�C�*� �D�6� �D�H� �D�r r c �" � \ rS rSrSrSr SrSrg)�DataModei� zOConstants specifying the type of data contained within messages
to be spoken.
r� �ssmlr N)r r r r r r� �SSMLr r r r r r � s � �� �D� � �D�:r r c �� � \ rS rSrSrSr Sr Sr S1S jrS r S r
S
r S r S r
S
rS rS2S jrS rS rS r\R* 4S jr\R* 4S jr\R* 4S jr\R* 4S jrS rS2S jr\R* 4S jr S r \R* 4S jr S r \R* 4S jr S r!\R* 4S jr"\R* 4S jr#S! r$\R* 4S" jr%S# r&\R* 4S$ jr'S% r(\R* 4S& jr)\R* 4S' jr*\R* 4S( jr+\R* 4S) jr,\R* 4S* jr-S+ r.S, r/S- r0S. r1S/ r2S0r3g)3�
SSIPClienti� a Basic Speech Dispatcher client interface.
This class provides a Python interface to Speech Dispatcher functionality
over an SSIP connection. The API maps directly to available SSIP commands.
Each connection to Speech Dispatcher is represented by one instance of this
class.
Many commands take the 'scope' argument, thus it is shortly documented
here. It is either one of 'Scope' constants or a number of connection. By
specifying the connection number, you are applying the command to a
particular connection. This feature is only meant to be used by Speech
Dispatcher control application, however. More datails can be found in
Speech Dispatcher documentation.
Here is a simple example:
from speechd import client
c = client.SSIPClient("mytest")
c.speak("hello, world!")
z 127.0.0.1i� z speech-dispatcher/speechd.sockNc
�� � [ R R S5 n
[ R R S[ R R S[ R R U
S5 5 5 n [ R R X�R 5 n [ R U U R U R S.n
U=( d [ R R S5 nU( a! U
R U R U5 5 O�[ R R S5 n [ [ R R S5 5 n[ R R S
5 nU( a X�S ' U( a X}S ' O U( a UU
S ' U ( a X�S
' O U( a UU
S
' U R X�5 U R X1U5 g ! S n N�= f)ac Initialize the instance and connect to the server.
Arguments:
name -- client identification string
component -- connection identification string. When one client opens
multiple connections, this can be used to identify each of them.
user -- user identification string (user name). When multi-user
access is expected, this can be used to identify their connections.
address -- server address as specified in Speech Dispatcher
documentation (e.g. "unix:/run/user/joe/speech-dispatcher/speechd.sock"
or "inet:192.168.0.85:6561")
autospawn -- a flag to specify whether the library should
try to start the server if it determines its not already
running or not
Deprecated arguments:
method -- communication method to use, one of the constants defined in class
CommunicationMethod
socket_path -- for CommunicationMethod.UNIX_SOCKET, socket
path in filesystem. By default, this is $XDG_RUNTIME_DIR/speech-dispatcher/speechd.sock
where $XDG_RUNTIME_DIR is determined using the XDG Base Directory
Specification.
host -- for CommunicationMethod.INET_SOCKET, server hostname
or IP address as a string. If None, the default value is
taken from SPEECHD_HOST environment variable (if it
exists) or from the DEFAULT_HOST attribute of this class.
port -- for CommunicationMethod.INET_SOCKET method, server
port as number or None. If None, the default value is
taken from SPEECHD_PORT environment variable (if it
exists) or from the DEFAULT_PORT attribute of this class.
For more information on client identification strings see Speech
Dispatcher documentation.
�~�XDG_RUNTIME_DIR�XDG_CACHE_HOMEz.cache)r� r� r� r� �SPEECHD_ADDRESS� SPEECHD_HOST� SPEECHD_PORTN�SPEECHD_SOCKET�methodr� r� )�os�path�
expanduser�environ�getrA �DEFAULT_SOCKET_PATHrj ro � DEFAULT_HOST� DEFAULT_PORT�update�"_connection_arguments_from_addressr� �_connect_with_autospawn�_initialize_connection)r) rw � component�user�address� autospawnr� r� r r� �_home� _runtime_dir�
_sock_path�connection_args�_address�env_speechd_host�env_speechd_port�env_speechd_socket_paths r r( �SSIPClient.__init__� sw � �N ���"�"�3�'���z�z�~�~�&7���� � �HX�Z\�Za�Za�Zf�Zf�gl�nv�Zw�9x�y� ��W�W�\�\�,�0H�0H�I�
�3F�3R�3R�*4�#'�#4�#4�#'�#4�#4� �� �?�b�j�j�n�n�->� ?�� � � "� "�4�#J�#J�8�#T� U�
"�z�z�~�~�n� =� �
(�#&�r�z�z�~�~�n�'E�#F� � ')�j�j�n�n�5E�&F� #� �,2��)��*.��'�!�*:���'��1<�
�.�(�1H��
�.� �$�$�_�@� �#�#�D� �:��#
(�#'� �s �>(G$ �$G*c �� � [ S0 UD6U l g! [ aY nUS:w aM U R U5 O%! [ a nUR U5 UeSnAff = f[ S0 UD6U l SnAge SnAff = f)z2Establish new connection (and/or autospawn server)FNr )rr �_connr" �
_server_spawnrg r6 )r) r- r) �ce�ses r r$ �"SSIPClient._connect_with_autospawnK sz � � �)�<�O�<�D�J��%� ��E�!� ��&�&��7��!� ��/�/��3� �H�� �� .� @�� @��
�
��� �s: � �
A6�A1�6�A1�
A� A�A�A1�0A1�1A6c �^ � U< SU< SU< 3nU R R S[ R SU5 U R R SSS5 u pVn[ US 5 U l [
U R
5 U l U R R U R 5 [ R [ R [ R [ R [ R [ R 4 H" nU R R SSS US
5 M$ g ) zIInitialize connection -- Set client name, get id, register callbacks etc.�:r� � CLIENT_NAME�HISTORY�GET� CLIENT_IDr r) r �onN)r4 r� r� r� r� r� r� �_callback_handlerr� r r r r r r r ) r) r' rw r& � full_namerQ rR rS �events r r% �!SSIPClient._initialize_connection] s� � �"&��i�8� � �
�
� � ��u�z�z�=�)�L� �*�*�1�1�)�U�K�P���4� �d�1�g�,���!1�$�/�/�!B�� � �
�
� � �� 6� 6�7�"�-�-�"�(�(�"�&�&�"�)�)�"�(�(�"�)�)� +�E�
�J�J� #� #�E�6�>�5�$� O�
+r c �| � 0 nUR S5 n US nXBS' U[ R :X a US US' U$ U[ R
:X a US US' [
US 5 US ' U$ [ S 5 e! [ S5 e= f! [ a U$ f = f! [ a [ S
5 e[ a U$ f = f) zVParse a Speech Dispatcher address line and return a dictionary
of connection argumentsr: r z Wrong format of server addressr� r r� r� r� r� z<Third parameter of inet_socket address must be a port numberz(Unknown communication method in address.)�splitr" rj ro �
IndexErrorrp r� r} )r) r( r- �address_params�_methods r r# �-SSIPClient._connection_arguments_from_addressm s � � �� � � �s�+�� K�$�Q�'�G� 3:�.�/� �)�5�5� 5�
�1?��1B��
�.� � � �+�7�7�
7�
�*8��*;���'�*-�n�Q�.?�*@���'� � � )�)S�T� T��# K�(�)I�J� J��
�
�� � �
�� �
m�,�-k�l�l� �
�� � �
�s. �A8 �B �B �8
B�
B�B� B;�:B;c �$ � U R 5 g)zClose the connectionN)r� r0 s r �__del__�SSIPClient.__del__� s � � �
�
� r c �r � US S:X a� [ R " US US 5 nU Vs/ s H
o3S S PM nnSnU H' nUR S5 ( d US :X d M! XaS' S
nM) U( d [ S US < S [ U5 < S
35 e[
R " S5 nU( d [ R n[
R R U5 ( a� / nUR 5 H0 u p�U S; d M
USU R SS5 - [ U
5 /-
nM2 [ R " US/U- S[ R [ R S9n U R! 5 u p�U R# 5 nUS:w a [ SU
< 35 eU R$ $ [ SU- 5 es snf )z/Attempts to spawn the speech-dispatcher server.r� rm r� r� r� r Fz127.z::1Tz@Can't start server automatically (autospawn), requested address z
resolves on zj which seems to be a remote host. You must start the server manually or choose another connection address.� SPEECHD_CMD)r� z--�_r� z--spawnN)�stdin�stdout�stderrz2Server refused to autospawn, stating this reason: z-Can't find Speech Dispatcher spawn command %s)ry � getaddrinfor� rg r@ r �getenvr �
SPD_SPAWN_CMDr �exists�itemsr� �
subprocess�Popen�PIPE� communicate�wait�pid)r) r- � addrinfos�addrinfo� ip_addresses� localhost�ipr� �connection_params�param�value�server� stdout_reply� stderr_reply�retcodes r r5 �SSIPClient._server_spawn� s� � � �1� 2�m� C� �*�*�?�6�+B�+:�6�+B�D�I� <E�E�9�x�Q�K��N�9�L�E��I�"���=�=��(�(�B�%�K�.0�F�+� "�I� #� � !� P_�_e�Of�OR�S_�O`�c�d� d�
�i�i�
�&����%�%�C�
�7�7�>�>�#� � � "� � /� 5� 5� 7� ��� �)�%�$�u�}�}�S��/E�*E�s�5�z�)R�R�%� !8� �%�%�s�I�&6�7H�&H�,0�� � �Q[�Q`�Q`�b�F�)/�);�);�)=� &�L� �k�k�m�G��!�|� �[g�!i�j�j��:�:� � � L�,/� 1� 2�
2��? Fs �F4c � � U[ R [ R [ R [ R [ R
4; d U5 eU R R S[ R SU5 g)zrSet the priority category for the following messages.
Arguments:
priority -- one of the 'Priority' constants.
r� �PRIORITYN)
r� r� r r� r r r4 r� r� r� )r) �prioritys r � set_priority�SSIPClient.set_priority� si � � �H� .� .��0@�0@� $�M�M�8�+@�+@� $� -� -� /� /� 9�08� 9� /�
�
�
� � ��u�z�z�:�x�Hr c �� � U[ R :X a SnO%U[ R :X a SnO[ SU- 5 eU R R S[ R SU5 g)zzSet the data mode for further speech commands.
Arguments:
value - one of the constants defined by the DataMode class.
r? �offz?Value "%s" is not one of the constants from the DataMode class.r� � SSML_MODEN)r r r� r} r4 r� r� r� )r) re �ssip_vals r �
set_data_mode�SSIPClient.set_data_mode� s\ � � �H�M�M� !��H�
�h�m�m�
#� �H� �Q����
�
�
�
� � ��u�z�z�;��Ir c �� � U R R S5 U R R U5 nU( a- [ US S 5 nU R R XRU5 U$ )a
Say given message.
Arguments:
text -- message text to be spoken. This may be either a UTF-8
encoded byte string or a Python unicode string.
callback -- a callback handler for asynchronous event notifications.
A callable object (function) which accepts one positional argument
`type' and one keyword argument `index_mark'. See below for more
details.
event_types -- a tuple of event types for which the callback should
be called. Each item must be one of `CallbackType' constants.
None (the default value) means to handle all event types. This
argument is irrelevant when `callback' is not used.
The callback function will be called whenever one of the events occurs.
The event type will be passed as argument. Its value is one of the
`CallbackType' constants. In case of an index mark event, additional
keyword argument `index_mark' will be passed and will contain the index
mark identifier as specified within the text.
The callback function should not perform anything complicated and is
not allowed to issue any further SSIP client commands. An attempt to
do so would lead to a deadlock in SSIP communication.
This method is non-blocking; it just sends the command, given
message is queued on the server and the method returns immediately.
�SPEAKr� r )r4 r� r� r� r@ r� )r) r� r� r� �resultr� s r �speak�SSIPClient.speak� s\ � �:
�
�
� � ��(����%�%�d�+�� �����1� �&�F�
� "� "� /� /��+� N��
r c �\ � U R R SUR SS5 5 g)a Say given character.
Arguments:
char -- a character to be spoken. Either a Python unicode string or
a UTF-8 encoded byte string.
This method is non-blocking; it just sends the command, given
message is queued on the server and the method returns immediately.
�CHARr� �spaceN)r4 r� r� )r) �chars r r~ �SSIPClient.char� s# � �
�
�
� � ��� � �S�'�(B�Cr c �< � U R R SU5 g)z�Say given key name.
Arguments:
key -- the key name (as defined in SSIP); string.
This method is non-blocking; it just sends the command, given
message is queued on the server and the method returns immediately.
�KEYN�r4 r� )r) �keys r r� �SSIPClient.key s � �
�
�
� � ��s�+r c �< � U R R SU5 g)z�Output given sound_icon.
Arguments:
sound_icon -- the name of the sound icon as defined by SSIP; string.
This method is non-blocking; it just sends the command, given message
is queued on the server and the method returns immediately.
�
SOUND_ICONNr� )r) �
sound_icons r r� �SSIPClient.sound_icon s � �
�
�
� � � �j�9r c �< � U R R SU5 g)z{Immediately stop speaking and discard messages in queues.
Arguments:
scope -- see the documentation of this class.
r Nr� �r) �scopes r r �SSIPClient.cancel! s � �
�
�
� � ��%�0r c �< � U R R SU5 g)zuImmediately stop speaking the currently spoken message.
Arguments:
scope -- see the documentation of this class.
r� Nr� r� s r �stop�SSIPClient.stop+ s � �
�
�
� � ���.r c �< � U R R SU5 g)a Pause speaking and postpone other messages until resume.
This method is non-blocking. However, speaking can continue for a
short while even after it's called (typically to the end of the
sentence).
Arguments:
scope -- see the documentation of this class.
r Nr� r� s r r �SSIPClient.pause4 s � �
�
�
� � ���/r c �< � U R R SU5 g)z�Resume speaking of the currently paused messages.
This method is non-blocking. However, speaking can continue for a
short while even after it's called (typically to the end of the
sentence).
Arguments:
scope -- see the documentation of this class.
r Nr� r� s r r
�SSIPClient.resumeA s � �
�
�
� � ��%�0r c �D � U R R SS5 u pnU$ )z@Return names of all active output modules as a tuple of strings.�LIST�OUTPUT_MODULESr� rP s r �list_output_modules� SSIPClient.list_output_modulesN s" � � �*�*�1�1�&�:J�K���4�� r c � � SS/nU( a) UR U5 U( a UR U5 U R R " U6 u pEnS n[ U Vs/ s H
o�" U5 PM sn5 $ ! [ a gf = fs snf )a{ Return names of all available voices for the current output module.
If language (possibly even variant) is set, only the list matching that
language (possibly even variant) is returned.
Returns a tuple of tripplets (name, language, variant).
'name' is a string, 'language' is an ISO 639-1 Alpha-2/3 language code
and 'variant' is a string. Language and variant may be None.
r� �SYNTHESIS_VOICESr c �j � [ U R SS5 5 u pnX=( d S U=( d S 4$ )N� r� )r� �rsplit)�itemrw �lang�variants r rE �/SSIPClient.list_synthesis_voices.<locals>.splith s/ � �"'�� � �D�!�(<�"=� �D���,�$���4�8� 8r )r? r4 r� r[ r� ) r) �languager� r_ rQ rR rS rE r� s r �list_synthesis_voices� SSIPClient.list_synthesis_voicesS s� � � � � 1�2�G�����x�(���N�N�7�+� "�j�j� 5� 5�w� ?�O�D�t� 9� �d�3�d�d�e�D�k�d�3�4�4�� � �� ��
4s �AA6 � B�6
B�Bc �n � [ U[ 5 ( d eU R R SUSU5 g)z�Switch to a particular language for further speech commands.
Arguments:
language -- two/three letter language code according to RFC 1766 as string, possibly with a region qualification.
scope -- see the documentation of this class.
r� �LANGUAGEN)r� r@ r4 r� )r) r� r� s r � set_language�SSIPClient.set_languagem s/ � � �(�C�(�(�(�(� �
�
� � ��u�j�(�Cr c �Z � U R R SS5 u pnU( a US $ g)zGet the current language.r= r� r Nr� rP s r � get_language�SSIPClient.get_languagex s+ � � �*�*�1�1�%��D���4� ���7�N�r c �@ � U R R SUSU5 g)z�Switch to a particular output module.
Arguments:
name -- module (string) as returned by 'list_output_modules()'.
scope -- see the documentation of this class.
r� �
OUTPUT_MODULENr� )r) rw r� s r �set_output_module� SSIPClient.set_output_module s � �
�
�
� � ��u�o�t�Dr c �Z � U R R SS5 u pnU( a US $ g)z Get the current output module.r= r� r Nr� rP s r �get_output_module� SSIPClient.get_output_module� s+ � � �*�*�1�1�%� �I���4� ���7�N�r c � � [ U[ 5 ( a SUs=:: a S:: d U5 e U5 eU R R SUSU5 g)aT Set the pitch for further speech commands.
Arguments:
value -- integer value within the range from -100 to 100, with 0
corresponding to the default pitch of the current speech synthesis
output module, lower values meaning lower pitch and higher values
meaning higher pitch.
scope -- see the documentation of this class.
���r� r� �PITCHN�r� r� r4 r� �r) re r� s r � set_pitch�SSIPClient.set_pitch� sN � � �%��%�%�$�%�*>�3�*>�E��E�>�*>�E��E�>� �
�
� � ��u�g�u�=r c �Z � U R R SS5 u pnU( a US $ g)zGet the current pitch.r= r� r Nr� rP s r � get_pitch�SSIPClient.get_pitch� s+ � � �*�*�1�1�%��A���4� ���7�N�r c � � [ U[ 5 ( a SUs=:: a S:: d U5 e U5 eU R R SUSU5 g)al Set the pitch range for further speech commands.
Arguments:
value -- integer value within the range from -100 to 100, with 0
corresponding to the default pitch range of the current speech synthesis
output module, lower values meaning lower pitch range and higher values
meaning higher pitch range.
scope -- see the documentation of this class.
r� r� r� � PITCH_RANGENr� r� s r �set_pitch_range�SSIPClient.set_pitch_range� sN � � �%��%�%�$�%�*>�3�*>�E��E�>�*>�E��E�>� �
�
� � ��u�m�U�Cr c � � [ U[ 5 ( a SUs=:: a S:: d e eU R R SUSU5 g)am Set the speech rate (speed) for further speech commands.
Arguments:
value -- integer value within the range from -100 to 100, with 0
corresponding to the default speech rate of the current speech
synthesis output module, lower values meaning slower speech and
higher values meaning faster speech.
scope -- see the documentation of this class.
r� r� r� �RATENr� r� s r �set_rate�SSIPClient.set_rate� sD � � �%��%�%�$�%�*>�3�*>�>�>�*>�>�>� �
�
� � ��u�f�e�<r c �Z � U R R SS5 u pnU( a US $ g)z$Get the current speech rate (speed).r= r� r Nr� rP s r �get_rate�SSIPClient.get_rate� s+ � � �*�*�1�1�%��@���4� ���7�N�r c � � [ U[ 5 ( a SUs=:: a S:: d e eU R R SUSU5 g)a? Set the speech volume for further speech commands.
Arguments:
value -- integer value within the range from -100 to 100, with 100
corresponding to the default speech volume of the current speech
synthesis output module, lower values meaning softer speech.
scope -- see the documentation of this class.
r� r� r� �VOLUMENr� r� s r �
set_volume�SSIPClient.set_volume� sD � � �%��%�%�$�%�*>�3�*>�>�>�*>�>�>� �
�
� � ��u�h��>r c �Z � U R R SS5 u pnU( a US $ g)zGet the speech volume.r= r� r Nr� rP s r �
get_volume�SSIPClient.get_volume� s+ � � �*�*�1�1�%��B���4� ���7�N�r c �� � U[ R [ R [ R [ R 4; d U5 eU R
R
SUSU5 g)z�Set the punctuation pronunciation level.
Arguments:
value -- one of the 'PunctuationMode' constants.
scope -- see the documentation of this class.
r� � PUNCTUATIONN)r r� r
r r r4 r� r� s r �set_punctuation�SSIPClient.set_punctuation� sa � � � �,�,�o�.B�.B�(�-�-��/C�/C�E� E� L�FK� L� E� �
�
� � ��u�m�U�Cr c �Z � U R R SS5 u pnU( a US $ g)z(Get the punctuation pronunciation level.r= r� r Nr� rP s r �get_punctuation�SSIPClient.get_punctuation� s+ � � �*�*�1�1�%� �G���4� ���7�N�r c � � US; d eUS:X a U R R SUSS5 gU R R SUSS5 g)z�Toggle the spelling mode or on off.
Arguments:
value -- if 'True', all incoming messages will be spelled
instead of being read as normal words. 'False' switches
this behavior off.
scope -- see the documentation of this class.
)TFTr� �SPELLINGr? rq Nr� r� s r � set_spelling�SSIPClient.set_spelling� sI � � �
�%�%�%� �D�=� �J�J� #� #�E�5�*�d� C� �J�J� #� #�E�5�*�e� Dr c �P � US; d eU R R SUSU5 g)an Set capital letter recognition mode.
Arguments:
value -- one of 'none', 'spell', 'icon'. None means no signalization
of capital letters, 'spell' means capital letters will be spelled
with a synthetic voice and 'icon' means that the capital-letter icon
will be prepended before each capital letter.
scope -- see the documentation of this class.
)r �spell�iconr� �CAP_LET_RECOGNNr� r� s r �set_cap_let_recogn� SSIPClient.set_cap_let_recogn� s, � � �1�1�1�1� �
�
� � ��u�.>��Fr c � � [ U[ 5 ( a UR 5 S; d eU R R SUSU5 g)a� Set voice by a symbolic name.
Arguments:
value -- one of the SSIP symbolic voice names: 'MALE1' .. 'MALE3',
'FEMALE1' ... 'FEMALE3', 'CHILD_MALE', 'CHILD_FEMALE'
scope -- see the documentation of this class.
Symbolic voice names are mapped to real synthesizer voices in the
configuration of the output module. Use the method
'set_synthesis_voice()' if you want to work with real voices.
)�male1�male2�male3�female1�female2�female3�
child_male� child_femaler� �
VOICE_TYPEN)r� r@ �lowerr4 r� r� s r � set_voice�SSIPClient.set_voice
sH � � �%��%�%��{�{�}� !1� 1� 1� 1�
�
�
� � ��u�l�E�Br c �@ � U R R SUSU5 g)z�Set voice by its real name.
Arguments:
value -- voice name as returned by 'list_synthesis_voices()'
scope -- see the documentation of this class.
r� �SYNTHESIS_VOICENr� r� s r �set_synthesis_voice� SSIPClient.set_synthesis_voice s � �
�
�
� � ��u�.?��Gr c �n � [ U[ 5 ( d eU R R SUSU5 g)a Set the amount of context when resuming a paused message.
Arguments:
value -- a positive or negative value meaning how many chunks of data
after or before the pause should be read when resume() is executed.
scope -- see the documentation of this class.
r� �
PAUSE_CONTEXTNr� r� s r �set_pause_context� SSIPClient.set_pause_context* s/ � � �%��%�%�%�%� �
�
� � ��u�o�u�Er c � � [ U[ 5 ( d eUS:X a SnOSnU R R S[ R
SU5 g)a� Switch debugging on and off. When switched on,
debugging files will be created in the chosen destination
(see set_debug_destination()) for Speech Dispatcher and all
its running modules. All logging information will then be
written into these files with maximal verbosity until switched
off. You should always first call set_debug_destination.
The intended use of this functionality is to switch debugging
on for a period of time while the user will repeat the behavior
and then send the logs to the appropriate bug-reporting place.
Arguments:
val -- a boolean value determining whether debugging
is switched on or off
scope -- see the documentation of this class.
T�ON�OFFr� �DEBUGN)r� �boolr4 r� r� r� )r) �valrs s r � set_debug�SSIPClient.set_debug6 sD � �$ �#�t�$�$�$�$� �$�;��H� �H� �
�
� � ��u�y�y�'�8�Dr c � � [ U[ 5 ( d eU R R S[ R
SU5 g)z�Set debug destination.
Arguments:
path -- path (string) to the directory where debugging
files will be created
scope -- see the documentation of this class.
r� �DEBUG_DESTINATIONN)r� r@ r4 r� r� r� )r) r s r �set_debug_destination� SSIPClient.set_debug_destinationQ s4 � � �$��$�$�$�$� �
�
� � ��u�y�y�2E�t�Lr c �< � U R R SS5 g)zMBegin an SSIP block.
See SSIP documentation for more details about blocks.
�BLOCKr Nr� r0 s r � block_begin�SSIPClient.block_begin^ s � �
�
�
� � ���1r c �< � U R R SS5 g)zMClose an SSIP block.
See SSIP documentation for more details about blocks.
r r Nr� r0 s r � block_end�SSIPClient.block_endf s � �
�
�
� � ���/r c �` � [ U S5 ( a U R R 5 U ?gg)z*Close the connection to Speech Dispatcher.r4 N)�hasattrr4 r� r0 s r r� �SSIPClient.closen s) � � �4�� !� !� �J�J� � � ��
� "r )r@ r� r4 )�default�unknownNNNNNNrE )4r r r r r r r! r r( r$ r% r# rK r5 rn rt ry r~ r� r� r� r� r r� r r
r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r r r� r r r r r r � s� � ��* �L�.��L�5�:��7�JN� �@D�M;�^�$P� �6�*2�X
I�J�"%�N D�
,�
:� !�:�:� 1� ��� /� �*�*� 0� !�:�:� 1��
5�4 ,1�:�:� D�� -2�J�J� E�� &+�Z�Z� >� � ,1�:�:� D� %*�J�J� =� � ',�j�j� ?�� ,1�:�:�
D�� ).�
�
� E� /4�j�j� G� &+�Z�Z� C�& 05�z�z� H� .3�Z�Z�
F�E�6 M�2�0�r r c �� ^ � \ rS rSrSrS U 4S jjr\R 4S jr\R 4U 4S jjr
\R 4U 4S jjr \R 4U 4S jjr Sr
U =r$ )
�Clientiu a A DEPRECATED backwards-compatible API.
This Class is provided only for backwards compatibility with the previous
unofficial API. It will be removed in future versions. Please use either
'SSIPClient' or 'Speaker' interface instead. As deprecated, the API is no
longer documented.
c �X >� U=( d U=( d Sn[ [ U ]
" U40 UD6 g )N�python)r' r r( )r) rw �clientr, r- s �r r( �Client.__init__~ s& �� ��)�v�)���
�f�d�$�T�4�V�4r c �H � U R U5 U R U5 g r� )rn ry )r) r� rm s r �say�
Client.say� s � � ���(�#� �
�
�4�r c �N >� U R U5 [ [ U ] U5 g r� )rn r' r r~ )r) r~ rm r- s �r r~ � Client.char� s �� � ���(�#�
�f�d� ��&r c �N >� U R U5 [ [ U ] U5 g r� )rn r' r r� )r) r� rm r- s �r r� �
Client.key� s �� � ���(�#�
�f�d� ��$r c �N >� U R U5 [ [ U ] U5 g r� )rn r' r r� )r) r� rm r- s �r r� �Client.sound_icon� s �� � ���(�#�
�f�d�&�z�2r r rE )r r r r r r( r� r r r� r~ r� r� r rF rG s @r r r u sL �� ��5� "*�!1�!1� � #+�-�-� '� !)�
�
� %� /7�m�m� 3� 3r r c � � \ rS rSrSrSrg)�Speakeri� a� Extended Speech Dispatcher Interface.
This class provides an extended intercace to Speech Dispatcher
functionality and tries to hide most of the lower level details of SSIP
(such as a more sophisticated handling of blocks and priorities and
advanced event notifications) under a more convenient API.
Please note that the API is not yet stabilized and thus is subject to
change! Please contact the authors if you plan using it and/or if you have
any suggestions.
Well, in fact this class is currently not implemented at all. It is just a
draft. The intention is to hide the SSIP details and provide a generic
interface practical for screen readers.
r Nr r r r r r � s � �r r c �" � \ rS rSrSrSr SrSrg)�ConnectionMethodi� z�Constants describing the possible methods of connection to server.
Retained for backwards compatibility but DEPRECATED. See CommunicationMethod.rl rm r Nrn r r r r r � s � �U� �K�;� �K�9r r ) r ry r rX �time�tempfiler� �dummy_threading� r �objectr rL r r" rI r[ rb rg rj rr r� r� r� r r r r r r r r r �<module>r% s �� � .� -� -�(�� �)�6� )�.F� � F�, �Y� , �\
� �
� �(� ��%� �1�� 1�:�&� :�l"�v� l"�\ !�v� !�B
L�F�
L� �v� � �f� �&;�v� ;�S
�� S
�l3�Z� 3�<�j� �,:�v� :��U$(�'�s �C) �)C1