wrel2.1.me

speech signal process tools

programs and xwaves+ attachments.
.lp
Operation as a display server is initiated on startup by means of the
\fB-s\fP option, or after startup by means of the \fIenable_server\fP command.
When in display server mode, \fIxwaves+\fP listens on an INET domain socket
port for commands to execute.  The port number used is determined in
the following order: (a) the global \fIsocket_port\fP as specified in the
.wave_pro or by a direct "set" command.  Setting this global has no
effect if \fIxwaves+\fP is already operating as a display server
(e.g., if it was started with \fB-s\fP), but it determines the socket
number used the next time server mode is started by
\fIenable_server\fP; (b) the port specified by the command line option
\fB-p\fP; (c) the contents of the the unix environment variable
WAVES_PORT at the time \fIxwaves+\fP starts; (d) a compiled in
default.
.lp
When in display server mode, \fIxwaves+\fP continues to operate normally via
keyboard and mouse interactions. Operation in display server mode can
be terminated by means of the command \fIdisable_server\fP.
.lp
External scripts can exploit an \fIxwaves+\fP display server by using
\fIsend_xwaves\fP.  (One can also enter \fIsend_xwaves\fP commands
directly in a shell window).  External C programs can exploit the
display server by using the utility functions \fIopen_xwaves\fP
(3\-\s-1ESPS\s+1), \fIsend_xwaves\fP (3\-\s-1ESPS\s+1),
\fIclose_xwaves\fP (3\-\s-1ESPS\s+1), and \fIsend_xwaves2\fP.  For
example, the \fIplot3d\fP (1\-\s-1ESPS\s+1) included in ESPS Version
4.1 has an option that uses these functions to send
cursor-coordination commands to an \fIxwaves\fP+ display, thereby
providing coordinated 3D- and spectrogram-style displays.
(3\-\s-1ESPS\s+1).
.sh 2 "Position Independence; Environment Variables"
.lp
ESPS and \fI(x)waves\fP+ have been made "position independent".  
In practice, this means that the system (or a link) no longer 
has to be at /usr/esps.  Thus, root access is no longer required, and 
it is easy to switch between different versions (e.g., between old
and new release). 
.lp
To support position independence, and to support customization of 
ESPS/\fI(x)waves\fP+ packages, various environment variables 
have been defined.  The main ones are listed below (for details see 
\fIespsenv\fP (1\-\s-1ESPS\s+1)).  The ones with names ending in
"_PATH" are search paths for various types of files and have the same
syntax as a Unix PATH variable: a list of directory pathnames separated
by colons.  The general rule is that if a required file is specified
by a full pathname (beginning with "/" or "./"), the name is simply
used unchanged; otherwise \fIxwaves+\fP looks for the file in the
directories listed in the appropriate environment variable, if it
is defined, or else in the directories in a default search path.
For example (see WAVES_INPUT_PATH below) if a user calls on
\fIxwaves+\fP to display a signal by a name such as "/usr/myname/speech.sd"
or "./speech.sd", precisely that name is used.  If the name is given
simply as "speech.sd", the result depends on the search path.
Suppose the value of the environment variable WAVES_INPUT_PATH is,
say, "/usr/abc:./data:.".
Then waves looks first for "/usr/abc/speech.sd"; if that doesn't exist,
it looks for "./data/speech.sd"; as the final resort, it looks for
"./speech.sd".
If WAVES_INPUT_PATH is undefined, the search path is the default,
".:$ESPS_BASE/lib/waves/files", so \fIxwaves+\fP looks first for
"./speech.sd" and then for "$ESPS_BASE/lib/waves/files/speech.sd".
For more information, see \fIfind_esps_file\fP (1\-\s-1ESPS\s+1),
\fIfind_esps_file\fP (3\-\s-1ESPS\s+1u),
and the macros in the include file $ESPS_BASE/include/esps/epaths.h.
Here is the list of environment variables.
.ip ESPS_BASE
This should be set to the root of the ESPS (and \fIwaves\fP+) install
tree.  If not defined, programs all use /usr/esps as a default. 
.ip WAVES_INPUT_PATH
This is the path used by \fIwaves+\fP and \fIxwaves+\fP to find all
input signal files, label files, and label menu files.  If
WAVES_INPUT_PATH is not defined, the default path used is
".:$ESPS_BASE/lib/waves/files".
.ip WAVES_LIB_PATH
This is the path used by \fIwaves+\fP and \fIxwaves+\fP to find certain library
files.  If WAVES_LIB_PATH is not defined, the default path used is
"$ESPS_BASE/lib/waves".
.ip WAVES_MENU_PATH
This is the path used by \fIxwaves+\fP to find menu files used
with the \fIxwaves+\fP command \fImake_panel\fP.  If WAVES_MENU_PATH is not
defined, the default path used is ".:$ESPS_BASE/lib/waves/menus".
.ip WAVES_COMMAND_PATH
This is the path used by \fIwaves\fP+ and \fIxwaves+\fP to find
command files.  If WAVES_COMMAND_PATH is not defined, the default path
used is ".:$ESPS_BASE/lib/waves/commands".
.ip WAVES_COLORMAP_PATH
This is the path used by \fIwaves+\fP and \fIxwaves+\fP to find colormaps.  If
WAVES_COLORMAP_PATH is not defined, the default path used is
".:$ESPS_BASE/lib/waves/colormaps".
.ip  WAVES_PROFILE_PATH
This is the path used by \fIwaves+\fP and \fIxwaves+\fP to find the startup
profile.  IF WAVES_PROFILE_PATH is not defined, the default path used
is "$HOME:$ESPS_BASE/lib/waves".
.ip WAVES_HOST
This is the hostname of an \fIxwaves+\fP display server.  That is,
\fIsend_xwaves\fP (1\-\s-1ESPS\s+1) \fIsend_xwaves\fP
(3\-\s-1ESPS\s+1) attempt to send messages to an \fIxwaves+\fP process
running on WAVES_HOST.  If WAVES_HOST is not defined, the local host
is assumed.
.ip WAVES_PORT
This is the INET domain socket port number used by \fIsend_xwaves\fP
(1\-\s-1ESPS\s+1) and \fIsend_xwaves\fP (3\-\s-1ESPS\s+1) when sending
messages to an \fIxwaves+\fP display server.  It is also used by
\fIxwaves+\fP in determining the port on which to listen.  If
WAVES_PORT is not defined, than a compiled-in default is used.  This
is the default socket that \fIxwaves+\fP listens on when started in
server mode (\fB-s\fP).  If a non-default socket is to be used, it is
specified to \fIxwaves+\fP, \fIsend_xwaves\fP (1\-\s-1ESPS\s+1), and
\fIsend_xwaves\fP (3\-\s-1ESPS\s+1) by means of WAVES_PORT.  Note that
\fIsend_xwaves\fP (1\-\s-1ESPS\s+1) and \fIxwaves+\fP also have a \fB-p\fP option that can
be used to override WAVES_PORT.
.ip  BBOX_QUIT_BUTTON
If this variable is defined, it forces a "QUIT" button to be included
at the top of every button panel created via \fIexv_bbox\fP
(3\-\s-1ESPS\s+1).  This includes button panels created by
\fImbuttons\fP (1\-\s-1ESPS\s+1), \fIfbuttons\fP (1\-\s-1ESPS\s+1),
and the \fIxwaves+\fP command \fImake_panel\fP.  The variable has no
effect if a quit button was specified directly using the \fB-q\fP
option to \fImbuttons\fP or the \fIquit_button\fP keyword of the
\fIxwaves+\fP command \fImake_panel\fP.
.ip DEF_HEADER
If this environment variable is defined when \fIwaves\fP+ or
\fIxwaves\fP+ starts up, it specifies a default header to be used for
headerless files (non-ESPS and non-SIGnal) files.  The global
\fIdef_header\fP is effectively disabled.  If you want to set
def_header dynamically (changing it while (\fIx\fP)\fIwaves\fP+ is
running), don't set DEF_HEADER.
.ip DSP_NO_LOCK
If set, disables locking of the DSP by \fIwaves\fP+, \fIxwaves\fP+,
and the record and play programs.
.sh 2 "LICENSE MANAGER CHANGES"
.lp
Unlike the previous version, the environment variable \fBELM_HOST\fR
must now always be defined.  It must always contain the hostname of the
host running the Entropic License Manager (\fIelmd\fR).  It is best to
have all users define this in their \fI.cshrc\fR (or equivalent).
One other environment variable affects the license manager system:
.ip ELM_TIMEOUT
controls the length of time \fIxwaves\fP+ and ESPS programs wait while
trying to contact the license server.   The default is 10 seconds.  Some
adjustment may be required depending upon the nature of your network.
.sh 2 "Other Significant \fIxwaves\fP+ Changes and Fixes"
.np
In addition to the digital time and frequency readouts in
spectrogram windows, there is now a readout for the data value at the
cursor position.  The digital readouts associated with overlays have
been moved to avoid overlapping other readouts.
.np
\fIxwaves\fP+ and \fIxspectrum\fP attachment now properly handle ESPS
spectrum files (FEA_SPEC files) in the ASYM_EDGE format, which allows
displaying spectrograms with negative-frequency parts that result from
analysis of complex time series.  (Formerly \fIxwaves\fP+ would
display such spectrograms, but with an incorrect frequency scale.)
.np
The label for an iconized waveform or spectrogram window is now
the signal name rather than "waves+".
.np
Startup messages about the profile and DSP boards are now suppressed
if \fIverbose\fP is set to 0 in the .wave_pro.  
.np
The range option used in calling external programs had a bug 
that could result in one-too-many records.  This has been fixed. 
.np
Many but (alas) not all of the multiple repaints have been suppressed.
.np
Although attachments are now much less important given the new
capabilities of \fIsend_xwaves\fP (1\-\s-1ESPS\s+1) and \fIxwaves\fP+
operating as a display server, a number of customers have asked for a
source example of an attachment.  In this release we have included
sources for \fIxspectrum\fP; see $ESPS_BASE/src_examples/waves/spectrum.
.sh 1 "SIGNIFICANT CHANGES TO \fIxspectrum\fP"
.lp
.np
There is now a choice of units for the ordinate of spectrum plots.  
Control-panel buttons allow switching between dB, magnitude, or power.
.np
Harmonic cursors are now available in the spectrum plot.  They 
are enabled/disabled via buttons on the control panel.  
.np
Six additional autoregressive (LPC, maximum entropy) spectrum analysis
methods have been added to the choices in \fIxspectrum\fP.  The full
eight methods are as follows (references are to the corresponding ESPS
signal processing library routine):
.nf

    Autocorrelation Method (AUTOC) \- see \fIget_auto\fP (3\-\s-1ESPS\s+1)

    Covariance Method (COV) \- see \fIcovar\fP (3\-\s-1ESPS\s+1)

    Burg Method (BURG) \- see \fIget_burg\fP (3\-\s-1ESPS\s+1)

    Modified Burg Method (MBURG) \- see \fIget_burg\fP (3\-\s-1ESPS\s+1)

    Fast Modified Burg Method (FBURG) \- \fIget_fburg\fP (3\-\s-1ESPS\s+1)

    Structured Covariance Method (STRCOV and STRCOV1) \- see \fIbestauto\fP (3\-\s-1ESPS\s+1), 
    \fIstruct_cov\fP (3\-\s-1ESPS\s+1), and \fIgenburg\fP (3\-\s-1ESPS\s+1)

    Vector Burg Method (VBURG) (fast approximation to structured 
    covariance)  \- see \fIget_vburg\fP (3\-\s-1ESPS\s+1)

