PipeWire 1.3.82
 
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
21
26struct pw_filter;
27
28#include <spa/buffer/buffer.h>
29#include <spa/node/io.h>
31#include <spa/pod/command.h>
32#include <spa/pod/event.h>
33
34#include <pipewire/core.h>
35#include <pipewire/stream.h>
36
38enum pw_filter_state {
44};
46#if 0
47struct pw_buffer {
48 struct spa_buffer *buffer;
49 void *user_data;
50 uint64_t size;
55};
56#endif
57
60struct pw_filter_events {
61#define PW_VERSION_FILTER_EVENTS 1
62 uint32_t version;
63
64 void (*destroy) (void *data);
65 /** when the filter state changes */
66 void (*state_changed) (void *data, enum pw_filter_state old,
67 enum pw_filter_state state, const char *error);
70 void (*io_changed) (void *data, void *port_data,
71 uint32_t id, void *area, uint32_t size);
73 void (*param_changed) (void *data, void *port_data,
74 uint32_t id, const struct spa_pod *param);
75
77 void (*add_buffer) (void *data, void *port_data, struct pw_buffer *buffer);
79 void (*remove_buffer) (void *data, void *port_data, struct pw_buffer *buffer);
80
86 void (*process) (void *data, struct spa_io_position *position);
87
89 void (*drained) (void *data);
90
92 void (*command) (void *data, const struct spa_command *command);
93};
94
96const char * pw_filter_state_as_string(enum pw_filter_state state);
97
99enum pw_filter_flags {
101 PW_FILTER_FLAG_INACTIVE = (1 << 0),
104 PW_FILTER_FLAG_DRIVER = (1 << 1),
130
131 * data of the buffer should be set */
136struct pw_filter *
137pw_filter_new(struct pw_core *core,
138 const char *name,
139 struct pw_properties *props );
140
141struct pw_filter *
142pw_filter_new_simple(struct pw_loop *loop,
143 const char *name,
144 struct pw_properties *props,
145 const struct pw_filter_events *events,
146 void *data );
147
149void pw_filter_destroy(struct pw_filter *filter);
150
151void pw_filter_add_listener(struct pw_filter *filter,
152 struct spa_hook *listener,
153 const struct pw_filter_events *events,
154 void *data);
155
156enum pw_filter_state pw_filter_get_state(struct pw_filter *filter, const char **error);
157
158const char *pw_filter_get_name(struct pw_filter *filter);
159
160struct pw_core *pw_filter_get_core(struct pw_filter *filter);
161
167int
168pw_filter_connect(struct pw_filter *filter,
169 enum pw_filter_flags flags,
170 const struct spa_pod **params,
171 uint32_t n_params );
172
175uint32_t
176pw_filter_get_node_id(struct pw_filter *filter);
177
179int pw_filter_disconnect(struct pw_filter *filter);
180
182void *pw_filter_add_port(struct pw_filter *filter,
183 enum pw_direction direction,
184 enum pw_filter_port_flags flags,
185 size_t port_data_size,
186 struct pw_properties *props,
187 const struct spa_pod **params,
189 uint32_t n_params );
190
192int pw_filter_remove_port(void *port_data );
193
195const struct pw_properties *pw_filter_get_properties(struct pw_filter *filter,
196 void *port_data);
197
199int pw_filter_update_properties(struct pw_filter *filter,
200 void *port_data, const struct spa_dict *dict);
201
203int pw_filter_set_error(struct pw_filter *filter,
204 int res,
205 const char *error,
206 ...
207 ) SPA_PRINTF_FUNC(3, 4);
208
210int
211pw_filter_update_params(struct pw_filter *filter,
212 void *port_data,
213 const struct spa_pod **params,
214 uint32_t n_params );
215
216
220int pw_filter_get_time(struct pw_filter *filter, struct pw_time *time);
221
224uint64_t pw_filter_get_nsec(struct pw_filter *filter);
225
228struct pw_loop *pw_filter_get_data_loop(struct pw_filter *filter);
229
232struct pw_buffer *pw_filter_dequeue_buffer(void *port_data);
233
235int pw_filter_queue_buffer(void *port_data, struct pw_buffer *buffer);
236
238void *pw_filter_get_dsp_buffer(void *port_data, uint32_t n_samples);
239
241int pw_filter_set_active(struct pw_filter *filter, bool active);
242
249int pw_filter_flush(struct pw_filter *filter, bool drain);
250
255bool pw_filter_is_driving(struct pw_filter *filter);
256
259bool pw_filter_is_lazy(struct pw_filter *filter);
260
263int pw_filter_trigger_process(struct pw_filter *filter);
264
267int pw_filter_emit_event(struct pw_filter *filter, const struct spa_event *event);
268
272
273#ifdef __cplusplus
274}
275#endif
276
277#endif /* PIPEWIRE_FILTER_H */
spa/buffer/buffer.h
pipewire/core.h
uint32_t id
Definition core.h:432
uint32_t int int res
Definition core.h:433
const char * pw_filter_get_name(struct pw_filter *filter)
Definition filter.c:1488
int pw_filter_remove_port(void *port_data)
remove a port from the filter
Definition filter.c:1873
pw_filter_flags
Extra flags that can be used in pw_filter_connect()
Definition filter.h:105
const char * pw_filter_state_as_string(enum pw_filter_state state)
Convert a filter state to a readable string.
Definition filter.c:1333
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:1555
struct pw_core * pw_filter_get_core(struct pw_filter *filter)
Definition filter.c:1482
void pw_filter_add_listener(struct pw_filter *filter, struct spa_hook *listener, const struct pw_filter_events *events, void *data)
Definition filter.c:1456
enum pw_filter_state pw_filter_get_state(struct pw_filter *filter, const char **error)
Definition filter.c:1474
uint32_t pw_filter_get_node_id(struct pw_filter *filter)
Get the node ID of the filter.
Definition filter.c:1706
int pw_filter_emit_event(struct pw_filter *filter, const struct spa_event *event)
Emit an event from this filter.
Definition filter.c:2112
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:2013
uint64_t pw_filter_get_nsec(struct pw_filter *filter)
Get the current time in nanoseconds.
Definition filter.c:1980
pw_filter_port_flags
Definition filter.h:131
int pw_filter_trigger_process(struct pw_filter *filter)
Trigger a push/pull on the filter.
Definition filter.c:2120
int pw_filter_disconnect(struct pw_filter *filter)
Disconnect filter.
Definition filter.c:1712
pw_filter_state
The state of a filter.
Definition filter.h:43
struct pw_filter * pw_filter_new(struct pw_core *core, const char *name, struct pw_properties *props)
Create a new unconnected Filter.
Definition filter.c:1266
int pw_filter_set_active(struct pw_filter *filter, bool active)
Activate or deactivate the filter.
Definition filter.c:1939
struct pw_loop * pw_filter_get_data_loop(struct pw_filter *filter)
Get the data loop that is doing the processing of this filter.
Definition filter.c:1988
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:1796
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:1957
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:1995
bool pw_filter_is_driving(struct pw_filter *filter)
Check if the filter is driving.
Definition filter.c:2082
bool pw_filter_is_lazy(struct pw_filter *filter)
Check if the graph is using lazy scheduling.
Definition filter.c:2088
int pw_filter_flush(struct pw_filter *filter, bool drain)
Flush a filter.
Definition filter.c:2073
int pw_filter_set_error(struct pw_filter *filter, int res, const char *error,...)
Set the filter in error state.
Definition filter.c:1885
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:1494
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:1911
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:1507
void pw_filter_destroy(struct pw_filter *filter)
Destroy a filter.
Definition filter.c:1392
void * pw_filter_get_dsp_buffer(void *port_data, uint32_t n_samples)
Get a data pointer to the buffer data.
Definition filter.c:2022
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:1288
@ PW_FILTER_FLAG_NONE
no flags
Definition filter.h:106
@ PW_FILTER_FLAG_TRIGGER
the filter will not be scheduled automatically but _trigger_process() needs to be called.
Definition filter.h:117
@ 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:114
@ PW_FILTER_FLAG_INACTIVE
start the filter inactive, pw_filter_set_active() needs to be called explicitly
Definition filter.h:107
@ PW_FILTER_FLAG_RT_PROCESS
call process from the realtime thread.
Definition filter.h:111
@ PW_FILTER_FLAG_ASYNC
Buffers will not be dequeued/queued from the realtime process() function.
Definition filter.h:122
@ PW_FILTER_FLAG_DRIVER
be a driver
Definition filter.h:110
@ PW_FILTER_PORT_FLAG_ALLOC_BUFFERS
the application will allocate buffer memory.
Definition filter.h:135
@ PW_FILTER_PORT_FLAG_MAP_BUFFERS
mmap the buffers except DmaBuf that is not explicitly marked as mappable.
Definition filter.h:133
@ PW_FILTER_PORT_FLAG_NONE
no flags
Definition filter.h:132
@ PW_FILTER_STATE_STREAMING
filter is streaming
Definition filter.h:48
@ PW_FILTER_STATE_ERROR
the stream is in error
Definition filter.h:44
@ PW_FILTER_STATE_UNCONNECTED
unconnected
Definition filter.h:45
@ PW_FILTER_STATE_CONNECTING
connection is in progress
Definition filter.h:46
@ PW_FILTER_STATE_PAUSED
filter is connected and paused
Definition filter.h:47
#define pw_direction
The direction of a port.
Definition port.h:51
#define SPA_DEPRECATED
Definition defs.h:301
#define SPA_PRINTF_FUNC(fmt, arg1)
Definition defs.h:295
spa/node/io.h
spa/param/param.h
spa/pod/command.h
spa/pod/event.h
pipewire/stream.h
a buffer structure obtained from pw_stream_dequeue_buffer().
Definition stream.h:261
uint64_t size
This field is set by the user and the sum of all queued buffers is returned in the time info.
Definition stream.h:269
void * user_data
user data attached to the buffer.
Definition stream.h:263
Events for a filter.
Definition filter.h:65
void(* process)(void *data, struct spa_io_position *position)
do processing.
Definition filter.h:92
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:79
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:76
uint32_t version
Definition filter.h:68
void(* drained)(void *data)
The filter is drained.
Definition filter.h:95
void(* command)(void *data, const struct spa_command *command)
A command notify, Since 0.3.39:1.
Definition filter.h:98
void(* remove_buffer)(void *data, void *port_data, struct pw_buffer *buffer)
when a buffer was destroyed for a port
Definition filter.h:85
void(* add_buffer)(void *data, void *port_data, struct pw_buffer *buffer)
when a new buffer was created for a port
Definition filter.h:83
void(* destroy)(void *data)
Definition filter.h:70
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:72
Definition loop.h:33
Definition properties.h:39
struct spa_dict dict
dictionary of key/values
Definition properties.h:40
A time structure.
Definition stream.h:376
A Buffer.
Definition buffer.h:110
Definition command.h:29
Definition dict.h:51
Definition event.h:28
A hook, contains the structure with functions and the data passed to the functions.
Definition hook.h:427
The position information adds extra meaning to the raw clock times.
Definition io.h:316
Definition pod.h:43