25 #ifndef PIPEWIRE_FILTER_H 26 #define PIPEWIRE_FILTER_H 43 #include <spa/buffer/buffer.h> 44 #include <spa/node/io.h> 45 #include <spa/param/param.h> 74 #define PW_VERSION_FILTER_EVENTS 0 84 uint32_t
id,
void *area, uint32_t size);
87 uint32_t
id,
const struct spa_pod *
param);
97 void (*
process) (
void *
data,
struct spa_io_position *position);
143 struct spa_hook *listener,
161 const struct spa_pod **params,
176 size_t port_data_size,
178 const struct spa_pod **params,
191 void *port_data,
const struct spa_dict *
dict);
196 const char *error, ... ) SPA_PRINTF_FUNC(3, 4);
202 const struct spa_pod **params,
210 struct spa_fraction
rate;
void(* destroy)(void *data)
Definition: filter.h:77
int pw_filter_remove_port(void *port_data)
remove a port from the filter
Definition: filter.c:1484
int pw_filter_set_error(struct pw_filter *filter, int res, const char *error,...) SPA_PRINTF_FUNC(3
Set the filter in error state.
uint64_t ticks
the ticks at now.
Definition: stream.h:186
connection is in progress
Definition: filter.h:54
A collection of key/value pairs.
Definition: properties.h:45
static uint32_t int int res
Definition: core.h:325
void(* drained)(void *data)
The filter is drained.
Definition: filter.h:100
pw_filter_flags
Extra flags that can be used in pw_filter_connect()
Definition: filter.h:107
be a driver
Definition: filter.h:112
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:1234
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:1617
void(* add_buffer)(void *data, void *port_data, struct pw_buffer *buffer)
when a new buffer was created for a port
Definition: filter.h:90
call process from the realtime thread
Definition: filter.h:113
buffer[1023]
Definition: core.h:330
start the filter inactive, pw_filter_set_active() needs to be called explicitly
Definition: filter.h:109
int64_t now
the monotonic time in nanoseconds
Definition: stream.h:184
filter is connected and paused
Definition: filter.h:55
PipeWire loop object provides an implementation of the spa loop interfaces.
Definition: loop.h:41
A time structure.
Definition: stream.h:183
the strean is in error
Definition: filter.h:52
struct spa_dict dict
dictionary of key/values
Definition: properties.h:46
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:1195
uint32_t version
Definition: filter.h:75
PipeWire filter object class.
struct spa_fraction rate
the rate of ticks and delay
Definition: stream.h:185
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:1414
int pw_filter_set_active(struct pw_filter *filter, bool active)
Activate or deactivate the filter.
Definition: filter.c:1553
void pw_filter_destroy(struct pw_filter *filter)
Destroy a filter.
Definition: filter.c:1127
the application will allocate buffer memory.
Definition: filter.h:120
void * pw_filter_get_dsp_buffer(void *port_data, uint32_t n_samples)
Get a data pointer to the buffer data.
Definition: filter.c:1632
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:79
unconnected
Definition: filter.h:53
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:1527
struct pw_core * pw_filter_get_core(struct pw_filter *filter)
Definition: filter.c:1183
const char * pw_filter_state_as_string(enum pw_filter_state state)
Convert a filter state to a readable string.
Definition: filter.c:1109
int pw_filter_disconnect(struct pw_filter *filter)
Disconnect filter.
Definition: filter.c:1324
pw_filter_port_flags
Definition: filter.h:117
no flags
Definition: filter.h:118
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:83
Events for a filter.
Definition: filter.h:73
int pw_filter_get_time(struct pw_filter *filter, struct pw_time *time)
Query the time on the filter.
Definition: filter.c:1560
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:167
void pw_filter_add_listener(struct pw_filter *filter, struct spa_hook *listener, const struct pw_filter_events *events, void *data)
Definition: filter.c:1166
void(* process)(void *data, struct spa_io_position *position)
do processing.
Definition: filter.h:97
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:1063
#define pw_direction
Definition: port.h:47
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:86
struct pw_filter * pw_filter_new(struct pw_core *core, const char *name, struct pw_properties *props)
Create a new unconneced pw_filter.
Definition: filter.c:1041
struct spa_buffer * buffer
the spa buffer
Definition: stream.h:165
static uint32_t id
Definition: core.h:325
no flags
Definition: filter.h:108
mmap the buffers except DmaBuf
Definition: filter.h:119
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:1598
uint32_t pw_filter_get_node_id(struct pw_filter *filter)
Get the node ID of the filter.
Definition: filter.c:1318
int pw_filter_flush(struct pw_filter *filter, bool drain)
Flush a filter.
Definition: filter.c:1687
const char * pw_filter_get_name(struct pw_filter *filter)
Definition: filter.c:1189
pw_filter_state
The state of a filter.
Definition: filter.h:51
enum pw_filter_state pw_filter_get_state(struct pw_filter *filter, const char **error)
Definition: filter.c:1175
filter is streaming
Definition: filter.h:56
void * user_data
user data attached to the buffer
Definition: stream.h:166
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:1208
void(* remove_buffer)(void *data, void *port_data, struct pw_buffer *buffer)
when a buffer was destroyed for a port
Definition: filter.h:92