PipeWire 0.3.72
src/pipewire/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
33#include <pipewire/core.h>
34#include <pipewire/stream.h>
35
37enum pw_filter_state {
43};
45#if 0
46struct 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);
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);
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 {
98 PW_FILTER_FLAG_INACTIVE = (1 << 0),
101 PW_FILTER_FLAG_DRIVER = (1 << 1),
113
124struct pw_filter *
125pw_filter_new(struct pw_core *core,
126 const char *name,
127 struct pw_properties *props );
128
129struct pw_filter *
130pw_filter_new_simple(struct pw_loop *loop,
131 const char *name,
132 struct pw_properties *props,
133 const struct pw_filter_events *events,
134 void *data );
135
137void pw_filter_destroy(struct pw_filter *filter);
138
139void pw_filter_add_listener(struct pw_filter *filter,
140 struct spa_hook *listener,
141 const struct pw_filter_events *events,
142 void *data);
143
144enum pw_filter_state pw_filter_get_state(struct pw_filter *filter, const char **error);
145
146const char *pw_filter_get_name(struct pw_filter *filter);
147
148struct pw_core *pw_filter_get_core(struct pw_filter *filter);
149
155int
156pw_filter_connect(struct pw_filter *filter,
157 enum pw_filter_flags flags,
158 const struct spa_pod **params,
159 uint32_t n_params );
160
163uint32_t
164pw_filter_get_node_id(struct pw_filter *filter);
165
167int pw_filter_disconnect(struct pw_filter *filter);
168
170void *pw_filter_add_port(struct pw_filter *filter,
171 enum pw_direction direction,
172 enum pw_filter_port_flags flags,
173 size_t port_data_size,
174 struct pw_properties *props,
175 const struct spa_pod **params,
177 uint32_t n_params );
178
180int pw_filter_remove_port(void *port_data );
181
183const struct pw_properties *pw_filter_get_properties(struct pw_filter *filter,
184 void *port_data);
185
187int pw_filter_update_properties(struct pw_filter *filter,
188 void *port_data, const struct spa_dict *dict);
189
191int pw_filter_set_error(struct pw_filter *filter,
192 int res,
193 const char *error,
194 ...
195 ) SPA_PRINTF_FUNC(3, 4);
196
198int
199pw_filter_update_params(struct pw_filter *filter,
200 void *port_data,
201 const struct spa_pod **params,
202 uint32_t n_params );
203
204
208int pw_filter_get_time(struct pw_filter *filter, struct pw_time *time);
209
212struct pw_buffer *pw_filter_dequeue_buffer(void *port_data);
213
215int pw_filter_queue_buffer(void *port_data, struct pw_buffer *buffer);
216
218void *pw_filter_get_dsp_buffer(void *port_data, uint32_t n_samples);
219
221int pw_filter_set_active(struct pw_filter *filter, bool active);
222
225int pw_filter_flush(struct pw_filter *filter, bool drain);
226
231bool pw_filter_is_driving(struct pw_filter *filter);
232
235int pw_filter_trigger_process(struct pw_filter *filter);
236
241#ifdef __cplusplus
242}
243#endif
244
245#endif /* PIPEWIRE_FILTER_H */
spa/buffer/buffer.h
pipewire/core.h
const char * pw_filter_get_name(struct pw_filter *filter)
Definition: filter.c:1533
int pw_filter_remove_port(void *port_data)
remove a port from the filter
Definition: filter.c:1879
pw_filter_flags
Extra flags that can be used in pw_filter_connect()
Definition: src/pipewire/filter.h:102
const char * pw_filter_state_as_string(enum pw_filter_state state)
Convert a filter state to a readable string
Definition: filter.c:1378
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:1600
struct pw_core * pw_filter_get_core(struct pw_filter *filter)
Definition: filter.c:1527
void pw_filter_add_listener(struct pw_filter *filter, struct spa_hook *listener, const struct pw_filter_events *events, void *data)
Definition: filter.c:1501
enum pw_filter_state pw_filter_get_state(struct pw_filter *filter, const char **error)
Definition: filter.c:1519
uint32_t pw_filter_get_node_id(struct pw_filter *filter)
Get the node ID of the filter.
Definition: filter.c:1728
int pw_filter_set_error(struct pw_filter *filter, int res, const char *error,...) 1(3
Set the filter in error state.
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
int 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:1919
pw_filter_port_flags
Definition: src/pipewire/filter.h:120
int pw_filter_trigger_process(struct pw_filter *filter)
Trigger a push/pull on the filter.
Definition: filter.c:2105
int pw_filter_disconnect(struct pw_filter *filter)
Disconnect filter
Definition: filter.c:1734
pw_filter_state
The state of a filter
Definition: src/pipewire/filter.h:42
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:1311
int pw_filter_set_active(struct pw_filter *filter, bool active)
Activate or deactivate the filter
Definition: filter.c:1947
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:1809
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:1965
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
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:1539
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:1552
void pw_filter_destroy(struct pw_filter *filter)
Destroy a filter
Definition: filter.c:1437
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:1333
@ PW_FILTER_FLAG_NONE
no flags
Definition: src/pipewire/filter.h:103
@ PW_FILTER_FLAG_TRIGGER
the filter will not be scheduled automatically but _trigger_process() needs to be called.
Definition: src/pipewire/filter.h:113
@ PW_FILTER_FLAG_CUSTOM_LATENCY
don't call the default latency algorithm but emit the param_changed event for the ports when Latency ...
Definition: src/pipewire/filter.h:110
@ PW_FILTER_FLAG_INACTIVE
start the filter inactive, pw_filter_set_active() needs to be called explicitly
Definition: src/pipewire/filter.h:104
@ PW_FILTER_FLAG_RT_PROCESS
call process from the realtime thread
Definition: src/pipewire/filter.h:108
@ PW_FILTER_FLAG_DRIVER
be a driver
Definition: src/pipewire/filter.h:107
@ PW_FILTER_PORT_FLAG_ALLOC_BUFFERS
the application will allocate buffer memory.
Definition: src/pipewire/filter.h:123
@ PW_FILTER_PORT_FLAG_MAP_BUFFERS
mmap the buffers except DmaBuf
Definition: src/pipewire/filter.h:122
@ PW_FILTER_PORT_FLAG_NONE
no flags
Definition: src/pipewire/filter.h:121
@ PW_FILTER_STATE_STREAMING
filter is streaming
Definition: src/pipewire/filter.h:47
@ PW_FILTER_STATE_ERROR
the stream is in error
Definition: src/pipewire/filter.h:43
@ PW_FILTER_STATE_UNCONNECTED
unconnected
Definition: src/pipewire/filter.h:44
@ PW_FILTER_STATE_CONNECTING
connection is in progress
Definition: src/pipewire/filter.h:45
@ PW_FILTER_STATE_PAUSED
filter is connected and paused
Definition: src/pipewire/filter.h:46
#define pw_direction
The direction of a port.
Definition: port.h:43
#define SPA_DEPRECATED
Definition: defs.h:279
#define SPA_PRINTF_FUNC(fmt, arg1)
Definition: defs.h:273
spa/node/io.h
spa/param/param.h
spa/pod/command.h
pipewire/stream.h
a buffer structure obtained from pw_stream_dequeue_buffer().
Definition: stream.h:194
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:197
struct spa_buffer * buffer
the spa buffer
Definition: stream.h:195
void * user_data
user data attached to the buffer
Definition: stream.h:196
Events for a filter.
Definition: src/pipewire/filter.h:64
void(* process)(void *data, struct spa_io_position *position)
do processing.
Definition: src/pipewire/filter.h:89
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: src/pipewire/filter.h:78
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: src/pipewire/filter.h:75
uint32_t version
Definition: src/pipewire/filter.h:67
void(* drained)(void *data)
The filter is drained.
Definition: src/pipewire/filter.h:92
void(* command)(void *data, const struct spa_command *command)
A command notify, Since 0.3.39:1.
Definition: src/pipewire/filter.h:95
void(* remove_buffer)(void *data, void *port_data, struct pw_buffer *buffer)
when a buffer was destroyed for a port
Definition: src/pipewire/filter.h:84
void(* add_buffer)(void *data, void *port_data, struct pw_buffer *buffer)
when a new buffer was created for a port
Definition: src/pipewire/filter.h:82
void(* destroy)(void *data)
Definition: src/pipewire/filter.h:69
void(* state_changed)(void *data, enum pw_filter_state old, enum pw_filter_state state, const char *error)
when the filter state changes
Definition: src/pipewire/filter.h:71
Definition: src/pipewire/loop.h:31
Definition: properties.h:33
struct spa_dict dict
dictionary of key/values
Definition: properties.h:34
A time structure.
Definition: stream.h:284
A Buffer.
Definition: buffer/buffer.h:90
Definition: pod/command.h:29
Definition: utils/dict.h:39
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:279
Definition: pod/pod.h:43