PipeWire  0.3.33
src/pipewire/control.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_CONTROL_H
26 #define PIPEWIRE_CONTROL_H
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
32 #include <spa/utils/hook.h>
33 
43 struct pw_control;
44 
45 #include <pipewire/impl.h>
46 
49 #define PW_VERSION_CONTROL_EVENTS 0
50  uint32_t version;
51 
53  void (*destroy) (void *data);
54 
56  void (*free) (void *data);
57 
59  void (*linked) (void *data, struct pw_control *other);
61  void (*unlinked) (void *data, struct pw_control *other);
62 
63 };
64 
66 struct pw_impl_port *pw_control_get_port(struct pw_control *control);
67 
69 void pw_control_add_listener(struct pw_control *control,
70  struct spa_hook *listener,
71  const struct pw_control_events *events,
72  void *data);
73 
78 #ifdef __cplusplus
79 }
80 #endif
81 
82 #endif /* PIPEWIRE_CONTROL_H */
SPA_MAX
#define SPA_MAX(a, b)
Definition: defs.h:129
pw_control_add_listener
void pw_control_add_listener(struct pw_control *control, struct spa_hook *listener, const struct pw_control_events *events, void *data)
Add an event listener on the control.
Definition: control.c:138
spa_direction
spa_direction
Definition: defs.h:78
NAME
#define NAME
Definition: control.c:31
PW_MEMBLOCK_FLAG_READWRITE
@ PW_MEMBLOCK_FLAG_READWRITE
Definition: src/pipewire/mem.h:53
control
Definition: stream.c:86
pw_control_remove_link
int pw_control_remove_link(struct pw_control_link *link)
Definition: control.c:237
types.h
pw_control_events
Port events, use pw_control_add_listener.
Definition: src/pipewire/control.h:48
data
user data to add to an object
Definition: filter.c:75
pw_mempool_alloc
struct pw_memblock * pw_mempool_alloc(struct pw_mempool *pool, enum pw_memblock_flags flags, uint32_t type, size_t size)
Allocate a memory block from the pool.
Definition: mem.c:464
SPA_EXPORT
#define SPA_EXPORT
Definition: defs.h:208
SPA_DIRECTION_INPUT
@ SPA_DIRECTION_INPUT
Definition: defs.h:79
pw_control_new
struct pw_control * pw_control_new(struct pw_context *context, struct pw_impl_port *port, uint32_t id, uint32_t size, size_t user_data_size)
Definition: control.c:40
pw_control_events::linked
void(* linked)(void *data, struct pw_control *other)
control is linked to another control
Definition: src/pipewire/control.h:59
impl
Definition: control.c:33
control.h
spa_hook_list_append
void spa_hook_list_append(struct spa_hook_list *list, struct spa_hook *hook, const void *funcs, void *data)
Append a hook.
Definition: hook.h:316
pw_memmap::ptr
void * ptr
mapped pointer
Definition: src/pipewire/mem.h:92
SPA_PTROFF
#define SPA_PTROFF(ptr_, offset_, type_)
Return the address (buffer + offset) as pointer of type.
Definition: defs.h:159
port::node
struct spa_node * node
Definition: buffers.c:45
SPA_IO_Control
@ SPA_IO_Control
area for control messages, struct spa_io_sequence
Definition: io.h:57
pw_control_add_link
int pw_control_add_link(struct pw_control *control, uint32_t cmix, struct pw_control *other, uint32_t omix, struct pw_control_link *link)
Definition: control.c:166
impl.h
SPA_CONTAINER_OF
#define SPA_CONTAINER_OF(p, t, m)
Definition: defs.h:170
spa_list_consume
#define spa_list_consume(pos, head, member)
Definition: list.h:96
spa_node_port_set_io
#define spa_node_port_set_io(n,...)
Definition: build-12775836/doc/spa/node/node.h:660
spa_list_remove
void spa_list_remove(struct spa_list *elem)
Definition: list.h:69
port
Definition: buffers.c:44
SPA_RESULT_IS_OK
#define SPA_RESULT_IS_OK(res)
Definition: result.h:44
PW_MEMBLOCK_FLAG_SEAL
@ PW_MEMBLOCK_FLAG_SEAL
seal the fd
Definition: src/pipewire/mem.h:48
pw_control_destroy
void pw_control_destroy(struct pw_control *control)
Definition: control.c:94
control::id
uint32_t id
Definition: stream.c:87
spa_hook
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:295
control::link
struct spa_list link
Definition: stream.c:90
pw_control_events::destroy
void(* destroy)(void *data)
The control is destroyed.
Definition: src/pipewire/control.h:53
PW_MEMBLOCK_FLAG_MAP
@ PW_MEMBLOCK_FLAG_MAP
mmap the fd
Definition: src/pipewire/mem.h:49
pw_memblock::map
struct pw_memmap * map
optional map when PW_MEMBLOCK_FLAG_MAP was given
Definition: src/pipewire/mem.h:86
spa_list_init
void spa_list_init(struct spa_list *list)
Definition: list.h:44
SPA_IO_Notify
@ SPA_IO_Notify
area for notify messages, struct spa_io_sequence
Definition: io.h:58
SPA_DIRECTION_OUTPUT
@ SPA_DIRECTION_OUTPUT
Definition: defs.h:80
pw_control_get_port
struct pw_impl_port * pw_control_get_port(struct pw_control *control)
Get the control parent port or NULL when not set.
Definition: control.c:132
port::port_id
uint32_t port_id
Definition: buffers.c:47
pw_control_events::version
uint32_t version
Definition: src/pipewire/control.h:50
spa_strerror
#define spa_strerror(err)
Definition: result.h:51
SPA_SWAP
#define SPA_SWAP(a, b)
Definition: defs.h:143
pw_memblock
Memory block structure.
Definition: src/pipewire/mem.h:78
pw_log_debug
#define pw_log_debug(...)
Definition: src/pipewire/log.h:89
spa_type_io
const struct spa_type_info spa_type_io[]
Definition: node/type-info.h:46
pw_control_events::free
void(* free)(void *data)
The control is freed.
Definition: src/pipewire/control.h:56
spa_list_is_empty
#define spa_list_is_empty(l)
Definition: list.h:49
pw_control_events::unlinked
void(* unlinked)(void *data, struct pw_control *other)
control is unlinked from another control
Definition: src/pipewire/control.h:61
parser.h
SPA_DATA_MemFd
@ SPA_DATA_MemFd
generic fd, mmap to get to memory
Definition: buffer/buffer.h:49
impl::mem
struct pw_memblock * mem
Definition: control.c:36
pw_log_warn
#define pw_log_warn(...)
Definition: src/pipewire/log.h:87
impl::this
struct pw_control this
Definition: control.c:34
spa_hook_list_init
void spa_hook_list_init(struct spa_hook_list *list)
Initialize a hook list to the empty list.
Definition: hook.h:305
hook.h
port::direction
enum spa_direction direction
Definition: buffers.c:46
spa_hook_list_clean
void spa_hook_list_clean(struct spa_hook_list *list)
Remove all hooks from the list.
Definition: hook.h:344
spa_debug_type_find_name
const char * spa_debug_type_find_name(const struct spa_type_info *info, uint32_t type)
Definition: types.h:68
spa_list_append
#define spa_list_append(list, item)
Definition: list.h:81