upstream version 1.2.2
[debian/freetts] / com / sun / speech / freetts / PhoneSet.java
1 /**
2  * Portions Copyright 2001 Sun Microsystems, Inc.
3  * Portions Copyright 1999-2001 Language Technologies Institute, 
4  * Carnegie Mellon University.
5  * All Rights Reserved.  Use is subject to license terms.
6  * 
7  * See the file "license.terms" for information on usage and
8  * redistribution of this file, and for a DISCLAIMER OF ALL 
9  * WARRANTIES.
10  */
11 package com.sun.speech.freetts;
12
13
14 /**
15  * Maintains a list of phones with various features for those phones.
16  */
17 public interface PhoneSet  {
18
19     /**
20      * Vowel or consonant:  + = vowel, - = consonant.
21      */
22     public final static String VC = "vc";  
23
24     /**
25      * Vowel length:  s = short, l = long, d = dipthong, a = schwa.
26      */
27     public final static String VLNG = "vlng";  
28
29     /**
30      * Vowel height:  1 = high,  2 = mid,  3 = low.
31      */
32     public final static String VHEIGHT = "vheight";  
33
34     /**
35      * Vowel frontness:  1 = front, 2 = mid, 3 = back.
36      */
37     public final static String VFRONT = "vfront";  
38
39     /**
40      * Lip rounding:  + = on, - = off.
41      */
42     public final static String VRND = "vrnd";  
43
44     /**
45      * Consonant type:  s = stop, f = fricative,  a = affricative,
46      * n = nasal, l = liquid.
47      */
48     public final static String CTYPE = "ctype";  
49
50     /**
51      * Consonant cplace:  l = labial, a = alveolar, p = palatal,
52      * b = labio_dental, d = dental, v = velar
53      */
54     public final static String CPLACE = "cplace";  
55
56     /**
57      * Consonant voicing:  + = on, - = off
58      */
59     public final static String CVOX = "cvox";  
60
61     /**
62      * Given a phoneme and a feature name, return the feature.
63      *
64      * @param phone the phoneme of interest
65      * @param featureName the name of the feature of interest
66      *
67      * @return the feature with the given name
68      */
69     public String getPhoneFeature(String phone, String featureName);
70 }