delete use of PLUGIN_DESCRIPTION_STRING and PLUGIN_EDITOR_DESCRIPTION…

…_STRING macros (holdovers from the old Mac OS X Component Manager resource fork data)
sophiapoirier · Sep 23, 2021 · eff157c · eff157c
1 parent 517fad6
commit eff157c
Show file tree

Hide file tree

Showing 19 changed files with 6 additions and 77 deletions.
diff --git a/bufferoverride/bufferoverridedef.h b/bufferoverride/bufferoverridedef.h
@@ -42,8 +42,5 @@ To contact the author, use the contact form at http:https://destroyfx.org/
 #define PLUGIN_COPYRIGHT_YEAR_STRING "2001-2021"
 #define VST_NUM_CHANNELS 2
 
-// optional
-#define PLUGIN_DESCRIPTION_STRING "overcome your audio processing buffer size and then (unsuccessfully) override that new buffer size to be a smaller buffer size"
-
 
 #endif
diff --git a/dfx-library/dfxplugin.h b/dfx-library/dfxplugin.h
@@ -135,16 +135,6 @@ VST_NUM_OUTPUTS
 or if they match, simply define
 VST_NUM_CHANNELS
  integers representing how many inputs and outputs your plugin has
-
- optional for Audio Unit:
-PLUGIN_DESCRIPTION_STRING
- a C string description of the plugin
-PLUGIN_RES_ID
- component resource ID of the base plugin
-PLUGIN_EDITOR_DESCRIPTION_STRING
- a C string description of the plugin editor
-PLUGIN_EDITOR_RES_ID
- component resource ID of the base plugin
 ------------------------------------------------------------------------*/
 
 #pragma once

