tenfourfox/media/pocketsphinx/src/fsg_search_internal.h
Cameron Kaiser c9b2922b70 hello FPR
2017-04-19 00:56:45 -07:00

150 lines
5.1 KiB
C

/* -*- c-basic-offset:4; indent-tabs-mode: nil -*- */
/* ====================================================================
* Copyright (c) 1999-2004 Carnegie Mellon University. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
*
* THIS SOFTWARE IS PROVIDED BY CARNEGIE MELLON UNIVERSITY ``AS IS'' AND
* ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY
* NOR ITS EMPLOYEES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* ====================================================================
*
*/
/*
* fsg_search_internal.h -- Search structures for FSG decoding.
*/
#ifndef __S2_FSG_SEARCH_H__
#define __S2_FSG_SEARCH_H__
/* SphinxBase headers. */
#include <sphinxbase/glist.h>
#include <sphinxbase/cmd_ln.h>
#include <sphinxbase/fsg_model.h>
/* Local headers. */
#include "pocketsphinx_internal.h"
#include "hmm.h"
#include "fsg_history.h"
#include "fsg_lextree.h"
/**
* Segmentation "iterator" for FSG history.
*/
typedef struct fsg_seg_s {
ps_seg_t base; /**< Base structure. */
fsg_hist_entry_t **hist; /**< Sequence of history entries. */
int16 n_hist; /**< Number of history entries. */
int16 cur; /**< Current position in hist. */
} fsg_seg_t;
/**
* Implementation of FSG search (and "FSG set") structure.
*/
typedef struct fsg_search_s {
ps_search_t base;
hmm_context_t *hmmctx; /**< HMM context. */
char const *arpafile;
cmd_ln_t *config;
fsg_model_t *fsg; /**< FSG model */
struct fsg_lextree_s *lextree;/**< Lextree structure for the currently
active FSG */
struct fsg_history_s *history;/**< For storing the Viterbi search history */
glist_t pnode_active; /**< Those active in this frame */
glist_t pnode_active_next; /**< Those activated for the next frame */
int32 beam_orig; /**< Global pruning threshold */
int32 pbeam_orig; /**< Pruning threshold for phone transition */
int32 wbeam_orig; /**< Pruning threshold for word exit */
float32 beam_factor; /**< Dynamic/adaptive factor (<=1) applied to above
beams to determine actual effective beams.
For implementing absolute pruning. */
int32 beam, pbeam, wbeam; /**< Effective beams after applying beam_factor */
int32 lw, pip, wip; /**< Language weights */
frame_idx_t frame; /**< Current frame. */
uint8 final; /**< Decoding is finished for this utterance. */
uint8 bestpath; /**< Whether to run bestpath search
and confidence annotation at end. */
float32 ascale; /**< Acoustic score scale for posterior probabilities. */
int32 bestscore; /**< For beam pruning */
int32 bpidx_start; /**< First history entry index this frame */
int32 ascr, lscr; /**< Total acoustic and lm score for utt */
int32 n_hmm_eval; /**< Total HMMs evaluated this utt */
int32 n_sen_eval; /**< Total senones evaluated this utt */
} fsg_search_t;
/* Access macros */
#define fsg_search_frame(s) ((s)->frame)
/**
* Create, initialize and return a search module.
*/
ps_search_t *fsg_search_init(fsg_model_t *fsg,
cmd_ln_t *config,
acmod_t *acmod,
dict_t *dict,
dict2pid_t *d2p);
/**
* Deallocate search structure.
*/
void fsg_search_free(ps_search_t *search);
/**
* Update FSG search module for new or updated FSGs.
*/
int fsg_search_reinit(ps_search_t *fsgs, dict_t *dict, dict2pid_t *d2p);
/**
* Prepare the FSG search structure for beginning decoding of the next
* utterance.
*/
int fsg_search_start(ps_search_t *search);
/**
* Step one frame forward through the Viterbi search.
*/
int fsg_search_step(ps_search_t *search, int frame_idx);
/**
* Windup and clean the FSG search structure after utterance.
*/
int fsg_search_finish(ps_search_t *search);
/**
* Get hypothesis string from the FSG search.
*/
char const *fsg_search_hyp(ps_search_t *search, int32 *out_score, int32 *out_is_final);
#endif