/[svn]/doc/docbase/instrument_scripts/nksp/reference/01_nksp_reference.html
ViewVC logotype

Diff of /doc/docbase/instrument_scripts/nksp/reference/01_nksp_reference.html

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 3079 by schoenebeck, Thu Jan 5 18:20:09 2017 UTC revision 3318 by schoenebeck, Thu Jul 20 12:21:24 2017 UTC
# Line 15  Line 15 
15    
16      <h2>Built-In Functions</h2>      <h2>Built-In Functions</h2>
17      <p>      <p>
18        These are the built-in functions available with the NKSP realt-time        These are the built-in functions available with the NKSP real-time
19        instrument script language.        instrument script language.
20      </p>      </p>
21    
# Line 28  Line 28 
28          <th>Function</th> <th>Description</th>          <th>Function</th> <th>Description</th>
29        </tr>        </tr>
30        <tr>        <tr>
31            <td><code lang="nksp">abort()</code></td>
32            <td>Stops execution of a script callback.</td>
33          </tr>
34          <tr>
35            <td><code lang="nksp">array_equal()</code></td>
36            <td>Check whether two arrays are equal.</td>
37          </tr>
38          <tr>
39            <td><code>fork()</code></td>
40            <td>Creates new execution instances (threads).</td>
41          </tr>
42          <tr>
43            <td><code>callback_status()</code></td>
44            <td>Returns the current status of a callback (thread).</td>
45          </tr>
46          <tr>
47          <td><code lang="nksp">dec()</code></td>          <td><code lang="nksp">dec()</code></td>
48          <td>Decrements the passed integer variable by one.</td>          <td>Decrements the passed integer variable by one.</td>
49        </tr>        </tr>
# Line 44  Line 60 
60          <td>Prints text to the sampler's terminal.</td>          <td>Prints text to the sampler's terminal.</td>
61        </tr>        </tr>
62        <tr>        <tr>
63            <td><code>search()</code></td>
64            <td>Search for a certain value within an array.</td>
65          </tr>
66          <tr>
67            <td><code>sort()</code></td>
68            <td>Sort the given array.</td>
69          </tr>
70          <tr>
71          <td><code>exit()</code></td>          <td><code>exit()</code></td>
72          <td>Stops execution of the current event handler instance.</td>          <td>Stops execution of the current event handler instance.</td>
73        </tr>        </tr>
# Line 99  Line 123 
123          <td>Triggers a new note.</td>          <td>Triggers a new note.</td>
124        </tr>        </tr>
125        <tr>        <tr>
126            <td><code>change_note()</code></td>
127            <td>Change MIDI note number of note.</td>
128          </tr>
129          <tr>
130          <td><code>change_pan()</code></td>          <td><code>change_pan()</code></td>
131          <td>Changes panning of voices (stereo balance).</td>          <td>Changes panning of voices (stereo balance).</td>
132        </tr>        </tr>
133        <tr>        <tr>
134            <td><code>change_play_pos()</code></td>
135            <td>Change the sample playback position.</td>
136          </tr>
137          <tr>
138          <td><code>change_tune()</code></td>          <td><code>change_tune()</code></td>
139          <td>Changes the tuning of voices.</td>          <td>Changes the tuning of voices.</td>
140        </tr>        </tr>
141        <tr>        <tr>
142            <td><code>change_tune_time()</code></td>
143            <td>Changes the duration of tuning changes.</td>
144          </tr>
145          <tr>
146            <td><code>change_tune_curve()</code></td>
147            <td>Changes the curve type of tuning changes.</td>
148          </tr>
149          <tr>
150          <td><code>change_vol()</code></td>          <td><code>change_vol()</code></td>
151          <td>Changes the volume of voices.</td>          <td>Changes the volume of voices.</td>
152        </tr>        </tr>
153        <tr>        <tr>
154            <td><code>change_vol_time()</code></td>
155            <td>Changes the duration of volume changes.</td>
156          </tr>
157          <tr>
158            <td><code>change_vol_curve()</code></td>
159            <td>Changes the curve type of volume changes.</td>
160          </tr>
161          <tr>
162          <td><code>change_cutoff()</code></td>          <td><code>change_cutoff()</code></td>
163          <td>Changes filter cutoff frequency of voices.</td>          <td>Changes filter cutoff frequency of voices.</td>
164        </tr>        </tr>
# Line 127  Line 175 
175          <td>Modifies the decay time of voices.</td>          <td>Modifies the decay time of voices.</td>
176        </tr>        </tr>
177        <tr>        <tr>
178            <td><code>change_sustain()</code></td>
179            <td>Modifies the sustain level of voices.</td>
180          </tr>
181          <tr>
182          <td><code>change_release()</code></td>          <td><code>change_release()</code></td>
183          <td>Modifies the release time of voices.</td>          <td>Modifies the release time of voices.</td>
184        </tr>        </tr>
185        <tr>        <tr>
186            <td><code>change_amp_lfo_depth()</code></td>
187            <td>Modifies the amplitude LFO depth.</td>
188          </tr>
189          <tr>
190            <td><code>change_amp_lfo_freq()</code></td>
191            <td>Modifies the amplitude LFO frequency.</td>
192          </tr>
193          <tr>
194            <td><code>change_pitch_lfo_depth()</code></td>
195            <td>Modifies the pitch LFO depth.</td>
196          </tr>
197          <tr>
198            <td><code>change_pitch_lfo_freq()</code></td>
199            <td>Modifies the pitch LFO frequency.</td>
200          </tr>
201          <tr>
202            <td><code>change_velo()</code></td>
203            <td>Change MIDI velocity of note.</td>
204          </tr>
205          <tr>
206          <td><code>event_status()</code></td>          <td><code>event_status()</code></td>
207          <td>Checks and returns whether a particular note is still alive.</td>          <td>Checks and returns whether a particular note is still alive.</td>
208        </tr>        </tr>
209        <tr>        <tr>
210            <td><code>fade_in()</code></td>
211            <td>Fade the requested note in.</td>
212          </tr>
213          <tr>
214            <td><code>fade_out()</code></td>
215            <td>Fade the requested note out.</td>
216          </tr>
217          <tr>
218            <td><code>get_event_par()</code></td>
219            <td>Get the current value of a specific note parameter.</td>
220          </tr>
221          <tr>
222            <td><code>set_event_par()</code></td>
223            <td>Change the value of a specific note parameter.</td>
224          </tr>
225          <tr>
226          <td><code>set_controller()</code></td>          <td><code>set_controller()</code></td>
227          <td>Creates a MIDI control change event.</td>          <td>Creates a MIDI control change event.</td>
228        </tr>        </tr>
# Line 177  Line 265 
265          <td><code>gig_set_dim_zone()</code></td>          <td><code>gig_set_dim_zone()</code></td>
266          <td>Changes the currently active dimension zone.</td>          <td>Changes the currently active dimension zone.</td>
267        </tr>        </tr>
268          <tr>
269            <td><code>same_region()</code></td>
270            <td>Check whether two keys are mapped to the same region.</td>
271          </tr>
272      </table>      </table>
273    
274      <h2>Built-In Variables</h2>      <h2>Built-In Variables</h2>
# Line 195  Line 287 
287          <th>Variable</th> <th>Description</th>          <th>Variable</th> <th>Description</th>
288        </tr>        </tr>
289        <tr>        <tr>
290            <td><code>$CALLBACK_STATUS_QUEUE</code></td>
291            <td>Built-in constant reflecting the status of a callback to be
292                alive but suspended. See <code>callback_status()</code> for details.</td>
293          </tr>
294          <tr>
295            <td><code>$CALLBACK_STATUS_RUNNING</code></td>
296            <td>Built-in constant reflecting the status of a callback to be
297                alive and currently executing. See <code>callback_status()</code>
298                for details.</td>
299          </tr>
300          <tr>
301            <td><code>$CALLBACK_STATUS_TERMINATED</code></td>
302            <td>Built-in constant reflecting the status of a callback to be
303                not alive. See <code>callback_status()</code> for details.</td>
304          </tr>
305          <tr>
306          <td><code>$KSP_TIMER</code></td>          <td><code>$KSP_TIMER</code></td>
307          <td>Preserved for compatiblity reasons with KSP, returns the same value          <td>Preserved for compatiblity reasons with KSP, returns the same value
308             as <code>$NKSP_REAL_TIMER</code> (refer to the latter for details).             as <code>$NKSP_REAL_TIMER</code> (refer to the latter for details).
# Line 239  Line 347 
347          </td>          </td>
348        </tr>        </tr>
349        <tr>        <tr>
350            <td><code>%NKSP_CALLBACK_CHILD_ID[]</code></td>
351            <td>
352              Reflects the callback IDs of all child threads which the current
353              script callback instance spawned by having called <code>fork()</code> before.
354              See the latter function for details about this array variable.
355            </td>
356          </tr>
357          <tr>
358            <td><code>$NKSP_CALLBACK_PARENT_ID</code></td>
359            <td>
360              If the current execution thread is a child thread spawned by a <code>fork()</code>
361              call before, then this variable reflects the callback ID of the parent
362              thread which created this child thread. Otherwise this variable is <code>0</code>.
363              See <code>fork()</code> for more details about this variable.
364            </td>
365          </tr>
366          <tr>
367          <td><code>$NKSP_REAL_TIMER</code></td>          <td><code>$NKSP_REAL_TIMER</code></td>
368          <td>Returns the current time stamp in reality (in microseconds). You may          <td>Returns the current time stamp in reality (in microseconds). You may
369              read this variable from time to time to take              read this variable from time to time to take
# Line 380  Line 505 
505              note is still "alive".</td>              note is still "alive".</td>
506        </tr>        </tr>
507        <tr>        <tr>
508            <td><code>$EVENT_PAR_NOTE</code></td>
509            <td>Constant value symbolizing the "note number" parameter. See
510                <code>get_event_par()</code> and <code>set_event_par()</code>
511                for details.</td>
512          </tr>
513          <tr>
514            <td><code>$EVENT_PAR_TUNE</code></td>
515            <td>Constant value symbolizing the "tune" parameter. See
516                <code>get_event_par()</code> and <code>set_event_par()</code>
517                for details.</td>
518          </tr>
519          <tr>
520            <td><code>$EVENT_PAR_VELOCITY</code></td>
521            <td>Constant value symbolizing the "note velocity" parameter. See
522                <code>get_event_par()</code> and <code>set_event_par()</code>
523                for details.</td>
524          </tr>
525          <tr>
526            <td><code>$EVENT_PAR_VOLUME</code></td>
527            <td>Constant value symbolizing the "volume" parameter. See
528                <code>get_event_par()</code> and <code>set_event_par()</code>
529                for details.</td>
530          </tr>
531          <tr>
532            <td><code>$EVENT_PAR_0</code> to <code>$EVENT_PAR_3</code></td>
533            <td>Four constant values symbolizing the 4 possible user specific
534                parameters, which i.e. might be used to pass data from one script
535                (slot) to another script (slot). See  <code>get_event_par()</code>
536                and <code>set_event_par()</code> for details.</td>
537          </tr>
538          <tr>
539          <td><code>%KEY_DOWN[]</code></td>          <td><code>%KEY_DOWN[]</code></td>
540          <td>This can be used in any context to check whether a certain MIDI          <td>This can be used in any context to check whether a certain MIDI
541              key is currently pressed down. Use the respective MIDI note number              key is currently pressed down. Use the respective MIDI note number
542              as index to this array variable (see also <code>event_status()</code>).</td>              as index to this array variable (see also <code>event_status()</code>).</td>
543        </tr>        </tr>
544        <tr>        <tr>
545            <td><code>$NKSP_EASE_IN_EASE_OUT</code></td>
546            <td>Used to select a fade curve with "ease in and ease out" shape.</td>
547          </tr>
548          <tr>
549            <td><code>$NKSP_LINEAR</code></td>
550            <td>Used to select a fade curve with linear shape.</td>
551          </tr>
552          <tr>
553          <td><code>$VCC_MONO_AT</code></td>          <td><code>$VCC_MONO_AT</code></td>
554          <td>Constant identifying the MIDI monophonic aftertouch controller (also          <td>Constant identifying the MIDI monophonic aftertouch controller (also
555              called <i title="Amount of force on held-down key.">              called <i title="Amount of force on held-down key.">
# Line 459  Line 623 
623          <td>Constant that identifies the <i>keyboard position dimension</i>.</td>          <td>Constant that identifies the <i>keyboard position dimension</i>.</td>
624        </tr>        </tr>
625        <tr>        <tr>
626          <td><code>$GIG_DIM_ROUNDROBIN"</code></td>          <td><code>$GIG_DIM_ROUNDROBIN</code></td>
627          <td>Constant that identifies the <i>round robin dimension</i>.</td>          <td>Constant that identifies the <i>round robin dimension</i>.</td>
628        </tr>        </tr>
629        <tr>        <tr>
# Line 567  Line 731 
731          <td>Constant that identifies the <i>general purpose 8 MIDI controller dimension</i>.</td>          <td>Constant that identifies the <i>general purpose 8 MIDI controller dimension</i>.</td>
732        </tr>        </tr>
733      </table>      </table>
734    
735            <h2>Built-In Preprocessor Conditions</h2>
736        <p>
737          These are the built-in preprocessor conditions available with the NKSP realt-time
738          instrument script language.
739        </p>
740            
741        <h3>Core Language Preprocessor Conditions</h3>
742        <p>
743          Most fundamental NKSP built-in preprocessor conditions, independent from
744          any purpose of being used in a sampler.
745        </p>
746        <table>
747          <tr>
748            <th>Condition</th> <th>Description</th>
749          </tr>
750          <tr>
751            <td><code>NKSP_NO_MESSAGE</code></td>
752            <td>
753              By default this condition is not set. By explicitly enabling this
754              condition with <code>SET_CONDITION(NKSP_NO_MESSAGE)</code> it
755              causes all subsequent <code>message()</code> calls to be ignored
756              and filtered out on preprocessor level. See function <code>message()</code>
757              for details.
758            </td>
759          </tr>
760        </table>
761    
762    </body>    </body>
763  </html>  </html>
Legend:
Removed from v.3079  
changed lines
  Added in v.3318
  ViewVC Help
Powered by ViewVC