33. Variable list

This chapter contains a list of variables currently defined within Festival available for general use. This list is automatically generated from the documentation strings of the variables as they are defined within the system, so has some chance in being up-to-date.

Cross references to sections elsewhere int he manual are given where appropriate.

!

In interactive mode, this variable’s value is the return value of the previously evaluated expression.

*module-descriptions*

An association list recording the description objects for proclaimed modules.

*ostype*

Contains the name of the operating system type that Festival is running on, e.g. SunOS5, FreeBSD, linux etc. The value is taken from the Makefile variable OSTYPE at compile time.

*properties*

Array for holding symbol property lists.

after_analysis_hooks

List of functions to be applied after analysis and before synthesis.

after_synth_hooks

List of functions to be applied after all synthesis modules have been applied. This is primarily designed to allow waveform manipulation, particularly resampling and volume changes.

auto-text-mode-alist

Following Emacs’ auto-mode-alist thios provides a mechanism for auto selecting a TTS text mode based on the filename being analyzed. Its format is exactly the same as Emacs in that it consists of an alist of dotted pairs of regular expression and text mode name.

before_synth_hooks

List of functions to be run on synthesised utterances before synthesis starts.

default-voice-priority-list

List of voice names. The first of them available becomes the default voice.

default_access_strategy

How to access units from databases.

default_after_analysis_hooks

The default list of functions to be run on all synthesized utterances after analysis but before synthesis.

default_after_synth_hooks

The default list of functions to be run on all synthesized utterances after Wave_Synth. This will normally be nil but if for some reason you need to change the gain or rescale *all* waveforms you could set the function here, in your siteinit.scm.

default_before_synth_hooks

The default list of functions to be run on all synthesized utterances before synthesis starts.

diphone_module_hooks

A function or list of functions that will be applied to the utterance at the start of the diphone module. It can be used to map segment names to those that will be used by the diphone database itself. Typical use specifies _ and $ for consonant clusters and syllable boundaries, mapping to dark ll’s etc. Reduction and tap type phenomena should probabaly be done by post lexical rules though the distinction is not a clear one.

duffint_params

Default parameters for Default (duff) intonation target generation. This is an assoc list of parameters. Two parameters are supported start specifies the start F0 in Hertz for an utterance, and end specifies the end.

editline_histsize

The number of lines to be saved in the users history file when a Festival session ends. The histfile is ".festival_history" in the users home directory. Note this value is only checked when the command interpreter is started, hence this should be set in a user’s ".festivalrc" or system init file. Reseting it at the command interpreter will have no effect.

editline_no_echo

When running under Emacs as an inferior process, we don’t want to echo the content of the line, only the prompt.

english_homographs

A list of tokens that are dealt with by a homograph disambiguation tree in english_token_pos_cart_trees.

english_phr_break_params

Parameters for English phrase break statistical model.

eou_tree

End of utterance tree. A decision tree used to determine if the given token marks the end of an utterance. It may look one token ahead to do this. [see section Utterance chunking]

etc-path

A list of directories where binaries specific to Festival may be located. This variable is automatically set to LIBDIR/etc/OSTYPE/ and that path is added to the end of the UNIX PATH environment variable.

festival_version

A string containing the current version number of the system.

festival_version_number

A list of major, minor and subminor version numbers of the current system. e.g. (1 0 12).

FP_duration

In using Fixed_Prosody as used in Phones type utterances and hence SayPhones, this is the fix value in ms for phone durations.

FP_F0

In using Fixed_Prosody as used in Phones type utterances and hence SayPhones, this is the value in Hertz for the monotone F0.

guess_pos

An assoc-list of simple part of speech tag to list of words in that class. This basically only contains closed class words all other words may be assumed to be content words. This was built from information in the f2b database and is used by the ffeature gpos.

home-directory

Place looked at for .festivalrc etc.

hush_startup

If set to non-nil, the copyright banner is not displayed at start up.

int_tilt_params

Parameters for tilt intonation model.

kal_diphone_dir

The default directory for the kal diphone database.

lexdir

The directory where the lexicon(s) are, by default.

libdir

