PipeWire: spa/monitor/device.h Source File

PipeWire 0.3.51

device.h
Go to the documentation of this file.
1/* Simple Plugin API
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 SPA_DEVICE_H
26#define SPA_DEVICE_H
27
28#ifdef __cplusplus
29extern "C" {
30#endif
31
32#include <spa/utils/defs.h>
33#include <spa/utils/hook.h>
34#include <spa/utils/dict.h>
35#include <spa/pod/event.h>
36
50#define SPA_TYPE_INTERFACE_Device SPA_TYPE_INFO_INTERFACE_BASE "Device"
51
52#define SPA_VERSION_DEVICE 0
53struct spa_device { struct spa_interface iface; };
54
60 struct spa_device_info {
61#define SPA_VERSION_DEVICE_INFO 0
62 uint32_t version;
63
64#define SPA_DEVICE_CHANGE_MASK_FLAGS (1u<<0)
65#define SPA_DEVICE_CHANGE_MASK_PROPS (1u<<1)
66#define SPA_DEVICE_CHANGE_MASK_PARAMS (1u<<2)
67 uint64_t change_mask;
68 uint64_t flags;
69 const struct spa_dict *props;
70 struct spa_param_info *params;
71 uint32_t n_params;
72};
73
74#define SPA_DEVICE_INFO_INIT() (struct spa_device_info){ SPA_VERSION_DEVICE_INFO, }
75
81 struct spa_device_object_info {
82#define SPA_VERSION_DEVICE_OBJECT_INFO 0
83 uint32_t version;
84
85 const char *type;
86 const char *factory_name;
88#define SPA_DEVICE_OBJECT_CHANGE_MASK_FLAGS (1u<<0)
89#define SPA_DEVICE_OBJECT_CHANGE_MASK_PROPS (1u<<1)
90 uint64_t change_mask;
91 uint64_t flags;
92 const struct spa_dict *props;
93};
94
95#define SPA_DEVICE_OBJECT_INFO_INIT() (struct spa_device_object_info){ SPA_VERSION_DEVICE_OBJECT_INFO, }
96
98#define SPA_RESULT_TYPE_DEVICE_PARAMS 1
99 struct spa_result_device_params {
100 uint32_t id;
101 uint32_t index;
102 uint32_t next;
103 struct spa_pod *param;
104};
105
106#define SPA_DEVICE_EVENT_INFO 0
107#define SPA_DEVICE_EVENT_RESULT 1
108#define SPA_DEVICE_EVENT_EVENT 2
109#define SPA_DEVICE_EVENT_OBJECT_INFO 3
110#define SPA_DEVICE_EVENT_NUM 4
111
117 struct spa_device_events {
119#define SPA_VERSION_DEVICE_EVENTS 0
120 uint32_t version;
121
123 void (*info) (void *data, const struct spa_device_info *info);
124
126 void (*result) (void *data, int seq, int res, uint32_t type, const void *result);
127
129 void (*event) (void *data, const struct spa_event *event);
130
133 void (*object_info) (void *data, uint32_t id,
134 const struct spa_device_object_info *info);
135};
136
137#define SPA_DEVICE_METHOD_ADD_LISTENER 0
138#define SPA_DEVICE_METHOD_SYNC 1
139#define SPA_DEVICE_METHOD_ENUM_PARAMS 2
140#define SPA_DEVICE_METHOD_SET_PARAM 3
141#define SPA_DEVICE_METHOD_NUM 4
142
146 struct spa_device_methods {
147 /* the version of the methods. This can be used to expand this
148 * structure in the future */
149#define SPA_VERSION_DEVICE_METHODS 0
150 uint32_t version;
151
167 int (*add_listener) (void *object,
168 struct spa_hook *listener,
169 const struct spa_device_events *events,
170 void *data);
186 int (*sync) (void *object, int seq);
187
213 int (*enum_params) (void *object, int seq,
214 uint32_t id, uint32_t index, uint32_t max,
215 const struct spa_pod *filter);
216
238 int (*set_param) (void *object,
239 uint32_t id, uint32_t flags,
240 const struct spa_pod *param);
241};
242
243#define spa_device_method(o,method,version,...) \
244({ \
245 int _res = -ENOTSUP; \
246 struct spa_device *_o = o; \
247 spa_interface_call_res(&_o->iface, \
248 struct spa_device_methods, _res, \
249 method, version, ##__VA_ARGS__); \
250 _res; \
251})
252
253#define spa_device_add_listener(d,...) spa_device_method(d, add_listener, 0, __VA_ARGS__)
254#define spa_device_sync(d,...) spa_device_method(d, sync, 0, __VA_ARGS__)
255#define spa_device_enum_params(d,...) spa_device_method(d, enum_params, 0, __VA_ARGS__)
256#define spa_device_set_param(d,...) spa_device_method(d, set_param, 0, __VA_ARGS__)
257
258#define SPA_KEY_DEVICE_ENUM_API "device.enum.api"
260#define SPA_KEY_DEVICE_API "device.api"
262#define SPA_KEY_DEVICE_NAME "device.name"
263#define SPA_KEY_DEVICE_ALIAS "device.alias"
264#define SPA_KEY_DEVICE_NICK "device.nick"
265#define SPA_KEY_DEVICE_DESCRIPTION "device.description"
266#define SPA_KEY_DEVICE_ICON "device.icon"
268#define SPA_KEY_DEVICE_ICON_NAME "device.icon-name"
270#define SPA_KEY_DEVICE_PLUGGED_USEC "device.plugged.usec"
272#define SPA_KEY_DEVICE_BUS_ID "device.bus-id"
273#define SPA_KEY_DEVICE_BUS_PATH "device.bus-path"
276#define SPA_KEY_DEVICE_BUS "device.bus"
279#define SPA_KEY_DEVICE_SUBSYSTEM "device.subsystem"
280#define SPA_KEY_DEVICE_SYSFS_PATH "device.sysfs.path"
282#define SPA_KEY_DEVICE_VENDOR_ID "device.vendor.id"
283#define SPA_KEY_DEVICE_VENDOR_NAME "device.vendor.name"
284#define SPA_KEY_DEVICE_PRODUCT_ID "device.product.id"
285#define SPA_KEY_DEVICE_PRODUCT_NAME "device.product.name"
286#define SPA_KEY_DEVICE_SERIAL "device.serial"
287#define SPA_KEY_DEVICE_CLASS "device.class"
288#define SPA_KEY_DEVICE_CAPABILITIES "device.capabilities"
289#define SPA_KEY_DEVICE_FORM_FACTOR "device.form-factor"
294#define SPA_KEY_DEVICE_PROFILE "device.profile "
295#define SPA_KEY_DEVICE_PROFILE_SET "device.profile-set"
296#define SPA_KEY_DEVICE_STRING "device.string"
303#ifdef __cplusplus
304} /* extern "C" */
305#endif
306
307#endif /* SPA_DEVICE_H */
defs.h
spa/utils/defs.h
hook.h
spa/utils/hook.h
event.h
spa/pod/event.h
spa_device_events
spa_device_events:
Definition: device.h:139
spa_device_events::result
void(* result)(void *data, int seq, int res, uint32_t type, const void *result)
notify a result
Definition: device.h:149
spa_device_events::event
void(* event)(void *data, const struct spa_event *event)
a device event
Definition: device.h:152
spa_device_events::info
void(* info)(void *data, const struct spa_device_info *info)
notify extra information about the device
Definition: device.h:146
spa_device_events::object_info
void(* object_info)(void *data, uint32_t id, const struct spa_device_object_info *info)
info changed for an object managed by the device, info is NULL when the object is removed
Definition: device.h:156
spa_device_events::version
uint32_t version
Definition: device.h:143
spa_device_info
Information about the device and parameters it supports.
Definition: device.h:67
spa_device_info::flags
uint64_t flags
Definition: device.h:79
spa_device_info::params
struct spa_param_info * params
supported parameters
Definition: device.h:81
spa_device_info::version
uint32_t version
Definition: device.h:70
spa_device_info::n_params
uint32_t n_params
number of elements in params
Definition: device.h:82
spa_device_info::change_mask
uint64_t change_mask
Definition: device.h:78
spa_device_methods
spa_device_methods:
Definition: device.h:174
spa_device_methods::version
uint32_t version
Definition: device.h:179
spa_device_methods::sync
int(* sync)(void *object, int seq)
Perform a sync operation.
Definition: device.h:215
spa_device_methods::enum_params
int(* enum_params)(void *object, int seq, uint32_t id, uint32_t index, uint32_t max, const struct spa_pod *filter)
Enumerate the parameters of a device.
Definition: device.h:242
spa_device_methods::set_param
int(* set_param)(void *object, uint32_t id, uint32_t flags, const struct spa_pod *param)
Set the configurable parameter in device.
Definition: device.h:267
spa_device_methods::add_listener
int(* add_listener)(void *object, struct spa_hook *listener, const struct spa_device_events *events, void *data)
Set events to receive asynchronous notifications from the device.
Definition: device.h:196
spa_device_object_info
Information about a device object.
Definition: device.h:93
spa_device_object_info::version
uint32_t version
Definition: device.h:96
spa_device_object_info::type
const char * type
the object type managed by this device
Definition: device.h:98
spa_device_object_info::change_mask
uint64_t change_mask
Definition: device.h:105
spa_device_object_info::factory_name
const char * factory_name
a factory name that implements the object
Definition: device.h:99
spa_device_object_info::flags
uint64_t flags
Definition: device.h:106
spa_device
Definition: device.h:60
spa_device::iface
struct spa_interface iface
Definition: device.h:60
spa_dict
Definition: dict.h:59
spa_event
Definition: event.h:48
spa_hook
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:351
spa_interface
Definition: hook.h:158
spa_param_info
information about a parameter
Definition: param.h:70
spa_pod
Definition: pod.h:63
spa_result_device_params
Definition: device.h:116
spa_result_device_params::id
uint32_t id
Definition: device.h:117
spa_result_device_params::index
uint32_t index
Definition: device.h:118
spa_result_device_params::next
uint32_t next
Definition: device.h:119
spa_result_device_params::param
struct spa_pod * param
Definition: device.h:120
dict.h
spa/utils/dict.h