/[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 2949 - (show annotations) (download) (as text)
Fri Jul 15 15:33:43 2016 UTC (4 years, 10 months ago) by schoenebeck
File MIME type: text/html
File size: 21745 byte(s)
* NKSP: Added function stop_wait().
* NKSP: Added variables $NI_CALLBACK_ID and $NI_CALLBACK_TYPE.
* NKSP: Added constants $NI_CB_TYPE_INIT, $NI_CB_TYPE_NOTE,
  $NI_CB_TYPE_RELEASE and $NI_CB_TYPE_CONTROLLER.
* NKSP: Updated wait() description for those new ones mentioned
  above.

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

  ViewVC Help
Powered by ViewVC