ref.txt

speech signal process tools

enable_server
     START LISTENING FOR COMMANDS ON SOCKET

     xwaves starts listening for commands on an INET domain socket port. The
     port number used is determined in the following order:
       1. the global socket_port as specified in the .wave_pro file or by a
          direct set command. Setting this global has no effect if xwaves is
          already operating as a display server (e.g., if it was started
          with -s), but it determines the socket number used the next time
          server mode is started by enable_server;
       2. the port specified by the command line option -p;
       3. the contents of the UNIX environment variable WAVES_PORT  at the
          time xwaves starts;
       4. a compiled-in default.
     Note that as of version 5.0, the socket-based ``server mode'' is only
     used in conjunction with the send_xwaves  (3-ESPS) library functions,
     not with the send_xwaves  program. In future releases, the
     enable_server and disable_server commands may be eliminated since they
     will be unnecessary.

get
     GET GLOBAL ATTRIBUTES FROM xwaves

     attributes
          This optional keyword has only one meaningful value at this time:
          global . If global is specified, the data is provided as
          keyword-value pairs suitable for output into a file that may then
          be used as an xwaves profile file (.wave_pro). Otherwise, only the
          variable values explicitly requested are returned (without their
          corresponding keywords).
     output
          the name of an output file to receive keyword- value pairs (in a
          format suitable for a .wave_pro file) in the case where global is
          specified for attributes or an unadorned list of values if
          attributes is not specified.

          If an output is not specified, but attributes is, then stdout is
          assumed. If attributes is not specified the values ONLY go to an
          output file or the calling process (e.g. send_xwaves). The output
          name can include UNIX environment variables (e.g., $HOME).
     aname
          a quoted string list of xwaves globals to output, in the case
          where global is specified for attributes. If aname is omitted, but
          attributes global is specified, all global values are output. If
          attributes is not specified, aname (and an associated list of
          symbols) must be specified.

     Note that the keywords return_id, file and function are recognized by
     the get command, but are for xwaves-internal use only. See also the get
     command in the section 26.4.

key_map
     BIND A KEYBOARD CHARACTER TO AN OPERATOR

     op
          a quoted string value that is the exact name of the operator to be
          called when the key is struck. This operator name may be drawn
          from any of the built-in menu operations (see the chapter ``Data
          Window Menu Items'' of the full manual) or may be any operator
          defined with the add_op command. The keyword command is an exact
          synonym for op.
     menu
          the display window type for which the mapping is to be effective.
          Typical values for menu would be wave, spect or all, but any menu
          list created with the add_op command may be accessed. If no menu
          is specified, all lists (including new lists created by the add_op
          command) will be searched and the first operator with the
          requested name will be applied to all display window types.
          However, add_ops and built-ins specifically designated as wave or
          spect operator will not cross over and be mappable to other than
          this designated view type.
     key
          The single character that is to be mapped to the operator. All
          alphanumeric keys and control keys are acceptable values. Control
          qualification is indicated by preceding the key with the caret (^)
          symbol. The space bar is represented by the underline character
          (_). If desired, the same key can be made to have different
          semantics in the different display window types through use of the
          menu specification.

     As an example, suppose you wanted the space bar to play between marks
     in the spectrogram windows, but apply marks in the waveform window. The
     following key_map and add_op commands would do the trick:

          add_op name mark menu wave op # _name mark \
             time _cursor_time
          key_map key _ menu spect op play between marks
          key_map key _ menu wave op mark


key_unmap
     REMOVE A KEY-TO-OPERATOR BINDING

     menu
          the name of the display window type (spect, wave or all) from
          which the key-mapping is to be deleted. If unspecified, all is
          assumed. Note that menu is a bit of a misnomer, it should probably
          be called something like view_type.
     key
          The character that is to be unmapped. This is specified the same
          as for the key_map command.

     Note the key_unmap command does not affect the definition of the
     operator, only its binding to a key. If a key is to be remapped to
     another operator it is not necessary to perform a key_unmap first.

kill
     DESTROY ONE OR MORE DATA DISPLAY WINDOWS

     <none>
          implies that all display objects are to be killed.
     name
          name of the display object with a display window to be killed.
     file
          the specific data display window to be killed. If file is
          specified, name must be specified. If name is specified and file
          omitted, all objects in the named display object will be killed.
          Note that the file name specified must match the name by which the
          display window was created (which may not be the name displayed in
          the display window's frame if the global shorten_header is
          enabled).

kill_panel
     KILL AUXILIARY CONTROL PANEL

     name
          contiguous string of non-blank characters that has been used in
          creating an auxiliary control panel with the make_panel command.
          The named panel ceases to exist.

