aux_qhist.5t

speech signal process tools

.\" Copyright (c) 1987 Entropic Speech, Inc.; All rights reserved
.\" @(#)aux_qhist.5t	1.1 8/7/87 ESI
.TH AUX_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
Extension to ESPS histogram feature file subtype \- AUX_QHIST.
.SH SYNOPSIS
.nf
.ft B
#include <esps/esps.h>
#include <esps/fea.h>
#include <esps/feaqhist.h>
#include <esps/feahuff.h>
.fi
.SH DESCRIPTION
.PP
The AUX_QHIST file is an extension of the FEA_QHIST 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 first
setting up the standard FEA_QHIST header [see \fIfea_qhist\fR (5\-ESPS)], and
then calling \fIinit_auxqhist_hd\fR (3\-ESPS).
.PP
The generic header items in an AUX_QHIST file are identical to those in a
FEA_QHIST file [see \fIfea_qhist\fR (5\-ESPS)].
.PP
The header of an AUX_QHIST 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
=
code;1;0;NULL;long;NULL
length;1;0;NULL;long;NULL
.TE
.PP
See \fIfea\fR (5\-ESPS) for additional information on the meaning of the
table columns.
.PP
In most cases, programs that deal with AUX_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 table. The library routine \fIinit_auxqhist_hd\fR
(3\-ESPS) creates the record fields.
.PP
Programs that deal with the auxiliary record fields in AUX_QHIST files do so
in terms of structures of type \fIstruct auxqhist\fR \- pointers to structures
of this type are returned by \fIallo_auxqhist_rec\fR (3\-ESPS). The FEA_QHIST
read and write routines, \fIget_feaqhist_rec\fR (3\-ESPS) and \fIput_feaqhist_rec\fP
(3\-ESPS), implicitly perform the I/O for the auxiliary data \- no separate
routines are needed.
.PP
The definition of the \fIauxqhist\fR data structure is given in \fI<esps/feahuff.h>\fR,
and is repeated here:
.nf
.ta .5i 1i 1.75i

    struct auxqhist
    {
        long	*code;
        long	*length;
    };

.fi
.PP
The auxiliary record fields have the following meanings:
.IP code
.br
Numerical value of the Huffman code for the associated histogram record.
.IP length
.br
Length (in bits), including leading zeros, of the Huffman code for the
associated histogram record. For example, code == 10, length == 6
corresponds to the bit pattern 001010.
.SH SEE ALSO
allo_auxqhist_rec (3\-ESPS), allo_feaqhist_rec (3\-ESPS), init_auxqhist_hd (3\-ESPS),
fea_qhist (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
/usr/include/esps/feahuff.h
.SH AUTHOR
Manual page by Jim Elliott.