history.prme

speech signal process tools

a particular built-in file type are described in the manual page for
that file type in Section 5 of the ESPS Manual.  For example, see SD
(5\-\s-1ESPS\s+1) for the type-specific header definition for
sampled-data files.  For FEA files and FEA subtypes, the type-specific
section contains the self-description information \- the names, types,
and sizes of the record fields defined in the file.
.pp
The output from \fIpsps\fP will include the type-specific header (in
addition to the universal header) if the \fB\-l\fP (for "long") option
is used.  For example, here is the header for the file signal.sd
(produced as part of \fIspecdemo\fP:
.nf
.ft CW
     %psps -l signal.sd
     File: signal.sd

     ---Universal Part of Header---
     File type: FEA (Feature File)
     File header date: Tue Mar 20 14:37:06 1990 , header version: 1.73
     Produced by: addsd, version: 3.12, of: 2/19/90, user: burton
     Hostname:path: epiwrl:/u2/burton/esps/doc
     Machine type: Masscomp; file is in NATIVE format.
     Number of data records: 8000
     Data is not tagged.
     comment text:
      addsd gauss.sd sines.sd signal.sd 
        Added samples from sines.sd to samples 1 - 8000 of gauss.sd.
     Source files: gauss.sd
                   sines.sd
     There is no reference header.
     
     ---Type Specific Part of Header (FEA)---
     fea_type: FEA_SD, segment_labeled: NO, field_count: 1
     
     ---Generic Part of Header---
     record_freq:  20000 
     start_time:  0 

.ft LR
.fi
The generic part of the header is explained in the next section. 
Notice that non-numeric quantities are printed symbolically 
(e.g., NO instead of something like "type 0"). 
.pp
For FEA files, the \fB-l\fP option on \fIpsps\fP shows the
FEA subtype (if any), whether or not the file is segment labelled, and the
number of fields.  Here is an example using the FEA_SPEC file
signal.spec from \fIspecdemo\fP:  
.nf
.ft CW

    %psps -l signal.spec
    File: signal.spec

    ---Universal Part of Header---
    File type: FEA (Feature File)
    File header date: Fri Jan  6 11:11:22 1989 , header version: 1.66
    Produced by: me_spec, version: 1.4, of: 12/13/88, user: shore
    Hostname:path: epiwrl:/u2/shore/epi/esps/doc/demo
    Number of data records: 1
    Data is  tagged.
    refer file: signal.sd
    comment text:
    me_spec signal.rc signal.spec 
    Source files: signal.rc
    There is no reference header.

    ---Type Specific Part of Header (FEA)---
    fea_type: FEA_SPEC, segment_labeled: NO, field_count: 3

    ---Generic Part of Header---
    contin:  YES 
    frame_meth:  FIXED 
    freq_format:  SYM_EDGE 
    frmlen:  2500 
    num_freqs:  513 
    order_unvcd:  100 
    order_vcd:  0 
    record_freq:  8 
    sf:  20000 
    spec_type:  DB 
    src_sf:  20000 
    start:  1 
    start_time: 

.ft LR
.fi
The generic part of the header is explained in the next section. 
Notice, however, that non-numeric quantities are printed symbolically 
(e.g., SYM_EDGE instead of something like "type 3").  Again, 
the meanings of these items are described in the relevant 
Section 5 man page, in this case FEA_SPEC (5\-\s-1ESPS\s+1).  
.pp
If detailed information is needed about the field definitions for FEA
files, the \fB-v\fP should be used on \fIpsps\fP.  This expands the
type-specific portion of the FEA header to show the names, types, and
sizes of the defined fields.  For CODED fields, the possible symbolic
values are shown.  The \fB-v\fP also gives the same details for the
generic header items.
.nf
.ft CW

    %psps -v signal.spec
    File: signal.spec

    ---Universal Part of Header---
    File type: FEA (Feature File)
    File header date: Fri Jan  6 11:11:22 1989 , header version: 1.66
    Produced by: me_spec, version: 1.4, of: 12/13/88, user: shore
    Hostname:path: epiwrl:/u2/shore/epi/esps/doc/demo
    Number of data records: 1
    Data is  tagged.
    Data format is 0 doubles, 514 floats, 0 longs,
    1 shorts, and 0 chars (bytes).
    refer file: signal.sd
    comment text:
    me_spec signal.rc signal.spec 
    Source files: signal.rc
    There is no reference header.

    ---Type Specific Part of Header (FEA)---
    fea_type: FEA_SPEC, segment_labeled: NO, field_count: 3
    Item name: tot_power, type: FLOAT, size: 1
    Item name: re_spec_val, type: FLOAT, size: 513, rank: 1
    Item name: voiced, type: CODED, size: 1
    Possible coded values:
    NO
    YES

    ---Generic Part of Header---
    contin: (CODED) YES 
    Possible coded values:
    NO
    YES
    frame_meth: (CODED) FIXED 
    Possible coded values:
    NONE
    FIXED
    VARIABLE
    freq_format: (CODED) SYM_EDGE 
    Possible coded values:
    NONE
    SYM_CTR
    SYM_EDGE
    ASYM_CTR
    ASYM_EDGE
    ARB_VAR
    ARB_FIXED
    frmlen: (LONG) 2500 
    num_freqs: (LONG) 513 
    order_unvcd: (LONG) 100 
    order_vcd: (LONG) 0 
    record_freq: (DOUBLE) 8 
    sf: (FLOAT) 20000 
    spec_type: (CODED) DB 
    Possible coded values:
    NONE
    PWR
    DB
    REAL
    CPLX
    src_sf: (DOUBLE) 20000 
    start: (LONG) 1 
    start_time: (DOUBLE) 0.0625 

.ft LR
.fi
.sh 2 "Generic Header Items"
.pp
The pre-defined items in the universal and type-specific header
sections are intended to be useful in a broad range of typical
applications.  However, they cannot anticipate every application, so
ESPS provides a mechanism by which programs can store additional,
arbitrarily named items in any ESPS header; these are called generic
header items.  Like other header items, the values in generic header
items are available (by name) to programs that process the files.
.pp
For example, \fItestsd\fP can produce several types of test
sampled-data (sine waves, noise, or pulses), and it is useful 
to record in the output header which of these was chosen.  
Since the standard FEA_SD type-specific header has no provision for
this (which would be silly, as the list of possibly useful
items would be endless), a generic header-item is used.  
.pp
Generic header items are output by \fIpsps\fP when the \fB\-l\fP option is
used.  (Thus, this option yields the universal header, the type-specific
header, and the generics.)  Here, for example, is the complete header of
sine1.sd (from \fIspecdemo\fP):
.nf
.ft CW

    %psps -Dl sine1.sd
    File: sine1.sd

    ---Universal Part of Header---
    File type: FEA (Feature File)
    File header date: Tue Mar 20 14:36:48 1990 , header version: 1.71
    Produced by: testsd, version: 3.12, of: 10/17/89, user: burton
    Hostname:path: epiwrl:/u2/burton/esps/doc
    Machine type: Masscomp; file is in NATIVE format.
    Number of data records: 8000
    Data is not tagged.
    comment text:
     testsd -Tsine -f600 -r20000 sine1.sd 
    There is no reference header.
    
    ---Type Specific Part of Header (FEA)---
    fea_type: FEA_SD, segment_labeled: NO, field_count: 1
    
    ---Generic Part of Header---
    frequency:  600 
    level:  500 
    max_value:  500 
    phase:  0 
    record_freq:  20000 
    start_time:  0 
    test_type:  SINE 

.ft LR
.fi
Although in this case the type of test signal can be 
deduced from the command line in the comment field, it is 
not always so obvious (the default might be used).  Besides, 
a program that processes sine1.sd can obtain the 
test type by means of a simple library call, rather than 
having to do elaborate string processing on the comment field. 
.sh 3 "Adding Generic Header Items at the User Level"
.pp
The program \fIaddgen\fP (1\-\s-1ESPS\s+1) allows users to add
to add generic header items to existing ESPS files (analogous
to the use of \fIcomment\fP in adding to the comment field).  This can 
be useful as an alternative form of informal record record
keeping, and as a means of inserting values that may not be present 
but are needed by other programs that are to be run subsequently on 
the file.  For example, suppose one wants to insert a header item 
in the file signal.sd to record the signal to noise ratio (which is 
1.0).  Here's the appropriate call to \fIaddgen\fP:
.nf
.ft CW

    %addgen -g sn_ratio -v float -v 1.0 signal.sd

.ft LR
.lp
An alternative is to use the \fIeparam\fP (1\-\s-1ESPS\s+1) to 
provide an interactive interface:
.nf
.ft CW

    %eparam addgen signal.sd
    Name of new generic header item [item1]: sn_ratio
    Type of new generic header item [long]: float
    Value of new generic header item [1000.000000]: 1.0

.ft LR
.lp
Here, each of the three lines following the \fIeparam\fP call has a
prompt (with default) output by \fIeparam\fP with the the user's input
following the colon.  After adding a generic header item in this way,
it will be reflected in subsequent \fIpsps\fP listings:
.nf
.ft CW

    %psps -Dl signal.sd
    File: signal.sd

    ---Universal Part of Header---
    File type: FEA (Feature File)
    File header date: Tue Mar 20 14:37:06 1990 , header version: 1.73
    Produced by: addsd, version: 3.12, of: 2/19/90, user: burton
    Hostname:path: epiwrl:/u2/burton/esps/doc
    Machine type: Masscomp; file is in NATIVE format.
    Number of data records: 8000
    Data is not tagged.
    comment text:
     addsd gauss.sd sines.sd signal.sd 
       Added samples from sines.sd to samples 1 - 8000 of gauss.sd.
     added generic "sn_ratio" on Tue Mar 20 14:58:46 1990
    Source files: gauss.sd
                  sines.sd
    There is no reference header.
    
    ---Type Specific Part of Header (FEA)---
    fea_type: FEA_SD, segment_labeled: NO, field_count: 1
    
    ---Generic Part of Header---
    record_freq:  20000 
    sn_ratio:  1 
    start_time:  0 
    
.ft LR
.lp
Besides floats, \fIaddgen\fP supports double precision, long integer,
short integer, and string header items.  It also supports two special
data types that link the header to ESPS headers and ASCII files stored
separates.  We discuss these next.
.sh 3 "External Headers and Files"
.pp
It is sometimes convenient to associate a parameter set with an ESPS
file without storing the parameters within the header.  For example, a
large database of speech files could have a common set of parameters
that document aspects of the data collection.  While it would be
wasteful to store this information in every file, it's important that
it be readily available not only for visual inspection, but also for
access by programs.  ESPS meets this need with generic header items of
type EFILE.  \fIPsps\fP has a special option (\fB-e\fP), which causes
it to follow EFILE references and to display the corresponding 
ESPS headers.  This will work even if the file is located on a 
different machine.  
.lp
For example, suppose there is a header-only ESPS file on host episun
containing a few common parameters:
.nf
.ft CW

    %rsh episun psps -l /usr/u/shore/com_params

    File: com_params

    ---Universal Part of Header---
    File type: FEA (Feature File)
    File header date: Wed Aug 10 17:38:33 1988 , header version: 1.61
    Produced by: addgen, version: 3.2, of: 9/9/88, user: shore
    Hostname:path: episun:/usr/u/shore
    Number of data records: 0
    Data is not tagged.
    comment text:
    added generic "background" on Wed Aug 10 17:37:23 1988
    added generic "microphone" on Wed Aug 10 17:38:11 1988
    added generic "filter_cutoff" on Wed Aug 10 17:38:33 1988
    There is no reference header.

    ---Type Specific Part of Header (FEA)---
    fea_type: NONE, segment_labeled: NO, field_count: 1

    ---Generic Part of Header---
    background[0]:  office noise
    filter_cutoff:  3900 
    microphone[0]:  carbon handset

.ft LR
.lp
We can link this in using \fIaddgen\fP:
.ft CW

    %eparam addgen speech.fana 
    Name of new generic header item [item1]: collection_params
    Type of new generic header item [long]: efile
    Value of new generic header item [TEST]: sun:/usr/u/shore/com_params

.lp
Without the \fB-e\fP option, \fIpsps\fP just shows the reference 
file name:
.nf
.ft CW

    %psps -lD speech.fana
    File: speech.fana

    ---Universal Part of Header---
    File type: FEA (Feature File)
    File header date: Wed Aug 10 17:23:52 1988 , header version: 1.61
    Produced by: refcof, version: 3.6, of: 5/24/88, user: shore
    Hostname:path: epiwrl:/usr/edemos/demo
    Number of data records: 167
    Data is  tagged.
    refer file: speech.sd
    comment text:
    refcof -P/u2/esps3/lib/Prefcof speech.sd speech.nw.spec 
    added generic "collection_params" on Wed Aug 10 17:23:52 1988
    Source files: speech.sd
    There is no reference header.

    ---Type Specific Part of Header (FEA)---
    fea_type: FEA_ANA, segment_labeled: NO, field_count: 8

    ---Generic Part of Header---
    DC_removed:  NO 
    collection_params:  sun:/usr/u/shore/com_params
    filters:  NO 
    frmlen:  160 
    maxlpc:  1 
    maxpulses:  1 
    maxraw:  1 
    method:  AUTOC 
    nan:  13421 
    order:  12 
    order_unvcd:  12 
    order_vcd:  0 
    spec_rep:  RC 
    src_sf:  8000 
    start:  1 
    step:  80 
    window_type:  WT_HAMMING 

.ft LR
.lp
However, if the \fB-e\fP option is used, \fIpsps\fP follows the 
reference (across the network if necessary) and displays the 
contents:  
.nf
.ft CW

    %psps -e speech.fana
    File: speech.fana

    ---Universal Part of Header---
    File type: FEA (Feature File)
    File header date: Wed Aug 10 17:23:52 1988 , header version: 1.61
    Produced by: refcof, version: 3.6, of: 5/24/88, user: shore
    Hostname:path: epiwrl:/usr/edemos/demo
    Number of data records: 167
    Data is  tagged.
    refer file: speech.sd
    comment text:
    refcof -P/u2/esps3/lib/Prefcof speech.sd speech.nw.spec 
    added generic "collection_params" on Wed Aug 10 17:23:52 1988
    Source files: speech.sd
    There is no reference header.

    ---Type Specific Part of Header (FEA)---
    fea_type: FEA_ANA, segment_labeled: NO, field_count: 8

    ---Generic Part of Header---
    DC_removed:  NO 
    collection_params:  External EFILE  File: sun:/usr/u/shore/com_params

       ---Universal Part of Header---
       File type: FEA (Feature File)
       File header date: Wed Aug 10 17:38:33 1988 , header version: 1.61
       Produced by: addgen, version: 3.2, of: 9/9/88, user: shore
       Hostname:path: sun:/usr/u/shore
       Number of data records: 0
       Data is not tagged.
       comment text:
       added generic "background" on Wed Aug 10 17:37:23 1988
       added generic "microphone" on Wed Aug 10 17:38:11 1988
       added generic "filter_cutoff" on Wed Aug 10 17:38:33 1988
       There is no reference header.

       ---Type Specific Part of Header (FEA)---
       fea_type: NONE, segment_labeled: NO, field_count: 1

       ---Generic Part of Header---
       background[0]:  office noise 
       filter_cutoff:  3900 
       microphone[0]:  carbon handset 

    filters:  NO 
    frmlen:  160 
    maxlpc:  1 
    maxpulses:  1 
    maxraw:  1 
    method:  AUTOC 
    nan:  13421 
    order:  12 
    order_unvcd:  12 
    order_vcd:  0 
    spec_rep:  RC