<?php $isip_window_title = "ISIP Homepage"; ?>
<?php include("/data/isip/www/templates/documentation/header/header.html"); ?>
<?php include("/data/isip/www/templates/documentation/body/bar.html"); ?>
<!--#set var="isip_page_title" value="ISIP UTILITIES" -->
<!--#include virtual="/hse/ies/templates/documentation/body/title.html" -->

<!-- turn off underlining of links -->
<!--                               -->
<style type="text/css">
<!--
A { text-decoration: none; }
A:visited, A:hover, A:active {text-decoration: none; }
// -->
</style>

This branch of the ISIP environment contains
utilities developed from the

<a href="../class/index.html">foundation classes</a>

and miscellaneous

<a href="../scripts/index.html">scripting tools</a>.

These utilities share a common command line interface
and support a uniform look and feel across a variety of
technologies.

<br><br>

Some significant features of these utilities are

<br><br>

<ul>
  <li> unicode compatibility and wide character support to allow
       multilingual applications;

  <li> transparent file list processing;

  <li> flexible command line argument parsing;

  <li> user-programmable debugging levels;

  <li> consistent and comprehensive error reporting.

</ul>       

Our command line interface, which is shared by all utilities,
is best explained via an example using a simple utility, <i>isip_make_sof</i>.

<a href="./speech/isip_make_sof/index.html">Click here</a>

to view the manual page for this utility. A typical command line will
look like this:

<br><br>

<ul>
  isip_make_sof -sample_frequency 8000 -num_bytes 2 -encoding linear -type text speech.raw
</ul>

Our command line interface conforms to most standard Unix conventions.
There are a few basic interface features to note:

<ol>
  <li> The command line follows standard Unix
       conventions, and consists of items we refer to as
       options (e.g., "-num_bytes") and arguments (e.g., speech.raw).

       <br><br>

  <li> Options, which are preceded by a dash ("-") may appear in any order.

       <br><br>

  <li> Arguments (e.g., "speech.raw") are sometimes required to appear
       in a specific order. Alternately, you can often enumerate a set of
       arguments to be processed using standard command line regular expression
       pattern matching (e.g., "*/*/*.raw").

       <br><br>

  <li> The name of the option can be abbreviated to the shortest name that
       is unique. For example, "-sample_frequency" is often entered using
       "-samp" or even "-s" in this utility (since no other options begin
       with "s").

       <br><br>

  <li> Help is available for all utilities. Extended help messages can be
       obtained by inserting "-help" anywhere on the command line:

       <br><br>

       <ul>
	 isip_make_sof -sample_frequency 8000 -help -num_bytes 2
       </ul>

       <br>
       
       This will display the help message show below:

       <br><br>

       <ul>
	 <pre>
isip221_[1]: isip_make_sof -help
name: isip_make_sof
synopsis: isip_make_sof [options] file(s)
descr: coverts raw audio files to Sof audio files
example: isip_make_sof -encoding linear -sample_frequency 8000.0 file.raw

options:
 -encoding: format of the raw data (default = linear)
 -num_bytes: the number of bytes for each sample (default = 2)
 -sample_frequency: sample frequency for the data
 -byte_order: byte order for raw data (default = native)
 -list: file containing input file list in Sdb format
 -output_directory: output directory
 -new_extension: output file extension
 -dir_pres_level: number of levels of subdirectories to preserve (def 0)
 -debug: debug level, either NONE, BRIEF, DETAILED, or ALL 
 -verbose: how verbose should the output be? (default NONE)
 -help: display this help message
 
arguments: sdb or sof files can be passed as arguments

man page: none</pre>
       </ul>

  <li> A brief help message can often be obtained by typing the
       command name with no arguments:

       <br><br>

       <ul>
	 <pre>
isip221_[1]: isip_make_sof
Usage: isip_make_sof [options] file(s)
        specify the -help option for more information</pre>
       </ul>

  <li> Debugging information can be obtained by specifying the debug
       option "-debug". Allowable values are "NONE", "BRIEF",
       "DETAILED", and "ALL". These provide varying amounts of detail
       to the console (stdout in most cases). All utilities and classes
       support this interface.

       <br><br>

  <li> A man page can be located by transforming the man
       page path listed on the page
       (e.g., $ISIP/util/speech/isip_make_sof/index.html) to a URL
       (e.g., http://www.isip.msstate.edu/projects/speech/software/documentation/util/speech/isip_make_sof/index.html). These pages are also available in
       your local installation.
</ol>

The structure of the utility directories is explained below:

<br><br>

<!-- major table declaration                       -->
<!--                                               -->
<center>
<table border=5 cellpadding=0 cellspacing=0>
<tr>
<td>

<!-- minor table declaration                       -->
<!--                                               -->
<table border=0 cellpadding=3 cellspacing=0 bgcolor="#55DDFF">
<tr>

<!-- row declaration                               -->
<!--                                               -->
<tr>
<td width=175 align=left>
&nbsp;
<a href="./speech/index.html">Speech (/speech)</a>:<br>
</td>
<td width=375 align=center bgcolor="#DDEEFF">
&nbsp;
<a href="./speech/index.html">... isip_transform, isip_recognize ...</a><br>
</tr>

<!-- row declaration                               -->
<!--                                               -->
<tr>
<td width=175 align=left>
&nbsp;
<a href="./devel/index.html">Development Tools (/devel):</a>
<br>
</td>
<td width=375 align=center bgcolor="#DDEEFF">
&nbsp;
<a href="./devel/index.html">... isip_tkdiff, isip_varmint, and dmalloc_run ...</a>
<br>
</td>
</tr>

<!-- row declaration                               -->
<!--                                               -->
<tr>
<td width=175 align=left>
&nbsp;
<a href="./misc/index.html">Miscellaneous (/misc)</a>:<br>
</td>
<td width=375 align=center bgcolor="#DDEEFF">
&nbsp;
<a href="./misc/index.html">... isip_e, isip_ci, isip_chmod ...</a>
<br>
</td>
</tr>

<!-- end minor table declaration                   -->
<!--                                               -->
</table>

<!-- end major table declaration                   -->
<!--                                               -->
</td>
</tr>
</table>
</center>

<br>

The <i>misc</i> directory contains miscellaneous tools
we use in our day-to-day computing environment.
The <i>devel</i> directory provides some useful software
engineering and development tools.
Most users will interact with the environment
through the <i>speech</i> directory, which contains
the core speech recognition and speech processing tools.
Each library in the above table is linked to a short description
of the library, including a tutorial on how to use the tools in
that library.

<br><br>

<!--#include virtual="/hse/ies/templates/documentation/footer/footer.html" -->
