source: roaraudio/include/libroar/roardl.h @ 5427:543c052527b2

Last change on this file since 5427:543c052527b2 was 5427:543c052527b2, checked in by phi, 10 years ago

support usage of plugin path also outside plugin containers

File size: 15.0 KB
Line 
1//roardl.h:
2
3/*
4 *      Copyright (C) Philipp 'ph3-der-loewe' Schafft - 2010-2012
5 *
6 *  This file is part of libroar a part of RoarAudio,
7 *  a cross-platform sound system for both, home and professional use.
8 *  See README for details.
9 *
10 *  This file is free software; you can redistribute it and/or modify
11 *  it under the terms of the GNU General Public License version 3
12 *  as published by the Free Software Foundation.
13 *
14 *  libroar is distributed in the hope that it will be useful,
15 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
16 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 *  GNU General Public License for more details.
18 *
19 *  You should have received a copy of the GNU General Public License
20 *  along with this software; see the file COPYING.  If not, write to
21 *  the Free Software Foundation, 51 Franklin Street, Fifth Floor,
22 *  Boston, MA 02110-1301, USA.
23 *
24 *  NOTE for everyone want's to change something and send patches:
25 *  read README and HACKING! There a addition information on
26 *  the license of this document you need to read before you send
27 *  any patches.
28 *
29 *  NOTE for uses of non-GPL (LGPL,...) software using libesd, libartsc
30 *  or libpulse*:
31 *  The libs libroaresd, libroararts and libroarpulse link this lib
32 *  and are therefore GPL. Because of this it may be illigal to use
33 *  them with any software that uses libesd, libartsc or libpulse*.
34 */
35
36#ifndef _LIBROARROARDL_H_
37#define _LIBROARROARDL_H_
38
39#include "libroar.h"
40
41#define ROAR_DL_FLAG_DEFAULTS          -1
42#define ROAR_DL_FLAG_PLUGIN            -2
43#define ROAR_DL_FLAG_NONE               0x0000
44#define ROAR_DL_FLAG_STATIC             0x0001 /* plugins are linked statically -lfoo */
45#define ROAR_DL_FLAG_LAZY               0x0002
46#define ROAR_DL_FLAG_PLUGINPATH         0x0004 /* Use plugin search path */
47
48#define ROAR_DL_HANDLE_DEFAULT          ((struct roar_dl_lhandle*)(void*)0)
49#define ROAR_DL_HANDLE_NEXT             ((struct roar_dl_lhandle*)(void*)1)
50
51#define ROAR_DL_FN_DSTR                 0
52#define ROAR_DL_FN_CDRIVER              1
53#define ROAR_DL_FN_TRANSCODER           2
54#define ROAR_DL_FN_DRIVER               3
55#define ROAR_DL_FN_SOURCE               4
56#define ROAR_DL_FN_FILTER               5
57#define ROAR_DL_FN_FF                   6 /* file format */
58#define ROAR_DL_FN_AUTH                 7
59#define ROAR_DL_FN_BRIDGE               8
60#define ROAR_DL_FN_ROARDSCHED           9
61#define ROAR_DL_FN_APPSCHED            10
62#define ROAR_DL_FN_PROTO               11
63#define ROAR_DL_FN_NOTIFY              12
64#define ROAR_DL_FN_INIT                13 /* global plugin instance init. should be avoided */
65//#define ROAR_DL_FN_               9
66#define ROAR_DL_FN_MAX                 24
67
68#define ROAR_DL_LIBPARA_VERSION         1
69#define ROAR_DL_LIBNAME_VERSION         0
70#define ROAR_DL_LIBINST_VERSION         1
71#define ROAR_DL_LIBDEP_VERSION          0
72
73#define ROAR_DL_PLUGIN(lib) struct roar_dl_libraryinst *                                          \
74                             _##lib##_roaraudio_library_init(struct roar_dl_librarypara * para);  \
75                            struct roar_dl_libraryinst *                                          \
76                             _roaraudio_library_init(struct roar_dl_librarypara * para) {         \
77                              return _##lib##_roaraudio_library_init(para);                       \
78                            }                                                                     \
79                            struct roar_dl_libraryinst *                                          \
80                             _##lib##_roaraudio_library_init(struct roar_dl_librarypara * para)   \
81
82#define ROAR_DL_PLUGIN_START(xlib) ROAR_DL_PLUGIN(xlib) {                                         \
83                                     static int _inited = 0;                                      \
84                                     static struct roar_dl_libraryinst lib;                       \
85                                     static struct roar_dl_libraryname libname;                   \
86                                     (void)para;                                                  \
87                                     if ( _inited )                                               \
88                                      return &lib;                                                \
89                                     memset(&lib, 0, sizeof(lib));                                \
90                                     lib.version = ROAR_DL_LIBINST_VERSION;                       \
91                                     lib.len     = sizeof(lib);                                   \
92                                     memset(&libname, 0, sizeof(libname));                        \
93                                     libname.version = ROAR_DL_LIBNAME_VERSION;                   \
94                                     libname.len     = sizeof(libname);                           \
95                                     libname.name = #xlib;                                        \
96                                     lib.libname  = &libname;                                     \
97                                     do
98
99#define ROAR_DL_PLUGIN_END          while(0);                                                     \
100                                    _inited = 1;                                                  \
101                                    return &lib;                                                  \
102                                   }
103
104// general stuff:
105#define ROAR_DL_PLUGIN_ABORT_LOADING(err) roar_err_set((err)); return NULL
106#define ROAR_DL_PLUGIN_CHECK_VERSIONS(app,abi) ((lib.host_appname = (app))    != NULL || \
107                                                (lib.host_abiversion = (abi)) != NULL )
108// should we keep this macro at all? Is it helpfull at all?
109// if a plugin can handle multiple hosts it needs to call roar_dl_para_check_version() itself anyway.
110#define ROAR_DL_PLUGIN_CHECK_VERSIONS_NOW(app,abi) if ( roar_dl_para_check_version(para, (app), (abi)) == -1 ) return NULL
111
112// register stuff:
113#define ROAR_DL_PLUGIN_REG(fn, funcptr) (lib.func[(fn)] = (funcptr))
114#define ROAR_DL_PLUGIN_REG_UNLOAD(func) (lib.unload = (func))
115#define ROAR_DL_PLUGIN_REG_APPSCHED(sched) (lib.appsched = (sched))
116#define ROAR_DL_PLUGIN_REG_GLOBAL_DATA(ptr,init) lib.global_data_len = sizeof((init)); \
117                                                 lib.global_data_init = &(init);       \
118                                                 lib.global_data_pointer = (void*)&(ptr)
119#define ROAR_DL_PLUGIN_REG_LIBDEP(deps) (((lib.libdep = (deps)) == NULL) ? \
120                                           (ssize_t)-1 : \
121                                           (ssize_t)(lib.libdep_len = sizeof((deps))/sizeof(struct roar_dl_librarydep)))
122
123// meta data stuff:
124#define ROAR_DL_PLUGIN_META_PRODUCT(x)      (libname.libname     = (x))
125#define ROAR_DL_PLUGIN_META_PRODUCT_NV(name,vendor)      ROAR_DL_PLUGIN_META_PRODUCT(name " <" vendor ">")
126#define ROAR_DL_PLUGIN_META_PRODUCT_NIV_REAL(name,id,vendor)  ROAR_DL_PLUGIN_META_PRODUCT(name " <" #id "/" vendor ">")
127#define ROAR_DL_PLUGIN_META_PRODUCT_NIV(name,id,vendor)  ROAR_DL_PLUGIN_META_PRODUCT_NIV_REAL(name,id,vendor)
128#define ROAR_DL_PLUGIN_META_VERSION(x)      (libname.libversion  = (x))
129#define ROAR_DL_PLUGIN_META_ABI(x)          (libname.abiversion  = (x))
130#define ROAR_DL_PLUGIN_META_DESC(x)         (libname.description = (x))
131#define ROAR_DL_PLUGIN_META_CONTACT(x)      (libname.contact = (x))
132#define ROAR_DL_PLUGIN_META_CONTACT_FL(first,last)        ROAR_DL_PLUGIN_META_CONTACT(first " " last)
133#define ROAR_DL_PLUGIN_META_CONTACT_FLE(first,last,email) ROAR_DL_PLUGIN_META_CONTACT(first " " last " <" email ">")
134#define ROAR_DL_PLUGIN_META_CONTACT_FLNE(first,last,nick,email) ROAR_DL_PLUGIN_META_CONTACT(first " \"" nick "\" " last " <" email ">")
135#define ROAR_DL_PLUGIN_META_AUTHORS(x)      (libname.authors = (x))
136#define ROAR_DL_PLUGIN_META_LICENSE(x)      (libname.license = (x))
137#define ROAR_DL_PLUGIN_META_LICENSE_TAG(x)  ROAR_DL_PLUGIN_META_LICENSE(ROAR_LICENSE_ ## x)
138
139enum roar_dl_loadercmd {
140 ROAR_DL_LOADER_NOOP = 0,
141 ROAR_DL_LOADER_PRELOAD,
142 ROAR_DL_LOADER_LOAD,
143 ROAR_DL_LOADER_POSTLOAD,
144 ROAR_DL_LOADER_PREUNLOAD,
145 ROAR_DL_LOADER_UNLOAD,
146 ROAR_DL_LOADER_POSTUNLOAD
147};
148
149struct roar_plugincontainer;
150
151struct roar_dl_librarypara {
152 int version;               // version of this struct type (must be ROAR_DL_LIBPARA_VERSION)
153 size_t len;                // Length of this struct type (must be sizeof(struct roar_dl_librarypara)
154
155 size_t refc;               // Reference counter.
156
157 size_t argc;               // number of elements in argv
158 struct roar_keyval * argv; // Parameter for the plugin
159 void * args_store;         // Storage area for argv's data.
160                            // If not NULL this and argv will be freed.
161                            // If NULL argv will be left untouched.
162
163 void * binargv;            // A pointer with binary data arguments.
164                            // This can be used to pass any non-string data to
165                            // the plugin. Normally this is NULL or the pointer
166                            // to a struct with members of whatever is needed.
167
168 const char * appname;      // application name in common format:
169                            // Product/Version <VendorID/VendorName> (comments)
170                            // Version and comment are optional and should be avoided.
171                            // When no vendor ID is registered use <VendorName>.
172                            // The VendorName MUST NOT contain a slash and SHOULD
173                            // be as unique as possible.
174                            // Examples: roard <0/RoarAudio>, MyAPP <myapp.org>,
175                            //           AnAPP <Musterman GbR>
176 const char * abiversion;   // The ABI version. For libraries this should be the SONAME.
177                            // For applications this should be the version of the release
178                            // which introduced the current ABI.
179                            // Examples: libroar2, 0.5.1
180 struct roar_notify_core * notifycore;
181 struct roar_plugincontainer * container;
182 int (*loader)(struct roar_dl_librarypara * lhandle, void * loader_userdata, enum roar_dl_loadercmd cmd, void * argp);
183 void * loader_userdata;
184};
185
186struct roar_dl_libraryname {
187 int      version;
188 size_t   len;
189 const char * name;        //Format: shortname
190 const char * libname;     //This is the same as appname in struct roar_dl_librarypara.
191                           //Format: Product <VendorID/VendorName> (comments)
192 const char * libversion;  //This is the pure version number of the library.
193 const char * abiversion;  //This is the same as abiversion in struct roar_dl_librarypara.
194                           //Format: Version
195 const char * description; //Free form.
196 const char * contact;     //Format: first ["']nick["'] last (comment) <email>/OpenPGPkey/Phone/Room
197 const char * authors;     //Other authors as free form.
198 const char * license;     //Format: LicenseName-Version (options)
199                           //Examples: GPL-3.0, LGPL-2.1, LGPL-3.0 (or later).
200};
201
202struct roar_dl_librarydep {
203 int      version;
204 size_t   len;
205 uint32_t flags;
206 const char * name;
207 const char * libname;
208 const char * abiversion;
209};
210
211#define ROAR_DL_DEP(__flags,__name,__libname,__abiversion) \
212                                                   {.version    = ROAR_DL_LIBDEP_VERSION,            \
213                                                    .len        = sizeof(struct roar_dl_librarydep), \
214                                                    .flags      = __flags,                           \
215                                                    .name       = __name,                            \
216                                                    .libname    = __libname,                         \
217                                                    .abiversion = __abiversion}
218
219struct roar_dl_libraryinst {
220 int      version;
221 size_t   len;
222 int    (*unload)(struct roar_dl_librarypara * para, struct roar_dl_libraryinst * lib);
223 int    (*func[ROAR_DL_FN_MAX])(struct roar_dl_librarypara * para, struct roar_dl_libraryinst * lib);
224 struct roar_dl_libraryname * libname;
225 size_t  global_data_len;
226 void *  global_data_init;
227 void ** global_data_pointer;
228 struct roar_dl_librarydep * libdep;
229 size_t libdep_len;
230 struct roar_dl_appsched * appsched;
231 const char * host_appname;
232 const char * host_abiversion;
233};
234
235struct roar_dl_appsched {
236 int (*init)  (struct roar_dl_librarypara * para);
237 int (*free)  (struct roar_dl_librarypara * para);
238 int (*update)(struct roar_dl_librarypara * para);
239 int (*tick)  (struct roar_dl_librarypara * para);
240 int (*wait)  (struct roar_dl_librarypara * para);
241};
242
243enum roar_dl_appsched_trigger {
244 ROAR_DL_APPSCHED_INIT = 1,
245#define ROAR_DL_APPSCHED_INIT ROAR_DL_APPSCHED_INIT
246 ROAR_DL_APPSCHED_FREE,
247#define ROAR_DL_APPSCHED_FREE ROAR_DL_APPSCHED_FREE
248 ROAR_DL_APPSCHED_UPDATE,
249#define ROAR_DL_APPSCHED_UPDATE ROAR_DL_APPSCHED_UPDATE
250 ROAR_DL_APPSCHED_TICK,
251#define ROAR_DL_APPSCHED_TICK ROAR_DL_APPSCHED_TICK
252 ROAR_DL_APPSCHED_WAIT
253#define ROAR_DL_APPSCHED_WAIT ROAR_DL_APPSCHED_WAIT
254};
255
256// parameter functions:
257struct roar_dl_librarypara * roar_dl_para_new(const char * args, void * binargv,
258                                              const char * appname, const char * abiversion);
259int roar_dl_para_ref                    (struct roar_dl_librarypara * para);
260int roar_dl_para_unref                  (struct roar_dl_librarypara * para);
261int roar_dl_para_check_version          (struct roar_dl_librarypara * para,
262                                         const char * appname, const char * abiversion);
263
264// 'core' dynamic loader functions.
265struct roar_dl_lhandle * roar_dl_open   (const char * filename, int flags,
266                                         int ra_init, struct roar_dl_librarypara * para);
267int                      roar_dl_ref    (struct roar_dl_lhandle * lhandle);
268int                      roar_dl_unref  (struct roar_dl_lhandle * lhandle);
269#define roar_dl_close(x) roar_dl_unref((x))
270
271void                   * roar_dl_getsym (struct roar_dl_lhandle * lhandle, const char * sym, int type);
272
273int                      roar_dl_ra_init(struct roar_dl_lhandle * lhandle,
274                                         const char * prefix,
275                                         struct roar_dl_librarypara * para);
276
277const char *             roar_dl_errstr (struct roar_dl_lhandle * lhandle);
278
279// getting meta data:
280struct roar_dl_librarypara       * roar_dl_getpara(struct roar_dl_lhandle * lhandle);
281const struct roar_dl_libraryname * roar_dl_getlibname(struct roar_dl_lhandle * lhandle);
282
283// context switching:
284// _restore() is to switch from main to library context. _store() is to store library context
285// and switch back to main context.
286int                      roar_dl_context_restore(struct roar_dl_lhandle * lhandle);
287int                      roar_dl_context_store(struct roar_dl_lhandle * lhandle);
288
289// appsched:
290int                      roar_dl_appsched_trigger(struct roar_dl_lhandle * lhandle, enum roar_dl_appsched_trigger trigger);
291
292#endif
293
294//ll
Note: See TracBrowser for help on using the repository browser.