PipeWire: port.h Source File

PipeWire 0.3.67

Loading...
Searching...
No Matches
port.h
Go to the documentation of this file.
1/* PipeWire */
2/* SPDX-FileCopyrightText: Copyright © 2018 Wim Taymans */
3/* SPDX-License-Identifier: MIT */
4
5#ifndef PIPEWIRE_PORT_H
6#define PIPEWIRE_PORT_H
7
8#ifdef __cplusplus
9extern "C" {
10#endif
11
12#include <stdarg.h>
13#include <errno.h>
14
15#include <spa/utils/defs.h>
16#include <spa/utils/hook.h>
17#include <spa/param/param.h>
18
19#include <pipewire/proxy.h>
20
30#define PW_TYPE_INTERFACE_Port PW_TYPE_INFO_INTERFACE_BASE "Port"
31
32#define PW_VERSION_PORT 3
33struct pw_port;
34
36#define pw_direction spa_direction
37#define PW_DIRECTION_INPUT SPA_DIRECTION_INPUT
38#define PW_DIRECTION_OUTPUT SPA_DIRECTION_OUTPUT
39
41const char * pw_direction_as_string(enum pw_direction direction);
42
43 struct pw_port_info {
44 uint32_t id;
45 enum pw_direction direction;
46#define PW_PORT_CHANGE_MASK_PROPS (1 << 0)
47#define PW_PORT_CHANGE_MASK_PARAMS (1 << 1)
48#define PW_PORT_CHANGE_MASK_ALL ((1 << 2)-1)
49 uint64_t change_mask;
50 struct spa_dict *props;
51 struct spa_param_info *params;
52 uint32_t n_params;
53};
54
55struct pw_port_info *
56 pw_port_info_update(struct pw_port_info *info,
57 const struct pw_port_info *update);
58
59struct pw_port_info *
60 pw_port_info_merge(struct pw_port_info *info,
61 const struct pw_port_info *update, bool reset);
62
63 void
64 pw_port_info_free(struct pw_port_info *info);
65
66#define PW_PORT_EVENT_INFO 0
67#define PW_PORT_EVENT_PARAM 1
68#define PW_PORT_EVENT_NUM 2
69
71struct pw_port_events {
72#define PW_VERSION_PORT_EVENTS 0
73 uint32_t version;
79 void (*info) (void *data, const struct pw_port_info *info);
91 void (*param) (void *data, int seq,
92 uint32_t id, uint32_t index, uint32_t next,
93 const struct spa_pod *param);
94};
95
96#define PW_PORT_METHOD_ADD_LISTENER 0
97#define PW_PORT_METHOD_SUBSCRIBE_PARAMS 1
98#define PW_PORT_METHOD_ENUM_PARAMS 2
99#define PW_PORT_METHOD_NUM 3
100
102struct pw_port_methods {
103#define PW_VERSION_PORT_METHODS 0
104 uint32_t version;
105
106 int (*add_listener) (void *object,
107 struct spa_hook *listener,
108 const struct pw_port_events *events,
109 void *data);
119 int (*subscribe_params) (void *object, uint32_t *ids, uint32_t n_ids);
120
133 int (*enum_params) (void *object, int seq,
134 uint32_t id, uint32_t start, uint32_t num,
135 const struct spa_pod *filter);
136};
137
138#define pw_port_method(o,method,version,...) \
139({ \
140 int _res = -ENOTSUP; \
141 spa_interface_call_res((struct spa_interface*)o, \
142 struct pw_port_methods, _res, \
143 method, version, ##__VA_ARGS__); \
144 _res; \
145})
146
147#define pw_port_add_listener(c,...) pw_port_method(c,add_listener,0,__VA_ARGS__)
148#define pw_port_subscribe_params(c,...) pw_port_method(c,subscribe_params,0,__VA_ARGS__)
149#define pw_port_enum_params(c,...) pw_port_method(c,enum_params,0,__VA_ARGS__)
150
155#ifdef __cplusplus
156} /* extern "C" */
157#endif
158
159#endif /* PIPEWIRE_PORT_H */
defs.h
spa/utils/defs.h
pw_direction_as_string
const char * pw_direction_as_string(enum pw_direction direction)
Convert a pw_direction to a readable string.
Definition: introspect.c:32
pw_port_info_free
void pw_port_info_free(struct pw_port_info *info)
Definition: introspect.c:304
pw_port_info_update
struct pw_port_info * pw_port_info_update(struct pw_port_info *info, const struct pw_port_info *update)
Definition: introspect.c:297
pw_direction
#define pw_direction
The direction of a port.
Definition: port.h:43
pw_port_info_merge
struct pw_port_info * pw_port_info_merge(struct pw_port_info *info, const struct pw_port_info *update, bool reset)
Definition: introspect.c:241
hook.h
spa/utils/hook.h
param.h
spa/param/param.h
proxy.h
pipewire/proxy.h
pw_port_events
Port events.
Definition: port.h:86
pw_port_events::info
void(* info)(void *data, const struct pw_port_info *info)
Notify port info.
Definition: port.h:95
pw_port_events::version
uint32_t version
Definition: port.h:89
pw_port_events::param
void(* param)(void *data, int seq, uint32_t id, uint32_t index, uint32_t next, const struct spa_pod *param)
Notify a port param.
Definition: port.h:107
pw_port_info
Definition: port.h:52
pw_port_info::n_params
uint32_t n_params
number of items in params
Definition: port.h:64
pw_port_info::params
struct spa_param_info * params
parameters
Definition: port.h:63
pw_port_info::change_mask
uint64_t change_mask
bitfield of changed fields since last call
Definition: port.h:61
pw_port_info::id
uint32_t id
id of the global
Definition: port.h:53
pw_port_info::direction
enum pw_direction direction
port direction
Definition: port.h:54
pw_port_methods
Port methods.
Definition: port.h:122
pw_port_methods::subscribe_params
int(* subscribe_params)(void *object, uint32_t *ids, uint32_t n_ids)
Subscribe to parameter changes.
Definition: port.h:140
pw_port_methods::version
uint32_t version
Definition: port.h:125
pw_port_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 port parameters.
Definition: port.h:154
pw_port_methods::add_listener
int(* add_listener)(void *object, struct spa_hook *listener, const struct pw_port_events *events, void *data)
Definition: port.h:127
pw_port
spa_dict
Definition: utils/dict.h:39
spa_hook
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:331
spa_param_info
information about a parameter
Definition: param.h:50
spa_pod
Definition: pod/pod.h:43