clap

commit c541c44750661c40cb9a01c148eec5be323e1b92
parent 5959da31cc7fbf5df1a2f3f19d7da955251693e2
Author: Alexandre BIQUE <bique.alexandre@gmail.com>
Date:   Sun, 30 Jan 2022 17:28:47 +0100

Merge branch 'main' into next

Diffstat:
M
include/clap/entry.h
 | 
2
+-
M
include/clap/ext/gui.h
 | 
11
+++++++++--
M
include/clap/ext/params.h
 | 
20
++++++++++++++------

3 files changed, 24 insertions(+), 9 deletions(-)
diff --git a/include/clap/entry.h b/include/clap/entry.h
@@ -22,7 +22,7 @@ extern "C" {
 //
 // Windows
 //   - %CommonFilesFolder%/CLAP/
-//   - %LOCALAPPDATA%/Programs/Common/VST3/
+//   - %LOCALAPPDATA%/Programs/Common/CLAP/
 //
 // MacOS
 //   - /Library/Audio/Plug-Ins/CLAP
diff --git a/include/clap/ext/gui.h b/include/clap/ext/gui.h
@@ -17,7 +17,13 @@
 /// 6. clap_plugin_gui->hide()/show() ...
 /// 7. clap_plugin_gui->destroy() when done with the gui
 ///
-/// Resizing the window:
+/// Resizing the window (initiated by the plugin):
+/// 1. Plugins calls clap_host_gui->request_resize()
+/// 2. If the host returns true the new size is accepted,
+///    the host doesn't have to call clap_plugin_gui->set_size().
+///    If the host returns false, the new size is rejected.
+///
+/// Resizing the window (drag):
 /// 1. Only possible if clap_plugin_gui->can_resize() returns true
 /// 2. Mouse drag -> new_size
 /// 3. clap_plugin_gui->round_size(new_size) -> working_size
@@ -82,7 +88,8 @@ typedef struct clap_plugin_gui {
 
 typedef struct clap_host_gui {
    /* Request the host to resize the client area to width, height.
-    * Return true on success, false otherwise.
+    * Return true if the new size is accepted, false otherwise.
+    * The host doesn't have to call set_size().
     * [main-thread] */
    bool (*request_resize)(const clap_host_t *host, uint32_t width, uint32_t height);
 
diff --git a/include/clap/ext/params.h b/include/clap/ext/params.h
@@ -21,9 +21,9 @@
 ///
 /// When the plugin changes a parameter value, it must inform the host.
 /// It will send @ref CLAP_EVENT_PARAM_VALUE event during process() or flush().
-/// - set the flag CLAP_EVENT_PARAM_BEGIN_ADJUST to mark the begining of automation recording
-/// - set the flag CLAP_EVENT_PARAM_END_ADJUST to mark the end of automation recording
-/// - set the flag CLAP_EVENT_PARAM_SHOULD_RECORD if the event should be recorded
+/// - set the flag CLAP_EVENT_BEGIN_ADJUST to mark the begining of automation recording
+/// - set the flag CLAP_EVENT_END_ADJUST to mark the end of automation recording
+/// - set the flag CLAP_EVENT_SHOULD_RECORD if the event should be recorded
 ///
 /// @note MIDI CCs are a tricky because you may not know when the parameter adjustment ends.
 /// Also if the hosts records incoming MIDI CC and parameter change automation at the same time,
@@ -55,7 +55,7 @@
 /// - if the plugin is not processing, call clap_host_params->request_flush() or
 ///   clap_host->request_process().
 /// - send an automation event and don't forget to set begin_adjust, end_adjust and should_record
-///   attributes
+///   flags
 /// - the plugin is responsible to send the parameter value to its audio processor
 ///
 /// IV. Turning a knob via automation
@@ -70,9 +70,9 @@
 /// - if the plugin is activated call clap_host->restart()
 /// - once the plugin isn't active:
 ///   - apply the new state
-///   - call clap_host_params->rescan(CLAP_PARAM_RESCAN_ALL)
-///   - if a parameter is created with an id that may have been used before,
+///   - if a parameter is gone or is created with an id that may have been used before,
 ///     call clap_host_params.clear(host, param_id, CLAP_PARAM_CLEAR_ALL)
+///   - call clap_host_params->rescan(CLAP_PARAM_RESCAN_ALL)
 
 static CLAP_CONSTEXPR const char CLAP_EXT_PARAMS[] = "clap.params";
 
@@ -121,6 +121,14 @@ enum {
    // A simple example would be a DC Offset, changing it will change the output signal and must be
    // processed.
    CLAP_PARAM_REQUIRES_PROCESS = 1 << 9,
+
+   // The host should not record and play automation for this parameter.
+   // Though, the host can send live user changes for this parameter.
+   //
+   // If this parameters affect the internal processing structure of the plugin, ie: max delay, fft
+   // size, ... and the plugins needs to re-allocate its working buffers, then it should call
+   // host->request_restart(), and perform the change once the plugin is re-activated.
+   CLAP_PARAM_NOT_AUTOMATABLE = 1 << 10,
 };
 typedef uint32_t clap_param_info_flags;