clap

commit b37f51f94c5c334f185442502a339d5b5abbe85d
parent 123c421a23b0171b9a51fb26e1a78a730c769822
Author: Alexandre Bique <bique.alexandre@gmail.com>
Date:   Mon, 23 May 2022 09:16:09 +0200

Avoid spaces in features and add some documentation

Diffstat:
M
include/clap/plugin-features.h
 | 
16
++++++++++++----
M
include/clap/plugin.h
 | 
1
-

2 files changed, 12 insertions(+), 5 deletions(-)
diff --git a/include/clap/plugin-features.h b/include/clap/plugin-features.h
@@ -2,6 +2,14 @@
 
 #include "private/macros.h"
 
+// This files provides a set of standard plugin features meant to be use
+// within clap_plugin_descriptor.features.
+//
+// For practical reasons we'll avoid spaces and use `-` instead to facilitate
+// scripts that generate the feature array.
+//
+// Non standard feature should be formated as follow: "$namespace:$feature"
+
 /////////////////////
 // Plugin category //
 /////////////////////
@@ -10,10 +18,10 @@
 static CLAP_CONSTEXPR const char *CLAP_PLUGIN_FEATURE_INSTRUMENT = "instrument";
 
 // Add this feature if your plugin is an audio effect
-static CLAP_CONSTEXPR const char *CLAP_PLUGIN_FEATURE_AUDIO_EFFECT = "audio effect";
+static CLAP_CONSTEXPR const char *CLAP_PLUGIN_FEATURE_AUDIO_EFFECT = "audio-effect";
 
 // Add this feature if your plugin is a note effect or a note generator/sequencer
-static CLAP_CONSTEXPR const char *CLAP_PLUGIN_FEATURE_NOTE_EFFECT = "note effect";
+static CLAP_CONSTEXPR const char *CLAP_PLUGIN_FEATURE_NOTE_EFFECT = "note-effect";
 
 // Add this feature if your plugin is an analyzer
 static CLAP_CONSTEXPR const char *CLAP_PLUGIN_FEATURE_ANALYZER = "analyzer";
@@ -28,7 +36,7 @@ static CLAP_CONSTEXPR const char *CLAP_PLUGIN_FEATURE_EQUALIZER = "equalizer";
 static CLAP_CONSTEXPR const char *CLAP_PLUGIN_FEATURE_DEESSER = "de-esser";
 
 static CLAP_CONSTEXPR const char *CLAP_PLUGIN_FEATURE_DISTORTION = "distortion";
-static CLAP_CONSTEXPR const char *CLAP_PLUGIN_FEATURE_TRANSIENT_SHAPER = "transient shaper";
+static CLAP_CONSTEXPR const char *CLAP_PLUGIN_FEATURE_TRANSIENT_SHAPER = "transient-shaper";
 static CLAP_CONSTEXPR const char *CLAP_PLUGIN_FEATURE_COMPRESSOR = "compressor";
 static CLAP_CONSTEXPR const char *CLAP_PLUGIN_FEATURE_LIMITER = "limiter";
 
@@ -54,4 +62,4 @@ static CLAP_CONSTEXPR const char *CLAP_PLUGIN_FEATURE_AMBISONIC = "ambisonic";
 /////////////////
 
 // Add this feature if the plugin is DPI aware on Windows.
-static CLAP_CONSTEXPR const char *CLAP_PLUGIN_FEATURE_WIN32_DPI_AWARE = "win32 DPI aware";
+static CLAP_CONSTEXPR const char *CLAP_PLUGIN_FEATURE_WIN32_DPI_AWARE = "win32-dpi-aware";
diff --git a/include/clap/plugin.h b/include/clap/plugin.h
@@ -26,7 +26,6 @@ typedef struct clap_plugin_descriptor {
    // They can be matched by the host indexer and used to classify the plugin.
    // The array of pointers must be null terminated.
    // For some standard features see plugin-features.h
-   // Non standard feature should be formated as follow: "$namespace:$feature"
    const char **features;
 } clap_plugin_descriptor_t;