aux_ana.5t

speech signal process tools

.\" Copyright (c) 1987 Entropic Speech, Inc.; All rights reserved
.\" @(#)aux_ana.5t	1.1 8/7/87 ESI
.TH AUX_ANA 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
Extension to ESPS histogram feature file subtype \- AUX_ANA.
.SH SYNOPSIS
.nf
.ft B
#include <esps/esps.h>
#include <esps/fea.h>
#include <esps/anafea.h>
#include <esps/feaquant.h>
.fi
.SH DESCRIPTION
.PP
The AUX_ANA file is an extension of the FEA_ANA 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_ANA. Such files are created by first
setting up the standard FEA_ANA header [see \fIfea_ana\fR (5\-ESPS)], and
then calling \fIinit_auxana_hd\fR (3\-ESPS).
.PP
The generic header items in an AUX_ANA file are identical to those in a
FEA_ANA file [see \fIfea_ana\fR (5\-ESPS)].
.PP
The header of an AUX_ANA file also contains definitions for the auxiliary
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
=
raw_power_idx;\fImaxraw\fR;1;NULL;short;NULL
pulse_len_idx;\fImaxpulses\fR;1;NULL;short;NULL
spec_param_idx;MAX(\fIorder_unvcd, order_vcd\fR);1;NULL;short;NULL
.TE
.PP
See \fIfea\fR (5\-ESPS) for additional information on the meaning of the
table columns, and \fIfea_ana\fR (5\-ESPS) for the definitions of the
size parameters.
.PP
In most cases, programs that deal with AUX_ANA 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 table. The library routine \fIinit_auxana_hd\fR
(3\-ESPS) creates the record fields.
.PP
Programs that deal with the auxiliary record fields in AUX_ANA files do so
in terms of structures of type \fIstruct auxana\fR \- pointers to structures
of this type are returned by \fIallo_auxana_rec\fR (3\-ESPS). The FEA_ANA
read and write routines, \fIget_anafea_rec\fR (3\-ESPS) and \fIput_anafea_rec\fP
(3\-ESPS), implicitly perform the I/O for the auxiliary data \- no separate
routines are needed.
.PP
The definition of the \fIauxana\fR data structure is given in \fI<esps/feaquant.h>\fR,
and is repeated here:
.nf
.ta .5i 1i 1.75i

    struct auxana
    {
        short	*raw_power_idx;
        short	*pulse_len_idx;
        short	*spec_param_idx;
    };

.fi
.PP
The auxiliary record fields have the following meanings:
.IP raw_power_idx
Quantization indices for raw power. In a voiced frame, the first \fInum_pulses\fR
values are significant, starting with \fIraw_power_idx[0]\fR, where \fInum_pulses\fR
is the number of pulses in the frame [see \fIfea_ana\fR (5\-ESPS)]. In an unvoiced
frame, only \fIraw_power_idx[0]\fR is significant.
.IP pulse_len_idx
Quantization indices for pulse length (voiced frames), or frame length (unvoiced
frames). In a voiced frame, the first \fInum_pulses\fR values are significant,
starting with \fIpulse_len_idx[0]\fR, where \fInum_pulses\fR is the number of
pulses in the frame [see \fIfea_ana\fR (5\-ESPS)]. In an unvoiced frame, only
\fIpulse_len_idx[0]\fR is significant.
.IP spec_param_idx
Quantization indices for spectral parameters. In an unvoiced frame, the first
\fIorder_unvcd\fR values are significant, starting with \fIspec_param_idx[0]\fR.
In a voiced frame, the first \fIorder_vcd\fR values are significant. Here,
\fIorder_unvcd\fR and \fIorder_vcd\fR are the respective analysis orders for
unvoiced and voiced frames [see \fIfea_ana\fR (5\-ESPS)].
.SH SEE ALSO
allo_auxana_rec (3\-ESPS), allo_anafea_rec (3\-ESPS), init_auxana_hd (3\-ESPS),
fea_ana (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/anafea.h
/usr/include/esps/feaquant.h
.SH AUTHOR
Manual page by Jim Elliott.