5 #ifndef PIPEWIRE_FILTER_H
6 #define PIPEWIRE_FILTER_H
28 #include <spa/buffer/buffer.h>
29 #include <spa/node/io.h>
30 #include <spa/param/param.h>
31 #include <spa/pod/command.h>
33 #include <pipewire/core.h>
34 #include <pipewire/stream.h>
60 #define PW_VERSION_FILTER_EVENTS 1
70 uint32_t id,
void *area, uint32_t size);
73 uint32_t id,
const struct spa_pod *param);
180 size_t port_data_size,
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
void(* destroy)(void *data)
Definition: filter.h:69
#define pw_direction
The direction of a port.
Definition: port.h:46
Definition: properties.h:33
void(* drained)(void *data)
The filter is drained.
Definition: filter.h:92
uint32_t pw_filter_get_node_id(struct pw_filter *filter)
Get the node ID of the filter.
Definition: filter.c:1739
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
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:350
A time structure.
Definition: stream.h:295
struct spa_dict dict
dictionary of key/values
Definition: properties.h:34
struct pw_core * pw_filter_get_core(struct pw_filter *filter)
Definition: filter.c:1516
enum pw_filter_state pw_filter_get_state(struct pw_filter *filter, const char **error)
Definition: filter.c:1508
uint32_t version
Definition: filter.h:67
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
the stream is in error
Definition: filter.h:43
no flags
Definition: filter.h:128
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
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
the filter will not be scheduled automatically but _trigger_process() needs to be called...
Definition: filter.h:113
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
#define SPA_DEPRECATED
Definition: defs.h:283
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
int pw_filter_remove_port(void *port_data)
remove a port from the filter
Definition: filter.c:1891
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
int pw_filter_set_error(struct pw_filter *filter, int res, const char *error,...) 1(3
Set the filter in error state.
unconnected
Definition: filter.h:44
pw_filter_port_flags
Definition: filter.h:127
mmap the buffers except DmaBuf
Definition: filter.h:129
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
filter is connected and paused
Definition: filter.h:46
call process from the realtime thread
Definition: filter.h:108
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
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
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
start the filter inactive, pw_filter_set_active() needs to be called explicitly
Definition: filter.h:104
connection is in progress
Definition: filter.h:45
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
Events for a filter.
Definition: filter.h:64
A Buffer.
Definition: buffer.h:92
the application will allocate buffer memory.
Definition: filter.h:130
pw_filter_state
The state of a filter.
Definition: filter.h:42
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
pw_filter_flags
Extra flags that can be used in pw_filter_connect()
Definition: filter.h:102
filter is streaming
Definition: filter.h:47
const char * pw_filter_state_as_string(enum pw_filter_state state)
Convert a filter state to a readable string.
Definition: filter.c:1367
void(* process)(void *data, struct spa_io_position *position)
do processing.
Definition: filter.h:89
be a driver
Definition: filter.h:107
no flags
Definition: filter.h:103
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
Buffers will not be dequeued/queued from the realtime process() function.
Definition: filter.h:118
The position information adds extra meaning to the raw clock times.
Definition: io.h:282
struct spa_buffer * buffer
the spa buffer
Definition: stream.h:197
don't call the default latency algorithm but emit the param_changed event for the ports when Latency ...
Definition: filter.h:110
int pw_filter_flush(struct pw_filter *filter, bool drain)
Flush a filter.
Definition: filter.c:2076
void(* command)(void *data, const struct spa_command *command)
A command notify, Since 0.3.39:1.
Definition: filter.h:95
int pw_filter_trigger_process(struct pw_filter *filter)
Trigger a push/pull on the filter.
Definition: filter.c:2115
void pw_filter_destroy(struct pw_filter *filter)
Destroy a filter.
Definition: filter.c:1426
a buffer structure obtained from pw_stream_dequeue_buffer().
Definition: stream.h:196
bool pw_filter_is_driving(struct pw_filter *filter)
Check if the filter is driving.
Definition: filter.c:2085
int pw_filter_set_active(struct pw_filter *filter, bool active)
Activate or deactivate the filter.
Definition: filter.c:1957
int pw_filter_disconnect(struct pw_filter *filter)
Disconnect filter.
Definition: filter.c:1745
const char * pw_filter_get_name(struct pw_filter *filter)
Definition: filter.c:1522
void * user_data
user data attached to the buffer
Definition: stream.h:198
#define SPA_PRINTF_FUNC(fmt, arg1)
Definition: defs.h:277
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
void(* remove_buffer)(void *data, void *port_data, struct pw_buffer *buffer)
when a buffer was destroyed for a port
Definition: filter.h:84
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