auxqhist_rec.3

speech signal process tools

.\" Copyright (c) 1987 Entropic Speech, Inc.; All rights reserved
.\" @(#)auxqhist_rec.3	1.1 8/7/87 ESI
.TH AUXQHIST_REC 3\-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
allo_auxqhist_rec \- allocate memory for auxiliary portion of an expanded
ESPS FEA_QHIST file record.
.br
init_auxqhist_hd \- initialize an expanded FEA file header for subtype FEA_QHIST.
.SH SYNOPSIS
.ft B
.nf
#include <esps/esps.h>
#include <esps/fea.h>
#include <esps/feaqhist.h>
#include <esps/feahuff.h>

struct auxqhist *
allo_auxqhist_rec( hd, p )
struct header *hd;
struct feaqhist *p;

int
init_auxqhist_hd( hd )
struct header *hd;
.fi
.ft
.SH DESCRIPTION
\fIAllo_auxqhist_rec\fR allocates memory for the auxiliary portion of an
expanded FEA_QHIST file record and returns a pointer to it. The memory
allocations assume that the header was initialized by a call to
\fIinit_auxqhist_hd\fR. Because the size of the allocated record
depends on values in the data file header, it is important to ensure that
an expanded FEA_QHIST record is consistent with the header of the file it
is being used with [see \fIinit_auxqhist_hd\fR]. Internally,
\fIallo_auxqhist_rec\fR hooks the FEA record up to an \fIauxqhist\fR struct.
.PP
\fIInit_auxqhist_hd\fR accepts a pointer \fIhd\fR to an ESPS FEA file header. It
initializes the record-field definitions to describe the auxiliary fields that
make up an expanded file of subtype FEA_QHIST. It does this by means of calls to
\fIadd_fea_fld\fR (3\-ESPS). For a description of the expanded FEA_QHIST record
fields, see \fIaux_qhist\fR (5\-ESPS). \fIInit_auxqhist_hd\fR returns 1 if any of
the internal calls to \fIadd_fea_fld\fR (3\-ESPS) return an error code; otherwise,
it returns 0. \fIInit_auxqhist_hd\fR should be called only when creating a new
expanded FEA_QHIST file, after the call to \fInew_header\fR (3\-ESPS), or
\fIcopy_header\fR (3\-ESPS).
.SH EXAMPLES
.if n .ta 33
.if t .ta 3i
.nf
\fB\s-1Reading an existing file:\s+1\fR

FILE *ifp;
struct auxqhist *auxqhist_rec;
struct feaqhist *feaqhist_rec;
struct header *ih;

ih = read_header( ifp );
feaqhist_rec = allo_feaqhist_rec( ih );
auxqhist_rec = allo_auxqhist_rec( ih, feaqhist_rec );
if ( get_feaqhist_rec( feaqhist_rec, ih, ifp ) == EOF ) . . .

c = *auxqhist_rec\->code;

\fB\s-1Creating a new file:\s+1\fR

FILE *ifp;
FILE *ofp;
struct auxqhist *auxqhist_rec;
struct feaqhist *feaqhist_rec;
struct header *ih;
struct header *oh;

ih = read_header( ifp );
oh = copy_header( ih );
if ( init_auxqhist_hd( oh ) )
    ERROR_EXIT( "error filling expanded FEA_QHIST header" );
 . . .
write_header( oh, ofp );
feaqhist_rec = allo_feaqhist_rec( oh );
auxqhist_rec = allo_auxqhist_rec( oh, feaqhist_rec );
 . . .
*auxqhist_rec\->code = c;
put_feaqhist_rec( feaqhist_rec, oh, ofp );
.fi
.PP
In both of these examples, notice that the FEA_QHIST read and write
routines, \fIget_feaqhist_rec\fR (3\-ESPS) and \fIput_feaqhist_rec\fR
(3\-ESPS), implicitly perform the I/O for the auxiliary data \- no
separate routines are needed.
.SH DIAGNOSTICS
If \fIhd\fR does not point to a FEA header of subtype FEA_QHIST, the
program terminates with an assertion failure.  
.SH BUGS
None known.
.SH SEE ALSO
allo_feaqhist_rec (3\-ESPS), init_feaqhist_hd (3\-ESPS), aux_qhist (5\-ESPS),
fea_qhist (5\-ESPS).
.SH AUTHOR
Programs and manual page by Jim Elliott.