PipeWire  0.3.59
context.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_CONTEXT_H
26 #define PIPEWIRE_CONTEXT_H
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
32 #include <spa/utils/defs.h>
33 #include <spa/utils/hook.h>
34 
62 struct pw_context;
63 
64 struct pw_global;
65 struct pw_impl_client;
66 
67 #include <pipewire/core.h>
68 #include <pipewire/loop.h>
70 
72 struct pw_context_events {
73 #define PW_VERSION_CONTEXT_EVENTS 0
74  uint32_t version;
75 
77  void (*destroy) (void *data);
79  void (*free) (void *data);
81  void (*check_access) (void *data, struct pw_impl_client *client);
83  void (*global_added) (void *data, struct pw_global *global);
85  void (*global_removed) (void *data, struct pw_global *global);
86 };
87 
89 struct pw_context * pw_context_new(struct pw_loop *main_loop,
90  struct pw_properties *props,
91  size_t user_data_size );
92 
94 void pw_context_destroy(struct pw_context *context);
95 
97 void *pw_context_get_user_data(struct pw_context *context);
98 
100 void pw_context_add_listener(struct pw_context *context,
101  struct spa_hook *listener,
102  const struct pw_context_events *events,
103  void *data);
104 
106 const struct pw_properties *pw_context_get_properties(struct pw_context *context);
107 
109 int pw_context_update_properties(struct pw_context *context, const struct spa_dict *dict);
110 
113 const char *pw_context_get_conf_section(struct pw_context *context, const char *section);
115 int pw_context_parse_conf_section(struct pw_context *context,
116  struct pw_properties *conf, const char *section);
117 
119 int pw_context_conf_update_props(struct pw_context *context, const char *section,
120  struct pw_properties *props);
122 int pw_context_conf_section_for_each(struct pw_context *context, const char *section,
123  int (*callback) (void *data, const char *location, const char *section,
124  const char *str, size_t len),
125  void *data);
127 int pw_context_conf_section_match_rules(struct pw_context *context, const char *section,
128  const struct spa_dict *props,
129  int (*callback) (void *data, const char *location, const char *action,
130  const char *str, size_t len),
131  void *data);
132 
134 const struct spa_support *pw_context_get_support(struct pw_context *context, uint32_t *n_support);
135 
137 struct pw_loop *pw_context_get_main_loop(struct pw_context *context);
138 
140 struct pw_data_loop *pw_context_get_data_loop(struct pw_context *context);
141 
143 struct pw_work_queue *pw_context_get_work_queue(struct pw_context *context);
144 
149 int pw_context_for_each_global(struct pw_context *context,
150  int (*callback) (void *data, struct pw_global *global),
151  void *data);
152 
154 struct pw_global *pw_context_find_global(struct pw_context *context,
155  uint32_t id );
156 
158 int pw_context_add_spa_lib(struct pw_context *context, const char *factory_regex, const char *lib);
159 
161 const char * pw_context_find_spa_lib(struct pw_context *context, const char *factory_name);
162 
163 struct spa_handle *pw_context_load_spa_handle(struct pw_context *context,
164  const char *factory_name,
165  const struct spa_dict *info);
166 
167 
169 struct pw_export_type {
170  struct spa_list link;
171  const char *type;
172  struct pw_proxy * (*func) (struct pw_core *core,
173  const char *type, const struct spa_dict *props, void *object,
174  size_t user_data_size);
175 };
176 
179 int pw_context_register_export_type(struct pw_context *context, struct pw_export_type *type);
181 const struct pw_export_type *pw_context_find_export_type(struct pw_context *context, const char *type);
182 
184 int pw_context_set_object(struct pw_context *context, const char *type, void *value);
186 void *pw_context_get_object(struct pw_context *context, const char *type);
187 
191 #ifdef __cplusplus
192 }
193 #endif
194 
195 #endif /* PIPEWIRE_CONTEXT_H */
pipewire/core.h
spa/utils/defs.h
struct pw_data_loop * pw_context_get_data_loop(struct pw_context *context)
get the context data loop.
Definition: context.c:511
int pw_context_set_object(struct pw_context *context, const char *type, void *value)
add an object to the context
Definition: context.c:1395
void * pw_context_get_object(struct pw_context *context, const char *type)
get an object from the context
Definition: context.c:1423
int pw_context_register_export_type(struct pw_context *context, struct pw_export_type *type)
register a type that can be exported on a context_proxy.
Definition: context.c:1357
void pw_context_destroy(struct pw_context *context)
destroy a context object, all resources except the main_loop will be destroyed
Definition: context.c:399
void pw_context_add_listener(struct pw_context *context, struct spa_hook *listener, const struct pw_context_events *events, void *data)
Add a new event listener to a context.
Definition: context.c:489
int pw_context_update_properties(struct pw_context *context, const struct spa_dict *dict)
Update the context properties.
Definition: context.c:542
const struct spa_support * pw_context_get_support(struct pw_context *context, uint32_t *n_support)
Get the context support objects.
Definition: context.c:498
struct pw_global * pw_context_find_global(struct pw_context *context, uint32_t id)
Find a context global by id.
Definition: context.c:578
int pw_context_conf_section_for_each(struct pw_context *context, const char *section, int(*callback)(void *data, const char *location, const char *section, const char *str, size_t len), void *data)
emit callback for all config sections.
Definition: conf.c:865
struct pw_context * pw_context_new(struct pw_loop *main_loop, struct pw_properties *props, size_t user_data_size)
Make a new context object for a given main_loop.
Definition: context.c:188
const char * pw_context_get_conf_section(struct pw_context *context, const char *section)
Get a config section for this context.
Definition: context.c:529
int pw_context_conf_section_match_rules(struct pw_context *context, const char *section, const struct spa_dict *props, int(*callback)(void *data, const char *location, const char *action, const char *str, size_t len), void *data)
emit callback for all matched properties.
Definition: conf.c:1153
int pw_context_conf_update_props(struct pw_context *context, const char *section, struct pw_properties *props)
update properties from a section into props.
Definition: conf.c:998
const struct pw_export_type * pw_context_find_export_type(struct pw_context *context, const char *type)
find information about registered export type
Definition: context.c:1369
struct spa_handle * pw_context_load_spa_handle(struct pw_context *context, const char *factory_name, const struct spa_dict *info)
Definition: context.c:1327
void * pw_context_get_user_data(struct pw_context *context)
Get the context user data.
Definition: context.c:483
const struct pw_properties * pw_context_get_properties(struct pw_context *context)
Get the context properties.
Definition: context.c:523
int pw_context_for_each_global(struct pw_context *context, int(*callback)(void *data, struct pw_global *global), void *data)
Iterate the globals of the context.
Definition: context.c:561
const char * pw_context_find_spa_lib(struct pw_context *context, const char *factory_name)
find the library name for a spa factory
Definition: context.c:1315
int pw_context_add_spa_lib(struct pw_context *context, const char *factory_regex, const char *lib)
add a spa library for the given factory_name regex
Definition: context.c:1290
struct pw_loop * pw_context_get_main_loop(struct pw_context *context)
get the context main loop
Definition: context.c:505
int pw_context_parse_conf_section(struct pw_context *context, struct pw_properties *conf, const char *section)
Parse a standard config section for this context.
Definition: conf.c:896
struct pw_work_queue * pw_context_get_work_queue(struct pw_context *context)
Get the work queue from the context: Since 0.3.26.
Definition: context.c:517
spa/utils/hook.h
pipewire/properties.h
pipewire/loop.h
context events emitted by the context object added with pw_context_add_listener
Definition: context.h:79
void(* global_added)(void *data, struct pw_global *global)
a new global object was added
Definition: context.h:91
void(* destroy)(void *data)
The context is being destroyed.
Definition: context.h:85
void(* global_removed)(void *data, struct pw_global *global)
a global object was removed
Definition: context.h:93
void(* free)(void *data)
The context is being freed.
Definition: context.h:87
uint32_t version
Definition: context.h:82
void(* check_access)(void *data, struct pw_impl_client *client)
a new client object is added
Definition: context.h:89
data for registering export functions
Definition: context.h:177
const char * type
Definition: context.h:179
struct spa_list link
Definition: context.h:178
Definition: context.h:67
Definition: loop.h:51
Definition: properties.h:53
struct spa_dict dict
dictionary of key/values
Definition: properties.h:54
Definition: dict.h:59
Definition: plugin.h:50
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:351
Definition: list.h:47
Extra supporting infrastructure passed to the init() function of a factory.
Definition: plugin.h:96