SphinxBase 0.6
fsg_model.h
1/* -*- c-basic-offset: 4; indent-tabs-mode: nil -*- */
2/* ====================================================================
3 * Copyright (c) 1999-2004 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 *
19 * THIS SOFTWARE IS PROVIDED BY CARNEGIE MELLON UNIVERSITY ``AS IS'' AND
20 * ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
21 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY
23 * NOR ITS EMPLOYEES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 *
31 * ====================================================================
32 *
33 */
34
35/*
36 * fsg_model.h -- Word-level finite state graph
37 *
38 * **********************************************
39 * CMU ARPA Speech Project
40 *
41 * Copyright (c) 2003 Carnegie Mellon University.
42 * ALL RIGHTS RESERVED.
43 * **********************************************
44 */
45
46
47#ifndef __FSG_MODEL_H__
48#define __FSG_MODEL_H__
49
50/* System headers. */
51#include <stdio.h>
52#include <string.h>
53
54/* SphinxBase headers. */
56#include <sphinxbase/glist.h>
57#include <sphinxbase/logmath.h>
58#include <sphinxbase/bitvec.h>
61#include <sphinxbase/sphinxbase_export.h>
62
63/*
64 * A single transition in the FSG.
65 */
66typedef struct fsg_link_s {
67 int32 from_state;
68 int32 to_state;
69 int32 logs2prob;
70 int32 wid;
72
73/* Access macros */
74#define fsg_link_from_state(l) ((l)->from_state)
75#define fsg_link_to_state(l) ((l)->to_state)
76#define fsg_link_wid(l) ((l)->wid)
77#define fsg_link_logs2prob(l) ((l)->logs2prob)
78
82typedef struct trans_list_s trans_list_t;
83
108
109/* Access macros */
110#define fsg_model_name(f) ((f)->name)
111#define fsg_model_n_state(f) ((f)->n_state)
112#define fsg_model_start_state(f) ((f)->start_state)
113#define fsg_model_final_state(f) ((f)->final_state)
114#define fsg_model_log(f,p) logmath_log((f)->lmath, p)
115#define fsg_model_lw(f) ((f)->lw)
116#define fsg_model_n_word(f) ((f)->n_word)
117#define fsg_model_word_str(f,wid) (wid == -1 ? "(NULL)" : (f)->vocab[wid])
118
122typedef struct fsg_arciter_s fsg_arciter_t;
123
127#define fsg_model_has_sil(f) ((f)->silwords != NULL)
128
132#define fsg_model_has_alt(f) ((f)->altwords != NULL)
133
134#define fsg_model_is_filler(f,wid) \
135 (fsg_model_has_sil(f) ? bitvec_is_set((f)->silwords, wid) : FALSE)
136#define fsg_model_is_alt(f,wid) \
137 (fsg_model_has_alt(f) ? bitvec_is_set((f)->altwords, wid) : FALSE)
138
142SPHINXBASE_EXPORT
143fsg_model_t *fsg_model_init(char const *name, logmath_t *lmath,
144 float32 lw, int32 n_state);
145
185SPHINXBASE_EXPORT
186fsg_model_t *fsg_model_readfile(const char *file, logmath_t *lmath, float32 lw);
187
191SPHINXBASE_EXPORT
192fsg_model_t *fsg_model_read(FILE *fp, logmath_t *lmath, float32 lw);
193
199SPHINXBASE_EXPORT
200fsg_model_t *fsg_model_retain(fsg_model_t *fsg);
201
207SPHINXBASE_EXPORT
208int fsg_model_free(fsg_model_t *fsg);
209
215SPHINXBASE_EXPORT
216int fsg_model_word_add(fsg_model_t *fsg, char const *word);
217
223SPHINXBASE_EXPORT
224int fsg_model_word_id(fsg_model_t *fsg, char const *word);
225
232SPHINXBASE_EXPORT
233void fsg_model_trans_add(fsg_model_t * fsg,
234 int32 from, int32 to, int32 logp, int32 wid);
235
246SPHINXBASE_EXPORT
247int32 fsg_model_null_trans_add(fsg_model_t * fsg, int32 from, int32 to, int32 logp);
248
263SPHINXBASE_EXPORT
264int32 fsg_model_tag_trans_add(fsg_model_t * fsg, int32 from, int32 to,
265 int32 logp, int32 wid);
266
273SPHINXBASE_EXPORT
274glist_t fsg_model_null_trans_closure(fsg_model_t * fsg, glist_t nulls);
275
279SPHINXBASE_EXPORT
280glist_t fsg_model_trans(fsg_model_t *fsg, int32 i, int32 j);
281
285SPHINXBASE_EXPORT
286fsg_arciter_t *fsg_model_arcs(fsg_model_t *fsg, int32 i);
287
291SPHINXBASE_EXPORT
292fsg_link_t *fsg_arciter_get(fsg_arciter_t *itor);
293
297SPHINXBASE_EXPORT
298fsg_arciter_t *fsg_arciter_next(fsg_arciter_t *itor);
299
303SPHINXBASE_EXPORT
304void fsg_arciter_free(fsg_arciter_t *itor);
308SPHINXBASE_EXPORT
309fsg_link_t *fsg_model_null_trans(fsg_model_t *fsg, int32 i, int32 j);
310
317SPHINXBASE_EXPORT
318int fsg_model_add_silence(fsg_model_t * fsg, char const *silword,
319 int state, float32 silprob);
320
324SPHINXBASE_EXPORT
325int fsg_model_add_alt(fsg_model_t * fsg, char const *baseword,
326 char const *altword);
327
331SPHINXBASE_EXPORT
332void fsg_model_write(fsg_model_t *fsg, FILE *fp);
333
337SPHINXBASE_EXPORT
338void fsg_model_writefile(fsg_model_t *fsg, char const *file);
339
343SPHINXBASE_EXPORT
344void fsg_model_write_fsm(fsg_model_t *fsg, FILE *fp);
345
349SPHINXBASE_EXPORT
350void fsg_model_writefile_fsm(fsg_model_t *fsg, char const *file);
351
355SPHINXBASE_EXPORT
356void fsg_model_write_symtab(fsg_model_t *fsg, FILE *file);
357
361SPHINXBASE_EXPORT
362void fsg_model_writefile_symtab(fsg_model_t *fsg, char const *file);
363
364#endif /* __FSG_MODEL_H__ */
An implementation of bit vectors.
Generic linked-lists maintenance.
Hash table implementation.
Fast memory allocator for uniformly sized objects.
Fast integer logarithmic addition operations.
Basic type definitions used in Sphinx.
Implementation of arc iterator.
Definition fsg_model.c:71
Word level FSG definition.
Definition fsg_model.h:91
int32 n_word_alloc
Number of words allocated in vocab.
Definition fsg_model.h:95
int32 start_state
Must be in the range [0..n_state-1].
Definition fsg_model.h:101
char ** vocab
Vocabulary for this FSG.
Definition fsg_model.h:96
int32 n_state
number of states in FSG
Definition fsg_model.h:100
int32 n_word
Number of unique words in this FSG.
Definition fsg_model.h:94
logmath_t * lmath
Pointer to log math computation object.
Definition fsg_model.h:99
char * name
A unique string identifier for this FSG.
Definition fsg_model.h:93
bitvec_t * silwords
Indicates which words are silence/fillers.
Definition fsg_model.h:97
listelem_alloc_t * link_alloc
Allocator for FSG links.
Definition fsg_model.h:106
trans_list_t * trans
Transitions out of each state, if any.
Definition fsg_model.h:105
int32 final_state
Must be in the range [0..n_state-1].
Definition fsg_model.h:102
bitvec_t * altwords
Indicates which words are pronunciation alternates.
Definition fsg_model.h:98
float32 lw
Language weight that's been applied to transition logprobs.
Definition fsg_model.h:103
int refcount
Reference count.
Definition fsg_model.h:92
A node in a generic list.
Definition glist.h:100
Fast linked list allocator.
Adjacency list (opaque) for a state in an FSG.
Definition fsg_model.c:63