PipeWire  0.3.59
module.h
Go to the documentation of this file.
1 /* PipeWire
2  *
3  * Copyright © 2018 Wim Taymans
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a
6  * copy of this software and associated documentation files (the "Software"),
7  * to deal in the Software without restriction, including without limitation
8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9  * and/or sell copies of the Software, and to permit persons to whom the
10  * Software is furnished to do so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice (including the next
13  * paragraph) shall be included in all copies or substantial portions of the
14  * Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22  * DEALINGS IN THE SOFTWARE.
23  */
24 
25 #ifndef PIPEWIRE_MODULE_H
26 #define PIPEWIRE_MODULE_H
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
32 #include <spa/utils/defs.h>
33 #include <spa/utils/hook.h>
34 
35 #include <pipewire/proxy.h>
36 
45 #define PW_TYPE_INTERFACE_Module PW_TYPE_INFO_INTERFACE_BASE "Module"
46 
47 #define PW_VERSION_MODULE 3
48 struct pw_module;
49 
51 struct pw_module_info {
52  uint32_t id;
53  const char *name;
54  const char *filename;
55  const char *args;
56 #define PW_MODULE_CHANGE_MASK_PROPS (1 << 0)
57 #define PW_MODULE_CHANGE_MASK_ALL ((1 << 1)-1)
58  uint64_t change_mask;
59  struct spa_dict *props;
60 };
61 
63 struct pw_module_info *
65  const struct pw_module_info *update);
69  const struct pw_module_info *update, bool reset);
71 void pw_module_info_free(struct pw_module_info *info);
72 
73 #define PW_MODULE_EVENT_INFO 0
74 #define PW_MODULE_EVENT_NUM 1
75 
77 struct pw_module_events {
78 #define PW_VERSION_MODULE_EVENTS 0
79  uint32_t version;
85  void (*info) (void *data, const struct pw_module_info *info);
86 };
87 
88 #define PW_MODULE_METHOD_ADD_LISTENER 0
89 #define PW_MODULE_METHOD_NUM 1
90 
92 struct pw_module_methods {
93 #define PW_VERSION_MODULE_METHODS 0
94  uint32_t version;
95 
96  int (*add_listener) (void *object,
97  struct spa_hook *listener,
98  const struct pw_module_events *events,
99  void *data);
100 };
101 
102 #define pw_module_method(o,method,version,...) \
103 ({ \
104  int _res = -ENOTSUP; \
105  spa_interface_call_res((struct spa_interface*)o, \
106  struct pw_module_methods, _res, \
107  method, version, ##__VA_ARGS__); \
108  _res; \
109 })
110 
111 #define pw_module_add_listener(c,...) pw_module_method(c,add_listener,0,__VA_ARGS__)
112 
117 #ifdef __cplusplus
118 } /* extern "C" */
119 #endif
120 
121 #endif /* PIPEWIRE_MODULE_H */
spa/utils/defs.h
void pw_module_info_free(struct pw_module_info *info)
Free a pw_module_info.
Definition: introspect.c:409
struct pw_module_info * pw_module_info_merge(struct pw_module_info *info, const struct pw_module_info *update, bool reset)
Merge and existing pw_module_info with update.
Definition: introspect.c:373
struct pw_module_info * pw_module_info_update(struct pw_module_info *info, const struct pw_module_info *update)
Update and existing pw_module_info with update with reset.
Definition: introspect.c:402
spa/utils/hook.h
pipewire/proxy.h
Module events.
Definition: module.h:88
uint32_t version
Definition: module.h:91
void(* info)(void *data, const struct pw_module_info *info)
Notify module info.
Definition: module.h:97
The module information.
Definition: module.h:58
uint32_t id
id of the global
Definition: module.h:59
const char * filename
filename of the module
Definition: module.h:61
const char * args
arguments passed to the module
Definition: module.h:62
uint64_t change_mask
bitfield of changed fields since last call
Definition: module.h:67
Module methods.
Definition: module.h:106
uint32_t version
Definition: module.h:109
int(* add_listener)(void *object, struct spa_hook *listener, const struct pw_module_events *events, void *data)
Definition: module.h:111
Definition: dict.h:59
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:351