PipeWire: device.h Source File

PipeWire 0.3.7

device.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_DEVICE_H
26 #define PIPEWIRE_DEVICE_H
27
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31
32 #include <spa/utils/defs.h>
33 #include <spa/utils/hook.h>
34
35 #include <pipewire/proxy.h>
36
37 #define PW_TYPE_INTERFACE_Device PW_TYPE_INFO_INTERFACE_BASE "Device"
38
39 #define PW_VERSION_DEVICE 3
40 struct pw_device;
41
43 struct pw_device_info {
44 uint32_t id;
45 #define PW_DEVICE_CHANGE_MASK_PROPS (1 << 0)
46 #define PW_DEVICE_CHANGE_MASK_PARAMS (1 << 1)
47 #define PW_DEVICE_CHANGE_MASK_ALL ((1 << 2)-1)
48 uint64_t change_mask;
49 struct spa_dict *props;
50 struct spa_param_info *params;
51 uint32_t n_params;
52 };
53
55 struct pw_device_info *
56 pw_device_info_update(struct pw_device_info *info,
57 const struct pw_device_info *update);
58
60 void pw_device_info_free(struct pw_device_info *info);
61
62 #define PW_DEVICE_EVENT_INFO 0
63 #define PW_DEVICE_EVENT_PARAM 1
64 #define PW_DEVICE_EVENT_NUM 2
65
67 struct pw_device_events {
68 #define PW_VERSION_DEVICE_EVENTS 0
69 uint32_t version;
75 void (*info) (void *object, const struct pw_device_info *info);
87 void (*param) (void *object, int seq,
88 uint32_t id, uint32_t index, uint32_t next,
89 const struct spa_pod *param);
90 };
91
92
93 #define PW_DEVICE_METHOD_ADD_LISTENER 0
94 #define PW_DEVICE_METHOD_SUBSCRIBE_PARAMS 1
95 #define PW_DEVICE_METHOD_ENUM_PARAMS 2
96 #define PW_DEVICE_METHOD_SET_PARAM 3
97 #define PW_DEVICE_METHOD_NUM 4
98
100 struct pw_device_methods {
101 #define PW_VERSION_DEVICE_METHODS 0
102 uint32_t version;
103
104 int (*add_listener) (void *object,
105 struct spa_hook *listener,
106 const struct pw_device_events *events,
107 void *data);
117 int (*subscribe_params) (void *object, uint32_t *ids, uint32_t n_ids);
118
131 int (*enum_params) (void *object, int seq, uint32_t id, uint32_t start, uint32_t num,
132 const struct spa_pod *filter);
140 int (*set_param) (void *object, uint32_t id, uint32_t flags,
141 const struct spa_pod *param);
142 };
143
144 #define pw_device_method(o,method,version,...) \
145 ({ \
146 int _res = -ENOTSUP; \
147 spa_interface_call_res((struct spa_interface*)o, \
148 struct pw_device_methods, _res, \
149 method, version, ##__VA_ARGS__); \
150 _res; \
151 })
152
153 #define pw_device_add_listener(c,...) pw_device_method(c,add_listener,0,__VA_ARGS__)
154 #define pw_device_subscribe_params(c,...) pw_device_method(c,subscribe_params,0,__VA_ARGS__)
155 #define pw_device_enum_params(c,...) pw_device_method(c,enum_params,0,__VA_ARGS__)
156 #define pw_device_set_param(c,...) pw_device_method(c,set_param,0,__VA_ARGS__)
157
158 #ifdef __cplusplus
159 } /* extern "C" */
160 #endif
161
162 #endif /* PIPEWIRE_DEVICE_H */
id
static uint32_t id
Definition: core.h:322
pw_device_info::props
struct spa_dict * props
extra properties
Definition: device.h:49
pw_device_methods::set_param
int(* set_param)(void *object, uint32_t id, uint32_t flags, const struct spa_pod *param)
Set a parameter on the device.
Definition: device.h:140
data
Definition: filter.c:71
pw_device_info::change_mask
uint64_t change_mask
bitfield of changed fields since last call
Definition: device.h:48
pw_device_events::param
void(* param)(void *object, int seq, uint32_t id, uint32_t index, uint32_t next, const struct spa_pod *param)
Notify a device param.
Definition: device.h:87
pw_device_methods::subscribe_params
int(* subscribe_params)(void *object, uint32_t *ids, uint32_t n_ids)
Subscribe to parameter changes.
Definition: device.h:117
pw_device_methods::add_listener
int(* add_listener)(void *object, struct spa_hook *listener, const struct pw_device_events *events, void *data)
Definition: device.h:104
pw_device_methods
Device methods.
Definition: device.h:100
pw_device_events::version
uint32_t version
Definition: device.h:69
pw_device_methods::version
uint32_t version
Definition: device.h:102
filter
Definition: filter.c:113
pw_device_info::params
struct spa_param_info * params
parameters
Definition: device.h:50
pw_introspect::pw_device_info_free
void pw_device_info_free(struct pw_device_info *info)
Free a pw_device_info.
Definition: introspect.c:412
pw_device_info::n_params
uint32_t n_params
number of items in params
Definition: device.h:51
proxy.h
pw_device_info
The device information.
Definition: device.h:43
param
Definition: filter.c:76
seq
static uint32_t int seq
Definition: core.h:322
pw_device_events::info
void(* info)(void *object, const struct pw_device_info *info)
Notify device info.
Definition: device.h:75
pw_device_info::id
uint32_t id
id of the global
Definition: device.h:44
pw_device_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 device parameters.
Definition: device.h:131
pw_introspect::pw_device_info_update
struct pw_device_info * pw_device_info_update(struct pw_device_info *info, const struct pw_device_info *update)
Update and existing pw_device_info with update.
Definition: introspect.c:368
pw_device_events
Device events.
Definition: device.h:67