25 #ifndef PIPEWIRE_FILTER_H 26 #define PIPEWIRE_FILTER_H 79 #define PW_VERSION_FILTER_EVENTS 0 82 void (*destroy) (
void *
data);
88 void (*io_changed) (
void *data,
void *port_data,
89 uint32_t id,
void *area, uint32_t
size);
91 void (*param_changed) (
void *data,
void *port_data,
105 void (*drained) (
void *data);
184 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:1451
#define pw_direction
The direction of a port.
Definition: port.h:56
Definition: properties.h:49
uint32_t pw_filter_get_node_id(struct pw_filter *filter)
Get the node ID of the filter.
Definition: filter.c:1536
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:295
Definition: src/pipewire/loop.h:47
A time structure.
Definition: stream.h:194
struct spa_dict dict
dictionary of key/values
Definition: properties.h:50
struct pw_core * pw_filter_get_core(struct pw_filter *filter)
Definition: filter.c:1400
enum pw_filter_state pw_filter_get_state(struct pw_filter *filter, const char **error)
Definition: filter.c:1392
uint32_t version
Definition: src/pipewire/filter.h:80
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:1632
the stream is in error
Definition: src/pipewire/filter.h:57
no flags
Definition: src/pipewire/filter.h:126
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:1267
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:1814
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:1743
void pw_filter_add_listener(struct pw_filter *filter, struct spa_hook *listener, const struct pw_filter_events *events, void *data)
Definition: filter.c:1377
int pw_filter_remove_port(void *port_data)
remove a port from the filter
Definition: filter.c:1700
Definition: utils/dict.h:48
#define SPA_PRINTF_FUNC(fmt, arg1)
Definition: defs.h:205
int pw_filter_set_error(struct pw_filter *filter, int res, const char *error,...) 1(3
Set the filter in error state.
unconnected
Definition: src/pipewire/filter.h:58
pw_filter_port_flags
Definition: src/pipewire/filter.h:125
mmap the buffers except DmaBuf
Definition: src/pipewire/filter.h:127
void * pw_filter_get_dsp_buffer(void *port_data, uint32_t n_samples)
Get a data pointer to the buffer data.
Definition: filter.c:1848
filter is connected and paused
Definition: src/pipewire/filter.h:60
call process from the realtime thread
Definition: src/pipewire/filter.h:118
int pw_filter_get_time(struct pw_filter *filter, struct pw_time *time)
Query the time on the filter.
Definition: filter.c:1776
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:1425
struct pw_filter * pw_filter_new(struct pw_core *core, const char *name, struct pw_properties *props)
Create a new unconneced PipeWire Filter.
Definition: filter.c:1245
start the filter inactive, pw_filter_set_active() needs to be called explicitly
Definition: src/pipewire/filter.h:114
connection is in progress
Definition: src/pipewire/filter.h:59
Events for a filter.
Definition: src/pipewire/filter.h:78
A Buffer.
Definition: buffer/buffer.h:93
the application will allocate buffer memory.
Definition: src/pipewire/filter.h:128
pw_filter_state
The state of a filter.
Definition: src/pipewire/filter.h:56
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:178
pw_filter_flags
Extra flags that can be used in pw_filter_connect()
Definition: src/pipewire/filter.h:112
filter is streaming
Definition: src/pipewire/filter.h:61
const char * pw_filter_state_as_string(enum pw_filter_state state)
Convert a filter state to a readable string.
Definition: filter.c:1312
be a driver
Definition: src/pipewire/filter.h:117
no flags
Definition: src/pipewire/filter.h:113
uint32_t state
one of enum spa_io_position_state
Definition: io.h:283
The position information adds extra meaning to the raw clock times.
Definition: io.h:274
struct spa_buffer * buffer
the spa buffer
Definition: stream.h:176
don't call the default latency algorithm but emit the param_changed event for the ports when Latency ...
Definition: src/pipewire/filter.h:120
int pw_filter_flush(struct pw_filter *filter, bool drain)
Flush a filter.
Definition: filter.c:1903
void pw_filter_destroy(struct pw_filter *filter)
Destroy a filter.
Definition: filter.c:1330
int pw_filter_set_active(struct pw_filter *filter, bool active)
Activate or deactivate the filter.
Definition: filter.c:1769
int pw_filter_disconnect(struct pw_filter *filter)
Disconnect filter.
Definition: filter.c:1542
const char * pw_filter_get_name(struct pw_filter *filter)
Definition: filter.c:1406
void * user_data
user data attached to the buffer
Definition: stream.h:177
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:1833
user data to add to an object
Definition: filter.c:75
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:1412