1 /* -*- c-basic-offset: 4; indent-tabs-mode: nil -*- */
2 /* ====================================================================
3  * Copyright (c) 2010 Carnegie Mellon University.  All rights
4  * reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in
15  *    the documentation and/or other materials provided with the
16  *    distribution.
17  *
18  * This work was supported in part by funding from the Defense Advanced
19  * Research Projects Agency and the National Science Foundation of the
20  * United States of America, and the CMU Sphinx Speech Consortium.
21  *
22  * THIS SOFTWARE IS PROVIDED BY CARNEGIE MELLON UNIVERSITY ``AS IS'' AND
23  * ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
24  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
25  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY
26  * NOR ITS EMPLOYEES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  *
34  * ====================================================================
35  *
36  */
37 
38 /**
39  * @file ps_alignment.h Multi-level alignment structure
40  */
41 
42 #ifndef __PS_ALIGNMENT_H__
43 #define __PS_ALIGNMENT_H__
44 
45 /* System headers. */
46 
47 /* SphinxBase headers. */
48 #include <sphinxbase/prim_type.h>
49 
50 /* Local headers. */
51 #include "dict2pid.h"
52 #include "hmm.h"
53 
54 #define PS_ALIGNMENT_NONE ((uint16)0xffff)
55 
56 struct ps_alignment_entry_s {
57     union {
58         int32 wid;
59         struct {
60             uint16 ssid;
61             uint16 cipid;
62             uint16 tmatid;
63         } pid;
64         uint16 senid;
65     } id;
66     int16 start;
67     int16 duration;
68     uint16 parent;
69     uint16 child;
70 };
71 typedef struct ps_alignment_entry_s ps_alignment_entry_t;
72 
73 struct ps_alignment_vector_s {
74     ps_alignment_entry_t *seq;
75     uint16 n_ent, n_alloc;
76 };
77 typedef struct ps_alignment_vector_s ps_alignment_vector_t;
78 
79 struct ps_alignment_s {
80     dict2pid_t *d2p;
81     ps_alignment_vector_t word;
82     ps_alignment_vector_t sseq;
83     ps_alignment_vector_t state;
84 };
85 typedef struct ps_alignment_s ps_alignment_t;
86 
87 struct ps_alignment_iter_s {
88     ps_alignment_t *al;
89     ps_alignment_vector_t *vec;
90     int pos;
91 };
92 typedef struct ps_alignment_iter_s ps_alignment_iter_t;
93 
94 /**
95  * Create a new, empty alignment.
96  */
97 ps_alignment_t *ps_alignment_init(dict2pid_t *d2p);
98 
99 /**
100  * Release an alignment
101  */
102 int ps_alignment_free(ps_alignment_t *al);
103 
104 /**
105  * Append a word.
106  */
107 int ps_alignment_add_word(ps_alignment_t *al,
108                           int32 wid, int duration);
109 
110 /**
111  * Populate lower layers using available word information.
112  */
113 int ps_alignment_populate(ps_alignment_t *al);
114 
115 /**
116  * Populate lower layers using context-independent phones.
117  */
118 int ps_alignment_populate_ci(ps_alignment_t *al);
119 
120 /**
121  * Propagate timing information up from state sequence.
122  */
123 int ps_alignment_propagate(ps_alignment_t *al);
124 
125 /**
126  * Number of words.
127  */
128 int ps_alignment_n_words(ps_alignment_t *al);
129 
130 /**
131  * Number of phones.
132  */
133 int ps_alignment_n_phones(ps_alignment_t *al);
134 
135 /**
136  * Number of states.
137  */
138 int ps_alignment_n_states(ps_alignment_t *al);
139 
140 /**
141  * Iterate over the alignment starting at the first word.
142  */
143 ps_alignment_iter_t *ps_alignment_words(ps_alignment_t *al);
144 
145 /**
146  * Iterate over the alignment starting at the first phone.
147  */
148 ps_alignment_iter_t *ps_alignment_phones(ps_alignment_t *al);
149 
150 /**
151  * Iterate over the alignment starting at the first state.
152  */
153 ps_alignment_iter_t *ps_alignment_states(ps_alignment_t *al);
154 
155 /**
156  * Get the alignment entry pointed to by an iterator.
157  */
158 ps_alignment_entry_t *ps_alignment_iter_get(ps_alignment_iter_t *itor);
159 
160 /**
161  * Move alignment iterator to given index.
162  */
163 ps_alignment_iter_t *ps_alignment_iter_goto(ps_alignment_iter_t *itor, int pos);
164 
165 /**
166  * Move an alignment iterator forward.
167  */
168 ps_alignment_iter_t *ps_alignment_iter_next(ps_alignment_iter_t *itor);
169 
170 /**
171  * Move an alignment iterator back.
172  */
173 ps_alignment_iter_t *ps_alignment_iter_prev(ps_alignment_iter_t *itor);
174 
175 /**
176  * Get a new iterator starting at the parent of the current node.
177  */
178 ps_alignment_iter_t *ps_alignment_iter_up(ps_alignment_iter_t *itor);
179 /**
180  * Get a new iterator starting at the first child of the current node.
181  */
182 ps_alignment_iter_t *ps_alignment_iter_down(ps_alignment_iter_t *itor);
183 
184 /**
185  * Release an iterator before completing all iterations.
186  */
187 int ps_alignment_iter_free(ps_alignment_iter_t *itor);
188 
189 #endif /* __PS_ALIGNMENT_H__ */
190