PipeWire: pipewire/filter.h Source File

PipeWire 1.0.4

Loading...
Searching...
No Matches
filter.h
Go to the documentation of this file.
1/* PipeWire */
2/* SPDX-FileCopyrightText: Copyright © 2019 Wim Taymans */
3/* SPDX-License-Identifier: MIT */
4
5#ifndef PIPEWIRE_FILTER_H
6#define PIPEWIRE_FILTER_H
7
8#ifdef __cplusplus
9extern "C" {
10#endif
11
26struct pw_filter;
27
28#include <spa/buffer/buffer.h>
29#include <spa/node/io.h>
30#include <spa/param/param.h>
31#include <spa/pod/command.h>
32
33#include <pipewire/core.h>
34#include <pipewire/stream.h>
35
37enum pw_filter_state {
38 PW_FILTER_STATE_ERROR = -1,
39 PW_FILTER_STATE_UNCONNECTED = 0,
40 PW_FILTER_STATE_CONNECTING = 1,
41 PW_FILTER_STATE_PAUSED = 2,
42 PW_FILTER_STATE_STREAMING = 3
43};
44
45#if 0
46 struct pw_buffer {
47 struct spa_buffer *buffer;
48 void *user_data;
49 uint64_t size;
54};
55#endif
56
59struct pw_filter_events {
60#define PW_VERSION_FILTER_EVENTS 1
61 uint32_t version;
62
63 void (*destroy) (void *data);
65 void (*state_changed) (void *data, enum pw_filter_state old,
66 enum pw_filter_state state, const char *error);
67
69 void (*io_changed) (void *data, void *port_data,
70 uint32_t id, void *area, uint32_t size);
72 void (*param_changed) (void *data, void *port_data,
73 uint32_t id, const struct spa_pod *param);
74
76 void (*add_buffer) (void *data, void *port_data, struct pw_buffer *buffer);
78 void (*remove_buffer) (void *data, void *port_data, struct pw_buffer *buffer);
79
83 void (*process) (void *data, struct spa_io_position *position);
84
86 void (*drained) (void *data);
87
89 void (*command) (void *data, const struct spa_command *command);
90};
91
93const char * pw_filter_state_as_string(enum pw_filter_state state);
94
96enum pw_filter_flags {
97 PW_FILTER_FLAG_NONE = 0,
98 PW_FILTER_FLAG_INACTIVE = (1 << 0),
101 PW_FILTER_FLAG_DRIVER = (1 << 1),
102 PW_FILTER_FLAG_RT_PROCESS = (1 << 2),
104 PW_FILTER_FLAG_CUSTOM_LATENCY = (1 << 3),
107 PW_FILTER_FLAG_TRIGGER = (1 << 4),
112 PW_FILTER_FLAG_ASYNC = (1 << 5),
119};
120
121enum pw_filter_port_flags {
122 PW_FILTER_PORT_FLAG_NONE = 0,
123 PW_FILTER_PORT_FLAG_MAP_BUFFERS = (1 << 0),
125 PW_FILTER_PORT_FLAG_ALLOC_BUFFERS = (1 << 1),
128};
129
132struct pw_filter *
133 pw_filter_new(struct pw_core *core,
134 const char *name,
135 struct pw_properties *props );
136
137struct pw_filter *
138 pw_filter_new_simple(struct pw_loop *loop,
139 const char *name,
140 struct pw_properties *props,
141 const struct pw_filter_events *events,
142 void *data );
143
145void pw_filter_destroy(struct pw_filter *filter);
146
147void pw_filter_add_listener(struct pw_filter *filter,
148 struct spa_hook *listener,
149 const struct pw_filter_events *events,
150 void *data);
151
152enum pw_filter_state pw_filter_get_state(struct pw_filter *filter, const char **error);
153
154const char *pw_filter_get_name(struct pw_filter *filter);
155
156struct pw_core *pw_filter_get_core(struct pw_filter *filter);
157
163int
164 pw_filter_connect(struct pw_filter *filter,
165 enum pw_filter_flags flags,
166 const struct spa_pod **params,
167 uint32_t n_params );
168
171uint32_t
172 pw_filter_get_node_id(struct pw_filter *filter);
173
175int pw_filter_disconnect(struct pw_filter *filter);
176
178void *pw_filter_add_port(struct pw_filter *filter,
179 enum pw_direction direction,
180 enum pw_filter_port_flags flags,
181 size_t port_data_size,
182 struct pw_properties *props,
183 const struct spa_pod **params,
185 uint32_t n_params );
186
188int pw_filter_remove_port(void *port_data );
189
191const struct pw_properties *pw_filter_get_properties(struct pw_filter *filter,
192 void *port_data);
193
195int pw_filter_update_properties(struct pw_filter *filter,
196 void *port_data, const struct spa_dict *dict);
197
199int pw_filter_set_error(struct pw_filter *filter,
200 int res,
201 const char *error,
202 ...
203 ) SPA_PRINTF_FUNC(3, 4);
204
206int
207 pw_filter_update_params(struct pw_filter *filter,
208 void *port_data,
209 const struct spa_pod **params,
210 uint32_t n_params );
211
212
215 SPA_DEPRECATED
216int pw_filter_get_time(struct pw_filter *filter, struct pw_time *time);
217
220uint64_t pw_filter_get_nsec(struct pw_filter *filter);
221
224struct pw_buffer *pw_filter_dequeue_buffer(void *port_data);
225
227int pw_filter_queue_buffer(void *port_data, struct pw_buffer *buffer);
228
230void *pw_filter_get_dsp_buffer(void *port_data, uint32_t n_samples);
231
233int pw_filter_set_active(struct pw_filter *filter, bool active);
234
237int pw_filter_flush(struct pw_filter *filter, bool drain);
238
243bool pw_filter_is_driving(struct pw_filter *filter);
244
247int pw_filter_trigger_process(struct pw_filter *filter);
248
253#ifdef __cplusplus
254}
255#endif
256
257#endif /* PIPEWIRE_FILTER_H */
buffer.h
spa/buffer/buffer.h
core.h
pipewire/core.h
pw_filter_get_name
const char * pw_filter_get_name(struct pw_filter *filter)
Definition filter.c:1522
pw_filter_remove_port
int pw_filter_remove_port(void *port_data)
remove a port from the filter
Definition filter.c:1891
pw_filter_flags
pw_filter_flags
Extra flags that can be used in pw_filter_connect()
Definition filter.h:102
pw_filter_state_as_string
const char * pw_filter_state_as_string(enum pw_filter_state state)
Convert a filter state to a readable string
Definition filter.c:1367
pw_filter_connect
int pw_filter_connect(struct pw_filter *filter, enum pw_filter_flags flags, const struct spa_pod **params, uint32_t n_params)
Connect a filter for processing.
Definition filter.c:1589
pw_filter_get_core
struct pw_core * pw_filter_get_core(struct pw_filter *filter)
Definition filter.c:1516
pw_filter_add_listener
void pw_filter_add_listener(struct pw_filter *filter, struct spa_hook *listener, const struct pw_filter_events *events, void *data)
Definition filter.c:1490
pw_filter_get_state
enum pw_filter_state pw_filter_get_state(struct pw_filter *filter, const char **error)
Definition filter.c:1508
pw_filter_get_node_id
uint32_t pw_filter_get_node_id(struct pw_filter *filter)
Get the node ID of the filter.
Definition filter.c:1739
pw_filter_queue_buffer
int pw_filter_queue_buffer(void *port_data, struct pw_buffer *buffer)
Submit a buffer for playback or recycle a buffer for capture.
Definition filter.c:2024
pw_filter_get_nsec
uint64_t pw_filter_get_nsec(struct pw_filter *filter)
Get the current time in nanoseconds.
Definition filter.c:1998
pw_filter_port_flags
pw_filter_port_flags
Definition filter.h:127
pw_filter_trigger_process
int pw_filter_trigger_process(struct pw_filter *filter)
Trigger a push/pull on the filter.
Definition filter.c:2123
pw_filter_disconnect
int pw_filter_disconnect(struct pw_filter *filter)
Disconnect filter
Definition filter.c:1745
pw_filter_state
pw_filter_state
The state of a filter
Definition filter.h:42
pw_filter_new
struct pw_filter * pw_filter_new(struct pw_core *core, const char *name, struct pw_properties *props)
Create a new unconneced Filter.
Definition filter.c:1300
pw_filter_set_active
int pw_filter_set_active(struct pw_filter *filter, bool active)
Activate or deactivate the filter
Definition filter.c:1957
pw_filter_add_port
void * pw_filter_add_port(struct pw_filter *filter, enum pw_direction direction, enum pw_filter_port_flags flags, size_t port_data_size, struct pw_properties *props, const struct spa_pod **params, uint32_t n_params)
add a port to the filter, returns user data of port_data_size.
Definition filter.c:1820
pw_filter_get_time
int pw_filter_get_time(struct pw_filter *filter, struct pw_time *time)
Query the time on the filter, deprecated, use the spa_io_position in the process() method for timing ...
Definition filter.c:1975
pw_filter_dequeue_buffer
struct pw_buffer * pw_filter_dequeue_buffer(void *port_data)
Get a buffer that can be filled for output ports or consumed for input ports.
Definition filter.c:2006
pw_filter_is_driving
bool pw_filter_is_driving(struct pw_filter *filter)
Check if the filter is driving.
Definition filter.c:2093
pw_filter_flush
int pw_filter_flush(struct pw_filter *filter, bool drain)
Flush a filter.
Definition filter.c:2084
pw_filter_set_error
int pw_filter_set_error(struct pw_filter *filter, int res, const char *error,...)
Set the filter in error state.
Definition filter.c:1903
pw_filter_get_properties
const struct pw_properties * pw_filter_get_properties(struct pw_filter *filter, void *port_data)
get properties, port_data of NULL will give global properties
Definition filter.c:1528
pw_filter_update_params
int pw_filter_update_params(struct pw_filter *filter, void *port_data, const struct spa_pod **params, uint32_t n_params)
Update params, use NULL port_data for global filter params.
Definition filter.c:1929
pw_filter_update_properties
int pw_filter_update_properties(struct pw_filter *filter, void *port_data, const struct spa_dict *dict)
Update properties, use NULL port_data for global filter properties.
Definition filter.c:1541
pw_filter_destroy
void pw_filter_destroy(struct pw_filter *filter)
Destroy a filter
Definition filter.c:1426
pw_filter_get_dsp_buffer
void * pw_filter_get_dsp_buffer(void *port_data, uint32_t n_samples)
Get a data pointer to the buffer data.
Definition filter.c:2033
pw_filter_new_simple
struct pw_filter * pw_filter_new_simple(struct pw_loop *loop, const char *name, struct pw_properties *props, const struct pw_filter_events *events, void *data)
Definition filter.c:1322
PW_FILTER_FLAG_NONE
@ PW_FILTER_FLAG_NONE
no flags
Definition filter.h:103
PW_FILTER_FLAG_TRIGGER
@ PW_FILTER_FLAG_TRIGGER
the filter will not be scheduled automatically but _trigger_process() needs to be called.
Definition filter.h:113
PW_FILTER_FLAG_CUSTOM_LATENCY
@ PW_FILTER_FLAG_CUSTOM_LATENCY
don't call the default latency algorithm but emit the param_changed event for the ports when Latency ...
Definition filter.h:110
PW_FILTER_FLAG_INACTIVE
@ PW_FILTER_FLAG_INACTIVE
start the filter inactive, pw_filter_set_active() needs to be called explicitly
Definition filter.h:104
PW_FILTER_FLAG_RT_PROCESS
@ PW_FILTER_FLAG_RT_PROCESS
call process from the realtime thread
Definition filter.h:108
PW_FILTER_FLAG_ASYNC
@ PW_FILTER_FLAG_ASYNC
Buffers will not be dequeued/queued from the realtime process() function.
Definition filter.h:118
PW_FILTER_FLAG_DRIVER
@ PW_FILTER_FLAG_DRIVER
be a driver
Definition filter.h:107
PW_FILTER_PORT_FLAG_ALLOC_BUFFERS
@ PW_FILTER_PORT_FLAG_ALLOC_BUFFERS
the application will allocate buffer memory.
Definition filter.h:131
PW_FILTER_PORT_FLAG_MAP_BUFFERS
@ PW_FILTER_PORT_FLAG_MAP_BUFFERS
mmap the buffers except DmaBuf that is not explicitly marked as mappable.
Definition filter.h:129
PW_FILTER_PORT_FLAG_NONE
@ PW_FILTER_PORT_FLAG_NONE
no flags
Definition filter.h:128
PW_FILTER_STATE_STREAMING
@ PW_FILTER_STATE_STREAMING
filter is streaming
Definition filter.h:47
PW_FILTER_STATE_ERROR
@ PW_FILTER_STATE_ERROR
the stream is in error
Definition filter.h:43
PW_FILTER_STATE_UNCONNECTED
@ PW_FILTER_STATE_UNCONNECTED
unconnected
Definition filter.h:44
PW_FILTER_STATE_CONNECTING
@ PW_FILTER_STATE_CONNECTING
connection is in progress
Definition filter.h:45
PW_FILTER_STATE_PAUSED
@ PW_FILTER_STATE_PAUSED
filter is connected and paused
Definition filter.h:46
pw_direction
#define pw_direction
The direction of a port.
Definition port.h:46
SPA_DEPRECATED
#define SPA_DEPRECATED
Definition defs.h:283
SPA_PRINTF_FUNC
#define SPA_PRINTF_FUNC(fmt, arg1)
Definition defs.h:277
io.h
spa/node/io.h
param.h
spa/param/param.h
command.h
spa/pod/command.h
stream.h
pipewire/stream.h
pw_buffer
a buffer structure obtained from pw_stream_dequeue_buffer().
Definition stream.h:196
pw_buffer::size
uint64_t size
This field is set by the user and the sum of all queued buffer is returned in the time info.
Definition stream.h:199
pw_buffer::buffer
struct spa_buffer * buffer
the spa buffer
Definition stream.h:197
pw_buffer::user_data
void * user_data
user data attached to the buffer
Definition stream.h:198
pw_core
pw_filter_events
Events for a filter.
Definition filter.h:64
pw_filter_events::process
void(* process)(void *data, struct spa_io_position *position)
do processing.
Definition filter.h:89
pw_filter_events::param_changed
void(* param_changed)(void *data, void *port_data, uint32_t id, const struct spa_pod *param)
when a parameter changed on a port of the filter (when port_data is NULL).
Definition filter.h:78
pw_filter_events::io_changed
void(* io_changed)(void *data, void *port_data, uint32_t id, void *area, uint32_t size)
when io changed on a port of the filter (when port_data is NULL).
Definition filter.h:75
pw_filter_events::version
uint32_t version
Definition filter.h:67
pw_filter_events::drained
void(* drained)(void *data)
The filter is drained.
Definition filter.h:92
pw_filter_events::command
void(* command)(void *data, const struct spa_command *command)
A command notify, Since 0.3.39:1.
Definition filter.h:95
pw_filter_events::remove_buffer
void(* remove_buffer)(void *data, void *port_data, struct pw_buffer *buffer)
when a buffer was destroyed for a port
Definition filter.h:84
pw_filter_events::add_buffer
void(* add_buffer)(void *data, void *port_data, struct pw_buffer *buffer)
when a new buffer was created for a port
Definition filter.h:82
pw_filter_events::destroy
void(* destroy)(void *data)
Definition filter.h:69
pw_filter_events::state_changed
void(* state_changed)(void *data, enum pw_filter_state old, enum pw_filter_state state, const char *error)
when the filter state changes
Definition filter.h:71
pw_filter
pw_loop
Definition loop.h:31
pw_properties
Definition properties.h:33
pw_properties::dict
struct spa_dict dict
dictionary of key/values
Definition properties.h:34
pw_time
A time structure.
Definition stream.h:294
spa_buffer
A Buffer.
Definition buffer.h:94
spa_command
Definition command.h:29
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_io_position
The position information adds extra meaning to the raw clock times.
Definition io.h:279
spa_pod
Definition pod.h:43