data-loop.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_DATA_LOOP_H
#define PIPEWIRE_DATA_LOOP_H
#ifdef __cplusplus
extern "C" {
#endif
#include <spa/utils/hook.h>
struct pw_data_loop;
#include <pipewire/loop.h>
#include <pipewire/properties.h>
struct pw_data_loop_events {
#define PW_VERSION_DATA_LOOP_EVENTS 0
uint32_t version;
void (*destroy) (void *data);
};
struct pw_data_loop *
pw_data_loop_new(const struct spa_dict *props);
void pw_data_loop_add_listener(struct pw_data_loop *loop,
struct spa_hook *listener,
const struct pw_data_loop_events *events,
void *data);
int pw_data_loop_wait(struct pw_data_loop *loop, int timeout);
void pw_data_loop_exit(struct pw_data_loop *loop);
struct pw_loop *
pw_data_loop_get_loop(struct pw_data_loop *loop);
void pw_data_loop_destroy(struct pw_data_loop *loop);
int pw_data_loop_start(struct pw_data_loop *loop);
int pw_data_loop_stop(struct pw_data_loop *loop);
bool pw_data_loop_in_thread(struct pw_data_loop *loop);
struct spa_thread *pw_data_loop_get_thread(struct pw_data_loop *loop);
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);
#ifdef __cplusplus
}
#endif
#endif /* PIPEWIRE_DATA_LOOP_H */
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:38
pw_data_loop_start
int pw_data_loop_start(struct pw_data_loop *loop)
Start the processing thread.
Definition: data-loop.c:197
pw_data_loop_stop
int pw_data_loop_stop(struct pw_data_loop *loop)
Stop the processing thread.
Definition: data-loop.c:222
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:174
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:259
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:184
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:147
pw_data_loop_destroy
void pw_data_loop_destroy(struct pw_data_loop *loop)
Destroy the loop.
Definition: data-loop.c:157
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:247
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:265
pw_data_loop_exit
void pw_data_loop_exit(struct pw_data_loop *loop)
make sure the thread will exit.
Definition: data-loop.c:57
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:86
hook.h
spa/utils/hook.h
properties.h
pipewire/properties.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:57
pw_data_loop_events::version
uint32_t version
Definition: data-loop.h:60
pw_data_loop_events::destroy
void(* destroy)(void *data)
The loop is destroyed.
Definition: data-loop.h:62
pw_data_loop
pw_loop
Definition: loop.h:51
pw_loop::loop
struct spa_loop * loop
wrapped loop
Definition: loop.h:53
spa_dict
Definition: dict.h:59
spa_hook
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:342
spa_thread