src/libpocketsphinx/vithist.h

Go to the documentation of this file.

/* -*- 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 work was supported in part by funding from the Defense Advanced 
 * Research Projects Agency and the National Science Foundation of the 
 * United States of America, and the CMU Sphinx Speech Consortium.
 *
 * 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.
 *
 * ====================================================================
 *
 */
/*
 * vithist.h -- Viterbi history
 * 
 * **********************************************
 * CMU ARPA Speech Project
 *
 * Copyright (c) 1999 Carnegie Mellon University.
 * ALL RIGHTS RESERVED.
 * **********************************************
 * 
 * HISTORY
 * $Log$
 * Revision 1.1  2006/04/05  20:27:30  dhdfu
 * A Great Reorganzation of header files and executables
 * 
 * Revision 1.12  2006/02/23 16:56:13  arthchan2003
 * Merged from the branch SPHINX3_5_2_RCI_IRII_BRANCH
 * 1, Split latticehist_t from flat_fwd.c to  here.
 * 2, Introduced vithist_entry_cp.  This is much better than the direct
 * copy we have been using. (Which could cause memory problem easily)
 *
 * Revision 1.11.4.9  2006/01/16 18:11:39  arthchan2003
 * 1, Important Bug fixes, a local pointer is used when realloc is needed.  This causes invalid writing of the memory, 2, Acoustic scores of the last segment in IBM lattice generation couldn't be found in the past.  Now, this could be handled by the optional acoustic scores in the node of lattice.  Application code is not yet checked-in
 *
 * Revision 1.11.4.8  2005/11/17 06:46:02  arthchan2003
 * 3 changes. 1, Code was added for full triphone implementation, not yet working. 2, Senone scale is removed from vithist table. This was a bug introduced during some fixes in CALO.
 *
 * Revision 1.11.4.7  2005/10/17 04:58:30  arthchan2003
 * vithist.c is the true source of memory leaks in the past for full cwtp expansion.  There are two changes made to avoid this happen, 1, instead of using ve->rc_info as the indicator whether something should be done, used a flag bFullExpand to control it. 2, avoid doing direct C-struct copy (like *ve = *tve), it becomes the reason of why memory are leaked and why the code goes wrong.
 *
 * Revision 1.11.4.6  2005/10/07 20:05:05  arthchan2003
 * When rescoring in full triphone expansion, the code should use the score for the word end with corret right context.
 *
 * Revision 1.11.4.5  2005/09/26 06:37:33  arthchan2003
 * Before anyone get hurt, quickly change back to using SINGLE_RC_HISTORY.
 *
 * Revision 1.11.4.4  2005/09/25 19:23:55  arthchan2003
 * 1, Added arguments for turning on/off LTS rules. 2, Added arguments for turning on/off composite triphones. 3, Moved dict2pid deallocation back to dict2pid. 4, Tidying up the clean up code.
 *
 * Revision 1.11.4.3  2005/09/11 03:00:15  arthchan2003
 * All lattice-related functions are not incorporated into vithist. So-called "lattice" is essentially the predecessor of vithist_t and fsg_history_t.  Later when vithist_t support by right context score and history.  It should replace both of them.
 *
 * Revision 1.11.4.2  2005/07/26 02:20:39  arthchan2003
 * merged hyp_t with srch_hyp_t.
 *
 * Revision 1.11.4.1  2005/07/04 07:25:22  arthchan2003
 * Added vithist_entry_display and vh_lmstate_display in vithist.
 *
 * Revision 1.11  2005/06/22 02:47:35  arthchan2003
 * 1, Added reporting flag for vithist_init. 2, Added a flag to allow using words other than silence to be the last word for backtracing. 3, Fixed doxygen documentation. 4, Add  keyword.
 *
 * Revision 1.10  2005/06/16 04:59:10  archan
 * Sphinx3 to s3.generic, a gentle-refactored version of Dave's change in senone scale.
 *
 * Revision 1.9  2005/06/13 04:02:59  archan
 * Fixed most doxygen-style documentation under libs3decoder.
 *
 * Revision 1.8  2005/05/26 00:46:59  archan
 * Added functionalities that such that <sil> will not be inserted at the end of the utterance.
 *
 * Revision 1.7  2005/04/25 23:53:35  archan
 * 1, Some minor modification of vithist_t, vithist_rescore can now support optional LM rescoring, vithist also has its own reporting routine. A new argument -lmrescore is also added in decode and livepretend.  This can switch on and off the rescoring procedure. 2, I am reaching the final difficulty of mode 5 implementation.  That is, to implement an algorithm which dynamically decide which tree copies should be entered.  However, stuffs like score propagation in the leave nodes and non-leaves nodes are already done. 3, As briefly mentioned in 2, implementation of rescoring , which used to happened at leave nodes are now separated. The current implementation is not the most clever one. Wish I have time to change it before check-in to the canonical.
 *
 * Revision 1.6  2005/04/21 23:50:26  archan
 * Some more refactoring on the how reporting of structures inside kbcore_t is done, it is now 50% nice. Also added class-based LM test case into test-decode.sh.in.  At this moment, everything in search mode 5 is already done.  It is time to test the idea whether the search can really be used.
 *
 * Revision 1.5  2005/04/20 03:46:30  archan
 * factor dag header writer into vithist.[ch], do the corresponding change for lm_t
 *
 * Revision 1.4  2005/03/30 01:22:47  archan
 * Fixed mistakes in last updates. Add
 *
 * 
 * 20.Apr.2001  RAH (rhoughton@mediasite.com, ricky.houghton@cs.cmu.edu)
 *              Added vithist_free() to free allocated memory
 * 
 * 30-Sep-1999  M K Ravishankar (rkm@cs.cmu.edu) at Carnegie Mellon University
 *              Added vithist_entry_t.ascr.
 * 
 * 13-Aug-1999  M K Ravishankar (rkm@cs.cmu.edu) at Carnegie Mellon University
 *              Added maxwpf handling.
 * 
 * 24-May-1999  M K Ravishankar (rkm@cs.cmu.edu) at Carnegie Mellon University
 *              Started.
 */


