libs/ardour/session_vst.cc

   1 /*
   2     Copyright (C) 2004
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef COMPILER_MSVC
  21 #include <stdbool.h>
  22 #endif
  23 #include <cstdio>
  24
  25 #include "ardour/session.h"
  26 #include "ardour/tempo.h"
  27 #include "ardour/windows_vst_plugin.h"
  28 #include "ardour/vestige/aeffectx.h"
  29 #include "ardour/vst_types.h"
  30
  31 #include "i18n.h"
  32
  33 #define DEBUG_CALLBACKS
  34 static int debug_callbacks = -1;
  35
  36 #ifdef DEBUG_CALLBACKS
  37 #define SHOW_CALLBACK if (debug_callbacks) printf
  38 #else
  39 #define SHOW_CALLBACK(...)
  40 #endif
  41
  42 using namespace ARDOUR;
  43
  44 intptr_t Session::vst_callback (
  45         AEffect* effect,
  46         int32_t opcode,
  47         int32_t index,
  48         intptr_t value,
  49         void* ptr,
  50         float opt
  51         )
  52 {
  53         static VstTimeInfo _timeInfo;
  54         VSTPlugin* plug;
  55         Session* session;
  56
  57         if (debug_callbacks < 0) {
  58                 debug_callbacks = (getenv ("ARDOUR_DEBUG_VST_CALLBACKS") != 0);
  59         }
  60
  61         if (effect && effect->user) {
  62                 plug = (VSTPlugin *) (effect->user);
  63                 session = &plug->session();
  64 #ifdef COMPILER_MSVC
  65                 SHOW_CALLBACK ("am callback 0x%x, opcode = %d, plugin = \"%s\" ", (int) pthread_self().p, opcode, plug->name());
  66 #else
  67                 SHOW_CALLBACK ("am callback 0x%x, opcode = %d, plugin = \"%s\" ", (int) pthread_self(), opcode, plug->name());
  68 #endif
  69         } else {
  70                 plug = 0;
  71                 session = 0;
  72 #ifdef COMPILER_MSVC
  73                 SHOW_CALLBACK ("am callback 0x%x, opcode = %d", (int) pthread_self().p, opcode);
  74 #else
  75                 SHOW_CALLBACK ("am callback 0x%x, opcode = %d", (int) pthread_self(), opcode);
  76 #endif
  77         }
  78
  79         switch(opcode){
  80
  81         case audioMasterAutomate:
  82                 SHOW_CALLBACK ("amc: audioMasterAutomate\n");
  83                 // index, value, returns 0
  84                 if (plug) {
  85                         plug->set_parameter (index, opt);
  86                 }
  87                 return 0;
  88
  89         case audioMasterVersion:
  90                 SHOW_CALLBACK ("amc: audioMasterVersion\n");
  91                 // vst version, currently 2 (0 for older)
  92                 return 2;
  93
  94         case audioMasterCurrentId:
  95                 SHOW_CALLBACK ("amc: audioMasterCurrentId\n");
  96                 // returns the unique id of a plug that's currently
  97                 // loading
  98                 return 0;
  99
 100         case audioMasterIdle:
 101                 SHOW_CALLBACK ("amc: audioMasterIdle\n");
 102                 // call application idle routine (this will
 103                 // call effEditIdle for all open editors too)
 104                 if (effect) {
 105                         effect->dispatcher(effect, effEditIdle, 0, 0, NULL, 0.0f);
 106                 }
 107                 return 0;
 108
 109         case audioMasterPinConnected:
 110                 SHOW_CALLBACK ("amc: audioMasterPinConnected\n");
 111                 // inquire if an input or output is beeing connected;
 112                 // index enumerates input or output counting from zero:
 113                 // value is 0 for input and != 0 otherwise. note: the
 114                 // return value is 0 for <true> such that older versions
 115                 // will always return true.
 116                 return 1;
 117
 118         case audioMasterWantMidi:
 119                 SHOW_CALLBACK ("amc: audioMasterWantMidi\n");
 120                 // <value> is a filter which is currently ignored
 121                 if (plug) {
 122                         plug->get_info()->n_inputs.set_midi (1);
 123                 }
 124                 return 0;
 125
 126         case audioMasterGetTime:
 127                 SHOW_CALLBACK ("amc: audioMasterGetTime\n");
 128                 // returns const VstTimeInfo* (or 0 if not supported)
 129                 // <value> should contain a mask indicating which fields are required
 130                 // (see valid masks above), as some items may require extensive
 131                 // conversions
 132                 memset(&_timeInfo, 0, sizeof(_timeInfo));
 133                 if (session) {
 134                         framepos_t now = session->transport_frame();
 135                         _timeInfo.samplePos = now;
 136                         _timeInfo.sampleRate = session->frame_rate();
 137                         _timeInfo.flags = 0;
 138
 139                         const TempoMetric& tm (session->tempo_map().metric_at (now));
 140
 141 //                      if (value & (kVstTempoValid)) {
 142                                 const Tempo& t (tm.tempo());
 143                                 _timeInfo.tempo = t.beats_per_minute ();
 144                                 _timeInfo.flags |= (kVstTempoValid);
 145 //                      }
 146 //                      if (value & (kVstBarsValid)) {
 147                                 const Meter& m (tm.meter());
 148                                 _timeInfo.timeSigNumerator = m.divisions_per_bar ();
 149                                 _timeInfo.timeSigDenominator = m.note_divisor ();
 150                                 _timeInfo.flags |= (kVstTimeSigValid);
 151 //                      }
 152 //                      if (value & (kVstPpqPosValid)) {
 153                                 Timecode::BBT_Time bbt;
 154                                 try {
 155                                         session->tempo_map().bbt_time_rt (now, bbt);
 156
 157                                         /* Note that this assumes constant
 158                                            meter/tempo throughout the session. We
 159                                            can do better than this, because
 160                                            progressive rock fans demand it.
 161                                         */
 162                                         double ppqBar = double(bbt.bars - 1) * tm.meter().divisions_per_bar();
 163                                         double ppqBeat = double(bbt.beats - 1);
 164                                         double ppqTick = double(bbt.ticks) / Timecode::BBT_Time::ticks_per_beat;
 165                                         // PPQ Pos
 166                                         _timeInfo.ppqPos = ppqBar + ppqBeat + ppqTick;
 167                                         _timeInfo.flags |= (kVstPpqPosValid);
 168                                 } catch (...) {
 169                                         /* relax */
 170                                 }
 171 //                      }
 172
 173                         // Bars
 174                         // _timeInfo.barStartPos = ppqBar;
 175                         // _timeInfo.flags |= kVstBarsValid;
 176
 177                         if (session->transport_speed() != 0.0f) {
 178                                 _timeInfo.flags |= kVstTransportPlaying;
 179                         }
 180                 }
 181
 182                 return (long)&_timeInfo;
 183
 184         case audioMasterProcessEvents:
 185                 SHOW_CALLBACK ("amc: audioMasterProcessEvents\n");
 186                 // VstEvents* in <ptr>
 187                 return 0;
 188
 189         case audioMasterSetTime:
 190                 SHOW_CALLBACK ("amc: audioMasterSetTime\n");
 191                 // VstTimenfo* in <ptr>, filter in <value>, not supported
 192
 193         case audioMasterTempoAt:
 194                 SHOW_CALLBACK ("amc: audioMasterTempoAt\n");
 195                 // returns tempo (in bpm * 10000) at sample frame location passed in <value>
 196                 if (session) {
 197                         const Tempo& t (session->tempo_map().tempo_at (value));
 198                         return t.beats_per_minute() * 1000;
 199                 } else {
 200                         return 0;
 201                 }
 202                 break;
 203
 204         case audioMasterGetNumAutomatableParameters:
 205                 SHOW_CALLBACK ("amc: audioMasterGetNumAutomatableParameters\n");
 206                 return 0;
 207
 208         case audioMasterGetParameterQuantization:
 209                 SHOW_CALLBACK ("amc: audioMasterGetParameterQuantization\n");
 210                // returns the integer value for +1.0 representation,
 211                // or 1 if full single float precision is maintained
 212                // in automation. parameter index in <value> (-1: all, any)
 213                 return 0;
 214
 215         case audioMasterIOChanged:
 216                 SHOW_CALLBACK ("amc: audioMasterIOChanged\n");
 217                // numInputs and/or numOutputs has changed
 218                 return 0;
 219
 220         case audioMasterNeedIdle:
 221                 SHOW_CALLBACK ("amc: audioMasterNeedIdle\n");
 222                 // plug needs idle calls (outside its editor window)
 223                 if (plug) {
 224                         plug->state()->wantIdle = 1;
 225                 }
 226                 return 0;
 227
 228         case audioMasterSizeWindow:
 229                 SHOW_CALLBACK ("amc: audioMasterSizeWindow\n");
 230                 // index: width, value: height
 231                 return 0;
 232
 233         case audioMasterGetSampleRate:
 234                 SHOW_CALLBACK ("amc: audioMasterGetSampleRate\n");
 235                 if (session) {
 236                         return session->frame_rate();
 237                 }
 238                 return 0;
 239
 240         case audioMasterGetBlockSize:
 241                 SHOW_CALLBACK ("amc: audioMasterGetBlockSize\n");
 242                 if (session) {
 243                         return session->get_block_size();
 244                 }
 245                 return 0;
 246
 247         case audioMasterGetInputLatency:
 248                 SHOW_CALLBACK ("amc: audioMasterGetInputLatency\n");
 249                 return 0;
 250
 251         case audioMasterGetOutputLatency:
 252                 SHOW_CALLBACK ("amc: audioMasterGetOutputLatency\n");
 253                 return 0;
 254
 255         case audioMasterGetPreviousPlug:
 256                 SHOW_CALLBACK ("amc: audioMasterGetPreviousPlug\n");
 257                // input pin in <value> (-1: first to come), returns cEffect*
 258                 return 0;
 259
 260         case audioMasterGetNextPlug:
 261                 SHOW_CALLBACK ("amc: audioMasterGetNextPlug\n");
 262                // output pin in <value> (-1: first to come), returns cEffect*
 263
 264         case audioMasterWillReplaceOrAccumulate:
 265                 SHOW_CALLBACK ("amc: audioMasterWillReplaceOrAccumulate\n");
 266                // returns: 0: not supported, 1: replace, 2: accumulate
 267                 return 0;
 268
 269         case audioMasterGetCurrentProcessLevel:
 270                 SHOW_CALLBACK ("amc: audioMasterGetCurrentProcessLevel\n");
 271                 // returns: 0: not supported,
 272                 // 1: currently in user thread (gui)
 273                 // 2: currently in audio thread (where process is called)
 274                 // 3: currently in 'sequencer' thread (midi, timer etc)
 275                 // 4: currently offline processing and thus in user thread
 276                 // other: not defined, but probably pre-empting user thread.
 277                 return 0;
 278
 279         case audioMasterGetAutomationState:
 280                 SHOW_CALLBACK ("amc: audioMasterGetAutomationState\n");
 281                 // returns 0: not supported, 1: off, 2:read, 3:write, 4:read/write
 282                 // offline
 283                 return 0;
 284
 285         case audioMasterOfflineStart:
 286                 SHOW_CALLBACK ("amc: audioMasterOfflineStart\n");
 287                 return 0;
 288
 289         case audioMasterOfflineRead:
 290                 SHOW_CALLBACK ("amc: audioMasterOfflineRead\n");
 291                // ptr points to offline structure, see below. return 0: error, 1 ok
 292                 return 0;
 293
 294         case audioMasterOfflineWrite:
 295                 SHOW_CALLBACK ("amc: audioMasterOfflineWrite\n");
 296                 // same as read
 297                 return 0;
 298
 299         case audioMasterOfflineGetCurrentPass:
 300                 SHOW_CALLBACK ("amc: audioMasterOfflineGetCurrentPass\n");
 301                 return 0;
 302
 303         case audioMasterOfflineGetCurrentMetaPass:
 304                 SHOW_CALLBACK ("amc: audioMasterOfflineGetCurrentMetaPass\n");
 305                 return 0;
 306
 307         case audioMasterSetOutputSampleRate:
 308                 SHOW_CALLBACK ("amc: audioMasterSetOutputSampleRate\n");
 309                 // for variable i/o, sample rate in <opt>
 310                 return 0;
 311
 312         case audioMasterGetSpeakerArrangement:
 313                 SHOW_CALLBACK ("amc: audioMasterGetSpeakerArrangement\n");
 314                 // (long)input in <value>, output in <ptr>
 315                 return 0;
 316
 317         case audioMasterGetVendorString:
 318                 SHOW_CALLBACK ("amc: audioMasterGetVendorString\n");
 319                 // fills <ptr> with a string identifying the vendor (max 64 char)
 320                 strcpy ((char*) ptr, "Linux Audio Systems");
 321                 return 0;
 322
 323         case audioMasterGetProductString:
 324                 SHOW_CALLBACK ("amc: audioMasterGetProductString\n");
 325                 // fills <ptr> with a string with product name (max 64 char)
 326                 strcpy ((char*) ptr, PROGRAM_NAME);
 327                 return 0;
 328
 329         case audioMasterGetVendorVersion:
 330                 SHOW_CALLBACK ("amc: audioMasterGetVendorVersion\n");
 331                 // returns vendor-specific version
 332                 return 900;
 333
 334         case audioMasterVendorSpecific:
 335                 SHOW_CALLBACK ("amc: audioMasterVendorSpecific\n");
 336                 // no definition, vendor specific handling
 337                 return 0;
 338
 339         case audioMasterSetIcon:
 340                 SHOW_CALLBACK ("amc: audioMasterSetIcon\n");
 341                 // void* in <ptr>, format not defined yet
 342                 return 0;
 343
 344         case audioMasterCanDo:
 345                 SHOW_CALLBACK ("amc: audioMasterCanDo\n");
 346                 // string in ptr, see below
 347                 return 0;
 348
 349         case audioMasterGetLanguage:
 350                 SHOW_CALLBACK ("amc: audioMasterGetLanguage\n");
 351                 // see enum
 352                 return 0;
 353
 354         case audioMasterOpenWindow:
 355                 SHOW_CALLBACK ("amc: audioMasterOpenWindow\n");
 356                 // returns platform specific ptr
 357                 return 0;
 358
 359         case audioMasterCloseWindow:
 360                 SHOW_CALLBACK ("amc: audioMasterCloseWindow\n");
 361                 // close window, platform specific handle in <ptr>
 362                 return 0;
 363
 364         case audioMasterGetDirectory:
 365                 SHOW_CALLBACK ("amc: audioMasterGetDirectory\n");
 366                 // get plug directory, FSSpec on MAC, else char*
 367                 return 0;
 368
 369         case audioMasterUpdateDisplay:
 370                 SHOW_CALLBACK ("amc: audioMasterUpdateDisplay\n");
 371                 // something has changed, update 'multi-fx' display
 372                 if (effect) {
 373                         effect->dispatcher(effect, effEditIdle, 0, 0, NULL, 0.0f);
 374                 }
 375                 return 0;
 376
 377         case audioMasterBeginEdit:
 378                 SHOW_CALLBACK ("amc: audioMasterBeginEdit\n");
 379                 // begin of automation session (when mouse down), parameter index in <index>
 380                 return 0;
 381
 382         case audioMasterEndEdit:
 383                 SHOW_CALLBACK ("amc: audioMasterEndEdit\n");
 384                 // end of automation session (when mouse up),     parameter index in <index>
 385                 return 0;
 386
 387         case audioMasterOpenFileSelector:
 388                 SHOW_CALLBACK ("amc: audioMasterOpenFileSelector\n");
 389                 // open a fileselector window with VstFileSelect* in <ptr>
 390                 return 0;
 391
 392         default:
 393                 SHOW_CALLBACK ("VST master dispatcher: undefed: %d\n", opcode);
 394                 break;
 395         }
 396
 397         return 0;
 398 }
 399