documentation/Main.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <link rel="stylesheet" href="style.css" type="text/css">
   5 <meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
   6 <link rel="Start" href="index.html">
   7 <link rel="previous" href="Preprocess.html">
   8 <link rel="Up" href="index.html">
   9 <link title="Index of types" rel=Appendix href="index_types.html">
  10 <link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
  11 <link title="Index of values" rel=Appendix href="index_values.html">
  12 <link title="Index of modules" rel=Appendix href="index_modules.html">
  13 <link title="Types" rel="Chapter" href="Types.html">
  14 <link title="Parser" rel="Chapter" href="Parser.html">
  15 <link title="Lexer" rel="Chapter" href="Lexer.html">
  16 <link title="Value" rel="Chapter" href="Value.html">
  17 <link title="Signal" rel="Chapter" href="Signal.html">
  18 <link title="Faustexp" rel="Chapter" href="Faustexp.html">
  19 <link title="Interpreter" rel="Chapter" href="Interpreter.html">
  20 <link title="Preprocess" rel="Chapter" href="Preprocess.html">
  21 <link title="Main" rel="Chapter" href="Main.html"><title>Main</title>
  22 </head>
  23 <body>
  24 <div class="navbar"><a href="Preprocess.html">Previous</a>
  25 &nbsp;<a href="index.html">Up</a>
  26 &nbsp;</div>
  27 <center><h1>Module <a href="type_Main.html">Main</a></h1></center>
  28 <br>
  29 <pre><span class="keyword">module</span> Main: <code class="code">sig</code> <a href="Main.html">..</a> <code class="code">end</code></pre>Module: Interpreter
  30         Description: Input wave -&gt; interpretation -&gt; output wave<br>
  31 <b>Author(s):</b> WANG Haisheng
  32         Created: 15/05/2013     Modified: 04/06/2013<br>
  33 <hr width="100%">
  34 <pre><span id="EXCEPTIONMissing_Expression"><span class="keyword">exception</span> Missing_Expression</span></pre>
  35 <div class="info">
  36 Exception raised when no string expression of faust process is typed in console.<br>
  37 </div>
  38 <br><code><span id="TYPEio_macro"><span class="keyword">type</span> <code class="type"></code>io_macro</span> = </code><table class="typetable">
  39 <tr>
  40 <td align="left" valign="top" >
  41 <code><span class="keyword">|</span></code></td>
  42 <td align="left" valign="top" >
  43 <code><span class="constructor">Input_Route_string</span></code></td>
  44
  45 </tr>
  46 <tr>
  47 <td align="left" valign="top" >
  48 <code><span class="keyword">|</span></code></td>
  49 <td align="left" valign="top" >
  50 <code><span class="constructor">Output_Route_string</span></code></td>
  51
  52 </tr>
  53 <tr>
  54 <td align="left" valign="top" >
  55 <code><span class="keyword">|</span></code></td>
  56 <td align="left" valign="top" >
  57 <code><span class="constructor">Dsp_Route_string</span></code></td>
  58
  59 </tr></table>
  60
  61 <div class="info">
  62 Macro constants of input/output route.<br>
  63 </div>
  64
  65 <pre><span id="VALio_macro_to_string"><span class="keyword">val</span> <a href="code_VALMain.io_macro_to_string.html">io_macro_to_string</a></span> : <code class="type"><a href="Main.html#TYPEio_macro">io_macro</a> -> string</code></pre><div class="info">
  66 val io_macro_to_string : io_macro -&gt; string.<br>
  67 </div>
  68 <pre><span id="VALset_GC"><span class="keyword">val</span> <a href="code_VALMain.set_GC.html">set_GC</a></span> : <code class="type">unit -> unit</code></pre><div class="info">
  69 val set_GC : unit -&gt; unit<br>
  70 </div>
  71 <pre><span id="VALread_input_wave"><span class="keyword">val</span> <a href="code_VALMain.read_input_wave.html">read_input_wave</a></span> : <code class="type">string array -> int list * float array list</code></pre><div class="info">
  72 val read_input_wave : string array -&gt; int list * float array list
  73     <code class="code">read_input_wave argv</code> gets information from command line,
  74     returns sample rate list and data (in form of float array) list.<br>
  75 </div>
  76 <pre><span id="VALwrite_output_wave"><span class="keyword">val</span> <a href="code_VALMain.write_output_wave.html">write_output_wave</a></span> : <code class="type">int list -> int list -> float array list -> unit</code></pre><div class="info">
  77 val write_output_wave : int list -&gt; int list -&gt; float_array_list -&gt; unit.
  78     <code class="code">write_output_wave channel_numbers sample_rates data</code><br>
  79 </div>
  80 <pre><span id="VALwrite_output_txt"><span class="keyword">val</span> <a href="code_VALMain.write_output_txt.html">write_output_txt</a></span> : <code class="type">int list -> float array list -> unit</code></pre><br>
  81 val main : unit -&gt; unit
  82 main function reads console input strings (Sys.argv) with
  83 input: string of faust process, input waves in default directory 'input_sounds/'
  84 output: output waves in default directory 'output_sounds/'.<br>
  85 <pre><span id="VALmain"><span class="keyword">val</span> <a href="code_VALMain.main.html">main</a></span> : <code class="type">unit -> unit</code></pre></body></html>