src/plugins/InstrumentEditorFactory.cpp

/***************************************************************************
 *                                                                         *
 *   Copyright (C) 2007 Christian Schoenebeck                              *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the Free Software           *
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,                 *
 *   MA  02111-1307  USA                                                   *
 ***************************************************************************/

#include "InstrumentEditorFactory.h"

#include "../common/global_private.h"

#if defined(WIN32)
#include <windows.h>
#else
#include <dlfcn.h>
#include <errno.h>
#include <dirent.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
#endif
#include <string.h>

#ifndef CONFIG_PLUGIN_DIR
# error "Configuration macro CONFIG_PLUGIN_DIR not defined!"
#endif // CONFIG_PLUGIN_DIR

#if defined(WIN32)
typedef void* (*InnerFactoryRegisterFunction)(void);
#endif

namespace LinuxSampler {

    std::map<String, InstrumentEditorFactory::InnerFactory*> InstrumentEditorFactory::InnerFactories;

    bool InstrumentEditorFactory::bPluginsLoaded = false;

    std::list<void*> InstrumentEditorFactory::LoadedDLLs;

    std::vector<String> InstrumentEditorFactory::AvailableEditors() {
        // make sure plugins were loaded already
        LoadPlugins();
        // render result
        std::vector<String> result;
        std::map<String, InnerFactory*>::iterator iter = InnerFactories.begin();
        for (; iter != InnerFactories.end(); iter++)
            result.push_back(iter->first);
        return result;
    }

    std::vector<String> InstrumentEditorFactory::MatchingEditors(String sTypeName, String sTypeVersion) {
        // make sure plugins were loaded already
        LoadPlugins();
        // render result
        std::vector<String> result;
        std::map<String, InnerFactory*>::iterator iter = InnerFactories.begin();
        for (; iter != InnerFactories.end(); iter++) {
            InstrumentEditor* pEditor = iter->second->Create();
            if (pEditor->IsTypeSupported(sTypeName, sTypeVersion))
                result.push_back(iter->first);
            iter->second->Destroy(pEditor);
        }
        return result;
    }

    String InstrumentEditorFactory::AvailableEditorsAsString() {
        std::vector<String> drivers = AvailableEditors();
        String result;
        std::vector<String>::iterator iter = drivers.begin();
        for (; iter != drivers.end(); iter++) {
            if (result != "") result += ",";
            result += "'" + *iter + "'";
        }
        return result;
    }

    InstrumentEditor* InstrumentEditorFactory::Create(String InstrumentEditorName) throw (Exception) {
        if (InnerFactories.count(InstrumentEditorName)) {
            InnerFactory* pInnerFactory = InnerFactories[InstrumentEditorName];
            return pInnerFactory->Create();
        } else throw Exception("unknown instrument editor");
    }

    void InstrumentEditorFactory::Destroy(InstrumentEditor* pInstrumentEditor) throw (Exception) {
        if (InnerFactories.count(pInstrumentEditor->Name())) {
            InnerFactory* pInnerFactory = InnerFactories[pInstrumentEditor->Name()];
            return pInnerFactory->Destroy(pInstrumentEditor);
        } else throw Exception("unknown instrument editor");
    }

