/[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 3077 by schoenebeck, Thu Jan 5 18:02:08 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_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>event_status()</code></td>
135            <td>Checks and returns whether a particular note is still alive.</td>
136          </tr>
137          <tr>
138          <td><code>set_controller()</code></td>          <td><code>set_controller()</code></td>
139          <td>Creates a MIDI control change event.</td>          <td>Creates a MIDI control change event.</td>
140        </tr>        </tr>
# Line 116  Line 184 
184        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
185        NKSP realt-time instrument script language.        NKSP realt-time instrument script language.
186      </p>      </p>
187        
188        <h3>Core Language Variables</h3>
189        <p>
190          Most fundamental NKSP built-in variables, independent from any purpose of
191          being used in a sampler.
192        </p>
193        <table>
194          <tr>
195            <th>Variable</th> <th>Description</th>
196          </tr>
197          <tr>
198            <td><code>$KSP_TIMER</code></td>
199            <td>Preserved for compatiblity reasons with KSP, returns the same value
200               as <code>$NKSP_REAL_TIMER</code> (refer to the latter for details).
201               Note that KSP's <code>reset_ksp_timer()</code> function is not available with
202               NKSP. However when calculating time differences between two time
203               stamps taken with <code>$NKSP_REAL_TIMER</code>, calling such a reset
204               function is not required, because the underlying clock does not stop
205               when it reached its value limit (which happens every 71 minutes), instead the clock
206               will automatically restart from zero and the calculated time difference
207               even between such transitions will reflect correct durations.</td>
208          </tr>
209          <tr>
210            <td><code>$NKSP_PERF_TIMER</code></td>
211            <td>Returns the current performance time stamp (in microseconds) of the
212                script running. You may 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 performance time
215                stamp is based on the script's actual CPU execution time. So the
216                internal clock which is used for generating such time stamps is only
217                running forward if the respective script is actually executed by the
218                CPU. Whenever your script is not really executed by the CPU (i.e. because
219                your script got suspended by a wait() call or got forcely suspended due to
220                real-time constraints, or when the entire sampler application got suspended
221                by the OS for other applications or OS tasks) then the underlying internal
222                clock is paused as well.
223                <note class="important">
224                  You should only use this built-in variable for script development
225                  purposes (i.e. for bench marking the performance of your script).
226                  You should <b>not</b> use it with your final production sounds!
227                  It is not appropriate for being used in a musical context, because
228                  when an offline bounce is performed for instance, the musical timing
229                  will be completely unrelated to the CPU execution time. Plus using
230                  this variable may cause audio drop outs on some systems. In a musical
231                  context you should use <code>$ENGINE_UPTIME</code> instead, which is
232                  also safe for offline bounces.
233                </note>
234                <note>
235                  On some systems <code>$NKSP_REAL_TIMER</code> and
236                  <code>$NKSP_PERF_TIMER</code> will actually return the same value. So the
237                  difference between them is not implemented for all systems at the moment.
238                </note>
239            </td>
240          </tr>
241          <tr>
242            <td><code>$NKSP_REAL_TIMER</code></td>
243            <td>Returns the current time stamp in reality (in microseconds). You may
244                read this variable from time to time to take
245                time stamps which can be used to calculate the time difference
246                (in microseconds) which elapsed between them. A "real" time
247                stamp is based on an internal clock which constantly proceeds, so this
248                internal clock also continues counting while your script is either suspended
249                (i.e. because your script got suspended by a wait() call or got forcely
250                suspended due to real-time constraints) and it also continues counting
251                even if the entire sampler application got suspended by the OS (i.e. to
252                execute other applications for multi-tasking or to perform OS tasks).
253                <note class="important">
254                  You should only use this built-in variable for script development
255                  purposes (i.e. for bench marking the performance of your script).
256                  You should <b>not</b> use it with your final production sounds!
257                  It is not appropriate for being used in a musical context, because
258                  when an offline bounce is performed for instance, the musical timing
259                  will be completely unrelated to the CPU execution time. Plus using
260                  this variable may cause audio drop outs on some systems. In a musical
261                  context you should use <code>$ENGINE_UPTIME</code> instead, which is
262                  also safe for offline bounces.
263                </note>
264                <note>
265                  On some systems <code>$NKSP_REAL_TIMER</code> and
266                  <code>$NKSP_PERF_TIMER</code> will actually return the same value. So the
267                  difference between them is not implemented for all systems at the moment.
268                </note>
269            </td>
270          </tr>
271          <tr>
272            <td><code>$NI_CALLBACK_ID</code></td>
273            <td>Reflects the current event handler instance's unique callback ID.
274                For the same event type there may be more than
275                one event handler instances running. Each one of them has
276                its own callback ID. You can get the current event handler
277                instance's callback ID by reading this built-in variable.</td>
278          </tr>
279          <tr>
280            <td><code>$NI_CALLBACK_TYPE</code></td>
281            <td>Reflects the event type of the current event handler. This variable
282                may reflect one of the following built-in constants:
283                <code>$NI_CB_TYPE_INIT</code>, <code>$NI_CB_TYPE_NOTE</code>,
284                <code>$NI_CB_TYPE_RELEASE</code>, <code>$NI_CB_TYPE_CONTROLLER</code>.</td>
285          </tr>
286          <tr>
287            <td><code>$NI_CB_TYPE_INIT</code></td>
288            <td>Built-in constant reflecting an <code>init</code> event handler type.</td>
289          </tr>
290          <tr>
291            <td><code>$NI_CB_TYPE_NOTE</code></td>
292            <td>Built-in constant reflecting a <code>note</code> event handler type.</td>
293          </tr>
294          <tr>
295            <td><code>$NI_CB_TYPE_RELEASE</code></td>
296            <td>Built-in constant reflecting a <code>release</code> event handler type.</td>
297          </tr>
298          <tr>
299            <td><code>$NI_CB_TYPE_CONTROLLER</code></td>
300            <td>Built-in constant reflecting a <code>controller</code> event handler type.</td>
301          </tr>
302          <tr>
303            <td><code>$NKSP_IGNORE_WAIT</code></td>
304            <td>If this boolean built-in variable is <code>1</code> then all calls of your
305                event handler instance to function <code>wait()</code> will be ignored.
306                This may for example be the case if another event handler instance
307                resumed your paused script by calling <code>stop_wait()</code> and
308                passing <code>1</code> to the 2nd argument of that function.</td>
309          </tr>
310        </table>
311    
312      <h3>Common Sampler Variables</h3>      <h3>Common Sampler Variables</h3>
313      <p>      <p>
314        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 319 
319          <th>Variable</th> <th>Description</th>          <th>Variable</th> <th>Description</th>
320        </tr>        </tr>
321        <tr>        <tr>
322            <td><code>%ALL_EVENTS</code></td>
323            <td>
324              Note IDs of all currently active notes of the current sampler part (a.k.a. sampler channel).
325              This may be passed to many built-in functions like <code>note_off()</code>.
326              This array variable only contains IDs of notes which were launched due
327              to MIDI note-on events. This variable does not contain IDs of child notes
328              (i.e. notes which were launched programmatically by calling <code>note_on()</code>).
329              <note>
330                In contrast to KSP this variable is an integer array type, whereas KSP's
331                pendent of this built-in variable is an integer constant (scalar) called
332                <code>$ALL_EVENTS</code>. Using the latter with NKSP will cause a
333                parser warning, the behavior will be the same though.
334              </note>
335            </td>
336          </tr>
337          <tr>
338          <td><code>$CC_NUM</code></td>          <td><code>$CC_NUM</code></td>
339          <td>MIDI controller number that caused the <code>controller</code>          <td>MIDI controller number that caused the <code>controller</code>
340              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 368 
368              <code>note</code> or <code>release</code> handler).</td>              <code>note</code> or <code>release</code> handler).</td>
369        </tr>        </tr>
370        <tr>        <tr>
371            <td><code>$EVENT_STATUS_INACTIVE</code></td>
372            <td>Constant bit flag used as possible return value by
373                <code>event_status()</code> in case the requested
374                note is not "alive".</td>
375          </tr>
376          <tr>
377            <td><code>$EVENT_STATUS_NOTE_QUEUE</code></td>
378            <td>Constant bit flag used as possible return value by
379                <code>event_status()</code> in case the requested
380                note is still "alive".</td>
381          </tr>
382          <tr>
383          <td><code>%KEY_DOWN[]</code></td>          <td><code>%KEY_DOWN[]</code></td>
384          <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
385              key is currently pressed down. Use the respective MIDI note number              key is currently pressed down. Use the respective MIDI note number
386              as index to this array variable.</td>              as index to this array variable (see also <code>event_status()</code>).</td>
387        </tr>        </tr>
388        <tr>        <tr>
389          <td><code>$VCC_MONO_AT</code></td>          <td><code>$VCC_MONO_AT</code></td>
# Line 183  Line 403 
403              This is somewhat different than in the MIDI standard. With              This is somewhat different than in the MIDI standard. With
404              NKSP pitch bend is handled like an additional "regular" MIDI CC controller.              NKSP pitch bend is handled like an additional "regular" MIDI CC controller.
405              Therefore use              Therefore use
406              <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
407              in the context of a <code>controller</code> event handler.</td>              in the context of a <code>controller</code> event handler.</td>
408        </tr>        </tr>
409        <tr>        <tr>
# Line 191  Line 411 
411          <td>Used to select one of the available 28 event groups.          <td>Used to select one of the available 28 event groups.
412          See <code>set_event_mark()</code> for details.</td>          See <code>set_event_mark()</code> for details.</td>
413        </tr>        </tr>
414          <tr>
415            <td><code>$ENGINE_UPTIME</code></td>
416            <td>Returns the current time stamp (in milliseconds) for being
417                used in a musical context. You may read this variable from time to time
418                to take time stamps which can be used to calculate the time difference
419                (in milliseconds) which elapsed between them. These timing values are
420                based on the internal sample rate and thus it can safely be used to
421                perform musical timing related tasks in your scripts. Especially
422                your script will also continue to behave correctly when an offline bounce
423                of a song is performed.
424            </td>
425          </tr>
426      </table>      </table>
427    
428      <h3>GigaStudio Format Variables</h3>      <h3>GigaStudio Format Variables</h3>
Legend:
Removed from v.2732  
changed lines
  Added in v.3077
  ViewVC Help
Powered by ViewVC