PipeWire  0.3.33
impl-module.h
Go to the documentation of this file.
1 /* PipeWire
2  * Copyright © 2016 Axis Communications <dev-gstreamer@axis.com>
3  * @author Linus Svensson <linus.svensson@axis.com>
4  * Copyright © 2018 Wim Taymans
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a
7  * copy of this software and associated documentation files (the "Software"),
8  * to deal in the Software without restriction, including without limitation
9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10  * and/or sell copies of the Software, and to permit persons to whom the
11  * Software is furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice (including the next
14  * paragraph) shall be included in all copies or substantial portions of the
15  * Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
22  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
23  * DEALINGS IN THE SOFTWARE.
24  */
25 
26 #ifndef PIPEWIRE_IMPL_MODULE_H
27 #define PIPEWIRE_IMPL_MODULE_H
28 
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32 
33 #include <spa/utils/hook.h>
34 
35 #include <pipewire/context.h>
36 
37 #define PIPEWIRE_SYMBOL_MODULE_INIT "pipewire__module_init"
38 #define PIPEWIRE_MODULE_PREFIX "libpipewire-"
39 
49 struct pw_impl_module;
50 
60 typedef int (*pw_impl_module_init_func_t) (struct pw_impl_module *module, const char *args);
61 
64 #define PW_VERSION_IMPL_MODULE_EVENTS 0
65  uint32_t version;
66 
68  void (*destroy) (void *data);
70  void (*free) (void *data);
72  void (*initialized) (void *data);
73 
76  void (*registered) (void *data);
77 };
78 
79 struct pw_impl_module *
80 pw_context_load_module(struct pw_context *context,
81  const char *name,
82  const char *args,
83  struct pw_properties *properties);
84 
86 struct pw_context * pw_impl_module_get_context(struct pw_impl_module *module);
87 
89 struct pw_global * pw_impl_module_get_global(struct pw_impl_module *module);
90 
92 const struct pw_properties *pw_impl_module_get_properties(struct pw_impl_module *module);
93 
95 int pw_impl_module_update_properties(struct pw_impl_module *module, const struct spa_dict *dict);
96 
98 const struct pw_module_info *pw_impl_module_get_info(struct pw_impl_module *module);
99 
101 void pw_impl_module_add_listener(struct pw_impl_module *module,
102  struct spa_hook *listener,
103  const struct pw_impl_module_events *events,
104  void *data);
105 
107 void pw_impl_module_destroy(struct pw_impl_module *module);
108 
113 #ifdef __cplusplus
114 }
115 #endif
116 
117 #endif /* PIPEWIRE_IMPL_MODULE_H */
PW_VERSION_MODULE
#define PW_VERSION_MODULE
Definition: module.h:39
pw_impl_module_events::registered
void(* registered)(void *data)
The module is registered.
Definition: impl-module.h:76
pw_properties_update
int pw_properties_update(struct pw_properties *props, const struct spa_dict *dict)
Update properties.
Definition: properties.c:298
PW_KEY_OBJECT_ID
#define PW_KEY_OBJECT_ID
a global object id
Definition: src/pipewire/keys.h:66
pw_global_register
int pw_global_register(struct pw_global *global)
Register a global object to the context registry.
Definition: global.c:125
name
const char * name
Definition: media-session.c:2379
string.h
pw_impl_module_events::free
void(* free)(void *data)
The module is freed.
Definition: impl-module.h:70
data
user data to add to an object
Definition: filter.c:75
pw_context_load_module
struct pw_impl_module * pw_context_load_module(struct pw_context *context, const char *name, const char *args, struct pw_properties *properties)
Load a module.
Definition: impl-module.c:158
pw_global_new
struct pw_global * pw_global_new(struct pw_context *context, const char *type, uint32_t version, struct pw_properties *properties, pw_global_bind_func_t func, void *object)
Create a new global object.
Definition: global.c:66
pw_global_add_resource
int pw_global_add_resource(struct pw_global *global, struct pw_resource *resource)
Add a resource to a global.
Definition: global.c:230
spa_streq
bool spa_streq(const char *s1, const char *s2)
Definition: string.h:50
spa_list_for_each
#define spa_list_for_each(pos, head, member)
Definition: list.h:111
pw_impl_module_add_listener
void pw_impl_module_add_listener(struct pw_impl_module *module, struct spa_hook *listener, const struct pw_impl_module_events *events, void *data)
Add an event listener to a module.
Definition: impl-module.c:371
pw_impl_module_events
Module events added with pw_impl_module_add_listener.
Definition: impl-module.h:63
PW_TYPE_INTERFACE_Module
#define PW_TYPE_INTERFACE_Module
Definition: module.h:37
spa_aprintf
#define spa_aprintf(_fmt,...)
Definition: defs.h:323
SPA_EXPORT
#define SPA_EXPORT
Definition: defs.h:208
pw_impl_module_events::initialized
void(* initialized)(void *data)
The module is initialized.
Definition: impl-module.h:72
pw_global_events
Global events, use pw_global_add_listener.
Definition: global.h:68
pw_impl_module_events::destroy
void(* destroy)(void *data)
The module is destroyed.
Definition: impl-module.h:68
impl
Definition: control.c:33
spa_hook_list_append
void spa_hook_list_append(struct spa_hook_list *list, struct spa_hook *hook, const void *funcs, void *data)
Append a hook.
Definition: hook.h:316
pw_context_load_module
struct pw_impl_module * pw_context_load_module(struct pw_context *context, const char *name, const char *args, struct pw_properties *properties)
Load a module.
Definition: impl-module.c:158
pw_impl_module_add_listener
void pw_impl_module_add_listener(struct pw_impl_module *module, struct spa_hook *listener, const struct pw_impl_module_events *events, void *data)
Add an event listener to a module.
Definition: impl-module.c:371
impl::info
struct spa_audio_info_raw info
Definition: module-echo-cancel.c:145
impl.h
pw_properties::dict
struct spa_dict dict
dictionary of key/values
Definition: properties.h:50
SPA_CONTAINER_OF
#define SPA_CONTAINER_OF(p, t, m)
Definition: defs.h:170
pw_impl_module_destroy
void pw_impl_module_destroy(struct pw_impl_module *module)
Destroy a module.
Definition: impl-module.c:293
pw_impl_module_init_func_t
int(* pw_impl_module_init_func_t)(struct pw_impl_module *module, const char *args)
Module init function signature.
Definition: impl-module.h:60
spa_list_prepend
#define spa_list_prepend(list, item)
Definition: list.h:84
pw_global_add_listener
void pw_global_add_listener(struct pw_global *global, struct spa_hook *listener, const struct pw_global_events *events, void *data)
Add an event listener on the global.
Definition: global.c:255
spa_list_remove
void spa_list_remove(struct spa_list *elem)
Definition: list.h:69
impl::module
struct pw_impl_module * module
Definition: module-echo-cancel.c:135
spa_hook
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:295
pw_impl_module_get_global
struct pw_global * pw_impl_module_get_global(struct pw_impl_module *module)
Get the global of a module.
Definition: impl-module.c:329
spa_dict
Definition: utils/dict.h:48
pw_module_info
The module information.
Definition: module.h:43
spa_strerror
#define spa_strerror(err)
Definition: result.h:51
pw_resource_new
struct pw_resource * pw_resource_new(struct pw_impl_client *client, uint32_t id, uint32_t permissions, const char *type, uint32_t version, size_t user_data_size)
Make a new resource for client.
Definition: resource.c:43
pw_impl_module_get_info
const struct pw_module_info * pw_impl_module_get_info(struct pw_impl_module *module)
Get the module info.
Definition: impl-module.c:365
pw_impl_module_destroy
void pw_impl_module_destroy(struct pw_impl_module *module)
Destroy a module.
Definition: impl-module.c:293
pw_log_debug
#define pw_log_debug(...)
Definition: src/pipewire/log.h:89
pw_in_valgrind
bool pw_in_valgrind(void)
Definition: pipewire.c:687
client
Definition: module-protocol-native.c:103
PW_MODULE_CHANGE_MASK_PROPS
#define PW_MODULE_CHANGE_MASK_PROPS
Definition: module.h:48
pw_global_destroy
void pw_global_destroy(struct pw_global *global)
Destroy a global.
Definition: global.c:369
PW_VERSION_GLOBAL_EVENTS
#define PW_VERSION_GLOBAL_EVENTS
Definition: global.h:69
impl::context
struct pw_context * context
Definition: settings.c:43
pw_properties_set
int pw_properties_set(struct pw_properties *properties, const char *key, const char *value)
Set a property value.
Definition: properties.c:435
pw_impl_module_get_properties
const struct pw_properties * pw_impl_module_get_properties(struct pw_impl_module *module)
Get the node properties.
Definition: impl-module.c:335
pw_log_warn
#define pw_log_warn(...)
Definition: src/pipewire/log.h:87
PW_MODULE_CHANGE_MASK_ALL
#define PW_MODULE_CHANGE_MASK_ALL
Definition: module.h:49
impl::properties
struct pw_properties * properties
Definition: module-access.c:141
pw_impl_module_get_info
const struct pw_module_info * pw_impl_module_get_info(struct pw_impl_module *module)
Get the module info.
Definition: impl-module.c:365
context.h
impl::this
struct pw_control this
Definition: control.c:34
spa_hook_remove
void spa_hook_remove(struct spa_hook *hook)
Remove a hook.
Definition: hook.h:336
pw_impl_module_get_global
struct pw_global * pw_impl_module_get_global(struct pw_impl_module *module)
Get the global of a module.
Definition: impl-module.c:329
pw_impl_module_events::version
uint32_t version
Definition: impl-module.h:65
pw_impl_module_get_properties
const struct pw_properties * pw_impl_module_get_properties(struct pw_impl_module *module)
Get the node properties.
Definition: impl-module.c:335
spa_hook_list_init
void spa_hook_list_init(struct spa_hook_list *list)
Initialize a hook list to the empty list.
Definition: hook.h:305
NAME
#define NAME
Definition: impl-module.c:39
pw_properties_new
struct pw_properties * pw_properties_new(const char *key,...) 1
Make a new properties object.
Definition: properties.c:98
pw_properties_setf
int pw_properties_setf(struct pw_properties *properties, const char *key, const char *format,...) 1(3
pw_impl_module_get_context
struct pw_context * pw_impl_module_get_context(struct pw_impl_module *module)
Get the context of a module.
Definition: impl-module.c:323
hook.h
pw_impl_module_update_properties
int pw_impl_module_update_properties(struct pw_impl_module *module, const struct spa_dict *dict)
Update the module properties.
Definition: impl-module.c:341
pw_impl_module_get_context
struct pw_context * pw_impl_module_get_context(struct pw_impl_module *module)
Get the context of a module.
Definition: impl-module.c:323
pw_properties
Definition: properties.h:49
spa_hook_list_clean
void spa_hook_list_clean(struct spa_hook_list *list)
Remove all hooks from the list.
Definition: hook.h:344
pw_properties_free
void pw_properties_free(struct pw_properties *properties)
Free a properties object.
Definition: properties.c:364
PIPEWIRE_SYMBOL_MODULE_INIT
#define PIPEWIRE_SYMBOL_MODULE_INIT
Definition: impl-module.h:37
pw_log_error
#define pw_log_error(...)
Definition: src/pipewire/log.h:86
pw_impl_module_update_properties
int pw_impl_module_update_properties(struct pw_impl_module *module, const struct spa_dict *dict)
Update the module properties.
Definition: impl-module.c:341
PW_KEY_MODULE_NAME
#define PW_KEY_MODULE_NAME
the name of the module
Definition: src/pipewire/keys.h:250