Chris@28: Chris@28: [Vamp] Plugin Load Checker Chris@28: ========================== Chris@28: Chris@28: This is a very small command-line program (C++98, no particular Chris@28: dependencies) for testing plugin libraries to see if they are Chris@28: loadable. You run the program, pass it a list of library paths to Chris@28: stdin, it tries to load them, and it reports to stdout whether each Chris@28: load succeeded or not. Chris@28: Chris@28: The program was written for use with Vamp audio analysis plugins, but Chris@28: it also works with other plugin formats. It has some hardcoded Chris@28: knowledge of Vamp, LADSPA, and DSSI plugins but it can be used with Chris@28: any plugins that involve loading DLLs and looking up descriptor Chris@28: functions from them. Chris@28: Chris@28: It comes with a library (C++11, Qt) that searches for candidate plugin Chris@28: files for some known formats in standard locations and runs the Chris@28: checker program as a separate process to check whether they can be Chris@28: loaded. This can be used to scan plugins and blacklist any that might Chris@29: crash a host on load. Chris@28: Chris@28: Chris@28: About the command-line program Chris@28: ------------------------------ Chris@28: Chris@28: The program (vamp-plugin-load-checker) accepts the name of a Chris@28: descriptor symbol as its only command-line argument. It then reads a Chris@28: list of plugin library paths from stdin, one per line. For each path Chris@28: read, it attempts to load that library and retrieve the named Chris@28: descriptor symbol, printing a line to stdout reporting whether this Chris@28: was successful or not and then flushing stdout. The output line format Chris@28: is described below. The program exits with code 0 if all libraries Chris@28: were loaded successfully and non-zero otherwise. Chris@28: Chris@28: Note that library paths must be ready to pass to dlopen() or Chris@28: equivalent; this usually means they should be absolute paths. Chris@28: Chris@28: Output line for successful load of library libname.so: Chris@28: SUCCESS|/path/to/libname.so| Chris@28: Chris@28: Output line for failed load of library libname.so: Chris@28: FAILURE|/path/to/libname.so|Reason for failure if available Chris@28: Chris@28: Although this program was written for use with Vamp audio analysis Chris@28: plugins, it also works with other plugin formats. The program has some Chris@28: hardcoded knowledge of Vamp, LADSPA, and DSSI plugins, but it can be Chris@28: used with any plugins that involve loading DLLs and looking up Chris@28: descriptor functions from them. Chris@28: Chris@28: Sometimes plugins will crash completely on load, bringing down this Chris@28: program with them. If the program exits before all listed plugins have Chris@28: been checked, this means that the plugin following the last reported Chris@28: one has crashed. Typically the caller may want to run it again, Chris@28: omitting that plugin. Chris@28: Chris@28: This program (src/helper.cpp) is written in C++98 and has no Chris@28: particular dependencies apart from the dynamic loader library. Chris@28: Chris@28: Chris@28: About the library Chris@28: ----------------- Chris@28: Chris@28: Two C++ classes are provided for use by a host application: Chris@28: PluginCandidates and KnownPlugins. Chris@28: Chris@28: PluginCandidates knows how to invoke the checker program (if you Chris@28: provide the path to it) and will do so for a set of plugin paths of Chris@28: your request, returning success or failure reports to you. Chris@28: Chris@28: KnownPlugins knows about a limited set of plugin formats (currently Chris@28: Vamp, LADSPA, DSSI) and will use PluginCandidates to test all plugins Chris@28: found in those formats' standard installation directories. Chris@28: Chris@28: These are C++11 classes using the Qt toolkit. Chris@28: Chris@28: Chris@28: How to compile Chris@28: -------------- Chris@28: Chris@28: A Qt project (checker.pro) is provided, which compiles the program and Chris@28: library: Chris@28: Chris@28: $ qmake checker.pro Chris@28: $ make Chris@28: Chris@29: It also builds a program called checker-client which exercises the Chris@29: library by using a KnownPlugins object with the program it just Chris@29: compiled and printing out the results. Chris@29: Chris@28: To compile only the command-line program, you should be able to use a Chris@28: single C++ compiler invocation like: Chris@28: Chris@28: $ c++ -o vamp-plugin-load-checker src/helper.cpp -ldl Chris@28: Chris@28: I expect that most often the program and library will be compiled as Chris@28: part of a larger host application. (They were written for use with Chris@28: Sonic Visualiser.) Chris@28: Chris@28: Chris@28: Copyright and licence Chris@28: --------------------- Chris@28: Chris@28: Written by Chris Cannam at the Centre for Digital Music, Queen Mary Chris@28: University of London. Chris@28: Chris@28: Copyright (c) 2016-2017 Queen Mary, University of London. Chris@28: Chris@28: Permission is hereby granted, free of charge, to any person Chris@28: obtaining a copy of this software and associated documentation Chris@28: files (the "Software"), to deal in the Software without Chris@28: restriction, including without limitation the rights to use, copy, Chris@28: modify, merge, publish, distribute, sublicense, and/or sell copies Chris@28: of the Software, and to permit persons to whom the Software is Chris@28: furnished to do so, subject to the following conditions: Chris@28: Chris@28: The above copyright notice and this permission notice shall be Chris@28: included in all copies or substantial portions of the Software. Chris@28: Chris@28: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, Chris@28: EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF Chris@28: MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND Chris@28: NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY Chris@28: CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF Chris@28: CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION Chris@28: WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Chris@28: Chris@28: Except as contained in this notice, the names of the Centre for Chris@28: Digital Music and Queen Mary, University of London shall not be Chris@28: used in advertising or otherwise to promote the sale, use or other Chris@28: dealings in this Software without prior written authorization. Chris@28: