PipeWire  1.0.0
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 
33 #include <pipewire/core.h>
34 #include <pipewire/stream.h>
35 
37 enum pw_filter_state {
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 
59 struct 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 
93 const char * pw_filter_state_as_string(enum pw_filter_state state);
94 
96 enum pw_filter_flags {
98  PW_FILTER_FLAG_INACTIVE = (1 << 0),
101  PW_FILTER_FLAG_DRIVER = (1 << 1),
104  PW_FILTER_FLAG_CUSTOM_LATENCY = (1 << 3),
112  PW_FILTER_FLAG_ASYNC = (1 << 5),
119 };
120 
127 };
128 
131 struct pw_filter *
132 pw_filter_new(struct pw_core *core,
133  const char *name,
134  struct pw_properties *props );
135 
136 struct pw_filter *
137 pw_filter_new_simple(struct pw_loop *loop,
138  const char *name,
139  struct pw_properties *props,
140  const struct pw_filter_events *events,
141  void *data );
142 
144 void pw_filter_destroy(struct pw_filter *filter);
145 
146 void pw_filter_add_listener(struct pw_filter *filter,
147  struct spa_hook *listener,
148  const struct pw_filter_events *events,
149  void *data);
150 
151 enum pw_filter_state pw_filter_get_state(struct pw_filter *filter, const char **error);
152 
153 const char *pw_filter_get_name(struct pw_filter *filter);
154 
155 struct pw_core *pw_filter_get_core(struct pw_filter *filter);
156 
162 int
163 pw_filter_connect(struct pw_filter *filter,
164  enum pw_filter_flags flags,
165  const struct spa_pod **params,
166  uint32_t n_params );
167 
170 uint32_t
171 pw_filter_get_node_id(struct pw_filter *filter);
172 
174 int pw_filter_disconnect(struct pw_filter *filter);
175 
177 void *pw_filter_add_port(struct pw_filter *filter,
178  enum pw_direction direction,
179  enum pw_filter_port_flags flags,
180  size_t port_data_size,
181  struct pw_properties *props,
182  const struct spa_pod **params,
184  uint32_t n_params );
185 
187 int pw_filter_remove_port(void *port_data );
188 
190 const struct pw_properties *pw_filter_get_properties(struct pw_filter *filter,
191  void *port_data);
192 
194 int pw_filter_update_properties(struct pw_filter *filter,
195  void *port_data, const struct spa_dict *dict);
196 
198 int pw_filter_set_error(struct pw_filter *filter,
199  int res,
200  const char *error,
201  ...
202  ) SPA_PRINTF_FUNC(3, 4);
203 
205 int
206 pw_filter_update_params(struct pw_filter *filter,
207  void *port_data,
208  const struct spa_pod **params,
209  uint32_t n_params );
210 
211 
215 int pw_filter_get_time(struct pw_filter *filter, struct pw_time *time);
216 
219 struct pw_buffer *pw_filter_dequeue_buffer(void *port_data);
220 
222 int pw_filter_queue_buffer(void *port_data, struct pw_buffer *buffer);
223 
225 void *pw_filter_get_dsp_buffer(void *port_data, uint32_t n_samples);
226 
228 int pw_filter_set_active(struct pw_filter *filter, bool active);
229 
232 int pw_filter_flush(struct pw_filter *filter, bool drain);
233 
238 bool pw_filter_is_driving(struct pw_filter *filter);
239 
242 int pw_filter_trigger_process(struct pw_filter *filter);
243 
248 #ifdef __cplusplus
249 }
250 #endif
251 
252 #endif /* PIPEWIRE_FILTER_H */
spa/buffer/buffer.h
pipewire/core.h
struct pw_core * pw_filter_get_core(struct pw_filter *filter)
Definition: filter.c:1516
int pw_filter_remove_port(void *port_data)
remove a port from the filter
Definition: filter.c:1891
pw_filter_flags
Extra flags that can be used in pw_filter_connect()
Definition: filter.h:102
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
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
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
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:1998
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
enum pw_filter_state pw_filter_get_state(struct pw_filter *filter, const char **error)
Definition: filter.c:1508
uint32_t pw_filter_get_node_id(struct pw_filter *filter)
Get the node ID of the filter.
Definition: filter.c:1739
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
int pw_filter_set_error(struct pw_filter *filter, int res, const char *error,...) 1(3
Set the filter in error state.
const char * pw_filter_state_as_string(enum pw_filter_state state)
Convert a filter state to a readable string
Definition: filter.c:1367
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:2016
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
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:1929
pw_filter_port_flags
Definition: filter.h:127
int pw_filter_trigger_process(struct pw_filter *filter)
Trigger a push/pull on the filter.
Definition: filter.c:2115
int pw_filter_disconnect(struct pw_filter *filter)
Disconnect filter
Definition: filter.c:1745
pw_filter_state
The state of a filter
Definition: filter.h:42
int pw_filter_set_active(struct pw_filter *filter, bool active)
Activate or deactivate the filter
Definition: filter.c:1957
const char * pw_filter_get_name(struct pw_filter *filter)
Definition: filter.c:1522
void * pw_filter_get_dsp_buffer(void *port_data, uint32_t n_samples)
Get a data pointer to the buffer data.
Definition: filter.c:2025
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
bool pw_filter_is_driving(struct pw_filter *filter)
Check if the filter is driving.
Definition: filter.c:2085
int pw_filter_flush(struct pw_filter *filter, bool drain)
Flush a filter.
Definition: filter.c:2076
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
void pw_filter_destroy(struct pw_filter *filter)
Destroy a filter
Definition: filter.c:1426
@ PW_FILTER_FLAG_NONE
no flags
Definition: filter.h:103
@ 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
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
start the filter inactive, pw_filter_set_active() needs to be called explicitly
Definition: filter.h:104
@ PW_FILTER_FLAG_RT_PROCESS
call process from the realtime thread
Definition: filter.h:108
@ PW_FILTER_FLAG_ASYNC
Buffers will not be dequeued/queued from the realtime process() function.
Definition: filter.h:118
@ PW_FILTER_FLAG_DRIVER
be a driver
Definition: filter.h:107
@ PW_FILTER_PORT_FLAG_ALLOC_BUFFERS
the application will allocate buffer memory.
Definition: filter.h:130
@ PW_FILTER_PORT_FLAG_MAP_BUFFERS
mmap the buffers except DmaBuf
Definition: filter.h:129
@ PW_FILTER_PORT_FLAG_NONE
no flags
Definition: filter.h:128
@ PW_FILTER_STATE_STREAMING
filter is streaming
Definition: filter.h:47
@ PW_FILTER_STATE_ERROR
the stream is in error
Definition: filter.h:43
@ PW_FILTER_STATE_UNCONNECTED
unconnected
Definition: filter.h:44
@ PW_FILTER_STATE_CONNECTING
connection is in progress
Definition: filter.h:45
@ PW_FILTER_STATE_PAUSED
filter is connected and paused
Definition: filter.h:46
#define pw_direction
The direction of a port.
Definition: port.h:46
#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:196
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
struct spa_buffer * buffer
the spa buffer
Definition: stream.h:197
void * user_data
user data attached to the buffer
Definition: stream.h:198
Events for a filter.
Definition: filter.h:64
void(* process)(void *data, struct spa_io_position *position)
do processing.
Definition: 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: 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: filter.h:75
uint32_t version
Definition: filter.h:67
void(* drained)(void *data)
The filter is drained.
Definition: filter.h:92
void(* command)(void *data, const struct spa_command *command)
A command notify, Since 0.3.39:1.
Definition: filter.h:95
void(* remove_buffer)(void *data, void *port_data, struct pw_buffer *buffer)
when a buffer was destroyed for a port
Definition: 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: filter.h:82
void(* destroy)(void *data)
Definition: 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: filter.h:71
Definition: 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:295
A Buffer.
Definition: buffer.h:90
Definition: command.h:29
Definition: 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.h:43