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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 2732 by schoenebeck, Sun Apr 26 20:54:00 2015 UTC revision 3248 by schoenebeck, Sun May 28 22:31:20 2017 UTC
# Line 28  Line 28 
28          <th>Function</th> <th>Description</th>          <th>Function</th> <th>Description</th>
29        </tr>        </tr>
30        <tr>        <tr>
31          <td><code>message()</code></td>          <td><code lang="nksp">array_equal()</code></td>
32            <td>Check whether two arrays are equal.</td>
33          </tr>
34          <tr>
35            <td><code lang="nksp">dec()</code></td>
36            <td>Decrements the passed integer variable by one.</td>
37          </tr>
38          <tr>
39            <td><code>inc()</code></td>
40            <td>Increments the passed integer variable by one.</td>
41          </tr>
42          <tr>
43            <td><code>in_range()</code></td>
44            <td>Checks whether a value is between two other values.</td>
45          </tr>
46          <tr>
47            <td><code lang="nksp">message()</code></td>
48          <td>Prints text to the sampler's terminal.</td>          <td>Prints text to the sampler's terminal.</td>
49        </tr>        </tr>
50        <tr>        <tr>
51            <td><code>search()</code></td>
52            <td>Search for a certain value within an array.</td>
53          </tr>
54          <tr>
55            <td><code>sort()</code></td>
56            <td>Sort the given array.</td>
57          </tr>
58          <tr>
59          <td><code>exit()</code></td>          <td><code>exit()</code></td>
60          <td>Stops execution of the current event handler instance.</td>          <td>Stops execution of the current event handler instance.</td>
61        </tr>        </tr>
# Line 40  Line 64 
64          <td>Pauses execution for a certain amount of time.</td>          <td>Pauses execution for a certain amount of time.</td>
65        </tr>        </tr>
66        <tr>        <tr>
67            <td><code>stop_wait()</code></td>
68            <td>Resumes execution of a suspended script callback.</td>
69          </tr>
70          <tr>
71          <td><code>abs()</code></td>          <td><code>abs()</code></td>
72          <td>Calculates the absolute value of a given value.</td>          <td>Calculates the absolute value of a given value.</td>
73        </tr>        </tr>
# Line 48  Line 76 
76          <td>Random number generator.</td>          <td>Random number generator.</td>
77        </tr>        </tr>
78        <tr>        <tr>
79            <td><code>min()</code></td>
80            <td>Calculates the minimum value of two given values.</td>
81          </tr>
82          <tr>
83            <td><code>max()</code></td>
84            <td>Calculates the maximum value of two given values.</td>
85          </tr>
86          <tr>
87          <td><code>num_elements()</code></td>          <td><code>num_elements()</code></td>
88          <td>Returns the size of the requested array variable.</td>          <td>Returns the size of the requested array variable.</td>
89        </tr>        </tr>
90          <tr>
91            <td><code>sh_left()</code></td>
92            <td>Calculates a left bit shifted value.</td>
93          </tr>
94          <tr>
95            <td><code>sh_right()</code></td>
96            <td>Calculates a right bit shifted value.</td>
97          </tr>
98      </table>      </table>
99            
100      <h3>Common Sampler Functions</h3>      <h3>Common Sampler Functions</h3>
# Line 67  Line 111 
111          <td>Triggers a new note.</td>          <td>Triggers a new note.</td>
112        </tr>        </tr>
113        <tr>        <tr>
114            <td><code>change_note()</code></td>
115            <td>Change MIDI note number of note.</td>
116          </tr>
117          <tr>
118            <td><code>change_pan()</code></td>
119            <td>Changes panning of voices (stereo balance).</td>
120          </tr>
121          <tr>
122            <td><code>change_tune()</code></td>
123            <td>Changes the tuning of voices.</td>
124          </tr>
125          <tr>
126            <td><code>change_tune_time()</code></td>
127            <td>Changes the duration of tuning changes.</td>
128          </tr>
129          <tr>
130            <td><code>change_tune_curve()</code></td>
131            <td>Changes the curve type of tuning changes.</td>
132          </tr>
133          <tr>
134            <td><code>change_vol()</code></td>
135            <td>Changes the volume of voices.</td>
136          </tr>
137          <tr>
138            <td><code>change_vol_time()</code></td>
139            <td>Changes the duration of volume changes.</td>
140          </tr>
141          <tr>
142            <td><code>change_vol_curve()</code></td>
143            <td>Changes the curve type of volume changes.</td>
144          </tr>
145          <tr>
146            <td><code>change_cutoff()</code></td>
147            <td>Changes filter cutoff frequency of voices.</td>
148          </tr>
149          <tr>
150            <td><code>change_reso()</code></td>
151            <td>Changes filter resonance of voices.</td>
152          </tr>
153          <tr>
154            <td><code>change_attack()</code></td>
155            <td>Modifies the attack time of voices.</td>
156          </tr>
157          <tr>
158            <td><code>change_decay()</code></td>
159            <td>Modifies the decay time of voices.</td>
160          </tr>
161          <tr>
162            <td><code>change_release()</code></td>
163            <td>Modifies the release time of voices.</td>
164          </tr>
165          <tr>
166            <td><code>change_amp_lfo_depth()</code></td>
167            <td>Modifies the amplitude LFO depth.</td>
168          </tr>
169          <tr>
170            <td><code>change_amp_lfo_freq()</code></td>
171            <td>Modifies the amplitude LFO frequency.</td>
172          </tr>
173          <tr>
174            <td><code>change_pitch_lfo_depth()</code></td>
175            <td>Modifies the pitch LFO depth.</td>
176          </tr>
177          <tr>
178            <td><code>change_pitch_lfo_freq()</code></td>
179            <td>Modifies the pitch LFO frequency.</td>
180          </tr>
181          <tr>
182            <td><code>change_velo()</code></td>
183            <td>Change MIDI velocity of note.</td>
184          </tr>
185          <tr>
186            <td><code>event_status()</code></td>
187            <td>Checks and returns whether a particular note is still alive.</td>
188          </tr>
189          <tr>
190            <td><code>fade_in()</code></td>
191            <td>Fade the requested note in.</td>
192          </tr>
193          <tr>
194            <td><code>fade_out()</code></td>
195            <td>Fade the requested note out.</td>
196          </tr>
197          <tr>
198            <td><code>get_event_par()</code></td>
199            <td>Get the current value of a specific note parameter.</td>
200          </tr>
201          <tr>
202            <td><code>set_event_par()</code></td>
203            <td>Change the value of a specific note parameter.</td>
204          </tr>
205          <tr>
206          <td><code>set_controller()</code></td>          <td><code>set_controller()</code></td>
207          <td>Creates a MIDI control change event.</td>          <td>Creates a MIDI control change event.</td>
208        </tr>        </tr>
# Line 109  Line 245 
245          <td><code>gig_set_dim_zone()</code></td>          <td><code>gig_set_dim_zone()</code></td>
246          <td>Changes the currently active dimension zone.</td>          <td>Changes the currently active dimension zone.</td>
247        </tr>        </tr>
248          <tr>
249            <td><code>same_region()</code></td>
250            <td>Check whether two keys are mapped to the same region.</td>
251          </tr>
252      </table>      </table>
253    
254      <h2>Built-In Variables</h2>      <h2>Built-In Variables</h2>
# Line 116  Line 256 
256        These are the built-in variables and built-in constants available with the        These are the built-in variables and built-in constants available with the
257        NKSP realt-time instrument script language.        NKSP realt-time instrument script language.
258      </p>      </p>
259        
260        <h3>Core Language Variables</h3>
261        <p>
262          Most fundamental NKSP built-in variables, independent from any purpose of
263          being used in a sampler.
264        </p>
265        <table>
266          <tr>
267            <th>Variable</th> <th>Description</th>
268          </tr>
269          <tr>
270            <td><code>$KSP_TIMER</code></td>
271            <td>Preserved for compatiblity reasons with KSP, returns the same value
272               as <code>$NKSP_REAL_TIMER</code> (refer to the latter for details).
273               Note that KSP's <code>reset_ksp_timer()</code> function is not available with
274               NKSP. However when calculating time differences between two time
275               stamps taken with <code>$NKSP_REAL_TIMER</code>, calling such a reset
276               function is not required, because the underlying clock does not stop
277               when it reached its value limit (which happens every 71 minutes), instead the clock
278               will automatically restart from zero and the calculated time difference
279               even between such transitions will reflect correct durations.</td>
280          </tr>
281          <tr>
282            <td><code>$NKSP_PERF_TIMER</code></td>
283            <td>Returns the current performance time stamp (in microseconds) of the
284                script running. You may read this variable from time to time to take
285                time stamps which can be used to calculate the time difference
286                (in microseconds) which elapsed between them. A performance time
287                stamp is based on the script's actual CPU execution time. So the
288                internal clock which is used for generating such time stamps is only
289                running forward if the respective script is actually executed by the
290                CPU. Whenever your script is not really executed by the CPU (i.e. because
291                your script got suspended by a wait() call or got forcely suspended due to
292                real-time constraints, or when the entire sampler application got suspended
293                by the OS for other applications or OS tasks) then the underlying internal
294                clock is paused as well.
295                <note class="important">
296                  You should only use this built-in variable for script development
297                  purposes (i.e. for bench marking the performance of your script).
298                  You should <b>not</b> use it with your final production sounds!
299                  It is not appropriate for being used in a musical context, because
300                  when an offline bounce is performed for instance, the musical timing
301                  will be completely unrelated to the CPU execution time. Plus using
302                  this variable may cause audio drop outs on some systems. In a musical
303                  context you should use <code>$ENGINE_UPTIME</code> instead, which is
304                  also safe for offline bounces.
305                </note>
306                <note>
307                  On some systems <code>$NKSP_REAL_TIMER</code> and
308                  <code>$NKSP_PERF_TIMER</code> will actually return the same value. So the
309                  difference between them is not implemented for all systems at the moment.
310                </note>
311            </td>
312          </tr>
313          <tr>
314            <td><code>$NKSP_REAL_TIMER</code></td>
315            <td>Returns the current time stamp in reality (in microseconds). You may
316                read this variable from time to time to take
317                time stamps which can be used to calculate the time difference
318                (in microseconds) which elapsed between them. A "real" time
319                stamp is based on an internal clock which constantly proceeds, so this
320                internal clock also continues counting while your script is either suspended
321                (i.e. because your script got suspended by a wait() call or got forcely
322                suspended due to real-time constraints) and it also continues counting
323                even if the entire sampler application got suspended by the OS (i.e. to
324                execute other applications for multi-tasking or to perform OS tasks).
325                <note class="important">
326                  You should only use this built-in variable for script development
327                  purposes (i.e. for bench marking the performance of your script).
328                  You should <b>not</b> use it with your final production sounds!
329                  It is not appropriate for being used in a musical context, because
330                  when an offline bounce is performed for instance, the musical timing
331                  will be completely unrelated to the CPU execution time. Plus using
332                  this variable may cause audio drop outs on some systems. In a musical
333                  context you should use <code>$ENGINE_UPTIME</code> instead, which is
334                  also safe for offline bounces.
335                </note>
336                <note>
337                  On some systems <code>$NKSP_REAL_TIMER</code> and
338                  <code>$NKSP_PERF_TIMER</code> will actually return the same value. So the
339                  difference between them is not implemented for all systems at the moment.
340                </note>
341            </td>
342          </tr>
343          <tr>
344            <td><code>$NI_CALLBACK_ID</code></td>
345            <td>Reflects the current event handler instance's unique callback ID.
346                For the same event type there may be more than
347                one event handler instances running. Each one of them has
348                its own callback ID. You can get the current event handler
349                instance's callback ID by reading this built-in variable.</td>
350          </tr>
351          <tr>
352            <td><code>$NI_CALLBACK_TYPE</code></td>
353            <td>Reflects the event type of the current event handler. This variable
354                may reflect one of the following built-in constants:
355                <code>$NI_CB_TYPE_INIT</code>, <code>$NI_CB_TYPE_NOTE</code>,
356                <code>$NI_CB_TYPE_RELEASE</code>, <code>$NI_CB_TYPE_CONTROLLER</code>.</td>
357          </tr>
358          <tr>
359            <td><code>$NI_CB_TYPE_INIT</code></td>
360            <td>Built-in constant reflecting an <code>init</code> event handler type.</td>
361          </tr>
362          <tr>
363            <td><code>$NI_CB_TYPE_NOTE</code></td>
364            <td>Built-in constant reflecting a <code>note</code> event handler type.</td>
365          </tr>
366          <tr>
367            <td><code>$NI_CB_TYPE_RELEASE</code></td>
368            <td>Built-in constant reflecting a <code>release</code> event handler type.</td>
369          </tr>
370          <tr>
371            <td><code>$NI_CB_TYPE_CONTROLLER</code></td>
372            <td>Built-in constant reflecting a <code>controller</code> event handler type.</td>
373          </tr>
374          <tr>
375            <td><code>$NKSP_IGNORE_WAIT</code></td>
376            <td>If this boolean built-in variable is <code>1</code> then all calls of your
377                event handler instance to function <code>wait()</code> will be ignored.
378                This may for example be the case if another event handler instance
379                resumed your paused script by calling <code>stop_wait()</code> and
380                passing <code>1</code> to the 2nd argument of that function.</td>
381          </tr>
382        </table>
383    
384      <h3>Common Sampler Variables</h3>      <h3>Common Sampler Variables</h3>
385      <p>      <p>
386        Basic sampler related built-in variables and constants, independent from a        Basic sampler related built-in variables and constants, independent from a
# Line 127  Line 391 
391          <th>Variable</th> <th>Description</th>          <th>Variable</th> <th>Description</th>
392        </tr>        </tr>
393        <tr>        <tr>
394            <td><code>%ALL_EVENTS</code></td>
395            <td>
396              Note IDs of all currently active notes of the current sampler part (a.k.a. sampler channel).
397              This may be passed to many built-in functions like <code>note_off()</code>.
398              This array variable only contains IDs of notes which were launched due
399              to MIDI note-on events. This variable does not contain IDs of child notes
400              (i.e. notes which were launched programmatically by calling <code>play_note()</code>).
401              <note>
402                In contrast to KSP this variable is an integer array type, whereas KSP's
403                pendent of this built-in variable is an integer constant (scalar) called
404                <code>$ALL_EVENTS</code>. Using the latter with NKSP will cause a
405                parser warning, the behavior will be the same though.
406              </note>
407            </td>
408          </tr>
409          <tr>
410          <td><code>$CC_NUM</code></td>          <td><code>$CC_NUM</code></td>
411          <td>MIDI controller number that caused the <code>controller</code>          <td>MIDI controller number that caused the <code>controller</code>
412              handler to be executed (only useful in the context of a              handler to be executed (only useful in the context of a
# Line 160  Line 440 
440              <code>note</code> or <code>release</code> handler).</td>              <code>note</code> or <code>release</code> handler).</td>
441        </tr>        </tr>
442        <tr>        <tr>
443            <td><code>$EVENT_STATUS_INACTIVE</code></td>
444            <td>Constant bit flag used as possible return value by
445                <code>event_status()</code> in case the requested
446                note is not "alive".</td>
447          </tr>
448          <tr>
449            <td><code>$EVENT_STATUS_NOTE_QUEUE</code></td>
450            <td>Constant bit flag used as possible return value by
451                <code>event_status()</code> in case the requested
452                note is still "alive".</td>
453          </tr>
454          <tr>
455            <td><code>$EVENT_PAR_NOTE</code></td>
456            <td>Constant value symbolizing the "note number" parameter. See
457                <code>get_event_par()</code> and <code>set_event_par()</code>
458                for details.</td>
459          </tr>
460          <tr>
461            <td><code>$EVENT_PAR_TUNE</code></td>
462            <td>Constant value symbolizing the "tune" parameter. See
463                <code>get_event_par()</code> and <code>set_event_par()</code>
464                for details.</td>
465          </tr>
466          <tr>
467            <td><code>$EVENT_PAR_VELOCITY</code></td>
468            <td>Constant value symbolizing the "note velocity" parameter. See
469                <code>get_event_par()</code> and <code>set_event_par()</code>
470                for details.</td>
471          </tr>
472          <tr>
473            <td><code>$EVENT_PAR_VOLUME</code></td>
474            <td>Constant value symbolizing the "volume" parameter. See
475                <code>get_event_par()</code> and <code>set_event_par()</code>
476                for details.</td>
477          </tr>
478          <tr>
479            <td><code>$EVENT_PAR_0</code> to <code>$EVENT_PAR_3</code></td>
480            <td>Four constant values symbolizing the 4 possible user specific
481                parameters, which i.e. might be used to pass data from one script
482                (slot) to another script (slot). See  <code>get_event_par()</code>
483                and <code>set_event_par()</code> for details.</td>
484          </tr>
485          <tr>
486          <td><code>%KEY_DOWN[]</code></td>          <td><code>%KEY_DOWN[]</code></td>
487          <td>This can be used in any context to check whether a certain MIDI          <td>This can be used in any context to check whether a certain MIDI
488              key is currently pressed down. Use the respective MIDI note number              key is currently pressed down. Use the respective MIDI note number
489              as index to this array variable.</td>              as index to this array variable (see also <code>event_status()</code>).</td>
490          </tr>
491          <tr>
492            <td><code>$NKSP_EASE_IN_EASE_OUT</code></td>
493            <td>Used to select a fade curve with "ease in and ease out" shape.</td>
494          </tr>
495          <tr>
496            <td><code>$NKSP_LINEAR</code></td>
497            <td>Used to select a fade curve with linear shape.</td>
498        </tr>        </tr>
499        <tr>        <tr>
500          <td><code>$VCC_MONO_AT</code></td>          <td><code>$VCC_MONO_AT</code></td>
# Line 183  Line 514 
514              This is somewhat different than in the MIDI standard. With              This is somewhat different than in the MIDI standard. With
515              NKSP pitch bend is handled like an additional "regular" MIDI CC controller.              NKSP pitch bend is handled like an additional "regular" MIDI CC controller.
516              Therefore use              Therefore use
517              <code>%CC[$VCC_PITCH_BEND]</code> to obtain the current aftertouch value              <code>%CC[$VCC_PITCH_BEND]</code> to obtain the current pitch bend wheel value
518              in the context of a <code>controller</code> event handler.</td>              in the context of a <code>controller</code> event handler.</td>
519        </tr>        </tr>
520        <tr>        <tr>
# Line 191  Line 522 
522          <td>Used to select one of the available 28 event groups.          <td>Used to select one of the available 28 event groups.
523          See <code>set_event_mark()</code> for details.</td>          See <code>set_event_mark()</code> for details.</td>
524        </tr>        </tr>
525          <tr>
526            <td><code>$ENGINE_UPTIME</code></td>
527            <td>Returns the current time stamp (in milliseconds) for being
528                used in a musical context. You may read this variable from time to time
529                to take time stamps which can be used to calculate the time difference
530                (in milliseconds) which elapsed between them. These timing values are
531                based on the internal sample rate and thus it can safely be used to
532                perform musical timing related tasks in your scripts. Especially
533                your script will also continue to behave correctly when an offline bounce
534                of a song is performed.
535            </td>
536          </tr>
537      </table>      </table>
538    
539      <h3>GigaStudio Format Variables</h3>      <h3>GigaStudio Format Variables</h3>
# Line 227  Line 570 
570          <td>Constant that identifies the <i>keyboard position dimension</i>.</td>          <td>Constant that identifies the <i>keyboard position dimension</i>.</td>
571        </tr>        </tr>
572        <tr>        <tr>
573          <td><code>$GIG_DIM_ROUNDROBIN"</code></td>          <td><code>$GIG_DIM_ROUNDROBIN</code></td>
574          <td>Constant that identifies the <i>round robin dimension</i>.</td>          <td>Constant that identifies the <i>round robin dimension</i>.</td>
575        </tr>        </tr>
576        <tr>        <tr>

Legend:
Removed from v.2732  
changed lines
  Added in v.3248

  ViewVC Help
Powered by ViewVC