context.h
Go to the documentation of this file.
/* PipeWire
*
* Copyright © 2018 Wim Taymans
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice (including the next
* paragraph) shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*/
#ifndef PIPEWIRE_CONTEXT_H
#define PIPEWIRE_CONTEXT_H
#ifdef __cplusplus
extern "C" {
#endif
#include <spa/utils/defs.h>
#include <spa/utils/hook.h>
struct pw_context;
struct pw_global;
struct pw_impl_client;
#include <pipewire/core.h>
#include <pipewire/loop.h>
#include <pipewire/properties.h>
struct pw_context_events {
#define PW_VERSION_CONTEXT_EVENTS 0
uint32_t version;
void (*destroy) (void *data);
void (*free) (void *data);
void (*check_access) (void *data, struct pw_impl_client *client);
void (*global_added) (void *data, struct pw_global *global);
void (*global_removed) (void *data, struct pw_global *global);
};
struct pw_context * pw_context_new(struct pw_loop *main_loop,
struct pw_properties *props,
size_t user_data_size );
void pw_context_destroy(struct pw_context *context);
void *pw_context_get_user_data(struct pw_context *context);
void pw_context_add_listener(struct pw_context *context,
struct spa_hook *listener,
const struct pw_context_events *events,
void *data);
const struct pw_properties *pw_context_get_properties(struct pw_context *context);
int pw_context_update_properties(struct pw_context *context, const struct spa_dict *dict);
const char *pw_context_get_conf_section(struct pw_context *context, const char *section);
int pw_context_parse_conf_section(struct pw_context *context,
struct pw_properties *conf, const char *section);
int pw_context_conf_update_props(struct pw_context *context, const char *section,
struct pw_properties *props);
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);
int pw_context_conf_section_match_rules(struct pw_context *context, const char *section,
struct spa_dict *props,
int (*callback) (void *data, const char *location, const char *action,
const char *str, size_t len),
void *data);
const struct spa_support *pw_context_get_support(struct pw_context *context, uint32_t *n_support);
struct pw_loop *pw_context_get_main_loop(struct pw_context *context);
struct pw_work_queue *pw_context_get_work_queue(struct pw_context *context);
int pw_context_for_each_global(struct pw_context *context,
int (*callback) (void *data, struct pw_global *global),
void *data);
struct pw_global *pw_context_find_global(struct pw_context *context,
uint32_t id );
int pw_context_add_spa_lib(struct pw_context *context, const char *factory_regex, const char *lib);
const char * pw_context_find_spa_lib(struct pw_context *context, const char *factory_name);
struct spa_handle *pw_context_load_spa_handle(struct pw_context *context,
const char *factory_name,
const struct spa_dict *info);
struct pw_export_type {
struct spa_list link;
const char *type;
struct pw_proxy * (*func) (struct pw_core *core,
const char *type, const struct spa_dict *props, void *object,
size_t user_data_size);
};
int pw_context_register_export_type(struct pw_context *context, struct pw_export_type *type);
const struct pw_export_type *pw_context_find_export_type(struct pw_context *context, const char *type);
int pw_context_set_object(struct pw_context *context, const char *type, void *value);
void *pw_context_get_object(struct pw_context *context, const char *type);
#ifdef __cplusplus
}
#endif
#endif /* PIPEWIRE_CONTEXT_H */
core.h
pipewire/core.h
defs.h
spa/utils/defs.h
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:1441
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:1463
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:1403
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:434
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:521
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:568
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:530
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:604
pw_context_conf_section_for_each
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:831
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:206
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:555
pw_context_conf_update_props
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:895
pw_context_conf_section_match_rules
int pw_context_conf_section_match_rules(struct pw_context *context, const char *section, 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:1042
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:1415
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:1373
pw_context_get_user_data
void * pw_context_get_user_data(struct pw_context *context)
Get the context user data.
Definition: context.c:515
pw_context_get_properties
const struct pw_properties * pw_context_get_properties(struct pw_context *context)
Get the context properties.
Definition: context.c:549
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:587
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:1361
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:1336
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:537
pw_context_parse_conf_section
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:862
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:543
hook.h
spa/utils/hook.h
properties.h
pipewire/properties.h
loop.h
pipewire/loop.h
pw_context_events
context events emitted by the context object added with pw_context_add_listener
Definition: context.h:79
pw_context_events::global_added
void(* global_added)(void *data, struct pw_global *global)
a new global object was added
Definition: context.h:91
pw_context_events::destroy
void(* destroy)(void *data)
The context is being destroyed.
Definition: context.h:85
pw_context_events::global_removed
void(* global_removed)(void *data, struct pw_global *global)
a global object was removed
Definition: context.h:93
pw_context_events::free
void(* free)(void *data)
The context is being freed.
Definition: context.h:87
pw_context_events::version
uint32_t version
Definition: context.h:82
pw_context_events::check_access
void(* check_access)(void *data, struct pw_impl_client *client)
a new client object is added
Definition: context.h:89
pw_context
pw_core
pw_export_type
data for registering export functions
Definition: context.h:174
pw_export_type::type
const char * type
Definition: context.h:176
pw_export_type::link
struct spa_list link
Definition: context.h:175
pw_global
Definition: context.h:67
pw_impl_client
pw_loop
Definition: loop.h:51
pw_properties
Definition: properties.h:53
pw_properties::dict
struct spa_dict dict
dictionary of key/values
Definition: properties.h:54
pw_proxy
pw_work_queue
spa_dict
Definition: dict.h:59
spa_handle
Definition: plugin.h:50
spa_hook
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:342
spa_list
Definition: list.h:47
spa_support
Extra supporting infrastructure passed to the init() function of a factory.
Definition: plugin.h:96