.np
Maximum order for LPC (maximum entropy) routines has been increased 
from 30 to 200. 
.np
\fIxspectrum\fP now uses the signal (or object) name, rather than the
string "spectrum", as the icon label for the spectrum plot window.
.np
\fIxspectrum\fP now works on FEA_SD files with FLOAT or DOUBLE data. 
.np
Global parameters are now inherited from \fIxwaves\fP+ rather than
read from the user's profile. 
.np
Startup globals allow control over the position of the control window,
position of the plot window, and size of the plot window.  
.np
\fIxspectrum\fP will now accept and display slices of spectrograms in
ARB_FIXED format (unequally spaced frequencies).
.np
The user-interface in the plot window was improved by the 
addition of a right button menu (left button is now a shortcut
for save reference spectrum)  
.np
Up to 4 different reference spectra can be saved and kept in view 
with separate cursors and readouts (up from 1).  Menu items are 
available to erase the reference spectra and erase all spectra.  
.np
All of the \fIxspectrum\fP control parameters can be changed remotely
from \fIxwaves\fP+ via a "send set" command.  Values shown in the
control panel are changed accordingly.  
.np
Remote commands now include setting left and right frame limits 
(host mode).  
.np
The default window type now depends on the analysis method \- Hanning
for FFT methods, and rectangular for all LPC (maximum entropy)
methods.  If a window type is changed, the change affects only the
current analysis method.  When a different analysis method is 
selected, the window type reverts to what was used the last time
the analysis method was used.  
.np
By default, the \fIxspectrum\fP plot window is brought to the
foreground every time a new spectrum is displayed.  This behavior can
be changed by means of the new startup global
\fIxspectrum_datwin_forward\fP.  
.np
No plot window is displayed until the first spectrum computation
takes place.   
.sh 1 "SIGNIFICANT CHANGES TO \fI(x)label\fP"
.np
\fIxlabel\fP now uses the object name instead of "label" as
the icon label when a label window (not the control panel) is
iconized.
.np
An arbitrary font can now be used in the label window for both
\fIlabel\fP and \fIxlabel\fP.  In the case of \fIlabel\fP, the font is
also used in the label menu.  
.np
Arbitrary shell commands can be added to the label menu.  The 
commands are invoked with three arguments: (1) text string in the
first label field of the closest label; (2) the name of the label file
displayed under the cursor; (3) the time location of the label
closest to the cursor.  This feature is available in both \fIlabel\fP
and \fIxlabel\fP.  
.np
New MOVE and REPLACE commands make it easy to move and replace
existing labels.  This feature is available in both \fIlabel\fP and
\fIxlabel\fP.  
.np
Global parameters are now inherited from \fIxwaves\fP+ rather than
read from the user's profile. 
.np
Startup globals allow control over the position of the control window. 
.sh 1 "SIGNIFICANT CHANGES TO \fIformant\fP"
.np
A bug was fixed that prevented \fIformant\fP from working on ESPS 
FEA_SD files that were not SHORTS.  \fIFormant\fP still assumes 
SHORT data, but the ESPS files are now converted on input.  
.np
The \fIxwaves\fP+ display of "f0.sig" files from \fIformant\fP was 
fixed so that the connect-the-dots mode operates correctly.  
.sh 1 "OTHER CHANGES AND FIXES"
.np
A new unix environment variable DSP_NO_LOCK can be set to disable 
the DSP file-locking mechanism. The \fIset_lock\fP() and
\fIrem_lock\fP() functions that implement the locking were 
documented.  
.np
The graphics problems with (Sunview) \fIwaves\fP+ (random dots) under 
Sun OS 4.1 have been fixed.  
.np
Many X bugs were fixed (yeah, everyone says that).
.sh 1 "WHAT HAPPENED TO MULTIPLE ATTACHMENTS?"
.lp
Certain scheduled features didn't make it into the release.  The most 
important of these is multiple attachments.  We are still committed
to doing this, it should be available before the end of the year.  
If your application depends on it, please let us know and we will 
schedule you for a maintenance update as soon as the feature is
available.  
.sh 1 "SOME KNOWN PROBLEMS"
.lp
Here are a few known problems related to the new features:
.np
If an attachment is started when another is running, the one running
will be detached.  However, if the time between starting the two
attachments is very short, the detach can fail and \fIxwaves\fP 
can hang. 
.np
If a font is defined in a label menu, \fIxwaves\fP+ uses it in the 
label window but not on the label menu. 
.np
Our fixes for "too many repaint operations" sometimes leaves portions
of display windows blank.  This is easily fixed by a manual refresh.