PocketSphinx  5prealpha
hmm.h
Go to the documentation of this file.
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  * 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 
42 #ifndef __HMM_H__
43 #define __HMM_H__
44 
45 /* System headers. */
46 #include <stdio.h>
47 
48 /* SphinxBase headers. */
49 #include <sphinxbase/fixpoint.h>
50 #include <sphinxbase/listelem_alloc.h>
51 
52 /* PocketSphinx headers. */
53 #include "bin_mdef.h"
54 
55 #ifdef __cplusplus
56 extern "C" {
57 #endif
58 
64 typedef int32 frame_idx_t;
65 
69 #define MAX_N_FRAMES MAX_INT32
70 
71 
73 #define SENSCR_SHIFT 10
74 
84 #define WORST_SCORE ((int)0xE0000000)
85 
90 #define TMAT_WORST_SCORE (-255)
91 
95 #define BETTER_THAN >
96 
100 #define WORSE_THAN <
101 
146 typedef struct hmm_context_s {
147  int32 n_emit_state;
148  uint8 ** const *tp;
149  int16 const *senscore;
151  uint16 * const *sseq;
152  int32 *st_sen_scr;
153  listelem_alloc_t *mpx_ssid_alloc;
154  void *udata;
155 } hmm_context_t;
156 
160 #define HMM_MAX_NSTATE 5
161 
170 typedef struct hmm_s {
174  int32 out_score;
175  int32 out_history;
176  uint16 ssid;
178  int32 bestscore;
179  int16 tmatid;
180  frame_idx_t frame;
181  uint8 mpx;
182  uint8 n_emit_state;
183 } hmm_t;
184 
186 #define hmm_context(h) (h)->ctx
187 #define hmm_is_mpx(h) (h)->mpx
188 
189 #define hmm_in_score(h) (h)->score[0]
190 #define hmm_score(h,st) (h)->score[st]
191 #define hmm_out_score(h) (h)->out_score
192 
193 #define hmm_in_history(h) (h)->history[0]
194 #define hmm_history(h,st) (h)->history[st]
195 #define hmm_out_history(h) (h)->out_history
196 
197 #define hmm_bestscore(h) (h)->bestscore
198 #define hmm_frame(h) (h)->frame
199 #define hmm_mpx_ssid(h,st) (h)->senid[st]
200 #define hmm_nonmpx_ssid(h) (h)->ssid
201 #define hmm_ssid(h,st) (hmm_is_mpx(h) \
202  ? hmm_mpx_ssid(h,st) : hmm_nonmpx_ssid(h))
203 #define hmm_mpx_senid(h,st) (hmm_mpx_ssid(h,st) == BAD_SENID \
204  ? BAD_SENID : (h)->ctx->sseq[hmm_mpx_ssid(h,st)][st])
205 #define hmm_nonmpx_senid(h,st) ((h)->senid[st])
206 #define hmm_senid(h,st) (hmm_is_mpx(h) \
207  ? hmm_mpx_senid(h,st) : hmm_nonmpx_senid(h,st))
208 #define hmm_senscr(h,st) (hmm_senid(h,st) == BAD_SENID \
209  ? WORST_SCORE \
210  : -(h)->ctx->senscore[hmm_senid(h,st)])
211 #define hmm_tmatid(h) (h)->tmatid
212 #define hmm_tprob(h,i,j) (-(h)->ctx->tp[hmm_tmatid(h)][i][j])
213 #define hmm_n_emit_state(h) ((h)->n_emit_state)
214 #define hmm_n_state(h) ((h)->n_emit_state + 1)
215 
219 hmm_context_t *hmm_context_init(int32 n_emit_state,
220  uint8 ** const *tp,
221  int16 const *senscore,
222  uint16 * const *sseq);
223 
227 #define hmm_context_set_senscore(ctx, senscr) ((ctx)->senscore = (senscr))
228 
237 
241 void hmm_init(hmm_context_t *ctx, hmm_t *hmm, int mpx, int ssid, int tmatid);
242 
246 void hmm_deinit(hmm_t *hmm);
247 
253 void hmm_clear(hmm_t *h);
254 
258 void hmm_clear_scores(hmm_t *h);
259 
263 void hmm_normalize(hmm_t *h, int32 bestscr);
264 
268 void hmm_enter(hmm_t *h, int32 score,
269  int32 histid, int frame);
270 
283 int32 hmm_vit_eval(hmm_t *hmm);
284 
285 
289 int32 hmm_dump_vit_eval(hmm_t *hmm,
290  FILE *fp
291  );
292 
297 void hmm_dump(hmm_t *h,
298  FILE *fp
299  );
300 
301 
302 #ifdef __cplusplus
303 }
304 #endif
305 
306 #endif /* __HMM_H__ */
uint16 senid[HMM_MAX_NSTATE]
Senone IDs (non-MPX) or sequence IDs (MPX)
Definition: hmm.h:177
int32 hmm_dump_vit_eval(hmm_t *hmm, FILE *fp)
Like hmm_vit_eval, but dump HMM state and relevant senscr to fp first, for debugging;.
Definition: hmm.c:810
void * udata
Whatever you feel like, gosh.
Definition: hmm.h:154
void hmm_init(hmm_context_t *ctx, hmm_t *hmm, int mpx, int ssid, int tmatid)
Populate a previously-allocated HMM structure, allocating internal data.
Definition: hmm.c:89
An individual HMM among the HMM search space.
int32 * st_sen_scr
Temporary array of senone scores (for some topologies).
Definition: hmm.h:152
listelem_alloc_t * mpx_ssid_alloc
Allocator for senone sequence ID arrays.
Definition: hmm.h:153
void hmm_deinit(hmm_t *hmm)
Free an HMM structure, releasing internal data (but not the HMM structure itself).
Definition: hmm.c:111
Binary format model definition files, with support for heterogeneous topologies and variable-size N-p...
int32 out_score
Score for non-emitting exit state.
Definition: hmm.h:174
int32 history[HMM_MAX_NSTATE]
History indices for emitting states.
Definition: hmm.h:173
uint8 mpx
Is this HMM multiplex? (hoisted for speed)
Definition: hmm.h:181
#define HMM_MAX_NSTATE
Hard-coded limit on the number of emitting states.
Definition: hmm.h:160
uint16 *const * sseq
Senone sequence mapping.
Definition: hmm.h:151
int32 hmm_vit_eval(hmm_t *hmm)
Viterbi evaluation of given HMM.
Definition: hmm.c:789
void hmm_normalize(hmm_t *h, int32 bestscr)
Renormalize the scores in this HMM based on the given best score.
Definition: hmm.c:209
hmm_context_t * hmm_context_init(int32 n_emit_state, uint8 **const *tp, int16 const *senscore, uint16 *const *sseq)
Create an HMM context.
Definition: hmm.c:56
uint16 ssid
Senone sequence ID (for non-MPX)
Definition: hmm.h:176
int32 bestscore
Best [emitting] state score in current frame (for pruning).
Definition: hmm.h:178
Shared information between a set of HMMs.
int32 out_history
History index for non-emitting exit state.
Definition: hmm.h:175
void hmm_enter(hmm_t *h, int32 score, int32 histid, int frame)
Enter an HMM with the given path score and history ID.
Definition: hmm.c:201
void hmm_dump(hmm_t *h, FILE *fp)
For debugging, dump the whole HMM out.
Definition: hmm.c:116
void hmm_clear(hmm_t *h)
Reset the states of the HMM to the invalid condition.
Definition: hmm.c:183
int16 tmatid
Transition matrix ID (see hmm_context_t).
Definition: hmm.h:179
hmm_context_t * ctx
Shared context data for this HMM.
Definition: hmm.h:171
int32 frame_idx_t
Type for frame index values.
Definition: hmm.h:64
int32 score[HMM_MAX_NSTATE]
State scores for emitting states.
Definition: hmm.h:172
void hmm_clear_scores(hmm_t *h)
Reset the scores of the HMM.
Definition: hmm.c:170
void hmm_context_free(hmm_context_t *ctx)
Free an HMM context.
Definition: hmm.c:80
uint8 n_emit_state
Number of emitting states (hoisted for speed)
Definition: hmm.h:182
int16 const * senscore
State emission scores senscore[senid] (negated scaled logs3 values).
Definition: hmm.h:149
uint8 **const * tp
State transition scores tp[id][from][to] (logs3 values).
Definition: hmm.h:148
int32 n_emit_state
Number of emitting states in this set of HMMs.
Definition: hmm.h:147
Definition: hmm.h:170
frame_idx_t frame
Frame in which this HMM was last active; &lt;0 if inactive.
Definition: hmm.h:180