/[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 2742 by schoenebeck, Wed Apr 29 00:22:59 2015 UTC revision 2966 by schoenebeck, Mon Jul 18 09:56:23 2016 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 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>          <td><code lang="nksp">message()</code></td>
40          <td>Prints text to the sampler's terminal.</td>          <td>Prints text to the sampler's terminal.</td>
41        </tr>        </tr>
# Line 40  Line 48 
48          <td>Pauses execution for a certain amount of time.</td>          <td>Pauses execution for a certain amount of time.</td>
49        </tr>        </tr>
50        <tr>        <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>          <td><code>abs()</code></td>
56          <td>Calculates the absolute value of a given value.</td>          <td>Calculates the absolute value of a given value.</td>
57        </tr>        </tr>
# Line 51  Line 63 
63          <td><code>num_elements()</code></td>          <td><code>num_elements()</code></td>
64          <td>Returns the size of the requested array variable.</td>          <td>Returns the size of the requested array variable.</td>
65        </tr>        </tr>
66          <tr>
67            <td><code>sh_left()</code></td>
68            <td>Calculates a left bit shifted value.</td>
69          </tr>
70          <tr>
71            <td><code>sh_right()</code></td>
72            <td>Calculates a right bit shifted value.</td>
73          </tr>
74      </table>      </table>
75            
76      <h3>Common Sampler Functions</h3>      <h3>Common Sampler Functions</h3>
# Line 67  Line 87 
87          <td>Triggers a new note.</td>          <td>Triggers a new note.</td>
88        </tr>        </tr>
89        <tr>        <tr>
90            <td><code>change_pan()</code></td>
91            <td>Changes panning of voices (stereo balance).</td>
92          </tr>
93          <tr>
94            <td><code>change_tune()</code></td>
95            <td>Changes the tuning of voices.</td>
96          </tr>
97          <tr>
98            <td><code>change_vol()</code></td>
99            <td>Changes the volume of voices.</td>
100          </tr>
101          <tr>
102            <td><code>change_cutoff()</code></td>
103            <td>Changes filter cutoff frequency of voices.</td>
104          </tr>
105          <tr>
106            <td><code>change_reso()</code></td>
107            <td>Changes filter resonance of voices.</td>
108          </tr>
109          <tr>
110            <td><code>change_attack()</code></td>
111            <td>Modifies the attack time of voices.</td>
112          </tr>
113          <tr>
114            <td><code>change_decay()</code></td>
115            <td>Modifies the decay time of voices.</td>
116          </tr>
117          <tr>
118            <td><code>change_release()</code></td>
119            <td>Modifies the release time of voices.</td>
120          </tr>
121          <tr>
122            <td><code>event_status()</code></td>
123            <td>Checks and returns whether a particular note is still alive.</td>
124          </tr>
125          <tr>
126          <td><code>set_controller()</code></td>          <td><code>set_controller()</code></td>
127          <td>Creates a MIDI control change event.</td>          <td>Creates a MIDI control change event.</td>
128        </tr>        </tr>
# Line 116  Line 172 
172        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
173        NKSP realt-time instrument script language.        NKSP realt-time instrument script language.
174      </p>      </p>
175        
176        <h3>Core Language Variables</h3>
177        <p>
178          Most fundamental NKSP built-in variables, independent from any purpose of
179          being used in a sampler.
180        </p>
181        <table>
182          <tr>
183            <th>Variable</th> <th>Description</th>
184          </tr>
185          <tr>
186            <td><code>$KSP_TIMER</code></td>
187            <td>Preserved for compatiblity reasons with KSP, returns the same value
188               as <code>$NKSP_REAL_TIMER</code> (refer to the latter for details).
189               Note that KSP's <code>reset_ksp_timer()</code> function is not available with
190               NKSP. However when calculating time differences between two time
191               stamps taken with <code>$NKSP_REAL_TIMER</code>, calling such a reset
192               function is not required, because the underlying clock does not stop
193               when it reached its value limit (which happens every 71 minutes), instead the clock
194               will automatically restart from zero and the calculated time difference
195               even between such transitions will reflect correct durations.</td>
196          </tr>
197          <tr>
198            <td><code>$NKSP_PERF_TIMER</code></td>
199            <td>Returns the current performance time stamp (in microseconds) of the
200                script running. You may read this variable from time to time to take
201                time stamps which can be used to calculate the time difference
202                (in microseconds) which elapsed between them. A performance time
203                stamp is based on the script's actual CPU execution time. So the
204                internal clock which is used for generating such time stamps is only
205                running forward if the respective script is actually executed by the
206                CPU. Whenever your script is not really executed by the CPU (i.e. because
207                your script got suspended by a wait() call or got forcely suspended due to
208                real-time constraints, or when the entire sampler application got suspended
209                by the OS for other applications or OS tasks) then the underlying internal
210                clock is paused as well.
211                <note class="important">
212                  You should only use this built-in variable for script development
213                  purposes (i.e. for bench marking the performance of your script).
214                  You should <b>not</b> use it with your final production sounds!
215                  It is not appropriate for being used in a musical context, because
216                  when an offline bounce is performed for instance, the musical timing
217                  will be completely unrelated to the CPU execution time. Plus using
218                  this variable may cause audio drop outs on some systems. In a musical
219                  context you should use <code>$ENGINE_UPTIME</code> instead, which is
220                  also safe for offline bounces.
221                </note>
222                <note>
223                  On some systems <code>$NKSP_REAL_TIMER</code> and
224                  <code>$NKSP_PERF_TIMER</code> will actually return the same value. So the
225                  difference between them is not implemented for all systems at the moment.
226                </note>
227            </td>
228          </tr>
229          <tr>
230            <td><code>$NKSP_REAL_TIMER</code></td>
231            <td>Returns the current time stamp in reality (in microseconds). You may
232                read this variable from time to time to take
233                time stamps which can be used to calculate the time difference
234                (in microseconds) which elapsed between them. A "real" time
235                stamp is based on an internal clock which constantly proceeds, so this
236                internal clock also continues counting while your script is either suspended
237                (i.e. because your script got suspended by a wait() call or got forcely
238                suspended due to real-time constraints) and it also continues counting
239                even if the entire sampler application got suspended by the OS (i.e. to
240                execute other applications for multi-tasking or to perform OS tasks).
241                <note class="important">
242                  You should only use this built-in variable for script development
243                  purposes (i.e. for bench marking the performance of your script).
244                  You should <b>not</b> use it with your final production sounds!
245                  It is not appropriate for being used in a musical context, because
246                  when an offline bounce is performed for instance, the musical timing
247                  will be completely unrelated to the CPU execution time. Plus using
248                  this variable may cause audio drop outs on some systems. In a musical
249                  context you should use <code>$ENGINE_UPTIME</code> instead, which is
250                  also safe for offline bounces.
251                </note>
252                <note>
253                  On some systems <code>$NKSP_REAL_TIMER</code> and
254                  <code>$NKSP_PERF_TIMER</code> will actually return the same value. So the
255                  difference between them is not implemented for all systems at the moment.
256                </note>
257            </td>
258          </tr>
259          <tr>
260            <td><code>$NI_CALLBACK_ID</code></td>
261            <td>Reflects the current event handler instance's unique callback ID.
262                For the same event type there may be more than
263                one event handler instances running. Each one of them has
264                its own callback ID. You can get the current event handler
265                instance's callback ID by reading this built-in variable.</td>
266          </tr>
267          <tr>
268            <td><code>$NI_CALLBACK_TYPE</code></td>
269            <td>Reflects the event type of the current event handler. This variable
270                may reflect one of the following built-in constants:
271                <code>$NI_CB_TYPE_INIT</code>, <code>$NI_CB_TYPE_NOTE</code>,
272                <code>$NI_CB_TYPE_RELEASE</code>, <code>$NI_CB_TYPE_CONTROLLER</code>.</td>
273          </tr>
274          <tr>
275            <td><code>$NI_CB_TYPE_INIT</code></td>
276            <td>Built-in constant reflecting an <code>init</code> event handler type.</td>
277          </tr>
278          <tr>
279            <td><code>$NI_CB_TYPE_NOTE</code></td>
280            <td>Built-in constant reflecting a <code>note</code> event handler type.</td>
281          </tr>
282          <tr>
283            <td><code>$NI_CB_TYPE_RELEASE</code></td>
284            <td>Built-in constant reflecting a <code>release</code> event handler type.</td>
285          </tr>
286          <tr>
287            <td><code>$NI_CB_TYPE_CONTROLLER</code></td>
288            <td>Built-in constant reflecting a <code>controller</code> event handler type.</td>
289          </tr>
290          <tr>
291            <td><code>$NKSP_IGNORE_WAIT</code></td>
292            <td>If this boolean built-in variable is <code>1</code> then all calls of your
293                event handler instance to function <code>wait()</code> will be ignored.
294                This may for example be the case if another event handler instance
295                resumed your paused script by calling <code>stop_wait()</code> and
296                passing <code>1</code> to the 2nd argument of that function.</td>
297          </tr>
298        </table>
299    
300      <h3>Common Sampler Variables</h3>      <h3>Common Sampler Variables</h3>
301      <p>      <p>
302        Basic sampler related built-in variables and constants, independent from a        Basic sampler related built-in variables and constants, independent from a
# Line 160  Line 340 
340              <code>note</code> or <code>release</code> handler).</td>              <code>note</code> or <code>release</code> handler).</td>
341        </tr>        </tr>
342        <tr>        <tr>
343            <td><code>$EVENT_STATUS_INACTIVE</code></td>
344            <td>Constant bit flag used as possible return value by
345                <code>event_status()</code> in case the requested
346                note is not "alive".</td>
347          </tr>
348          <tr>
349            <td><code>$EVENT_STATUS_NOTE_QUEUE</code></td>
350            <td>Constant bit flag used as possible return value by
351                <code>event_status()</code> in case the requested
352                note is still "alive".</td>
353          </tr>
354          <tr>
355          <td><code>%KEY_DOWN[]</code></td>          <td><code>%KEY_DOWN[]</code></td>
356          <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
357              key is currently pressed down. Use the respective MIDI note number              key is currently pressed down. Use the respective MIDI note number
358              as index to this array variable.</td>              as index to this array variable (see also <code>event_status()</code>).</td>
359        </tr>        </tr>
360        <tr>        <tr>
361          <td><code>$VCC_MONO_AT</code></td>          <td><code>$VCC_MONO_AT</code></td>
# Line 183  Line 375 
375              This is somewhat different than in the MIDI standard. With              This is somewhat different than in the MIDI standard. With
376              NKSP pitch bend is handled like an additional "regular" MIDI CC controller.              NKSP pitch bend is handled like an additional "regular" MIDI CC controller.
377              Therefore use              Therefore use
378              <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
379              in the context of a <code>controller</code> event handler.</td>              in the context of a <code>controller</code> event handler.</td>
380        </tr>        </tr>
381        <tr>        <tr>
# Line 191  Line 383 
383          <td>Used to select one of the available 28 event groups.          <td>Used to select one of the available 28 event groups.
384          See <code>set_event_mark()</code> for details.</td>          See <code>set_event_mark()</code> for details.</td>
385        </tr>        </tr>
386          <tr>
387            <td><code>$ENGINE_UPTIME</code></td>
388            <td>Returns the current time stamp (in milliseconds) for being
389                used in a musical context. You may read this variable from time to time
390                to take time stamps which can be used to calculate the time difference
391                (in milliseconds) which elapsed between them. These timing values are
392                based on the internal sample rate and thus it can safely be used to
393                perform musical timing related tasks in your scripts. Especially
394                your script will also continue to behave correctly when an offline bounce
395                of a song is performed.
396            </td>
397          </tr>
398      </table>      </table>
399    
400      <h3>GigaStudio Format Variables</h3>      <h3>GigaStudio Format Variables</h3>
Legend:
Removed from v.2742  
changed lines
  Added in v.2966
  ViewVC Help
Powered by ViewVC