PipeWire 1.3.0
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>
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 {
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);
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
84 void (*process) (void *data, struct spa_io_position *position);
87 void (*drained) (void *data);
88
90 void (*command) (void *data, const struct spa_command *command);
91};
92
94const char * pw_filter_state_as_string(enum pw_filter_state state);
95
97enum pw_filter_flags {
99 PW_FILTER_FLAG_INACTIVE = (1 << 0),
102 PW_FILTER_FLAG_DRIVER = (1 << 1),
130
133struct pw_filter *
134pw_filter_new(struct pw_core *core,
135 const char *name,
136 struct pw_properties *props );
137
138struct pw_filter *
139pw_filter_new_simple(struct pw_loop *loop,
140 const char *name,
141 struct pw_properties *props,
142 const struct pw_filter_events *events,
143 void *data );
144
146void pw_filter_destroy(struct pw_filter *filter);
147
148void pw_filter_add_listener(struct pw_filter *filter,
149 struct spa_hook *listener,
150 const struct pw_filter_events *events,
151 void *data);
152
153enum pw_filter_state pw_filter_get_state(struct pw_filter *filter, const char **error);
154
155const char *pw_filter_get_name(struct pw_filter *filter);
156
157struct pw_core *pw_filter_get_core(struct pw_filter *filter);
158
164int
165pw_filter_connect(struct pw_filter *filter,
166 enum pw_filter_flags flags,
167 const struct spa_pod **params,
168 uint32_t n_params );
169
172uint32_t
173pw_filter_get_node_id(struct pw_filter *filter);
174
176int pw_filter_disconnect(struct pw_filter *filter);
177
179void *pw_filter_add_port(struct pw_filter *filter,
180 enum pw_direction direction,
181 enum pw_filter_port_flags flags,
182 size_t port_data_size,
183 struct pw_properties *props,
184 const struct spa_pod **params,
186 uint32_t n_params );
187
189int pw_filter_remove_port(void *port_data );
190
192const struct pw_properties *pw_filter_get_properties(struct pw_filter *filter,
193 void *port_data);
194
196int pw_filter_update_properties(struct pw_filter *filter,
197 void *port_data, const struct spa_dict *dict);
198
200int pw_filter_set_error(struct pw_filter *filter,
201 int res,
202 const char *error,
203 ...
204 ) SPA_PRINTF_FUNC(3, 4);
205
207int
208pw_filter_update_params(struct pw_filter *filter,
209 void *port_data,
210 const struct spa_pod **params,
211 uint32_t n_params );
212
213
217int pw_filter_get_time(struct pw_filter *filter, struct pw_time *time);
218
221uint64_t pw_filter_get_nsec(struct pw_filter *filter);
222
225struct pw_loop *pw_filter_get_data_loop(struct pw_filter *filter);
226
229struct pw_buffer *pw_filter_dequeue_buffer(void *port_data);
230
232int pw_filter_queue_buffer(void *port_data, struct pw_buffer *buffer);
233
235void *pw_filter_get_dsp_buffer(void *port_data, uint32_t n_samples);
236
238int pw_filter_set_active(struct pw_filter *filter, bool active);
239
245int pw_filter_flush(struct pw_filter *filter, bool drain);
246
251bool pw_filter_is_driving(struct pw_filter *filter);
252
255int pw_filter_trigger_process(struct pw_filter *filter);
256
259int pw_filter_emit_event(struct pw_filter *filter, const struct spa_event *event);
260
265#ifdef __cplusplus
266}
267#endif
268
269#endif /* PIPEWIRE_FILTER_H */
spa/buffer/buffer.h
pipewire/core.h
const char * pw_filter_get_name(struct pw_filter *filter)
Definition filter.c:1481
int pw_filter_remove_port(void *port_data)
remove a port from the filter
Definition filter.c:1866
pw_filter_flags
Extra flags that can be used in pw_filter_connect()
Definition filter.h:103
const char * pw_filter_state_as_string(enum pw_filter_state state)
Convert a filter state to a readable string
Definition filter.c:1326
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:1548
struct pw_core * pw_filter_get_core(struct pw_filter *filter)
Definition filter.c:1475
void pw_filter_add_listener(struct pw_filter *filter, struct spa_hook *listener, const struct pw_filter_events *events, void *data)
Definition filter.c:1449
enum pw_filter_state pw_filter_get_state(struct pw_filter *filter, const char **error)
Definition filter.c:1467
uint32_t pw_filter_get_node_id(struct pw_filter *filter)
Get the node ID of the filter.
Definition filter.c:1699
int pw_filter_emit_event(struct pw_filter *filter, const struct spa_event *event)
Emit an event from this filter.
Definition filter.c:2099
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:2006
uint64_t pw_filter_get_nsec(struct pw_filter *filter)
Get the current time in nanoseconds.
Definition filter.c:1973
pw_filter_port_flags
Definition filter.h:128
int pw_filter_trigger_process(struct pw_filter *filter)
Trigger a push/pull on the filter.
Definition filter.c:2107
int pw_filter_disconnect(struct pw_filter *filter)
Disconnect filter
Definition filter.c:1705
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:1259
int pw_filter_set_active(struct pw_filter *filter, bool active)
Activate or deactivate the filter
Definition filter.c:1932
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:1981
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:1789
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:1950
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:1988
bool pw_filter_is_driving(struct pw_filter *filter)
Check if the filter is driving.
Definition filter.c:2075
int pw_filter_flush(struct pw_filter *filter, bool drain)
Flush a filter.
Definition filter.c:2066
int pw_filter_set_error(struct pw_filter *filter, int res, const char *error,...)
Set the filter in error state.
Definition filter.c:1878
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:1487
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:1904
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:1500
void pw_filter_destroy(struct pw_filter *filter)
Destroy a filter
Definition filter.c:1385
void * pw_filter_get_dsp_buffer(void *port_data, uint32_t n_samples)
Get a data pointer to the buffer data.
Definition filter.c:2015
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:1281
@ PW_FILTER_FLAG_NONE
no flags
Definition filter.h:104
@ PW_FILTER_FLAG_TRIGGER
the filter will not be scheduled automatically but _trigger_process() needs to be called.
Definition filter.h:114
@ 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:111
@ PW_FILTER_FLAG_INACTIVE
start the filter inactive, pw_filter_set_active() needs to be called explicitly
Definition filter.h:105
@ PW_FILTER_FLAG_RT_PROCESS
call process from the realtime thread
Definition filter.h:109
@ PW_FILTER_FLAG_ASYNC
Buffers will not be dequeued/queued from the realtime process() function.
Definition filter.h:119
@ PW_FILTER_FLAG_DRIVER
be a driver
Definition filter.h:108
@ PW_FILTER_PORT_FLAG_ALLOC_BUFFERS
the application will allocate buffer memory.
Definition filter.h:132
@ PW_FILTER_PORT_FLAG_MAP_BUFFERS
mmap the buffers except DmaBuf that is not explicitly marked as mappable.
Definition filter.h:130
@ PW_FILTER_PORT_FLAG_NONE
no flags
Definition filter.h:129
@ 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:46
#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:250
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:258
struct spa_buffer * buffer
the spa buffer
Definition stream.h:251
void * user_data
user data attached to the buffer.
Definition stream.h:252
Events for a filter.
Definition filter.h:65
void(* process)(void *data, struct spa_io_position *position)
do processing.
Definition filter.h:90
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:93
void(* command)(void *data, const struct spa_command *command)
A command notify, Since 0.3.39:1.
Definition filter.h:96
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:34
struct spa_dict dict
dictionary of key/values
Definition properties.h:35
A time structure.
Definition stream.h:365
A Buffer.
Definition buffer.h:100
Definition command.h:29
Definition dict.h:41
Definition event.h:28
A hook, contains the structure with functions and the data passed to the functions.
Definition hook.h:350
The position information adds extra meaning to the raw clock times.
Definition io.h:312
Definition pod.h:43