gtk2_ardour/linux_vst_gui_support.cc

   1 /*
   2  * Copyright (C) 2013-2015 Paul Davis <paul@linuxaudiosystems.com>
   3  * Copyright (C) 2014-2019 Robin Gareus <robin@gareus.org>
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18  */
  19
  20 /******************************************************************/
  21 /** VSTFX - An engine based on FST for handling linuxVST plugins **/
  22 /******************************************************************/
  23
  24 #include <stdlib.h>
  25 #include <stdio.h>
  26 #include <libgen.h>
  27 #include <assert.h>
  28
  29 #include <pthread.h>
  30 #include <signal.h>
  31 #include <glib.h>
  32 #include <glibmm/timer.h>
  33
  34 #include "ardour/linux_vst_support.h"
  35 #include "ardour/vst_plugin.h"
  36
  37 #include <X11/X.h>
  38 #include <X11/Xlib.h>
  39 #include <dlfcn.h>
  40 #include <string.h>
  41 #include <time.h>
  42 #include <unistd.h>
  43 #include <pthread.h>
  44 #include <sys/time.h>
  45
  46 struct ERect{
  47     short top;
  48     short left;
  49     short bottom;
  50     short right;
  51 };
  52
  53 static pthread_mutex_t plugin_mutex;
  54
  55 static VSTState * vstfx_first = NULL;
  56
  57 const char magic[] = "VSTFX Plugin State v002";
  58
  59 static volatile int gui_quit = 0;
  60
  61 /*This will be our connection to X*/
  62
  63 static Display* LXVST_XDisplay = NULL;
  64
  65 /*The thread handle for the GUI event loop*/
  66
  67 static pthread_t LXVST_gui_event_thread;
  68
  69 /*Util functions to get the value of a property attached to an XWindow*/
  70
  71 static bool LXVST_xerror;
  72
  73 int TempErrorHandler (Display *display, XErrorEvent *e)
  74 {
  75         LXVST_xerror = true;
  76
  77         return 0;
  78 }
  79
  80 #ifdef LXVST_32BIT
  81
  82 int getXWindowProperty (Window window, Atom atom)
  83 {
  84         int result = 0;
  85         int userSize;
  86         unsigned long bytes;
  87         unsigned long userCount;
  88         unsigned char *data;
  89         Atom userType;
  90         LXVST_xerror = false;
  91
  92         /*Use our own Xerror handler while we're in here - in an
  93         attempt to stop the brain dead default Xerror behaviour of
  94         qutting the entire application because of e.g. an invalid
  95         window ID*/
  96
  97         XErrorHandler olderrorhandler = XSetErrorHandler (TempErrorHandler);
  98
  99         XGetWindowProperty (LXVST_XDisplay,  // The display
 100                             window,          // The Window
 101                             atom,            // The property
 102                             0,               // Offset into the data
 103                             1,               // Number of 32Bit chunks of data
 104                             false,           // false = don't delete the property
 105                             AnyPropertyType, // Required property type mask
 106                             &userType,       // Actual type returned
 107                             &userSize,       // Actual format returned
 108                             &userCount,      // Actual number of items stored in the returned data
 109                             &bytes,          // Number of bytes remaining if a partial read
 110                             &data);          // The actual data read
 111
 112         if (LXVST_xerror == false && userCount == 1) {
 113                 result = *(int*)data;
 114         }
 115
 116         XSetErrorHandler (olderrorhandler);
 117
 118         /*Hopefully this will return zero if the property is not set*/
 119
 120         return result;
 121 }
 122
 123 #endif
 124
 125 #ifdef LXVST_64BIT
 126
 127 /********************************************************************/
 128 /* This is untested - have no 64Bit plugins which use this          */
 129 /* system of passing an eventProc address                           */
 130 /********************************************************************/
 131
 132 long getXWindowProperty (Window window, Atom atom)
 133 {
 134         long result = 0;
 135         int userSize;
 136         unsigned long bytes;
 137         unsigned long userCount;
 138         unsigned char *data;
 139         Atom userType;
 140         LXVST_xerror = false;
 141
 142         /*Use our own Xerror handler while we're in here - in an
 143          * attempt to stop the brain dead default Xerror behaviour of
 144          * qutting the entire application because of e.g. an invalid
 145          * window ID
 146          */
 147
 148         XErrorHandler olderrorhandler = XSetErrorHandler (TempErrorHandler);
 149
 150         XGetWindowProperty (LXVST_XDisplay,
 151                             window,
 152                             atom,
 153                             0,
 154                             2,
 155                             false,
 156                             AnyPropertyType,
 157                             &userType,
 158                             &userSize,
 159                             &userCount,
 160                             &bytes,
 161                             &data);
 162
 163         if (LXVST_xerror == false && userCount == 1) {
 164                 result = *(long*)data;
 165         }
 166
 167         XSetErrorHandler (olderrorhandler);
 168
 169         /*Hopefully this will return zero if the property is not set*/
 170
 171         return result;
 172 }
 173
 174 #endif
 175
 176 /*The event handler - called from within the main GUI thread to
 177 dispatch events to any VST UIs which have callbacks stuck to them*/
 178
 179 static void
 180 dispatch_x_events (XEvent* event, VSTState* vstfx)
 181 {
 182         /*Handle some of the Events we might be interested in*/
 183
 184         switch (event->type)
 185         {
 186                 /*Configure event - when the window is resized or first drawn*/
 187
 188                 case ConfigureNotify:
 189                 {
 190                         Window window = event->xconfigure.event;
 191
 192                         int width = event->xconfigure.width;
 193                         int height = event->xconfigure.height;
 194
 195                         /* If we get a config notify on the parent window XID then we need to see
 196                          * if the size has been changed - some plugins re-size their UI window e.g.
 197                          * when opening a preset manager.
 198                          *
 199                          * if the size has changed, we flag this so that in lxvst_pluginui.cc
 200                          * we can make the change to the GTK parent window in ardour, from its UI thread */
 201
 202                         if (window == (Window) (vstfx->linux_window)) {
 203 #ifndef NDEBUG
 204                                 printf ("dispatch_x_events: ConfigureNotify cfg: (%d %d) plugin: (%d %d)\n",
 205                                                 width, height,
 206                                                 vstfx->width, vstfx->height
 207                                                 );
 208 #endif
 209                                 if (width != vstfx->width || height != vstfx->height) {
 210                                         vstfx->width = width;
 211                                         vstfx->height = height;
 212                                         ARDOUR::VSTPlugin* plug = (ARDOUR::VSTPlugin *)(vstfx->plugin->ptr1);
 213                                         plug->VSTSizeWindow (); /* EMIT SIGNAL */
 214                                 }
 215
 216                                 /* QUIRK : Loomer plugins not only resize the UI but throw it into some random
 217                                  * position at the same time. We need to re-position the window at the origin of
 218                                  * the parent window*/
 219
 220                                 if (vstfx->linux_plugin_ui_window) {
 221                                         XMoveWindow (LXVST_XDisplay, vstfx->linux_plugin_ui_window, 0, 0);
 222                                 }
 223                         }
 224
 225                         break;
 226                 }
 227
 228                 /*Reparent Notify - when the plugin UI is reparented into
 229                 our Host Window we will get an event here... probably... */
 230
 231                 case ReparentNotify:
 232                 {
 233                         Window ParentWindow = event->xreparent.parent;
 234
 235                         /*If the ParentWindow matches the window for the vstfx instance then
 236                         the Child window must be the XID of the pluginUI window created by the
 237                         plugin, so we need to see if it has a callback stuck to it, and if so
 238                         set that up in the vstfx */
 239
 240                         /***********************************************************/
 241                         /* 64Bit --- This mechanism is not 64Bit compatible at the */
 242                         /* present time                                            */
 243                         /***********************************************************/
 244
 245                         if (ParentWindow == (Window) (vstfx->linux_window)) {
 246
 247                                 Window PluginUIWindowID = event->xreparent.window;
 248
 249                                 vstfx->linux_plugin_ui_window = PluginUIWindowID;
 250 #ifdef LXVST_32BIT
 251                                 int result = getXWindowProperty (PluginUIWindowID, XInternAtom (LXVST_XDisplay, "_XEventProc", false));
 252
 253                                 if (result == 0) {
 254                                         vstfx->eventProc = NULL;
 255                                 } else {
 256                                         vstfx->eventProc = (void (*) (void* event))result;
 257                                 }
 258 #endif
 259 #ifdef LXVST_64BIT
 260                                 long result = getXWindowProperty (PluginUIWindowID, XInternAtom (LXVST_XDisplay, "_XEventProc", false));
 261
 262                                 if (result == 0) {
 263                                         vstfx->eventProc = NULL;
 264                                 } else {
 265                                         vstfx->eventProc = (void (*) (void* event))result;
 266                                 }
 267 #endif
 268                         }
 269                         break;
 270                 }
 271
 272                 case ClientMessage:
 273                 {
 274                         Window window = event->xany.window;
 275                         Atom message_type = event->xclient.message_type;
 276
 277                         /*The only client message we are interested in is to signal
 278                         that the plugin parent window is now valid and can be passed
 279                         to effEditOpen when the editor is launched*/
 280
 281                         if (window == (Window) (vstfx->linux_window)) {
 282                                 char* message = XGetAtomName (LXVST_XDisplay, message_type);
 283
 284                                 if (strcmp (message,"LaunchEditor") == 0) {
 285                                         if (event->xclient.data.l[0] == 0x0FEEDBAC) {
 286                                                 vstfx_launch_editor (vstfx);
 287                                         }
 288                                 }
 289
 290                                 XFree (message);
 291                         }
 292                         break;
 293                 }
 294
 295                 default:
 296                         break;
 297         }
 298
 299         /* Some VSTs built with toolkits e.g. JUCE will manager their own UI
 300         autonomously in the plugin, running the UI in its own thread, so once
 301         we have created a parent window for the plugin, its UI takes care of
 302         itself.*/
 303
 304         /*Other types register a callback as an Xwindow property on the plugin
 305         UI window after they create it.  If that is the case, we need to call it
 306         here, passing the XEvent into it*/
 307
 308         if (vstfx->eventProc == NULL) {
 309                 return;
 310         }
 311
 312         vstfx->eventProc ((void*)event);
 313 }
 314
 315 /** This is the main gui event loop for the plugin, we also need to pass
 316 any Xevents to all the UI callbacks plugins 'may' have registered on their
 317 windows, that is if they don't manage their own UIs **/
 318
 319 void* gui_event_loop (void* ptr)
 320 {
 321         VSTState* vstfx;
 322         int LXVST_sched_timer_interval = 40; //ms, 25fps
 323         XEvent event;
 324         uint64_t clock1, clock2;
 325
 326         clock1 = g_get_monotonic_time();
 327         /*The 'Forever' loop - runs the plugin UIs etc - based on the FST gui event loop*/
 328
 329         while (!gui_quit)
 330         {
 331                 /* handle window creation requests, destroy requests,
 332                    and run idle callbacks */
 333
 334                 /*Look at the XEvent queue - if there are any XEvents we need to handle them,
 335                 including passing them to all the plugin (eventProcs) we are currently managing*/
 336
 337                 bool may_sleep = true;
 338
 339                 if (LXVST_XDisplay) {
 340                         /*See if there are any events in the queue*/
 341
 342                         int num_events = XPending (LXVST_XDisplay);
 343
 344                         if (num_events > 0) {
 345                                 // keep dispatching events as fast as possible
 346                                 may_sleep = false;
 347                         }
 348
 349                         /*process them if there are any*/
 350
 351                         while (num_events) {
 352                                 XNextEvent (LXVST_XDisplay, &event);
 353
 354                                 /*Call dispatch events, with the event, for each plugin in the linked list*/
 355
 356                                 for (vstfx = vstfx_first; vstfx; vstfx = vstfx->next) {
 357                                         pthread_mutex_lock (&vstfx->lock);
 358
 359                                         dispatch_x_events (&event, vstfx);
 360
 361                                         pthread_mutex_unlock (&vstfx->lock);
 362                                 }
 363
 364                                 num_events--;
 365                         }
 366                 }
 367
 368                 /*We don't want to use all the CPU.. */
 369
 370                 Glib::usleep (1000);
 371
 372                 /*See if its time for us to do a scheduled event pass on all the plugins*/
 373
 374                 clock2 = g_get_monotonic_time();
 375                 const int64_t elapsed_time_ms = (clock2 - clock1) / 1000;
 376
 377                 if ((LXVST_sched_timer_interval != 0) && elapsed_time_ms >= LXVST_sched_timer_interval) {
 378                         //printf ("elapsed %d ms ^= %.2f Hz\n", elapsed_time_ms, 1000.0/ (double)elapsed_time_ms); // DEBUG
 379                         pthread_mutex_lock (&plugin_mutex);
 380
 381 again:
 382                         /*Parse through the linked list of plugins*/
 383
 384                         for (vstfx = vstfx_first; vstfx; vstfx = vstfx->next)
 385                         {
 386                                 pthread_mutex_lock (&vstfx->lock);
 387
 388                                 /*Window scheduled for destruction*/
 389
 390                                 if (vstfx->destroy) {
 391                                         if (vstfx->linux_window) {
 392                                                 vstfx->plugin->dispatcher (vstfx->plugin, effEditClose, 0, 0, NULL, 0.0);
 393
 394                                                 XDestroyWindow (LXVST_XDisplay, vstfx->linux_window);
 395                                                 /* FIXME - probably safe to assume we never have an XID of 0 but not explicitly true */
 396                                                 vstfx->linux_window = 0;
 397                                                 vstfx->destroy = FALSE;
 398                                         }
 399
 400                                         vstfx_event_loop_remove_plugin (vstfx);
 401                                         vstfx->been_activated = FALSE;
 402                                         pthread_cond_signal (&vstfx->window_status_change);
 403                                         pthread_mutex_unlock (&vstfx->lock);
 404
 405                                         goto again;
 406                                 }
 407
 408                                 /*Window does not yet exist - scheduled for creation*/
 409
 410                                 /* FIXME - probably safe to assume 0 is not a valid XID but not explicitly true */
 411                                 if (vstfx->linux_window == 0) {
 412                                         if (vstfx_create_editor (vstfx)) {
 413                                                 vstfx_error ("** ERROR ** VSTFX : Cannot create editor for plugin %s", vstfx->handle->name);
 414                                                 vstfx_event_loop_remove_plugin (vstfx);
 415                                                 pthread_cond_signal (&vstfx->window_status_change);
 416                                                 pthread_mutex_unlock (&vstfx->lock);
 417                                                 goto again;
 418                                         } else {
 419                                                 /* condition/unlock: it was signalled & unlocked in fst_create_editor() */
 420                                         }
 421                                 }
 422
 423                                 vststate_maybe_set_program (vstfx);
 424                                 vstfx->want_program = -1;
 425                                 vstfx->want_chunk = 0;
 426
 427                                 /*scheduled call to dispatcher*/
 428
 429                                 if (vstfx->dispatcher_wantcall) {
 430                                         vstfx->dispatcher_retval = vstfx->plugin->dispatcher (
 431                                                 vstfx->plugin,
 432                                                 vstfx->dispatcher_opcode,
 433                                                 vstfx->dispatcher_index,
 434                                                 vstfx->dispatcher_val,
 435                                                 vstfx->dispatcher_ptr,
 436                                                 vstfx->dispatcher_opt
 437                                                 );
 438
 439                                         vstfx->dispatcher_wantcall = 0;
 440                                         pthread_cond_signal (&vstfx->plugin_dispatcher_called);
 441                                 }
 442
 443                                 /*Call the editor Idle function in the plugin*/
 444
 445                                 vstfx->plugin->dispatcher (vstfx->plugin, effEditIdle, 0, 0, NULL, 0);
 446
 447                                 if (vstfx->wantIdle) {
 448                                         vstfx->plugin->dispatcher (vstfx->plugin, 53, 0, 0, NULL, 0);
 449                                 }
 450
 451                                 pthread_mutex_unlock (&vstfx->lock);
 452                         }
 453                         pthread_mutex_unlock (&plugin_mutex);
 454
 455                         clock1 = g_get_monotonic_time();
 456                 }
 457
 458                 if (!gui_quit && may_sleep && elapsed_time_ms + 1 < LXVST_sched_timer_interval) {
 459                         Glib::usleep (1000 * (LXVST_sched_timer_interval - elapsed_time_ms - 1));
 460                 }
 461         }
 462
 463         if (LXVST_XDisplay) {
 464                 XCloseDisplay (LXVST_XDisplay);
 465                 LXVST_XDisplay = 0;
 466         }
 467
 468         /* some plugin UIs (looking at you, u-he^abique), do set thread-keys
 469          * and free, but not unset them.
 470          *
 471          * This leads to a double-free in __nptl_deallocate_tsd
 472          * nptl/pthread_create.c:175  __pthread_keys[idx].destr (data);
 473          * when the event-loop thread is joined.
 474          *
 475          * This workaround is dedicated to all the plugin-UI-devs
 476          * who think their UI owns the complete process memory-space.
 477          *
 478          * NB. ardour itself does not use thread-keys for the
 479          * VST event-loop thread, and anyway, this thread is joined
 480          * only when ardour exit()s. If this would result in a leak,
 481          * nobody will care.
 482          */
 483         if (!getenv ("ARDOUR_RUNNING_UNDER_VALGRIND")) {
 484                 for (pthread_key_t i = 0; i < PTHREAD_KEYS_MAX; ++i) {
 485                         if (pthread_getspecific (i)) {
 486                                 pthread_setspecific (i, NULL);
 487                         }
 488                 }
 489         }
 490
 491         return NULL;
 492 }
 493
 494 /*The VSTFX Init function - this needs to be called before the VSTFX engine
 495 can be accessed, it gets the UI thread running, opens a connection to X etc
 496 normally started in globals.cc*/
 497
 498 int vstfx_init (void* ptr)
 499 {
 500         assert (gui_quit == 0);
 501         pthread_mutex_init (&plugin_mutex, NULL);
 502
 503         int thread_create_result;
 504
 505         pthread_attr_t thread_attributes;
 506
 507         /*Init the attribs to defaults*/
 508
 509         pthread_attr_init (&thread_attributes);
 510
 511         /*Make sure the thread is joinable - this should be the default anyway -
 512         so we can join to it on vstfx_exit*/
 513
 514         pthread_attr_setdetachstate (&thread_attributes, PTHREAD_CREATE_JOINABLE);
 515
 516
 517         /*This is where we need to open a connection to X, and start the GUI thread*/
 518
 519         /*Open our connection to X - all linuxVST plugin UIs handled by the LXVST engine
 520         will talk to X down this connection - X cannot handle multi-threaded access via
 521         the same Display* */
 522
 523         if (LXVST_XDisplay == NULL) {
 524                 LXVST_XDisplay = XOpenDisplay (NULL); //We might be able to make this open a specific screen etc
 525         }
 526
 527         /*Drop out and report the error if we fail to connect to X */
 528
 529         if (LXVST_XDisplay == NULL) {
 530                 vstfx_error ("** ERROR ** VSTFX: Failed opening connection to X");
 531
 532                 return -1;
 533         }
 534
 535         /*We have a connection to X - so start the gui event loop*/
 536
 537         /*Create the thread - use default attrs for now, don't think we need anything special*/
 538
 539         thread_create_result = pthread_create (&LXVST_gui_event_thread, &thread_attributes, gui_event_loop, NULL);
 540
 541         if (thread_create_result != 0)
 542         {
 543                 /*There was a problem starting the GUI event thread*/
 544
 545                 vstfx_error ("** ERROR ** VSTFX: Failed starting GUI event thread");
 546
 547                 XCloseDisplay (LXVST_XDisplay);
 548                 LXVST_XDisplay = 0;
 549                 gui_quit = 1;
 550
 551                 return -1;
 552         }
 553
 554         return 0;
 555 }
 556
 557 /*The vstfx Quit function*/
 558
 559 void vstfx_exit ()
 560 {
 561         if (gui_quit) {
 562                 return;
 563         }
 564         gui_quit = 1;
 565
 566         /*We need to pthread_join the gui_thread here so
 567         we know when it has stopped*/
 568
 569         pthread_join(LXVST_gui_event_thread, NULL);
 570         pthread_mutex_destroy (&plugin_mutex);
 571 }
 572
 573 /*Adds a new plugin (VSTFX) instance to the linked list*/
 574
 575 int vstfx_run_editor (VSTState* vstfx)
 576 {
 577         pthread_mutex_lock (&plugin_mutex);
 578
 579         /* Add the new VSTFX instance to the linked list */
 580
 581         if (vstfx_first == NULL) {
 582                 vstfx_first = vstfx;
 583         } else {
 584                 VSTState* p = vstfx_first;
 585
 586                 while (p->next) {
 587                         p = p->next;
 588                 }
 589                 p->next = vstfx;
 590
 591                 /* Mark the new end of the list */
 592
 593                 vstfx->next = NULL;
 594         }
 595
 596         pthread_mutex_unlock (&plugin_mutex);
 597
 598         /* wait for the plugin editor window to be created (or not) */
 599
 600         pthread_mutex_lock (&vstfx->lock);
 601
 602         if (!vstfx->linux_window) {
 603                 pthread_cond_wait (&vstfx->window_status_change, &vstfx->lock);
 604         }
 605
 606         pthread_mutex_unlock (&vstfx->lock);
 607
 608         if (!vstfx->linux_window) {
 609                 return -1;
 610         }
 611
 612         return 0;
 613 }
 614
 615
 616 /*Creates an editor for the plugin - normally called from within the gui event loop
 617 after run_editor has added the plugin (editor) to the linked list*/
 618
 619 int vstfx_create_editor (VSTState* vstfx)
 620 {
 621         Window parent_window;
 622
 623         int x_size = 1;
 624         int y_size = 1;
 625
 626         /* Note: vstfx->lock is held while this function is called */
 627
 628         if (!(vstfx->plugin->flags & effFlagsHasEditor))
 629         {
 630                 vstfx_error ("** ERROR ** VSTFX: Plugin \"%s\" has no editor", vstfx->handle->name);
 631                 return -1;
 632         }
 633
 634
 635         /*Create an XWindow for the plugin to inhabit*/
 636
 637         parent_window = XCreateSimpleWindow (
 638                 LXVST_XDisplay,
 639                 DefaultRootWindow(LXVST_XDisplay),
 640                 0,
 641                 0,
 642                 x_size,
 643                 y_size,
 644                 0,
 645                 0,
 646                 0
 647                 );
 648
 649         /*Select the events we are interested in receiving - we need Substructure notify so that
 650         if the plugin resizes its window - e.g. Loomer Manifold then we get a message*/
 651
 652         XSelectInput(LXVST_XDisplay,
 653                                 parent_window,
 654                                 SubstructureNotifyMask | ButtonPressMask | ButtonReleaseMask | ButtonMotionMask | ExposureMask);
 655
 656         vstfx->linux_window = parent_window;
 657
 658         vstfx->xid = parent_window;  //vstfx->xid will be referenced to connect to GTK UI in ardour later
 659
 660         /*Because the plugin may be operating on a different Display* to us, and therefore
 661         the two event queues can be asynchronous, although we have created the window on
 662         our display, we can't guarantee it exists in the server yet, which will
 663         cause BadWindow crashes if the plugin tries to use it.
 664
 665         It would be nice to use CreateNotify events here, but they don't get
 666         through on all window managers, so instead we pass a client message
 667         into out queue, after the XCreateWindow.  When this message pops out
 668         in our event handler, it will trigger the second stage of plugin
 669         Editor instantiation, and by then the Window should be valid...*/
 670
 671         XClientMessageEvent event;
 672
 673         /*Create an atom to identify our message (only if it doesn't already exist)*/
 674
 675         Atom WindowActiveAtom = XInternAtom(LXVST_XDisplay, "LaunchEditor", false);
 676
 677         event.type = ClientMessage;
 678         event.send_event = true;
 679         event.window = parent_window;
 680         event.message_type = WindowActiveAtom;
 681
 682         event.format    = 32;         //Data format
 683         event.data.l[0] = 0x0FEEDBAC; //Something we can recognize later
 684
 685         /*Push the event into the queue on our Display*/
 686
 687         XSendEvent(LXVST_XDisplay, parent_window, FALSE, NoEventMask, (XEvent*)&event);
 688
 689         return 0;
 690 }
 691
 692 int
 693 vstfx_launch_editor (VSTState* vstfx)
 694 {
 695         /*This is the second stage of launching the editor (see vstfx_create editor)
 696         we get called here in response to receiving the ClientMessage on our Window,
 697         therefore it's about as safe (as can be) to assume that the Window we created
 698         is now valid in the XServer and can be passed to the plugin in effEditOpen
 699         without generating BadWindow errors when the plugin reparents itself into our
 700         parent window*/
 701
 702         if(vstfx->been_activated)
 703                 return 0;
 704
 705         Window parent_window;
 706         struct ERect* er = NULL;
 707
 708         int x_size = 1;
 709         int y_size = 1;
 710
 711         parent_window = vstfx->linux_window;
 712
 713         /*Open the editor - Bah! we have to pass the int windowID as a void pointer - yuck
 714         it gets cast back to an int as the parent window XID in the plugin - and we have to pass the
 715         Display* as a long */
 716
 717         /**************************************************************/
 718         /* 64Bit --- parent window is an int passed as a void* so     */
 719         /* that should be ok for 64Bit machines                       */
 720         /*                                                            */
 721         /* Display is passed in as a long - ok on arch's where sizeof */
 722         /* long = 8                                                   */
 723         /*                                                            */
 724         /* Most linux VST plugins open a connection to X on their own */
 725         /* Display anyway so it may not matter                        */
 726         /*                                                            */
 727         /* linuxDSP VSTs don't use the host Display* at all           */
 728         /**************************************************************/
 729
 730         vstfx->plugin->dispatcher (vstfx->plugin, effEditOpen, 0, (long)LXVST_XDisplay, (void*)(parent_window), 0);
 731
 732         /*QUIRK - some plugins need a slight delay after opening the editor before you can
 733         ask the window size or they might return zero - specifically discoDSP */
 734
 735         Glib::usleep(100000);
 736
 737         /*Now we can find out how big the parent window should be (and try) to resize it*/
 738
 739         vstfx->plugin->dispatcher (vstfx->plugin, effEditGetRect, 0, 0, &er, 0);
 740
 741         if (er) {
 742                 // Don't crash is plugin does not implement effEditGetRect
 743                 // it'll result in 1x1 px window but that's not our problem :)
 744                 x_size = er->right - er->left;
 745                 y_size = er->bottom - er->top;
 746         }
 747
 748         vstfx->width = x_size;
 749         vstfx->height = y_size;
 750
 751         XResizeWindow (LXVST_XDisplay, parent_window, x_size, y_size);
 752
 753         XFlush (LXVST_XDisplay);
 754
 755         /*Not sure if we need to map the window or if the plugin will do it for us
 756         it should be ok because XReparentWindow generates a Map event*/
 757
 758         /*mark the editor as activated - mainly so that vstfx_get_XID
 759         will know it is valid*/
 760
 761         vstfx->been_activated = TRUE;
 762
 763         pthread_cond_signal (&vstfx->window_status_change);
 764         return 0;
 765 }
 766
 767 /** Destroy the editor window */
 768 void
 769 vstfx_destroy_editor (VSTState* vstfx)
 770 {
 771         pthread_mutex_lock (&vstfx->lock);
 772         if (vstfx->linux_window) {
 773                 vstfx->destroy = TRUE;
 774                 pthread_cond_wait (&vstfx->window_status_change, &vstfx->lock);
 775         }
 776         pthread_mutex_unlock (&vstfx->lock);
 777 }
 778
 779 /** Remove a vstfx instance from the linked list parsed by the
 780     event loop
 781 */
 782 void
 783 vstfx_event_loop_remove_plugin (VSTState* vstfx)
 784 {
 785         /* This only ever gets called from within our GUI thread
 786            so we don't need to lock here - if we did there would be
 787            a deadlock anyway
 788         */
 789
 790         VSTState* p;
 791         VSTState* prev;
 792
 793         for (p = vstfx_first, prev = NULL; p; prev = p, p = p->next) {
 794                 if (p == vstfx) {
 795                         if (prev) {
 796                                 prev->next = p->next;
 797                                 break;
 798                         }
 799                 }
 800         }
 801
 802         // if this function is called, there must be
 803         // at least one plugin in the linked list
 804         assert (vstfx_first);
 805
 806         if (vstfx_first == vstfx) {
 807                 vstfx_first = vstfx_first->next;
 808         }
 809 }
 810