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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2946 - (hide annotations) (download) (as text)
Thu Jul 14 00:44:04 2016 UTC (7 years, 9 months ago) by schoenebeck
File MIME type: text/html
File size: 19692 byte(s)
* NKSP: Added built-in functions inc() and dec().

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

  ViewVC Help
Powered by ViewVC