PipeWire  0.3.29
src/pipewire/filter.h
Go to the documentation of this file.
1 /* PipeWire
2  *
3  * Copyright © 2019 Wim Taymans
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a
6  * copy of this software and associated documentation files (the "Software"),
7  * to deal in the Software without restriction, including without limitation
8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9  * and/or sell copies of the Software, and to permit persons to whom the
10  * Software is furnished to do so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice (including the next
13  * paragraph) shall be included in all copies or substantial portions of the
14  * Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22  * DEALINGS IN THE SOFTWARE.
23  */
24 
25 #ifndef PIPEWIRE_FILTER_H
26 #define PIPEWIRE_FILTER_H
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
46 struct pw_filter;
47 
48 #include <spa/buffer/buffer.h>
49 #include <spa/node/io.h>
50 #include <spa/param/param.h>
51 
52 #include <pipewire/core.h>
53 #include <pipewire/stream.h>
54 
62 };
63 
64 #if 0
65 struct pw_buffer {
66  struct spa_buffer *buffer;
67  void *user_data;
68  uint64_t size;
73 };
74 #endif
75 
79 #define PW_VERSION_FILTER_EVENTS 0
80  uint32_t version;
81 
82  void (*destroy) (void *data);
84  void (*state_changed) (void *data, enum pw_filter_state old,
85  enum pw_filter_state state, const char *error);
86 
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,
92  uint32_t id, const struct spa_pod *param);
93 
95  void (*add_buffer) (void *data, void *port_data, struct pw_buffer *buffer);
97  void (*remove_buffer) (void *data, void *port_data, struct pw_buffer *buffer);
98 
102  void (*process) (void *data, struct spa_io_position *position);
103 
105  void (*drained) (void *data);
106 };
107 
110 
120 };
121 
128 };
129 
132 struct pw_filter *
133 pw_filter_new(struct pw_core *core,
134  const char *name,
135  struct pw_properties *props );
136 
137 struct pw_filter *
138 pw_filter_new_simple(struct pw_loop *loop,
139  const char *name,
140  struct pw_properties *props,
141  const struct pw_filter_events *events,
142  void *data );
143 
145 void pw_filter_destroy(struct pw_filter *filter);
146 
147 void pw_filter_add_listener(struct pw_filter *filter,
148  struct spa_hook *listener,
149  const struct pw_filter_events *events,
150  void *data);
151 
152 enum pw_filter_state pw_filter_get_state(struct pw_filter *filter, const char **error);
153 
154 const char *pw_filter_get_name(struct pw_filter *filter);
155 
156 struct pw_core *pw_filter_get_core(struct pw_filter *filter);
157 
163 int
164 pw_filter_connect(struct pw_filter *filter,
165  enum pw_filter_flags flags,
166  const struct spa_pod **params,
167  uint32_t n_params );
168 
171 uint32_t
172 pw_filter_get_node_id(struct pw_filter *filter);
173 
175 int pw_filter_disconnect(struct pw_filter *filter);
176 
178 void *pw_filter_add_port(struct pw_filter *filter,
179  enum pw_direction direction,
180  enum pw_filter_port_flags flags,
181  size_t port_data_size,
182  struct pw_properties *props,
183  const struct spa_pod **params,
185  uint32_t n_params );
186 
188 int pw_filter_remove_port(void *port_data );
189 
191 const struct pw_properties *pw_filter_get_properties(struct pw_filter *filter,
192  void *port_data);
193 
195 int pw_filter_update_properties(struct pw_filter *filter,
196  void *port_data, const struct spa_dict *dict);
197 
199 int pw_filter_set_error(struct pw_filter *filter,
200  int res,
201  const char *error,
202  ...
203  ) SPA_PRINTF_FUNC(3, 4);
204 
206 int
207 pw_filter_update_params(struct pw_filter *filter,
208  void *port_data,
209  const struct spa_pod **params,
210  uint32_t n_params );
211 
212 
213 #if 0
214 
215 struct pw_time {
216  int64_t now;
217  struct spa_fraction rate;
218  uint64_t ticks;
220 };
221 #endif
222 
224 int pw_filter_get_time(struct pw_filter *filter, struct pw_time *time);
225 
228 struct pw_buffer *pw_filter_dequeue_buffer(void *port_data);
229 
231 int pw_filter_queue_buffer(void *port_data, struct pw_buffer *buffer);
232 
234 void *pw_filter_get_dsp_buffer(void *port_data, uint32_t n_samples);
235 
237 int pw_filter_set_active(struct pw_filter *filter, bool active);
238 
241 int pw_filter_flush(struct pw_filter *filter, bool drain);
242 
247 #ifdef __cplusplus
248 }
249 #endif
250 
251 #endif /* PIPEWIRE_FILTER_H */
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:1271
void(* destroy)(void *data)
Definition: src/pipewire/filter.h:82
int pw_filter_set_error(struct pw_filter *filter, int res, const char *error,...) SPA_PRINTF_FUNC(3
Set the filter in error state.
#define pw_direction
The direction of a port.
Definition: port.h:56
uint64_t ticks
the ticks at now.
Definition: stream.h:197
Definition: properties.h:49
void(* drained)(void *data)
The filter is drained.
Definition: src/pipewire/filter.h:105
uint32_t pw_filter_get_node_id(struct pw_filter *filter)
Get the node ID of the filter.
Definition: filter.c:1351
void(* add_buffer)(void *data, void *port_data, struct pw_buffer *buffer)
when a new buffer was created for a port
Definition: src/pipewire/filter.h:95
int64_t now
the monotonic time in nanoseconds
Definition: stream.h:195
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:76
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:1220
enum pw_filter_state pw_filter_get_state(struct pw_filter *filter, const char **error)
Definition: filter.c:1212
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:1447
the stream is in error
Definition: src/pipewire/filter.h:57
struct spa_fraction rate
the rate of ticks and delay
Definition: stream.h:196
no flags
Definition: src/pipewire/filter.h:123
static uint32_t int int res
Definition: core.h:328
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:1087
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:1629
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:1558
void pw_filter_add_listener(struct pw_filter *filter, struct spa_hook *listener, const struct pw_filter_events *events, void *data)
Definition: filter.c:1197
int pw_filter_remove_port(void *port_data)
remove a port from the filter
Definition: filter.c:1515
Definition: utils/dict.h:48
#define SPA_PRINTF_FUNC(fmt, arg1)
Definition: defs.h:203
void(* state_changed)(void *data, enum pw_filter_state old, enum pw_filter_state state, const char *error)
when the filter state changes
Definition: src/pipewire/filter.h:84
static uint32_t id
Definition: core.h:328
unconnected
Definition: src/pipewire/filter.h:58
Definition: defs.h:103
pw_filter_port_flags
Definition: src/pipewire/filter.h:122
mmap the buffers except DmaBuf
Definition: src/pipewire/filter.h:124
void * pw_filter_get_dsp_buffer(void *port_data, uint32_t n_samples)
Get a data pointer to the buffer data.
Definition: filter.c:1663
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:1591
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:1245
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:1065
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
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: src/pipewire/filter.h:88
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:125
pw_filter_state
The state of a filter.
Definition: src/pipewire/filter.h:56
Definition: pod/pod.h:50
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:1132
buffer[1023]
Definition: core.h:333
void(* process)(void *data, struct spa_io_position *position)
do processing.
Definition: src/pipewire/filter.h:102
be a driver
Definition: src/pipewire/filter.h:117
Definition: filter.c:80
no flags
Definition: src/pipewire/filter.h:113
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: src/pipewire/filter.h:91
uint32_t state
one of enum spa_io_position_state
Definition: io.h:283
Definition: filter.c:124
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
int pw_filter_flush(struct pw_filter *filter, bool drain)
Flush a filter.
Definition: filter.c:1718
Definition: filter.c:59
void pw_filter_destroy(struct pw_filter *filter)
Destroy a filter.
Definition: filter.c:1150
Definition: stream.h:175
int pw_filter_set_active(struct pw_filter *filter, bool active)
Activate or deactivate the filter.
Definition: filter.c:1584
int pw_filter_disconnect(struct pw_filter *filter)
Disconnect filter.
Definition: filter.c:1357
const char * pw_filter_get_name(struct pw_filter *filter)
Definition: filter.c:1226
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:1648
Definition: filter.c:75
void(* remove_buffer)(void *data, void *port_data, struct pw_buffer *buffer)
when a buffer was destroyed for a port
Definition: src/pipewire/filter.h:97
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:1232