Mercurial > hg > pub > prymula > com
comparison DPF-Prymula-audioplugins/dpf/README.md @ 3:84e66ea83026
DPF-Prymula-audioplugins-0.231015-2
| author | prymula <prymula76@outlook.com> |
|---|---|
| date | Mon, 16 Oct 2023 21:53:34 +0200 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| 2:cf2cb71d31dd | 3:84e66ea83026 |
|---|---|
| 1 # DPF - DISTRHO Plugin Framework | |
| 2 [](https://github.com/DISTRHO/DPF/actions/workflows/makefile.yml) | |
| 3 [](https://github.com/DISTRHO/DPF/actions/workflows/cmake.yml) | |
| 4 [](https://github.com/DISTRHO/DPF/actions/workflows/example-plugins.yml) | |
| 5 | |
| 6 DPF is designed to make development of new plugins an easy and enjoyable task. | |
| 7 It allows developers to create plugins with custom UIs using a simple C++ API. | |
| 8 The framework facilitates exporting various different plugin formats from the same code-base. | |
| 9 | |
| 10 DPF can build for LADSPA, DSSI, LV2, VST2, VST3 and CLAP formats. | |
| 11 A JACK/Standalone mode is also available, allowing you to quickly test plugins. | |
| 12 | |
| 13 Plugin DSP and UI communication is done via key-value string pairs. | |
| 14 You send messages from the UI to the DSP side, which is automatically saved in the host when required. | |
| 15 (You can also store state internally if needed, but this breaks DSSI compatibility). | |
| 16 | |
| 17 Getting time information from the host is possible. | |
| 18 It uses the same format as the JACK Transport API, making porting some code easier. | |
| 19 | |
| 20 Provided features and implementation status for specific plugin formats can be seen in [FEATURES.md](FEATURES.md). | |
| 21 | |
| 22 ## Licensing | |
| 23 | |
| 24 DPF is released under ISC, which basically means you can do whatever you want as long as you credit the original authors. | |
| 25 Some plugin formats may have additional restrictions, see [LICENSING.md](LICENSING.md) for details. | |
| 26 | |
| 27 | |
| 28 ## Help and documentation | |
| 29 | |
| 30 Bug reports happen on the [DPF github project](https://github.com/DISTRHO/DPF/issues). | |
| 31 | |
| 32 Online documentation is available at [https://distrho.github.io/DPF/](https://distrho.github.io/DPF/). | |
| 33 | |
| 34 Online help and discussion about DPF happens in the [kx.studio chat, DPF room](https://chat.kx.studio/channel/dpf). | |
| 35 | |
| 36 | |
| 37 ## List of plugins made with DPF: | |
| 38 | |
| 39 See [this wiki page](https://github.com/DISTRHO/DPF/wiki/Plugins-made-with-DPF) for a list of plugins made with DPF. | |
| 40 | |
| 41 Plugin examples are also available in the `example/` folder inside this repo. |