make
     CREATE A DATA DISPLAY WINDOW AND/OR DISPLAY OBJECT

     name
          any contiguous string to be used as an object name. If omitted,
          the current object name is used.
     file
          the filename of some data to be displayed. If name is omitted and
          file is specified, the simplified base name of the first file will
          become the object name.
     identifiers
          a quoted string of vector elements to display by name (see also
          activate in section 26.4).
     numbers
          a quoted string of vector elements to display by number (from
          zero) (see also activate in the section 26.4).
     <any xwaves global symbol>
          as described for the xwaves set command (including new
          definitions). The effect (with an exception noted below) is to set
          the named global. The globals that pertain to display window
          attributes will be used with any new values assigned in the
          current and all subsequent display window creations, unless they
          are otherwise modified. A few of the more commonly used variables
          have been given aliases for convenience:
     duration
          (alias for ref_size).
     start
          (alias for ref_start).
     loc_x
          (alias for first_x).
     loc_y
          (alias for first_y).
     width
          Using this keyword sets the width of the new display window (for
          both waveforms and spectrograms). The keyword is not an alias, so
          no corresponding global is set. In the case of waveform windows,
          using wave_width has the same effect but also sets the
          corresponding global and hence affects subsequently created
          display windows.
     height
          Using this keyword sets the height of the new display window (for
          both waveforms and spectrograms). The keyword is not an alias, so
          no corresponding globals is set. In the case of waveform windows,
          using wave_height has the same effect, but also sets the
          corresponding global.
     def_header
          See the description of the the global symbol def_header. This sets
          the global variable.

     The make command is the primary means for other programs to create data
     display windows in xwaves. It permits simultaneous specification of all
     major display window attributes and the naming of display object. For
     example, if a UNIX shell script is to display some data using xwaves,
     it could use the program send_xwaves like this:

          send_xwaves make name myview file my_data.sd \
             loc_x 0 loc_y 200 ...


     where ``...'' indicates any additional display window attributes you
     may need to specify as keyword-value pairs on the same command line.
     Later, you may want to send commands to this object. Suppose you wanted
     to iconize (close) the display window containing my_data.sd:

          send_xwaves myview close file my_data.sd


make_panel
     CREATE AUXILIARY CONTROL PANEL

     loc_x
          integer. Distance in pixels of the left edge of the panel from the
          left edge of the screen.
     loc_y
          integer. Distance in pixels of the top of the panel from the top
          of the screen.
     title
          identifying quoted string to be displayed in the panel frame.
     icon_title
          identifying quoted string to be displayed as the title of the
          iconized panel.
     columns
          the number of buttons in each row of the panel (default is 10).
     quit_button
          if non-zero, causes a QUIT button to be included as the first
          button in the panel. The default is 0 (no quit button). If the
          UNIX environment variable BBOX_QUIT_BUTTON  is defined, this
          results in a QUIT button being added even if quit_button is 0. The
          resulting behavior is somewhat different from the case where
          quit_button is non-zero, however, in that the QUIT button is
          created in a row by itself at the top of the panel and is not
          counted with the other buttons when determining where to break the
          first row. The reason for this is to avoid disturbing the geometry
          that may have been selected carefully by the application calling
          make_panel. The main reason for providing global control via
          BBOX_QUIT_BUTTON is to facilitate usage on systems with window
          managers that do not provide an independent means for killing
          windows.
     name
          contiguous string of non-blank characters. This string is used
          internally by other xwaves commands in referring to the panel.
          (Cf. close_panel, open_panel, kill_panel.) If the name is in use,
          the existing panel is destroyed.
     file
          contiguous string of non-blank characters forming a valid
          filename. This names an olwm -format ASCII menu file that defines
          the layout of the panel, the names of its buttons and the xwaves
          commands they perform. By default, xwaves looks for the named file
          first in the current directory and then in
          $ESPS_BASE/lib/waves/menus. This default path can be overridden by
          setting the UNIX environment variable WAVES_MENU_PATH . For a
          discussion of the format of the menu files see mbuttons  and
          exv_bbox . For examples, look at the files
          $ESPS_BASE/lib/waves/commands/*.WC.
     panel_choice
          a boolean that, when enabled, causes the items comprising the
          menus under the panel buttons to be expanded as exclusive
          pushbuttons on the panel, rather than as pull-down menus, which is
          the default.
     choice_horiz
          if panel_choice is enabled, choice_horiz is a boolean that
          determines the orientation of the button layout, which is vertical
          by default.

open_ctlwin
     OPEN MAIN CONTROL PANEL

     If it is currently iconized, the main xwaves control panel is opened.
     Otherwise, there is no effect.

open_panel
     OPEN AUXILIARY CONTROL PANEL

     name
          contiguous string of non-blank characters that has been used in
          creating an auxiliary control panel with the make_panel  command.
          The named panel, if closed (that is, iconized) is opened.

print_setup
     START PRINT GRAPHIC SETUP PANEL

     This command invokes a panel that can be used to set the various
     globals that affect printing and saving of graphic images. See the
     chapter ``Printing Graphics'' of the full manual.

quit
     CAUSES xwaves TO QUIT AND RETURN TO UNIX

     This commands stops xwaves. Any modified signals will be saved. All
     attachments will be stopped. The xwaves license will be released before
     xwaves exits.

return
     RETURN TO THE CALLING WAVES COMMAND FILE

     In addition to its use as a means for returning from subroutines, the
     return command may be placed at the end of any command file to force
     the removal of the file's name from the COMMAND (or @file): main
     control panel line on completion of the file.

     The call, branch, and return xwaves commands are only used in xwaves
     command files. They are of no use as direct commands. Before writing a