PipeWire  0.3.29
data-loop.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_DATA_LOOP_H
26 #define PIPEWIRE_DATA_LOOP_H
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
32 #include <spa/utils/hook.h>
33 
44 struct pw_data_loop;
45 
46 #include <pipewire/loop.h>
47 #include <pipewire/properties.h>
48 
51 #define PW_VERSION_DATA_LOOP_EVENTS 0
52  uint32_t version;
54  void (*destroy) (void *data);
55 };
56 
58 struct pw_data_loop *
59 pw_data_loop_new(const struct spa_dict *props);
60 
62 void pw_data_loop_add_listener(struct pw_data_loop *loop,
63  struct spa_hook *listener,
64  const struct pw_data_loop_events *events,
65  void *data);
66 
69 int pw_data_loop_wait(struct pw_data_loop *loop, int timeout);
70 
72 void pw_data_loop_exit(struct pw_data_loop *loop);
73 
75 struct pw_loop *
76 pw_data_loop_get_loop(struct pw_data_loop *loop);
77 
79 void pw_data_loop_destroy(struct pw_data_loop *loop);
80 
82 int pw_data_loop_start(struct pw_data_loop *loop);
83 
85 int pw_data_loop_stop(struct pw_data_loop *loop);
86 
88 bool pw_data_loop_in_thread(struct pw_data_loop *loop);
89 
92 int pw_data_loop_invoke(struct pw_data_loop *loop,
93  spa_invoke_func_t func, uint32_t seq, const void *data, size_t size,
94  bool block, void *user_data);
95 
100 #ifdef __cplusplus
101 }
102 #endif
103 
104 #endif /* PIPEWIRE_DATA_LOOP_H */
bool pw_data_loop_in_thread(struct pw_data_loop *loop)
Check if the current thread is the processing thread.
Definition: data-loop.c:251
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:257
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:76
int pw_data_loop_start(struct pw_data_loop *loop)
Start the processing thread.
Definition: data-loop.c:203
Definition: src/pipewire/loop.h:47
uint32_t version
Definition: data-loop.h:52
struct spa_loop * loop
wrapped loop
Definition: src/pipewire/loop.h:49
static uint32_t int seq
Definition: core.h:328
void(* destroy)(void *data)
The loop is destroyed.
Definition: data-loop.h:54
Definition: utils/dict.h:48
struct pw_data_loop * pw_data_loop_new(const struct spa_dict *props)
Make a new loop.
Definition: data-loop.c:152
int(* spa_invoke_func_t)(struct spa_loop *loop, bool async, uint32_t seq, const void *data, size_t size, void *user_data)
Definition: x86_64-redhat-linux-gnu/doc/spa/support/loop.h:67
Loop events, use pw_data_loop_add_listener to add a listener.
Definition: data-loop.h:50
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:36
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:190
void pw_data_loop_exit(struct pw_data_loop *loop)
make sure the thread will exit.
Definition: data-loop.c:55
int pw_data_loop_stop(struct pw_data_loop *loop)
Stop the processing thread.
Definition: data-loop.c:226
void pw_data_loop_destroy(struct pw_data_loop *loop)
Destroy the loop.
Definition: data-loop.c:162
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:181
Definition: filter.c:75
enum spa_log_level level const char int const char * func
Definition: log-impl.h:43