#ifndef _S3_VITHIST_H_
#define _S3_VITHIST_H_

#include <stdio.h>

#include <ngram_model.h>
#include <cmd_ln.h>
#include <logmath.h>
#include <glist.h>

#include "s3types.h"
#include "fillpen.h"
#include "s3dict.h"
#include "dict2pid.h"

#ifdef __cplusplus
extern "C" {
#endif
#if 0
} /* Fool Emacs into not indenting things. */
#endif

typedef union vh_lmstate_u {
    struct {
        int32 lwid[2];
    } lm3g;
} vh_lmstate_t;


typedef struct backpointer_s {
    int32 score;
    int32 pred;
} backpointer_t;

typedef struct {
    backpointer_t path;         
    vh_lmstate_t lmstate;       
    s3wid_t wid;                
    s3frmid_t sf, ef;           
    int32 ascr;                 
    int32 lscr;                 
    int16 type;                 
    int16 valid;                
    backpointer_t *rc;          
    int32 n_rc;                 
} vithist_entry_t;

#define vithist_entry_wid(ve)   ((ve)->wid)

#define vithist_entry_sf(ve)    ((ve)->sf)

#define vithist_entry_ef(ve)    ((ve)->ef)

#define vithist_entry_ascr(ve)  ((ve)->ascr)

#define vithist_entry_lscr(ve)  ((ve)->lscr)

#define vithist_entry_score(ve) ((ve)->path.score)
#define vithist_entry_pred(ve)  ((ve)->path.pred)
#define vithist_entry_valid(ve) ((ve)->valid)


typedef struct {                
    int32 state;                
    int32 vhid;                 
    vithist_entry_t *ve;        
    glist_t children;           
} vh_lms2vh_t;