    void InstrumentEditorFactory::LoadPlugins() {
        if (!bPluginsLoaded) {
            dmsg(1,("Loading instrument editor plugins..."));
            #if defined(WIN32)
            WIN32_FIND_DATA win32FindData;
            const String plugindir = (String)CONFIG_PLUGIN_DIR + (String)("\\*.DLL");
            HANDLE hDir = FindFirstFile(plugindir.c_str(), &win32FindData);
            if (hDir == INVALID_HANDLE_VALUE) {
                if (GetLastError() != ERROR_FILE_NOT_FOUND) {
                    std::cerr << "Could not open instrument editor plugins "
                              << "directory (" << CONFIG_PLUGIN_DIR << "), "
                              << "Error: " << GetLastError() << std::endl;
                } else {
                    dmsg(1,("None"));
                }
                // either dir doesn't exist or is empty
                return;
            }

            do {
                // skip directory entries
                if (win32FindData.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)
                    continue;
                // dir entry name as full qualified path
                const String sPath = (String)CONFIG_PLUGIN_DIR + ((String)"\\" + (String)win32FindData.cFileName);
                // load the DLL
                HINSTANCE hinstLib;
                void* pDLL = hinstLib = LoadLibrary(sPath.c_str());
                if (!pDLL) {
                    std::cerr << "Failed to load instrument editor plugin: "
                              << sPath << std::endl;
                    continue;
                }

                //(InnerFactory*) (*fn)(void);
                InnerFactoryRegisterFunction fn =
                    (InnerFactoryRegisterFunction)
                        GetProcAddress(
                            hinstLib,
                            "createInstrumentEditorInnerFactory"
                        );
                if (fn == NULL) {
                    std::cerr << "ERROR: unable to find "
                                 "createInstrumentEditorInnerFactory() "
                                 "in DLL\n" << std::flush;
                    FreeLibrary(hinstLib);
                    continue;
                }

                // get the plugin instance and register it to the factory

                InnerFactory* pInnerFactory = (InnerFactory*)fn();
                if (!pInnerFactory) {
                    std::cerr << "ERROR: !pInnerFactory\n" << std::flush;
                    FreeLibrary(hinstLib);
                    continue;
                }
                InstrumentEditor* pEditor = pInnerFactory->Create();
                if (InnerFactories.count(pEditor->Name())) {
                    std::cerr << "ERROR: a plugin with name '"
                              << pEditor->Name()
                              << "' already loaded (skipping)\n"
                              << std::flush;
                    pInnerFactory->Destroy(pEditor);
                    FreeLibrary(hinstLib);
                    continue;
                }
                InnerFactories[pEditor->Name()] = pInnerFactory;
                pInnerFactory->Destroy(pEditor);

                LoadedDLLs.push_back(pDLL);
            } while (FindNextFile(hDir, &win32FindData));
            if (hDir != INVALID_HANDLE_VALUE) FindClose(hDir);
            #else // POSIX
            DIR* hDir = opendir(CONFIG_PLUGIN_DIR);
            if (!hDir) {
                std::cerr << "Could not open instrument editor plugins directory "
                          << "(" << CONFIG_PLUGIN_DIR << "): "
                          << strerror(errno) << std::endl;
                return;
            }
            for (dirent* pEntry = readdir(hDir); pEntry; pEntry = readdir(hDir)) {
                // dir entry name as full qualified path
                const String sPath = CONFIG_PLUGIN_DIR + ("/" + String(pEntry->d_name));
                // skip entries that are not regular files
                struct stat entry_stat;
                if (lstat(sPath.c_str(), &entry_stat) != 0 ||
                   (entry_stat.st_mode & S_IFMT) != S_IFREG)
                   continue;
                // skip files that are not .so files
                if (sPath.length() < 3 ||
                    sPath.substr(sPath.length() - 3) != ".so" &&
                    sPath.find(".so.") == String::npos
                ) continue;
                // load the DLL (the plugins should register themselfes automatically)
                void* pDLL = dlopen(sPath.c_str(), RTLD_NOW);
                if (pDLL) LoadedDLLs.push_back(pDLL);
                else {
                    std::cerr << "Failed to load instrument editor plugin: "
                              << sPath << std::endl;
                }
            }
            closedir(hDir);
            #endif
            bPluginsLoaded = true;
            dmsg(1,("OK\n"));
        }
    }

