PipeWire: pipewire/data-loop.h Source File

PipeWire 1.2.3

Loading...
Searching...
No Matches
data-loop.h
Go to the documentation of this file.
1/* PipeWire */
2/* SPDX-FileCopyrightText: Copyright © 2018 Wim Taymans */
3/* SPDX-License-Identifier: MIT */
4
5#ifndef PIPEWIRE_DATA_LOOP_H
6#define PIPEWIRE_DATA_LOOP_H
7
8#ifdef __cplusplus
9extern "C" {
10#endif
11
12#include <spa/utils/hook.h>
13#include <spa/support/thread.h>
14
27struct pw_data_loop;
28
29#include <pipewire/loop.h>
30#include <pipewire/properties.h>
31
33struct pw_data_loop_events {
34#define PW_VERSION_DATA_LOOP_EVENTS 0
35 uint32_t version;
37 void (*destroy) (void *data);
38};
39
41 struct pw_data_loop *
42 pw_data_loop_new(const struct spa_dict *props);
43
45void pw_data_loop_add_listener(struct pw_data_loop *loop,
46 struct spa_hook *listener,
47 const struct pw_data_loop_events *events,
48 void *data);
49
52int pw_data_loop_wait(struct pw_data_loop *loop, int timeout);
53
55void pw_data_loop_exit(struct pw_data_loop *loop);
56
58struct pw_loop *
59 pw_data_loop_get_loop(struct pw_data_loop *loop);
60
62const char * pw_data_loop_get_name(struct pw_data_loop *loop);
64const char * pw_data_loop_get_class(struct pw_data_loop *loop);
65
67void pw_data_loop_destroy(struct pw_data_loop *loop);
68
70int pw_data_loop_start(struct pw_data_loop *loop);
71
73int pw_data_loop_stop(struct pw_data_loop *loop);
74
77bool pw_data_loop_in_thread(struct pw_data_loop *loop);
79struct spa_thread *pw_data_loop_get_thread(struct pw_data_loop *loop);
80
107int pw_data_loop_invoke(struct pw_data_loop *loop,
108 spa_invoke_func_t func, uint32_t seq, const void *data, size_t size,
109 bool block, void *user_data);
110
113void pw_data_loop_set_thread_utils(struct pw_data_loop *loop,
114 struct spa_thread_utils *impl);
119#ifdef __cplusplus
120}
121#endif
122
123#endif /* PIPEWIRE_DATA_LOOP_H */
pw_data_loop_get_class
const char * pw_data_loop_get_class(struct pw_data_loop *loop)
Get the loop class.
Definition data-loop.c:222
pw_data_loop_wait
int pw_data_loop_wait(struct pw_data_loop *loop, int timeout)
wait for activity on the loop up to timeout milliseconds.
Definition data-loop.c:21
pw_data_loop_start
int pw_data_loop_start(struct pw_data_loop *loop)
Start the processing thread.
Definition data-loop.c:235
pw_data_loop_get_thread
struct spa_thread * pw_data_loop_get_thread(struct pw_data_loop *loop)
Get the thread object.
Definition data-loop.c:314
pw_data_loop_set_thread_utils
void pw_data_loop_set_thread_utils(struct pw_data_loop *loop, struct spa_thread_utils *impl)
Set a custom spa_thread_utils for this loop.
Definition data-loop.c:335
pw_data_loop_stop
int pw_data_loop_stop(struct pw_data_loop *loop)
Stop the processing thread.
Definition data-loop.c:274
pw_data_loop_add_listener
void pw_data_loop_add_listener(struct pw_data_loop *loop, struct spa_hook *listener, const struct pw_data_loop_events *events, void *data)
Add an event listener to loop.
Definition data-loop.c:182
pw_data_loop_get_name
const char * pw_data_loop_get_name(struct pw_data_loop *loop)
Get the loop name.
Definition data-loop.c:207
pw_data_loop_get_loop
struct pw_loop * pw_data_loop_get_loop(struct pw_data_loop *loop)
Get the loop implementation of this data loop.
Definition data-loop.c:192
pw_data_loop_new
struct pw_data_loop * pw_data_loop_new(const struct spa_dict *props)
Make a new loop.
Definition data-loop.c:152
pw_data_loop_destroy
void pw_data_loop_destroy(struct pw_data_loop *loop)
Destroy the loop.
Definition data-loop.c:162
pw_data_loop_in_thread
bool pw_data_loop_in_thread(struct pw_data_loop *loop)
Check if the current thread is the processing thread.
Definition data-loop.c:302
pw_data_loop_invoke
int pw_data_loop_invoke(struct pw_data_loop *loop, spa_invoke_func_t func, uint32_t seq, const void *data, size_t size, bool block, void *user_data)
invoke func in the context of the thread or in the caller thread when the loop is not running.
Definition data-loop.c:320
pw_data_loop_exit
void pw_data_loop_exit(struct pw_data_loop *loop)
make sure the thread will exit.
Definition data-loop.c:40
spa_invoke_func_t
int(* spa_invoke_func_t)(struct spa_loop *loop, bool async, uint32_t seq, const void *data, size_t size, void *user_data)
Definition loop.h:66
hook.h
spa/utils/hook.h
properties.h
pipewire/properties.h
thread.h
spa/support/thread.h
loop.h
pipewire/loop.h
pw_data_loop_events
Loop events, use pw_data_loop_add_listener to add a listener.
Definition data-loop.h:38
pw_data_loop_events::version
uint32_t version
Definition data-loop.h:41
pw_data_loop_events::destroy
void(* destroy)(void *data)
The loop is destroyed.
Definition data-loop.h:43
pw_data_loop
pw_loop
Definition loop.h:33
pw_loop::loop
struct spa_loop * loop
wrapped loop
Definition loop.h:35
spa_dict
Definition dict.h:39
spa_hook
A hook, contains the structure with functions and the data passed to the functions.
Definition hook.h:350
spa_thread_utils
Definition thread.h:45
spa_thread