typedef struct {
    vithist_entry_t **entry;    
    int32 *frame_start;         
    int32 n_entry;              
    int32 n_frm;                
    int32 n_ci;                 
    int32 bghist;               
    int32 wbeam;                
    int32 *bestscore;           
    int32 *bestvh;              
    vh_lms2vh_t **lms2vh_root;  
    glist_t lwidlist;           
} vithist_t;


#define VITHIST_BLKSIZE         16384   /* (1 << 14) */
#define VITHIST_MAXBLKS         256
#define VITHIST_ID2BLK(i)       ((i) >> 14)
#define VITHIST_ID2BLKOFFSET(i) ((i) & 0x00003fff)      /* 14 LSB */

#define vithist_id2entry(vh,id) ((vh)->entry[VITHIST_ID2BLK(id)] + VITHIST_ID2BLKOFFSET(id))

#define vithist_n_entry(vh)             ((vh)->n_entry)

#define vithist_bestscore(vh)           ((vh)->bestscore)

#define vithist_bestvh(vh)              ((vh)->bestvh)

#define vithist_lms2vh_root(vh,w)       ((vh)->lms2vh_root[w])

#define vithist_lwidlist(vh)            ((vh)->lwidlist)

#define vithist_first_entry(vh,f)       ((vh)->frame_start[f])

#define vithist_last_entry(vh,f)        ((vh)->frame_start[f+1] - 1)


vithist_t *vithist_init(int32 lm_nword, 
                        int32 n_ci,     
                        int32 wbeam,    
                        int32 bghist,   
                        int32 report    
    );


int32 vithist_utt_begin(vithist_t *vh,  
                        int32 wid,   
                        int32 lwid   
    );


int32 vithist_utt_end(vithist_t *vh, 
                      ngram_model_t *lm,
                      s3dict_t *dict,
                      dict2pid_t *dict2pid,
                      fillpen_t *fp
    );


int32 vithist_partialutt_end(vithist_t *vh, 
                             ngram_model_t *lm,
                             s3dict_t *dict
    );

/* Invoked at the end of each utterance to clear up and deallocate space */
void vithist_utt_reset(vithist_t *vh  
    );


glist_t vithist_backtrace(vithist_t *vh,        
                          int32 id,             
                          s3dict_t *dict        
    );


void vithist_enter(vithist_t * vh,              
                   s3dict_t *dict,              
                   dict2pid_t *dict2pid,        
                   vithist_entry_t * tve,       
                   int32 comp_rc                
    );

void vithist_rescore(vithist_t *vh,    
                     ngram_model_t *lm,  
                     s3dict_t *dict,     
                     dict2pid_t *dict2pid,
                     fillpen_t *fp,    
                     s3wid_t wid,      
                     int32 ef,          
                     int32 score,       
                     int32 pred,        
                     int32 type,       
                     int32 rc          
    );


void vithist_frame_windup(vithist_t *vh,        
                          int32 frm,            
                          FILE *fp,             
                          ngram_model_t *lm,  
                          s3dict_t *dict      
    );

void vithist_prune(vithist_t *vh,      
                   s3dict_t *dict,      
                   int32 frm,           
                   int32 maxwpf,        
                   int32 maxhist,       
                   int32 beam   
    );

void vithist_dump(vithist_t *vh,      
                  int32 frm,          
                  ngram_model_t *lm,  
                  s3dict_t *dict,     
                  FILE *fp            
    );

#if 0

dag_t *vithist_dag_build(vithist_t * vh, glist_t hyp, s3dict_t * dict, int32 endid,
                         cmd_ln_t *config, logmath_t *logmath);
#endif

void vithist_free(vithist_t *vh         
    );


void vithist_report(vithist_t *vh       
    );

void vh_lmstate_display(vh_lmstate_t *vhl, 
                        s3dict_t *dict 
    );

void vithist_entry_display(vithist_entry_t *ve, 
                           s3dict_t* dict  
    );

#if 0
{ /* Stop indent from complaining */
#endif
#ifdef __cplusplus
}
#endif

#endif

---