PipeWire  0.3.61
utils.h
Go to the documentation of this file.
1 /* Simple Plugin API
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 SPA_DEVICE_UTILS_H
26 #define SPA_DEVICE_UTILS_H
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
32 #include <spa/pod/builder.h>
33 #include <spa/monitor/device.h>
34 
41  struct spa_pod_builder *builder;
43 };
44 
45 static inline void spa_result_func_device_params(void *data, int seq, int res,
46  uint32_t type, const void *result)
47 {
50  const struct spa_result_device_params *r =
51  (const struct spa_result_device_params *)result;
52  uint32_t offset = d->builder->state.offset;
54  return;
55  d->data.next = r->next;
56  d->data.param = spa_pod_builder_deref(d->builder, offset);
57 }
58 
59 static inline int spa_device_enum_params_sync(struct spa_device *device,
60  uint32_t id, uint32_t *index,
61  const struct spa_pod *filter,
62  struct spa_pod **param,
63  struct spa_pod_builder *builder)
64 {
66  struct spa_hook listener = {{0}};
67  static const struct spa_device_events device_events = {
69  .info = NULL,
71  };
72  int res;
73 
74  spa_device_add_listener(device, &listener, &device_events, &data);
75  res = spa_device_enum_params(device, 0, id, *index, 1, filter);
76  spa_hook_remove(&listener);
77 
78  if (data.data.param == NULL) {
79  if (res > 0)
80  res = 0;
81  } else {
82  *index = data.data.next;
83  *param = data.data.param;
84  res = 1;
85  }
86  return res;
87 }
88 
89 #define spa_device_emit(hooks,method,version,...) \
90  spa_hook_list_call_simple(hooks, struct spa_device_events, \
91  method, version, ##__VA_ARGS__)
92 
93 #define spa_device_emit_info(hooks,i) spa_device_emit(hooks,info, 0, i)
94 #define spa_device_emit_result(hooks,s,r,t,res) spa_device_emit(hooks,result, 0, s, r, t, res)
95 #define spa_device_emit_event(hooks,e) spa_device_emit(hooks,event, 0, e)
96 #define spa_device_emit_object_info(hooks,id,i) spa_device_emit(hooks,object_info, 0, id, i)
97 
102 #ifdef __cplusplus
103 } /* extern "C" */
104 #endif
105 
106 #endif /* SPA_DEVICE_UTILS_H */
spa/pod/builder.h
#define spa_device_enum_params(d,...)
Enumerate the parameters of a device.
Definition: device.h:288
static int spa_device_enum_params_sync(struct spa_device *device, uint32_t id, uint32_t *index, const struct spa_pod *filter, struct spa_pod **param, struct spa_pod_builder *builder)
Definition: utils.h:64
#define SPA_VERSION_DEVICE_EVENTS
version of the structure
Definition: device.h:142
#define spa_device_add_listener(d,...)
Set events to receive asynchronous notifications from the device.
Definition: device.h:282
static void spa_result_func_device_params(void *data, int seq, int res, uint32_t type, const void *result)
Definition: utils.h:50
static void spa_hook_remove(struct spa_hook *hook)
Remove a hook.
Definition: hook.h:392
static int spa_pod_builder_raw_padded(struct spa_pod_builder *builder, const void *data, uint32_t size)
Definition: builder.h:180
#define SPA_POD_SIZE(pod)
Definition: pod.h:50
static struct spa_pod * spa_pod_builder_deref(struct spa_pod_builder *builder, uint32_t offset)
Definition: builder.h:113
spa/monitor/device.h
spa_device_events:
Definition: device.h:139
uint32_t version
Definition: device.h:143
Definition: device.h:60
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:351
uint32_t offset
Definition: builder.h:53
Definition: builder.h:73
struct spa_pod_builder_state state
Definition: builder.h:77
Definition: pod.h:63
Definition: utils.h:45
struct spa_result_device_params data
Definition: utils.h:47
struct spa_pod_builder * builder
Definition: utils.h:46
Definition: device.h:116
uint32_t index
Definition: device.h:118
uint32_t next
Definition: device.h:119
struct spa_pod * param
Definition: device.h:120