--- doc/docbase/instrument_scripts/01_instrument_scripts.html 2015/04/28 17:24:16 2738 +++ doc/docbase/instrument_scripts/01_instrument_scripts.html 2017/01/09 19:23:58 3083 @@ -88,22 +88,17 @@

Using Scripts with LinuxSampler

LinuxSampler allows you to write and use such Instrument Scripts - as well. At this point however, support for instrument scripts is limited - to the GigaStudio format engine of LinuxSampler yet. The script engine was - developed in a very modular design, where most of the script engine's - software is independent from the actual sampler format and the - respective sampler format engine is just adding its format specific - extensions to the script language. For example the GigaStudio format - engine adds scripting functions to allow the sound designer to control the - dimension region by scripts. -

-

- In other words: adding script support to the SFZ format engine for - example would not be much work. Simply nobody so far had time and - passion to add the scripting feature to the SFZ engine yet. + as well. At the moment support for instrument scripts is provided by + the GigaStudio format engine, as well as now also by the SFZ format engine of + LinuxSampler. The script engine was developed in a very modular design, + where most of the script engine's software is independent from the + actual sampler format and the respective sampler format engine is just + adding its format specific extensions to the script language. For example + the GigaStudio format engine adds scripting functions to allow the sound + designer to control the dimension region by scripts.

-

Bundling Scripts with Sounds

+

Bundling Scripts with GigaStudio (.gig) Files

Our graphical instrument editor for the GigaStudio format - gigedit - includes an instrument script editor and allows you to attach @@ -111,6 +106,36 @@ gigedit manual for how to manage instrument scripts with gigedit.

+

Bundling Scripts with SFZ (.sfz) Files

+

+ LinuxSampler adds a new opcode script as an + extension to the offical SFZ format. Similar to the sample + opcode, a file system path needs to be assigned to the actual script file that should + be loaded by the sampler. The script opcode should be placed + in the SFZ file's <global> section. However at the moment + the precise location of the opcode will simply be ignored by LinuxSampler. A simple example + SFZ file may look like this: +

+ +// real-time instrument scripts should be loaded in global section +<global> +script=path/to/my_nksp_script.txt + +// just load one audio file and assign in to entire key range +<group> +sample=some_sound.wav + +

+ At the moment LinuxSampler supports only one script file per instrument. + Accordingly there should only be one script opcode + occurrence in your SFZ file. If you place more than one + script opcode to a SFZ file, then only the first + script will be loaded and the sampler will print a warning. In future this will + change, and the sampler will support running multiple scripts, and will run + the scripts subsequently on events according to the order the scripts appeared + in the SFZ file. +

+

Learning the Script Language

You certainly find some instrument scripts ready to be used on the