PipeWire: node.h Source File

PipeWire 0.3.4

node.h
Go to the documentation of this file.
1 /* PipeWire
2 *
3 * Copyright © 2018 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_NODE_H
26 #define PIPEWIRE_NODE_H
27
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31
32 #include <stdarg.h>
33 #include <errno.h>
34
35 #include <spa/utils/defs.h>
36 #include <spa/utils/hook.h>
37 #include <spa/node/command.h>
38 #include <spa/param/param.h>
39
40 #include <pipewire/proxy.h>
41
42 #define PW_TYPE_INTERFACE_Node PW_TYPE_INFO_INTERFACE_BASE "Node"
43
44 #define PW_VERSION_NODE 3
45 struct pw_node;
46
48 enum pw_node_state {
49 PW_NODE_STATE_ERROR = -1,
50 PW_NODE_STATE_CREATING = 0,
51 PW_NODE_STATE_SUSPENDED = 1,
53 PW_NODE_STATE_IDLE = 2,
55 PW_NODE_STATE_RUNNING = 3,
56 };
57
59 const char * pw_node_state_as_string(enum pw_node_state state);
60
62 struct pw_node_info {
63 uint32_t id;
64 uint32_t max_input_ports;
65 uint32_t max_output_ports;
66 #define PW_NODE_CHANGE_MASK_INPUT_PORTS (1 << 0)
67 #define PW_NODE_CHANGE_MASK_OUTPUT_PORTS (1 << 1)
68 #define PW_NODE_CHANGE_MASK_STATE (1 << 2)
69 #define PW_NODE_CHANGE_MASK_PROPS (1 << 3)
70 #define PW_NODE_CHANGE_MASK_PARAMS (1 << 4)
71 #define PW_NODE_CHANGE_MASK_ALL ((1 << 5)-1)
72 uint64_t change_mask;
73 uint32_t n_input_ports;
74 uint32_t n_output_ports;
75 enum pw_node_state state;
76 const char *error;
77 struct spa_dict *props;
78 struct spa_param_info *params;
79 uint32_t n_params;
80 };
81
82 struct pw_node_info *
83 pw_node_info_update(struct pw_node_info *info,
84 const struct pw_node_info *update);
85
86 void
87 pw_node_info_free(struct pw_node_info *info);
88
89 #define PW_NODE_EVENT_INFO 0
90 #define PW_NODE_EVENT_PARAM 1
91 #define PW_NODE_EVENT_NUM 2
92
94 struct pw_node_events {
95 #define PW_VERSION_NODE_EVENTS 0
96 uint32_t version;
102 void (*info) (void *object, const struct pw_node_info *info);
114 void (*param) (void *object, int seq,
115 uint32_t id, uint32_t index, uint32_t next,
116 const struct spa_pod *param);
117 };
118
119 #define PW_NODE_METHOD_ADD_LISTENER 0
120 #define PW_NODE_METHOD_SUBSCRIBE_PARAMS 1
121 #define PW_NODE_METHOD_ENUM_PARAMS 2
122 #define PW_NODE_METHOD_SET_PARAM 3
123 #define PW_NODE_METHOD_SEND_COMMAND 4
124 #define PW_NODE_METHOD_NUM 5
125
127 struct pw_node_methods {
128 #define PW_VERSION_NODE_METHODS 0
129 uint32_t version;
130
131 int (*add_listener) (void *object,
132 struct spa_hook *listener,
133 const struct pw_node_events *events,
134 void *data);
144 int (*subscribe_params) (void *object, uint32_t *ids, uint32_t n_ids);
145
158 int (*enum_params) (void *object, int seq, uint32_t id,
159 uint32_t start, uint32_t num,
160 const struct spa_pod *filter);
161
169 int (*set_param) (void *object, uint32_t id, uint32_t flags,
170 const struct spa_pod *param);
171
177 int (*send_command) (void *object, const struct spa_command *command);
178 };
179
180 #define pw_node_method(o,method,version,...) \
181 ({ \
182 int _res = -ENOTSUP; \
183 spa_interface_call_res((struct spa_interface*)o, \
184 struct pw_node_methods, _res, \
185 method, version, ##__VA_ARGS__); \
186 _res; \
187 })
188
190 #define pw_node_add_listener(c,...) pw_node_method(c,add_listener,0,__VA_ARGS__)
191 #define pw_node_subscribe_params(c,...) pw_node_method(c,subscribe_params,0,__VA_ARGS__)
192 #define pw_node_enum_params(c,...) pw_node_method(c,enum_params,0,__VA_ARGS__)
193 #define pw_node_set_param(c,...) pw_node_method(c,set_param,0,__VA_ARGS__)
194 #define pw_node_send_command(c,...) pw_node_method(c,send_command,0,__VA_ARGS__)
195
196 #ifdef __cplusplus
197 } /* extern "C" */
198 #endif
199
200 #endif /* PIPEWIRE_NODE_H */
pw_node_info_update
struct pw_node_info * pw_node_info_update(struct pw_node_info *info, const struct pw_node_info *update)
Definition: introspect.c:168
pw_node_info::props
struct spa_dict * props
the properties of the node
Definition: node.h:77
id
static uint32_t id
Definition: core.h:322
pw_node_info::n_params
uint32_t n_params
number of items in params
Definition: node.h:79
pw_node_info::params
struct spa_param_info * params
parameters
Definition: node.h:78
data
Definition: filter.c:70
pw_node_info_free
void pw_node_info_free(struct pw_node_info *info)
Definition: introspect.c:226
pw_node_info::n_input_ports
uint32_t n_input_ports
number of inputs
Definition: node.h:73
PW_NODE_STATE_RUNNING
@ PW_NODE_STATE_RUNNING
the node is running
Definition: node.h:55
pw_node_methods::enum_params
int(* enum_params)(void *object, int seq, uint32_t id, uint32_t start, uint32_t num, const struct spa_pod *filter)
Enumerate node parameters.
Definition: node.h:158
pw_node_info::id
uint32_t id
id of the global
Definition: node.h:63
filter
Definition: filter.c:112
pw_node_methods::add_listener
int(* add_listener)(void *object, struct spa_hook *listener, const struct pw_node_events *events, void *data)
Definition: node.h:131
pw_node_methods
Node methods.
Definition: node.h:127
PW_NODE_STATE_CREATING
@ PW_NODE_STATE_CREATING
the node is being created
Definition: node.h:50
pw_node_info::n_output_ports
uint32_t n_output_ports
number of outputs
Definition: node.h:74
pw_node_events
Node events.
Definition: node.h:94
proxy.h
pw_node_info::max_input_ports
uint32_t max_input_ports
maximum number of inputs
Definition: node.h:64
pw_node_methods::set_param
int(* set_param)(void *object, uint32_t id, uint32_t flags, const struct spa_pod *param)
Set a parameter on the node.
Definition: node.h:169
pw_node_events::param
void(* param)(void *object, int seq, uint32_t id, uint32_t index, uint32_t next, const struct spa_pod *param)
Notify a node param.
Definition: node.h:114
param
Definition: filter.c:75
PW_NODE_STATE_SUSPENDED
@ PW_NODE_STATE_SUSPENDED
the node is suspended, the device might be closed
Definition: node.h:51
pw_node_state_as_string
SPA_EXPORT const char * pw_node_state_as_string(enum pw_node_state state)
Definition: introspect.c:34
pw_node_events::info
void(* info)(void *object, const struct pw_node_info *info)
Notify node info.
Definition: node.h:102
pw_node_info::state
enum pw_node_state state
the current state of the node
Definition: node.h:75
pw_node_events::version
uint32_t version
Definition: node.h:96
pw_node_methods::send_command
int(* send_command)(void *object, const struct spa_command *command)
Send a command to the node.
Definition: node.h:177
seq
static uint32_t int seq
Definition: core.h:322
pw_node_info::error
const char * error
an error reason if state is error
Definition: node.h:76
pw_node_methods::version
uint32_t version
Definition: node.h:129
PW_NODE_STATE_ERROR
@ PW_NODE_STATE_ERROR
error state
Definition: node.h:49
pw_node_state
pw_node_state
Definition: node.h:48
PW_NODE_STATE_IDLE
@ PW_NODE_STATE_IDLE
the node is running but there is no active port
Definition: node.h:53
pw_node_info::change_mask
uint64_t change_mask
bitfield of changed fields since last call
Definition: node.h:72
pw_node_methods::subscribe_params
int(* subscribe_params)(void *object, uint32_t *ids, uint32_t n_ids)
Subscribe to parameter changes.
Definition: node.h:144
pw_node_info
The node information.
Definition: node.h:62
pw_node_info::max_output_ports
uint32_t max_output_ports
maximum number of outputs
Definition: node.h:65