clap

commit 51b604d23ba352574de4da07be7ee3ce48af3af1
parent be47a9f18da0ad48692987d33048509472c8440c
Author: Alexandre Bique <bique.alexandre@gmail.com>
Date:   Tue, 30 Sep 2014 15:06:29 +0200

Initial doc

Diffstat:
A
Makefile
 | 
4
++++
A
spec.rst
 | 
36
++++++++++++++++++++++++++++++++++++

2 files changed, 40 insertions(+), 0 deletions(-)
diff --git a/Makefile b/Makefile
@@ -0,0 +1,4 @@
+all: spec.html
+
+spec.html: spec.rst
+	rst2html $< >$@
diff --git a/spec.rst b/spec.rst
@@ -0,0 +1,36 @@
+==========================
+CLAP (CLever Audio Plugin)
+==========================
+
+--------------------------
+A free audio plugin format
+--------------------------
+
+Design goals
+============
+
+- Make a free audio plugin format
+- Be easy to understand and implement
+- Bring new features missed in VST 2.4
+
+Specification
+=============
+
+Threading
+---------
+
+The plugin is not thread safe, and must not be called concurrently.
+
+Yet, show_gui() and hide_gui() should be called from an other thread, and can be called concurrently.
+Rational: starting the GUI requires to load resources which may be done
+synchronously and can take time. So to avoid blocking the audio
+processing, we choose to start the GUI from an other thread.
+
+Examples
+========
+
+References
+==========
+
+.. include:: clap.h
+   :code: c