sam/sfizz
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated documentation files.

Browse source
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
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/_data/locale/en/layout.yml
View file

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

206
docs/_data/sfz/support.yml
View file

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

4
docs/index.md
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.
To build `sfizz` you need to install both as shared libraries on the system.
In Debian-based distributions, this translates into
```
```sh
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
If you already cloned the repository without the `--recursive` option, update the submodules manually with
```
```sh
git submodule update --init --recursive
```

1
docs/status.md
View file

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