PipeWire  0.3.24
impl-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_IMPL_FACTORY_H
26 #define PIPEWIRE_IMPL_FACTORY_H
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
38 struct pw_impl_factory;
39 
40 #include <pipewire/context.h>
41 #include <pipewire/impl-client.h>
42 #include <pipewire/global.h>
43 #include <pipewire/properties.h>
44 #include <pipewire/resource.h>
45 
48 #define PW_VERSION_IMPL_FACTORY_EVENTS 0
49  uint32_t version;
50 
52  void (*destroy) (void *data);
54  void (*free) (void *data);
56  void (*initialized) (void *data);
57 };
58 
60 #define PW_VERSION_IMPL_FACTORY_IMPLEMENTATION 0
61  uint32_t version;
62 
64  void *(*create_object) (void *data,
65  struct pw_resource *resource,
66  const char *type,
67  uint32_t version,
68  struct pw_properties *properties,
69  uint32_t new_id);
70 };
71 
73  const char *name,
74  const char *type,
75  uint32_t version,
76  struct pw_properties *properties,
77  size_t user_data_size);
78 
80 const struct pw_properties *pw_impl_factory_get_properties(struct pw_impl_factory *factory);
81 
83 const struct pw_factory_info *pw_impl_factory_get_info(struct pw_impl_factory *factory);
84 
86 int pw_impl_factory_update_properties(struct pw_impl_factory *factory, const struct spa_dict *dict);
87 
88 int pw_impl_factory_register(struct pw_impl_factory *factory,
89  struct pw_properties *properties);
90 
91 void pw_impl_factory_destroy(struct pw_impl_factory *factory);
92 
93 void *pw_impl_factory_get_user_data(struct pw_impl_factory *factory);
94 
97 
100  struct spa_hook *listener,
101  const struct pw_impl_factory_events *events,
102  void *data);
103 
105  const struct pw_impl_factory_implementation *implementation,
106  void *data);
107 
108 void *pw_impl_factory_create_object(struct pw_impl_factory *factory,
109  struct pw_resource *resource,
110  const char *type,
111  uint32_t version,
112  struct pw_properties *properties,
113  uint32_t new_id);
114 
116 struct pw_impl_factory *
118  const char *name );
119 
120 #ifdef __cplusplus
121 }
122 #endif
123 
124 #endif /* PIPEWIRE_IMPL_FACTORY_H */
the PipeWire context
SPA_EXPORT struct pw_impl_factory * pw_context_find_factory(struct pw_context *context, const char *name)
Find a factory by name.
Definition: impl-factory.c:287
A global object visible to remote clients.
PipeWire factory interface.
Client owned objects.
void pw_impl_factory_destroy(struct pw_impl_factory *factory)
Definition: impl-factory.c:82
const struct pw_properties * pw_impl_factory_get_properties(struct pw_impl_factory *factory)
Get the factory properties.
Definition: impl-factory.c:147
int pw_impl_factory_update_properties(struct pw_impl_factory *factory, const struct spa_dict *dict)
Update the factory properties.
Definition: impl-factory.c:153
struct pw_global * pw_impl_factory_get_global(struct pw_impl_factory *factory)
Get the global of this factory.
Definition: impl-factory.c:238
void pw_impl_factory_set_implementation(struct pw_impl_factory *factory, const struct pw_impl_factory_implementation *implementation, void *data)
Definition: impl-factory.c:253
const struct pw_factory_info * pw_impl_factory_get_info(struct pw_impl_factory *factory)
Get the factory info.
Definition: impl-factory.c:232
struct pw_impl_factory * pw_context_create_factory(struct pw_context *context, const char *name, const char *type, uint32_t version, struct pw_properties *properties, size_t user_data_size)
Definition: impl-factory.c:37
int pw_impl_factory_register(struct pw_impl_factory *factory, struct pw_properties *properties)
Definition: impl-factory.c:176
void pw_impl_factory_add_listener(struct pw_impl_factory *factory, struct spa_hook *listener, const struct pw_impl_factory_events *events, void *data)
Add an event listener.
Definition: impl-factory.c:244
void * pw_impl_factory_get_user_data(struct pw_impl_factory *factory)
Definition: impl-factory.c:226
void * pw_impl_factory_create_object(struct pw_impl_factory *factory, struct pw_resource *resource, const char *type, uint32_t version, struct pw_properties *properties, uint32_t new_id)
Definition: impl-factory.c:261
Definition: filter.c:74
The factory information.
Definition: factory.h:46
Factory events, listen to them with pw_impl_factory_add_listener.
Definition: impl-factory.h:47
uint32_t version
Definition: impl-factory.h:49
void(* initialized)(void *data)
the factory is initialized
Definition: impl-factory.h:56
void(* destroy)(void *data)
the factory is destroyed
Definition: impl-factory.h:52
void(* free)(void *data)
the factory is freed
Definition: impl-factory.h:54
Definition: impl-factory.h:59
uint32_t version
Definition: impl-factory.h:61
A collection of key/value pairs.
Definition: properties.h:45