diff --git a/dfx-library/dfxplugindef-template.h b/dfx-library/dfxplugindef-template.h
@@ -1,7 +1,7 @@
 /*------------------------------------------------------------------------
 Destroy FX Library is a collection of foundation code 
 for creating audio processing plug-ins. 
-Copyright (C) 2002-2021 Sophia Poirier
+Copyright (C) 2002-2021 Sophia Poirier and Tom Murphy 7
 
 This file is part of the Destroy FX Library (version 1.0).
 
@@ -31,15 +31,16 @@ To contact the author, use the contact form at http:https://destroyfx.org/
 
 // required
 #define PLUGIN_NAME_STRING ""
-// should be unique among all plugins (!) Official Destroy FX plugins use 'D' 'F'
-// for the first two characters
+// should be unique among all plugins (!)
+// Official Destroy FX plugins use 'D' 'F' for the first two characters
 #define PLUGIN_ID FOURCC('A', 'B', 'C', 'D')
 #define PLUGIN_VERSION_MAJOR 1
 #define PLUGIN_VERSION_MINOR 0
 #define PLUGIN_VERSION_BUGFIX 0
 #define PLUGIN_VERSION_STRING "1.0.0"
 #define PLUGIN_CLASS_NAME CoolPlugin
 #define PLUGIN_ENTRY_POINT "Entry"
+// required if PLUGIN_NAME_STRING contains whitespace
 #define PLUGIN_BUNDLE_IDENTIFIER DESTROYFX_BUNDLE_ID_PREFIX "" DFX_BUNDLE_ID_SUFFIX
 #define PLUGIN_COPYRIGHT_YEAR_STRING "20XX"
 // Define to 1 or 0
@@ -51,19 +52,13 @@ To contact the author, use the contact form at http:https://destroyfx.org/
 // only necessary for VST
 // #define VST_NUM_INPUTS 2
 // #define VST_NUM_OUTPUTS 2
-// or you can just define this if numinputs and numoutputs match
+// or you can define just this if numinputs and numoutputs match
 #define VST_NUM_CHANNELS 2
 
-// optional
-#define PLUGIN_DESCRIPTION_STRING ""
-#define PLUGIN_RES_ID
 #if TARGET_PLUGIN_HAS_GUI
+ // required if providing a GUI
  #define PLUGIN_BACKGROUND_IMAGE_FILENAME ".png"
- #define PLUGIN_EDITOR_DESCRIPTION_STRING ""
 #endif
 
-// if relevant
-#define DFX_SUPPORT_OLD_VST_SETTINGS 1
-
 
 #endif
diff --git a/eqsync/eqsyncdef.h b/eqsync/eqsyncdef.h
@@ -43,8 +43,5 @@ To contact the author, use the contact form at http:https://destroyfx.org/
 #define PLUGIN_COPYRIGHT_YEAR_STRING "2001-2021"
 #define VST_NUM_CHANNELS 2
 
-// optional
-#define PLUGIN_DESCRIPTION_STRING PLUGIN_NAME_STRING " is a ridiculous equalizer. You have no control over the EQ curve, if you try to adjust the faders they will escape, and the EQ parameters don't make any sense anyway. The EQ setting changes on its own according to your song's tempo."
-
 
 #endif
diff --git a/exemplar/exemplardefs.h b/exemplar/exemplardefs.h
@@ -14,7 +14,3 @@
 #ifndef TARGET_PLUGIN_HAS_GUI
 #define TARGET_PLUGIN_HAS_GUI 0
 #endif
-
-// optional
-#define PLUGIN_DESCRIPTION_STRING "the cow says..."
-#define PLUGIN_EDITOR_DESCRIPTION_STRING "the cow says..."
diff --git a/fonttest/fonttestdef.h b/fonttest/fonttestdef.h
@@ -41,9 +41,6 @@ To contact the author, use the contact form at http:https://destroyfx.org/
 #define TARGET_PLUGIN_HAS_GUI 1
 #define PLUGIN_BACKGROUND_IMAGE_FILENAME "fonttest-background.png"
 
-// optional
-#define PLUGIN_DESCRIPTION_STRING "a plugin of silence, yet of great diagnostic value"
-
 
 #define PLUGIN_COPYRIGHT_YEAR_STRING "2021"
 

diff --git a/geometer/geometerdef.h b/geometer/geometerdef.h
@@ -43,9 +43,6 @@ To contact the author, use the contact form at http:https://destroyfx.org/
 #define PLUGIN_COPYRIGHT_YEAR_STRING "2002-2021"
 #define VST_NUM_CHANNELS 2
 
-// optional
-#define PLUGIN_DESCRIPTION_STRING "visually oriented waveform geometry"
-
 
 #define DFX_SUPPORT_OLD_VST_SETTINGS 1
 

diff --git a/guitest/guitestdefs.h b/guitest/guitestdefs.h
@@ -14,7 +14,3 @@
 #ifndef TARGET_PLUGIN_HAS_GUI
 #define TARGET_PLUGIN_HAS_GUI 1
 #endif
-
-// optional
-#define PLUGIN_DESCRIPTION_STRING "i forgot to change the description"
-#define PLUGIN_EDITOR_DESCRIPTION_STRING "i forgot to change the gui description too"
diff --git a/midigater/midigaterdef.h b/midigater/midigaterdef.h
@@ -43,8 +43,5 @@ To contact the author, use the contact form at http:https://destroyfx.org/
 #define PLUGIN_COPYRIGHT_YEAR_STRING "2001-2021"
 #define VST_NUM_CHANNELS 2
 
-// optional
-#define PLUGIN_DESCRIPTION_STRING "a MIDI-note-controlled gate"
-
 
 #endif
diff --git a/monomaker/monomakerdef.h b/monomaker/monomakerdef.h
@@ -43,8 +43,5 @@ To contact the author, use the contact form at http:https://destroyfx.org/
 #define PLUGIN_COPYRIGHT_YEAR_STRING "2001-2021"
 #define VST_NUM_CHANNELS 2
 
-// optional
-#define PLUGIN_DESCRIPTION_STRING "a simple mono-merging and stereo-recentering utility"
-
 
 #endif
diff --git a/polarizer/polarizerdef.h b/polarizer/polarizerdef.h
@@ -43,8 +43,5 @@ To contact the author, use the contact form at http:https://destroyfx.org/
 #define PLUGIN_COPYRIGHT_YEAR_STRING "2001-2021"
 #define VST_NUM_CHANNELS 2
 
-// optional
-#define PLUGIN_DESCRIPTION_STRING "takes every Nth sample and polarizes it; you can also implode your sound"
-
 
 #endif
diff --git a/rezsynth/rezsynthdef.h b/rezsynth/rezsynthdef.h
@@ -43,8 +43,5 @@ To contact the author, use the contact form at http:https://destroyfx.org/
 #define PLUGIN_COPYRIGHT_YEAR_STRING "2001-2021"
 #define VST_NUM_CHANNELS 2
 
-// optional
-#define PLUGIN_DESCRIPTION_STRING PLUGIN_NAME_STRING " allows you to \"play\" resonant band-pass filter banks with MIDI notes"
-
 
 #endif
diff --git a/scrubby/scrubbydef.h b/scrubby/scrubbydef.h
@@ -43,8 +43,5 @@ To contact the author, use the contact form at http:https://destroyfx.org/
 #define PLUGIN_COPYRIGHT_YEAR_STRING "2002-2021"
 #define VST_NUM_CHANNELS 2
 
-// optional
-#define PLUGIN_DESCRIPTION_STRING PLUGIN_NAME_STRING " goes zipping around through time, doing whatever it takes to reach its destinations on time"
-
 
 #endif
diff --git a/skidder/skidderdef.h b/skidder/skidderdef.h
@@ -43,8 +43,5 @@ To contact the author, use the contact form at http:https://destroyfx.org/
 #define PLUGIN_COPYRIGHT_YEAR_STRING "2000-2021"
 #define VST_NUM_CHANNELS 2
 
-// optional
-#define PLUGIN_DESCRIPTION_STRING PLUGIN_NAME_STRING " turns your sound on and off"
-
 
 #endif
diff --git a/slowft/slowftdefs.h b/slowft/slowftdefs.h
@@ -14,7 +14,3 @@
 #ifndef TARGET_PLUGIN_HAS_GUI
 #define TARGET_PLUGIN_HAS_GUI 0
 #endif
-
-// optional
-#define PLUGIN_DESCRIPTION_STRING "i forgot to change the description"
-#define PLUGIN_EDITOR_DESCRIPTION_STRING "i forgot to change the gui description too"
diff --git a/stub-dfxplugin/dfxplugin-stub-def.h b/stub-dfxplugin/dfxplugin-stub-def.h
@@ -59,12 +59,7 @@ or somehow define this stuff another way (in compiler settings, or whatever).
 // 0 or 1 (whether or not the plugin has its own custom graphical interface)
 #define TARGET_PLUGIN_HAS_GUI 1
 
-// optional
-// a description of the effect (for Audio Unit)
-#define PLUGIN_DESCRIPTION_STRING "demonstration of how to use DfxPlugin"
 #if TARGET_PLUGIN_HAS_GUI
- // a description of the GUI component of the plugin (for Audio Unit, not important)
- #define PLUGIN_EDITOR_DESCRIPTION_STRING "graphics for DfxPlugin stub"
  // the file name of the GUI's background image
  #define PLUGIN_BACKGROUND_IMAGE_FILENAME "dfxplugin-stub-background.png"
 #endif

diff --git a/transverb/transverbdef.h b/transverb/transverbdef.h
@@ -41,9 +41,6 @@ To contact the author, use the contact form at http:https://destroyfx.org/
 #define TARGET_PLUGIN_HAS_GUI 1
 #define PLUGIN_BACKGROUND_IMAGE_FILENAME "transverb-background.png"
 
-// optional
-#define PLUGIN_DESCRIPTION_STRING "like a delay that can play back the delay buffer at different speeds"
-
 
 #define PLUGIN_COPYRIGHT_YEAR_STRING "2001-2021"
 

diff --git a/turntablist/turntablistdef.h b/turntablist/turntablistdef.h
@@ -42,7 +42,5 @@ To contact the author, use the contact form at http:https://destroyfx.org/
 #define PLUGIN_BUNDLE_IDENTIFIER DESTROYFX_BUNDLE_ID_PREFIX PLUGIN_NAME_STRING DFX_BUNDLE_ID_SUFFIX
 #define PLUGIN_COPYRIGHT_YEAR_STRING "2004-2021"
 
-#define PLUGIN_DESCRIPTION_STRING PLUGIN_NAME_STRING " is an instrument that can load a sample and perform turntable style effects on it. You can scratch, change pitch, and even spin the audio up and down, just like on a real turntable."
-
 
 #endif
diff --git a/windowingstub/windowingstubdefs.h b/windowingstub/windowingstubdefs.h
@@ -15,7 +15,3 @@
 #ifndef TARGET_PLUGIN_HAS_GUI
 #define TARGET_PLUGIN_HAS_GUI 0
 #endif
-
-// optional
-#define PLUGIN_DESCRIPTION_STRING "i forgot to change the description"
-#define PLUGIN_EDITOR_DESCRIPTION_STRING "i forgot to change the gui description too"