guide.doc

speech signal process tools

                         ENTROPIC RESEARCH LABORATORY, INC.


       TECHNICAL MEMORANDUM

       SUBJECT: Entropic Signal Processing System (ESPS) Programming Guidelines

       ID: ETM-S-86-14

       VERSION: 3.6

       DATE: 1/22/93

       AUTHOR: Joe Buck, Alan Parker, and John Shore

       LAST REVISED BY: Rodney Johnson

       REFERENCES:

        [1] ETM-S-86-13:rap/jtb, Data Files in the Entropic Signal Processing
            System (ESPS)

        [2] ETM-S-86-12:jtb, Parameter and Common Files in ESPS

        [3] ETM-S-86-25:rap, Guidelines for Implementing  ESPS  Feature  File
            Subtypes

        [4] ESPS Users Manual

        [5] J. Shore and R. Parker, Introduction to the Entropic Signal  Pro-
            cessing System (ESPS)

        [6] ETM-S-89-49:rwj, FEA_SD files---Feature Files for Sampled Data in
            ESPS

       1 .  Introduction

       This document describes various programming conventions and guidelines
       for the Entropic Signal Processing  System  (ESPS).  Readers  of  this
       document  should  also  read  [1-3].   A  general familiarity with the
       reference manual [4] is also assumed.  For a general  introduction  to
       ESPS, see [5].

       This document describes the command  line  format  of  ESPS  programs,
       internal program structure, programming conventions, and the organiza-
       tion of the ESPS directory tree.


       ____________________

          Copyright  (c)  1987-1990  Entropic  Speech,  Inc.   Copyright  (c)
       1990-1993 Entropic Research Laboratory, Inc.  All rights reserved.











       ETM-S-86-14                                                     page 2


       2 .  Directory Structure

       The ESPS distribution comprises a directory tree.  In release  4.0  of
       ESPS,  the  root  directory  (or a link to it) had to be at /usr/esps.
       With release 4.1, ESPS has been made position independent (see  "Posi-
       tion Independence" below):  the root can be put anywhere, and programs
       that need to locate files in the directory tree find the root location
       in  the environment variable "ESPS_BASE".  Therefore, in what follows,
       the root directory is denoted by "$ESPS_BASE".  Here is  a  sketch  of
       the ESPS directory tree:













































       Version 3.6                      ERL                           1/22/93







       ETM-S-86-14                                                     page 3


                          |-32bin
                          |-32cbin
                          |-bin
                          |-demo         |-doc
                          |-doc          |-h
                          |              |-lib
                          |              |              |-man1
                          |-general------|-man----------|-man3
                          |              |              |-man5
                          |              |
                          |              |              |-lib
                          |              |              |-lib_header
                          |              |              |-lib_sp
                          |              |-src----------|-libxv
                          |                             |-misc
                          |                             |-prog1
                          |-include------|-esps         |-prog2
                          |              |-xview        |-prog...
                          |                             |-progN
                          |              |-colormaps
                          |              |-filters
                          |              |-keys
           |-$ESPS_BASE---|-lib----------|-lisp
                          |              |-maclib
                          |              |-menus
                          |              |-params
                          |              |-waves
                          |
                          |              |-cat1
                          |              |-cat3
                          |-man----------|-cat5
                          |              |-man1
                          |              |-man3
                          |              |-man5
                          |
                          |              |-demo3d
                          |              |-filterdemo
                          |              |-sounds
                          |-newdemos-----|-testsignal
                          |              |-timitdemo
                          |              |-tryme
                          |              |-wintro
                          |
                          |              |-shellforms
                          |              |-tek2ps
                          |-pub----------|-tpipe
                          |              |-xgrabsc
                          |              |-xloadimage
                          |                             |-cross_cor
                          |-src_examples-|-esps---------|-lib
                          |              |              |-sgram
                          |              |
                          |              |-waves--------|-spectrum


       Version 3.6                      ERL                           1/22/93







       ETM-S-86-14                                                     page 4


                          |
                          |-xview--------|-fonts


       The following are brief descriptions  of  the  main  ESPS  directories
       under $ESPS_BASE.

       32bin:
            Binary code for the AT&T DSP32 board ("Fab 2 Board").

       32cbin:
            Binary code for the AT&T DSP32C board ("Surfboard").

       bin: Executable programs  in  the  general  release.   This  directory
            should be added to ESPS users' paths.

       demo:
            Shell scripts and data files for various ESPS demos.

       doc: ESPS documents, such as this one, describing features of ESPS  as
            a whole.

       general:
            The root of a tree containing  sources  for  programs  and  other
            files elsewhere in the ESPS hierarchy.

       general/src:
            Source directory for programs and library functions.  This direc-
            tory  has subdirectories for all major programs.  The source code
            stored here is SCCS get versions.  The SCCS directories are main-
            tained  elsewhere.   Files in this directory should be read-only.
            Source  for  a  few  simple  (one-module)  ESPS  programs  is  in
            general/src/misc.     Source   for   library   routines   is   in
            general/src/lib, general/src/lib_sp, general/src/lib_header,  and
            general/src/libxv.

       general/h:
            Include files---sources for $ESPS_BASE/include/esps.

       general/doc:
            Sources for $ESPS_BASE/doc.  Both source files (for  nroff/troff)
            and ASCII document files should be stored in this directory.

       general/lib:
            Public ESPS files.

       general/man:
            Sources for $ESPS_BASE/man.  Most of the manual page sources  for
            Section  1  programs are not here, but are in the individual sub-
            directories of general/src.

       include:
            Include  files  for  ESPS  source  programs.    There   are   two


       Version 3.6                      ERL                           1/22/93







       ETM-S-86-14                                                     page 5


            subdirectories.

       include/esps
            Include files for functions that read or write  ESPS  files,  use
            ESPS  data  types,  or  call  ESPS library functions.  (See "ESPS
            Include Files and Library Functions" below).

       include/xview
            Sun include files for programs that use the XView toolkit.

       lib: The location of public ESPS files.  This is the location for  the
            ESPS binary libraries.

       lib/colormaps
            Some 16-entry colormap files for use with image(1-EPSP).

       lib/filters
            Filters (FEA_FILT files).

       lib/keys
            License key  files  created  by  elmadmin(1-ESPS)  when  Entropic
            license are installed.

       lib/lisp
            Lisp files for GNU emacs support of ESPS programming; in particu-
            lar,  the  file  lib/lisp/esps.el  contains  definitions  of  the
            interactive functions "eman" and "echeck"---these facilitate cal-
            ling  the  ESPS  programs  eman(1-ESPS)  and echeck (1-ESPS) from
            within GNU emacs.

       lib/maclib
            Mock-lisp files for Unipress emacs support of ESPS programming.

       lib/menus
            Menu files in  olwm/sunview  format  used  by  programs  such  as
            fbuttons(1-ESPS) and mbuttons(1-ESPS).

       lib/params
            Default parameter files of ESPS programs.

       lib/waves
            Library   files    and    subdirectories    specific    to    the
            waves+/xwaves+(1-ESPS) programs.

       man: The root of a tree  containing  the  on-line  ESPS  manual  pages
            (i.e.,   this   is  where  eman(1-ESPS)  looks).   Subdirectories
            include:

       man/man1:
            Manual pages for user-level programs.

       man/man3:
            Manual pages for library routines.


       Version 3.6                      ERL                           1/22/93







       ETM-S-86-14                                                     page 6


       man/man5:
            Manual pages for file formats.

            There are also associated man/cat? directories for the  formatted
            manual pages (created by eman).

       newdemos:
            A collection of subdirectories containing demos  that  are  newer
            (of  course!)  than  those under "demo" and either demonstrate or
            utilize some of the more recent additions to ESPS.

       pub: A collection of non-Entropic software whose authors  permit  free
            distribution  and  use; we pass these programs on free as a cour-
            tesy to our customers.

       src_examples:
            Some illustrative sample source code that is available  to  those
            without an ESPS source license for use as models in writing their
            own programs using the ESPS library.

       xview:
            Some non-Entropic files that are part of the  OpenLook  distribu-
            tion, including the window manager, the cmdtool program, and some
            fonts that you may need to install if you are not  running  Open-
            Look.

       3 .  Position Independence