1 | //plugincontainer.h: |
---|
2 | |
---|
3 | /* |
---|
4 | * Copyright (C) Philipp 'ph3-der-loewe' Schafft - 2008-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 _LIBROARPLUGINCONTAINER_H_ |
---|
37 | #define _LIBROARPLUGINCONTAINER_H_ |
---|
38 | |
---|
39 | #include "libroar.h" |
---|
40 | |
---|
41 | struct roar_plugincontainer; |
---|
42 | |
---|
43 | /* Create a new plugin container. |
---|
44 | * Takes a default parameter set. |
---|
45 | */ |
---|
46 | struct roar_plugincontainer * roar_plugincontainer_new(struct roar_dl_librarypara * default_para); |
---|
47 | |
---|
48 | /* Create a new plugin container. |
---|
49 | * Takes host application's appname and abiversion. |
---|
50 | */ |
---|
51 | struct roar_plugincontainer * roar_plugincontainer_new_simple(const char * appname, const char * abiversion); |
---|
52 | |
---|
53 | // Increment the refrence counter. |
---|
54 | int roar_plugincontainer_ref(struct roar_plugincontainer * cont); |
---|
55 | /* Decrement the refrence counter. |
---|
56 | * Unloads all plugins and frees all resources when there are no refreneces left. |
---|
57 | */ |
---|
58 | int roar_plugincontainer_unref(struct roar_plugincontainer * cont); |
---|
59 | |
---|
60 | /* |
---|
61 | * stuff we still need: |
---|
62 | * object creation, get plugin handle. |
---|
63 | */ |
---|
64 | |
---|
65 | // plugin loading and unloading: |
---|
66 | |
---|
67 | // Load a plugin by name. |
---|
68 | int roar_plugincontainer_load (struct roar_plugincontainer * cont, |
---|
69 | const char * name, |
---|
70 | struct roar_dl_librarypara * para); |
---|
71 | |
---|
72 | /* Load a plugin by name with extra options. |
---|
73 | * This is for advanced applications only. |
---|
74 | * NOTE: Using this handle after the plugin has been unloaded from the |
---|
75 | * container results in undefind behavior. |
---|
76 | */ |
---|
77 | struct roar_dl_lhandle * roar_plugincontainer_load_lhandle (struct roar_plugincontainer * cont, |
---|
78 | const char * name, |
---|
79 | int flags, |
---|
80 | int ra_init, |
---|
81 | struct roar_dl_librarypara * para); |
---|
82 | /* Unload a plugin by name. |
---|
83 | * NOTE: The name here is from the plugin and may not match the name you load |
---|
84 | * the plugin with. |
---|
85 | */ |
---|
86 | int roar_plugincontainer_unload (struct roar_plugincontainer * cont, |
---|
87 | const char * name); |
---|
88 | /* Load a plugin by roardl handle. |
---|
89 | * This is for advanced applications only. |
---|
90 | */ |
---|
91 | int roar_plugincontainer_unload_lhandle (struct roar_plugincontainer * cont, |
---|
92 | struct roar_dl_lhandle * lhandle); |
---|
93 | /* Post ra_init plugins not yet inited. |
---|
94 | * NOTE: This uses the default para, |
---|
95 | * not the one given with roar_plugincontainer_load_lhandle(). |
---|
96 | * This is for advanced applications only. |
---|
97 | */ |
---|
98 | int roar_plugincontainer_ra_init (struct roar_plugincontainer * cont); |
---|
99 | |
---|
100 | // appsched: |
---|
101 | // Trigger an application schedule event on all plugins. |
---|
102 | int roar_plugincontainer_appsched_trigger(struct roar_plugincontainer * cont, enum roar_dl_appsched_trigger trigger); |
---|
103 | |
---|
104 | #endif |
---|
105 | |
---|
106 | //ll |
---|