The pathname of the run-time libary directory. Note reseting is almost definitely not what you want to do. This value is automatically set at start up from the value specifed at compile-time or the value specifed with –libdir on the command line. A number of other variables depend on this value.

load-path

A list of directories containing .scm files. Used for various functions such as load_library and require. Follows the same use as EMACS. By default it is set up to the compile-time library directory but may be changed by the user at run time, by adding a user’s own library directory or even replacing all of the standard library. [see section Site initialization]

manual-browser

The Unix program name of your Netscape Navigator browser. [see section Getting some help]

manual-url

The default URL for the Festival Manual in html format. You may reset this to a file://.../... type URL on you’re local machine. [see section Getting some help]

mbrola_database

The name of the MBROLA database to usde during MBROLA Synthesis.

mbrola_progname

The program name for mbrola.

Param

A feature set for arbitrary parameters for modules.

pbreak_ngram_dir

The directory containing the ngram models for predicting phrase breaks. By default this is the standard library directory.

phr_break_params

Parameters for phrase break statistical model. This is typcal set by a voice selection function to the parameters for a particular model.

pos_map

A reverse assoc list of predicted pos tags to some other tag set. Note using this changes the pos tag loosing the actual predicted value. Rather than map here you may find it more appropriate to map tags sets locally in the modules that use them (e.g. phrasing and lexicons).

pos_model_dir

The directory contains the various models for the POS module. By default this is the same directory as lexdir. The directory should contain two models: a part of speech lexicon with reverse log probabilities and an ngram model for the same part of speech tag set.

pos_ngram_name

The name of a loaded ngram containing the a posteriori ngram model for predicting part of speech. The a priori model is held as a lexicon call poslex.

pos_p_start_tag

This variable’s value is the tag most likely to appear before the start of a sentence. It is used when looking for pos context before an utterance. Typically it should be some type of punctuation tag.

pos_pp_start_tag

This variable’s value is the tag most likely to appear before pos_p_start_tag and any position preceding that. It is typically some type of noun tag. This is used to provide pos context for early words in an utterance.

pos_supported

If set to non-nil use part of speech prediction, if nil just get pos information from the lexicon.

postlex_mrpa_r_cart_tree

For remove final R when not between vowels.

postlex_rules_hooks

A function or list of functions which encode post lexical rules. This will be voice specific, though some rules will be shared across languages.

postlex_vowel_reduce_cart_tree

CART tree for vowel reduction.

postlex_vowel_reduce_cart_tree_hand

A CART tree for vowel reduction. This is hand-written.

postlex_vowel_reduce_table

Mapping of vowels to their reduced form. This in an assoc list of phoneset name to an assoc list of full vowel to reduced form.

provided

List of file names (omitting .scm) that have been provided. This list is checked by the require function to find out if a file needs to be loaded. If that file is already in this list it is not loaded. Typically a file will have (provide ’MYNAME) at its end so that a call to (require ’MYNAME) will only load MYNAME.scm once.

server_access_list

If non-nil this is the exhaustive list of machines and domains from which clients may access the server. This is a list of REGEXs that client host must match. Remember to add the backslashes before the dots. [see section Server/client API]

server_deny_list

If non-nil this is a list of machines which are to be denied access to the server absolutely, irrespective of any other control features. The list is a list of REGEXs that are used to matched the client hostname. This list is checked first, then server_access_list, then passwd. [see section Server/client API]

server_log_file

If set to t server log information is printed to standard output of the server process. If set to nil no output is given. If set to anything else the value is used as the name of file to which server log information is appended. Note this value is checked at server start time, there is no way a client may change this. [see section Server/client API]

server_max_clients

In server mode, the maximum number of clients supported at any one time. When more that this number of clients attach simulaneous the last ones are denied access. Default value is 10. [see section Server/client API]

server_passwd

If non-nil clients must send this passwd to the server followed by a newline before they can get a connection. It would be normal to set this for the particular server task. [see section Server/client API]

server_port

In server mode the inet port number the server will wait for connects on. The default value is 1314. [see section Server/client API]

sgml_parse_progname

The name of the program to use to parse SGML files. Typically this is nsgml-1.0 from the sp SGML package. [see section XML/SGML requirements]

sonority_glides

