include/feat.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.
 *
 * ====================================================================
 *
 */
/*
 * feat.h -- Cepstral features computation.
 *
 * **********************************************
 * 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.17  2006/02/23 03:59:40  arthchan2003
 * Merged from branch SPHINX3_5_2_RCI_IRII_BRANCH: a, Free buffers correctly. b, Fixed dox-doc.
 *
 * Revision 1.16.4.1  2005/07/05 06:25:08  arthchan2003
 * Fixed dox-doc.
 *
 * Revision 1.16  2005/06/22 03:29:35  arthchan2003
 * Makefile.am s  for all subdirectory of libs3decoder/
 *
 * Revision 1.5  2005/06/13 04:02:56  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
 *
 * 
 * 20.Apr.2001  RAH (rhoughton@mediasite.com, ricky.houghton@cs.cmu.edu)
 *              Adding feat_free() to free allocated memory
 * 
 * 04-Jan-1999  M K Ravishankar (rkm@cs.cmu.edu) at Carnegie Mellon University
 *              Started.
 */


#ifndef _S3_FEAT_H_
#define _S3_FEAT_H_

#include <stdio.h>

/* Win32/WinCE DLL gunk */
#include <sphinxbase_export.h>
#include <prim_type.h>
#include <fe.h>
#include <cmn.h>
#include <agc.h>

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

#define LIVEBUFBLOCKSIZE        256    
#define S3_MAX_FRAMES           15000    /* RAH, I believe this is still too large, but better than before */

#define cepstral_to_feature_command_line_macro()                        \
{ "-feat",                                                              \
      ARG_STRING,                                                       \
      "1s_c_d_dd",                                                      \
      "Feature stream type, depends on the acoustic model" },           \
{ "-ceplen",                                                            \
      ARG_INT32,                                                        \
      "13",                                                             \
     "Number of components in the input feature vector" },              \
{ "-cmn",                                                               \
      ARG_STRING,                                                       \
      "current",                                                        \
      "Cepstral mean normalization scheme ('current', 'prior', or 'none')" }, \
{ "-cmninit",                                                           \
      ARG_STRING,                                                       \
      "8.0",                                                            \
      "Initial values (comma-separated) for cepstral mean when 'prior' is used" }, \
{ "-varnorm",                                                           \
      ARG_BOOLEAN,                                                      \
      "no",                                                             \
      "Variance normalize each utterance (only if CMN == current)" },   \
{ "-agc",                                                               \
      ARG_STRING,                                                       \
      "none",                                                           \
      "Automatic gain control for c0 ('max', 'emax', 'noise', or 'none')" }, \
{ "-agcthresh",                                                         \
      ARG_FLOAT32,                                                      \
      "2.0",                                                            \
      "Initial threshold for automatic gain control" },                 \
{ "-lda",                                                               \
      ARG_STRING,                                                       \
      NULL,                                                             \
      "File containing transformation matrix to be applied to features (single-stream features only)" }, \
{ "-ldadim",                                                            \
      ARG_INT32,                                                        \
      "0",                                                              \
      "Dimensionality of output of feature transformation (0 to use entire matrix)" }, \
{"-svspec",                                                             \
     ARG_STRING,                                                        \
     NULL,                                                           \
     "Subvector specification (e.g., 24,0-11/25,12-23/26-38 or 0-12/13-25/26-38)"}

typedef struct feat_s {
    int refcount;       
    char *name;         
    int32 cepsize;      
    int32 n_stream;     
    int32 *stream_len;  
    int32 window_size;  
    int32 n_sv;         
    int32 *sv_len;      
    int32 **subvecs;    
    mfcc_t *sv_buf;      
    int32 sv_dim;       
    cmn_type_t cmn;     
    int32 varnorm;      
    agc_type_t agc;     
    void (*compute_feat)(struct feat_s *fcb, mfcc_t **input, mfcc_t **feat);
    cmn_t *cmn_struct;  
    agc_t *agc_struct;  
    mfcc_t **cepbuf;    
    mfcc_t **tmpcepbuf; 
    int32   bufpos;     
    int32   curpos;     
    mfcc_t ***lda; 
    uint32 n_lda;   
    uint32 out_dim; 
} feat_t;

#define feat_name(f)            ((f)->name)

#define feat_cepsize(f)         ((f)->cepsize)

#define feat_window_size(f)     ((f)->window_size)

#define feat_n_stream(f)        ((f)->n_stream)

#define feat_stream_len(f,i)    ((f)->stream_len[i])

#define feat_dimension1(f)      ((f)->n_sv ? (f)->n_sv : f->n_stream)

#define feat_dimension2(f,i)    ((f)->sv_len ? (f)->sv_len[i] : f->stream_len[i])

#define feat_dimension(f)       ((f)->out_dim)

SPHINXBASE_EXPORT
int32 **parse_subvecs(char const *str);

SPHINXBASE_EXPORT
void subvecs_free(int32 **subvecs);

SPHINXBASE_EXPORT
int32 feat_s2mfc_read(char *file,       
                int32 win,              
                int32 sf, int32 ef,     
                mfcc_t ***out_mfc,      
                int32 maxfr,            
                int32 cepsize           
    );

SPHINXBASE_EXPORT
mfcc_t ***feat_array_alloc(feat_t *fcb, 
                           int32 nfr    
    );

SPHINXBASE_EXPORT
void feat_array_free(mfcc_t ***feat);


SPHINXBASE_EXPORT
feat_t *feat_init(char const *type,
                  cmn_type_t cmn, 
                  int32 varnorm,  
                  agc_type_t agc, 
                  int32 breport, 
                  int32 cepsize  
    );

SPHINXBASE_EXPORT
int32 feat_read_lda(feat_t *feat,        
                    const char *ldafile, 
                    int32 dim            
    );

SPHINXBASE_EXPORT
void feat_lda_transform(feat_t *fcb,            
                        mfcc_t ***inout_feat,   
                        uint32 nfr              
    );

SPHINXBASE_EXPORT
int feat_set_subvecs(feat_t *fcb, int32 **subvecs);

SPHINXBASE_EXPORT
void feat_print(feat_t *fcb,            
                mfcc_t ***feat,         
                int32 nfr,              
                FILE *fp                
    );

  
SPHINXBASE_EXPORT
int32 feat_s2mfc2feat(feat_t *fcb,      
                      const char *file, 
                      const char *dir,  
                      const char *cepext,
                      int32 sf, int32 ef,   /* Start/End frames
                                               within file to be read. Use
                                               0,-1 to process entire
                                               file */
                      mfcc_t ***feat,   
                      int32 maxfr       
    );


SPHINXBASE_EXPORT
int32 feat_s2mfc2feat_live(feat_t  *fcb,     
                           mfcc_t **uttcep,  
                           int32 *inout_ncep,
                           int32 beginutt,   
                           int32 endutt,     
                           mfcc_t ***ofeat   
    );


SPHINXBASE_EXPORT
feat_t *feat_retain(feat_t *f);

SPHINXBASE_EXPORT
int feat_free(feat_t *f 
    );

SPHINXBASE_EXPORT
void feat_report(feat_t *f 
    );
#ifdef __cplusplus
}
#endif


#endif

---