allphone_search.h

/* -*- c-basic-offset:4; indent-tabs-mode: nil -*- */
/* ====================================================================
 * Copyright (c) 2014 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.
 *
 * ====================================================================
 *
 */

/*
 * allphone_search.h -- Search structures for phoneme decoding.
 */


#ifndef __ALLPHONE_SEARCH_H__
#define __ALLPHONE_SEARCH_H__


/* SphinxBase headers. */
#include <sphinxbase/glist.h>
#include <sphinxbase/cmd_ln.h>
#include <sphinxbase/ngram_model.h>
#include <sphinxbase/bitvec.h>

/* Local headers. */
#include "pocketsphinx_internal.h"
#include "blkarray_list.h"
#include "hmm.h"

typedef struct phmm_s {
    hmm_t hmm;          
    s3pid_t pid;        
    s3cipid_t ci;       
    bitvec_t *lc;         
    bitvec_t *rc;         
    struct phmm_s *next;        
    struct plink_s *succlist;   
} phmm_t;

typedef struct plink_s {
    phmm_t *phmm;               
    struct plink_s *next;       
} plink_t;

typedef struct history_s {
    phmm_t *phmm;       
    int32 score;        
    int32 tscore;       
    frame_idx_t ef;     
    int32 hist;         
} history_t;

typedef struct phseg_s {
    s3cipid_t ci;               /* CI-phone id */
    frame_idx_t sf, ef;         /* Start and end frame for this phone occurrence */
    int32 score;                /* Acoustic score for this segment of alignment */
    int32 tscore;               /* Transition ("LM") score for this segment */
} phseg_t;

typedef struct phseg_iter_s {
    ps_seg_t base;
    glist_t seg;
} phseg_iter_t;

typedef struct allphone_search_s {
    ps_search_t base;

    hmm_context_t *hmmctx;    
    ngram_model_t *lm;        
    int32 ci_only;            
    phmm_t **ci_phmm;         
    int32 *ci2lmwid;          
    int32 beam, pbeam;        
    int32 lw, inspen;         
    frame_idx_t frame;          
    float32 ascale;           
    int32 n_tot_frame;         
    int32 n_hmm_eval;          
    int32 n_sen_eval;          
    /* Backtrace information */
    blkarray_list_t *history;     
    /* Hypothesis DAG */
    glist_t segments;

    ptmr_t perf; 
} allphone_search_t;

ps_search_t *allphone_search_init(const char *name,
                                  ngram_model_t * lm,
                                  cmd_ln_t * config,
                                  acmod_t * acmod,
                                  dict_t * dict, dict2pid_t * d2p);

void allphone_search_free(ps_search_t * search);

int allphone_search_reinit(ps_search_t * search, dict_t * dict,
                           dict2pid_t * d2p);

int allphone_search_start(ps_search_t * search);

int allphone_search_step(ps_search_t * search, int frame_idx);

int allphone_search_finish(ps_search_t * search);

char const *allphone_search_hyp(ps_search_t * search, int32 * out_score);

#endif                          /* __ALLPHONE_SEARCH_H__ */