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/audioengine.h"
  26 #include "ardour/debug.h"
  27 #include "ardour/session.h"
  28 #include "ardour/tempo.h"
  29 #include "ardour/plugin_insert.h"
  30 #include "ardour/windows_vst_plugin.h"
  31 #include "ardour/vestige/aeffectx.h"
  32 #include "ardour/vst_types.h"
  33 #ifdef WINDOWS_VST_SUPPORT
  34 #include <fst.h>
  35 #endif
  36
  37 #include "pbd/i18n.h"
  38
  39 using namespace ARDOUR;
  40
  41 #define SHOW_CALLBACK(MSG) DEBUG_TRACE (PBD::DEBUG::VSTCallbacks, string_compose (MSG " val = %1 idx = %2\n", index, value))
  42
  43 static double
  44 vst_ppq (const TempoMetric& tm, const Timecode::BBT_Time& bbt, double& ppqBar)
  45 {
  46
  47         /* PPQ = pulse per quarter
  48          * VST's "pulse" is our "division".
  49          *
  50          * 8 divisions per bar, 1 division = quarter, so 8 quarters per bar, ppq = 1
  51          * 8 divisions per bar, 1 division = eighth, so  4 quarters per bar, ppq = 2
  52          * 4 divisions per bar, 1 division = quarter, so  4 quarters per bar, ppq = 1
  53          * 4 divisions per bar, 1 division = half, so 8 quarters per bar, ppq = 0.5
  54          * 4 divisions per bar, 1 division = fifth, so (4 * 5/4) quarters per bar, ppq = 5/4
  55          *
  56          * general: divs_per_bar / (note_type / 4.0)
  57          */
  58         const double ppq_scaling =  tm.meter().note_divisor() / 4.0;
  59
  60         /* Note that this assumes constant meter/tempo throughout the session. Stupid VST */
  61         ppqBar = double(bbt.bars - 1) * tm.meter().divisions_per_bar();
  62         double ppqBeat = double(bbt.beats - 1);
  63         double ppqTick = double(bbt.ticks) / Timecode::BBT_Time::ticks_per_beat;
  64
  65         ppqBar *= ppq_scaling;
  66         ppqBeat *= ppq_scaling;
  67         ppqTick *= ppq_scaling;
  68
  69         return ppqBar + ppqBeat + ppqTick;
  70 }
  71
  72 int Session::vst_current_loading_id = 0;
  73 const char* Session::vst_can_do_strings[] = {
  74         X_("supplyIdle"),
  75         X_("sendVstTimeInfo"),
  76         X_("sendVstEvents"),
  77         X_("sendVstMidiEvent"),
  78         X_("receiveVstEvents"),
  79         X_("receiveVstMidiEvent"),
  80         X_("supportShell"),
  81         X_("shellCategory"),
  82         X_("shellCategorycurID")
  83 };
  84 const int Session::vst_can_do_string_count = sizeof (vst_can_do_strings) / sizeof (char*);
  85
  86 intptr_t Session::vst_callback (
  87         AEffect* effect,
  88         int32_t opcode,
  89         int32_t index,
  90         intptr_t value,
  91         void* ptr,
  92         float opt
  93         )
  94 {
  95         VSTPlugin* plug;
  96         Session* session;
  97         static VstTimeInfo _timeinfo; // only uses as fallback
  98         VstTimeInfo* timeinfo;
  99         int32_t newflags = 0;
 100
 101         if (effect && effect->user) {
 102                 plug = (VSTPlugin *) (effect->user);
 103                 session = &plug->session();
 104                 timeinfo = plug->timeinfo ();
 105                 DEBUG_TRACE (PBD::DEBUG::VSTCallbacks, string_compose ("am callback 0x%1%2, opcode = %3%4, plugin = \"%5\"\n",
 106                                         std::hex, (void*) DEBUG_THREAD_SELF,
 107                                         std::dec, opcode, plug->name()));
 108         } else {
 109                 plug = 0;
 110                 session = 0;
 111                 timeinfo = &_timeinfo;
 112                 DEBUG_TRACE (PBD::DEBUG::VSTCallbacks, string_compose ("am callback 0x%1%2, opcode = %3%4\n",
 113                                         std::hex, (void*) DEBUG_THREAD_SELF,
 114                                         std::dec, opcode));
 115         }
 116
 117         switch(opcode){
 118
 119         case audioMasterAutomate:
 120                 SHOW_CALLBACK ("audioMasterAutomate");
 121                 // index, value, returns 0
 122                 if (plug) {
 123                         plug->parameter_changed_externally (index, opt);
 124                 }
 125                 return 0;
 126
 127         case audioMasterVersion:
 128                 SHOW_CALLBACK ("audioMasterVersion");
 129                 // vst version, currently 2 (0 for older)
 130                 return 2400;
 131
 132         case audioMasterCurrentId:
 133                 SHOW_CALLBACK ("audioMasterCurrentId");
 134                 // returns the unique id of a plug that's currently loading
 135                 return vst_current_loading_id;
 136
 137         case audioMasterIdle:
 138                 SHOW_CALLBACK ("audioMasterIdle");
 139 #ifdef WINDOWS_VST_SUPPORT
 140                 fst_audio_master_idle();
 141 #endif
 142                 if (effect) {
 143                         effect->dispatcher(effect, effEditIdle, 0, 0, NULL, 0.0f);
 144                 }
 145                 return 0;
 146
 147         case audioMasterPinConnected:
 148                 SHOW_CALLBACK ("audioMasterPinConnected");
 149                 // inquire if an input or output is beeing connected;
 150                 // index enumerates input or output counting from zero:
 151                 // value is 0 for input and != 0 otherwise. note: the
 152                 // return value is 0 for <true> such that older versions
 153                 // will always return true.
 154                 if (!plug) {
 155                         // we don't know.
 156                         // but ardour always connects all buffers, so we're good
 157                         return 0;
 158                 }
 159                 switch (value) {
 160                         case 0:
 161                                 if (plug->plugin_insert ()) {
 162                                         bool valid;
 163                                         const ChanMapping& map (plug->plugin_insert ()->input_map (plug->plugin_number ()));
 164                                         map.get (DataType::AUDIO, index, &valid);
 165                                         return valid ? 0 : 1;
 166                                 }
 167                                 if (index < plug->plugin()->numInputs) {
 168                                         return 0;
 169                                 }
 170                                 break;
 171                         case 1:
 172 #if 0 // investigate, the outputs *are* connected to scratch buffers
 173                                 if (plug->plugin_insert ()) {
 174                                         bool valid;
 175                                         const ChanMapping& map (plug->plugin_insert ()->output_map (plug->plugin_number ()));
 176                                         map.get (DataType::AUDIO, index, &valid);
 177                                         return valid ? 0 : 1;
 178                                 }
 179 #endif
 180                                 if (index < plug->plugin()->numOutputs) {
 181                                         return 0;
 182                                 }
 183                                 break;
 184                         default:
 185                                 break;
 186                 }
 187                 return 1;
 188
 189         case audioMasterWantMidi:
 190                 SHOW_CALLBACK ("audioMasterWantMidi");
 191                 // <value> is a filter which is currently ignored
 192                 if (plug && plug->get_info() != NULL) {
 193                         plug->get_info()->n_inputs.set_midi (1);
 194                 }
 195                 return 0;
 196
 197         case audioMasterGetTime:
 198                 SHOW_CALLBACK ("audioMasterGetTime");
 199                 newflags = kVstNanosValid | kVstAutomationWriting | kVstAutomationReading;
 200
 201                 timeinfo->nanoSeconds = g_get_monotonic_time () * 1000;
 202
 203                 if (plug && session) {
 204                         framepos_t now = plug->transport_frame();
 205
 206                         timeinfo->samplePos = now;
 207                         timeinfo->sampleRate = session->frame_rate();
 208
 209                         const TempoMetric& tm (session->tempo_map().metric_at (now));
 210
 211                         if (value & (kVstTempoValid)) {
 212                                 const Tempo& t (tm.tempo());
 213                                 timeinfo->tempo = t.beats_per_minute ();
 214                                 newflags |= (kVstTempoValid);
 215                         }
 216                         if (value & (kVstTimeSigValid)) {
 217                                 const Meter& m (tm.meter());
 218                                 timeinfo->timeSigNumerator = m.divisions_per_bar ();
 219                                 timeinfo->timeSigDenominator = m.note_divisor ();
 220                                 newflags |= (kVstTimeSigValid);
 221                         }
 222                         if ((value & (kVstPpqPosValid)) || (value & (kVstBarsValid))) {
 223                                 Timecode::BBT_Time bbt;
 224
 225                                 try {
 226                                         bbt = session->tempo_map().bbt_at_frame_rt (now);
 227
 228                                         double ppqBar;
 229                                         double ppqPos = vst_ppq (tm, bbt, ppqBar);
 230
 231                                         if (value & (kVstPpqPosValid)) {
 232                                                 timeinfo->ppqPos = ppqPos;
 233                                                 newflags |= kVstPpqPosValid;
 234                                         }
 235
 236                                         if (value & (kVstBarsValid)) {
 237                                                 timeinfo->barStartPos = ppqBar;
 238                                                 newflags |= kVstBarsValid;
 239                                         }
 240
 241                                 } catch (...) {
 242                                         /* relax */
 243                                 }
 244                         }
 245
 246                         if (value & (kVstSmpteValid)) {
 247                                 Timecode::Time t;
 248
 249                                 session->timecode_time (now, t);
 250
 251                                 timeinfo->smpteOffset = (t.hours * t.rate * 60.0 * 60.0) +
 252                                         (t.minutes * t.rate * 60.0) +
 253                                         (t.seconds * t.rate) +
 254                                         (t.frames) +
 255                                         (t.subframes);
 256
 257                                 timeinfo->smpteOffset *= 80.0; /* VST spec is 1/80th frames */
 258
 259                                 if (session->timecode_drop_frames()) {
 260                                         if (session->timecode_frames_per_second() == 30.0) {
 261                                                 timeinfo->smpteFrameRate = 5;
 262                                         } else {
 263                                                 timeinfo->smpteFrameRate = 4; /* 29.97 assumed, thanks VST */
 264                                         }
 265                                 } else {
 266                                         if (session->timecode_frames_per_second() == 24.0) {
 267                                                 timeinfo->smpteFrameRate = 0;
 268                                         } else if (session->timecode_frames_per_second() == 24.975) {
 269                                                 timeinfo->smpteFrameRate = 2;
 270                                         } else if (session->timecode_frames_per_second() == 25.0) {
 271                                                 timeinfo->smpteFrameRate = 1;
 272                                         } else {
 273                                                 timeinfo->smpteFrameRate = 3; /* 30 fps */
 274                                         }
 275                                 }
 276                                 newflags |= (kVstSmpteValid);
 277                         }
 278
 279                         if (session->actively_recording ()) {
 280                                 newflags |= kVstTransportRecording;
 281                         }
 282
 283                         if (plug->transport_speed () != 0.0f) {
 284                                 newflags |= kVstTransportPlaying;
 285                         }
 286
 287                         if (session->get_play_loop ()) {
 288                                 newflags |= kVstTransportCycleActive;
 289                                 Location * looploc = session->locations ()->auto_loop_location ();
 290                                 if (looploc) try {
 291                                         double ppqBar;
 292                                         Timecode::BBT_Time bbt;
 293
 294                                         bbt = session->tempo_map ().bbt_at_frame_rt (looploc->start ());
 295                                         timeinfo->cycleStartPos = vst_ppq (tm, bbt, ppqBar);
 296
 297                                         bbt = session->tempo_map ().bbt_at_frame_rt (looploc->end ());
 298                                         timeinfo->cycleEndPos = vst_ppq (tm, bbt, ppqBar);
 299
 300                                         newflags |= kVstCyclePosValid;
 301                                 } catch (...) { }
 302                         }
 303
 304                 } else {
 305                         timeinfo->samplePos = 0;
 306                         timeinfo->sampleRate = AudioEngine::instance()->sample_rate();
 307                 }
 308
 309                 if ((timeinfo->flags & (kVstTransportPlaying | kVstTransportRecording | kVstTransportCycleActive))
 310                     !=
 311                     (newflags        & (kVstTransportPlaying | kVstTransportRecording | kVstTransportCycleActive)))
 312                 {
 313                         newflags |= kVstTransportChanged;
 314                 }
 315
 316                 timeinfo->flags = newflags;
 317                 return (intptr_t) timeinfo;
 318
 319         case audioMasterProcessEvents:
 320                 SHOW_CALLBACK ("audioMasterProcessEvents");
 321                 // VstEvents* in <ptr>
 322                 if (plug && plug->midi_buffer()) {
 323                         VstEvents* v = (VstEvents*)ptr;
 324                         for (int n = 0 ; n < v->numEvents; ++n) {
 325                                 VstMidiEvent *vme = (VstMidiEvent*) (v->events[n]->dump);
 326                                 if (vme->type == kVstMidiType) {
 327                                         plug->midi_buffer()->push_back(vme->deltaFrames, 3, (uint8_t*)vme->midiData);
 328                                 }
 329                         }
 330                 }
 331                 return 0;
 332
 333         case audioMasterSetTime:
 334                 SHOW_CALLBACK ("audioMasterSetTime");
 335                 // VstTimenfo* in <ptr>, filter in <value>, not supported
 336
 337         case audioMasterTempoAt:
 338                 SHOW_CALLBACK ("audioMasterTempoAt");
 339                 // returns tempo (in bpm * 10000) at sample frame location passed in <value>
 340                 if (session) {
 341                         const Tempo& t (session->tempo_map().tempo_at_frame (value));
 342                         return t.beats_per_minute() * 1000;
 343                 } else {
 344                         return 0;
 345                 }
 346                 break;
 347
 348         case audioMasterGetNumAutomatableParameters:
 349                 SHOW_CALLBACK ("audioMasterGetNumAutomatableParameters");
 350                 return 0;
 351
 352         case audioMasterGetParameterQuantization:
 353                 SHOW_CALLBACK ("audioMasterGetParameterQuantization");
 354                 // returns the integer value for +1.0 representation,
 355                 // or 1 if full single float precision is maintained
 356                 // in automation. parameter index in <value> (-1: all, any)
 357                 return 0;
 358
 359         case audioMasterIOChanged:
 360                 SHOW_CALLBACK ("audioMasterIOChanged");
 361                 // numInputs and/or numOutputs has changed
 362                 return 0;
 363
 364         case audioMasterNeedIdle:
 365                 SHOW_CALLBACK ("audioMasterNeedIdle");
 366                 // plug needs idle calls (outside its editor window)
 367                 if (plug) {
 368                         plug->state()->wantIdle = 1;
 369                 }
 370                 return 0;
 371
 372         case audioMasterSizeWindow:
 373                 SHOW_CALLBACK ("audioMasterSizeWindow");
 374                 if (plug && plug->state()) {
 375                         plug->state()->width = index;
 376                         plug->state()->height = value;
 377                         plug->state()->want_resize = 1;
 378                 }
 379                 return 0;
 380
 381         case audioMasterGetSampleRate:
 382                 SHOW_CALLBACK ("audioMasterGetSampleRate");
 383                 if (session) {
 384                         return session->frame_rate();
 385                 }
 386                 return 0;
 387
 388         case audioMasterGetBlockSize:
 389                 SHOW_CALLBACK ("audioMasterGetBlockSize");
 390                 if (session) {
 391                         return session->get_block_size();
 392                 }
 393                 return 0;
 394
 395         case audioMasterGetInputLatency:
 396                 SHOW_CALLBACK ("audioMasterGetInputLatency");
 397                 return 0;
 398
 399         case audioMasterGetOutputLatency:
 400                 SHOW_CALLBACK ("audioMasterGetOutputLatency");
 401                 return 0;
 402
 403         case audioMasterGetPreviousPlug:
 404                 SHOW_CALLBACK ("audioMasterGetPreviousPlug");
 405                 // input pin in <value> (-1: first to come), returns cEffect*
 406                 return 0;
 407
 408         case audioMasterGetNextPlug:
 409                 SHOW_CALLBACK ("audioMasterGetNextPlug");
 410                 // output pin in <value> (-1: first to come), returns cEffect*
 411
 412         case audioMasterWillReplaceOrAccumulate:
 413                 SHOW_CALLBACK ("audioMasterWillReplaceOrAccumulate");
 414                 // returns: 0: not supported, 1: replace, 2: accumulate
 415                 return 0;
 416
 417         case audioMasterGetCurrentProcessLevel:
 418                 SHOW_CALLBACK ("audioMasterGetCurrentProcessLevel");
 419                 // returns: 0: not supported,
 420                 // 1: currently in user thread (gui)
 421                 // 2: currently in audio thread (where process is called)
 422                 // 3: currently in 'sequencer' thread (midi, timer etc)
 423                 // 4: currently offline processing and thus in user thread
 424                 // other: not defined, but probably pre-empting user thread.
 425                 return 0;
 426
 427         case audioMasterGetAutomationState:
 428                 SHOW_CALLBACK ("audioMasterGetAutomationState");
 429                 // returns 0: not supported, 1: off, 2:read, 3:write, 4:read/write
 430                 // offline
 431                 return 0;
 432
 433         case audioMasterOfflineStart:
 434                 SHOW_CALLBACK ("audioMasterOfflineStart");
 435                 return 0;
 436
 437         case audioMasterOfflineRead:
 438                 SHOW_CALLBACK ("audioMasterOfflineRead");
 439                 // ptr points to offline structure, see below. return 0: error, 1 ok
 440                 return 0;
 441
 442         case audioMasterOfflineWrite:
 443                 SHOW_CALLBACK ("audioMasterOfflineWrite");
 444                 // same as read
 445                 return 0;
 446
 447         case audioMasterOfflineGetCurrentPass:
 448                 SHOW_CALLBACK ("audioMasterOfflineGetCurrentPass");
 449                 return 0;
 450
 451         case audioMasterOfflineGetCurrentMetaPass:
 452                 SHOW_CALLBACK ("audioMasterOfflineGetCurrentMetaPass");
 453                 return 0;
 454
 455         case audioMasterSetOutputSampleRate:
 456                 SHOW_CALLBACK ("audioMasterSetOutputSampleRate");
 457                 // for variable i/o, sample rate in <opt>
 458                 return 0;
 459
 460         case audioMasterGetSpeakerArrangement:
 461                 SHOW_CALLBACK ("audioMasterGetSpeakerArrangement");
 462                 // (long)input in <value>, output in <ptr>
 463                 return 0;
 464
 465         case audioMasterGetVendorString:
 466                 SHOW_CALLBACK ("audioMasterGetVendorString");
 467                 // fills <ptr> with a string identifying the vendor (max 64 char)
 468                 strcpy ((char*) ptr, "Linux Audio Systems");
 469                 return 0;
 470
 471         case audioMasterGetProductString:
 472                 SHOW_CALLBACK ("audioMasterGetProductString");
 473                 // fills <ptr> with a string with product name (max 64 char)
 474                 strcpy ((char*) ptr, PROGRAM_NAME);
 475                 return 0;
 476
 477         case audioMasterGetVendorVersion:
 478                 SHOW_CALLBACK ("audioMasterGetVendorVersion");
 479                 // returns vendor-specific version
 480                 return 900;
 481
 482         case audioMasterVendorSpecific:
 483                 SHOW_CALLBACK ("audioMasterVendorSpecific");
 484                 // no definition, vendor specific handling
 485                 return 0;
 486
 487         case audioMasterSetIcon:
 488                 SHOW_CALLBACK ("audioMasterSetIcon");
 489                 // void* in <ptr>, format not defined yet
 490                 return 0;
 491
 492         case audioMasterCanDo:
 493                 SHOW_CALLBACK ("audioMasterCanDo");
 494                 // string in ptr,  (const char*)ptr
 495                 for (int i = 0; i < vst_can_do_string_count; i++) {
 496                         if (! strcmp(vst_can_do_strings[i], (const char*)ptr)) {
 497                                 return 1;
 498                         }
 499                 }
 500                 return 0;
 501
 502         case audioMasterGetLanguage:
 503                 SHOW_CALLBACK ("audioMasterGetLanguage");
 504                 // see enum
 505                 return 0;
 506
 507         case audioMasterOpenWindow:
 508                 SHOW_CALLBACK ("audioMasterOpenWindow");
 509                 // returns platform specific ptr
 510                 return 0;
 511
 512         case audioMasterCloseWindow:
 513                 SHOW_CALLBACK ("audioMasterCloseWindow");
 514                 // close window, platform specific handle in <ptr>
 515                 return 0;
 516
 517         case audioMasterGetDirectory:
 518                 SHOW_CALLBACK ("audioMasterGetDirectory");
 519                 // get plug directory, FSSpec on MAC, else char*
 520                 return 0;
 521
 522         case audioMasterUpdateDisplay:
 523                 SHOW_CALLBACK ("audioMasterUpdateDisplay");
 524                 // something has changed, update 'multi-fx' display
 525                 if (effect) {
 526                         effect->dispatcher(effect, effEditIdle, 0, 0, NULL, 0.0f);
 527                 }
 528                 return 0;
 529
 530         case audioMasterBeginEdit:
 531                 SHOW_CALLBACK ("audioMasterBeginEdit");
 532                 // begin of automation session (when mouse down), parameter index in <index>
 533                 return 0;
 534
 535         case audioMasterEndEdit:
 536                 SHOW_CALLBACK ("audioMasterEndEdit");
 537                 // end of automation session (when mouse up),     parameter index in <index>
 538                 return 0;
 539
 540         case audioMasterOpenFileSelector:
 541                 SHOW_CALLBACK ("audioMasterOpenFileSelector");
 542                 // open a fileselector window with VstFileSelect* in <ptr>
 543                 return 0;
 544
 545         default:
 546                 DEBUG_TRACE (PBD::DEBUG::VSTCallbacks, string_compose ("VST master dispatcher: undefed: %1\n", opcode));
 547                 break;
 548         }
 549
 550         return 0;
 551 }