[3297] | 1 | //roardl.h: |
---|
| 2 | |
---|
| 3 | /* |
---|
[4708] | 4 | * Copyright (C) Philipp 'ph3-der-loewe' Schafft - 2010-2011 |
---|
[3297] | 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 |
---|
[3517] | 21 | * the Free Software Foundation, 51 Franklin Street, Fifth Floor, |
---|
| 22 | * Boston, MA 02110-1301, USA. |
---|
[3297] | 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 | |
---|
[3303] | 41 | #define ROAR_DL_FLAG_DEFAUTS -1 |
---|
| 42 | |
---|
[3297] | 43 | #define ROAR_DL_HANDLE_DEFAULT ((struct roar_dl_lhandle*)(void*)0) |
---|
| 44 | #define ROAR_DL_HANDLE_NEXT ((struct roar_dl_lhandle*)(void*)1) |
---|
| 45 | |
---|
[3299] | 46 | #define ROAR_DL_FN_DSTR 0 |
---|
| 47 | #define ROAR_DL_FN_CDRIVER 1 |
---|
| 48 | #define ROAR_DL_FN_TRANSCODER 2 |
---|
| 49 | #define ROAR_DL_FN_DRIVER 3 |
---|
| 50 | #define ROAR_DL_FN_SOURCE 4 |
---|
| 51 | #define ROAR_DL_FN_FILTER 5 |
---|
| 52 | #define ROAR_DL_FN_FF 6 /* file format */ |
---|
| 53 | #define ROAR_DL_FN_AUTH 7 |
---|
| 54 | #define ROAR_DL_FN_BRIDGE 8 |
---|
| 55 | #define ROAR_DL_FN_ROARDSCHED 9 |
---|
| 56 | #define ROAR_DL_FN_APPSCHED 10 |
---|
[3360] | 57 | #define ROAR_DL_FN_PROTO 11 |
---|
[3299] | 58 | //#define ROAR_DL_FN_ 9 |
---|
[5275] | 59 | #define ROAR_DL_FN_MAX 24 |
---|
[3300] | 60 | |
---|
[5275] | 61 | #define ROAR_DL_LIBPARA_VERSION 1 |
---|
| 62 | #define ROAR_DL_LIBNAME_VERSION 0 |
---|
| 63 | #define ROAR_DL_LIBINST_VERSION 1 |
---|
[3300] | 64 | |
---|
| 65 | #define ROAR_DL_PLUGIN(lib) struct roar_dl_libraryinst * \ |
---|
[3306] | 66 | _##lib##_roaraudio_library_init(struct roar_dl_librarypara * para); \ |
---|
| 67 | struct roar_dl_libraryinst * \ |
---|
[3300] | 68 | _roaraudio_library_init(struct roar_dl_librarypara * para) { \ |
---|
| 69 | return _##lib##_roaraudio_library_init(para); \ |
---|
| 70 | } \ |
---|
| 71 | struct roar_dl_libraryinst * \ |
---|
| 72 | _##lib##_roaraudio_library_init(struct roar_dl_librarypara * para) \ |
---|
[3299] | 73 | |
---|
[3308] | 74 | #define ROAR_DL_PLUGIN_START(xlib) ROAR_DL_PLUGIN(xlib) { \ |
---|
| 75 | static int _inited = 0; \ |
---|
| 76 | static struct roar_dl_libraryinst lib; \ |
---|
[5275] | 77 | static struct roar_dl_libraryname libname; \ |
---|
[4681] | 78 | (void)para; \ |
---|
[3308] | 79 | if ( _inited ) \ |
---|
| 80 | return &lib; \ |
---|
| 81 | memset(&lib, 0, sizeof(lib)); \ |
---|
| 82 | lib.version = ROAR_DL_LIBINST_VERSION; \ |
---|
| 83 | lib.len = sizeof(lib); \ |
---|
[5275] | 84 | memset(&libname, 0, sizeof(libname)); \ |
---|
| 85 | libname.version = ROAR_DL_LIBNAME_VERSION; \ |
---|
| 86 | libname.len = sizeof(libname); \ |
---|
| 87 | libname.name = #xlib; \ |
---|
| 88 | lib.libname = &libname; \ |
---|
[3308] | 89 | do |
---|
| 90 | |
---|
| 91 | #define ROAR_DL_PLUGIN_END while(0); \ |
---|
| 92 | _inited = 1; \ |
---|
| 93 | return &lib; \ |
---|
| 94 | } |
---|
| 95 | |
---|
[5275] | 96 | #define ROAR_DL_PLUGIN_ABORT_LOADING(err) roar_err_set((err)); return NULL |
---|
| 97 | #define ROAR_DL_PLUGIN_CHECK_VERSIONS(app,abi) if ( roar_dl_para_check_version(para, (app), (abi)) == -1 ) return NULL |
---|
[3363] | 98 | #define ROAR_DL_PLUGIN_REG(fn, funcptr) (lib.func[(fn)] = (funcptr)) |
---|
[3360] | 99 | #define ROAR_DL_PLUGIN_REG_UNLOAD(func) (lib.unload = (func)) |
---|
[3314] | 100 | |
---|
[3297] | 101 | struct roar_dl_librarypara { |
---|
[5275] | 102 | int version; // version of this struct type (must be ROAR_DL_LIBPARA_VERSION) |
---|
| 103 | size_t len; // Length of this struct type (must be sizeof(struct roar_dl_librarypara) |
---|
| 104 | |
---|
| 105 | size_t refc; // Reference counter. |
---|
| 106 | |
---|
| 107 | size_t argc; // number of elements in argv |
---|
| 108 | struct roar_keyval * argv; // Parameter for the plugin |
---|
| 109 | void * args_store; // Storage area for argv's data. |
---|
| 110 | // If not NULL this and argv will be freed. |
---|
| 111 | // If NULL argv will be left untouched. |
---|
| 112 | |
---|
| 113 | void * binargv; // A pointer with binary data arguments. |
---|
| 114 | // This can be used to pass any non-string data to |
---|
| 115 | // the plugin. Normally this is NULL or the pointer |
---|
| 116 | // to a struct with members of whatever is needed. |
---|
| 117 | |
---|
| 118 | const char * appname; // application name in common format: |
---|
| 119 | // Product/Version <VendorID/VendorName> (comments) |
---|
| 120 | // Version and comment are optional and should be avoided. |
---|
| 121 | // When no vendor ID is registered use <VendorName>. |
---|
| 122 | // The VendorName MUST NOT contain a slash and SHOULD |
---|
| 123 | // be as unique as possible. |
---|
| 124 | // Examples: roard <0/RoarAudio>, MyAPP <myapp.org>, |
---|
| 125 | // AnAPP <Musterman GbR> |
---|
| 126 | const char * abiversion; // The ABI version. For libraries this should be the SONAME. |
---|
| 127 | // For applications this should be the version of the release |
---|
| 128 | // which introduced the current ABI. |
---|
| 129 | // Examples: libroar2, 0.5.1 |
---|
| 130 | }; |
---|
| 131 | |
---|
| 132 | struct roar_dl_libraryname { |
---|
| 133 | int version; |
---|
| 134 | size_t len; |
---|
| 135 | const char * name; //Format: shortname |
---|
| 136 | const char * libversion; //Format: Product/Version <VendorID/VendorName> (comments) |
---|
| 137 | const char * description; //Free form. |
---|
| 138 | const char * contact; //Format: first ["']nick["'] last (comment) <email>/OpenPGPkey/Phone/Room |
---|
| 139 | const char * authors; //Other authors as free form. |
---|
| 140 | const char * license; //Format: LicenseName-Version (options) |
---|
| 141 | //Examples: GPL-3.0, LGPL-2.1, LGPL-3.0 (or later). |
---|
[3297] | 142 | }; |
---|
| 143 | |
---|
| 144 | struct roar_dl_libraryinst { |
---|
[3299] | 145 | int version; |
---|
| 146 | size_t len; |
---|
[3301] | 147 | int (*unload)(struct roar_dl_librarypara * para, struct roar_dl_libraryinst * lib); |
---|
[3299] | 148 | int (*func[ROAR_DL_FN_MAX])(struct roar_dl_librarypara * para, struct roar_dl_libraryinst * lib); |
---|
[5275] | 149 | struct roar_dl_libraryname * libname; |
---|
[5312] | 150 | size_t global_data_len; |
---|
| 151 | void * global_data_init; |
---|
| 152 | void ** global_data_pointer; |
---|
[3297] | 153 | }; |
---|
| 154 | |
---|
[5312] | 155 | // parameter functions: |
---|
[5275] | 156 | struct roar_dl_librarypara * roar_dl_para_new(const char * args, void * binargv, |
---|
| 157 | const char * appname, const char * abiversion); |
---|
| 158 | int roar_dl_para_ref (struct roar_dl_librarypara * para); |
---|
| 159 | int roar_dl_para_unref (struct roar_dl_librarypara * para); |
---|
| 160 | int roar_dl_para_check_version (struct roar_dl_librarypara * para, |
---|
| 161 | const char * appname, const char * abiversion); |
---|
| 162 | |
---|
[5312] | 163 | // 'core' dynamic loader functions. |
---|
[5275] | 164 | struct roar_dl_lhandle * roar_dl_open (const char * filename, int flags, |
---|
| 165 | int ra_init, struct roar_dl_librarypara * para); |
---|
| 166 | int roar_dl_close (struct roar_dl_lhandle * lhandle); |
---|
[3301] | 167 | |
---|
[5275] | 168 | void * roar_dl_getsym (struct roar_dl_lhandle * lhandle, const char * sym, int type); |
---|
[3297] | 169 | |
---|
[5275] | 170 | int roar_dl_ra_init(struct roar_dl_lhandle * lhandle, |
---|
| 171 | const char * prefix, |
---|
| 172 | struct roar_dl_librarypara * para); |
---|
[3297] | 173 | |
---|
[5275] | 174 | const char * roar_dl_errstr (struct roar_dl_lhandle * lhandle); |
---|
[3297] | 175 | |
---|
[5312] | 176 | // getting meta data: |
---|
[5275] | 177 | struct roar_dl_librarypara * roar_dl_getpara(struct roar_dl_lhandle * lhandle); |
---|
| 178 | const struct roar_dl_libraryname * roar_dl_getlibname(struct roar_dl_lhandle * lhandle); |
---|
[3364] | 179 | |
---|
[5312] | 180 | // context switching: |
---|
| 181 | // _restore() is to switch from main to library context. _store() is to store library context |
---|
| 182 | // and switch back to main context. |
---|
| 183 | int roar_dl_context_restore(struct roar_dl_lhandle * lhandle); |
---|
| 184 | int roar_dl_context_store(struct roar_dl_lhandle * lhandle); |
---|
| 185 | |
---|
[3297] | 186 | #endif |
---|
| 187 | |
---|
| 188 | //ll |
---|