1# DPF - DISTRHO Plugin Framework
2[![Build Status](https://travis-ci.org/DISTRHO/DPF.png)](https://travis-ci.org/DISTRHO/DPF)
3
4DPF is designed to make development of new plugins an easy and enjoyable task.<br/>
5It allows developers to create plugins with custom UIs using a simple C++ API.<br/>
6The framework facilitates exporting various different plugin formats from the same code-base.<br/>
7
8DPF can build for LADSPA, DSSI, LV2 and VST formats.<br/>
9All current plugin format implementations are complete.<br/>
10A JACK/Standalone mode is also available, allowing you to quickly test plugins.<br/>
11
12Plugin DSP and UI communication is done via key-value string pairs.<br/>
13You send messages from the UI to the DSP side, which is automatically saved in the host when required.<br/>
14(You can also store state internally if needed, but this breaks DSSI compatibility).<br/>
15
16Getting time information from the host is possible.<br/>
17It uses the same format as the JACK Transport API, making porting some code easier.<br/>
18
19
20## Help and documentation
21
22Bug reports happen on the [DPF github project](https://github.com/DISTRHO/DPF/issues).
23
24Online documentation is available at [https://distrho.github.io/DPF/](https://distrho.github.io/DPF/).
25
26Online help and discussion about DPF happens in the [KXStudio chat DPF room](https://chat.kx.studio/channel/dpf).
27
28
29## List of plugins made with DPF:
30 - [DISTRHO glBars](https://github.com/DISTRHO/glBars)
31 - [DISTRHO Kars](https://github.com/DISTRHO/Kars)
32 - [DISTRHO Mini-Series](https://github.com/DISTRHO/Mini-Series)
33 - [DISTRHO MVerb](https://github.com/DISTRHO/MVerb)
34 - [DISTRHO ndc Plugs](https://github.com/DISTRHO/ndc-Plugs)
35 - [DISTRHO Nekobi](https://github.com/DISTRHO/Nekobi)
36 - [DISTRHO ProM](https://github.com/DISTRHO/ProM)
37 - [Dragonfly Reverb](https://michaelwillis.github.io/dragonfly-reverb)
38 - [Fogpad-port](https://github.com/linuxmao-org/fogpad-port)
39 - [Ninjas2](https://github.com/rghvdberg/ninjas2)
40 - [osamc-lv2-workshop](https://github.com/osamc-lv2-workshop/lv2-workshop) (simple plugins code examples)
41 - [QuadraFuzz](https://github.com/jpcima/quadrafuzz)
42 - [Regrader-Port](https://github.com/linuxmao-org/regrader-port)
43 - [Rezonateur](https://github.com/jpcima/rezonateur)
44 - [Spectacle-analyzer](https://github.com/jpcima/spectacle/)
45 - [Stone Phaser](https://github.com/jpcima/stone-phaser)
46 - [String-machine](https://github.com/jpcima/string-machine)
47 - [Uhhyou Plugins](https://github.com/ryukau/LV2Plugins)
48 - [VL1-emulator](https://github.com/linuxmao-org/VL1-emulator)
49 - [Wolf Shaper](https://github.com/pdesaulniers/wolf-shaper)
50 - [Wolf Spectrum](https://github.com/pdesaulniers/wolf-spectrum)
51 - [YK Chorus](https://github.com/SpotlightKid/ykchorus)
52 - [ZamAudio Suite](https://github.com/zamaudio/zam-plugins)
53 ## Work in progress
54 - [CV-LFO-blender-LV2](https://github.com/BramGiesen/cv-lfo-blender-lv2)
55 - [fverb](https://github.com/jpcima/fverb)
56 - [Juice Plugins](https://github.com/DISTRHO/JuicePlugins)
57 - [gunshot](https://github.com/soerenbnoergaard/gunshot)
58 - [midiomatic](https://github.com/SpotlightKid/midiomatic)
59 - [Shiro Plugins](https://github.com/ninodewit/SHIRO-Plugins/)
60 - [Shiru Plugins](https://github.com/linuxmao-org/shiru-plugins)
61
62Checking the [github "DPF" tag](https://github.com/topics/dpf) can potentially brings up other DPF-made plugins.
63
64Plugin examples are available in the `example/` folder inside this repo.<br/>
65Extra OpenGL UI examples are available [here](https://github.com/DISTRHO/gl-examples).
66