Updated documentation files.

This commit is contained in:
redtide 2019-10-05 11:39:20 +02:00
parent f2d1a2ced8
commit 16e94cc0c5
4 changed files with 109 additions and 112 deletions

View file

@ -49,11 +49,11 @@ navigation:
type: normal type: normal
url: /contacts url: /contacts
#- title: Status - title: Status
# icon_type: tasks icon_type: tasks
# icon_category: fas icon_category: fas
# type: normal type: normal
# url: /status url: /status
- title: Downloads - title: Downloads
type: normal type: normal

View file

@ -1,5 +1,4 @@
# TODO: fill with supported opcodes and tests name: "sfizz"
name: "Sfizz"
license: "BSD-2-Clause" license: "BSD-2-Clause"
url: "https://sfztools.github.io/sfizz/" url: "https://sfztools.github.io/sfizz/"
documented: true documented: true
@ -48,16 +47,16 @@ categories:
opcodes: opcodes:
- name: "count" - name: "count"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "delay" - name: "delay"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "delay_ccN" - name: "delay_ccN"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "x"
- name: "delay_random" - name: "delay_random"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "delay_samples" - name: "delay_samples"
version: "SFZ v2" version: "SFZ v2"
support: "x" support: "x"
@ -66,28 +65,28 @@ categories:
support: "x" support: "x"
- name: "end" - name: "end"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "loop_mode" - name: "loop_mode"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "loop_start" - name: "loop_start"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "loop_end" - name: "loop_end"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "offset" - name: "offset"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "offset_ccN" - name: "offset_ccN"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "x"
- name: "offset_random" - name: "offset_random"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "sample" - name: "sample"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "sync_beats" - name: "sync_beats"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "x"
@ -105,7 +104,7 @@ categories:
support: "x" support: "x"
- name: "loop_count" - name: "loop_count"
version: "ARIA" version: "ARIA"
support: "x" support: "v"
- name: "loop_crossfade" - name: "loop_crossfade"
version: "SFZ v2" version: "SFZ v2"
support: "x" support: "x"
@ -129,10 +128,10 @@ categories:
opcodes: opcodes:
- name: "#define" - name: "#define"
version: "SFZ v2" version: "SFZ v2"
support: "x" support: "v"
- name: "default_path" - name: "default_path"
version: "SFZ v2" version: "SFZ v2"
support: "x" support: "v"
- name: "note_offset" - name: "note_offset"
version: "SFZ v2" version: "SFZ v2"
support: "x" support: "x"
@ -141,14 +140,14 @@ categories:
support: "x" support: "x"
- name: "label_ccN" - name: "label_ccN"
version: "ARIA" version: "ARIA"
support: "x" support: "v"
- name: "set_ccN" - name: "set_ccN"
version: "SFZ v2" version: "SFZ v2"
support: "x" support: "v"
- name: "#include" - name: "#include"
version: "ARIA" version: "ARIA"
support: "x" support: "v"
- name: "hint_" - name: "hint_*"
version: "ARIA" version: "ARIA"
support: "x" support: "x"
- name: "set_hdccN" - name: "set_hdccN"
@ -189,13 +188,13 @@ categories:
opcodes: opcodes:
- name: "group" - name: "group"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "off_by" - name: "off_by"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "off_mode" - name: "off_mode"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "output" - name: "output"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "x"
@ -228,34 +227,34 @@ categories:
opcodes: opcodes:
- name: "key" - name: "key"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "lokey" - name: "lokey"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "hikey" - name: "hikey"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "lovel" - name: "lovel"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "hivel" - name: "hivel"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "Region Logic: MIDI Conditions" - name: "Region Logic: MIDI Conditions"
opcodes: opcodes:
- name: "lochan" - name: "lochan"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "hichan" - name: "hichan"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "loccN" - name: "loccN"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "hiccN" - name: "hiccN"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "lobend" - name: "lobend"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "x"
@ -264,28 +263,28 @@ categories:
support: "x" support: "x"
- name: "sw_lokey" - name: "sw_lokey"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "sw_hikey" - name: "sw_hikey"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "sw_last" - name: "sw_last"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "sw_down" - name: "sw_down"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "sw_up" - name: "sw_up"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "sw_previous" - name: "sw_previous"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "sw_vel" - name: "sw_vel"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "sustain_sw" - name: "sustain_sw"
version: "SFZ v2" version: "SFZ v2"
support: "x" support: "v"
- name: "sostenuto_sw" - name: "sostenuto_sw"
version: "SFZ v2" version: "SFZ v2"
support: "x" support: "x"
@ -303,7 +302,7 @@ categories:
support: "x" support: "x"
- name: "sw_default" - name: "sw_default"
version: "ARIA" version: "ARIA"
support: "x" support: "v"
- name: "sw_label" - name: "sw_label"
version: "ARIA" version: "ARIA"
support: "x" support: "x"
@ -348,16 +347,16 @@ categories:
support: "x" support: "x"
- name: "lorand" - name: "lorand"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "hirand" - name: "hirand"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "seq_length" - name: "seq_length"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "seq_position" - name: "seq_position"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "lotimer" - name: "lotimer"
version: "SFZ v2" version: "SFZ v2"
support: "x" support: "x"
@ -369,13 +368,13 @@ categories:
opcodes: opcodes:
- name: "trigger" - name: "trigger"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "on_loccN" - name: "on_loccN"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "on_hiccN" - name: "on_hiccN"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "start_loccN" - name: "start_loccN"
version: "SFZ v2" version: "SFZ v2"
support: "x" support: "x"
@ -393,19 +392,19 @@ categories:
opcodes: opcodes:
- name: "pan" - name: "pan"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "position" - name: "position"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "volume" - name: "volume"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "gain_ccN" - name: "gain_ccN"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "volume_onccN" - name: "volume_onccN"
version: "SFZ v2" version: "SFZ v2"
support: "x" support: "v"
- name: "volume_smoothccN" - name: "volume_smoothccN"
version: "SFZ v2" version: "SFZ v2"
support: "x" support: "x"
@ -417,7 +416,7 @@ categories:
support: "x" support: "x"
- name: "width" - name: "width"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "width_onccN" - name: "width_onccN"
version: "Cakewalk" version: "Cakewalk"
support: "x" support: "x"
@ -432,67 +431,67 @@ categories:
support: "x" support: "x"
- name: "amp_keycenter" - name: "amp_keycenter"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "amp_keytrack" - name: "amp_keytrack"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "amp_veltrack" - name: "amp_veltrack"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "amp_velcurve_N" - name: "amp_velcurve_N"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "amp_random" - name: "amp_random"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "rt_decay" - name: "rt_decay"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "xf_cccurve" - name: "xf_cccurve"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "xf_keycurve" - name: "xf_keycurve"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "xf_velcurve" - name: "xf_velcurve"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "xfin_loccN" - name: "xfin_loccN"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "xfin_hiccN" - name: "xfin_hiccN"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "xfout_loccN" - name: "xfout_loccN"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "xfout_hiccN" - name: "xfout_hiccN"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "xfin_lokey" - name: "xfin_lokey"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "xfin_hikey" - name: "xfin_hikey"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "xfout_lokey" - name: "xfout_lokey"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "xfout_hikey" - name: "xfout_hikey"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "xfin_lovel" - name: "xfin_lovel"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "xfin_hivel" - name: "xfin_hivel"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "xfout_lovel" - name: "xfout_lovel"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "xfout_hivel" - name: "xfout_hivel"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "phase" - name: "phase"
version: "ARIA" version: "ARIA"
support: "x" support: "x"
@ -531,7 +530,7 @@ categories:
support: "x" support: "x"
- name: "pan_onccN" - name: "pan_onccN"
version: "SFZ v2" version: "SFZ v2"
support: "x" support: "v"
- name: "pan_smoothccN" - name: "pan_smoothccN"
version: "SFZ v2" version: "SFZ v2"
support: "x" support: "x"
@ -654,7 +653,7 @@ categories:
support: "x" support: "x"
- name: "fil2_type" - name: "fil2_type"
version: "SFZ v2" version: "SFZ v2"
support: "x" support: "Partial"
- name: "fil2_veltrack" - name: "fil2_veltrack"
version: "SFZ v2" version: "SFZ v2"
support: "x" support: "x"
@ -705,19 +704,19 @@ categories:
support: "x" support: "x"
- name: "pitch_keycenter" - name: "pitch_keycenter"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "pitch_keytrack" - name: "pitch_keytrack"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "pitch_random" - name: "pitch_random"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "pitch_veltrack" - name: "pitch_veltrack"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "transpose" - name: "transpose"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "transpose_onccN" - name: "transpose_onccN"
version: "SFZ v2" version: "SFZ v2"
support: "x" support: "x"
@ -729,7 +728,7 @@ categories:
support: "x" support: "x"
- name: "tune" - name: "tune"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "tune_onccN" - name: "tune_onccN"
version: "SFZ v2" version: "SFZ v2"
support: "x" support: "x"
@ -750,64 +749,64 @@ categories:
opcodes: opcodes:
- name: "ampeg_attack" - name: "ampeg_attack"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "ampeg_attackccN" - name: "ampeg_attackccN"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "ampeg_vel2attack" - name: "ampeg_vel2attack"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "ampeg_decay" - name: "ampeg_decay"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "ampeg_decayccN" - name: "ampeg_decayccN"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "ampeg_vel2decay" - name: "ampeg_vel2decay"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "ampeg_delay" - name: "ampeg_delay"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "ampeg_delayccN" - name: "ampeg_delayccN"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "ampeg_vel2delay" - name: "ampeg_vel2delay"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "ampeg_hold" - name: "ampeg_hold"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "ampeg_holdccN" - name: "ampeg_holdccN"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "ampeg_vel2hold" - name: "ampeg_vel2hold"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "ampeg_release" - name: "ampeg_release"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "ampeg_releaseccN" - name: "ampeg_releaseccN"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "ampeg_vel2release" - name: "ampeg_vel2release"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "ampeg_sustain" - name: "ampeg_sustain"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "ampeg_sustainccN" - name: "ampeg_sustainccN"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "ampeg_vel2sustain" - name: "ampeg_vel2sustain"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "ampeg_start" - name: "ampeg_start"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "ampeg_startccN" - name: "ampeg_startccN"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "v"
- name: "ampeg_attack_shape" - name: "ampeg_attack_shape"
version: "ARIA" version: "ARIA"
support: "x" support: "x"
@ -913,8 +912,6 @@ categories:
- name: "fileg_startccN" - name: "fileg_startccN"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "x"
- name: "pitcheg_attack" - name: "pitcheg_attack"
version: "SFZ v1" version: "SFZ v1"
support: "x" support: "x"
@ -1398,3 +1395,4 @@ categories:
- name: "vendor_specific" - name: "vendor_specific"
version: "ARIA" version: "ARIA"
support: "x" support: "x"

View file

@ -13,7 +13,7 @@ Sfizz depends on the `sndfile` library.
The Jack client that you will probably build depends on the `jack` library. The Jack client that you will probably build depends on the `jack` library.
To build `sfizz` you need to install both as shared libraries on the system. To build `sfizz` you need to install both as shared libraries on the system.
In Debian-based distributions, this translates into In Debian-based distributions, this translates into
``` ```sh
sudo apt install libjack-jackd2-dev libsndfile1-dev sudo apt install libjack-jackd2-dev libsndfile1-dev
``` ```
@ -40,7 +40,7 @@ If no Jack server is already started it will start one with basic options.
### Possible pitfalls and alternatives ### Possible pitfalls and alternatives
If you already cloned the repository without the `--recursive` option, update the submodules manually with If you already cloned the repository without the `--recursive` option, update the submodules manually with
``` ```sh
git submodule update --init --recursive git submodule update --init --recursive
``` ```

View file

@ -1,7 +1,6 @@
--- ---
title: "Opcodes Support Status" title: "Opcodes Support Status"
lang: "en" lang: "en"
published: false
--- ---
Here is the list of currently supported headers and opcodes. Here is the list of currently supported headers and opcodes.