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 "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 (session) {
 204                         framepos_t now = session->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                                         session->tempo_map().bbt_time (now, bbt);
 227
 228                                         /* PPQ = pulse per quarter
 229                                          * VST's "pulse" is our "division".
 230                                          *
 231                                          * 8 divisions per bar, 1 division = quarter, so 8 quarters per bar, ppq = 1
 232                                          * 8 divisions per bar, 1 division = eighth, so  4 quarters per bar, ppq = 2
 233                                          * 4 divisions per bar, 1 division = quarter, so  4 quarters per bar, ppq = 1
 234                                          * 4 divisions per bar, 1 division = half, so 8 quarters per bar, ppq = 0.5
 235                                          * 4 divisions per bar, 1 division = fifth, so (4 * 5/4) quarters per bar, ppq = 5/4
 236                                          *
 237                                          * general: divs_per_bar / (note_type / 4.0)
 238                                          */
 239                                         double ppq_scaling =  tm.meter().note_divisor() / 4.0;
 240
 241                                         /* Note that this assumes constant meter/tempo throughout the session. Stupid VST */
 242                                         double ppqBar = double(bbt.bars - 1) * tm.meter().divisions_per_bar();
 243                                         double ppqBeat = double(bbt.beats - 1);
 244                                         double ppqTick = double(bbt.ticks) / Timecode::BBT_Time::ticks_per_beat;
 245
 246                                         ppqBar *= ppq_scaling;
 247                                         ppqBeat *= ppq_scaling;
 248                                         ppqTick *= ppq_scaling;
 249
 250                                         if (value & (kVstPpqPosValid)) {
 251                                                 timeinfo->ppqPos = ppqPos;
 252                                                 newflags |= kVstPpqPosValid;
 253                                         }
 254
 255                                         if (value & (kVstBarsValid)) {
 256                                                 timeinfo->barStartPos = ppqBar;
 257                                                 newflags |= kVstBarsValid;
 258                                         }
 259
 260                                 } catch (...) {
 261                                         /* relax */
 262                                 }
 263                         }
 264
 265                         if (value & (kVstSmpteValid)) {
 266                                 Timecode::Time t;
 267
 268                                 session->timecode_time (now, t);
 269
 270                                 timeinfo->smpteOffset = (t.hours * t.rate * 60.0 * 60.0) +
 271                                         (t.minutes * t.rate * 60.0) +
 272                                         (t.seconds * t.rate) +
 273                                         (t.frames) +
 274                                         (t.subframes);
 275
 276                                 timeinfo->smpteOffset *= 80.0; /* VST spec is 1/80th frames */
 277
 278                                 if (session->timecode_drop_frames()) {
 279                                         if (session->timecode_frames_per_second() == 30.0) {
 280                                                 timeinfo->smpteFrameRate = 5;
 281                                         } else {
 282                                                 timeinfo->smpteFrameRate = 4; /* 29.97 assumed, thanks VST */
 283                                         }
 284                                 } else {
 285                                         if (session->timecode_frames_per_second() == 24.0) {
 286                                                 timeinfo->smpteFrameRate = 0;
 287                                         } else if (session->timecode_frames_per_second() == 24.975) {
 288                                                 timeinfo->smpteFrameRate = 2;
 289                                         } else if (session->timecode_frames_per_second() == 25.0) {
 290                                                 timeinfo->smpteFrameRate = 1;
 291                                         } else {
 292                                                 timeinfo->smpteFrameRate = 3; /* 30 fps */
 293                                         }
 294                                 }
 295                                 newflags |= (kVstSmpteValid);
 296                         }
 297
 298                         if (session->actively_recording ()) {
 299                                 newflags |= kVstTransportRecording;
 300                         }
 301
 302                         if (session->transport_speed () != 0.0f) {
 303                                 newflags |= kVstTransportPlaying;
 304                         }
 305
 306                         if (session->get_play_loop ()) {
 307                                 newflags |= kVstTransportCycleActive;
 308                                 Location * looploc = session->locations ()->auto_loop_location ();
 309                                 if (looploc) try {
 310                                         double ppqBar;
 311                                         Timecode::BBT_Time bbt;
 312
 313                                         session->tempo_map().bbt_time_rt (looploc->start (), bbt);
 314                                         timeinfo->cycleStartPos = vst_ppq (tm, bbt, ppqBar);
 315
 316                                         session->tempo_map().bbt_time_rt (looploc->end (), bbt);
 317                                         timeinfo->cycleEndPos = vst_ppq (tm, bbt, ppqBar);
 318
 319                                         newflags |= kVstCyclePosValid;
 320                                 } catch (...) { }
 321                         }
 322
 323                 } else {
 324                         timeinfo->samplePos = 0;
 325                         timeinfo->sampleRate = AudioEngine::instance()->sample_rate();
 326                 }
 327
 328                 if ((timeinfo->flags & (kVstTransportPlaying | kVstTransportRecording | kVstTransportCycleActive))
 329                     !=
 330                     (newflags        & (kVstTransportPlaying | kVstTransportRecording | kVstTransportCycleActive)))
 331                 {
 332                         newflags |= kVstTransportChanged;
 333                 }
 334
 335                 timeinfo->flags = newflags;
 336                 return (intptr_t) timeinfo;
 337
 338         case audioMasterProcessEvents:
 339                 SHOW_CALLBACK ("audioMasterProcessEvents");
 340                 // VstEvents* in <ptr>
 341                 if (plug && plug->midi_buffer()) {
 342                         VstEvents* v = (VstEvents*)ptr;
 343                         for (int n = 0 ; n < v->numEvents; ++n) {
 344                                 VstMidiEvent *vme = (VstMidiEvent*) (v->events[n]->dump);
 345                                 if (vme->type == kVstMidiType) {
 346                                         plug->midi_buffer()->push_back(vme->deltaFrames, 3, (uint8_t*)vme->midiData);
 347                                 }
 348                         }
 349                 }
 350                 return 0;
 351
 352         case audioMasterSetTime:
 353                 SHOW_CALLBACK ("audioMasterSetTime");
 354                 // VstTimenfo* in <ptr>, filter in <value>, not supported
 355
 356         case audioMasterTempoAt:
 357                 SHOW_CALLBACK ("audioMasterTempoAt");
 358                 // returns tempo (in bpm * 10000) at sample frame location passed in <value>
 359                 if (session) {
 360                         const Tempo& t (session->tempo_map().tempo_at (value));
 361                         return t.beats_per_minute() * 1000;
 362                 } else {
 363                         return 0;
 364                 }
 365                 break;
 366
 367         case audioMasterGetNumAutomatableParameters:
 368                 SHOW_CALLBACK ("audioMasterGetNumAutomatableParameters");
 369                 return 0;
 370
 371         case audioMasterGetParameterQuantization:
 372                 SHOW_CALLBACK ("audioMasterGetParameterQuantization");
 373                 // returns the integer value for +1.0 representation,
 374                 // or 1 if full single float precision is maintained
 375                 // in automation. parameter index in <value> (-1: all, any)
 376                 return 0;
 377
 378         case audioMasterIOChanged:
 379                 SHOW_CALLBACK ("audioMasterIOChanged");
 380                 // numInputs and/or numOutputs has changed
 381                 return 0;
 382
 383         case audioMasterNeedIdle:
 384                 SHOW_CALLBACK ("audioMasterNeedIdle");
 385                 // plug needs idle calls (outside its editor window)
 386                 if (plug) {
 387                         plug->state()->wantIdle = 1;
 388                 }
 389                 return 0;
 390
 391         case audioMasterSizeWindow:
 392                 SHOW_CALLBACK ("audioMasterSizeWindow");
 393                 if (plug && plug->state()) {
 394                         plug->state()->width = index;
 395                         plug->state()->height = value;
 396                         plug->state()->want_resize = 1;
 397                 }
 398                 return 0;
 399
 400         case audioMasterGetSampleRate:
 401                 SHOW_CALLBACK ("audioMasterGetSampleRate");
 402                 if (session) {
 403                         return session->frame_rate();
 404                 }
 405                 return 0;
 406
 407         case audioMasterGetBlockSize:
 408                 SHOW_CALLBACK ("audioMasterGetBlockSize");
 409                 if (session) {
 410                         return session->get_block_size();
 411                 }
 412                 return 0;
 413
 414         case audioMasterGetInputLatency:
 415                 SHOW_CALLBACK ("audioMasterGetInputLatency");
 416                 return 0;
 417
 418         case audioMasterGetOutputLatency:
 419                 SHOW_CALLBACK ("audioMasterGetOutputLatency");
 420                 return 0;
 421
 422         case audioMasterGetPreviousPlug:
 423                 SHOW_CALLBACK ("audioMasterGetPreviousPlug");
 424                 // input pin in <value> (-1: first to come), returns cEffect*
 425                 return 0;
 426
 427         case audioMasterGetNextPlug:
 428                 SHOW_CALLBACK ("audioMasterGetNextPlug");
 429                 // output pin in <value> (-1: first to come), returns cEffect*
 430
 431         case audioMasterWillReplaceOrAccumulate:
 432                 SHOW_CALLBACK ("audioMasterWillReplaceOrAccumulate");
 433                 // returns: 0: not supported, 1: replace, 2: accumulate
 434                 return 0;
 435
 436         case audioMasterGetCurrentProcessLevel:
 437                 SHOW_CALLBACK ("audioMasterGetCurrentProcessLevel");
 438                 // returns: 0: not supported,
 439                 // 1: currently in user thread (gui)
 440                 // 2: currently in audio thread (where process is called)
 441                 // 3: currently in 'sequencer' thread (midi, timer etc)
 442                 // 4: currently offline processing and thus in user thread
 443                 // other: not defined, but probably pre-empting user thread.
 444                 return 0;
 445
 446         case audioMasterGetAutomationState:
 447                 SHOW_CALLBACK ("audioMasterGetAutomationState");
 448                 // returns 0: not supported, 1: off, 2:read, 3:write, 4:read/write
 449                 // offline
 450                 return 0;
 451
 452         case audioMasterOfflineStart:
 453                 SHOW_CALLBACK ("audioMasterOfflineStart");
 454                 return 0;
 455
 456         case audioMasterOfflineRead:
 457                 SHOW_CALLBACK ("audioMasterOfflineRead");
 458                 // ptr points to offline structure, see below. return 0: error, 1 ok
 459                 return 0;
 460
 461         case audioMasterOfflineWrite:
 462                 SHOW_CALLBACK ("audioMasterOfflineWrite");
 463                 // same as read
 464                 return 0;
 465
 466         case audioMasterOfflineGetCurrentPass:
 467                 SHOW_CALLBACK ("audioMasterOfflineGetCurrentPass");
 468                 return 0;
 469
 470         case audioMasterOfflineGetCurrentMetaPass:
 471                 SHOW_CALLBACK ("audioMasterOfflineGetCurrentMetaPass");
 472                 return 0;
 473
 474         case audioMasterSetOutputSampleRate:
 475                 SHOW_CALLBACK ("audioMasterSetOutputSampleRate");
 476                 // for variable i/o, sample rate in <opt>
 477                 return 0;
 478
 479         case audioMasterGetSpeakerArrangement:
 480                 SHOW_CALLBACK ("audioMasterGetSpeakerArrangement");
 481                 // (long)input in <value>, output in <ptr>
 482                 return 0;
 483
 484         case audioMasterGetVendorString:
 485                 SHOW_CALLBACK ("audioMasterGetVendorString");
 486                 // fills <ptr> with a string identifying the vendor (max 64 char)
 487                 strcpy ((char*) ptr, "Linux Audio Systems");
 488                 return 0;
 489
 490         case audioMasterGetProductString:
 491                 SHOW_CALLBACK ("audioMasterGetProductString");
 492                 // fills <ptr> with a string with product name (max 64 char)
 493                 strcpy ((char*) ptr, PROGRAM_NAME);
 494                 return 0;
 495
 496         case audioMasterGetVendorVersion:
 497                 SHOW_CALLBACK ("audioMasterGetVendorVersion");
 498                 // returns vendor-specific version
 499                 return 900;
 500
 501         case audioMasterVendorSpecific:
 502                 SHOW_CALLBACK ("audioMasterVendorSpecific");
 503                 // no definition, vendor specific handling
 504                 return 0;
 505
 506         case audioMasterSetIcon:
 507                 SHOW_CALLBACK ("audioMasterSetIcon");
 508                 // void* in <ptr>, format not defined yet
 509                 return 0;
 510
 511         case audioMasterCanDo:
 512                 SHOW_CALLBACK ("audioMasterCanDo");
 513                 // string in ptr,  (const char*)ptr
 514                 for (int i = 0; i < vst_can_do_string_count; i++) {
 515                         if (! strcmp(vst_can_do_strings[i], (const char*)ptr)) {
 516                                 return 1;
 517                         }
 518                 }
 519                 return 0;
 520
 521         case audioMasterGetLanguage:
 522                 SHOW_CALLBACK ("audioMasterGetLanguage");
 523                 // see enum
 524                 return 0;
 525
 526         case audioMasterOpenWindow:
 527                 SHOW_CALLBACK ("audioMasterOpenWindow");
 528                 // returns platform specific ptr
 529                 return 0;
 530
 531         case audioMasterCloseWindow:
 532                 SHOW_CALLBACK ("audioMasterCloseWindow");
 533                 // close window, platform specific handle in <ptr>
 534                 return 0;
 535
 536         case audioMasterGetDirectory:
 537                 SHOW_CALLBACK ("audioMasterGetDirectory");
 538                 // get plug directory, FSSpec on MAC, else char*
 539                 return 0;
 540
 541         case audioMasterUpdateDisplay:
 542                 SHOW_CALLBACK ("audioMasterUpdateDisplay");
 543                 // something has changed, update 'multi-fx' display
 544                 if (effect) {
 545                         effect->dispatcher(effect, effEditIdle, 0, 0, NULL, 0.0f);
 546                 }
 547                 return 0;
 548
 549         case audioMasterBeginEdit:
 550                 SHOW_CALLBACK ("audioMasterBeginEdit");
 551                 // begin of automation session (when mouse down), parameter index in <index>
 552                 return 0;
 553
 554         case audioMasterEndEdit:
 555                 SHOW_CALLBACK ("audioMasterEndEdit");
 556                 // end of automation session (when mouse up),     parameter index in <index>
 557                 return 0;
 558
 559         case audioMasterOpenFileSelector:
 560                 SHOW_CALLBACK ("audioMasterOpenFileSelector");
 561                 // open a fileselector window with VstFileSelect* in <ptr>
 562                 return 0;
 563
 564         default:
 565                 DEBUG_TRACE (PBD::DEBUG::VSTCallbacks, string_compose ("VST master dispatcher: undefed: %1\n", opcode));
 566                 break;
 567         }
 568
 569         return 0;
 570 }
 571