home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: Multimed / Multimed.zip / fest-141.zip / festival / README.EST < prev    next >
Text File  |  1999-11-19  |  9KB  |  244 lines
  1.         EDINBURGH SPEECH TOOLS LIBRARY
  2.                  VERSION 1.2.1 November 1999
  3.  
  4. Principal authors: Paul Taylor, Alan W Black, Richard Caley and Simon King
  5.  
  6. Centre for Speech Technology
  7. University of Edinburgh 
  8. 80 South Bridge
  9. Edinburgh EH1 1HN, UK
  10. http://www.cstr.ed.ac.uk/projects/speech_tools.html
  11.  
  12. Although this is a considered stable release, there are still a number
  13. of known parts are missing or incomplete.
  14.  
  15. ------------------------------------------------------------------------
  16.  
  17. The Edinburgh speech tools system is a library of C++ classes, functions
  18. and utility programs that are frequently used in speech software. The
  19. system compiles to a single unix library .a file which can be linked
  20. with software. At present, C++ classes for several useful speech and
  21. language classes have been written, along with audio software and some
  22. basic signal processing software.
  23.  
  24. ========================================================================
  25.  
  26.  
  27.             Edinburgh Speech Tools Library version 1.2.1
  28.               Centre for Speech Technology Research                
  29.                    University of Edinburgh, UK                     
  30.                     Copyright (c) 1994-1999
  31.                       All Rights Reserved.                         
  32.                                                                    
  33. Permission is hereby granted, free of charge, to use and distribute  
  34. this software and its documentation without restriction, including   
  35. without limitation the rights to use, copy, modify, merge, publish,  
  36. distribute, sublicense, and/or sell copies of this work, and to      
  37. permit persons to whom this work is furnished to do so, subject to   
  38. the following conditions:                                            
  39.  1. The code must retain the above copyright notice, this list of    
  40.     conditions and the following disclaimer.                         
  41.  2. Any modifications must be clearly marked as such.                
  42.  3. Original authors' names are not deleted.                         
  43.  4. The authors' names are not used to endorse or promote products   
  44.     derived from this software without specific prior written        
  45.     permission.                                                      
  46.                                                                      
  47. THE UNIVERSITY OF EDINBURGH AND THE CONTRIBUTORS TO THIS WORK        
  48. DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING      
  49. ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT   
  50. SHALL THE UNIVERSITY OF EDINBURGH NOR THE CONTRIBUTORS BE LIABLE     
  51. FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES    
  52. WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN   
  53. AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,          
  54. ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF       
  55. THIS SOFTWARE.                                                       
  56.  
  57. ========================================================================
  58.  
  59. The following c++ programs are available:
  60.  
  61.     na_play: generic playback program for use with net_audio and CSTR ao.
  62.  
  63.     ch_wave: Waveform file conversion program.
  64.  
  65.     ch_lab: label file conversion program.
  66.  
  67.     ch_track: Track file conversion program.
  68.  
  69.         wagon: a CART tree build and test program
  70.  
  71.         And others
  72.  
  73. The following C++ sub-libraries are available
  74.  
  75.     audio:    C++ audio functions for Network Audio system, Suns
  76.                 Linux and FreeBSD
  77.  
  78.     speech_class:    C++ speech classes, including waveform and track.
  79.  
  80.     ling_class:    C++ linguistic classes.
  81.     
  82.     sigpr:    Signal processing
  83.  
  84.     utils: Various utilities.    
  85.  
  86.  
  87. COPYING
  88. ------------------------------------------------------------------------
  89.  
  90. Some files in the distribution do not fall under the above copyright.
  91. However none have any commercial restrictions, and no files fall under
  92. the GPL.  Specifically files that have different licences are as
  93. follows:
  94.  
  95. siod/ 
  96. include/siod*.h
  97. lib/siod/siod.scm
  98.         Apart from some new functionality under our licence the SIOD
  99.         files fall under the licence given in siod/slib.cc copyright
  100.         Paradigm Associates.  This code has been substantially modified
  101.         by us though our changes are under that licence.
  102.  
  103.         editline.c editline.h el_complete.c el_sysunix.c el_unix.h
  104.         are copyright 1992 Simmule Turner and Rich Salz under the
  105.         "BSD like" licence in siod/editline.c  Again substantial 
  106.         changes have been made by us which continue to be under that
  107.         licence
  108.  
  109. rxp/    
  110. include/rxp/
  111.         Is Copyright Richard Tobin.  We have a specific version of RXP
  112.         which allows free (including non-commercial) use.
  113.  
  114. base_class/raveconv.cc
  115.         Is copyright 1992, 1995 by Markus Mummert
  116.  
  117. base_class/string/reg*.{c,cc}
  118.         Copyright (c) 1986 by University of Toronto.
  119.  
  120. base_class/string/EST_strcasecmp.c
  121.    Copyright (c) 1987, 1993
  122.      The Regents of the University of California.  All rights reserved.
  123.  
  124.    The standard BSD licence
  125.  
  126.  
  127. ACKNOWLEDGEMENTS
  128. ------------------------------------------------------------------------
  129.  
  130. Most of the software was written by Paul Taylor, Alan W Black, Simon King
  131. and Richard Caley additional contributions have been made by the
  132. following people.  Slightly different licence agreements accompany
  133. these pieces of code, so it is important that the various agreements
  134. be properly understood.
  135.  
  136. Tony Robinson: some signal processing code.
  137. Markus Mummert: sample rate converter (rateconv.cc).
  138. Craig Reese and Joe Campbell: ulaw conversion code.
  139. Paul Bagshaw: pitch tracker.
  140. Theo Veenker: IRIX audio support.
  141. Stan Chen: AIX support
  142. Paradigm Assoc. and George Carrett: For Scheme In One Defun
  143. Simmule Turner and Rich Salz: for editline
  144. Henry Spencer: for regex code
  145. The Regents of the University of California: some string comparison code
  146. Richard Tobin: RXP, XML parser.
  147.  
  148. INSTALLATION
  149. ************
  150.  
  151. see INSTALL file for details
  152.  
  153. FILE/DIRECTORY STRUCTURE
  154. ------------------------------------------------------------------------
  155.  
  156. The main directory contains minimal wrap-around main() functions
  157. which compile to form executables which use the algorithms in the
  158. speech tools. All these main() functions really do is to read
  159. command line options and read and write files, the algorithms
  160. themselves are completely contained within the libraries.
  161.  
  162. The directory structure is as follows:
  163.  
  164. config: 
  165.         shared make rules and configuration make rules
  166.  
  167. speech_class:
  168.     general speech class files, including waveforms, contours etc.
  169.  
  170. ling_class:
  171.     general linguistic class files, including a stream-based architecture.
  172.  
  173. sigpr:
  174.     signal processing code.
  175.  
  176. doc:
  177.     basic documentation, generates html, info and postscript
  178.  
  179. include:
  180.     class and general header files.
  181.  
  182. lib:    
  183.     where the .a files are kept
  184.  
  185. main:
  186.     Directory containing main files which compile to executables.
  187.  
  188.  
  189. DOCUMENTATION
  190. ------------------------------------------------------------------------
  191.  
  192. There are two sources of documentation.
  193.  
  194. Man pages exist for the more important stand-alone programs. These are
  195. found in the main directory.
  196.  
  197. The library documentation has substantiall improved in this version
  198. using an integrated DOC++, JADE and docbook combination. Classes are
  199. described at the overview, theorectical, practical and code level.
  200. The build process for the documentation is still dependent on some
  201. more obscure packages so it is recommended that you take the
  202. pre-built documentation.  Or access it on-line through
  203.    http://www.cstr.ed.ac.uk/projects/speech_tools.html
  204.  
  205. The library documentation is in texinfo format which can be converted
  206. into GNU info HTML and postscript, see Makefile in doc/
  207.  
  208. Note the documentation is not up to date.
  209.  
  210. BUGS/COMMENTS ETC
  211. ------------------------------------------------------------------------
  212.  
  213. Substantial parts of this release are considered mature and should be
  214. relatively free of bugs, however there are newer parts which have not
  215. been rigourously tested yet.  If you find any bugs, please send a bug
  216. report to speechtools@cstr.ed.ac.uk. Any useful comments will also be
  217. appreciated. See also the bugs file in the doc directory.
  218.  
  219. If you have some software that you think could be integrated into the
  220. speechtools system, please contact us at
  221. speechtools@cstr.ed.ac.uk. The whole point of writing and releasing
  222. code such as this is to prevent duplication of effort, and therefore
  223. we would appreciate greatly any code which will add to the usefulness
  224. of the system. Signal processing routines are particularly welcome.
  225.  
  226.  
  227. ======================================================================
  228. ADDITIONAL SOFTWARE
  229. ======================================================================
  230.  
  231. CSTR supplies a number of different speech technology systems
  232. including speech synthesis systems and (in the future) a recognition
  233. system.  To find out more information checkout http://www.cstr.ed.ac.uk/
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.