PipeWire: pipewire/factory.h Source File

PipeWire 0.3.59

factory.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_FACTORY_H
26#define PIPEWIRE_FACTORY_H
27
28#ifdef __cplusplus
29extern "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
38#include <pipewire/proxy.h>
39
48#define PW_TYPE_INTERFACE_Factory PW_TYPE_INFO_INTERFACE_BASE "Factory"
49
50#define PW_VERSION_FACTORY 3
51struct pw_factory;
52
54struct pw_factory_info {
55 uint32_t id;
56 const char *name;
57 const char *type;
58 uint32_t version;
59#define PW_FACTORY_CHANGE_MASK_PROPS (1 << 0)
60#define PW_FACTORY_CHANGE_MASK_ALL ((1 << 1)-1)
61 uint64_t change_mask;
62 struct spa_dict *props;
63};
64
65 struct pw_factory_info *
66 pw_factory_info_update(struct pw_factory_info *info,
67 const struct pw_factory_info *update);
68struct pw_factory_info *
69 pw_factory_info_merge(struct pw_factory_info *info,
70 const struct pw_factory_info *update, bool reset);
71void
72 pw_factory_info_free(struct pw_factory_info *info);
73
74
75#define PW_FACTORY_EVENT_INFO 0
76#define PW_FACTORY_EVENT_NUM 1
77
79struct pw_factory_events {
80#define PW_VERSION_FACTORY_EVENTS 0
81 uint32_t version;
87 void (*info) (void *data, const struct pw_factory_info *info);
88};
89
90#define PW_FACTORY_METHOD_ADD_LISTENER 0
91#define PW_FACTORY_METHOD_NUM 1
92
94struct pw_factory_methods {
95#define PW_VERSION_FACTORY_METHODS 0
96 uint32_t version;
97
98 int (*add_listener) (void *object,
99 struct spa_hook *listener,
100 const struct pw_factory_events *events,
101 void *data);
102};
103
104#define pw_factory_method(o,method,version,...) \
105({ \
106 int _res = -ENOTSUP; \
107 spa_interface_call_res((struct spa_interface*)o, \
108 struct pw_factory_methods, _res, \
109 method, version, ##__VA_ARGS__); \
110 _res; \
111})
112
113#define pw_factory_add_listener(c,...) pw_factory_method(c,add_listener,0,__VA_ARGS__)
114
119#ifdef __cplusplus
120} /* extern "C" */
121#endif
122
123#endif /* PIPEWIRE_FACTORY_H */
defs.h
spa/utils/defs.h
pw_factory_info_merge
struct pw_factory_info * pw_factory_info_merge(struct pw_factory_info *info, const struct pw_factory_info *update, bool reset)
Definition: introspect.c:327
pw_factory_info_update
struct pw_factory_info * pw_factory_info_update(struct pw_factory_info *info, const struct pw_factory_info *update)
Definition: introspect.c:356
pw_factory_info_free
void pw_factory_info_free(struct pw_factory_info *info)
Definition: introspect.c:363
hook.h
spa/utils/hook.h
proxy.h
pipewire/proxy.h
pw_factory_events
Factory events.
Definition: factory.h:90
pw_factory_events::version
uint32_t version
Definition: factory.h:93
pw_factory_events::info
void(* info)(void *data, const struct pw_factory_info *info)
Notify factory info.
Definition: factory.h:99
pw_factory_info
The factory information.
Definition: factory.h:61
pw_factory_info::version
uint32_t version
version of the objects
Definition: factory.h:65
pw_factory_info::type
const char * type
type of the objects created by this factory
Definition: factory.h:64
pw_factory_info::id
uint32_t id
id of the global
Definition: factory.h:62
pw_factory_info::change_mask
uint64_t change_mask
bitfield of changed fields since last call
Definition: factory.h:70
pw_factory_methods
Factory methods.
Definition: factory.h:108
pw_factory_methods::version
uint32_t version
Definition: factory.h:111
pw_factory_methods::add_listener
int(* add_listener)(void *object, struct spa_hook *listener, const struct pw_factory_events *events, void *data)
Definition: factory.h:113
pw_factory
spa_dict
Definition: dict.h:59
spa_hook
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:351