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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3362 - (show annotations) (download) (as text)
Fri Oct 27 21:26:26 2017 UTC (3 years, 7 months ago) by schoenebeck
File MIME type: text/html
File size: 31749 byte(s)
- NKSP: Just updated list of built-in functions.

1 <html>
2 <head>
3 <meta name="author" content="Christian Schoenebeck">
4 <title>NKSP Reference</title>
5 <urlpath>Reference</urlpath>
6 <navpath>Reference Manual</navpath>
7 <meta name="description" content="Reference documentation of the NKSP real-time instrument script language.">
8 </head>
9 <body>
10 <h1>NKSP Reference</h1>
11 <p>
12 This document gives you an overview of all built-in functions and built-in
13 variables provided by the NKSP real-time instrument script language.
14 </p>
15
16 <h2>Built-In Functions</h2>
17 <p>
18 These are the built-in functions available with the NKSP real-time
19 instrument script language.
20 </p>
21
22 <h3>Core Language Functions</h3>
23 <p>
24 Most fundamental NKSP functions, independent from any purpose of being used in a sampler.
25 </p>
26 <table>
27 <tr>
28 <th>Function</th> <th>Description</th>
29 </tr>
30 <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>
60 <td>Prints text to the sampler's terminal.</td>
61 </tr>
62 <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>
72 <td>Stops execution of the current event handler instance.</td>
73 </tr>
74 <tr>
75 <td><code>wait()</code></td>
76 <td>Pauses execution for a certain amount of time.</td>
77 </tr>
78 <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>
84 <td>Calculates the absolute value of a given value.</td>
85 </tr>
86 <tr>
87 <td><code>random()</code></td>
88 <td>Random number generator.</td>
89 </tr>
90 <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>
100 <td>Returns the size of the requested array variable.</td>
101 </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>
111
112 <h3>Common Sampler Functions</h3>
113 <p>
114 Basic sampler related functions, independent from a particular sampler
115 format or sampler engine.
116 </p>
117 <table>
118 <tr>
119 <th>Function</th> <th>Description</th>
120 </tr>
121 <tr>
122 <td><code>play_note()</code></td>
123 <td>Triggers a new note.</td>
124 </tr>
125 <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>
131 <td>Changes panning of voices (stereo balance).</td>
132 </tr>
133 <tr>
134 <td><code>change_pan_time()</code></td>
135 <td>Changes the duration of panning (stereo balance) changes.</td>
136 </tr>
137 <tr>
138 <td><code>change_pan_curve()</code></td>
139 <td>Changes the curve type of panning (stereo balance) changes.</td>
140 </tr>
141 <tr>
142 <td><code>change_play_pos()</code></td>
143 <td>Change the sample playback position.</td>
144 </tr>
145 <tr>
146 <td><code>change_tune()</code></td>
147 <td>Changes the tuning of voices.</td>
148 </tr>
149 <tr>
150 <td><code>change_tune_time()</code></td>
151 <td>Changes the duration of tuning changes.</td>
152 </tr>
153 <tr>
154 <td><code>change_tune_curve()</code></td>
155 <td>Changes the curve type of tuning changes.</td>
156 </tr>
157 <tr>
158 <td><code>change_vol()</code></td>
159 <td>Changes the volume of voices.</td>
160 </tr>
161 <tr>
162 <td><code>change_vol_time()</code></td>
163 <td>Changes the duration of volume changes.</td>
164 </tr>
165 <tr>
166 <td><code>change_vol_curve()</code></td>
167 <td>Changes the curve type of volume changes.</td>
168 </tr>
169 <tr>
170 <td><code>change_cutoff()</code></td>
171 <td>Changes filter cutoff frequency of voices.</td>
172 </tr>
173 <tr>
174 <td><code>change_reso()</code></td>
175 <td>Changes filter resonance of voices.</td>
176 </tr>
177 <tr>
178 <td><code>change_attack()</code></td>
179 <td>Modifies the amplitude attack time of voices.</td>
180 </tr>
181 <tr>
182 <td><code>change_decay()</code></td>
183 <td>Modifies the amplitude decay time of voices.</td>
184 </tr>
185 <tr>
186 <td><code>change_sustain()</code></td>
187 <td>Modifies the amplitude sustain level of voices.</td>
188 </tr>
189 <tr>
190 <td><code>change_release()</code></td>
191 <td>Modifies the amplitude release time of voices.</td>
192 </tr>
193
194 <tr>
195 <td><code>change_cutoff_attack()</code></td>
196 <td>Modifies the filter cutoff attack time of voices.</td>
197 </tr>
198 <tr>
199 <td><code>change_cutoff_decay()</code></td>
200 <td>Modifies the filter cutoff decay time of voices.</td>
201 </tr>
202 <tr>
203 <td><code>change_cutoff_sustain()</code></td>
204 <td>Modifies the filter cutoff sustain level of voices.</td>
205 </tr>
206 <tr>
207 <td><code>change_cutoff_release()</code></td>
208 <td>Modifies the filter cutoff release time of voices.</td>
209 </tr>
210
211 <tr>
212 <td><code>change_amp_lfo_depth()</code></td>
213 <td>Modifies the amplitude LFO depth.</td>
214 </tr>
215 <tr>
216 <td><code>change_amp_lfo_freq()</code></td>
217 <td>Modifies the amplitude LFO frequency.</td>
218 </tr>
219
220 <tr>
221 <td><code>change_cutoff_lfo_depth()</code></td>
222 <td>Modifies the filter cutoff LFO depth.</td>
223 </tr>
224 <tr>
225 <td><code>change_cutoff_lfo_freq()</code></td>
226 <td>Modifies the filter cutoff LFO frequency.</td>
227 </tr>
228
229 <tr>
230 <td><code>change_pitch_lfo_depth()</code></td>
231 <td>Modifies the pitch LFO depth.</td>
232 </tr>
233 <tr>
234 <td><code>change_pitch_lfo_freq()</code></td>
235 <td>Modifies the pitch LFO frequency.</td>
236 </tr>
237 <tr>
238 <td><code>change_velo()</code></td>
239 <td>Change MIDI velocity of note.</td>
240 </tr>
241 <tr>
242 <td><code>event_status()</code></td>
243 <td>Checks and returns whether a particular note is still alive.</td>
244 </tr>
245 <tr>
246 <td><code>fade_in()</code></td>
247 <td>Fade the requested note in.</td>
248 </tr>
249 <tr>
250 <td><code>fade_out()</code></td>
251 <td>Fade the requested note out.</td>
252 </tr>
253 <tr>
254 <td><code>get_event_par()</code></td>
255 <td>Get the current value of a specific note parameter.</td>
256 </tr>
257 <tr>
258 <td><code>set_event_par()</code></td>
259 <td>Change the value of a specific note parameter.</td>
260 </tr>
261 <tr>
262 <td><code>set_controller()</code></td>
263 <td>Creates a MIDI control change event.</td>
264 </tr>
265 <tr>
266 <td><code>ignore_event()</code></td>
267 <td>Drops the given event.</td>
268 </tr>
269 <tr>
270 <td><code>ignore_controller()</code></td>
271 <td>Drops the given MIDI control change event.</td>
272 </tr>
273 <tr>
274 <td><code>note_off()</code></td>
275 <td>Releases the requested note.</td>
276 </tr>
277 <tr>
278 <td><code>set_event_mark()</code></td>
279 <td>Adds an event to an event group.</td>
280 </tr>
281 <tr>
282 <td><code>delete_event_mark()</code></td>
283 <td>Removes an event from some event group.</td>
284 </tr>
285 <tr>
286 <td><code>by_marks()</code></td>
287 <td>Returns all events of an event group.</td>
288 </tr>
289 </table>
290
291 <h3>GigaStudio Format Functions</h3>
292 <p>
293 Sampler format specific functions, dedicated to the individual features
294 of the GigaStudio format engine.
295 </p>
296 <table>
297 <tr>
298 <th>Function</th> <th>Description</th>
299 </tr>
300 <tr>
301 <td><code>gig_set_dim_zone()</code></td>
302 <td>Changes the currently active dimension zone.</td>
303 </tr>
304 <tr>
305 <td><code>same_region()</code></td>
306 <td>Check whether two keys are mapped to the same region.</td>
307 </tr>
308 </table>
309
310 <h2>Built-In Variables</h2>
311 <p>
312 These are the built-in variables and built-in constants available with the
313 NKSP realt-time instrument script language.
314 </p>
315
316 <h3>Core Language Variables</h3>
317 <p>
318 Most fundamental NKSP built-in variables, independent from any purpose of
319 being used in a sampler.
320 </p>
321 <table>
322 <tr>
323 <th>Variable</th> <th>Description</th>
324 </tr>
325 <tr>
326 <td><code>$CALLBACK_STATUS_QUEUE</code></td>
327 <td>Built-in constant reflecting the status of a callback to be
328 alive but suspended. See <code>callback_status()</code> for details.</td>
329 </tr>
330 <tr>
331 <td><code>$CALLBACK_STATUS_RUNNING</code></td>
332 <td>Built-in constant reflecting the status of a callback to be
333 alive and currently executing. See <code>callback_status()</code>
334 for details.</td>
335 </tr>
336 <tr>
337 <td><code>$CALLBACK_STATUS_TERMINATED</code></td>
338 <td>Built-in constant reflecting the status of a callback to be
339 not alive. See <code>callback_status()</code> for details.</td>
340 </tr>
341 <tr>
342 <td><code>$KSP_TIMER</code></td>
343 <td>Preserved for compatiblity reasons with KSP, returns the same value
344 as <code>$NKSP_REAL_TIMER</code> (refer to the latter for details).
345 Note that KSP's <code>reset_ksp_timer()</code> function is not available with
346 NKSP. However when calculating time differences between two time
347 stamps taken with <code>$NKSP_REAL_TIMER</code>, calling such a reset
348 function is not required, because the underlying clock does not stop
349 when it reached its value limit (which happens every 71 minutes), instead the clock
350 will automatically restart from zero and the calculated time difference
351 even between such transitions will reflect correct durations.</td>
352 </tr>
353 <tr>
354 <td><code>$NKSP_PERF_TIMER</code></td>
355 <td>Returns the current performance time stamp (in microseconds) of the
356 script running. You may read this variable from time to time to take
357 time stamps which can be used to calculate the time difference
358 (in microseconds) which elapsed between them. A performance time
359 stamp is based on the script's actual CPU execution time. So the
360 internal clock which is used for generating such time stamps is only
361 running forward if the respective script is actually executed by the
362 CPU. Whenever your script is not really executed by the CPU (i.e. because
363 your script got suspended by a wait() call or got forcely suspended due to
364 real-time constraints, or when the entire sampler application got suspended
365 by the OS for other applications or OS tasks) then the underlying internal
366 clock is paused as well.
367 <note class="important">
368 You should only use this built-in variable for script development
369 purposes (i.e. for bench marking the performance of your script).
370 You should <b>not</b> use it with your final production sounds!
371 It is not appropriate for being used in a musical context, because
372 when an offline bounce is performed for instance, the musical timing
373 will be completely unrelated to the CPU execution time. Plus using
374 this variable may cause audio drop outs on some systems. In a musical
375 context you should use <code>$ENGINE_UPTIME</code> instead, which is
376 also safe for offline bounces.
377 </note>
378 <note>
379 On some systems <code>$NKSP_REAL_TIMER</code> and
380 <code>$NKSP_PERF_TIMER</code> will actually return the same value. So the
381 difference between them is not implemented for all systems at the moment.
382 </note>
383 </td>
384 </tr>
385 <tr>
386 <td><code>%NKSP_CALLBACK_CHILD_ID[]</code></td>
387 <td>
388 Reflects the callback IDs of all child threads which the current
389 script callback instance spawned by having called <code>fork()</code> before.
390 See the latter function for details about this array variable.
391 </td>
392 </tr>
393 <tr>
394 <td><code>$NKSP_CALLBACK_PARENT_ID</code></td>
395 <td>
396 If the current execution thread is a child thread spawned by a <code>fork()</code>
397 call before, then this variable reflects the callback ID of the parent
398 thread which created this child thread. Otherwise this variable is <code>0</code>.
399 See <code>fork()</code> for more details about this variable.
400 </td>
401 </tr>
402 <tr>
403 <td><code>$NKSP_REAL_TIMER</code></td>
404 <td>Returns the current time stamp in reality (in microseconds). You may
405 read this variable from time to time to take
406 time stamps which can be used to calculate the time difference
407 (in microseconds) which elapsed between them. A "real" time
408 stamp is based on an internal clock which constantly proceeds, so this
409 internal clock also continues counting while your script is either suspended
410 (i.e. because your script got suspended by a wait() call or got forcely
411 suspended due to real-time constraints) and it also continues counting
412 even if the entire sampler application got suspended by the OS (i.e. to
413 execute other applications for multi-tasking or to perform OS tasks).
414 <note class="important">
415 You should only use this built-in variable for script development
416 purposes (i.e. for bench marking the performance of your script).
417 You should <b>not</b> use it with your final production sounds!
418 It is not appropriate for being used in a musical context, because
419 when an offline bounce is performed for instance, the musical timing
420 will be completely unrelated to the CPU execution time. Plus using
421 this variable may cause audio drop outs on some systems. In a musical
422 context you should use <code>$ENGINE_UPTIME</code> instead, which is
423 also safe for offline bounces.
424 </note>
425 <note>
426 On some systems <code>$NKSP_REAL_TIMER</code> and
427 <code>$NKSP_PERF_TIMER</code> will actually return the same value. So the
428 difference between them is not implemented for all systems at the moment.
429 </note>
430 </td>
431 </tr>
432 <tr>
433 <td><code>$NI_CALLBACK_ID</code></td>
434 <td>Reflects the current event handler instance's unique callback ID.
435 For the same event type there may be more than
436 one event handler instances running. Each one of them has
437 its own callback ID. You can get the current event handler
438 instance's callback ID by reading this built-in variable.</td>
439 </tr>
440 <tr>
441 <td><code>$NI_CALLBACK_TYPE</code></td>
442 <td>Reflects the event type of the current event handler. This variable
443 may reflect one of the following built-in constants:
444 <code>$NI_CB_TYPE_INIT</code>, <code>$NI_CB_TYPE_NOTE</code>,
445 <code>$NI_CB_TYPE_RELEASE</code>, <code>$NI_CB_TYPE_CONTROLLER</code>.</td>
446 </tr>
447 <tr>
448 <td><code>$NI_CB_TYPE_INIT</code></td>
449 <td>Built-in constant reflecting an <code>init</code> event handler type.</td>
450 </tr>
451 <tr>
452 <td><code>$NI_CB_TYPE_NOTE</code></td>
453 <td>Built-in constant reflecting a <code>note</code> event handler type.</td>
454 </tr>
455 <tr>
456 <td><code>$NI_CB_TYPE_RELEASE</code></td>
457 <td>Built-in constant reflecting a <code>release</code> event handler type.</td>
458 </tr>
459 <tr>
460 <td><code>$NI_CB_TYPE_CONTROLLER</code></td>
461 <td>Built-in constant reflecting a <code>controller</code> event handler type.</td>
462 </tr>
463 <tr>
464 <td><code>$NKSP_IGNORE_WAIT</code></td>
465 <td>If this boolean built-in variable is <code>1</code> then all calls of your
466 event handler instance to function <code>wait()</code> will be ignored.
467 This may for example be the case if another event handler instance
468 resumed your paused script by calling <code>stop_wait()</code> and
469 passing <code>1</code> to the 2nd argument of that function.</td>
470 </tr>
471 </table>
472
473 <h3>Common Sampler Variables</h3>
474 <p>
475 Basic sampler related built-in variables and constants, independent from a
476 particular sampler format or sampler engine.
477 </p>
478 <table>
479 <tr>
480 <th>Variable</th> <th>Description</th>
481 </tr>
482 <tr>
483 <td><code>%ALL_EVENTS</code></td>
484 <td>
485 Note IDs of all currently active notes of the current sampler part (a.k.a. sampler channel).
486 This may be passed to many built-in functions like <code>note_off()</code>.
487 This array variable only contains IDs of notes which were launched due
488 to MIDI note-on events. This variable does not contain IDs of child notes
489 (i.e. notes which were launched programmatically by calling <code>play_note()</code>).
490 <note>
491 In contrast to KSP this variable is an integer array type, whereas KSP's
492 pendent of this built-in variable is an integer constant (scalar) called
493 <code>$ALL_EVENTS</code>. Using the latter with NKSP will cause a
494 parser warning, the behavior will be the same though.
495 </note>
496 </td>
497 </tr>
498 <tr>
499 <td><code>$CC_NUM</code></td>
500 <td>MIDI controller number that caused the <code>controller</code>
501 handler to be executed (only useful in the context of a
502 <code>controller</code> handler).</td>
503 </tr>
504 <tr>
505 <td><code>%CC[]</code></td>
506 <td>Provides access to all current MIDI controller values. This can be
507 used in any context. Use the respective MIDI controller number as
508 index to this integer array variable. For instance <code>%CC[1]</code>
509 would give you the current value of the modulation wheel.
510 </td>
511 </tr>
512 <tr>
513 <td><code>$EVENT_ID</code></td>
514 <td>ID of the event that caused the current event handler to be executed. In
515 the context of a <code>note</code> handler this would be the event
516 ID of the note, within a <code>controller</code> handler it would
517 be the controller event ID, etc.</td>
518 </tr>
519 <tr>
520 <td><code>$EVENT_NOTE</code></td>
521 <td>MIDI note number that caused a note related
522 handler to be executed (only useful in the context of a
523 <code>note</code> or <code>release</code> handler).</td>
524 </tr>
525 <tr>
526 <td><code>$EVENT_VELOCITY</code></td>
527 <td>MIDI velocity value of the note that caused that note related
528 handler to be executed (only useful in the context of a
529 <code>note</code> or <code>release</code> handler).</td>
530 </tr>
531 <tr>
532 <td><code>$EVENT_STATUS_INACTIVE</code></td>
533 <td>Constant bit flag used as possible return value by
534 <code>event_status()</code> in case the requested
535 note is not "alive".</td>
536 </tr>
537 <tr>
538 <td><code>$EVENT_STATUS_NOTE_QUEUE</code></td>
539 <td>Constant bit flag used as possible return value by
540 <code>event_status()</code> in case the requested
541 note is still "alive".</td>
542 </tr>
543 <tr>
544 <td><code>$EVENT_PAR_NOTE</code></td>
545 <td>Constant value symbolizing the "note number" parameter. See
546 <code>get_event_par()</code> and <code>set_event_par()</code>
547 for details.</td>
548 </tr>
549 <tr>
550 <td><code>$EVENT_PAR_TUNE</code></td>
551 <td>Constant value symbolizing the "tune" parameter. See
552 <code>get_event_par()</code> and <code>set_event_par()</code>
553 for details.</td>
554 </tr>
555 <tr>
556 <td><code>$EVENT_PAR_VELOCITY</code></td>
557 <td>Constant value symbolizing the "note velocity" parameter. See
558 <code>get_event_par()</code> and <code>set_event_par()</code>
559 for details.</td>
560 </tr>
561 <tr>
562 <td><code>$EVENT_PAR_VOLUME</code></td>
563 <td>Constant value symbolizing the "volume" parameter. See
564 <code>get_event_par()</code> and <code>set_event_par()</code>
565 for details.</td>
566 </tr>
567 <tr>
568 <td><code>$EVENT_PAR_0</code> to <code>$EVENT_PAR_3</code></td>
569 <td>Four constant values symbolizing the 4 possible user specific
570 parameters, which i.e. might be used to pass data from one script
571 (slot) to another script (slot). See <code>get_event_par()</code>
572 and <code>set_event_par()</code> for details.</td>
573 </tr>
574 <tr>
575 <td><code>%KEY_DOWN[]</code></td>
576 <td>This can be used in any context to check whether a certain MIDI
577 key is currently pressed down. Use the respective MIDI note number
578 as index to this array variable (see also <code>event_status()</code>).</td>
579 </tr>
580 <tr>
581 <td><code>$NKSP_EASE_IN_EASE_OUT</code></td>
582 <td>Used to select a fade curve with "ease in and ease out" shape.</td>
583 </tr>
584 <tr>
585 <td><code>$NKSP_LINEAR</code></td>
586 <td>Used to select a fade curve with linear shape.</td>
587 </tr>
588 <tr>
589 <td><code>$VCC_MONO_AT</code></td>
590 <td>Constant identifying the MIDI monophonic aftertouch controller (also
591 called <i title="Amount of force on held-down key.">
592 MIDI channel pressure
593 </i>). This is somewhat different than in the MIDI standard. With
594 NKSP aftertouch is handled like an additional "regular" MIDI CC controller.
595 Therefore use
596 <code>%CC[$VCC_MONO_AT]</code> to obtain the current aftertouch value
597 in the context of a <code>controller</code> event handler.
598 </td>
599 </tr>
600 <tr>
601 <td><code>$VCC_PITCH_BEND</code></td>
602 <td>Constant identifying the pitch bend wheel controller.
603 This is somewhat different than in the MIDI standard. With
604 NKSP pitch bend is handled like an additional "regular" MIDI CC controller.
605 Therefore use
606 <code>%CC[$VCC_PITCH_BEND]</code> to obtain the current pitch bend wheel value
607 in the context of a <code>controller</code> event handler.</td>
608 </tr>
609 <tr>
610 <td><code>$MARK_1</code> to <code>$MARK_28</code></td>
611 <td>Used to select one of the available 28 event groups.
612 See <code>set_event_mark()</code> for details.</td>
613 </tr>
614 <tr>
615 <td><code>$ENGINE_UPTIME</code></td>
616 <td>Returns the current time stamp (in milliseconds) for being
617 used in a musical context. You may read this variable from time to time
618 to take time stamps which can be used to calculate the time difference
619 (in milliseconds) which elapsed between them. These timing values are
620 based on the internal sample rate and thus it can safely be used to
621 perform musical timing related tasks in your scripts. Especially
622 your script will also continue to behave correctly when an offline bounce
623 of a song is performed.
624 </td>
625 </tr>
626 </table>
627
628 <h3>GigaStudio Format Variables</h3>
629 <p>
630 Sampler format specific built-in variables and constants, dedicated to the
631 individual features of the GigaStudio format engine.
632 </p>
633 <table>
634 <tr>
635 <th>Variable</th> <th>Description</th>
636 </tr>
637 <tr>
638 <td><code>$GIG_DIM_CHANNEL</code></td>
639 <td>Constant that identifies the <i>stereo dimension</i>.</td>
640 </tr>
641 <tr>
642 <td><code>$GIG_DIM_LAYER</code></td>
643 <td>Constant that identifies the <i>layer dimension</i>.</td>
644 </tr>
645 <tr>
646 <td><code>$GIG_DIM_VELOCITY</code></td>
647 <td>Constant that identifies the <i>velocity dimension</i>.</td>
648 </tr>
649 <tr>
650 <td><code>$GIG_DIM_AFTERTOUCH</code></td>
651 <td>Constant that identifies the <i>aftertouch dimension</i>.</td>
652 </tr>
653 <tr>
654 <td><code>$GIG_DIM_RELEASE</code></td>
655 <td>Constant that identifies the <i>release trigger dimension</i>.</td>
656 </tr>
657 <tr>
658 <td><code>$GIG_DIM_KEYBOARD</code></td>
659 <td>Constant that identifies the <i>keyboard position dimension</i>.</td>
660 </tr>
661 <tr>
662 <td><code>$GIG_DIM_ROUNDROBIN</code></td>
663 <td>Constant that identifies the <i>round robin dimension</i>.</td>
664 </tr>
665 <tr>
666 <td><code>$GIG_DIM_RANDOM</code></td>
667 <td>Constant that identifies the <i>random dimension</i>.</td>
668 </tr>
669 <tr>
670 <td><code>$GIG_DIM_SMARTMIDI</code></td>
671 <td>Constant that identifies the <i>start MIDI dimension</i> (a.k.a iMIDI rules).</td>
672 </tr>
673 <tr>
674 <td><code>$GIG_DIM_ROUNDROBINKEY</code></td>
675 <td>Constant that identifies the <i>round robin key dimension</i>.</td>
676 </tr>
677 <tr>
678 <td><code>$GIG_DIM_MODWHEEL</code></td>
679 <td>Constant that identifies the <i>modulation wheel dimension</i>.</td>
680 </tr>
681 <tr>
682 <td><code>$GIG_DIM_SUSTAIN</code></td>
683 <td>Constant that identifies the <i>sustain pedal dimension</i> (a.k.a. hold pedal).</td>
684 </tr>
685 <tr>
686 <td><code>$GIG_DIM_PORTAMENTO</code></td>
687 <td>Constant that identifies the <i>portamento MIDI controller dimension</i>.</td>
688 </tr>
689 <tr>
690 <td><code>$GIG_DIM_SOSTENUTO</code></td>
691 <td>Constant that identifies the <i>sostenuto MIDI controller dimension</i>.</td>
692 </tr>
693 <tr>
694 <td><code>$GIG_DIM_SOFT</code></td>
695 <td>Constant that identifies the <i>soft pedal dimension</i>.</td>
696 </tr>
697 <tr>
698 <td><code>$GIG_DIM_BREATH</code></td>
699 <td>Constant that identifies the <i>breath controller dimension</i>.</td>
700 </tr>
701 <tr>
702 <td><code>$GIG_DIM_FOOT</code></td>
703 <td>Constant that identifies the <i>foot pedal dimension</i>.</td>
704 </tr>
705 <tr>
706 <td><code>$GIG_DIM_PORTAMENTOTIME</code></td>
707 <td>Constant that identifies the <i>portamento time controller dimension</i>.</td>
708 </tr>
709 <tr>
710 <td><code>$GIG_DIM_EFFECT1</code></td>
711 <td>Constant that identifies the <i>effect 1 MIDI controller dimension</i>.</td>
712 </tr>
713 <tr>
714 <td><code>$GIG_DIM_EFFECT2</code></td>
715 <td>Constant that identifies the <i>effect 2 MIDI controller dimension</i>.</td>
716 </tr>
717 <tr>
718 <td><code>$GIG_DIM_EFFECT1DEPTH</code></td>
719 <td>Constant that identifies the <i>effect 1 depth MIDI controller dimension</i>.</td>
720 </tr>
721 <tr>
722 <td><code>$GIG_DIM_EFFECT2DEPTH</code></td>
723 <td>Constant that identifies the <i>effect 2 depth MIDI controller dimension</i>.</td>
724 </tr>
725 <tr>
726 <td><code>$GIG_DIM_EFFECT3DEPTH</code></td>
727 <td>Constant that identifies the <i>effect 3 depth MIDI controller dimension</i>.</td>
728 </tr>
729 <tr>
730 <td><code>$GIG_DIM_EFFECT4DEPTH</code></td>
731 <td>Constant that identifies the <i>effect 4 depth MIDI controller dimension</i>.</td>
732 </tr>
733 <tr>
734 <td><code>$GIG_DIM_EFFECT5DEPTH</code></td>
735 <td>Constant that identifies the <i>effect 5 depth MIDI controller dimension</i>.</td>
736 </tr>
737 <tr>
738 <td><code>$GIG_DIM_GENPURPOSE1</code></td>
739 <td>Constant that identifies the <i>general purpose 1 MIDI controller dimension</i>.</td>
740 </tr>
741 <tr>
742 <td><code>$GIG_DIM_GENPURPOSE2</code></td>
743 <td>Constant that identifies the <i>general purpose 2 MIDI controller dimension</i>.</td>
744 </tr>
745 <tr>
746 <td><code>$GIG_DIM_GENPURPOSE3</code></td>
747 <td>Constant that identifies the <i>general purpose 3 MIDI controller dimension</i>.</td>
748 </tr>
749 <tr>
750 <td><code>$GIG_DIM_GENPURPOSE4</code></td>
751 <td>Constant that identifies the <i>general purpose 4 MIDI controller dimension</i>.</td>
752 </tr>
753 <tr>
754 <td><code>$GIG_DIM_GENPURPOSE5</code></td>
755 <td>Constant that identifies the <i>general purpose 5 MIDI controller dimension</i>.</td>
756 </tr>
757 <tr>
758 <td><code>$GIG_DIM_GENPURPOSE6</code></td>
759 <td>Constant that identifies the <i>general purpose 6 MIDI controller dimension</i>.</td>
760 </tr>
761 <tr>
762 <td><code>$GIG_DIM_GENPURPOSE7</code></td>
763 <td>Constant that identifies the <i>general purpose 7 MIDI controller dimension</i>.</td>
764 </tr>
765 <tr>
766 <td><code>$GIG_DIM_GENPURPOSE8</code></td>
767 <td>Constant that identifies the <i>general purpose 8 MIDI controller dimension</i>.</td>
768 </tr>
769 </table>
770
771 <h2>Built-In Preprocessor Conditions</h2>
772 <p>
773 These are the built-in preprocessor conditions available with the NKSP realt-time
774 instrument script language.
775 </p>
776
777 <h3>Core Language Preprocessor Conditions</h3>
778 <p>
779 Most fundamental NKSP built-in preprocessor conditions, independent from
780 any purpose of being used in a sampler.
781 </p>
782 <table>
783 <tr>
784 <th>Condition</th> <th>Description</th>
785 </tr>
786 <tr>
787 <td><code>NKSP_NO_MESSAGE</code></td>
788 <td>
789 By default this condition is not set. By explicitly enabling this
790 condition with <code>SET_CONDITION(NKSP_NO_MESSAGE)</code> it
791 causes all subsequent <code>message()</code> calls to be ignored
792 and filtered out on preprocessor level. See function <code>message()</code>
793 for details.
794 </td>
795 </tr>
796 </table>
797
798 </body>
799 </html>

  ViewVC Help
Powered by ViewVC