    void InstrumentEditorFactory::ClosePlugins() {
        if (LoadedDLLs.size()) {
            dmsg(1,("Unloading instrument editor plugins..."));
            // free all inner factories
            {
                std::map<String, InnerFactory*>::iterator iter = InnerFactories.begin();
                for (; iter != InnerFactories.end(); iter++) delete iter->second;
                InnerFactories.clear();
            }
            // free the DLLs
            {
                std::list<void*>::iterator iter = LoadedDLLs.begin();
                for (; iter != LoadedDLLs.end(); iter++) {
                    #if defined(WIN32)
                    FreeLibrary((HINSTANCE)*iter);
                    #else
                    dlclose(*iter);
                    #endif
                }
                LoadedDLLs.clear();
                dmsg(1,("OK\n"));
            }
        }
        bPluginsLoaded = false;
    }

} // namespace LinuxSampler
1	schoenebeck	1374	/***************************************************************************
2			* *
3			* Copyright (C) 2007 Christian Schoenebeck *
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., 59 Temple Place, Suite 330, Boston, *
18			* MA 02111-1307 USA *
19			***************************************************************************/
20
21			#include "InstrumentEditorFactory.h"
22
23	schoenebeck	1425	#include "../common/global_private.h"
24
25	senoner	1478	#if defined(WIN32)
26			#include <windows.h>
27			#else
28	schoenebeck	1374	#include <dlfcn.h>
29			#include <errno.h>
30	senoner	1478	#include <dirent.h>
31	schoenebeck	1601	#include <sys/types.h>
32			#include <sys/stat.h>
33			#include <unistd.h>
34	senoner	1478	#endif
35	schoenebeck	1374	#include <string.h>
36
37			#ifndef CONFIG_PLUGIN_DIR
38			# error "Configuration macro CONFIG_PLUGIN_DIR not defined!"
39			#endif // CONFIG_PLUGIN_DIR
40
41	senoner	1481	#if defined(WIN32)
42			typedef void* (*InnerFactoryRegisterFunction)(void);
43			#endif
44
45	schoenebeck	1374	namespace LinuxSampler {
46
47			std::map<String, InstrumentEditorFactory::InnerFactory*> InstrumentEditorFactory::InnerFactories;
48
49			bool InstrumentEditorFactory::bPluginsLoaded = false;
50
51			std::list<void*> InstrumentEditorFactory::LoadedDLLs;
52
53			std::vector<String> InstrumentEditorFactory::AvailableEditors() {
54			// make sure plugins were loaded already
55			LoadPlugins();
56			// render result
57			std::vector<String> result;
58			std::map<String, InnerFactory*>::iterator iter = InnerFactories.begin();
59			for (; iter != InnerFactories.end(); iter++)
60			result.push_back(iter->first);
61			return result;
62			}
63
64			std::vector<String> InstrumentEditorFactory::MatchingEditors(String sTypeName, String sTypeVersion) {
65			// make sure plugins were loaded already
66			LoadPlugins();
67			// render result
68			std::vector<String> result;
69			std::map<String, InnerFactory*>::iterator iter = InnerFactories.begin();
70			for (; iter != InnerFactories.end(); iter++) {
71			InstrumentEditor* pEditor = iter->second->Create();
72			if (pEditor->IsTypeSupported(sTypeName, sTypeVersion))
73			result.push_back(iter->first);
74			iter->second->Destroy(pEditor);
75			}
76			return result;
77			}
78
79			String InstrumentEditorFactory::AvailableEditorsAsString() {
80			std::vector<String> drivers = AvailableEditors();
81			String result;
82			std::vector<String>::iterator iter = drivers.begin();
83			for (; iter != drivers.end(); iter++) {
84			if (result != "") result += ",";
85			result += "'" + *iter + "'";
86			}
87			return result;
88			}
89
90			InstrumentEditor* InstrumentEditorFactory::Create(String InstrumentEditorName) throw (Exception) {
91			if (InnerFactories.count(InstrumentEditorName)) {
92			InnerFactory* pInnerFactory = InnerFactories[InstrumentEditorName];
93			return pInnerFactory->Create();
94			} else throw Exception("unknown instrument editor");
95			}
96
97			void InstrumentEditorFactory::Destroy(InstrumentEditor* pInstrumentEditor) throw (Exception) {
98			if (InnerFactories.count(pInstrumentEditor->Name())) {
99			InnerFactory* pInnerFactory = InnerFactories[pInstrumentEditor->Name()];
100			return pInnerFactory->Destroy(pInstrumentEditor);
101			} else throw Exception("unknown instrument editor");
102			}
103
104			void InstrumentEditorFactory::LoadPlugins() {
105			if (!bPluginsLoaded) {
106			dmsg(1,("Loading instrument editor plugins..."));
107	senoner	1478	#if defined(WIN32)
108			WIN32_FIND_DATA win32FindData;
109	schoenebeck	1602	const String plugindir = (String)CONFIG_PLUGIN_DIR + (String)("\\*.DLL");
110	senoner	1478	HANDLE hDir = FindFirstFile(plugindir.c_str(), &win32FindData);
111			if (hDir == INVALID_HANDLE_VALUE) {
112	schoenebeck	1602	if (GetLastError() != ERROR_FILE_NOT_FOUND) {
113			std::cerr << "Could not open instrument editor plugins "
114			<< "directory (" << CONFIG_PLUGIN_DIR << "), "
115			<< "Error: " << GetLastError() << std::endl;
116			} else {
117			dmsg(1,("None"));
118	senoner	1478	}
119	schoenebeck	1602	// either dir doesn't exist or is empty
120			return;
121	senoner	1478	}
122
123	schoenebeck	1602	do {
124			// skip directory entries
125			if (win32FindData.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)
126			continue;
127			// dir entry name as full qualified path
128			const String sPath = (String)CONFIG_PLUGIN_DIR + ((String)"\\" + (String)win32FindData.cFileName);
129			// load the DLL
130			HINSTANCE hinstLib;
131			void* pDLL = hinstLib = LoadLibrary(sPath.c_str());
132			if (!pDLL) {
133			std::cerr << "Failed to load instrument editor plugin: "
134			<< sPath << std::endl;
135			continue;
136			}
137
138			//(InnerFactory) (fn)(void);
139			InnerFactoryRegisterFunction fn =
140			(InnerFactoryRegisterFunction)
141	senoner	1481	GetProcAddress(
142			hinstLib,
143			"createInstrumentEditorInnerFactory"
144			);
145	schoenebeck	1602	if (fn == NULL) {
146			std::cerr << "ERROR: unable to find "
147			"createInstrumentEditorInnerFactory() "
148			"in DLL\n" << std::flush;
149			FreeLibrary(hinstLib);
150			continue;
151			}
152
153			// get the plugin instance and register it to the factory
154
155			InnerFactory* pInnerFactory = (InnerFactory*)fn();
156			if (!pInnerFactory) {
157			std::cerr << "ERROR: !pInnerFactory\n" << std::flush;
158			FreeLibrary(hinstLib);
159			continue;
160			}
161			InstrumentEditor* pEditor = pInnerFactory->Create();
162			if (InnerFactories.count(pEditor->Name())) {
163			std::cerr << "ERROR: a plugin with name '"
164			<< pEditor->Name()
165			<< "' already loaded (skipping)\n"
166			<< std::flush;
167	senoner	1481	pInnerFactory->Destroy(pEditor);
168	schoenebeck	1602	FreeLibrary(hinstLib);
169			continue;
170	senoner	1478	}
171	schoenebeck	1602	InnerFactories[pEditor->Name()] = pInnerFactory;
172			pInnerFactory->Destroy(pEditor);
173
174			LoadedDLLs.push_back(pDLL);
175			} while (FindNextFile(hDir, &win32FindData));
176			if (hDir != INVALID_HANDLE_VALUE) FindClose(hDir);
177	senoner	1478	#else // POSIX
178	schoenebeck	1374	DIR* hDir = opendir(CONFIG_PLUGIN_DIR);
179			if (!hDir) {
180			std::cerr << "Could not open instrument editor plugins directory "
181			<< "(" << CONFIG_PLUGIN_DIR << "): "
182			<< strerror(errno) << std::endl;
183			return;
184			}
185			for (dirent* pEntry = readdir(hDir); pEntry; pEntry = readdir(hDir)) {
186	schoenebeck	1601	// dir entry name as full qualified path
187			const String sPath = CONFIG_PLUGIN_DIR + ("/" + String(pEntry->d_name));
188	schoenebeck	1374	// skip entries that are not regular files
189	schoenebeck	1601	struct stat entry_stat;
190			if (lstat(sPath.c_str(), &entry_stat) != 0 \|\|
191			(entry_stat.st_mode & S_IFMT) != S_IFREG)
192			continue;
193	schoenebeck	1374	// skip files that are not .so files
194	schoenebeck	1601	if (sPath.length() < 3 \|\|
195	schoenebeck	1374	sPath.substr(sPath.length() - 3) != ".so" &&
196			sPath.find(".so.") == String::npos
197			) continue;
198			// load the DLL (the plugins should register themselfes automatically)
199			void* pDLL = dlopen(sPath.c_str(), RTLD_NOW);
200			if (pDLL) LoadedDLLs.push_back(pDLL);
201			else {
202			std::cerr << "Failed to load instrument editor plugin: "
203			<< sPath << std::endl;
204			}
205			}
206			closedir(hDir);
207	senoner	1478	#endif
208	schoenebeck	1374	bPluginsLoaded = true;
209			dmsg(1,("OK\n"));
210			}
211			}
212
213			void InstrumentEditorFactory::ClosePlugins() {
214			if (LoadedDLLs.size()) {
215			dmsg(1,("Unloading instrument editor plugins..."));
216			// free all inner factories
217			{
218			std::map<String, InnerFactory*>::iterator iter = InnerFactories.begin();
219			for (; iter != InnerFactories.end(); iter++) delete iter->second;
220			InnerFactories.clear();
221			}
222			// free the DLLs
223			{
224			std::list<void*>::iterator iter = LoadedDLLs.begin();
225	senoner	1478	for (; iter != LoadedDLLs.end(); iter++) {
226			#if defined(WIN32)
227			FreeLibrary((HINSTANCE)*iter);
228			#else
229			dlclose(*iter);
230			#endif
231			}
232	schoenebeck	1374	LoadedDLLs.clear();
233			dmsg(1,("OK\n"));
234			}
235			}
236			bPluginsLoaded = false;
237			}
238
239			} // namespace LinuxSampler