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 #define effGetEffectName 45
 105 #define effGetVendorString 47
 106 #define effGetProductString 48
 107 #define effGetVendorVersion 49
 108 #define effCanDo 51 // currently unused
 109 /* from http://asseca.com/vst-24-specs/efGetParameterProperties.html */
 110 #define effGetParameterProperties 56
 111 #define effGetVstVersion 58 // currently unused
 112
 113 #define kEffectMagic (CCONST( 'V', 's', 't', 'P' ))
 114 #define kVstLangEnglish 1
 115 #define kVstMidiType 1
 116
 117 struct RemoteVstPlugin;
 118
 119 #define kVstTransportPlaying (1 << 1)
 120
 121 #define kVstNanosValid (1 << 8)
 122 #define kVstPpqPosValid (1 << 9)
 123 #define kVstTempoValid (1 << 10)
 124 #define kVstBarsValid (1 << 11)
 125 #define kVstCyclePosValid (1 << 12)
 126 #define kVstTimeSigValid (1 << 13)
 127 #define kVstSmpteValid (1 << 14)
 128 #define kVstClockValid (1 << 15)
 129
 130 struct _VstMidiEvent
 131 {
 132         // 00
 133         int type;
 134         // 04
 135         int byteSize;
 136         // 08
 137         int deltaFrames;
 138         // 0c?
 139         int flags;
 140         // 10?
 141         int noteLength;
 142         // 14?
 143         int noteOffset;
 144         // 18
 145         char midiData[4];
 146         // 1c?
 147         char detune;
 148         // 1d?
 149         char noteOffVelocity;
 150         // 1e?
 151         char reserved1;
 152         // 1f?
 153         char reserved2;
 154 };
 155
 156 typedef struct _VstMidiEvent VstMidiEvent;
 157
 158
 159 struct _VstEvent
 160 {
 161         char dump[sizeof (VstMidiEvent)];
 162
 163 };
 164
 165 typedef struct _VstEvent VstEvent;
 166
 167 struct _VstEvents
 168 {
 169         // 00
 170         int numEvents;
 171         // 04
 172         void *reserved;
 173         // 08
 174         VstEvent * events[];
 175 };
 176
 177 typedef struct _VstEvents VstEvents;
 178
 179 /* this struct taken from http://asseca.com/vst-24-specs/efGetParameterProperties.html */
 180 struct _VstParameterProperties
 181 {
 182         float stepFloat;
 183         float smallStepFloat;
 184         float largeStepFloat;
 185         char label[64];
 186         int32_t flags;
 187         int32_t minInteger;
 188         int32_t maxInteger;
 189         int32_t stepInteger;
 190         int32_t largeStepInteger;
 191         char shortLabel[8];
 192 };
 193
 194 typedef struct _VstParameterProperties VstParameterProperties;
 195
 196 /* this enum taken from http://asseca.com/vst-24-specs/efGetParameterProperties.html */
 197 enum VstParameterFlags
 198 {
 199         kVstParameterIsSwitch                = 1 << 0,  /* parameter is a switch (on/off) */
 200         kVstParameterUsesIntegerMinMax       = 1 << 1,  /* minInteger, maxInteger valid */
 201         kVstParameterUsesFloatStep           = 1 << 2,  /* stepFloat, smallStepFloat, largeStepFloat valid */
 202         kVstParameterUsesIntStep             = 1 << 3,  /* stepInteger, largeStepInteger valid */
 203         kVstParameterSupportsDisplayIndex    = 1 << 4,  /* displayIndex valid */
 204         kVstParameterSupportsDisplayCategory = 1 << 5,  /* category, etc. valid */
 205         kVstParameterCanRamp                 = 1 << 6   /* set if parameter value can ramp up/down */
 206 };
 207
 208 struct _AEffect
 209 {
 210         // Never use virtual functions!!!
 211         // 00-03
 212         int magic;
 213         // dispatcher 04-07
 214         intptr_t (* dispatcher) (struct _AEffect *, int, int, intptr_t, void *, float);
 215         // process, quite sure 08-0b
 216         void (* process) (struct _AEffect *, float **, float **, int);
 217         // setParameter 0c-0f
 218         void (* setParameter) (struct _AEffect *, int, float);
 219         // getParameter 10-13
 220         float (* getParameter) (struct _AEffect *, int);
 221         // programs 14-17
 222         int numPrograms;
 223         // Params 18-1b
 224         int numParams;
 225         // Input 1c-1f
 226         int numInputs;
 227         // Output 20-23
 228         int numOutputs;
 229         // flags 24-27
 230         int flags;
 231         // Fill somewhere 28-2b
 232         void *ptr1;
 233         void *ptr2;
 234         // Zeroes 2c-2f 30-33 34-37 38-3b
 235         char empty3[4 + 4 + 4];
 236         // 1.0f 3c-3f
 237         float unkown_float;
 238         // An object? pointer 40-43
 239         void *ptr3;
 240         // Zeroes 44-47
 241         void *user;
 242         // Id 48-4b
 243         int32_t uniqueID;
 244         // Don't know 4c-4f
 245         char unknown1[4];
 246         // processReplacing 50-53
 247         void (* processReplacing) (struct _AEffect *, float **, float **, int);
 248 };
 249
 250 typedef struct _AEffect AEffect;
 251
 252 typedef struct _VstTimeInfo
 253 {
 254     /* info from online documentation of VST provided by Steinberg */
 255
 256     double samplePos;
 257     double sampleRate;
 258     double nanoSeconds;
 259     double ppqPos;
 260     double tempo;
 261     double barStartPos;
 262     double cycleStartPos;
 263     double cycleEndPos;
 264     int32_t   timeSigNumerator;
 265     int32_t   timeSigDenominator;
 266     int32_t   smpteOffset;
 267     int32_t   smpteFrameRate;
 268     int32_t   samplesToNextClock;
 269     int32_t   flags;
 270
 271 } VstTimeInfo;
 272
 273 typedef struct _VstTimeInfo VstTimeInfo;
 274
 275 typedef intptr_t (* audioMasterCallback) (AEffect *, int32_t, int32_t, intptr_t, void *, float);
 276
 277 #endif