PipeWire: context.h Source File

PipeWire 0.3.37

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
29extern "C" {
30#endif
31
32#include <spa/utils/defs.h>
33#include <spa/utils/hook.h>
34
62struct pw_context;
63
64struct pw_global;
65struct pw_impl_client;
66
67#include <pipewire/core.h>
68#include <pipewire/loop.h>
69#include <pipewire/properties.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
89struct pw_context * pw_context_new(struct pw_loop *main_loop,
90 struct pw_properties *props,
91 size_t user_data_size );
92
94void pw_context_destroy(struct pw_context *context);
95
97void *pw_context_get_user_data(struct pw_context *context);
98
100void pw_context_add_listener(struct pw_context *context,
101 struct spa_hook *listener,
102 const struct pw_context_events *events,
103 void *data);
104
106const struct pw_properties *pw_context_get_properties(struct pw_context *context);
107
109int pw_context_update_properties(struct pw_context *context, const struct spa_dict *dict);
110
112const char *pw_context_get_conf_section(struct pw_context *context, const char *section);
113
115const struct spa_support *pw_context_get_support(struct pw_context *context, uint32_t *n_support);
116
118struct pw_loop *pw_context_get_main_loop(struct pw_context *context);
119
121struct pw_work_queue *pw_context_get_work_queue(struct pw_context *context);
122
127int pw_context_for_each_global(struct pw_context *context,
128 int (*callback) (void *data, struct pw_global *global),
129 void *data);
130
132struct pw_global *pw_context_find_global(struct pw_context *context,
133 uint32_t id );
134
136int pw_context_add_spa_lib(struct pw_context *context, const char *factory_regex, const char *lib);
137
139const char * pw_context_find_spa_lib(struct pw_context *context, const char *factory_name);
140
141struct spa_handle *pw_context_load_spa_handle(struct pw_context *context,
142 const char *factory_name,
143 const struct spa_dict *info);
144
145
147 struct pw_export_type {
148 struct spa_list link;
149 const char *type;
150 struct pw_proxy * (*func) (struct pw_core *core,
151 const char *type, const struct spa_dict *props, void *object,
152 size_t user_data_size);
153};
154
157int pw_context_register_export_type(struct pw_context *context, struct pw_export_type *type);
159const struct pw_export_type *pw_context_find_export_type(struct pw_context *context, const char *type);
160
162int pw_context_set_object(struct pw_context *context, const char *type, void *value);
164void *pw_context_get_object(struct pw_context *context, const char *type);
165
169#ifdef __cplusplus
170}
171#endif
172
173#endif /* PIPEWIRE_CONTEXT_H */
core.h
defs.h
pw_context_get_user_data
void * pw_context_get_user_data(struct pw_context *context)
Get the context user data.
Definition: context.c:596
pw_context_load_spa_handle
struct spa_handle * pw_context_load_spa_handle(struct pw_context *context, const char *factory_name, const struct spa_dict *info)
Definition: context.c:1400
pw_context_set_object
int pw_context_set_object(struct pw_context *context, const char *type, void *value)
add an object to the context
Definition: context.c:1468
pw_context_register_export_type
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:1430
pw_context_destroy
void pw_context_destroy(struct pw_context *context)
destroy a context object, all resources except the main_loop will be destroyed
Definition: context.c:515
pw_context_add_listener
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:602
pw_context_get_conf_section
const char * pw_context_get_conf_section(struct pw_context *context, const char *section)
Get a config section for this context.
Definition: context.c:638
pw_context_update_properties
int pw_context_update_properties(struct pw_context *context, const struct spa_dict *dict)
Update the context properties.
Definition: context.c:651
pw_context_get_object
void * pw_context_get_object(struct pw_context *context, const char *type)
get an object from the context
Definition: context.c:1490
pw_context_find_export_type
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:1442
pw_context_get_properties
const struct pw_properties * pw_context_get_properties(struct pw_context *context)
Get the context properties.
Definition: context.c:632
pw_context_find_spa_lib
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:1388
pw_context_for_each_global
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:670
pw_context_get_main_loop
struct pw_loop * pw_context_get_main_loop(struct pw_context *context)
get the context main loop
Definition: context.c:618
pw_context_new
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:296
pw_context_add_spa_lib
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:1363
pw_context_get_work_queue
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:624
pw_context_get_support
const struct spa_support * pw_context_get_support(struct pw_context *context, uint32_t *n_support)
Get the context support objects.
Definition: context.c:611
pw_context_find_global
struct pw_global * pw_context_find_global(struct pw_context *context, uint32_t id)
Find a context global by id.
Definition: context.c:687
hook.h
props
const char * props
Definition: media-session.c:2383
loop.h
properties.h
client
Definition: access-flatpak.c:67
data
user data to add to an object
Definition: media-session.c:110
link
Definition: media-session.c:183
pw_context_events
context events emitted by the context object added with pw_context_add_listener
Definition: context.h:72
pw_context_events::global_added
void(* global_added)(void *data, struct pw_global *global)
a new global object was added
Definition: context.h:83
pw_context_events::destroy
void(* destroy)(void *data)
The context is being destroyed.
Definition: context.h:77
pw_context_events::global_removed
void(* global_removed)(void *data, struct pw_global *global)
a global object was removed
Definition: context.h:85
pw_context_events::free
void(* free)(void *data)
The context is being freed.
Definition: context.h:79
pw_context_events::version
uint32_t version
Definition: context.h:74
pw_context_events::check_access
void(* check_access)(void *data, struct pw_impl_client *client)
a new client object is added
Definition: context.h:81
pw_export_type
data for registering export functions
Definition: context.h:147
pw_export_type::type
const char * type
Definition: context.h:149
pw_loop
Definition: pipewire/src/pipewire/loop.h:47
pw_properties
Definition: properties.h:49
pw_properties::dict
struct spa_dict dict
dictionary of key/values
Definition: properties.h:50
spa_dict
Definition: utils/dict.h:48
spa_handle
Definition: plugin.h:44
spa_hook
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:295
spa_list
Definition: list.h:37
spa_support
Extra supporting infrastructure passed to the init() function of a factory.
Definition: plugin.h:89