List of glides (only good w/ radio_speech)

sonority_liq

List of liquids (only good w/ radio_speech)

sonority_nas

List of nasals (only good w/ radio_speech)

sonority_v_obst

List of voiced obstruents for use in sonority scaling (only good w/ radio_speech)

sonority_vless_obst

List of voiceless obstruents for use in sonority scaling (only good w/ radio_speech)

SynthTypes

List of synthesis types and functions used by the utt.synth function to call appropriate methods for wave synthesis.

system-voice-path

Additional directory not near the load path where voices can be found, this can be redefined in lib/sitevars.scm if desired.

system-voice-path-multisyn

Additional directory not near the load path where multisyn voices can be found, this can be redefined in lib/sitevars.scm if desired.

tilt_accent_list

List of events containing accents in tilt model.

tilt_boundary_list

List of events containing boundaries in tilt model.

tobi_support_yn_questions

If set a crude final rise will be added at utterance that are judged to be yesy/no questions. Namely ending in a ? and not starting with a wh-for word.

token.letter_pos

The part of speech tag (valid for your part of speech tagger) for individual letters. When the tokenizer decide to pronounce a token as a list of letters this tag is added to each letter in the list. Note this should be from the part of speech set used in your tagger which may not be the same one that appears in the actual lexical entry (if you map them afterwards). This specifically allows "a" to come out as ae rather than @.

token.prepunctuation

A string of characters which are to be treated as preceding punctuation when tokenizing text. Prepunctuation symbols will be removed from the text of the token and made available through the "prepunctuation" feature. [see section Tokenizing]

token.punctuation

A string of characters which are to be treated as punctuation when tokenizing text. Punctuation symbols will be removed from the text of the token and made available through the "punctuation" feature. [see section Tokenizing]

token.singlecharsymbols

Characters which have always to be split as tokens. This would be usual is standard text, but is useful in parsing some types of file. [see section Tokenizing]

token.unknown_word_name

When all else fails and a pronunciation for a word or character can’t be found this word will be said instead. If you make this "" them the unknown word will simple be omitted. This will only really be called when there is a bug in the lexicon and characters are missing from the lexicon. Note this word should be in the lexicon.

token.whitespace

A string of characters which are to be treated as whitespace when tokenizing text. Whitespace is treated as a separator and removed from the text of a token and made available through the "whitespace" feature. [see section Tokenizing]

token_most_common

A list of (English) words which were found to be most common in an text database and are used as discriminators in token analysis.

token_pos_cart_trees

This is a list of pairs or regex plus CART tree. Tokens that match the regex will have the CART tree aplied, setting the result as the token_pos feature on the token. The list is checked in order and only the first match will be applied.

tts_hooks

Function or list of functions to be called during text to speech. The function tts_file, chunks data into Utterances of type Token and applies this hook to the utterance. This typically contains the utt.synth function and utt.play. [see section TTS]

tts_text_modes

An a-list of text modes data for file type specific tts functions. See the manual for an example. [see section Text modes]

UttTypes

List of types and functions used by the utt.synth function to call appropriate methods.

var-docstrings

An assoc-list of variable names and their documentation strings.

voice-location-trace

Set t to print voice locations as they are found

voice-locations

Association list recording where voices were found.

voice-path

List of places to look for voices. If not set it is initialised from load-path by appending "voices/" to each directory with system-voice-path appended.

voice-path-multisyn

List of places to look for multisyn voices. If not set it is initialised from load-path by appending "voices-multisyn/" to each directory with system-voice-path-multisyn appended.

voice_default

A variable whose value is a function name that is called on start up to the default voice. [see section Site initialization]

Internal variable containing list of voice descriptions as

decribed by proclaim_voice.

xml_dtd_dir

The directory holding standard DTD form the xml parser.

xxml_elements

List of Scheme actions to perform on finding xxML tags.

xxml_hooks

Function or list of functions to be applied to an utterance when parsed with xxML, before tts_hooks.

xxml_token_hooks

Functions to apply to each token.

xxml_word_features

An assoc list of features to be added to the current word when in xxml parse mode.

This document was generated by Alan W Black on December 2, 2014 using texi2html 1.82.