PipeWire  1.4.1
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
9 extern "C" {
10 #endif
11 
26 struct 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 
38 enum pw_filter_state {
44 };
45 
46 #if 0
47 struct pw_buffer {
48  struct spa_buffer *buffer;
49  void *user_data;
50  uint64_t size;
55 };
56 #endif
57 
60 struct pw_filter_events {
61 #define PW_VERSION_FILTER_EVENTS 1
62  uint32_t version;
63 
64  void (*destroy) (void *data);
67  void (*state_changed) (void *data, enum pw_filter_state old,
68  enum pw_filter_state state, const char *error);
69 
71  void (*io_changed) (void *data, void *port_data,
72  uint32_t id, void *area, uint32_t size);
74  void (*param_changed) (void *data, void *port_data,
75  uint32_t id, const struct spa_pod *param);
76 
78  void (*add_buffer) (void *data, void *port_data, struct pw_buffer *buffer);
80  void (*remove_buffer) (void *data, void *port_data, struct pw_buffer *buffer);
81 
87  void (*process) (void *data, struct spa_io_position *position);
88 
90  void (*drained) (void *data);
91 
93  void (*command) (void *data, const struct spa_command *command);
94 };
95 
97 const char * pw_filter_state_as_string(enum pw_filter_state state);
98 
100 enum pw_filter_flags {
101  PW_FILTER_FLAG_NONE = 0,
102  PW_FILTER_FLAG_INACTIVE = (1 << 0),
105  PW_FILTER_FLAG_DRIVER = (1 << 1),
109  PW_FILTER_FLAG_CUSTOM_LATENCY = (1 << 3),
112  PW_FILTER_FLAG_TRIGGER = (1 << 4),
117  PW_FILTER_FLAG_ASYNC = (1 << 5),
124 };
125 
133 };
134 
137 struct pw_filter *
138 pw_filter_new(struct pw_core *core,
139  const char *name,
140  struct pw_properties *props );
141 
142 struct pw_filter *
143 pw_filter_new_simple(struct pw_loop *loop,
144  const char *name,
145  struct pw_properties *props,
146  const struct pw_filter_events *events,
147  void *data );
148 
150 void pw_filter_destroy(struct pw_filter *filter);
151 
152 void pw_filter_add_listener(struct pw_filter *filter,
153  struct spa_hook *listener,
154  const struct pw_filter_events *events,
155  void *data);
156 
159 enum pw_filter_state pw_filter_get_state(struct pw_filter *filter, const char **error);
160 
161 const char *pw_filter_get_name(struct pw_filter *filter);
162 
163 struct pw_core *pw_filter_get_core(struct pw_filter *filter);
164 
170 int
171 pw_filter_connect(struct pw_filter *filter,
172  enum pw_filter_flags flags,
173  const struct spa_pod **params,
174  uint32_t n_params );
175 
178 uint32_t
179 pw_filter_get_node_id(struct pw_filter *filter);
180 
182 int pw_filter_disconnect(struct pw_filter *filter);
183 
185 void *pw_filter_add_port(struct pw_filter *filter,
186  enum pw_direction direction,
187  enum pw_filter_port_flags flags,
188  size_t port_data_size,
189  struct pw_properties *props,
190  const struct spa_pod **params,
192  uint32_t n_params );
193 
195 int pw_filter_remove_port(void *port_data );
196 
198 const struct pw_properties *pw_filter_get_properties(struct pw_filter *filter,
199  void *port_data);
200 
202 int pw_filter_update_properties(struct pw_filter *filter,
203  void *port_data, const struct spa_dict *dict);
204 
206 int pw_filter_set_error(struct pw_filter *filter,
207  int res,
208  const char *error,
209  ...
210  ) SPA_PRINTF_FUNC(3, 4);
211 
213 int
214 pw_filter_update_params(struct pw_filter *filter,
215  void *port_data,
216  const struct spa_pod **params,
217  uint32_t n_params );
218 
219 
223 int pw_filter_get_time(struct pw_filter *filter, struct pw_time *time);
224 
227 uint64_t pw_filter_get_nsec(struct pw_filter *filter);
228 
231 struct pw_loop *pw_filter_get_data_loop(struct pw_filter *filter);
232 
235 struct pw_buffer *pw_filter_dequeue_buffer(void *port_data);
236 
238 int pw_filter_queue_buffer(void *port_data, struct pw_buffer *buffer);
239 
241 void *pw_filter_get_dsp_buffer(void *port_data, uint32_t n_samples);
242 
244 int pw_filter_set_active(struct pw_filter *filter, bool active);
245 
252 int pw_filter_flush(struct pw_filter *filter, bool drain);
253 
258 bool pw_filter_is_driving(struct pw_filter *filter);
259 
262 bool pw_filter_is_lazy(struct pw_filter *filter);
263 
266 int pw_filter_trigger_process(struct pw_filter *filter);
267 
270 int pw_filter_emit_event(struct pw_filter *filter, const struct spa_event *event);
271 
276 #ifdef __cplusplus
277 }
278 #endif
279 
280 #endif /* PIPEWIRE_FILTER_H */
spa/buffer/buffer.h
pipewire/core.h
buffer[1023]
Definition: core.h:437
uint32_t id
Definition: core.h:432
uint32_t int int res
Definition: core.h:433
struct pw_core * pw_filter_get_core(struct pw_filter *filter)
Definition: filter.c:1489
int pw_filter_remove_port(void *port_data)
remove a port from the filter
Definition: filter.c:1880
pw_filter_flags
Extra flags that can be used in pw_filter_connect()
Definition: filter.h:106
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:1562
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:1271
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:1803
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:2002
void pw_filter_add_listener(struct pw_filter *filter, struct spa_hook *listener, const struct pw_filter_events *events, void *data)
Definition: filter.c:1461
enum pw_filter_state pw_filter_get_state(struct pw_filter *filter, const char **error)
Get the current filter state.
Definition: filter.c:1479
uint32_t pw_filter_get_node_id(struct pw_filter *filter)
Get the node ID of the filter.
Definition: filter.c:1713
int pw_filter_emit_event(struct pw_filter *filter, const struct spa_event *event)
Emit an event from this filter.
Definition: filter.c:2119
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:1501
const char * pw_filter_state_as_string(enum pw_filter_state state)
Convert a filter state to a readable string
Definition: filter.c:1338
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:2020
uint64_t pw_filter_get_nsec(struct pw_filter *filter)
Get the current time in nanoseconds.
Definition: filter.c:1987
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:1293
pw_filter_port_flags
Definition: filter.h:132
int pw_filter_trigger_process(struct pw_filter *filter)
Trigger a push/pull on the filter.
Definition: filter.c:2127
int pw_filter_disconnect(struct pw_filter *filter)
Disconnect filter
Definition: filter.c:1719
pw_filter_state
The state of a filter
Definition: filter.h:43
int pw_filter_set_active(struct pw_filter *filter, bool active)
Activate or deactivate the filter
Definition: filter.c:1946
const char * pw_filter_get_name(struct pw_filter *filter)
Definition: filter.c:1495
void * pw_filter_get_dsp_buffer(void *port_data, uint32_t n_samples)
Get a data pointer to the buffer data.
Definition: filter.c:2029
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:1964
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:1995
bool pw_filter_is_driving(struct pw_filter *filter)
Check if the filter is driving.
Definition: filter.c:2089
bool pw_filter_is_lazy(struct pw_filter *filter)
Check if the graph is using lazy scheduling.
Definition: filter.c:2095
int pw_filter_flush(struct pw_filter *filter, bool drain)
Flush a filter.
Definition: filter.c:2080
int pw_filter_set_error(struct pw_filter *filter, int res, const char *error,...)
Set the filter in error state.
Definition: filter.c:1892
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:1918
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:1514
void pw_filter_destroy(struct pw_filter *filter)
Destroy a filter
Definition: filter.c:1397
@ PW_FILTER_FLAG_NONE
no flags
Definition: filter.h:107
@ PW_FILTER_FLAG_TRIGGER
the filter will not be scheduled automatically but _trigger_process() needs to be called.
Definition: filter.h:118
@ 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:115
@ PW_FILTER_FLAG_INACTIVE
start the filter inactive, pw_filter_set_active() needs to be called explicitly
Definition: filter.h:108
@ PW_FILTER_FLAG_RT_PROCESS
call process from the realtime thread.
Definition: filter.h:112
@ PW_FILTER_FLAG_ASYNC
Buffers will not be dequeued/queued from the realtime process() function.
Definition: filter.h:123
@ PW_FILTER_FLAG_DRIVER
be a driver
Definition: filter.h:111
@ PW_FILTER_PORT_FLAG_ALLOC_BUFFERS
the application will allocate buffer memory.
Definition: filter.h:136
@ PW_FILTER_PORT_FLAG_MAP_BUFFERS
mmap the buffers except DmaBuf that is not explicitly marked as mappable.
Definition: filter.h:134
@ PW_FILTER_PORT_FLAG_NONE
no flags
Definition: filter.h:133
@ 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
struct spa_buffer * buffer
the spa buffer
Definition: stream.h:262
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:93
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:80
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:77
uint32_t version
Definition: filter.h:68
void(* drained)(void *data)
The filter is drained.
Definition: filter.h:96
void(* command)(void *data, const struct spa_command *command)
A command notify, Since 0.3.39:1.
Definition: filter.h:99
void(* remove_buffer)(void *data, void *port_data, struct pw_buffer *buffer)
when a buffer was destroyed for a port
Definition: filter.h:86
void(* add_buffer)(void *data, void *port_data, struct pw_buffer *buffer)
when a new buffer was created for a port
Definition: filter.h:84
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:73
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