Difference between revisions of "Speecher Assistive Kit"

From Free Pascal wiki
Jump to navigationJump to search
(wikify text)
Line 1: Line 1:
 +
==About==
 
'''sak''' is the Speecher Assistive Kit who transforms your applications into multi-language speaking assisted applications.
 
'''sak''' is the Speecher Assistive Kit who transforms your applications into multi-language speaking assisted applications.
 
----
 
 
 
 
Easy and independent, you do not have to change anything in your original code.
 
Easy and independent, you do not have to change anything in your original code.
 +
Compatible with Lazarus, fpGUI, MSEgui and console.
  
Compatible with lcl(Lazarus), fpGUI, MSEgui and console.
+
For Linux, FreeBSD, macOS and Windows.
 
 
For Linux, freeBSD, Mac and Windows.
 
 
 
You do not need external libraries like at-spi, sapi, nor install anything in your system...
 
 
 
All is included in the kit (+- 1 mega).
 
sak uses [http://espeak.sourceforge.net/ eSpeak] and [http://www.portaudio.com/ PortAudio] Open Source libraries.
 
Of course the kit can be shared with other applications.
 
  
 +
You do not need external libraries like at-spi, sapi, nor install anything in your system.
 +
All is included in the kit.
  
Download it from gitHub here :
+
sak uses [http://espeak.sourceforge.net/ eSpeak] and [http://www.portaudio.com/ PortAudio] open source libraries.
[https://github.com/fredvs/sak sak Speecher Assistive Kit]
 
  
 +
==Download==
 +
GitHub: https://github.com/fredvs/sak
  
 +
==License==
 
sak uses eSpeak who is GPL license.
 
sak uses eSpeak who is GPL license.
 
So the license differs if you use eSpeak executable or eSpeak library.
 
So the license differs if you use eSpeak executable or eSpeak library.
  
'''sak''' > for all types of licenses, included commercial applications without source.  It uses Speak executable and new Portaudio dynamic library.
+
* '''sak''': for all types of licenses, included commercial applications without source.  It uses Speak executable and new PortAudio dynamic library.
 
+
* '''sak_dll''': for applications with GPL Open Source licences.  It uses eSpeak dynamic library and new PortAudio dynamic library.
'''sak_dll''' > for applications with GPL Open Source licences.  It uses eSpeak dynamic library and new Portaudio dynamic library.
 
 
 
 
 
 
 
''How to use it ?''
 
  
 +
==Usage==
  
 
Copy the '''sakit/''' (or '''sakit_dll/''') folder into your application-folder (from sak/ or sak_dll/, depend of the license you give...).
 
Copy the '''sakit/''' (or '''sakit_dll/''') folder into your application-folder (from sak/ or sak_dll/, depend of the license you give...).
  
For '''sak''' > add '''sak.pas''' into your application-folder.
+
* For '''sak''', add '''sak.pas''' into your application-folder.
 +
* For '''sak_dll''', add '''sak_dll.pas''', '''uos_portaudio.pas''' and '''uos_espeak.pas''' into your application-folder.
  
For '''sak_dll''' > add '''sak_dll.pas''', '''uos_portaudio.pas''' and '''uos_espeak.pas''' into your application-folder.
+
In the "uses" section of your program add:
  
 +
* For '''sak''': "uses sak"
 +
* For '''sak_dll''': "uses sak_dll"
  
In '''uses''' section of your program add :
+
In your main program:
 +
When you want your application becomes ''assistived'' call:
  
For '''sak''' >
+
* '''SAKLoadLib();''' => This will seek in program-directory for /sakit/ (if not, in system for eSpeak).
'''uses
 
'''sak''',...
 
'''
 
 
 
For '''sak_dll''' >
 
'''uses
 
'''sak_dll''',...
 
'''
 
 
 
 
 
In your main program :
 
When you want your application becomes ''assistived'' call :
 
 
 
'''SAKLoadLib();''' => This will seek in program-directory for /sakit/ (if not, in system for eSpeak).
 
  
 
or
 
or
  
'''SAKLoadLib('/path/of/sakit/');''' => To load custom path of /sakit/ folder.
+
* '''SAKLoadLib('/path/of/sakit/');''' => To load custom path of /sakit/ folder.
  
  
 
To unload it :
 
To unload it :
  
  '''SAKUnLoadLib;'''
+
  SAKUnLoadLib;
  
  
 
You may change the default gender and language.
 
You may change the default gender and language.
  
gender : male or female
+
* gender: male or female
 +
* language: language code
  
language : language code
+
Here example for Portugues/Brasil woman:
 
 
Here example for Portugues/Brasil woman :
 
 
 
'''SAKSetVoice(female,'pt');'''
 
  
 +
SAKSetVoice(female,'pt');
  
 
In addition you may add your own speech with :
 
In addition you may add your own speech with :
  
  '''SAKSay(Text: string);'''
+
  SAKSay(Text: string);
 
 
  
 
When you close your application, call :
 
When you close your application, call :
  
  '''SAKUnLoadLib;'''
+
  SAKUnLoadLib;
 
 
 
 
----
 
  
 
[[Category:Accessibility]]
 
[[Category:Accessibility]]
 
[[Category:Speech synthesis]]
 
[[Category:Speech synthesis]]

Revision as of 19:37, 28 April 2022

About

sak is the Speecher Assistive Kit who transforms your applications into multi-language speaking assisted applications. Easy and independent, you do not have to change anything in your original code. Compatible with Lazarus, fpGUI, MSEgui and console.

For Linux, FreeBSD, macOS and Windows.

You do not need external libraries like at-spi, sapi, nor install anything in your system. All is included in the kit.

sak uses eSpeak and PortAudio open source libraries.

Download

GitHub: https://github.com/fredvs/sak

License

sak uses eSpeak who is GPL license. So the license differs if you use eSpeak executable or eSpeak library.

  • sak: for all types of licenses, included commercial applications without source. It uses Speak executable and new PortAudio dynamic library.
  • sak_dll: for applications with GPL Open Source licences. It uses eSpeak dynamic library and new PortAudio dynamic library.

Usage

Copy the sakit/ (or sakit_dll/) folder into your application-folder (from sak/ or sak_dll/, depend of the license you give...).

  • For sak, add sak.pas into your application-folder.
  • For sak_dll, add sak_dll.pas, uos_portaudio.pas and uos_espeak.pas into your application-folder.

In the "uses" section of your program add:

  • For sak: "uses sak"
  • For sak_dll: "uses sak_dll"

In your main program: When you want your application becomes assistived call:

  • SAKLoadLib(); => This will seek in program-directory for /sakit/ (if not, in system for eSpeak).

or

  • SAKLoadLib('/path/of/sakit/'); => To load custom path of /sakit/ folder.


To unload it :

SAKUnLoadLib;


You may change the default gender and language.

  • gender: male or female
  • language: language code

Here example for Portugues/Brasil woman:

SAKSetVoice(female,'pt');

In addition you may add your own speech with :

SAKSay(Text: string);

When you close your application, call :

SAKUnLoadLib;