PipeWire 0.3.34
protocol.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_PROTOCOL_H
26#define PIPEWIRE_PROTOCOL_H
27
28#ifdef __cplusplus
29extern "C" {
30#endif
31
32#include <spa/utils/list.h>
33
44struct pw_protocol;
45
46#include <pipewire/context.h>
47#include <pipewire/properties.h>
48#include <pipewire/utils.h>
49
50#define PW_TYPE_INFO_Protocol "PipeWire:Protocol"
51#define PW_TYPE_INFO_PROTOCOL_BASE PW_TYPE_INFO_Protocol ":"
52
54 struct spa_list link;
55 struct pw_protocol *protocol;
57 struct pw_core *core;
58
60 const struct spa_dict *props,
61 void (*done_callback) (void *data, int result),
62 void *data);
63 int (*connect_fd) (struct pw_protocol_client *client, int fd, bool close);
67 int (*set_paused) (struct pw_protocol_client *client, bool paused);
68};
69
70#define pw_protocol_client_connect(c,p,cb,d) ((c)->connect(c,p,cb,d))
71#define pw_protocol_client_connect_fd(c,fd,cl) ((c)->connect_fd(c,fd,cl))
72#define pw_protocol_client_steal_fd(c) ((c)->steal_fd(c))
73#define pw_protocol_client_disconnect(c) ((c)->disconnect(c))
74#define pw_protocol_client_destroy(c) ((c)->destroy(c))
75#define pw_protocol_client_set_paused(c,p) ((c)->set_paused(c,p))
76
78 struct spa_list link;
79 struct pw_protocol *protocol;
81 struct pw_impl_core *core;
82
85 void (*destroy) (struct pw_protocol_server *listen);
86};
87
88#define pw_protocol_server_destroy(l) ((l)->destroy(l))
89
91 const char *type;
92 uint32_t version;
93#define PW_PROTOCOL_MARSHAL_FLAG_IMPL (1 << 0)
94 uint32_t flags;
97 const void *client_marshal;
98 const void *server_demarshal;
99 const void *server_marshal;
100 const void *client_demarshal;
101};
102
104#define PW_VERSION_PROTOCOL_IMPLEMENTATION 0
105 uint32_t version;
106
107 struct pw_protocol_client * (*new_client) (struct pw_protocol *protocol,
108 struct pw_core *core,
109 const struct spa_dict *props);
110 struct pw_protocol_server * (*add_server) (struct pw_protocol *protocol,
111 struct pw_impl_core *core,
112 const struct spa_dict *props);
113};
114
116#define PW_VERSION_PROTOCOL_EVENTS 0
117 uint32_t version;
118
119 void (*destroy) (void *data);
120};
121
122#define pw_protocol_new_client(p,...) (pw_protocol_get_implementation(p)->new_client(p,__VA_ARGS__))
123#define pw_protocol_add_server(p,...) (pw_protocol_get_implementation(p)->add_server(p,__VA_ARGS__))
124#define pw_protocol_ext(p,type,method,...) (((type*)pw_protocol_get_extension(p))->method( __VA_ARGS__))
125
126struct pw_protocol *pw_protocol_new(struct pw_context *context, const char *name, size_t user_data_size);
127
128void pw_protocol_destroy(struct pw_protocol *protocol);
129
130struct pw_context *pw_protocol_get_context(struct pw_protocol *protocol);
131
132void *pw_protocol_get_user_data(struct pw_protocol *protocol);
133
134const struct pw_protocol_implementation *
135pw_protocol_get_implementation(struct pw_protocol *protocol);
136
137const void *
138pw_protocol_get_extension(struct pw_protocol *protocol);
139
140
141void pw_protocol_add_listener(struct pw_protocol *protocol,
142 struct spa_hook *listener,
143 const struct pw_protocol_events *events,
144 void *data);
145
146int pw_protocol_add_marshal(struct pw_protocol *protocol,
147 const struct pw_protocol_marshal *marshal);
148
149const struct pw_protocol_marshal *
150pw_protocol_get_marshal(struct pw_protocol *protocol, const char *type, uint32_t version, uint32_t flags);
151
152struct pw_protocol * pw_context_find_protocol(struct pw_context *context, const char *name);
153
158#ifdef __cplusplus
159} /* extern "C" */
160#endif
161
162#endif /* PIPEWIRE_PROTOCOL_H */
struct pw_protocol * pw_context_find_protocol(struct pw_context *context, const char *name)
Definition: protocol.c:179
void pw_protocol_add_listener(struct pw_protocol *protocol, struct spa_hook *listener, const struct pw_protocol_events *events, void *data)
Definition: protocol.c:132
struct pw_context * pw_protocol_get_context(struct pw_protocol *protocol)
Definition: protocol.c:77
const struct pw_protocol_marshal * pw_protocol_get_marshal(struct pw_protocol *protocol, const char *type, uint32_t version, uint32_t flags)
Definition: protocol.c:163
int pw_protocol_add_marshal(struct pw_protocol *protocol, const struct pw_protocol_marshal *marshal)
Definition: protocol.c:142
struct pw_protocol * pw_protocol_new(struct pw_context *context, const char *name, size_t user_data_size)
Definition: protocol.c:48
void pw_protocol_destroy(struct pw_protocol *protocol)
Definition: protocol.c:103
void * pw_protocol_get_user_data(struct pw_protocol *protocol)
Definition: protocol.c:83
const void * pw_protocol_get_extension(struct pw_protocol *protocol)
Definition: protocol.c:97
const struct pw_protocol_implementation * pw_protocol_get_implementation(struct pw_protocol *protocol)
Definition: protocol.c:90
const char * props
Definition: media-session.c:2382
const char * name
Definition: media-session.c:2379
Definition: access-flatpak.c:51
user data to add to an object
Definition: media-session.c:109
Definition: protocol.h:53
int(* connect)(struct pw_protocol_client *client, const struct spa_dict *props, void(*done_callback)(void *data, int result), void *data)
Definition: protocol.h:59
struct pw_core * core
Definition: protocol.h:57
int(* connect_fd)(struct pw_protocol_client *client, int fd, bool close)
Definition: protocol.h:63
struct pw_protocol * protocol
the owner protocol
Definition: protocol.h:55
void(* disconnect)(struct pw_protocol_client *client)
Definition: protocol.h:65
int(* set_paused)(struct pw_protocol_client *client, bool paused)
Definition: protocol.h:67
void(* destroy)(struct pw_protocol_client *client)
Definition: protocol.h:66
int(* steal_fd)(struct pw_protocol_client *client)
Definition: protocol.h:64
Definition: protocol.h:115
void(* destroy)(void *data)
Definition: protocol.h:119
uint32_t version
Definition: protocol.h:117
Definition: protocol.h:103
uint32_t version
Definition: protocol.h:105
Definition: protocol.h:90
uint32_t n_client_methods
number of client methods
Definition: protocol.h:95
const void * server_demarshal
Definition: protocol.h:98
uint32_t flags
version
Definition: protocol.h:94
const char * type
interface type
Definition: protocol.h:91
const void * client_marshal
Definition: protocol.h:97
uint32_t version
version
Definition: protocol.h:92
uint32_t n_server_methods
number of server methods
Definition: protocol.h:96
const void * client_demarshal
Definition: protocol.h:100
const void * server_marshal
Definition: protocol.h:99
Definition: protocol.h:77
struct spa_list client_list
list of clients of this protocol
Definition: protocol.h:83
struct pw_protocol * protocol
the owner protocol
Definition: protocol.h:79
void(* destroy)(struct pw_protocol_server *listen)
Definition: protocol.h:85
struct pw_impl_core * core
Definition: protocol.h:81
Definition: utils/dict.h:48
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:295
Definition: list.h:37