fea_qhist.5t

speech signal process tools

.\" Copyright (c) 1987 Entropic Speech, Inc.; All rights reserved
.\" @(#)fea_qhist.5t	1.1 8/7/87 ESI
.TH FEA_QHIST 5\-ESPS 8/7/87
.ds ]W "\fI\s+4\ze\h'0.05'e\s-4\v'-0.4m'\fP\(*p\v'0.4m'\ Entropic Speech, Inc.
.ds ]Y "\fBESI INTERNAL\fP
.SH NAME
ESPS histogram feature file subtype \- FEA_QHIST.
.SH SYNOPSIS
.nf
.ft B
#include <esps/esps.h>
#include <esps/fea.h>
#include <esps/feaqhist.h>
.fi
.SH DESCRIPTION
.PP
The FEA_QHIST file is a subtype of the FEA file. If \fIhd\fR is a pointer to
the header of such a file, then \fIhd\->hd.fea\->fea_type\fR == FEA_QHIST.
Such files are created by calling \fIinit_feaqhist_hd\fR (3\-ESPS) after 
\fInew_header\fR (3\-ESPS).  
.PP
The header for a FEA_QHIST file consists of the following generic header items:
.PP
.TS
center, box, tab(;);
c | c | c | c
l | l | l | l.
Name;Size;Type;Enums
=
comb_frq;1;coded;NO,YES
comb_vcg;1;coded;NO,YES
cont_pwr;1;coded;NO,YES
cont_spc;1;coded;NO,YES
.TE
.PP
The generic header items have the following meanings:
.IP comb_frq
Specifies whether or not the histogram data for different LSP center and
offset frequency indices have been combined.
.IP comb_vcg
Specifies whether or not the histogram data for voiced and unvoiced frames
have been combined.
.IP cont_pwr
Indicates whether or not differences in power indices are taken continuously
upon voicing transitions.
.IP cont_spc
Indicates whether or not differences in spectral indices are taken on an
interframe or intraframe basis, upon voicing transitions.
.PP
The header of a FEA_QHIST file also contains definitions for the record fields,
as given by the following table:
.PP
.TS
center, box, tab(;);
c | c | c | c | c | c 
l | l | l | l | l | l.
Name;Size;Rank;Dimen;Type;Enums
=
hist_type;1;0;NULL;short;\fIhist_types\fR
data_type;1;0;NULL;short;\fIdata_types\fR
value;1;0;NULL;short;NULL
count;1;0;NULL;short;NULL
.TE
.PP
In the above table, \fIhist_types\fR and \fIdata_types\fR are arrays of the
possible values the respective fields \fIhist_type\fP and \fIdata_type\fR
can take. These are defined in the FEA_QHIST library support module
\fIfeaqhistsupp.c\fP. See \fIfea\fR (5\-ESPS) for additional information on
the meaning of the table columns.
.PP
In most cases, programs that deal with FEA_QHIST files will use the support
routines provided in the ESPS library and will not have to make direct use
of the information in the above tables. The library routine \fIinit_feaqhist_hd\fR
(3\-ESPS) creates the record fields and the generic header items.
.PP
Programs that deal with FEA_QHIST files do so in terms of structures of type
\fIstruct feaqhist\fR \- pointers to structures of this type are returned by 
\fIallo_feaqhist_rec\fR (3\-ESPS); the FEA_QHIST read and write routines,
\fIget_feaqhist_rec\fR (3\-ESPS) and \fIput_feaqhist_rec\fP (3\-ESPS), have
parameters of type \fIstruct feaqhist\fR. The definition of the \fIfeaqhist\fR
data structure is given in \fI<esps/feaqhist.h>\fR, and is repeated here:
.nf
.ta .5i 1i 1.75i

    struct feaqhist
    {
        short	*hist_type;
        short	*data_type;
        short	*value;
        short	*count;

        struct fea_data	*fea_rec;
    };

.fi
.PP
The record fields have the following meanings:
.IP hist_type
Classification of the type of histogram. A particular histogram will have
multiple records with the same value of \fIhist_type\fR. Numerical values
are defined in \fIfeaqhist.h\fR, with corresponding strings defined in
\fIfeaqhistsupp.c\fR. Typical values are: POWER, LENGTH, SPEC_INTRA,
SPEC_INTER.
.IP data_type
Classification of the type of datum corresponding to a particular record.
Within the set of records corresponding to a given \fIhist_type\fR, the
value of \fIdata_type\fR may vary from one record to another. Numerical
values are defined in \fIfeaqhist.h\fR, with corresponding strings defined
in \fIfeaqhistsupp.c\fR. Currently supported values are: AMP_DIFF, AMP_ESC.
.IP value
.br
Gives the numerical value of the \fIdata_type\fR associated with a given
record, e.g., a difference of 2 between successive pulse power indices
corresponds to that record having \fIvalue\fR == 2 in the histogram with
\fIhist_type\fR == POWER.
.IP count
.br
Gives the number of occurrences of \fIvalue\fR in a particular histogram.
.IP fea_rec
This is a pointer to the FEA file record in which all the FEA_QHIST
information is stored. Programs should not use this value directly.
.SH SEE ALSO
allo_feaqhist_rec (3\-ESPS), get_feaqhist_rec (3\-ESPS), get_genhd (3\-ESPS),
init_feaqhist_hd (3\-ESPS), put_feaqhist_rec(3\-ESPS), esps (5\-ESPS),
fea (5\-ESPS).
.SH RECORD ELEMENT FILE STRUCTURE
In order to use this (or any other) FEA file type with a generic ESPS program
(one that operates a file of arbitrary type) it is necessary to know the
manner in which record elements are positioned in the file. For a FEA file,
this information can be obtained by running the program \fIfea_element\fR
(1\-ESPS) on the file in question.
.SH FILES
.nf
/usr/include/esps/esps.h
/usr/include/esps/fea.h
/usr/include/esps/feaqhist.h
.SH AUTHOR
Manual page by Jim Elliott.