.TH ic 1P local "Silicon Graphics, Inc."
.SH NAME
ic \- instrument compiler for Ultra 64 audio
.SH SYNOPSIS
\f3ic\f1 [-v] [-p] [-c] [-s] -[n] -o <output file prefix> <source file>
.SH DESCRIPTION
The Ultra 64 Audio Library synthesizes audio from MIDI events using
information contained in the 
.I .ctl 
and 
.I .tbl 
data files. These files,
along with the 
.I .sym 
file are known collectively as Bank files, and are
created by the "ic" tool.  
.PP
The 
.I \.tbl
file contains the ADPCM compressed audio wavetable data.  
.PP
The
.I \.ctl
file contains information about how the wavetables are to be
synthesized. It includes information about the wavetable's envelope,
pan position, pitch, mapping to MIDI note numbers and velocity
values. For more information about format of the
.I .ctl 
file, refer to Audio Formats section of the Ultra 64 developer's
manual.
.PP
If the -c or -s option is used, ic will determine what sounds are
needed to play the sequences contained in the sequence bank files, 
and remove any unused sounds or objects.
.PP
The
.I \.sym
file contains the bank file's symbol information, and is used mainly
for development and debugging. It is used only by the audio bank
tools, not by the Audio Library.
.PP 
Command line options are:
.RS 5
.TP 12
.B -v
turns on verbose mode, which spews a lot of largely useless information.
.TP
.B \-o <filename>
specifies a file prefix for compiler output.
.TP
.B <source file>
source code for the instrument compiler.
.TP
.B -c <compact sequence bank file>
Analyses the sequence bank file, and determines what sounds and objects 
are used. Any object not needed is stripped from the output bank. The 
compact sequence file should have been made using 
.I midicomp
and
.I sbc.
.TP
.B -s <midi sequence bank file>
Analyses the sequence bank file, and determines what sounds and objects 
are used. Any object not needed is stripped from the output bank. The 
compact sequence file should have been made using 
.I midicvt
and
.I sbc.
.TP
.B -p
prints out a table for every program, showing whether or not the key is
used. A value of zero is unused, and a one is used. (Only valid when used 
with the -c or -s option.)
.TP
.B -n
will not sort the sounds by their keymap.  This is normally used when
compiling a sound effects bank since the game needs to reference the
sounds as they appear in the .inst file.  However, MIDI banks need to
have their sounds sorted by keymap so MIDI note numbers can be correctly
mapped to the corresponding sound.

.SH "SEE ALSO"
.IR tabledesign (1P),
.IR vadpcm_enc (1P)