/[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 3121 - (show annotations) (download) (as text)
Fri Apr 21 19:45:29 2017 UTC (4 years, 5 months ago) by schoenebeck
File MIME type: text/html
File size: 24134 byte(s)
* NKSP: Added built-in function "change_amp_lfo_depth()".
* NKSP: Added built-in function "change_amp_lfo_freq()".
* NKSP: Added built-in function "change_pitch_lfo_depth()".
* NKSP: Added built-in function "change_pitch_lfo_freq()".

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 realt-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">dec()</code></td>
32 <td>Decrements the passed integer variable by one.</td>
33 </tr>
34 <tr>
35 <td><code>inc()</code></td>
36 <td>Increments the passed integer variable by one.</td>
37 </tr>
38 <tr>
39 <td><code>in_range()</code></td>
40 <td>Checks whether a value is between two other values.</td>
41 </tr>
42 <tr>
43 <td><code lang="nksp">message()</code></td>
44 <td>Prints text to the sampler's terminal.</td>
45 </tr>
46 <tr>
47 <td><code>exit()</code></td>
48 <td>Stops execution of the current event handler instance.</td>
49 </tr>
50 <tr>
51 <td><code>wait()</code></td>
52 <td>Pauses execution for a certain amount of time.</td>
53 </tr>
54 <tr>
55 <td><code>stop_wait()</code></td>
56 <td>Resumes execution of a suspended script callback.</td>
57 </tr>
58 <tr>
59 <td><code>abs()</code></td>
60 <td>Calculates the absolute value of a given value.</td>
61 </tr>
62 <tr>
63 <td><code>random()</code></td>
64 <td>Random number generator.</td>
65 </tr>
66 <tr>
67 <td><code>min()</code></td>
68 <td>Calculates the minimum value of two given values.</td>
69 </tr>
70 <tr>
71 <td><code>max()</code></td>
72 <td>Calculates the maximum value of two given values.</td>
73 </tr>
74 <tr>
75 <td><code>num_elements()</code></td>
76 <td>Returns the size of the requested array variable.</td>
77 </tr>
78 <tr>
79 <td><code>sh_left()</code></td>
80 <td>Calculates a left bit shifted value.</td>
81 </tr>
82 <tr>
83 <td><code>sh_right()</code></td>
84 <td>Calculates a right bit shifted value.</td>
85 </tr>
86 </table>
87
88 <h3>Common Sampler Functions</h3>
89 <p>
90 Basic sampler related functions, independent from a particular sampler
91 format or sampler engine.
92 </p>
93 <table>
94 <tr>
95 <th>Function</th> <th>Description</th>
96 </tr>
97 <tr>
98 <td><code>play_note()</code></td>
99 <td>Triggers a new note.</td>
100 </tr>
101 <tr>
102 <td><code>change_pan()</code></td>
103 <td>Changes panning of voices (stereo balance).</td>
104 </tr>
105 <tr>
106 <td><code>change_tune()</code></td>
107 <td>Changes the tuning of voices.</td>
108 </tr>
109 <tr>
110 <td><code>change_vol()</code></td>
111 <td>Changes the volume of voices.</td>
112 </tr>
113 <tr>
114 <td><code>change_cutoff()</code></td>
115 <td>Changes filter cutoff frequency of voices.</td>
116 </tr>
117 <tr>
118 <td><code>change_reso()</code></td>
119 <td>Changes filter resonance of voices.</td>
120 </tr>
121 <tr>
122 <td><code>change_attack()</code></td>
123 <td>Modifies the attack time of voices.</td>
124 </tr>
125 <tr>
126 <td><code>change_decay()</code></td>
127 <td>Modifies the decay time of voices.</td>
128 </tr>
129 <tr>
130 <td><code>change_release()</code></td>
131 <td>Modifies the release time of voices.</td>
132 </tr>
133 <tr>
134 <td><code>change_amp_lfo_depth()</code></td>
135 <td>Modifies the amplitude LFO depth.</td>
136 </tr>
137 <tr>
138 <td><code>change_amp_lfo_freq()</code></td>
139 <td>Modifies the amplitude LFO frequency.</td>
140 </tr>
141 <tr>
142 <td><code>change_pitch_lfo_depth()</code></td>
143 <td>Modifies the pitch LFO depth.</td>
144 </tr>
145 <tr>
146 <td><code>change_pitch_lfo_freq()</code></td>
147 <td>Modifies the pitch LFO frequency.</td>
148 </tr>
149 <tr>
150 <td><code>event_status()</code></td>
151 <td>Checks and returns whether a particular note is still alive.</td>
152 </tr>
153 <tr>
154 <td><code>set_controller()</code></td>
155 <td>Creates a MIDI control change event.</td>
156 </tr>
157 <tr>
158 <td><code>ignore_event()</code></td>
159 <td>Drops the given event.</td>
160 </tr>
161 <tr>
162 <td><code>ignore_controller()</code></td>
163 <td>Drops the given MIDI control change event.</td>
164 </tr>
165 <tr>
166 <td><code>note_off()</code></td>
167 <td>Releases the requested note.</td>
168 </tr>
169 <tr>
170 <td><code>set_event_mark()</code></td>
171 <td>Adds an event to an event group.</td>
172 </tr>
173 <tr>
174 <td><code>delete_event_mark()</code></td>
175 <td>Removes an event from some event group.</td>
176 </tr>
177 <tr>
178 <td><code>by_marks()</code></td>
179 <td>Returns all events of an event group.</td>
180 </tr>
181 </table>
182
183 <h3>GigaStudio Format Functions</h3>
184 <p>
185 Sampler format specific functions, dedicated to the individual features
186 of the GigaStudio format engine.
187 </p>
188 <table>
189 <tr>
190 <th>Function</th> <th>Description</th>
191 </tr>
192 <tr>
193 <td><code>gig_set_dim_zone()</code></td>
194 <td>Changes the currently active dimension zone.</td>
195 </tr>
196 </table>
197
198 <h2>Built-In Variables</h2>
199 <p>
200 These are the built-in variables and built-in constants available with the
201 NKSP realt-time instrument script language.
202 </p>
203
204 <h3>Core Language Variables</h3>
205 <p>
206 Most fundamental NKSP built-in variables, independent from any purpose of
207 being used in a sampler.
208 </p>
209 <table>
210 <tr>
211 <th>Variable</th> <th>Description</th>
212 </tr>
213 <tr>
214 <td><code>$KSP_TIMER</code></td>
215 <td>Preserved for compatiblity reasons with KSP, returns the same value
216 as <code>$NKSP_REAL_TIMER</code> (refer to the latter for details).
217 Note that KSP's <code>reset_ksp_timer()</code> function is not available with
218 NKSP. However when calculating time differences between two time
219 stamps taken with <code>$NKSP_REAL_TIMER</code>, calling such a reset
220 function is not required, because the underlying clock does not stop
221 when it reached its value limit (which happens every 71 minutes), instead the clock
222 will automatically restart from zero and the calculated time difference
223 even between such transitions will reflect correct durations.</td>
224 </tr>
225 <tr>
226 <td><code>$NKSP_PERF_TIMER</code></td>
227 <td>Returns the current performance time stamp (in microseconds) of the
228 script running. You may read this variable from time to time to take
229 time stamps which can be used to calculate the time difference
230 (in microseconds) which elapsed between them. A performance time
231 stamp is based on the script's actual CPU execution time. So the
232 internal clock which is used for generating such time stamps is only
233 running forward if the respective script is actually executed by the
234 CPU. Whenever your script is not really executed by the CPU (i.e. because
235 your script got suspended by a wait() call or got forcely suspended due to
236 real-time constraints, or when the entire sampler application got suspended
237 by the OS for other applications or OS tasks) then the underlying internal
238 clock is paused as well.
239 <note class="important">
240 You should only use this built-in variable for script development
241 purposes (i.e. for bench marking the performance of your script).
242 You should <b>not</b> use it with your final production sounds!
243 It is not appropriate for being used in a musical context, because
244 when an offline bounce is performed for instance, the musical timing
245 will be completely unrelated to the CPU execution time. Plus using
246 this variable may cause audio drop outs on some systems. In a musical
247 context you should use <code>$ENGINE_UPTIME</code> instead, which is
248 also safe for offline bounces.
249 </note>
250 <note>
251 On some systems <code>$NKSP_REAL_TIMER</code> and
252 <code>$NKSP_PERF_TIMER</code> will actually return the same value. So the
253 difference between them is not implemented for all systems at the moment.
254 </note>
255 </td>
256 </tr>
257 <tr>
258 <td><code>$NKSP_REAL_TIMER</code></td>
259 <td>Returns the current time stamp in reality (in microseconds). You may
260 read this variable from time to time to take
261 time stamps which can be used to calculate the time difference
262 (in microseconds) which elapsed between them. A "real" time
263 stamp is based on an internal clock which constantly proceeds, so this
264 internal clock also continues counting while your script is either suspended
265 (i.e. because your script got suspended by a wait() call or got forcely
266 suspended due to real-time constraints) and it also continues counting
267 even if the entire sampler application got suspended by the OS (i.e. to
268 execute other applications for multi-tasking or to perform OS tasks).
269 <note class="important">
270 You should only use this built-in variable for script development
271 purposes (i.e. for bench marking the performance of your script).
272 You should <b>not</b> use it with your final production sounds!
273 It is not appropriate for being used in a musical context, because
274 when an offline bounce is performed for instance, the musical timing
275 will be completely unrelated to the CPU execution time. Plus using
276 this variable may cause audio drop outs on some systems. In a musical
277 context you should use <code>$ENGINE_UPTIME</code> instead, which is
278 also safe for offline bounces.
279 </note>
280 <note>
281 On some systems <code>$NKSP_REAL_TIMER</code> and
282 <code>$NKSP_PERF_TIMER</code> will actually return the same value. So the
283 difference between them is not implemented for all systems at the moment.
284 </note>
285 </td>
286 </tr>
287 <tr>
288 <td><code>$NI_CALLBACK_ID</code></td>
289 <td>Reflects the current event handler instance's unique callback ID.
290 For the same event type there may be more than
291 one event handler instances running. Each one of them has
292 its own callback ID. You can get the current event handler
293 instance's callback ID by reading this built-in variable.</td>
294 </tr>
295 <tr>
296 <td><code>$NI_CALLBACK_TYPE</code></td>
297 <td>Reflects the event type of the current event handler. This variable
298 may reflect one of the following built-in constants:
299 <code>$NI_CB_TYPE_INIT</code>, <code>$NI_CB_TYPE_NOTE</code>,
300 <code>$NI_CB_TYPE_RELEASE</code>, <code>$NI_CB_TYPE_CONTROLLER</code>.</td>
301 </tr>
302 <tr>
303 <td><code>$NI_CB_TYPE_INIT</code></td>
304 <td>Built-in constant reflecting an <code>init</code> event handler type.</td>
305 </tr>
306 <tr>
307 <td><code>$NI_CB_TYPE_NOTE</code></td>
308 <td>Built-in constant reflecting a <code>note</code> event handler type.</td>
309 </tr>
310 <tr>
311 <td><code>$NI_CB_TYPE_RELEASE</code></td>
312 <td>Built-in constant reflecting a <code>release</code> event handler type.</td>
313 </tr>
314 <tr>
315 <td><code>$NI_CB_TYPE_CONTROLLER</code></td>
316 <td>Built-in constant reflecting a <code>controller</code> event handler type.</td>
317 </tr>
318 <tr>
319 <td><code>$NKSP_IGNORE_WAIT</code></td>
320 <td>If this boolean built-in variable is <code>1</code> then all calls of your
321 event handler instance to function <code>wait()</code> will be ignored.
322 This may for example be the case if another event handler instance
323 resumed your paused script by calling <code>stop_wait()</code> and
324 passing <code>1</code> to the 2nd argument of that function.</td>
325 </tr>
326 </table>
327
328 <h3>Common Sampler Variables</h3>
329 <p>
330 Basic sampler related built-in variables and constants, independent from a
331 particular sampler format or sampler engine.
332 </p>
333 <table>
334 <tr>
335 <th>Variable</th> <th>Description</th>
336 </tr>
337 <tr>
338 <td><code>%ALL_EVENTS</code></td>
339 <td>
340 Note IDs of all currently active notes of the current sampler part (a.k.a. sampler channel).
341 This may be passed to many built-in functions like <code>note_off()</code>.
342 This array variable only contains IDs of notes which were launched due
343 to MIDI note-on events. This variable does not contain IDs of child notes
344 (i.e. notes which were launched programmatically by calling <code>play_note()</code>).
345 <note>
346 In contrast to KSP this variable is an integer array type, whereas KSP's
347 pendent of this built-in variable is an integer constant (scalar) called
348 <code>$ALL_EVENTS</code>. Using the latter with NKSP will cause a
349 parser warning, the behavior will be the same though.
350 </note>
351 </td>
352 </tr>
353 <tr>
354 <td><code>$CC_NUM</code></td>
355 <td>MIDI controller number that caused the <code>controller</code>
356 handler to be executed (only useful in the context of a
357 <code>controller</code> handler).</td>
358 </tr>
359 <tr>
360 <td><code>%CC[]</code></td>
361 <td>Provides access to all current MIDI controller values. This can be
362 used in any context. Use the respective MIDI controller number as
363 index to this integer array variable. For instance <code>%CC[1]</code>
364 would give you the current value of the modulation wheel.
365 </td>
366 </tr>
367 <tr>
368 <td><code>$EVENT_ID</code></td>
369 <td>ID of the event that caused the current event handler to be executed. In
370 the context of a <code>note</code> handler this would be the event
371 ID of the note, within a <code>controller</code> handler it would
372 be the controller event ID, etc.</td>
373 </tr>
374 <tr>
375 <td><code>$EVENT_NOTE</code></td>
376 <td>MIDI note number that caused a note related
377 handler to be executed (only useful in the context of a
378 <code>note</code> or <code>release</code> handler).</td>
379 </tr>
380 <tr>
381 <td><code>$EVENT_VELOCITY</code></td>
382 <td>MIDI velocity value of the note that caused that note related
383 handler to be executed (only useful in the context of a
384 <code>note</code> or <code>release</code> handler).</td>
385 </tr>
386 <tr>
387 <td><code>$EVENT_STATUS_INACTIVE</code></td>
388 <td>Constant bit flag used as possible return value by
389 <code>event_status()</code> in case the requested
390 note is not "alive".</td>
391 </tr>
392 <tr>
393 <td><code>$EVENT_STATUS_NOTE_QUEUE</code></td>
394 <td>Constant bit flag used as possible return value by
395 <code>event_status()</code> in case the requested
396 note is still "alive".</td>
397 </tr>
398 <tr>
399 <td><code>%KEY_DOWN[]</code></td>
400 <td>This can be used in any context to check whether a certain MIDI
401 key is currently pressed down. Use the respective MIDI note number
402 as index to this array variable (see also <code>event_status()</code>).</td>
403 </tr>
404 <tr>
405 <td><code>$VCC_MONO_AT</code></td>
406 <td>Constant identifying the MIDI monophonic aftertouch controller (also
407 called <i title="Amount of force on held-down key.">
408 MIDI channel pressure
409 </i>). This is somewhat different than in the MIDI standard. With
410 NKSP aftertouch is handled like an additional "regular" MIDI CC controller.
411 Therefore use
412 <code>%CC[$VCC_MONO_AT]</code> to obtain the current aftertouch value
413 in the context of a <code>controller</code> event handler.
414 </td>
415 </tr>
416 <tr>
417 <td><code>$VCC_PITCH_BEND</code></td>
418 <td>Constant identifying the pitch bend wheel controller.
419 This is somewhat different than in the MIDI standard. With
420 NKSP pitch bend is handled like an additional "regular" MIDI CC controller.
421 Therefore use
422 <code>%CC[$VCC_PITCH_BEND]</code> to obtain the current pitch bend wheel value
423 in the context of a <code>controller</code> event handler.</td>
424 </tr>
425 <tr>
426 <td><code>$MARK_1</code> to <code>$MARK_28</code></td>
427 <td>Used to select one of the available 28 event groups.
428 See <code>set_event_mark()</code> for details.</td>
429 </tr>
430 <tr>
431 <td><code>$ENGINE_UPTIME</code></td>
432 <td>Returns the current time stamp (in milliseconds) for being
433 used in a musical context. You may read this variable from time to time
434 to take time stamps which can be used to calculate the time difference
435 (in milliseconds) which elapsed between them. These timing values are
436 based on the internal sample rate and thus it can safely be used to
437 perform musical timing related tasks in your scripts. Especially
438 your script will also continue to behave correctly when an offline bounce
439 of a song is performed.
440 </td>
441 </tr>
442 </table>
443
444 <h3>GigaStudio Format Variables</h3>
445 <p>
446 Sampler format specific built-in variables and constants, dedicated to the
447 individual features of the GigaStudio format engine.
448 </p>
449 <table>
450 <tr>
451 <th>Variable</th> <th>Description</th>
452 </tr>
453 <tr>
454 <td><code>$GIG_DIM_CHANNEL</code></td>
455 <td>Constant that identifies the <i>stereo dimension</i>.</td>
456 </tr>
457 <tr>
458 <td><code>$GIG_DIM_LAYER</code></td>
459 <td>Constant that identifies the <i>layer dimension</i>.</td>
460 </tr>
461 <tr>
462 <td><code>$GIG_DIM_VELOCITY</code></td>
463 <td>Constant that identifies the <i>velocity dimension</i>.</td>
464 </tr>
465 <tr>
466 <td><code>$GIG_DIM_AFTERTOUCH</code></td>
467 <td>Constant that identifies the <i>aftertouch dimension</i>.</td>
468 </tr>
469 <tr>
470 <td><code>$GIG_DIM_RELEASE</code></td>
471 <td>Constant that identifies the <i>release trigger dimension</i>.</td>
472 </tr>
473 <tr>
474 <td><code>$GIG_DIM_KEYBOARD</code></td>
475 <td>Constant that identifies the <i>keyboard position dimension</i>.</td>
476 </tr>
477 <tr>
478 <td><code>$GIG_DIM_ROUNDROBIN"</code></td>
479 <td>Constant that identifies the <i>round robin dimension</i>.</td>
480 </tr>
481 <tr>
482 <td><code>$GIG_DIM_RANDOM</code></td>
483 <td>Constant that identifies the <i>random dimension</i>.</td>
484 </tr>
485 <tr>
486 <td><code>$GIG_DIM_SMARTMIDI</code></td>
487 <td>Constant that identifies the <i>start MIDI dimension</i> (a.k.a iMIDI rules).</td>
488 </tr>
489 <tr>
490 <td><code>$GIG_DIM_ROUNDROBINKEY</code></td>
491 <td>Constant that identifies the <i>round robin key dimension</i>.</td>
492 </tr>
493 <tr>
494 <td><code>$GIG_DIM_MODWHEEL</code></td>
495 <td>Constant that identifies the <i>modulation wheel dimension</i>.</td>
496 </tr>
497 <tr>
498 <td><code>$GIG_DIM_SUSTAIN</code></td>
499 <td>Constant that identifies the <i>sustain pedal dimension</i> (a.k.a. hold pedal).</td>
500 </tr>
501 <tr>
502 <td><code>$GIG_DIM_PORTAMENTO</code></td>
503 <td>Constant that identifies the <i>portamento MIDI controller dimension</i>.</td>
504 </tr>
505 <tr>
506 <td><code>$GIG_DIM_SOSTENUTO</code></td>
507 <td>Constant that identifies the <i>sostenuto MIDI controller dimension</i>.</td>
508 </tr>
509 <tr>
510 <td><code>$GIG_DIM_SOFT</code></td>
511 <td>Constant that identifies the <i>soft pedal dimension</i>.</td>
512 </tr>
513 <tr>
514 <td><code>$GIG_DIM_BREATH</code></td>
515 <td>Constant that identifies the <i>breath controller dimension</i>.</td>
516 </tr>
517 <tr>
518 <td><code>$GIG_DIM_FOOT</code></td>
519 <td>Constant that identifies the <i>foot pedal dimension</i>.</td>
520 </tr>
521 <tr>
522 <td><code>$GIG_DIM_PORTAMENTOTIME</code></td>
523 <td>Constant that identifies the <i>portamento time controller dimension</i>.</td>
524 </tr>
525 <tr>
526 <td><code>$GIG_DIM_EFFECT1</code></td>
527 <td>Constant that identifies the <i>effect 1 MIDI controller dimension</i>.</td>
528 </tr>
529 <tr>
530 <td><code>$GIG_DIM_EFFECT2</code></td>
531 <td>Constant that identifies the <i>effect 2 MIDI controller dimension</i>.</td>
532 </tr>
533 <tr>
534 <td><code>$GIG_DIM_EFFECT1DEPTH</code></td>
535 <td>Constant that identifies the <i>effect 1 depth MIDI controller dimension</i>.</td>
536 </tr>
537 <tr>
538 <td><code>$GIG_DIM_EFFECT2DEPTH</code></td>
539 <td>Constant that identifies the <i>effect 2 depth MIDI controller dimension</i>.</td>
540 </tr>
541 <tr>
542 <td><code>$GIG_DIM_EFFECT3DEPTH</code></td>
543 <td>Constant that identifies the <i>effect 3 depth MIDI controller dimension</i>.</td>
544 </tr>
545 <tr>
546 <td><code>$GIG_DIM_EFFECT4DEPTH</code></td>
547 <td>Constant that identifies the <i>effect 4 depth MIDI controller dimension</i>.</td>
548 </tr>
549 <tr>
550 <td><code>$GIG_DIM_EFFECT5DEPTH</code></td>
551 <td>Constant that identifies the <i>effect 5 depth MIDI controller dimension</i>.</td>
552 </tr>
553 <tr>
554 <td><code>$GIG_DIM_GENPURPOSE1</code></td>
555 <td>Constant that identifies the <i>general purpose 1 MIDI controller dimension</i>.</td>
556 </tr>
557 <tr>
558 <td><code>$GIG_DIM_GENPURPOSE2</code></td>
559 <td>Constant that identifies the <i>general purpose 2 MIDI controller dimension</i>.</td>
560 </tr>
561 <tr>
562 <td><code>$GIG_DIM_GENPURPOSE3</code></td>
563 <td>Constant that identifies the <i>general purpose 3 MIDI controller dimension</i>.</td>
564 </tr>
565 <tr>
566 <td><code>$GIG_DIM_GENPURPOSE4</code></td>
567 <td>Constant that identifies the <i>general purpose 4 MIDI controller dimension</i>.</td>
568 </tr>
569 <tr>
570 <td><code>$GIG_DIM_GENPURPOSE5</code></td>
571 <td>Constant that identifies the <i>general purpose 5 MIDI controller dimension</i>.</td>
572 </tr>
573 <tr>
574 <td><code>$GIG_DIM_GENPURPOSE6</code></td>
575 <td>Constant that identifies the <i>general purpose 6 MIDI controller dimension</i>.</td>
576 </tr>
577 <tr>
578 <td><code>$GIG_DIM_GENPURPOSE7</code></td>
579 <td>Constant that identifies the <i>general purpose 7 MIDI controller dimension</i>.</td>
580 </tr>
581 <tr>
582 <td><code>$GIG_DIM_GENPURPOSE8</code></td>
583 <td>Constant that identifies the <i>general purpose 8 MIDI controller dimension</i>.</td>
584 </tr>
585 </table>
586
587 </body>
588 </html>

  ViewVC Help
Powered by ViewVC