PipeWire: spa/support/plugin.h Source File

PipeWire 0.3.51

plugin.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_PLUGIN_H
26#define SPA_PLUGIN_H
27
28#ifdef __cplusplus
29extern "C" {
30#endif
31
32#include <spa/utils/defs.h>
33#include <spa/utils/dict.h>
34
45struct spa_handle {
47#define SPA_VERSION_HANDLE 0
48 uint32_t version;
49
63 int (*get_interface) (struct spa_handle *handle, const char *type, void **interface);
71 int (*clear) (struct spa_handle *handle);
72};
73
74#define spa_handle_get_interface(h,...) (h)->get_interface((h),__VA_ARGS__)
75#define spa_handle_clear(h) (h)->clear((h))
76
81 struct spa_interface_info {
82 const char *type; /*< the type of the interface, can be
83 * used to get the interface */
84};
85
90struct spa_support {
91 const char *type; /*< the type of the support item */
92 void *data; /*< specific data for the item */
93};
94
96 static inline void *spa_support_find(const struct spa_support *support,
97 uint32_t n_support,
98 const char *type)
99{
100 uint32_t i;
101 for (i = 0; i < n_support; i++) {
102 if (strcmp(support[i].type, type) == 0)
103 return support[i].data;
104 }
105 return NULL;
106}
107
108#define SPA_SUPPORT_INIT(type,data) (struct spa_support) { (type), (data) }
109
110struct spa_handle_factory {
112#define SPA_VERSION_HANDLE_FACTORY 1
113 uint32_t version;
127 const char *name;
131 const struct spa_dict *info;
139 size_t (*get_size) (const struct spa_handle_factory *factory,
140 const struct spa_dict *params);
141
158 int (*init) (const struct spa_handle_factory *factory,
159 struct spa_handle *handle,
160 const struct spa_dict *info,
161 const struct spa_support *support,
162 uint32_t n_support);
163
176 int (*enum_interface_info) (const struct spa_handle_factory *factory,
177 const struct spa_interface_info **info,
178 uint32_t *index);
179};
180
181#define spa_handle_factory_get_size(h,...) (h)->get_size((h),__VA_ARGS__)
182#define spa_handle_factory_init(h,...) (h)->init((h),__VA_ARGS__)
183#define spa_handle_factory_enum_interface_info(h,...) (h)->enum_interface_info((h),__VA_ARGS__)
184
194typedef int (*spa_handle_factory_enum_func_t) (const struct spa_handle_factory **factory,
195 uint32_t *index);
196
197#define SPA_HANDLE_FACTORY_ENUM_FUNC_NAME "spa_handle_factory_enum"
198
208int spa_handle_factory_enum(const struct spa_handle_factory **factory, uint32_t *index);
209
210
211
212#define SPA_KEY_FACTORY_NAME "factory.name"
213#define SPA_KEY_FACTORY_AUTHOR "factory.author"
214#define SPA_KEY_FACTORY_DESCRIPTION "factory.description"
215#define SPA_KEY_FACTORY_USAGE "factory.usage"
217#define SPA_KEY_LIBRARY_NAME "library.name"
225#ifdef __cplusplus
226} /* extern "C" */
227#endif
228
229#endif /* SPA_PLUGIN_H */
defs.h
spa/utils/defs.h
spa_handle_factory_enum_func_t
int(* spa_handle_factory_enum_func_t)(const struct spa_handle_factory **factory, uint32_t *index)
The function signature of the entry point in a plugin.
Definition: plugin.h:202
spa_support_find
static void * spa_support_find(const struct spa_support *support, uint32_t n_support, const char *type)
Find a support item of the given type.
Definition: plugin.h:102
spa_handle_factory_enum
int spa_handle_factory_enum(const struct spa_handle_factory **factory, uint32_t *index)
The entry point in a plugin.
spa_dict
Definition: dict.h:59
spa_handle_factory
Definition: plugin.h:117
spa_handle_factory::enum_interface_info
int(* enum_interface_info)(const struct spa_handle_factory *factory, const struct spa_interface_info **info, uint32_t *index)
spa_handle_factory::enum_interface_info:
Definition: plugin.h:184
spa_handle_factory::version
uint32_t version
Definition: plugin.h:121
spa_handle_factory::info
const struct spa_dict * info
Extra information about the handles of this factory.
Definition: plugin.h:139
spa_handle_factory::get_size
size_t(* get_size)(const struct spa_handle_factory *factory, const struct spa_dict *params)
Get the size of handles from this factory.
Definition: plugin.h:147
spa_handle_factory::init
int(* init)(const struct spa_handle_factory *factory, struct spa_handle *handle, const struct spa_dict *info, const struct spa_support *support, uint32_t n_support)
Initialize an instance of this factory.
Definition: plugin.h:166
spa_handle
Definition: plugin.h:50
spa_handle::get_interface
int(* get_interface)(struct spa_handle *handle, const char *type, void **interface)
Get the interface provided by handle with type.
Definition: plugin.h:69
spa_handle::clear
int(* clear)(struct spa_handle *handle)
Clean up the memory of handle.
Definition: plugin.h:77
spa_handle::version
uint32_t version
Definition: plugin.h:54
spa_interface_info
This structure lists the information about available interfaces on handles.
Definition: plugin.h:87
spa_interface_info::type
const char * type
Definition: plugin.h:88
spa_support
Extra supporting infrastructure passed to the init() function of a factory.
Definition: plugin.h:96
spa_support::data
void * data
Definition: plugin.h:98
spa_support::type
const char * type
Definition: plugin.h:97
dict.h
spa/utils/dict.h