filter.h
Go to the documentation of this file.
/* PipeWire
*
* Copyright © 2019 Wim Taymans
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice (including the next
* paragraph) shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*/
#ifndef PIPEWIRE_FILTER_H
#define PIPEWIRE_FILTER_H
#ifdef __cplusplus
extern "C" {
#endif
struct pw_filter;
#include <spa/buffer/buffer.h>
#include <spa/node/io.h>
#include <spa/param/param.h>
#include <spa/pod/command.h>
#include <pipewire/core.h>
#include <pipewire/stream.h>
enum pw_filter_state {
PW_FILTER_STATE_ERROR = -1,
PW_FILTER_STATE_UNCONNECTED = 0,
PW_FILTER_STATE_CONNECTING = 1,
PW_FILTER_STATE_PAUSED = 2,
PW_FILTER_STATE_STREAMING = 3
};
#if 0
struct pw_buffer {
struct spa_buffer *buffer;
void *user_data;
uint64_t size;
};
#endif
struct pw_filter_events {
#define PW_VERSION_FILTER_EVENTS 1
uint32_t version;
void (*destroy) (void *data);
void (*state_changed) (void *data, enum pw_filter_state old,
enum pw_filter_state state, const char *error);
void (*io_changed) (void *data, void *port_data,
uint32_t id, void *area, uint32_t size);
void (*param_changed) (void *data, void *port_data,
uint32_t id, const struct spa_pod *param);
void (*add_buffer) (void *data, void *port_data, struct pw_buffer *buffer);
void (*remove_buffer) (void *data, void *port_data, struct pw_buffer *buffer);
void (*process) (void *data, struct spa_io_position *position);
void (*drained) (void *data);
void (*command) (void *data, const struct spa_command *command);
};
const char * pw_filter_state_as_string(enum pw_filter_state state);
enum pw_filter_flags {
PW_FILTER_FLAG_NONE = 0,
PW_FILTER_FLAG_INACTIVE = (1 << 0),
PW_FILTER_FLAG_DRIVER = (1 << 1),
PW_FILTER_FLAG_RT_PROCESS = (1 << 2),
PW_FILTER_FLAG_CUSTOM_LATENCY = (1 << 3),
};
enum pw_filter_port_flags {
PW_FILTER_PORT_FLAG_NONE = 0,
PW_FILTER_PORT_FLAG_MAP_BUFFERS = (1 << 0),
PW_FILTER_PORT_FLAG_ALLOC_BUFFERS = (1 << 1),
};
struct pw_filter *
pw_filter_new(struct pw_core *core,
const char *name,
struct pw_properties *props );
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 );
void pw_filter_destroy(struct pw_filter *filter);
void pw_filter_add_listener(struct pw_filter *filter,
struct spa_hook *listener,
const struct pw_filter_events *events,
void *data);
enum pw_filter_state pw_filter_get_state(struct pw_filter *filter, const char **error);
const char *pw_filter_get_name(struct pw_filter *filter);
struct pw_core *pw_filter_get_core(struct pw_filter *filter);
int
pw_filter_connect(struct pw_filter *filter,
enum pw_filter_flags flags,
const struct spa_pod **params,
uint32_t n_params );
uint32_t
pw_filter_get_node_id(struct pw_filter *filter);
int pw_filter_disconnect(struct pw_filter *filter);
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 );
int pw_filter_remove_port(void *port_data );
const struct pw_properties *pw_filter_get_properties(struct pw_filter *filter,
void *port_data);
int pw_filter_update_properties(struct pw_filter *filter,
void *port_data, const struct spa_dict *dict);
int pw_filter_set_error(struct pw_filter *filter,
int res,
const char *error,
...
) SPA_PRINTF_FUNC(3, 4);
int
pw_filter_update_params(struct pw_filter *filter,
void *port_data,
const struct spa_pod **params,
uint32_t n_params );
#if 0
struct pw_time {
int64_t now;
struct spa_fraction rate;
uint64_t ticks;
};
#endif
int pw_filter_get_time(struct pw_filter *filter, struct pw_time *time);
struct pw_buffer *pw_filter_dequeue_buffer(void *port_data);
int pw_filter_queue_buffer(void *port_data, struct pw_buffer *buffer);
void *pw_filter_get_dsp_buffer(void *port_data, uint32_t n_samples);
int pw_filter_set_active(struct pw_filter *filter, bool active);
int pw_filter_flush(struct pw_filter *filter, bool drain);
#ifdef __cplusplus
}
#endif
#endif /* PIPEWIRE_FILTER_H */
buffer.h
spa/buffer/buffer.h
core.h
pipewire/core.h
pw_filter_get_core
struct pw_core * pw_filter_get_core(struct pw_filter *filter)
Definition: filter.c:1418
pw_filter_remove_port
int pw_filter_remove_port(void *port_data)
remove a port from the filter
Definition: filter.c:1716
pw_filter_flags
pw_filter_flags
Extra flags that can be used in pw_filter_connect()
Definition: filter.h:122
pw_filter_connect
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:1469
pw_filter_new
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:1260
pw_filter_add_port
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:1648
pw_filter_dequeue_buffer
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:1830
pw_filter_add_listener
void pw_filter_add_listener(struct pw_filter *filter, struct spa_hook *listener, const struct pw_filter_events *events, void *data)
Definition: filter.c:1395
pw_filter_get_state
enum pw_filter_state pw_filter_get_state(struct pw_filter *filter, const char **error)
Definition: filter.c:1410
pw_filter_get_node_id
uint32_t pw_filter_get_node_id(struct pw_filter *filter)
Get the node ID of the filter.
Definition: filter.c:1553
pw_filter_get_properties
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:1430
pw_filter_set_error
int pw_filter_set_error(struct pw_filter *filter, int res, const char *error,...) 1(3
Set the filter in error state.
pw_filter_state_as_string
const char * pw_filter_state_as_string(enum pw_filter_state state)
Convert a filter state to a readable string
Definition: filter.c:1327
pw_filter_queue_buffer
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:1849
pw_filter_new_simple
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:1282
pw_filter_update_params
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:1759
pw_filter_port_flags
pw_filter_port_flags
Definition: filter.h:135
pw_filter_disconnect
int pw_filter_disconnect(struct pw_filter *filter)
Disconnect filter
Definition: filter.c:1559
pw_filter_state
pw_filter_state
The state of a filter
Definition: filter.h:62
pw_filter_set_active
int pw_filter_set_active(struct pw_filter *filter, bool active)
Activate or deactivate the filter
Definition: filter.c:1785
pw_filter_get_name
const char * pw_filter_get_name(struct pw_filter *filter)
Definition: filter.c:1424
pw_filter_get_dsp_buffer
void * pw_filter_get_dsp_buffer(void *port_data, uint32_t n_samples)
Get a data pointer to the buffer data.
Definition: filter.c:1864
pw_filter_get_time
int pw_filter_get_time(struct pw_filter *filter, struct pw_time *time)
Query the time on the filter
Definition: filter.c:1792
pw_filter_flush
int pw_filter_flush(struct pw_filter *filter, bool drain)
Flush a filter.
Definition: filter.c:1919
pw_filter_update_properties
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:1443
pw_filter_destroy
void pw_filter_destroy(struct pw_filter *filter)
Destroy a filter
Definition: filter.c:1345
PW_FILTER_FLAG_NONE
@ PW_FILTER_FLAG_NONE
no flags
Definition: filter.h:123
PW_FILTER_FLAG_CUSTOM_LATENCY
@ 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:130
PW_FILTER_FLAG_INACTIVE
@ PW_FILTER_FLAG_INACTIVE
start the filter inactive, pw_filter_set_active() needs to be called explicitly
Definition: filter.h:124
PW_FILTER_FLAG_RT_PROCESS
@ PW_FILTER_FLAG_RT_PROCESS
call process from the realtime thread
Definition: filter.h:128
PW_FILTER_FLAG_DRIVER
@ PW_FILTER_FLAG_DRIVER
be a driver
Definition: filter.h:127
PW_FILTER_PORT_FLAG_ALLOC_BUFFERS
@ PW_FILTER_PORT_FLAG_ALLOC_BUFFERS
the application will allocate buffer memory.
Definition: filter.h:138
PW_FILTER_PORT_FLAG_MAP_BUFFERS
@ PW_FILTER_PORT_FLAG_MAP_BUFFERS
mmap the buffers except DmaBuf
Definition: filter.h:137
PW_FILTER_PORT_FLAG_NONE
@ PW_FILTER_PORT_FLAG_NONE
no flags
Definition: filter.h:136
PW_FILTER_STATE_STREAMING
@ PW_FILTER_STATE_STREAMING
filter is streaming
Definition: filter.h:67
PW_FILTER_STATE_ERROR
@ PW_FILTER_STATE_ERROR
the stream is in error
Definition: filter.h:63
PW_FILTER_STATE_UNCONNECTED
@ PW_FILTER_STATE_UNCONNECTED
unconnected
Definition: filter.h:64
PW_FILTER_STATE_CONNECTING
@ PW_FILTER_STATE_CONNECTING
connection is in progress
Definition: filter.h:65
PW_FILTER_STATE_PAUSED
@ PW_FILTER_STATE_PAUSED
filter is connected and paused
Definition: filter.h:66
pw_direction
#define pw_direction
The direction of a port.
Definition: port.h:63
SPA_PRINTF_FUNC
#define SPA_PRINTF_FUNC(fmt, arg1)
Definition: defs.h:260
io.h
spa/node/io.h
param.h
spa/param/param.h
command.h
spa/pod/command.h
stream.h
pipewire/stream.h
pw_buffer
Definition: stream.h:181
pw_buffer::size
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:184
pw_buffer::buffer
struct spa_buffer * buffer
the spa buffer
Definition: stream.h:182
pw_buffer::user_data
void * user_data
user data attached to the buffer
Definition: stream.h:183
pw_core
pw_filter_events
Events for a filter.
Definition: filter.h:84
pw_filter_events::process
void(* process)(void *data, struct spa_io_position *position)
do processing.
Definition: filter.h:109
pw_filter_events::param_changed
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:98
pw_filter_events::io_changed
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:95
pw_filter_events::version
uint32_t version
Definition: filter.h:87
pw_filter_events::drained
void(* drained)(void *data)
The filter is drained.
Definition: filter.h:112
pw_filter_events::command
void(* command)(void *data, const struct spa_command *command)
A command notify, Since 0.3.39:1.
Definition: filter.h:115
pw_filter_events::remove_buffer
void(* remove_buffer)(void *data, void *port_data, struct pw_buffer *buffer)
when a buffer was destroyed for a port
Definition: filter.h:104
pw_filter_events::add_buffer
void(* add_buffer)(void *data, void *port_data, struct pw_buffer *buffer)
when a new buffer was created for a port
Definition: filter.h:102
pw_filter_events::destroy
void(* destroy)(void *data)
Definition: filter.h:89
pw_filter_events::state_changed
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:91
pw_filter
pw_loop
Definition: loop.h:51
pw_properties
Definition: properties.h:53
pw_properties::dict
struct spa_dict dict
dictionary of key/values
Definition: properties.h:54
pw_time
A time structure.
Definition: stream.h:200
pw_time::rate
struct spa_fraction rate
the rate of ticks and delay
Definition: stream.h:202
pw_time::ticks
uint64_t ticks
the ticks at now.
Definition: stream.h:203
pw_time::now
int64_t now
the monotonic time in nanoseconds
Definition: stream.h:201
spa_buffer
A Buffer.
Definition: buffer.h:105
spa_command
Definition: command.h:49
spa_dict
Definition: dict.h:59
spa_fraction
Definition: defs.h:121
spa_hook
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:342
spa_io_position
The position information adds extra meaning to the raw clock times.
Definition: io.h:293
spa_pod
Definition: pod.h:63