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 |
|
|
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> |
48 |
|
<td>Decrements the passed integer variable by one.</td> |
49 |
|
</tr> |
50 |
|
<tr> |
51 |
|
<td><code>inc()</code></td> |
52 |
|
<td>Increments the passed integer variable by one.</td> |
53 |
|
</tr> |
54 |
|
<tr> |
55 |
|
<td><code>in_range()</code></td> |
56 |
|
<td>Checks whether a value is between two other values.</td> |
57 |
|
</tr> |
58 |
|
<tr> |
59 |
<td><code lang="nksp">message()</code></td> |
<td><code lang="nksp">message()</code></td> |
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> |
76 |
<td>Pauses execution for a certain amount of time.</td> |
<td>Pauses execution for a certain amount of time.</td> |
77 |
</tr> |
</tr> |
78 |
<tr> |
<tr> |
79 |
|
<td><code>stop_wait()</code></td> |
80 |
|
<td>Resumes execution of a suspended script callback.</td> |
81 |
|
</tr> |
82 |
|
<tr> |
83 |
<td><code>abs()</code></td> |
<td><code>abs()</code></td> |
84 |
<td>Calculates the absolute value of a given value.</td> |
<td>Calculates the absolute value of a given value.</td> |
85 |
</tr> |
</tr> |
88 |
<td>Random number generator.</td> |
<td>Random number generator.</td> |
89 |
</tr> |
</tr> |
90 |
<tr> |
<tr> |
91 |
|
<td><code>min()</code></td> |
92 |
|
<td>Calculates the minimum value of two given values.</td> |
93 |
|
</tr> |
94 |
|
<tr> |
95 |
|
<td><code>max()</code></td> |
96 |
|
<td>Calculates the maximum value of two given values.</td> |
97 |
|
</tr> |
98 |
|
<tr> |
99 |
<td><code>num_elements()</code></td> |
<td><code>num_elements()</code></td> |
100 |
<td>Returns the size of the requested array variable.</td> |
<td>Returns the size of the requested array variable.</td> |
101 |
</tr> |
</tr> |
102 |
|
<tr> |
103 |
|
<td><code>sh_left()</code></td> |
104 |
|
<td>Calculates a left bit shifted value.</td> |
105 |
|
</tr> |
106 |
|
<tr> |
107 |
|
<td><code>sh_right()</code></td> |
108 |
|
<td>Calculates a right bit shifted value.</td> |
109 |
|
</tr> |
110 |
</table> |
</table> |
111 |
|
|
112 |
<h3>Common Sampler Functions</h3> |
<h3>Common Sampler Functions</h3> |
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> |
167 |
<td>Changes filter resonance of voices.</td> |
<td>Changes filter resonance of voices.</td> |
168 |
</tr> |
</tr> |
169 |
<tr> |
<tr> |
170 |
|
<td><code>change_attack()</code></td> |
171 |
|
<td>Modifies the attack time of voices.</td> |
172 |
|
</tr> |
173 |
|
<tr> |
174 |
|
<td><code>change_decay()</code></td> |
175 |
|
<td>Modifies the decay time of voices.</td> |
176 |
|
</tr> |
177 |
|
<tr> |
178 |
|
<td><code>change_release()</code></td> |
179 |
|
<td>Modifies the release time of voices.</td> |
180 |
|
</tr> |
181 |
|
<tr> |
182 |
|
<td><code>change_amp_lfo_depth()</code></td> |
183 |
|
<td>Modifies the amplitude LFO depth.</td> |
184 |
|
</tr> |
185 |
|
<tr> |
186 |
|
<td><code>change_amp_lfo_freq()</code></td> |
187 |
|
<td>Modifies the amplitude LFO frequency.</td> |
188 |
|
</tr> |
189 |
|
<tr> |
190 |
|
<td><code>change_pitch_lfo_depth()</code></td> |
191 |
|
<td>Modifies the pitch LFO depth.</td> |
192 |
|
</tr> |
193 |
|
<tr> |
194 |
|
<td><code>change_pitch_lfo_freq()</code></td> |
195 |
|
<td>Modifies the pitch LFO frequency.</td> |
196 |
|
</tr> |
197 |
|
<tr> |
198 |
|
<td><code>change_velo()</code></td> |
199 |
|
<td>Change MIDI velocity of note.</td> |
200 |
|
</tr> |
201 |
|
<tr> |
202 |
<td><code>event_status()</code></td> |
<td><code>event_status()</code></td> |
203 |
<td>Checks and returns whether a particular note is still alive.</td> |
<td>Checks and returns whether a particular note is still alive.</td> |
204 |
</tr> |
</tr> |
205 |
<tr> |
<tr> |
206 |
|
<td><code>fade_in()</code></td> |
207 |
|
<td>Fade the requested note in.</td> |
208 |
|
</tr> |
209 |
|
<tr> |
210 |
|
<td><code>fade_out()</code></td> |
211 |
|
<td>Fade the requested note out.</td> |
212 |
|
</tr> |
213 |
|
<tr> |
214 |
|
<td><code>get_event_par()</code></td> |
215 |
|
<td>Get the current value of a specific note parameter.</td> |
216 |
|
</tr> |
217 |
|
<tr> |
218 |
|
<td><code>set_event_par()</code></td> |
219 |
|
<td>Change the value of a specific note parameter.</td> |
220 |
|
</tr> |
221 |
|
<tr> |
222 |
<td><code>set_controller()</code></td> |
<td><code>set_controller()</code></td> |
223 |
<td>Creates a MIDI control change event.</td> |
<td>Creates a MIDI control change event.</td> |
224 |
</tr> |
</tr> |
261 |
<td><code>gig_set_dim_zone()</code></td> |
<td><code>gig_set_dim_zone()</code></td> |
262 |
<td>Changes the currently active dimension zone.</td> |
<td>Changes the currently active dimension zone.</td> |
263 |
</tr> |
</tr> |
264 |
|
<tr> |
265 |
|
<td><code>same_region()</code></td> |
266 |
|
<td>Check whether two keys are mapped to the same region.</td> |
267 |
|
</tr> |
268 |
</table> |
</table> |
269 |
|
|
270 |
<h2>Built-In Variables</h2> |
<h2>Built-In Variables</h2> |
283 |
<th>Variable</th> <th>Description</th> |
<th>Variable</th> <th>Description</th> |
284 |
</tr> |
</tr> |
285 |
<tr> |
<tr> |
286 |
|
<td><code>$CALLBACK_STATUS_QUEUE</code></td> |
287 |
|
<td>Built-in constant reflecting the status of a callback to be |
288 |
|
alive but suspended. See <code>callback_status()</code> for details.</td> |
289 |
|
</tr> |
290 |
|
<tr> |
291 |
|
<td><code>$CALLBACK_STATUS_RUNNING</code></td> |
292 |
|
<td>Built-in constant reflecting the status of a callback to be |
293 |
|
alive and currently executing. See <code>callback_status()</code> |
294 |
|
for details.</td> |
295 |
|
</tr> |
296 |
|
<tr> |
297 |
|
<td><code>$CALLBACK_STATUS_TERMINATED</code></td> |
298 |
|
<td>Built-in constant reflecting the status of a callback to be |
299 |
|
not alive. See <code>callback_status()</code> for details.</td> |
300 |
|
</tr> |
301 |
|
<tr> |
302 |
<td><code>$KSP_TIMER</code></td> |
<td><code>$KSP_TIMER</code></td> |
303 |
<td>Preserved for compatiblity reasons with KSP, returns the same value |
<td>Preserved for compatiblity reasons with KSP, returns the same value |
304 |
as <code>$NKSP_REAL_TIMER</code> (refer to the latter for details). |
as <code>$NKSP_REAL_TIMER</code> (refer to the latter for details). |
343 |
</td> |
</td> |
344 |
</tr> |
</tr> |
345 |
<tr> |
<tr> |
346 |
|
<td><code>%NKSP_CALLBACK_CHILD_ID[]</code></td> |
347 |
|
<td> |
348 |
|
Reflects the callback IDs of all child threads which the current |
349 |
|
script callback instance spawned by having called <code>fork()</code> before. |
350 |
|
See the latter function for details about this array variable. |
351 |
|
</td> |
352 |
|
</tr> |
353 |
|
<tr> |
354 |
|
<td><code>$NKSP_CALLBACK_PARENT_ID</code></td> |
355 |
|
<td> |
356 |
|
If the current execution thread is a child thread spawned by a <code>fork()</code> |
357 |
|
call before, then this variable reflects the callback ID of the parent |
358 |
|
thread which created this child thread. Otherwise this variable is <code>0</code>. |
359 |
|
See <code>fork()</code> for more details about this variable. |
360 |
|
</td> |
361 |
|
</tr> |
362 |
|
<tr> |
363 |
<td><code>$NKSP_REAL_TIMER</code></td> |
<td><code>$NKSP_REAL_TIMER</code></td> |
364 |
<td>Returns the current time stamp in reality (in microseconds). You may |
<td>Returns the current time stamp in reality (in microseconds). You may |
365 |
read this variable from time to time to take |
read this variable from time to time to take |
389 |
</note> |
</note> |
390 |
</td> |
</td> |
391 |
</tr> |
</tr> |
392 |
|
<tr> |
393 |
|
<td><code>$NI_CALLBACK_ID</code></td> |
394 |
|
<td>Reflects the current event handler instance's unique callback ID. |
395 |
|
For the same event type there may be more than |
396 |
|
one event handler instances running. Each one of them has |
397 |
|
its own callback ID. You can get the current event handler |
398 |
|
instance's callback ID by reading this built-in variable.</td> |
399 |
|
</tr> |
400 |
|
<tr> |
401 |
|
<td><code>$NI_CALLBACK_TYPE</code></td> |
402 |
|
<td>Reflects the event type of the current event handler. This variable |
403 |
|
may reflect one of the following built-in constants: |
404 |
|
<code>$NI_CB_TYPE_INIT</code>, <code>$NI_CB_TYPE_NOTE</code>, |
405 |
|
<code>$NI_CB_TYPE_RELEASE</code>, <code>$NI_CB_TYPE_CONTROLLER</code>.</td> |
406 |
|
</tr> |
407 |
|
<tr> |
408 |
|
<td><code>$NI_CB_TYPE_INIT</code></td> |
409 |
|
<td>Built-in constant reflecting an <code>init</code> event handler type.</td> |
410 |
|
</tr> |
411 |
|
<tr> |
412 |
|
<td><code>$NI_CB_TYPE_NOTE</code></td> |
413 |
|
<td>Built-in constant reflecting a <code>note</code> event handler type.</td> |
414 |
|
</tr> |
415 |
|
<tr> |
416 |
|
<td><code>$NI_CB_TYPE_RELEASE</code></td> |
417 |
|
<td>Built-in constant reflecting a <code>release</code> event handler type.</td> |
418 |
|
</tr> |
419 |
|
<tr> |
420 |
|
<td><code>$NI_CB_TYPE_CONTROLLER</code></td> |
421 |
|
<td>Built-in constant reflecting a <code>controller</code> event handler type.</td> |
422 |
|
</tr> |
423 |
|
<tr> |
424 |
|
<td><code>$NKSP_IGNORE_WAIT</code></td> |
425 |
|
<td>If this boolean built-in variable is <code>1</code> then all calls of your |
426 |
|
event handler instance to function <code>wait()</code> will be ignored. |
427 |
|
This may for example be the case if another event handler instance |
428 |
|
resumed your paused script by calling <code>stop_wait()</code> and |
429 |
|
passing <code>1</code> to the 2nd argument of that function.</td> |
430 |
|
</tr> |
431 |
</table> |
</table> |
432 |
|
|
433 |
<h3>Common Sampler Variables</h3> |
<h3>Common Sampler Variables</h3> |
440 |
<th>Variable</th> <th>Description</th> |
<th>Variable</th> <th>Description</th> |
441 |
</tr> |
</tr> |
442 |
<tr> |
<tr> |
443 |
|
<td><code>%ALL_EVENTS</code></td> |
444 |
|
<td> |
445 |
|
Note IDs of all currently active notes of the current sampler part (a.k.a. sampler channel). |
446 |
|
This may be passed to many built-in functions like <code>note_off()</code>. |
447 |
|
This array variable only contains IDs of notes which were launched due |
448 |
|
to MIDI note-on events. This variable does not contain IDs of child notes |
449 |
|
(i.e. notes which were launched programmatically by calling <code>play_note()</code>). |
450 |
|
<note> |
451 |
|
In contrast to KSP this variable is an integer array type, whereas KSP's |
452 |
|
pendent of this built-in variable is an integer constant (scalar) called |
453 |
|
<code>$ALL_EVENTS</code>. Using the latter with NKSP will cause a |
454 |
|
parser warning, the behavior will be the same though. |
455 |
|
</note> |
456 |
|
</td> |
457 |
|
</tr> |
458 |
|
<tr> |
459 |
<td><code>$CC_NUM</code></td> |
<td><code>$CC_NUM</code></td> |
460 |
<td>MIDI controller number that caused the <code>controller</code> |
<td>MIDI controller number that caused the <code>controller</code> |
461 |
handler to be executed (only useful in the context of a |
handler to be executed (only useful in the context of a |
501 |
note is still "alive".</td> |
note is still "alive".</td> |
502 |
</tr> |
</tr> |
503 |
<tr> |
<tr> |
504 |
|
<td><code>$EVENT_PAR_NOTE</code></td> |
505 |
|
<td>Constant value symbolizing the "note number" parameter. See |
506 |
|
<code>get_event_par()</code> and <code>set_event_par()</code> |
507 |
|
for details.</td> |
508 |
|
</tr> |
509 |
|
<tr> |
510 |
|
<td><code>$EVENT_PAR_TUNE</code></td> |
511 |
|
<td>Constant value symbolizing the "tune" parameter. See |
512 |
|
<code>get_event_par()</code> and <code>set_event_par()</code> |
513 |
|
for details.</td> |
514 |
|
</tr> |
515 |
|
<tr> |
516 |
|
<td><code>$EVENT_PAR_VELOCITY</code></td> |
517 |
|
<td>Constant value symbolizing the "note velocity" parameter. See |
518 |
|
<code>get_event_par()</code> and <code>set_event_par()</code> |
519 |
|
for details.</td> |
520 |
|
</tr> |
521 |
|
<tr> |
522 |
|
<td><code>$EVENT_PAR_VOLUME</code></td> |
523 |
|
<td>Constant value symbolizing the "volume" parameter. See |
524 |
|
<code>get_event_par()</code> and <code>set_event_par()</code> |
525 |
|
for details.</td> |
526 |
|
</tr> |
527 |
|
<tr> |
528 |
|
<td><code>$EVENT_PAR_0</code> to <code>$EVENT_PAR_3</code></td> |
529 |
|
<td>Four constant values symbolizing the 4 possible user specific |
530 |
|
parameters, which i.e. might be used to pass data from one script |
531 |
|
(slot) to another script (slot). See <code>get_event_par()</code> |
532 |
|
and <code>set_event_par()</code> for details.</td> |
533 |
|
</tr> |
534 |
|
<tr> |
535 |
<td><code>%KEY_DOWN[]</code></td> |
<td><code>%KEY_DOWN[]</code></td> |
536 |
<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 |
537 |
key is currently pressed down. Use the respective MIDI note number |
key is currently pressed down. Use the respective MIDI note number |
538 |
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> |
539 |
</tr> |
</tr> |
540 |
<tr> |
<tr> |
541 |
|
<td><code>$NKSP_EASE_IN_EASE_OUT</code></td> |
542 |
|
<td>Used to select a fade curve with "ease in and ease out" shape.</td> |
543 |
|
</tr> |
544 |
|
<tr> |
545 |
|
<td><code>$NKSP_LINEAR</code></td> |
546 |
|
<td>Used to select a fade curve with linear shape.</td> |
547 |
|
</tr> |
548 |
|
<tr> |
549 |
<td><code>$VCC_MONO_AT</code></td> |
<td><code>$VCC_MONO_AT</code></td> |
550 |
<td>Constant identifying the MIDI monophonic aftertouch controller (also |
<td>Constant identifying the MIDI monophonic aftertouch controller (also |
551 |
called <i title="Amount of force on held-down key."> |
called <i title="Amount of force on held-down key."> |
619 |
<td>Constant that identifies the <i>keyboard position dimension</i>.</td> |
<td>Constant that identifies the <i>keyboard position dimension</i>.</td> |
620 |
</tr> |
</tr> |
621 |
<tr> |
<tr> |
622 |
<td><code>$GIG_DIM_ROUNDROBIN"</code></td> |
<td><code>$GIG_DIM_ROUNDROBIN</code></td> |
623 |
<td>Constant that identifies the <i>round robin dimension</i>.</td> |
<td>Constant that identifies the <i>round robin dimension</i>.</td> |
624 |
</tr> |
</tr> |
625 |
<tr> |
<tr> |
727 |
<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> |
728 |
</tr> |
</tr> |
729 |
</table> |
</table> |
730 |
|
|
731 |
|
<h2>Built-In Preprocessor Conditions</h2> |
732 |
|
<p> |
733 |
|
These are the built-in preprocessor conditions available with the NKSP realt-time |
734 |
|
instrument script language. |
735 |
|
</p> |
736 |
|
|
737 |
|
<h3>Core Language Preprocessor Conditions</h3> |
738 |
|
<p> |
739 |
|
Most fundamental NKSP built-in preprocessor conditions, independent from |
740 |
|
any purpose of being used in a sampler. |
741 |
|
</p> |
742 |
|
<table> |
743 |
|
<tr> |
744 |
|
<th>Condition</th> <th>Description</th> |
745 |
|
</tr> |
746 |
|
<tr> |
747 |
|
<td><code>NKSP_NO_MESSAGE</code></td> |
748 |
|
<td> |
749 |
|
By default this condition is not set. By explicitly enabling this |
750 |
|
condition with <code>SET_CONDITION(NKSP_NO_MESSAGE)</code> it |
751 |
|
causes all subsequent <code>message()</code> calls to be ignored |
752 |
|
and filtered out on preprocessor level. See function <code>message()</code> |
753 |
|
for details. |
754 |
|
</td> |
755 |
|
</tr> |
756 |
|
</table> |
757 |
|
|
758 |
</body> |
</body> |
759 |
</html> |
</html> |