gtk2_ardour/linux_vst_gui_support.cc

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