2 Copyright (C) 2012 Paul Davis
3 Based on code by Paul Davis, Torben Hohn as part of FST
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.
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.
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.
21 /******************************************************************/
22 /** VSTFX - An engine based on FST for handling linuxVST plugins **/
23 /******************************************************************/
33 #include <glibmm/timer.h>
35 #include "ardour/linux_vst_support.h"
36 #include "ardour/vst_plugin.h"
54 static pthread_mutex_t plugin_mutex;
56 static VSTState * vstfx_first = NULL;
58 const char magic[] = "VSTFX Plugin State v002";
60 static volatile int gui_quit = 0;
62 /*This will be our connection to X*/
64 static Display* LXVST_XDisplay = NULL;
66 /*The thread handle for the GUI event loop*/
68 static pthread_t LXVST_gui_event_thread;
70 /*Util functions to get the value of a property attached to an XWindow*/
72 static bool LXVST_xerror;
74 int TempErrorHandler(Display *display, XErrorEvent *e)
83 int getXWindowProperty(Window window, Atom atom)
88 unsigned long userCount;
93 /*Use our own Xerror handler while we're in here - in an
94 attempt to stop the brain dead default Xerror behaviour of
95 qutting the entire application because of e.g. an invalid
98 XErrorHandler olderrorhandler = XSetErrorHandler(TempErrorHandler);
100 XGetWindowProperty( LXVST_XDisplay, //The display
103 0, //Offset into the data
104 1, //Number of 32Bit chunks of data
105 false, //false = don't delete the property
106 AnyPropertyType, //Required property type mask
107 &userType, //Actual type returned
108 &userSize, //Actual format returned
109 &userCount, //Actual number of items stored in the returned data
110 &bytes, //Number of bytes remaining if a partial read
111 &data); //The actual data read
113 if(LXVST_xerror == false && userCount == 1)
114 result = *(int*)data;
116 XSetErrorHandler(olderrorhandler);
118 /*Hopefully this will return zero if the property is not set*/
127 /********************************************************************/
128 /* This is untested - have no 64Bit plugins which use this */
129 /* system of passing an eventProc address */
130 /********************************************************************/
132 long getXWindowProperty(Window window, Atom atom)
137 unsigned long userCount;
140 LXVST_xerror = false;
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
147 XErrorHandler olderrorhandler = XSetErrorHandler(TempErrorHandler);
149 XGetWindowProperty( LXVST_XDisplay,
162 if(LXVST_xerror == false && userCount == 1)
163 result = *(long*)data;
165 XSetErrorHandler(olderrorhandler);
167 /*Hopefully this will return zero if the property is not set*/
174 /*The event handler - called from within the main GUI thread to
175 dispatch events to any VST UIs which have callbacks stuck to them*/
178 dispatch_x_events (XEvent* event, VSTState* vstfx)
180 /*Handle some of the Events we might be interested in*/
184 /*Configure event - when the window is resized or first drawn*/
186 case ConfigureNotify:
188 Window window = event->xconfigure.event;
190 int width = event->xconfigure.width;
191 int height = event->xconfigure.height;
193 /* If we get a config notify on the parent window XID then we need to see
194 * if the size has been changed - some plugins re-size their UI window e.g.
195 * when opening a preset manager.
197 * if the size has changed, we flag this so that in lxvst_pluginui.cc
198 * we can make the change to the GTK parent window in ardour, from its UI thread */
200 if (window == (Window) (vstfx->linux_window)) {
202 printf("dispatch_x_events: ConfigureNotify cfg:(%d %d) plugin:(%d %d)\n",
204 vstfx->width, vstfx->height
207 if (width != vstfx->width || height != vstfx->height) {
208 vstfx->width = width;
209 vstfx->height = height;
210 ARDOUR::VSTPlugin* plug = (ARDOUR::VSTPlugin *)(vstfx->plugin->ptr1);
211 plug->VSTSizeWindow (); /* EMIT SIGNAL */
214 /* QUIRK : Loomer plugins not only resize the UI but throw it into some random
215 * position at the same time. We need to re-position the window at the origin of
216 * the parent window*/
218 if (vstfx->linux_plugin_ui_window) {
219 XMoveWindow (LXVST_XDisplay, vstfx->linux_plugin_ui_window, 0, 0);
226 /*Reparent Notify - when the plugin UI is reparented into
227 our Host Window we will get an event here... probably... */
231 Window ParentWindow = event->xreparent.parent;
233 /*If the ParentWindow matches the window for the vstfx instance then
234 the Child window must be the XID of the pluginUI window created by the
235 plugin, so we need to see if it has a callback stuck to it, and if so
236 set that up in the vstfx */
238 /***********************************************************/
239 /* 64Bit --- This mechanism is not 64Bit compatible at the */
241 /***********************************************************/
243 if (ParentWindow == (Window) (vstfx->linux_window)) {
245 Window PluginUIWindowID = event->xreparent.window;
247 vstfx->linux_plugin_ui_window = PluginUIWindowID;
249 int result = getXWindowProperty(PluginUIWindowID, XInternAtom(LXVST_XDisplay, "_XEventProc", false));
252 vstfx->eventProc = NULL;
254 vstfx->eventProc = (void (*) (void* event))result;
258 long result = getXWindowProperty(PluginUIWindowID, XInternAtom(LXVST_XDisplay, "_XEventProc", false));
261 vstfx->eventProc = NULL;
263 vstfx->eventProc = (void (*) (void* event))result;
271 Window window = event->xany.window;
272 Atom message_type = event->xclient.message_type;
274 /*The only client message we are interested in is to signal
275 that the plugin parent window is now valid and can be passed
276 to effEditOpen when the editor is launched*/
278 if (window == (Window) (vstfx->linux_window)) {
279 char* message = XGetAtomName(LXVST_XDisplay, message_type);
281 if (strcmp(message,"LaunchEditor") == 0) {
282 if (event->xclient.data.l[0] == 0x0FEEDBAC) {
283 vstfx_launch_editor (vstfx);
296 /* Some VSTs built with toolkits e.g. JUCE will manager their own UI
297 autonomously in the plugin, running the UI in its own thread, so once
298 we have created a parent window for the plugin, its UI takes care of
301 /*Other types register a callback as an Xwindow property on the plugin
302 UI window after they create it. If that is the case, we need to call it
303 here, passing the XEvent into it*/
305 if (vstfx->eventProc == NULL) {
309 vstfx->eventProc((void*)event);
312 /** This is the main gui event loop for the plugin, we also need to pass
313 any Xevents to all the UI callbacks plugins 'may' have registered on their
314 windows, that is if they don't manage their own UIs **/
316 void* gui_event_loop (void* ptr)
319 int LXVST_sched_timer_interval = 40; //ms, 25fps
321 uint64_t clock1, clock2;
323 clock1 = g_get_monotonic_time();
324 /*The 'Forever' loop - runs the plugin UIs etc - based on the FST gui event loop*/
328 /* handle window creation requests, destroy requests,
329 and run idle callbacks */
331 /*Look at the XEvent queue - if there are any XEvents we need to handle them,
332 including passing them to all the plugin (eventProcs) we are currently managing*/
334 bool may_sleep = true;
338 /*See if there are any events in the queue*/
340 int num_events = XPending(LXVST_XDisplay);
342 if (num_events > 0) {
343 // keep dispatching events as fast as possible
347 /*process them if there are any*/
351 XNextEvent(LXVST_XDisplay, &event);
353 /*Call dispatch events, with the event, for each plugin in the linked list*/
355 for (vstfx = vstfx_first; vstfx; vstfx = vstfx->next)
357 pthread_mutex_lock(&vstfx->lock);
359 dispatch_x_events(&event, vstfx);
361 pthread_mutex_unlock(&vstfx->lock);
368 /*We don't want to use all the CPU.. */
372 /*See if its time for us to do a scheduled event pass on all the plugins*/
374 clock2 = g_get_monotonic_time();
375 const int64_t elapsed_time_ms = (clock2 - clock1) / 1000;
377 if((LXVST_sched_timer_interval != 0) && elapsed_time_ms >= LXVST_sched_timer_interval)
379 //printf("elapsed %d ms ^= %.2f Hz\n", elapsed_time_ms, 1000.0/(double)elapsed_time_ms); // DEBUG
380 pthread_mutex_lock (&plugin_mutex);
383 /*Parse through the linked list of plugins*/
385 for (vstfx = vstfx_first; vstfx; vstfx = vstfx->next)
387 pthread_mutex_lock (&vstfx->lock);
389 /*Window scheduled for destruction*/
391 if (vstfx->destroy) {
392 if (vstfx->linux_window) {
393 vstfx->plugin->dispatcher (vstfx->plugin, effEditClose, 0, 0, NULL, 0.0);
395 XDestroyWindow (LXVST_XDisplay, vstfx->linux_window);
396 /* FIXME - probably safe to assume we never have an XID of 0 but not explicitly true */
397 vstfx->linux_window = 0;
398 vstfx->destroy = FALSE;
401 vstfx_event_loop_remove_plugin (vstfx);
402 vstfx->been_activated = FALSE;
403 pthread_cond_signal (&vstfx->window_status_change);
404 pthread_mutex_unlock (&vstfx->lock);
409 /*Window does not yet exist - scheduled for creation*/
411 /* FIXME - probably safe to assume 0 is not a valid XID but not explicitly true */
412 if (vstfx->linux_window == 0) {
413 if (vstfx_create_editor (vstfx)) {
414 vstfx_error ("** ERROR ** VSTFX : Cannot create editor for plugin %s", vstfx->handle->name);
415 vstfx_event_loop_remove_plugin (vstfx);
416 pthread_cond_signal (&vstfx->window_status_change);
417 pthread_mutex_unlock (&vstfx->lock);
420 /* condition/unlock: it was signalled & unlocked in fst_create_editor() */
424 vststate_maybe_set_program (vstfx);
425 vstfx->want_program = -1;
426 vstfx->want_chunk = 0;
428 /*scheduled call to dispatcher*/
430 if (vstfx->dispatcher_wantcall) {
431 vstfx->dispatcher_retval = vstfx->plugin->dispatcher (
433 vstfx->dispatcher_opcode,
434 vstfx->dispatcher_index,
435 vstfx->dispatcher_val,
436 vstfx->dispatcher_ptr,
437 vstfx->dispatcher_opt
440 vstfx->dispatcher_wantcall = 0;
441 pthread_cond_signal (&vstfx->plugin_dispatcher_called);
444 /*Call the editor Idle function in the plugin*/
446 vstfx->plugin->dispatcher (vstfx->plugin, effEditIdle, 0, 0, NULL, 0);
449 vstfx->plugin->dispatcher (vstfx->plugin, 53, 0, 0, NULL, 0);
451 pthread_mutex_unlock (&vstfx->lock);
453 pthread_mutex_unlock (&plugin_mutex);
455 clock1 = g_get_monotonic_time();
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));
463 if (LXVST_XDisplay) {
464 XCloseDisplay(LXVST_XDisplay);
468 /* some plugin UIs (looking at you, u-he^abique), do set thread-keys
469 * and free, but not unset them.
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.
475 * This workaround is dedicated to all the plugin-UI-devs
476 * who think their UI owns the complete process memory-space.
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,
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);
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*/
498 int vstfx_init (void* ptr)
500 assert (gui_quit == 0);
501 pthread_mutex_init (&plugin_mutex, NULL);
503 int thread_create_result;
505 pthread_attr_t thread_attributes;
507 /*Init the attribs to defaults*/
509 pthread_attr_init(&thread_attributes);
511 /*Make sure the thread is joinable - this should be the default anyway -
512 so we can join to it on vstfx_exit*/
514 pthread_attr_setdetachstate(&thread_attributes, PTHREAD_CREATE_JOINABLE);
517 /*This is where we need to open a connection to X, and start the GUI thread*/
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
523 if(LXVST_XDisplay==NULL)
524 LXVST_XDisplay = XOpenDisplay(NULL); //We might be able to make this open a specific screen etc
526 /*Drop out and report the error if we fail to connect to X */
528 if(LXVST_XDisplay==NULL)
530 vstfx_error ("** ERROR ** VSTFX: Failed opening connection to X");
535 /*We have a connection to X - so start the gui event loop*/
537 /*Create the thread - use default attrs for now, don't think we need anything special*/
539 thread_create_result = pthread_create(&LXVST_gui_event_thread, &thread_attributes, gui_event_loop, NULL);
541 if(thread_create_result!=0)
543 /*There was a problem starting the GUI event thread*/
545 vstfx_error ("** ERROR ** VSTFX: Failed starting GUI event thread");
547 XCloseDisplay(LXVST_XDisplay);
557 /*The vstfx Quit function*/
566 /*We need to pthread_join the gui_thread here so
567 we know when it has stopped*/
569 pthread_join(LXVST_gui_event_thread, NULL);
570 pthread_mutex_destroy (&plugin_mutex);
573 /*Adds a new plugin (VSTFX) instance to the linked list*/
575 int vstfx_run_editor (VSTState* vstfx)
577 pthread_mutex_lock (&plugin_mutex);
579 /* Add the new VSTFX instance to the linked list */
581 if (vstfx_first == NULL) {
584 VSTState* p = vstfx_first;
591 /* Mark the new end of the list */
596 pthread_mutex_unlock (&plugin_mutex);
598 /* wait for the plugin editor window to be created (or not) */
600 pthread_mutex_lock (&vstfx->lock);
602 if (!vstfx->linux_window) {
603 pthread_cond_wait (&vstfx->window_status_change, &vstfx->lock);
606 pthread_mutex_unlock (&vstfx->lock);
608 if (!vstfx->linux_window) {
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*/
619 int vstfx_create_editor (VSTState* vstfx)
621 Window parent_window;
626 /* Note: vstfx->lock is held while this function is called */
628 if (!(vstfx->plugin->flags & effFlagsHasEditor))
630 vstfx_error ("** ERROR ** VSTFX: Plugin \"%s\" has no editor", vstfx->handle->name);
635 /*Create an XWindow for the plugin to inhabit*/
637 parent_window = XCreateSimpleWindow (
639 DefaultRootWindow(LXVST_XDisplay),
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*/
652 XSelectInput(LXVST_XDisplay,
654 SubstructureNotifyMask | ButtonPressMask | ButtonReleaseMask | ButtonMotionMask | ExposureMask);
656 vstfx->linux_window = parent_window;
658 vstfx->xid = parent_window; //vstfx->xid will be referenced to connect to GTK UI in ardour later
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.
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...*/
671 XClientMessageEvent event;
673 /*Create an atom to identify our message (only if it doesn't already exist)*/
675 Atom WindowActiveAtom = XInternAtom(LXVST_XDisplay, "LaunchEditor", false);
677 event.type = ClientMessage;
678 event.send_event = true;
679 event.window = parent_window;
680 event.message_type = WindowActiveAtom;
682 event.format = 32; //Data format
683 event.data.l[0] = 0x0FEEDBAC; //Something we can recognize later
685 /*Push the event into the queue on our Display*/
687 XSendEvent(LXVST_XDisplay, parent_window, FALSE, NoEventMask, (XEvent*)&event);
693 vstfx_launch_editor (VSTState* vstfx)
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
702 if(vstfx->been_activated)
705 Window parent_window;
706 struct ERect* er = NULL;
711 parent_window = vstfx->linux_window;
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 */
717 /**************************************************************/
718 /* 64Bit --- parent window is an int passed as a void* so */
719 /* that should be ok for 64Bit machines */
721 /* Display is passed in as a long - ok on arch's where sizeof */
724 /* Most linux VST plugins open a connection to X on their own */
725 /* Display anyway so it may not matter */
727 /* linuxDSP VSTs don't use the host Display* at all */
728 /**************************************************************/
730 vstfx->plugin->dispatcher (vstfx->plugin, effEditOpen, 0, (long)LXVST_XDisplay, (void*)(parent_window), 0 );
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 */
735 Glib::usleep(100000);
737 /*Now we can find out how big the parent window should be (and try) to resize it*/
739 vstfx->plugin->dispatcher (vstfx->plugin, effEditGetRect, 0, 0, &er, 0 );
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;
748 vstfx->width = x_size;
749 vstfx->height = y_size;
751 XResizeWindow(LXVST_XDisplay, parent_window, x_size, y_size);
753 XFlush (LXVST_XDisplay);
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*/
758 /*mark the editor as activated - mainly so that vstfx_get_XID
759 will know it is valid*/
761 vstfx->been_activated = TRUE;
763 pthread_cond_signal (&vstfx->window_status_change);
767 /** Destroy the editor window */
769 vstfx_destroy_editor (VSTState* vstfx)
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);
776 pthread_mutex_unlock (&vstfx->lock);
779 /** Remove a vstfx instance from the linked list parsed by the
783 vstfx_event_loop_remove_plugin (VSTState* vstfx)
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
793 for (p = vstfx_first, prev = NULL; p; prev = p, p = p->next) {
796 prev->next = p->next;
802 // if this function is called, there must be
803 // at least one plugin in the linked list
806 if (vstfx_first == vstfx) {
807 vstfx_first = vstfx_first->next;