src/libpocketsphinx/s3dict.h

/* -*- 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.
 *
 * ====================================================================
 *
 */
/*
 * dict.h -- Pronunciation dictionary structures
 *
 * **********************************************
 * CMU ARPA Speech Project
 *
 * Copyright (c) 1997 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.10  2006/02/22 20:55:06  arthchan2003
 * Merged from branch SPHINX3_5_2_RCI_IRII_BRANCH:
 *
 * 1, Added Letter-to-sound LTS rule, dict_init will only specify
 * d->lts_rules to be true if the useLTS is specified.  Only if
 * d->lts_rules is specified, the LTS logic will be used. The code safe
 * guarded the case when a phone in mdef doesn't appear in LTS, in that
 * case, the code will force exit.
 *
 * 2, The LTS logic is only used as a reserved measure.  By default, it
 * is not turned on.  See also the comment in kbcore.c and the default
 * parameters in revision 1.3 cmdln_macro.h . We added it because we have
 * this functionality in SphinxTrain.
 *
 * Revision 1.9.4.4  2005/10/07 18:58:04  arthchan2003
 * Added macro for getting second last phone for a word.
 *
 * Revision 1.9.4.3  2005/09/25 19:12:09  arthchan2003
 * Added optional LTS support for the dictionary.
 *
 * Revision 1.9.4.2  2005/09/18 01:15:45  arthchan2003
 * Add one doxy-doc in dict.h
 *
 * Revision 1.9.4.1  2005/07/05 06:55:26  arthchan2003
 * Fixed dox-doc.
 *
 * Revision 1.9  2005/06/21 21:04:36  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
 *
 * 19-Apr-01    Ricky Houghton, added code for freeing memory that is allocated internally.
 * 
 * 23-Apr-98    M K Ravishankar (rkm@cs.cmu.edu) at Carnegie Mellon University.
 *              Made usage of mdef optional.  If no mdef is specified while loading
 *              a dictionary, it maintains the needed CI phone information internally.
 *              Added dict_ciphone_str().
 * 
 * 02-Jul-97    M K Ravishankar (rkm@cs.cmu.edu) at Carnegie Mellon University.
 *              Added startwid, finishwid, silwid to dict_t structure.
 * 
 * 07-Feb-97    M K Ravishankar (rkm@cs.cmu.edu) at Carnegie Mellon University.
 *              Created from previous Sphinx-3 version.
 */


#ifndef _S3_DICT_H_
#define _S3_DICT_H_

#include <hash_table.h>
#include <s3types.h>

#include "bin_mdef.h"
#include "lts.h" 

#define S3DICT_INC_SZ 4096

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

typedef struct {
    char *word;         
    s3cipid_t *ciphone; 
    int32 pronlen;      
    s3wid_t alt;        
    s3wid_t basewid;    
} dictword_t;

typedef struct {
    int refcnt;
    bin_mdef_t *mdef;   
    dictword_t *word;   
    hash_table_t *ht;   
    int32 max_words;    
    int32 n_word;       
    int32 filler_start; 
    int32 filler_end;   
    s3wid_t startwid;   
    s3wid_t finishwid;  
    s3wid_t silwid;     
    lts_t *lts_rules;     
} s3dict_t;


s3dict_t *s3dict_init(bin_mdef_t *mdef, 
                      const char *dictfile,     
                      const char *fillerfile,   
                      int useLTS,          
                      int breport          
    );

s3wid_t s3dict_wordid(s3dict_t *d, const char *word);

int s3dict_filler_word(s3dict_t *d,  
                       s3wid_t w     
    );

int s3dict_real_word(s3dict_t *d,  
                     s3wid_t w     
    );

s3wid_t s3dict_add_word(s3dict_t *d,  
                        char *word, 
                        s3cipid_t *p, 
                        int32 np
    );

const char *s3dict_ciphone_str(s3dict_t *d,     
                               s3wid_t wid,     
                               int32 pos        
    );

#define s3dict_size(d)          ((d)->n_word)
#define s3dict_num_fillers(d)   (s3dict_filler_end(d) - s3dict_filler_start(d))

#define s3dict_num_real_words(d) \
    (s3dict_size(d) - (s3dict_filler_end(d) - s3dict_filler_start(d)) - 2)
#define s3dict_basewid(d,w)     ((d)->word[w].basewid)
#define s3dict_wordstr(d,w)     ((d)->word[w].word)
#define s3dict_basestr(d,w)     ((d)->word[s3dict_basewid(d,w)].word)
#define s3dict_nextalt(d,w)     ((d)->word[w].alt)
#define s3dict_pronlen(d,w)     ((d)->word[w].pronlen) 
#define s3dict_pron(d,w,p)      ((d)->word[w].ciphone[p]) 
#define s3dict_filler_start(d)  ((d)->filler_start)
#define s3dict_filler_end(d)    ((d)->filler_end)
#define s3dict_startwid(d)      ((d)->startwid)
#define s3dict_finishwid(d)     ((d)->finishwid)
#define s3dict_silwid(d)                ((d)->silwid)
#define s3dict_first_phone(d,w) ((d)->word[w].ciphone[0])
#define s3dict_second_last_phone(d,w)   ((d)->word[w].ciphone[(d)->word[w].pronlen - 2])
#define s3dict_last_phone(d,w)  ((d)->word[w].ciphone[(d)->word[w].pronlen - 1])

/* Hard-coded special words */
#define S3_START_WORD           "<s>"
#define S3_FINISH_WORD          "</s>"
#define S3_SILENCE_WORD         "<sil>"
#define S3_UNKNOWN_WORD         "<UNK>"

/* Function versions of some of the above macros; note the leading underscore. */

s3wid_t _s3dict_basewid(s3dict_t *d, s3wid_t w);

char *_s3dict_wordstr(s3dict_t *d, s3wid_t wid);

s3wid_t _s3dict_nextalt(s3dict_t *d, s3wid_t wid);

int32 s3dict_word2basestr(char *word);

s3dict_t *s3dict_retain(s3dict_t *d);

int s3dict_free(s3dict_t *d);

void s3dict_report(s3dict_t *d 
    );

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

#endif

---