libs3decoder-dev 0.8-0ubuntu1 / usr / include / sphinx3 / classify.h

/* -*- c-basic-offset: 4; indent-tabs-mode: nil -*- */
/* ====================================================================
 * Copyright (c) 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.
 *
 * ====================================================================
 *
 */
/*************************************************
 * CMU CALO Speech Project
 *
 * Copyright (c) 2004 Carnegie Mellon University.
 * ALL RIGHTS RESERVED.
 * **********************************************
 * 
 * 17-Jun-2004  Ziad Al Bawab (ziada@cs.cmu.edu) at Carnegie Mellon University
 * Created
 * $Log$
 * Revision 1.1  2006/04/05  20:27:30  dhdfu
 * A Great Reorganzation of header files and executables
 * 
 * Revision 1.10  2006/03/03 20:02:38  arthchan2003
 * Removed C++ styles comment. This will make options -ansi and -std=c89 happy
 *
 * Revision 1.9  2006/02/23 04:05:21  arthchan2003
 * Merged from branch SPHINX3_5_2_RCI_IRII_BRANCH: fixed dox-doc.
 *
 *
 * Revision 1.6.4.1  2005/07/05 06:46:23  arthchan2003
 * 1, Merged from HEAD.  2, fixed dox-doc.
 *
 * Revision 1.8  2005/07/04 20:57:53  dhdfu
 * Finally remove the "temporary hack" for the endpointer, and do
 * everything in logs3 domain.  Should make it faster and less likely to
 * crash on Alphas.
 *
 * Actually it kind of duplicates the existing GMM computation functions,
 * but it is slightly different (see the comment in classify.c).  I don't
 * know the rationale for this.
 *
 * Revision 1.7  2005/07/02 04:24:45  egouvea
 * Changed some hardwired constants to user defined parameters in the end pointer. Tested with make test-ep.
 *
 * Revision 1.6  2005/06/21 21:06:47  arthchan2003
 * 1, Fixed doxygen documentation, 2, Added  keyword. 3, Change for mdef_init to use logging.
 *
 * Revision 1.3  2005/06/15 06:48:54  archan
 * Sphinx3 to s3.generic: 1, updated the endptr and classify 's code, 2, also added
 *
 */


#include "s3types.h"
#include "cont_mgau.h"

/** \file classify.h
    \brief Frame-by-frame classifier written by Ziad. To be replaced by Yitao's version. 
*/
#ifdef __cplusplus
extern "C" {
#endif 
#if 0
} /* Fool Emacs into not indenting things. */
#endif

#ifndef __FRAME_CLASSIFIER__
#define __FRAME_CLASSIFIER__

/******** Set the parameters of the classes *************/

#define NUMCLASSES      4	/* Number of classes*/

/*
  #define NUMMIXTURES     32 	// Number of gaussian mixtures used in classification
*/
#define DIMENSIONS      13	/* Length of the feature vector*/
#define MAXFRAMES       10000	

/******** Set the names of the classes *************/
/* this is how the mdef file arranged the models*/

#define CLASS_N         0 	/* Noise*/
#define CLASS_O         1 	/* Owner speech*/
#define CLASS_S         2 	/* Secondary speech */
#define CLASS_SIL       3 	/* Silence */

/******** Set the priors of the classes *************/

#define PRIOR_N  	0.1 	/* N */
#define PRIOR_O  	0.4 	/* O */
#define PRIOR_S  	0.1 	/* S */
#define PRIOR_SIL  	0.4 	/* SIL */

/****************************************************/


/******** Set the width of the voting Window *************/

#define VOTEWINDOWLEN 	5	/* Don't change this number as the code expects 5, or you have to 
				   change the code*/

#define CLASSLATENCY  	2	/* Number of latency frames caused by the post processing (voting window)
				 */

#define POSTPROCESS	1	/* Enabling/disabling post-processing
				 */
/**************************************************/

/**
   \struct class_t
   \brief class to store the classifier parameters 
*/ 

typedef struct{
    char *classname[NUMCLASSES];             /**< An array of class names */
    int32 windowlen;                         /**< The window length */
    mgau_model_t *g ;                        /**< The endpoint model */
    s3cipid_t classmap[NUMCLASSES];

    int32 priors[NUMCLASSES];

    int32 window[VOTEWINDOWLEN];              /**< the voting window contains class numbers*/
    int32 postprocess;
    int32 classlatency;
}class_t;





/** Macro to byteswap an int variable.  x = ptr to variable */
#define SWAP_INT(x)   *(x) = ((0x000000ff & (*(x))>>24) | \
                                (0x0000ff00 & (*(x))>>8) | \
                                (0x00ff0000 & (*(x))<<8) | \
                                (0xff000000 & (*(x))<<24))
/** Macro to byteswap a float variable.  x = ptr to variable */
#define SWAP_FLOAT(x) SWAP_INT((int *) x)

void majority_class(class_t* CLASSW, int *classcount, int frame_count);

class_t * classw_initialize(char *mdeffile,  /**< The model def file */
			    char* meanfile,   /**< The mean file */
			    char *varfile,       /**< The variance file */
			    float64 varfloor,    /**< variance floor */
			    char* mixwfile,         /**< The mixture weight */
			    float64 mixwfloor,       /**< mixture weight floor */
			    int32 precomp,       /**< pre-computation of values,
						    0 not to pre-compute, 
						    1 to precompute */
			    char *senmgau       /**< whether it is SCHMM, ".semi." or FCHMM ".cont." */
    );

void classw_free(class_t *CLASSW);

int classify (float *frame,     /**< the frame */
	      mgau_model_t *g,  /**< multiple mixture models */
	      int32 priors[NUMCLASSES], /**< The prior of each classes */
	      s3cipid_t *map  /**< Map between ci phones and classes */
    );

int postclassify (int *window, int windowlen, int *wincap, int myclass);

int vote (int *window, /**< A window of input */
	  int windowlen /**< The window length*/
    );

#endif /*__FRAME_CLASSIFIER__*/

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