src/libpocketsphinx/dict2pid.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.
 *
 * ====================================================================
 *
 */
/*
 * dict2pid.h -- Triphones for dictionary
 * 
 * **********************************************
 * 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.9  2006/02/22 21:05:16  arthchan2003
 * Merged from branch SPHINX3_5_2_RCI_IRII_BRANCH:
 *
 * 1, Added logic to handle bothe composite and non composite left
 * triphone.  Composite left triphone's logic (the original one) is
 * tested thoroughly. The non-composite triphone (or full triphone) is
 * found to have bugs.  The latter is fended off from the users in the
 * library level.
 *
 * 2, Fixed dox-doc.
 *
 * Revision 1.8.4.5  2005/11/17 06:13:49  arthchan2003
 * Use compressed right context in expansion in triphones.
 *
 * Revision 1.8.4.4  2005/10/17 04:48:45  arthchan2003
 * Free resource correctly in dict2pid.
 *
 * Revision 1.8.4.3  2005/10/07 19:03:38  arthchan2003
 * Added xwdssid_t structure.  Also added compression routines.
 *
 * Revision 1.8.4.2  2005/09/25 19:13:31  arthchan2003
 * Added optional full triphone expansion support when building context phone mapping.
 *
 * Revision 1.8.4.1  2005/07/17 05:20:30  arthchan2003
 * Fixed dox-doc.
 *
 * Revision 1.8  2005/06/21 21:03:49  arthchan2003
 * 1, Introduced a reporting routine. 2, Fixed doyxgen documentation, 3, Added  keyword.
 *
 * Revision 1.5  2005/06/13 04:02:57  archan
 * Fixed most doxygen-style documentation under libs3decoder.
 *
 * Revision 1.4  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.3  2005/03/30 01:22:46  archan
 * Fixed mistakes in last updates. Add
 *
 * 
 * 14-Sep-1999  M K Ravishankar (rkm@cs.cmu.edu) at Carnegie Mellon University
 *              Added dict2pid_comsseq2sen_active().
 * 
 * 04-May-1999  M K Ravishankar (rkm@cs.cmu.edu) at Carnegie Mellon University
 *              Started.
 */


#ifndef _S3_DICT2PID_H_
#define _S3_DICT2PID_H_


#include <stdio.h>

#include <logmath.h>
#include <bitvec.h>

#include "s3types.h"
#include "bin_mdef.h"
#include "s3dict.h"

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

typedef struct {
    s3ssid_t  *ssid;    
    s3cipid_t *cimap;   
    int32     n_ssid;   
} xwdssid_t;

typedef struct {
    int refcount;

    s3ssid_t **internal;        
    /*Notice the order of the arguments */

    s3ssid_t ***ldiph_lc;       
    s3ssid_t ***rdiph_rc;       
    xwdssid_t **rssid;          
    s3ssid_t ***lrdiph_rc;      
    xwdssid_t **lrssid;          
    int32 is_composite;         
    s3ssid_t **single_lc;       
    s3senid_t **comstate;       
    s3senid_t **comsseq;        
    int16 *comwt;               
    int32 n_comstate;           
    int32 n_comsseq;            
    int32 n_ci;   
    int32 n_dictsize; 
} dict2pid_t;

#define dict2pid_internal(d,w,p)        ((d)->internal[w][p]) 
#define dict2pid_n_comstate(d)          ((d)->n_comstate)     
#define dict2pid_n_comsseq(d)           ((d)->n_comsseq)      
#define dict2pid_is_composite(d)        ((d)->is_composite)      
#define dict2pid_rssid(d,ci,lc) (&(d)->rssid[ci][lc])

#define IS_COMPOSITE 1
#define NOT_COMPOSITE 0

dict2pid_t *dict2pid_build(bin_mdef_t *mdef,   
                           s3dict_t *dict,       
                           int32 is_composite, 
                           logmath_t *logmath
    );

dict2pid_t *dict2pid_retain(dict2pid_t *d2p);  

int dict2pid_free(dict2pid_t *d2p 
    );
void dict2pid_comsenscr(dict2pid_t *d2p,        
                        int16 const *senscr,    
                        int16 *comsenscr        
    );

void dict2pid_comsseq2sen_active(dict2pid_t *d2p,      
                                 bin_mdef_t *mdef,         
                                 bitvec_t *comssid,     
                                 bitvec_t *sen          
    );

void dict2pid_dump(FILE *fp,        
                   dict2pid_t *d2p, 
                   bin_mdef_t *mdef,    
                   s3dict_t *dict     
    );

void dict2pid_report(dict2pid_t *d2p 
    );

int32 get_rc_nssid(dict2pid_t *d2p,  
                   s3wid_t w,        
                   s3dict_t *dict      
    );

s3cipid_t* dict2pid_get_rcmap(dict2pid_t *d2p,  
                              s3wid_t w,        
                              s3dict_t *dict      
    );

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


#endif

---