========================================================================

 This document describes the contents of an input text file for the
 call_dsplib example application.  Example input text files for several
 DSPLIB functions are included in this folder's subdirectories.
 
------------------------------------------------------------------------

 When running call_dsplib from a Linux shell, the second command line
 parameter must be the relative path to a valid input text file.  This
 file contains the parameter values to pass to the DSPLIB function.
 The call_dsplib application will parse this file before calling the
 DSPLIB function.
 
 There are three (3) different ways to list parameters in an input text
 file:
 
 1. Single Value:
 
    !<value>
    
    This form is used to specify a single integer or float value, such
    as N for the DSPF_sp_fftSPxSP algorithm or ny and nh for the
    DSPF_sp_fir_gen algorithm.  Note that the exclamation point (!) is
    required.
    
 2. Array Value:
 
    <size (N)>
    <value 0>
    <value 1>
    <...>
    <value N - 1>
    
    This form is used to specify an entire array of values, such as an
    input array or a list of filter coefficients.  The first value must
    be the number of values in the array.  There are no special
    characters required to list an array, but each value must be listed
    on a separate line.
    
 3. Reference Value:
 
    @<file name>
    
    This form is used to move a parameter definition to its own,
    separate text file.  This is useful for isolating long arrays and
    improving readability of the input file.  Note that the at sign    (@)
    is required.
 
 In addition, comments may be inserted between parameters by beginning
 lines with the pound sign (#):
 
    # This is a comment.

------------------------------------------------------------------------

 The linux app has a simple parsing kernel that is easily confused by
 unexpected input.  Here are some "dos and don'ts" to keep in mind
 when creating an input file:
 
 DO:    List parameters in the order they are specified in the DSPLIB
        function call.
 DON'T: Re-order parameters.
 
 DO:    List values one per line without extra white space.
 DON'T: List multiple values per line or insert blank lines between
        values or comments.
 
 DO:    Use comments to identify the file and each parameter.
 DON'T: Use comments within an array listing.
 
 DO:    Use the "!" notation to list single value parameters.
 DON'T: List a single value parater without a "!" symbol.
 
 DO:    Use one of the sample input files as a starting point.
 
------------------------------------------------------------------------
End of README.txt