Go to the documentation of this file.
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;
parameters to map a memory range
Definition: mem.h:176
static uint32_t int int res
Definition: core.h:326
void * user_data
user data attached to the buffer
Definition: stream.h:166
struct spa_param_info params[5]
Definition: filter.c:102
static uint32_t id
Definition: core.h:325
struct pw_context * context
Definition: filter.c:121
uint64_t base_pos
Definition: filter.c:145
uint32_t clock_id
Definition: filter.c:146
@ PW_FILTER_FLAG_RT_PROCESS
call process from the realtime thread
Definition: filter.h:113
struct pw_filter this
Definition: filter.c:117
#define PW_KEY_FORMAT_DSP
format related properties
Definition: keys.h:277
SPA_EXPORT 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
int pw_filter_get_time(struct pw_filter *filter, struct pw_time *time)
Query the time on the filter.
Definition: filter.c:1560
PipeWire filter object class.
#define pw_log_error(...)
Log an error message.
@ PW_FILTER_FLAG_INACTIVE
start the filter inactive, pw_filter_set_active() needs to be called explicitly
Definition: filter.h:109
SPA_EXPORT 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_proxy_error(struct pw_proxy *proxy, int res, const char *error)
Generate an error for a proxy.
Definition: proxy.c:341
const char * pw_filter_get_name(struct pw_filter *filter)
Definition: filter.c:1189
#define MASK_BUFFERS
Definition: filter.c:50
struct spa_port_info info
Definition: filter.c:100
@ PW_FILTER_STATE_UNCONNECTED
unconnected
Definition: filter.h:53
struct pw_properties * props
Definition: filter.c:97
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 queue dequeued
Definition: filter.c:109
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
#define BUFFER_FLAG_MAPPED
Definition: filter.c:61
pw_filter_state
The state of a filter.
Definition: filter.h:51
@ PW_FILTER_PORT_FLAG_MAP_BUFFERS
mmap the buffers except DmaBuf
Definition: filter.h:119
enum pw_filter_flags flags
Definition: filter.c:123
struct spa_callbacks callbacks
Definition: filter.c:127
struct spa_list param_list
Definition: impl-device.c:39
int pw_core_disconnect(struct pw_core *core)
disconnect and destroy a core
Definition: core.c:492
struct spa_io_buffers * io
Definition: filter.c:104
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
PipeWire loop object provides an implementation of the spa loop interfaces.
Definition: loop.h:41
struct spa_hook filter_listener
Definition: filter.c:76
void(* drained)(void *data)
The filter is drained.
Definition: filter.h:100
SPA_EXPORT const char * pw_filter_get_name(struct pw_filter *filter)
Definition: filter.c:1189
void pw_context_destroy(struct pw_context *context)
destroy a context object, all resources except the main_loop will be destroyed
@ PW_FILTER_STATE_ERROR
the strean is in error
Definition: filter.h:52
#define pw_direction
Definition: port.h:47
A time structure.
Definition: stream.h:183
SPA_EXPORT 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
SPA_EXPORT void pw_proxy_destroy(struct pw_proxy *proxy)
Destroy a proxy object.
Definition: proxy.c:232
#define MAX_PORTS
Definition: filter.c:51
int pw_filter_remove_port(void *port_data)
remove a port from the filter
Definition: filter.c:1484
uint32_t pw_filter_get_node_id(struct pw_filter *filter)
Get the node ID of the filter.
Definition: filter.c:1318
Proxy events, use pw_proxy_add_listener.
Definition: proxy.h:106
uint32_t ids[MAX_BUFFERS]
Definition: filter.c:68
static uint32_t int int const char int r
Definition: core.h:338
int pw_filter_set_error(struct pw_filter *filter, int res, const char *error,...) SPA_PRINTF_FUNC(3
Set the filter in error state.
SPA_EXPORT 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 id
Definition: filter.c:80
int64_t delay
delay to device, add to ticks to get the time of the device.
Definition: stream.h:188
void(* remove_buffer)(void *data, void *port_data, struct pw_buffer *buffer)
when a buffer was destroyed for a port
Definition: filter.h:92
SPA_EXPORT int pw_filter_flush(struct pw_filter *filter, bool drain)
Flush a filter.
Definition: filter.c:1687
struct spa_list port_list
Definition: filter.c:134
uintptr_t seq
Definition: filter.c:143
struct spa_dict dict
dictionary of key/values
Definition: properties.h:46
unsigned int allow_mlock
Definition: filter.c:152
void(* destroy)(void *data)
Definition: filter.h:77
#define PW_KEY_NODE_LATENCY
the requested latency of the node as a fraction.
Definition: keys.h:144
uint64_t ticks
the ticks at now.
Definition: stream.h:186
SPA_EXPORT 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
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
@ PW_FILTER_STATE_CONNECTING
connection is in progress
Definition: filter.h:54
struct spa_list link
Definition: filter.c:88
struct spa_pod * param
Definition: filter.c:84
struct pw_port * port
Definition: filter.c:95
void(* process)(void *data, struct spa_io_position *position)
do processing.
Definition: filter.h:97
#define pw_log(lev,...)
Definition: log.h:76
struct spa_node impl_node
Definition: filter.c:125
#define PW_VERSION_PROXY_EVENTS
Definition: proxy.h:107
@ PW_FILTER_STATE_PAUSED
filter is connected and paused
Definition: filter.h:55
#define PARAM_FLAG_LOCKED
Definition: filter.c:81
uint32_t change_mask_all
Definition: filter.c:137
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
buffer[1023]
Definition: core.h:330
pw_filter_flags
Extra flags that can be used in pw_filter_connect()
Definition: filter.h:107
struct data data
Definition: filter.c:142
int64_t now
the monotonic time in nanoseconds
Definition: stream.h:184
static uint32_t int int const char * message
Definition: core.h:326
#define pw_log_debug(...)
Log a debug message.
#define pw_log_warn(...)
Log a warning message.
#define BUFFER_FLAG_ADDED
Definition: filter.c:63
#define PW_KEY_APP_PROCESS_BINARY
binary name
Definition: keys.h:109
#define NAME
Definition: filter.c:45
SPA_EXPORT int pw_properties_update(struct pw_properties *props, const struct spa_dict *dict)
Update properties.
Definition: properties.c:281
#define pw_core_add_listener(c,...)
Definition: core.h:316
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 version
Definition: filter.h:75
struct pw_proxy * pw_core_export(struct pw_core *core, const char *type, const struct spa_dict *props, void *object, size_t user_data_size)
Export an object into the PipeWire instance associated with core.
Definition: core.c:277
struct spa_hook_list hooks
Definition: filter.c:126
int pw_filter_flush(struct pw_filter *filter, bool drain)
Flush a filter.
Definition: filter.c:1687
@ PW_FILTER_PORT_FLAG_NONE
no flags
Definition: filter.h:118
@ PW_FILTER_STATE_STREAMING
filter is streaming
Definition: filter.h:56
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
const char * path
Definition: filter.c:119
#define PW_KEY_NODE_NAME
node name
Definition: keys.h:128
uint32_t change_mask_all
Definition: filter.c:99
uint32_t port_id
Definition: buffers.c:47
SPA_EXPORT 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
uint32_t flags
Definition: filter.c:94
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_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
#define MAX_SAMPLES
Definition: filter.c:47
static uint32_t int int const char va_list args
Definition: core.h:327
struct spa_param_info params[5]
Definition: filter.c:140
#define PW_VERSION_CORE_EVENTS
Definition: core.h:106
@ PW_FILTER_PORT_FLAG_ALLOC_BUFFERS
the application will allocate buffer memory.
Definition: filter.h:120
enum pw_filter_state pw_filter_get_state(struct pw_filter *filter, const char **error)
Definition: filter.c:1175
#define PW_KEY_MEDIA_NAME
media name.
Definition: keys.h:261
struct pw_context * pw_context_new(struct pw_loop *main_loop, struct pw_properties *props, size_t user_data_size)
Make a new context object for a given main_loop.
int pw_filter_set_active(struct pw_filter *filter, bool active)
Activate or deactivate the filter.
Definition: filter.c:1553
unsigned int draining
Definition: filter.c:151
SPA_EXPORT struct pw_properties * pw_properties_copy(const struct pw_properties *properties)
Copy a properties object.
Definition: properties.c:223
struct pw_core * pw_filter_get_core(struct pw_filter *filter)
Definition: filter.c:1183
SPA_EXPORT int pw_properties_set(struct pw_properties *properties, const char *key, const char *value)
Set a property value.
Definition: properties.c:419
SPA_EXPORT 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(* 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
uint8_t user_data[0]
Definition: filter.c:113
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
SPA_EXPORT 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
SPA_EXPORT int pw_filter_remove_port(void *port_data)
remove a port from the filter
Definition: filter.c:1484
#define pw_log_trace(...)
Log a trace message.
uint32_t flags
Definition: filter.c:82
SPA_EXPORT struct pw_core * pw_filter_get_core(struct pw_filter *filter)
Definition: filter.c:1183
void pw_proxy_add_listener(struct pw_proxy *proxy, struct spa_hook *listener, const struct pw_proxy_events *events, void *data)
Add an event listener to proxy.
Definition: proxy.c:197
SPA_EXPORT const char * pw_properties_get(const struct pw_properties *properties, const char *key)
Get a property.
Definition: properties.c:475
#define BUFFER_FLAG_QUEUED
Definition: filter.c:62
SPA_EXPORT enum pw_filter_state pw_filter_get_state(struct pw_filter *filter, const char **error)
Definition: filter.c:1175
Events for a filter.
Definition: filter.h:73
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
uint32_t id
Definition: filter.c:60
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 spa_node_info info
Definition: filter.c:138
unsigned int warn_mlock
Definition: filter.c:153
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
unsigned int disconnecting
Definition: filter.c:148
struct spa_buffer * buffer
the spa buffer
Definition: stream.h:165
struct spa_list param_list
Definition: filter.c:101
struct pw_buffer this
Definition: filter.c:59
unsigned int disconnect_core
Definition: filter.c:149
struct pw_control this
Definition: control.c:34
#define PW_KEY_APP_NAME
application keys
Definition: keys.h:98
pw_filter_port_flags
Definition: filter.h:117
struct spa_ringbuffer ring
Definition: filter.c:69
unsigned int process_rt
Definition: filter.c:154
@ PW_FILTER_FLAG_NONE
no flags
Definition: filter.h:108
SPA_EXPORT 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
void pw_filter_destroy(struct pw_filter *filter)
Destroy a filter.
Definition: filter.c:1127
SPA_EXPORT struct pw_properties * pw_properties_new(const char *key,...)
Make a new properties object.
Definition: properties.c:99
struct spa_list link
Definition: filter.c:83
static uint32_t int seq
Definition: core.h:325
const char * pw_filter_state_as_string(enum pw_filter_state state)
Convert a filter state to a readable string.
Definition: filter.c:1109
#define PW_ID_CORE
Definition: core.h:49
unsigned int subscribe
Definition: filter.c:150
SPA_EXPORT int pw_filter_set_error(struct pw_filter *filter, int res, const char *error,...)
Definition: filter.c:1503
#define pw_loop_invoke(l,...)
Definition: loop.h:57
int pw_filter_disconnect(struct pw_filter *filter)
Disconnect filter.
Definition: filter.c:1324
struct buffer buffers[MAX_BUFFERS]
Definition: filter.c:106
struct port * ports[2][MAX_PORTS]
Definition: filter.c:135
@ PW_FILTER_FLAG_DRIVER
be a driver
Definition: filter.h:112
uint64_t incount
Definition: filter.c:70
enum spa_direction direction
Definition: buffers.c:46
SPA_EXPORT struct pw_core * pw_context_connect(struct pw_context *context, struct pw_properties *properties, size_t user_data_size)
Definition: core.c:405
uint32_t flags
Definition: filter.c:64
struct spa_fraction rate
the rate of ticks and delay
Definition: stream.h:185
struct filter * filter
Definition: filter.c:90
struct spa_list param_list
Definition: filter.c:139
struct spa_io_position * position
Definition: filter.c:128
uint32_t n_buffers
Definition: filter.c:107
uint32_t id
Definition: filter.c:93
struct pw_context * context
Definition: filter.c:75
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
struct queue queued
Definition: filter.c:110
struct pw_time time
Definition: filter.c:144
A collection of key/value pairs.
Definition: properties.h:45
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
SPA_EXPORT void pw_properties_free(struct pw_properties *properties)
Free a properties object.
Definition: properties.c:353
#define MAX_BUFFERS
Definition: filter.c:48
Core events.
Definition: core.h:105
uint64_t outcount
Definition: filter.c:71