/[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 3215 by schoenebeck, Thu May 25 15:08:50 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">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>          <td>Prints text to the sampler's terminal.</td>
45        </tr>        </tr>
46        <tr>        <tr>
# Line 40  Line 52 
52          <td>Pauses execution for a certain amount of time.</td>          <td>Pauses execution for a certain amount of time.</td>
53        </tr>        </tr>
54        <tr>        <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>          <td><code>abs()</code></td>
60          <td>Calculates the absolute value of a given value.</td>          <td>Calculates the absolute value of a given value.</td>
61        </tr>        </tr>
# Line 48  Line 64 
64          <td>Random number generator.</td>          <td>Random number generator.</td>
65        </tr>        </tr>
66        <tr>        <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>          <td><code>num_elements()</code></td>
76          <td>Returns the size of the requested array variable.</td>          <td>Returns the size of the requested array variable.</td>
77        </tr>        </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>      </table>
87            
88      <h3>Common Sampler Functions</h3>      <h3>Common Sampler Functions</h3>
# Line 67  Line 99 
99          <td>Triggers a new note.</td>          <td>Triggers a new note.</td>
100        </tr>        </tr>
101        <tr>        <tr>
102            <td><code>change_note()</code></td>
103            <td>Change MIDI note number of note.</td>
104          </tr>
105          <tr>
106            <td><code>change_pan()</code></td>
107            <td>Changes panning of voices (stereo balance).</td>
108          </tr>
109          <tr>
110            <td><code>change_tune()</code></td>
111            <td>Changes the tuning of voices.</td>
112          </tr>
113          <tr>
114            <td><code>change_tune_time()</code></td>
115            <td>Changes the duration of tuning changes.</td>
116          </tr>
117          <tr>
118            <td><code>change_vol()</code></td>
119            <td>Changes the volume of voices.</td>
120          </tr>
121          <tr>
122            <td><code>change_vol_time()</code></td>
123            <td>Changes the duration of volume changes.</td>
124          </tr>
125          <tr>
126            <td><code>change_cutoff()</code></td>
127            <td>Changes filter cutoff frequency of voices.</td>
128          </tr>
129          <tr>
130            <td><code>change_reso()</code></td>
131            <td>Changes filter resonance of voices.</td>
132          </tr>
133          <tr>
134            <td><code>change_attack()</code></td>
135            <td>Modifies the attack time of voices.</td>
136          </tr>
137          <tr>
138            <td><code>change_decay()</code></td>
139            <td>Modifies the decay time of voices.</td>
140          </tr>
141          <tr>
142            <td><code>change_release()</code></td>
143            <td>Modifies the release time of voices.</td>
144          </tr>
145          <tr>
146            <td><code>change_amp_lfo_depth()</code></td>
147            <td>Modifies the amplitude LFO depth.</td>
148          </tr>
149          <tr>
150            <td><code>change_amp_lfo_freq()</code></td>
151            <td>Modifies the amplitude LFO frequency.</td>
152          </tr>
153          <tr>
154            <td><code>change_pitch_lfo_depth()</code></td>
155            <td>Modifies the pitch LFO depth.</td>
156          </tr>
157          <tr>
158            <td><code>change_pitch_lfo_freq()</code></td>
159            <td>Modifies the pitch LFO frequency.</td>
160          </tr>
161          <tr>
162            <td><code>change_velo()</code></td>
163            <td>Change MIDI velocity of note.</td>
164          </tr>
165          <tr>
166            <td><code>event_status()</code></td>
167            <td>Checks and returns whether a particular note is still alive.</td>
168          </tr>
169          <tr>
170            <td><code>fade_in()</code></td>
171            <td>Fade the requested note in.</td>
172          </tr>
173          <tr>
174            <td><code>fade_out()</code></td>
175            <td>Fade the requested note out.</td>
176          </tr>
177          <tr>
178            <td><code>get_event_par()</code></td>
179            <td>Get the current value of a specific note parameter.</td>
180          </tr>
181          <tr>
182            <td><code>set_event_par()</code></td>
183            <td>Change the value of a specific note parameter.</td>
184          </tr>
185          <tr>
186          <td><code>set_controller()</code></td>          <td><code>set_controller()</code></td>
187          <td>Creates a MIDI control change event.</td>          <td>Creates a MIDI control change event.</td>
188        </tr>        </tr>
# Line 116  Line 232 
232        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
233        NKSP realt-time instrument script language.        NKSP realt-time instrument script language.
234      </p>      </p>
235        
236        <h3>Core Language Variables</h3>
237        <p>
238          Most fundamental NKSP built-in variables, independent from any purpose of
239          being used in a sampler.
240        </p>
241        <table>
242          <tr>
243            <th>Variable</th> <th>Description</th>
244          </tr>
245          <tr>
246            <td><code>$KSP_TIMER</code></td>
247            <td>Preserved for compatiblity reasons with KSP, returns the same value
248               as <code>$NKSP_REAL_TIMER</code> (refer to the latter for details).
249               Note that KSP's <code>reset_ksp_timer()</code> function is not available with
250               NKSP. However when calculating time differences between two time
251               stamps taken with <code>$NKSP_REAL_TIMER</code>, calling such a reset
252               function is not required, because the underlying clock does not stop
253               when it reached its value limit (which happens every 71 minutes), instead the clock
254               will automatically restart from zero and the calculated time difference
255               even between such transitions will reflect correct durations.</td>
256          </tr>
257          <tr>
258            <td><code>$NKSP_PERF_TIMER</code></td>
259            <td>Returns the current performance time stamp (in microseconds) of the
260                script running. You may 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 performance time
263                stamp is based on the script's actual CPU execution time. So the
264                internal clock which is used for generating such time stamps is only
265                running forward if the respective script is actually executed by the
266                CPU. Whenever your script is not really executed by the CPU (i.e. because
267                your script got suspended by a wait() call or got forcely suspended due to
268                real-time constraints, or when the entire sampler application got suspended
269                by the OS for other applications or OS tasks) then the underlying internal
270                clock is paused as well.
271                <note class="important">
272                  You should only use this built-in variable for script development
273                  purposes (i.e. for bench marking the performance of your script).
274                  You should <b>not</b> use it with your final production sounds!
275                  It is not appropriate for being used in a musical context, because
276                  when an offline bounce is performed for instance, the musical timing
277                  will be completely unrelated to the CPU execution time. Plus using
278                  this variable may cause audio drop outs on some systems. In a musical
279                  context you should use <code>$ENGINE_UPTIME</code> instead, which is
280                  also safe for offline bounces.
281                </note>
282                <note>
283                  On some systems <code>$NKSP_REAL_TIMER</code> and
284                  <code>$NKSP_PERF_TIMER</code> will actually return the same value. So the
285                  difference between them is not implemented for all systems at the moment.
286                </note>
287            </td>
288          </tr>
289          <tr>
290            <td><code>$NKSP_REAL_TIMER</code></td>
291            <td>Returns the current time stamp in reality (in microseconds). You may
292                read this variable from time to time to take
293                time stamps which can be used to calculate the time difference
294                (in microseconds) which elapsed between them. A "real" time
295                stamp is based on an internal clock which constantly proceeds, so this
296                internal clock also continues counting while your script is either suspended
297                (i.e. because your script got suspended by a wait() call or got forcely
298                suspended due to real-time constraints) and it also continues counting
299                even if the entire sampler application got suspended by the OS (i.e. to
300                execute other applications for multi-tasking or to perform OS tasks).
301                <note class="important">
302                  You should only use this built-in variable for script development
303                  purposes (i.e. for bench marking the performance of your script).
304                  You should <b>not</b> use it with your final production sounds!
305                  It is not appropriate for being used in a musical context, because
306                  when an offline bounce is performed for instance, the musical timing
307                  will be completely unrelated to the CPU execution time. Plus using
308                  this variable may cause audio drop outs on some systems. In a musical
309                  context you should use <code>$ENGINE_UPTIME</code> instead, which is
310                  also safe for offline bounces.
311                </note>
312                <note>
313                  On some systems <code>$NKSP_REAL_TIMER</code> and
314                  <code>$NKSP_PERF_TIMER</code> will actually return the same value. So the
315                  difference between them is not implemented for all systems at the moment.
316                </note>
317            </td>
318          </tr>
319          <tr>
320            <td><code>$NI_CALLBACK_ID</code></td>
321            <td>Reflects the current event handler instance's unique callback ID.
322                For the same event type there may be more than
323                one event handler instances running. Each one of them has
324                its own callback ID. You can get the current event handler
325                instance's callback ID by reading this built-in variable.</td>
326          </tr>
327          <tr>
328            <td><code>$NI_CALLBACK_TYPE</code></td>
329            <td>Reflects the event type of the current event handler. This variable
330                may reflect one of the following built-in constants:
331                <code>$NI_CB_TYPE_INIT</code>, <code>$NI_CB_TYPE_NOTE</code>,
332                <code>$NI_CB_TYPE_RELEASE</code>, <code>$NI_CB_TYPE_CONTROLLER</code>.</td>
333          </tr>
334          <tr>
335            <td><code>$NI_CB_TYPE_INIT</code></td>
336            <td>Built-in constant reflecting an <code>init</code> event handler type.</td>
337          </tr>
338          <tr>
339            <td><code>$NI_CB_TYPE_NOTE</code></td>
340            <td>Built-in constant reflecting a <code>note</code> event handler type.</td>
341          </tr>
342          <tr>
343            <td><code>$NI_CB_TYPE_RELEASE</code></td>
344            <td>Built-in constant reflecting a <code>release</code> event handler type.</td>
345          </tr>
346          <tr>
347            <td><code>$NI_CB_TYPE_CONTROLLER</code></td>
348            <td>Built-in constant reflecting a <code>controller</code> event handler type.</td>
349          </tr>
350          <tr>
351            <td><code>$NKSP_IGNORE_WAIT</code></td>
352            <td>If this boolean built-in variable is <code>1</code> then all calls of your
353                event handler instance to function <code>wait()</code> will be ignored.
354                This may for example be the case if another event handler instance
355                resumed your paused script by calling <code>stop_wait()</code> and
356                passing <code>1</code> to the 2nd argument of that function.</td>
357          </tr>
358        </table>
359    
360      <h3>Common Sampler Variables</h3>      <h3>Common Sampler Variables</h3>
361      <p>      <p>
362        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 367 
367          <th>Variable</th> <th>Description</th>          <th>Variable</th> <th>Description</th>
368        </tr>        </tr>
369        <tr>        <tr>
370            <td><code>%ALL_EVENTS</code></td>
371            <td>
372              Note IDs of all currently active notes of the current sampler part (a.k.a. sampler channel).
373              This may be passed to many built-in functions like <code>note_off()</code>.
374              This array variable only contains IDs of notes which were launched due
375              to MIDI note-on events. This variable does not contain IDs of child notes
376              (i.e. notes which were launched programmatically by calling <code>play_note()</code>).
377              <note>
378                In contrast to KSP this variable is an integer array type, whereas KSP's
379                pendent of this built-in variable is an integer constant (scalar) called
380                <code>$ALL_EVENTS</code>. Using the latter with NKSP will cause a
381                parser warning, the behavior will be the same though.
382              </note>
383            </td>
384          </tr>
385          <tr>
386          <td><code>$CC_NUM</code></td>          <td><code>$CC_NUM</code></td>
387          <td>MIDI controller number that caused the <code>controller</code>          <td>MIDI controller number that caused the <code>controller</code>
388              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 416 
416              <code>note</code> or <code>release</code> handler).</td>              <code>note</code> or <code>release</code> handler).</td>
417        </tr>        </tr>
418        <tr>        <tr>
419            <td><code>$EVENT_STATUS_INACTIVE</code></td>
420            <td>Constant bit flag used as possible return value by
421                <code>event_status()</code> in case the requested
422                note is not "alive".</td>
423          </tr>
424          <tr>
425            <td><code>$EVENT_STATUS_NOTE_QUEUE</code></td>
426            <td>Constant bit flag used as possible return value by
427                <code>event_status()</code> in case the requested
428                note is still "alive".</td>
429          </tr>
430          <tr>
431            <td><code>$EVENT_PAR_NOTE</code></td>
432            <td>Constant value symbolizing the "note number" parameter. See
433                <code>get_event_par()</code> and <code>set_event_par()</code>
434                for details.</td>
435          </tr>
436          <tr>
437            <td><code>$EVENT_PAR_TUNE</code></td>
438            <td>Constant value symbolizing the "tune" parameter. See
439                <code>get_event_par()</code> and <code>set_event_par()</code>
440                for details.</td>
441          </tr>
442          <tr>
443            <td><code>$EVENT_PAR_VELOCITY</code></td>
444            <td>Constant value symbolizing the "note velocity" parameter. See
445                <code>get_event_par()</code> and <code>set_event_par()</code>
446                for details.</td>
447          </tr>
448          <tr>
449            <td><code>$EVENT_PAR_VOLUME</code></td>
450            <td>Constant value symbolizing the "volume" parameter. See
451                <code>get_event_par()</code> and <code>set_event_par()</code>
452                for details.</td>
453          </tr>
454          <tr>
455            <td><code>$EVENT_PAR_0</code> to <code>$EVENT_PAR_3</code></td>
456            <td>Four constant values symbolizing the 4 possible user specific
457                parameters, which i.e. might be used to pass data from one script
458                (slot) to another script (slot). See  <code>get_event_par()</code>
459                and <code>set_event_par()</code> for details.</td>
460          </tr>
461          <tr>
462          <td><code>%KEY_DOWN[]</code></td>          <td><code>%KEY_DOWN[]</code></td>
463          <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
464              key is currently pressed down. Use the respective MIDI note number              key is currently pressed down. Use the respective MIDI note number
465              as index to this array variable.</td>              as index to this array variable (see also <code>event_status()</code>).</td>
466        </tr>        </tr>
467        <tr>        <tr>
468          <td><code>$VCC_MONO_AT</code></td>          <td><code>$VCC_MONO_AT</code></td>
# Line 183  Line 482 
482              This is somewhat different than in the MIDI standard. With              This is somewhat different than in the MIDI standard. With
483              NKSP pitch bend is handled like an additional "regular" MIDI CC controller.              NKSP pitch bend is handled like an additional "regular" MIDI CC controller.
484              Therefore use              Therefore use
485              <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
486              in the context of a <code>controller</code> event handler.</td>              in the context of a <code>controller</code> event handler.</td>
487        </tr>        </tr>
488        <tr>        <tr>
# Line 191  Line 490 
490          <td>Used to select one of the available 28 event groups.          <td>Used to select one of the available 28 event groups.
491          See <code>set_event_mark()</code> for details.</td>          See <code>set_event_mark()</code> for details.</td>
492        </tr>        </tr>
493          <tr>
494            <td><code>$ENGINE_UPTIME</code></td>
495            <td>Returns the current time stamp (in milliseconds) for being
496                used in a musical context. You may read this variable from time to time
497                to take time stamps which can be used to calculate the time difference
498                (in milliseconds) which elapsed between them. These timing values are
499                based on the internal sample rate and thus it can safely be used to
500                perform musical timing related tasks in your scripts. Especially
501                your script will also continue to behave correctly when an offline bounce
502                of a song is performed.
503            </td>
504          </tr>
505      </table>      </table>
506    
507      <h3>GigaStudio Format Variables</h3>      <h3>GigaStudio Format Variables</h3>
Legend:
Removed from v.2732  
changed lines
  Added in v.3215
  ViewVC Help
Powered by ViewVC