libs/ardour/ardour/vestige/aeffectx.h

   1 /*
   2  * aeffectx.h - simple header to allow VeSTige compilation and eventually work
   3  *
   4  * Copyright (c) 2006 Javier Serrano Polo <jasp00/at/users.sourceforge.net>
   5  *
   6  * This file is part of Linux MultiMedia Studio - http://lmms.sourceforge.net
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public
  19  * License along with this program (see COPYING); if not, write to the
  20  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  21  * Boston, MA 02110-1301 USA.
  22  *
  23  */
  24 #include <stdint.h>
  25 #ifndef _AEFFECTX_H
  26 #define _AEFFECTX_H
  27
  28 #define CCONST(a, b, c, d)( ( ( (int) a ) << 24 ) |             \
  29                                 ( ( (int) b ) << 16 ) |         \
  30                                 ( ( (int) c ) << 8 ) |          \
  31                                 ( ( (int) d ) << 0 ) )
  32
  33 #define audioMasterAutomate 0
  34 #define audioMasterVersion 1
  35 #define audioMasterCurrentId 2
  36 #define audioMasterIdle 3
  37 #define audioMasterPinConnected 4
  38 // unsupported? 5
  39 #define audioMasterWantMidi 6
  40 #define audioMasterGetTime 7
  41 #define audioMasterProcessEvents 8
  42 #define audioMasterSetTime 9
  43 #define audioMasterTempoAt 10
  44 #define audioMasterGetNumAutomatableParameters 11
  45 #define audioMasterGetParameterQuantization 12
  46 #define audioMasterIOChanged 13
  47 #define audioMasterNeedIdle 14
  48 #define audioMasterSizeWindow 15
  49 #define audioMasterGetSampleRate 16
  50 #define audioMasterGetBlockSize 17
  51 #define audioMasterGetInputLatency 18
  52 #define audioMasterGetOutputLatency 19
  53 #define audioMasterGetPreviousPlug 20
  54 #define audioMasterGetNextPlug 21
  55 #define audioMasterWillReplaceOrAccumulate 22
  56 #define audioMasterGetCurrentProcessLevel 23
  57 #define audioMasterGetAutomationState 24
  58 #define audioMasterOfflineStart 25
  59 #define audioMasterOfflineRead 26
  60 #define audioMasterOfflineWrite 27
  61 #define audioMasterOfflineGetCurrentPass 28
  62 #define audioMasterOfflineGetCurrentMetaPass 29
  63 #define audioMasterSetOutputSampleRate 30
  64 // unsupported? 31
  65 #define audioMasterGetSpeakerArrangement 31 // deprecated in 2.4?
  66 #define audioMasterGetVendorString 32
  67 #define audioMasterGetProductString 33
  68 #define audioMasterGetVendorVersion 34
  69 #define audioMasterVendorSpecific 35
  70 #define audioMasterSetIcon 36
  71 #define audioMasterCanDo 37
  72 #define audioMasterGetLanguage 38
  73 #define audioMasterOpenWindow 39
  74 #define audioMasterCloseWindow 40
  75 #define audioMasterGetDirectory 41
  76 #define audioMasterUpdateDisplay 42
  77 #define audioMasterBeginEdit 43
  78 #define audioMasterEndEdit 44
  79 #define audioMasterOpenFileSelector 45
  80 #define audioMasterCloseFileSelector 46 // currently unused
  81 #define audioMasterEditFile 47 // currently unused
  82 #define audioMasterGetChunkFile 48 // currently unused
  83 #define audioMasterGetInputSpeakerArrangement 49 // currently unused
  84
  85 #define effFlagsHasEditor 1
  86 #define effFlagsCanReplacing (1 << 4) // very likely
  87 #define effFlagsIsSynth (1 << 8) // currently unused
  88
  89 #define effOpen 0
  90 #define effClose 1 // currently unused
  91 #define effSetProgram 2 // currently unused
  92 #define effGetProgram 3 // currently unused
  93 #define effGetProgramName 5 // currently unused
  94 #define effGetParamName 8 // currently unused
  95 #define effSetSampleRate 10
  96 #define effSetBlockSize 11
  97 #define effMainsChanged 12
  98 #define effEditGetRect 13
  99 #define effEditOpen 14
 100 #define effEditClose 15
 101 #define effEditIdle 19
 102 #define effEditTop 20
 103 #define effProcessEvents 25
 104 // the next one from http://asseca.com/vst-24-specs/index.html
 105 #define effGetPlugCategory 35
 106 #define effGetEffectName 45
 107 #define effGetVendorString 47
 108 #define effGetProductString 48
 109 #define effGetVendorVersion 49
 110 #define effCanDo 51 // currently unused
 111 /* from http://asseca.com/vst-24-specs/efIdle.html */
 112 #define effIdle 53
 113 /* from http://asseca.com/vst-24-specs/efGetParameterProperties.html */
 114 #define effGetParameterProperties 56
 115 #define effGetVstVersion 58 // currently unused
 116 /* http://asseca.com/vst-24-specs/efShellGetNextPlugin.html */
 117 #define effShellGetNextPlugin  70
 118 /* The next two were gleaned from http://www.kvraudio.com/forum/printview.php?t=143587&start=0 */
 119 #define effStartProcess 71
 120 #define effStopProcess 72
 121
 122 #define effBeginSetProgram 67
 123 #define effEndSetProgram 68
 124
 125 #ifdef WORDS_BIGENDIAN
 126 // "VstP"
 127 #define kEffectMagic 0x50747356
 128 #else
 129 // "PtsV"
 130 #define kEffectMagic 0x56737450
 131 #endif
 132
 133 #define kVstLangEnglish 1
 134 #define kVstMidiType 1
 135
 136 struct RemoteVstPlugin;
 137
 138 #define kVstTransportChanged 1
 139 #define kVstTransportPlaying (1 << 1)
 140 #define kVstTransportCycleActive (1 << 2)
 141
 142 #define kVstAutomationWriting (1 << 6)
 143 #define kVstAutomationReading (1 << 7)
 144
 145 #define kVstNanosValid (1 << 8)
 146 #define kVstPpqPosValid (1 << 9)
 147 #define kVstTempoValid (1 << 10)
 148 #define kVstBarsValid (1 << 11)
 149 #define kVstCyclePosValid (1 << 12)
 150 #define kVstTimeSigValid (1 << 13)
 151 #define kVstSmpteValid (1 << 14)
 152 #define kVstClockValid (1 << 15)
 153
 154 struct _VstMidiEvent
 155 {
 156         // 00
 157         int type;
 158         // 04
 159         int byteSize;
 160         // 08
 161         int deltaFrames;
 162         // 0c?
 163         int flags;
 164         // 10?
 165         int noteLength;
 166         // 14?
 167         int noteOffset;
 168         // 18
 169         char midiData[4];
 170         // 1c?
 171         char detune;
 172         // 1d?
 173         char noteOffVelocity;
 174         // 1e?
 175         char reserved1;
 176         // 1f?
 177         char reserved2;
 178 };
 179
 180 typedef struct _VstMidiEvent VstMidiEvent;
 181
 182
 183 struct _VstEvent
 184 {
 185         char dump[sizeof (VstMidiEvent)];
 186
 187 };
 188
 189 typedef struct _VstEvent VstEvent;
 190
 191 struct _VstEvents
 192 {
 193         // 00
 194         int numEvents;
 195         // 04
 196         void *reserved;
 197         // 08
 198         VstEvent * events[];
 199 };
 200
 201 /* constants from http://www.rawmaterialsoftware.com/juceforum/viewtopic.php?t=3740&sid=183f74631fee71a493316735e2b9f28b */
 202
 203 enum Vestige2StringConstants
 204 {
 205         VestigeMaxNameLen       = 64,
 206         VestigeMaxLabelLen      = 64,
 207         VestigeMaxShortLabelLen = 8,
 208         VestigeMaxCategLabelLen = 24,
 209         VestigeMaxFileNameLen   = 100
 210 };
 211
 212
 213 /* constants from http://asseca.com/vst-24-specs/efGetPlugCategory.html */
 214
 215 enum VstPlugCategory
 216 {
 217         kPlugCategUnknown = 0,
 218         kPlugCategEffect,
 219         kPlugCategSynth,
 220         kPlugCategAnalysis,
 221         kPlugCategMastering,
 222         kPlugCategSpacializer,
 223         kPlugCategRoomFx,
 224         kPlugSurroundFx,
 225         kPlugCategRestoration,
 226         kPlugCategOfflineProcess,
 227         kPlugCategShell,
 228         kPlugCategGenerator,
 229         kPlugCategMaxCount
 230 };
 231
 232 typedef struct _VstEvents VstEvents;
 233
 234 /* this struct taken from http://asseca.com/vst-24-specs/efGetParameterProperties.html */
 235 struct _VstParameterProperties
 236 {
 237         float stepFloat;              /* float step */
 238         float smallStepFloat;         /* small float step */
 239         float largeStepFloat;         /* large float step */
 240         char label[VestigeMaxLabelLen];  /* parameter label */
 241         int32_t flags;               /* @see VstParameterFlags */
 242         int32_t minInteger;          /* integer minimum */
 243         int32_t maxInteger;          /* integer maximum */
 244         int32_t stepInteger;         /* integer step */
 245         int32_t largeStepInteger;    /* large integer step */
 246         char shortLabel[VestigeMaxShortLabelLen]; /* short label, recommended: 6 + delimiter */
 247         int16_t displayIndex;        /* index where this parameter should be displayed (starting with 0) */
 248         int16_t category;            /* 0: no category, else group index + 1 */
 249         int16_t numParametersInCategory; /* number of parameters in category */
 250         int16_t reserved;            /* zero */
 251         char categoryLabel[VestigeMaxCategLabelLen]; /* category label, e.g. "Osc 1"  */
 252         char future[16];              /* reserved for future use */
 253 };
 254
 255 typedef struct _VstParameterProperties VstParameterProperties;
 256
 257 /* this enum taken from http://asseca.com/vst-24-specs/efGetParameterProperties.html */
 258 enum VstParameterFlags
 259 {
 260         kVstParameterIsSwitch                = 1 << 0,  /* parameter is a switch (on/off) */
 261         kVstParameterUsesIntegerMinMax       = 1 << 1,  /* minInteger, maxInteger valid */
 262         kVstParameterUsesFloatStep           = 1 << 2,  /* stepFloat, smallStepFloat, largeStepFloat valid */
 263         kVstParameterUsesIntStep             = 1 << 3,  /* stepInteger, largeStepInteger valid */
 264         kVstParameterSupportsDisplayIndex    = 1 << 4,  /* displayIndex valid */
 265         kVstParameterSupportsDisplayCategory = 1 << 5,  /* category, etc. valid */
 266         kVstParameterCanRamp                 = 1 << 6   /* set if parameter value can ramp up/down */
 267 };
 268
 269 struct _AEffect
 270 {
 271         // Never use virtual functions!!!
 272         // 00-03
 273         int magic;
 274         // dispatcher 04-07
 275         intptr_t (* dispatcher) (struct _AEffect *, int, int, intptr_t, void *, float);
 276         // process, quite sure 08-0b
 277         void (* process) (struct _AEffect *, float **, float **, int);
 278         // setParameter 0c-0f
 279         void (* setParameter) (struct _AEffect *, int, float);
 280         // getParameter 10-13
 281         float (* getParameter) (struct _AEffect *, int);
 282         // programs 14-17
 283         int numPrograms;
 284         // Params 18-1b
 285         int numParams;
 286         // Input 1c-1f
 287         int numInputs;
 288         // Output 20-23
 289         int numOutputs;
 290         // flags 24-27
 291         int flags;
 292         // Fill somewhere 28-2b
 293         void *ptr1;
 294         void *ptr2;
 295         // Zeroes 2c-2f 30-33 34-37 38-3b
 296         char empty3[4 + 4 + 4];
 297         // 1.0f 3c-3f
 298         float unkown_float;
 299         // An object? pointer 40-43
 300         void *ptr3;
 301         // Zeroes 44-47
 302         void *user;
 303         // Id 48-4b
 304         int32_t uniqueID;
 305         // Don't know 4c-4f
 306         char unknown1[4];
 307         // processReplacing 50-53
 308         void (* processReplacing) (struct _AEffect *, float **, float **, int);
 309 };
 310
 311 typedef struct _AEffect AEffect;
 312
 313 typedef struct _VstTimeInfo
 314 {
 315     /* info from online documentation of VST provided by Steinberg */
 316
 317     double samplePos;
 318     double sampleRate;
 319     double nanoSeconds;
 320     double ppqPos;
 321     double tempo;
 322     double barStartPos;
 323     double cycleStartPos;
 324     double cycleEndPos;
 325     int32_t   timeSigNumerator;
 326     int32_t   timeSigDenominator;
 327     int32_t   smpteOffset;
 328     int32_t   smpteFrameRate;
 329     int32_t   samplesToNextClock;
 330     int32_t   flags;
 331
 332 } VstTimeInfo;
 333
 334 typedef intptr_t (* audioMasterCallback) (AEffect *, int32_t, int32_t, intptr_t, void *, float);
 335
 336 #endif