2 Copyright (C) 2012 Paul Davis
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.
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.
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.
32 #include "pbd/gstdio_compat.h"
33 #include <glibmm/miscutils.h>
34 #include <glibmm/fileutils.h>
36 #include "ardour/linux_vst_support.h"
37 #include "pbd/basename.h"
38 #include "pbd/error.h"
42 /***********************************************************/
43 /* VSTFX - A set of modules for managing linux VST plugins */
44 /* vstfx.cc, vstfxwin.cc and vstfxinfofile.cc */
45 /***********************************************************/
47 /*Simple error handler stuff for VSTFX*/
49 void vstfx_error (const char *fmt, ...)
55 vsnprintf (buffer, sizeof(buffer), fmt, ap);
56 vstfx_error_callback (buffer);
60 /*default error handler callback*/
62 void default_vstfx_error_callback (const char *desc)
64 PBD::error << desc << endmsg;
67 void (*vstfx_error_callback)(const char *desc) = &default_vstfx_error_callback;
71 /*Create and return a pointer to a new VSTFX handle*/
76 VSTHandle* vstfx = (VSTHandle *) calloc (1, sizeof (VSTHandle));
80 /*Create and return a pointer to a new vstfx instance*/
85 VSTState* vstfx = (VSTState *) calloc (1, sizeof (VSTState));
89 pthread_mutex_init (&vstfx->lock, 0);
90 pthread_cond_init (&vstfx->window_status_change, 0);
91 pthread_cond_init (&vstfx->plugin_dispatcher_called, 0);
92 pthread_cond_init (&vstfx->window_created, 0);
96 vstfx->want_program = -1;
97 vstfx->want_chunk = 0;
98 vstfx->n_pending_keys = 0;
99 vstfx->has_editor = 0;
100 vstfx->program_set_without_editor = 0;
101 vstfx->linux_window = 0;
102 vstfx->linux_plugin_ui_window = 0;
103 vstfx->eventProc = 0;
104 vstfx->extra_data = 0;
105 vstfx->want_resize = 0;
110 /*This loads the plugin shared library*/
112 void* vstfx_load_vst_library(const char* path)
115 char* full_path = NULL;
121 /*Try and load the shared library pointed to by the path -
122 NOTE: You have to give RTLD_LAZY or RTLD_NOW to dlopen or
123 you get some occasional failures to load - dlerror reports
126 if ((dll = dlopen (path, RTLD_LOCAL | RTLD_LAZY)) != 0) {
130 if (Glib::file_test (path, Glib::FILE_TEST_EXISTS)) {
131 PBD::error << string_compose (_("Could not open existing LXVST plugin: %1"), dlerror()) << endmsg;
135 /*We didn't find the library so try and get the path specified in the
136 env variable LXVST_PATH*/
138 envdup = getenv ("LXVST_PATH");
140 /*Path not specified - not much more we can do*/
145 /*Copy the path into envdup*/
147 envdup = strdup (envdup);
154 /*Try all the possibilities in the path - deliminated by : */
156 lxvst_path = strtok_r (envdup, ":", &saveptr);
158 while (lxvst_path != 0)
160 vstfx_error ("\"%s\"", lxvst_path);
161 len1 = strlen(lxvst_path);
163 if (full_path) free(full_path);
164 full_path = (char*)malloc(len1 + 1 + len2 + 1);
165 memcpy(full_path, lxvst_path, len1);
166 full_path[len1] = '/';
167 memcpy(full_path + len1 + 1, path, len2);
168 full_path[len1 + 1 + len2] = '\0';
170 /*Try and load the library*/
172 if ((dll = dlopen(full_path, RTLD_LOCAL | RTLD_LAZY)) != 0)
180 lxvst_path = strtok_r (0, ":", &saveptr);
184 if (full_path) free(full_path);
190 /*This loads up a plugin, given the path to its .so file and
191 finds its main entry point etc*/
194 vstfx_load (const char *path)
199 /*Create a new handle we can use to reference the plugin*/
201 fhandle = vstfx_handle_new();
203 /*See if we have .so appended to the path - if not we need to make sure it is added*/
205 if (strstr (path, ".so") == 0)
208 /*Append the .so to the path - Make sure the path has enough space*/
210 buf = (char *)malloc(strlen(path) + 4); //The .so and a terminating zero
212 sprintf (buf, "%s.so", path);
217 /*We already have .so appened to the filename*/
222 /* get a name for the plugin based on the path: ye old VST problem where
223 we don't know anything about its name until we load and instantiate the plugin
224 which we don't want to do at this point
227 fhandle->name = strdup (PBD::basename_nosuffix (path).c_str());
229 /*call load_vstfx_library to actually load the .so into memory*/
231 if ((fhandle->dll = vstfx_load_vst_library (buf)) == 0)
233 vstfx_unload (fhandle);
240 /*Find the main entry point into the plugin*/
242 fhandle->main_entry = (main_entry_t) dlsym(fhandle->dll, "main");
244 if (fhandle->main_entry == 0) {
245 if ((fhandle->main_entry = (main_entry_t) dlsym(fhandle->dll, "VSTPluginMain")) != 0) {
246 PBD::warning << path << _(": is a VST >= 2.4 - this plugin may or may not function correctly with this version of Ardour.") << endmsg;
250 if (fhandle->main_entry == 0)
252 /*If it can't be found, unload the plugin and return a 0 handle*/
254 vstfx_unload (fhandle);
263 /*return the handle of the plugin*/
268 /*This unloads a plugin*/
271 vstfx_unload (VSTHandle* fhandle)
273 if (fhandle->plugincnt)
275 /*Still have plugin instances - can't unload the library
276 - actually dlclose keeps an instance count anyway*/
281 /*Valid plugin loaded?*/
285 dlclose(fhandle->dll);
291 free (fhandle->name);
294 /*Don't need the plugin handle any more*/
300 /*This instantiates a plugin*/
303 vstfx_instantiate (VSTHandle* fhandle, audioMasterCallback amc, void* userptr)
305 VSTState* vstfx = vstfx_new ();
309 vstfx_error( "** ERROR ** VSTFX : The handle was 0\n" );
314 if ((vstfx->plugin = fhandle->main_entry (amc)) == 0)
316 vstfx_error ("** ERROR ** VSTFX : %s could not be instantiated :(\n", fhandle->name);
321 vstfx->handle = fhandle;
322 vstfx->plugin->user = userptr;
324 if (vstfx->plugin->magic != kEffectMagic)
326 vstfx_error ("** ERROR ** VSTFX : %s is not a VST plugin\n", fhandle->name);
331 vstfx->plugin->dispatcher (vstfx->plugin, effOpen, 0, 0, 0, 0);
333 /*May or May not need to 'switch the plugin on' here - unlikely
334 since FST doesn't and most plugins start up 'On' by default - I think this is the least of our worries*/
336 //vstfx->plugin->dispatcher (vstfx->plugin, effMainsChanged, 0, 1, 0, 0);
338 vstfx->vst_version = vstfx->plugin->dispatcher (vstfx->plugin, effGetVstVersion, 0, 0, 0, 0);
340 vstfx->handle->plugincnt++;
346 /*Close a vstfx instance*/
348 void vstfx_close (VSTState* vstfx)
350 vstfx_destroy_editor(vstfx);
354 vstfx->plugin->dispatcher (vstfx->plugin, effMainsChanged, 0, 0, 0, 0);
356 /*Calling dispatcher with effClose will cause the plugin's destructor to
357 be called, which will also remove the editor if it exists*/
359 vstfx->plugin->dispatcher (vstfx->plugin, effClose, 0, 0, 0, 0);
362 if (vstfx->handle->plugincnt)
363 vstfx->handle->plugincnt--;
365 /*vstfx_unload will unload the dll if the instance count allows -
366 we need to do this because some plugins keep their own instance count
367 and (JUCE) manages the plugin UI in its own thread. When the plugins
368 internal instance count reaches zero, JUCE stops the UI thread and won't
369 restart it until the next time the library is loaded. If we don't unload
370 the lib JUCE will never restart*/
373 if (vstfx->handle->plugincnt)
378 /*Valid plugin loaded - so we can unload it and 0 the pointer
379 to it. We can't free the handle here because we don't know what else
380 might need it. It should be / is freed when the plugin is deleted*/
382 if (vstfx->handle->dll)
384 dlclose(vstfx->handle->dll); //dlclose keeps its own reference count
385 vstfx->handle->dll = 0;
392 vstfx_save_state (VSTState* vstfx, char * filename)
394 FILE* f = g_fopen (filename, "wb");
398 int numParams = vstfx->plugin->numParams;
400 char productString[64];
402 char vendorString[64];
407 fprintf(f, "<plugin_state>\n");
409 success = vstfx_call_dispatcher(vstfx, effGetProductString, 0, 0, productString, 0);
413 fprintf (f, " <check field=\"productString\" value=\"%s\"/>\n", productString);
417 printf ("No product string\n");
420 success = vstfx_call_dispatcher(vstfx, effGetEffectName, 0, 0, effectName, 0);
424 fprintf (f, " <check field=\"effectName\" value=\"%s\"/>\n", effectName);
425 printf ("Effect name: %s\n", effectName);
429 printf ("No effect name\n");
432 success = vstfx_call_dispatcher(vstfx, effGetVendorString, 0, 0, vendorString, 0);
436 fprintf (f, " <check field=\"vendorString\" value=\"%s\"/>\n", vendorString);
437 printf ("Vendor string: %s\n", vendorString);
441 printf ("No vendor string\n");
445 if(vstfx->plugin->flags & 32 )
450 for(i=0; i < numParams; i++)
454 pthread_mutex_lock( &vstfx->lock );
455 val = vstfx->plugin->getParameter(vstfx->plugin, i );
456 pthread_mutex_unlock( &vstfx->lock );
457 fprintf( f, " <param index=\"%d\" value=\"%f\"/>\n", i, val );
460 if(vstfx->plugin->flags & 32 )
462 printf( "getting chunk...\n" );
464 bytelen = vstfx_call_dispatcher(vstfx, 23, 0, 0, &chunk, 0 );
465 printf( "got tha chunk..\n" );
470 printf( "Chunke len < 0 !!! Not saving chunk.\n" );
474 //char *encoded = g_base64_encode( chunk, bytelen );
475 //fprintf( f, " <chunk size=\"%d\">\n %s\n </chunk>\n", bytelen, encoded );
481 fprintf( f, "</plugin_state>\n" );
486 printf ("Could not open state file\n");
492 /*Set up a call to the plugins 'dispatcher' function*/
494 int vstfx_call_dispatcher (VSTState* vstfx, int opcode, int index, int val, void *ptr, float opt)
496 pthread_mutex_lock (&vstfx->lock);
498 /*Set up the opcode and parameters*/
500 vstfx->dispatcher_opcode = opcode;
501 vstfx->dispatcher_index = index;
502 vstfx->dispatcher_val = val;
503 vstfx->dispatcher_ptr = ptr;
504 vstfx->dispatcher_opt = opt;
506 /*Signal that we want the call to happen*/
508 vstfx->dispatcher_wantcall = 1;
510 /*Wait for the call to happen*/
512 pthread_cond_wait (&vstfx->plugin_dispatcher_called, &vstfx->lock);
513 pthread_mutex_unlock (&vstfx->lock);
515 /*Return the result*/
517 return vstfx->dispatcher_retval;