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

  ViewVC Help
Powered by ViewVC