<?php $isip_window_title = "ISIP Homepage"; ?>
<?php include("/data/isip/www/templates/documentation/header/header.html"); ?>

<!--#set var="isip_page_title" value="isip_make_sof" -->
<!--#include virtual="/hse/ies/templates/documentation/body/index_utility.html" -->
<?php include("/data/isip/www/templates/documentation/body/bar.html"); ?>

<a name="name">
<b>
name:
<a href="/perl/ifc_document.pl?file=$isip/util/speech/isip_make_sof/isip_make_sof.cc">isip_make_sof</a>
</b>

<br><br>

<a name="synopsis">
<b>synopsis:</b>
<br><br>

<blockquote>
<pre>
isip_make_sof [options] file(s)
</pre>
</blockquote>

<a name="quick_start">
<b>quick start:</b>
<br><br>

<blockquote>
<pre>
isip_make_sof -help;
isip_make_sof file1.raw
isip_make_sof file1.raw file2.raw file3.sof ...
isip_make_sof -list raw_list.sof
</pre>
</blockquote>

<a name="description"> 
<b>description:</b>
<br><br>

<ul>
  The

  <a href="../../../class/io/Sof/index.html">Signal Object File</a>

  class, named 

  <a href="../../../class/io/Sof/index.html">Sof</a>,

  is the primary file format used in our programming environment.
  This utility is provided as a means to convert files to this
  format. There are advantages to dealing with Sof files, including
  the fact that byte-swapping is handled automatically.
  Some utilities also read raw audio data using the class

  <a href="../../../class/mmedia/AudioFile/index.html">AudioFile</a>.

  <br><br>

  The details of the format of the audio data are provided using
  a parameter file that can be configured using our
  standard transformation tool,

  <a href="../isip_transform_builder/index.html">isip_transform_builder</a>.

  The default configuration file can be viewed

  <a href="/perl/ifc_document.pl?file=$isip/util/speech/isip_make_sof/isip_make_sof_params.sof">here</a>.

  This configuration file converts 16-bit raw audio files.
  More information on the conversion process can be found
  in our

  <a href="/projects/speech/software/tutorials/production/fundamentals/current/" target="_top">
  on-line tutorial</a>.
</ul>

<a name="options">
<b>options:</b>
<br><br>

<ul>
  <li> directory: output directory (default = source directory)

       <br><br>

  <li> extension: new file extension (default = "sof")

       <br><br>

  <li> list: file containing input file list in Sdb format

       <br><br>

  <li> log_file: filename for console output (default is stdout).
       By default, status, debugging, and error messages
       are directed to stdout. However, this output can be redirected
       to a file by specifying this option with a filename.

       <br><br>

  <li> parameter_file: configures the data conversion
       (default = $ISIP/lib/text/isip_make_sof/isip_make_sof_params.sof)

       <br><br>

  <li> preserve: number of levels from the old directory structure
       (from the bottom up) to preserve (default = 0)

       <br><br>

  <li> suffix: the suffix to be added to the existing filename
       (default = empty)

       <br><br>

  <li> type: text or binary (default = text)

       <br><br>

  <li> verbosity: controls how much status information is displayed
       to the console
</ul>       

<a name="operands">
<b>operands:</b>

<ul>
  <li> file1.raw file2.raw ... : speech files (raw audio)
</ul>

<a name="examples">
<b>examples:</b>
<br><br>

<ul>
  <li> This example shows how to generate an Sof audio file
       from a user-supplied parameter file:

       <pre>
isip_make_sof -param pfile.sof x.raw</pre>

       In this case, a text sof file named x.sof will be generated.

       <br><br>

  <li> This example demonstrates how to use various command line
       features to change the filename:

       <pre>
isip_make_sof -param pfile.sof -ext sofx -suffix _0 -directory new x.raw</pre>

       In this case, a file named "./new/x_0.sofx" will be created.
</ul>
       
<a name="manuals">
<b>manuals:</b>

<br><br>

<ul>
  This man page is located at

  <a href="./index.html">$ISIP/util/speech/isip_make_sof/index.html</a>.

  <br><br>

  A tutorial on file conversion can be found in

  <a href="/projects/speech/software/tutorials/production/fundamentals/current/section_02/index.html" target="_top">
  Section 2</a>

  of our

  <a href="/projects/speech/software/tutorials/production/fundamentals/current/"  target="_top">
  on-line speech recognition tutorial</a>.
</ul>
       
<a name="languages">
<b>languages:</b>
<br><br>

<ul>
  This utility is written entirely in C++.
  The configuration tool,

    <a href="../isip_transform_builder/index.html">isip_transform_builder</a>

  is written in Java.
</ul>
       
<a name="variables">
<b>environment variables:</b>
<br><br>

<ul>
  $ISIP: path to the ISIP environment.
</ul>

<a name="files">
<b>files:</b>
<br><br>

<ul>
  <li> <a href="/perl/ifc_document.pl?file=$isip/util/speech/isip_make_sof/isip_make_sof.h">./isip_make_sof.h</a>: header file

       <br><br>

  <li> <a href="/perl/ifc_document.pl?file=$isip/util/speech/isip_make_sof/usage_message.text">./usage_message.text</a>: usage message

       <br><br>

  <li> <a href="/perl/ifc_document.pl?file=$isip/util/speech/isip_make_sof/help_message.text">./help_message.text</a>: help message

       <br><br>

  <li> <a href="/perl/ifc_document.pl?file=$isip/util/speech/isip_make_sof/isip_make_sof_params.sof">
       ./isip_make_sof_params.sof</a>:
       front end parameter file used to facilitate configuration for
       audio input and output
</ul>
       
<a name="see_also">
<b>see also:</b>
<br><br>

<ul>
  <a href="../isip_transform_builder/index.html">isip_transform_builder</a>,
  <a href="../isip_transform/index.html">isip_transform</a>
</ul>

<a name="notes">
<b>notes:</b>
<br><br>

<ul>
  Command line options always override parameter file values.
</ul>

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