]> code.delx.au - pulseaudio/blob - src/pulse/ext-stream-restore.c
add a few additional validity checks
[pulseaudio] / src / pulse / ext-stream-restore.c
1 /***
2 This file is part of PulseAudio.
3
4 Copyright 2008 Lennart Poettering
5
6 PulseAudio is free software; you can redistribute it and/or modify
7 it under the terms of the GNU Lesser General Public License as published
8 by the Free Software Foundation; either version 2 of the License,
9 or (at your option) any later version.
10
11 PulseAudio is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 General Public License for more details.
15
16 You should have received a copy of the GNU Lesser General Public License
17 along with PulseAudio; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
19 USA.
20 ***/
21
22 #ifdef HAVE_CONFIG_H
23 #include <config.h>
24 #endif
25
26 #include <pulse/context.h>
27 #include <pulse/gccmacro.h>
28
29 #include <pulsecore/macro.h>
30 #include <pulsecore/pstream-util.h>
31
32 #include "internal.h"
33 #include "operation.h"
34
35 #include "ext-stream-restore.h"
36
37 enum {
38 SUBCOMMAND_TEST,
39 SUBCOMMAND_READ,
40 SUBCOMMAND_WRITE,
41 SUBCOMMAND_DELETE,
42 SUBCOMMAND_SUBSCRIBE,
43 SUBCOMMAND_EVENT
44 };
45
46 static void ext_stream_restore_test_cb(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata) {
47 pa_operation *o = userdata;
48 uint32_t version = PA_INVALID_INDEX;
49
50 pa_assert(pd);
51 pa_assert(o);
52 pa_assert(PA_REFCNT_VALUE(o) >= 1);
53
54 if (!o->context)
55 goto finish;
56
57 if (command != PA_COMMAND_REPLY) {
58 if (pa_context_handle_error(o->context, command, t, FALSE) < 0)
59 goto finish;
60
61 } else if (pa_tagstruct_getu32(t, &version) < 0 ||
62 !pa_tagstruct_eof(t)) {
63
64 pa_context_fail(o->context, PA_ERR_PROTOCOL);
65 goto finish;
66 }
67
68 if (o->callback) {
69 pa_ext_stream_restore_test_cb_t cb = (pa_ext_stream_restore_test_cb_t) o->callback;
70 cb(o->context, version, o->userdata);
71 }
72
73 finish:
74 pa_operation_done(o);
75 pa_operation_unref(o);
76 }
77
78 pa_operation *pa_ext_stream_restore_test(
79 pa_context *c,
80 pa_ext_stream_restore_test_cb_t cb,
81 void *userdata) {
82
83 uint32_t tag;
84 pa_operation *o;
85 pa_tagstruct *t;
86
87 pa_assert(c);
88 pa_assert(PA_REFCNT_VALUE(c) >= 1);
89
90 PA_CHECK_VALIDITY_RETURN_NULL(c, c->state == PA_CONTEXT_READY, PA_ERR_BADSTATE);
91 PA_CHECK_VALIDITY_RETURN_NULL(c, c->version >= 14, PA_ERR_NOTSUPPORTED);
92
93 o = pa_operation_new(c, NULL, (pa_operation_cb_t) cb, userdata);
94
95 t = pa_tagstruct_command(c, PA_COMMAND_EXTENSION, &tag);
96 pa_tagstruct_putu32(t, PA_INVALID_INDEX);
97 pa_tagstruct_puts(t, "module-stream-restore");
98 pa_tagstruct_putu32(t, SUBCOMMAND_TEST);
99 pa_pstream_send_tagstruct(c->pstream, t);
100 pa_pdispatch_register_reply(c->pdispatch, tag, DEFAULT_TIMEOUT, ext_stream_restore_test_cb, pa_operation_ref(o), (pa_free_cb_t) pa_operation_unref);
101
102 return o;
103 }
104
105 static void ext_stream_restore_read_cb(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata) {
106 pa_operation *o = userdata;
107 int eol = 1;
108
109 pa_assert(pd);
110 pa_assert(o);
111 pa_assert(PA_REFCNT_VALUE(o) >= 1);
112
113 if (!o->context)
114 goto finish;
115
116 if (command != PA_COMMAND_REPLY) {
117 if (pa_context_handle_error(o->context, command, t, FALSE) < 0)
118 goto finish;
119
120 eol = -1;
121 } else {
122
123 while (!pa_tagstruct_eof(t)) {
124 pa_ext_stream_restore_info i;
125 pa_bool_t mute = FALSE;
126
127 memset(&i, 0, sizeof(i));
128
129 if (pa_tagstruct_gets(t, &i.name) < 0 ||
130 pa_tagstruct_get_channel_map(t, &i.channel_map) < 0 ||
131 pa_tagstruct_get_cvolume(t, &i.volume) < 0 ||
132 pa_tagstruct_gets(t, &i.device) < 0 ||
133 pa_tagstruct_get_boolean(t, &mute) < 0) {
134
135 pa_context_fail(o->context, PA_ERR_PROTOCOL);
136 goto finish;
137 }
138
139 i.mute = (int) mute;
140
141 if (o->callback) {
142 pa_ext_stream_restore_read_cb_t cb = (pa_ext_stream_restore_read_cb_t) o->callback;
143 cb(o->context, &i, 0, o->userdata);
144 }
145 }
146 }
147
148 if (o->callback) {
149 pa_ext_stream_restore_read_cb_t cb = (pa_ext_stream_restore_read_cb_t) o->callback;
150 cb(o->context, NULL, eol, o->userdata);
151 }
152
153 finish:
154 pa_operation_done(o);
155 pa_operation_unref(o);
156 }
157
158 pa_operation *pa_ext_stream_restore_read(
159 pa_context *c,
160 pa_ext_stream_restore_read_cb_t cb,
161 void *userdata) {
162
163 uint32_t tag;
164 pa_operation *o;
165 pa_tagstruct *t;
166
167 pa_assert(c);
168 pa_assert(PA_REFCNT_VALUE(c) >= 1);
169
170 PA_CHECK_VALIDITY_RETURN_NULL(c, c->state == PA_CONTEXT_READY, PA_ERR_BADSTATE);
171 PA_CHECK_VALIDITY_RETURN_NULL(c, c->version >= 14, PA_ERR_NOTSUPPORTED);
172
173 o = pa_operation_new(c, NULL, (pa_operation_cb_t) cb, userdata);
174
175 t = pa_tagstruct_command(c, PA_COMMAND_EXTENSION, &tag);
176 pa_tagstruct_putu32(t, PA_INVALID_INDEX);
177 pa_tagstruct_puts(t, "module-stream-restore");
178 pa_tagstruct_putu32(t, SUBCOMMAND_READ);
179 pa_pstream_send_tagstruct(c->pstream, t);
180 pa_pdispatch_register_reply(c->pdispatch, tag, DEFAULT_TIMEOUT, ext_stream_restore_read_cb, pa_operation_ref(o), (pa_free_cb_t) pa_operation_unref);
181
182 return o;
183 }
184
185 pa_operation *pa_ext_stream_restore_write(
186 pa_context *c,
187 pa_update_mode_t mode,
188 const pa_ext_stream_restore_info data[],
189 unsigned n,
190 int apply_immediately,
191 pa_context_success_cb_t cb,
192 void *userdata) {
193
194 uint32_t tag;
195 pa_operation *o = NULL;
196 pa_tagstruct *t = NULL;
197
198 pa_assert(c);
199 pa_assert(PA_REFCNT_VALUE(c) >= 1);
200 pa_assert(mode == PA_UPDATE_MERGE || mode == PA_UPDATE_REPLACE || mode == PA_UPDATE_SET);
201 pa_assert(data);
202
203 PA_CHECK_VALIDITY_RETURN_NULL(c, c->state == PA_CONTEXT_READY, PA_ERR_BADSTATE);
204 PA_CHECK_VALIDITY_RETURN_NULL(c, c->version >= 14, PA_ERR_NOTSUPPORTED);
205
206 o = pa_operation_new(c, NULL, (pa_operation_cb_t) cb, userdata);
207
208 t = pa_tagstruct_command(c, PA_COMMAND_EXTENSION, &tag);
209 pa_tagstruct_putu32(t, PA_INVALID_INDEX);
210 pa_tagstruct_puts(t, "module-stream-restore");
211 pa_tagstruct_putu32(t, SUBCOMMAND_WRITE);
212
213 pa_tagstruct_putu32(t, mode);
214 pa_tagstruct_put_boolean(t, apply_immediately);
215
216 for (; n > 0; n--, data++) {
217 if (!data->name || !*data->name)
218 goto fail;
219
220 pa_tagstruct_puts(t, data->name);
221
222 if (data->volume.channels > 0 &&
223 !pa_cvolume_compatible_with_channel_map(&data->volume, &data->channel_map))
224 goto fail;
225
226 pa_tagstruct_put_channel_map(t, &data->channel_map);
227 pa_tagstruct_put_cvolume(t, &data->volume);
228 pa_tagstruct_puts(t, data->device);
229 pa_tagstruct_put_boolean(t, data->mute);
230 }
231
232 pa_pstream_send_tagstruct(c->pstream, t);
233 pa_pdispatch_register_reply(c->pdispatch, tag, DEFAULT_TIMEOUT, pa_context_simple_ack_callback, pa_operation_ref(o), (pa_free_cb_t) pa_operation_unref);
234
235 return o;
236
237 fail:
238 if (o) {
239 pa_operation_cancel(o);
240 pa_operation_unref(o);
241 }
242
243 if (t)
244 pa_tagstruct_free(t);
245
246 pa_context_set_error(c, PA_ERR_INVALID);
247 return NULL;
248 }
249
250 pa_operation *pa_ext_stream_restore_delete(
251 pa_context *c,
252 const char *const s[],
253 pa_context_success_cb_t cb,
254 void *userdata) {
255
256 uint32_t tag;
257 pa_operation *o = NULL;
258 pa_tagstruct *t = NULL;
259 const char *const *k;
260
261 pa_assert(c);
262 pa_assert(PA_REFCNT_VALUE(c) >= 1);
263 pa_assert(s);
264
265 PA_CHECK_VALIDITY_RETURN_NULL(c, c->state == PA_CONTEXT_READY, PA_ERR_BADSTATE);
266 PA_CHECK_VALIDITY_RETURN_NULL(c, c->version >= 14, PA_ERR_NOTSUPPORTED);
267
268 o = pa_operation_new(c, NULL, (pa_operation_cb_t) cb, userdata);
269
270 t = pa_tagstruct_command(c, PA_COMMAND_EXTENSION, &tag);
271 pa_tagstruct_putu32(t, PA_INVALID_INDEX);
272 pa_tagstruct_puts(t, "module-stream-restore");
273 pa_tagstruct_putu32(t, SUBCOMMAND_DELETE);
274
275 for (k = s; *k; k++) {
276 if (!*k || !**k)
277 goto fail;
278
279 pa_tagstruct_puts(t, *k);
280 }
281
282 pa_pstream_send_tagstruct(c->pstream, t);
283 pa_pdispatch_register_reply(c->pdispatch, tag, DEFAULT_TIMEOUT, pa_context_simple_ack_callback, pa_operation_ref(o), (pa_free_cb_t) pa_operation_unref);
284
285 return o;
286
287 fail:
288 if (o) {
289 pa_operation_cancel(o);
290 pa_operation_unref(o);
291 }
292
293 if (t)
294 pa_tagstruct_free(t);
295
296 pa_context_set_error(c, PA_ERR_INVALID);
297 return NULL;
298 }
299
300 pa_operation *pa_ext_stream_restore_subscribe(
301 pa_context *c,
302 int enable,
303 pa_context_success_cb_t cb,
304 void *userdata) {
305
306 uint32_t tag;
307 pa_operation *o;
308 pa_tagstruct *t;
309
310 pa_assert(c);
311 pa_assert(PA_REFCNT_VALUE(c) >= 1);
312
313 PA_CHECK_VALIDITY_RETURN_NULL(c, c->state == PA_CONTEXT_READY, PA_ERR_BADSTATE);
314 PA_CHECK_VALIDITY_RETURN_NULL(c, c->version >= 14, PA_ERR_NOTSUPPORTED);
315
316 o = pa_operation_new(c, NULL, (pa_operation_cb_t) cb, userdata);
317
318 t = pa_tagstruct_command(c, PA_COMMAND_EXTENSION, &tag);
319 pa_tagstruct_putu32(t, PA_INVALID_INDEX);
320 pa_tagstruct_puts(t, "module-stream-restore");
321 pa_tagstruct_putu32(t, SUBCOMMAND_SUBSCRIBE);
322 pa_tagstruct_put_boolean(t, enable);
323 pa_pstream_send_tagstruct(c->pstream, t);
324 pa_pdispatch_register_reply(c->pdispatch, tag, DEFAULT_TIMEOUT, pa_context_simple_ack_callback, pa_operation_ref(o), (pa_free_cb_t) pa_operation_unref);
325
326 return o;
327 }
328
329 void pa_ext_stream_restore_set_subscribe_cb(
330 pa_context *c,
331 pa_ext_stream_restore_subscribe_cb_t cb,
332 void *userdata) {
333
334 pa_assert(c);
335 pa_assert(PA_REFCNT_VALUE(c) >= 1);
336
337 c->ext_stream_restore.callback = cb;
338 c->ext_stream_restore.userdata = userdata;
339 }
340
341 void pa_ext_stream_restore_command(pa_context *c, uint32_t tag, pa_tagstruct *t) {
342 uint32_t subcommand;
343
344 pa_assert(c);
345 pa_assert(PA_REFCNT_VALUE(c) >= 1);
346 pa_assert(t);
347
348 if (pa_tagstruct_getu32(t, &subcommand) < 0 ||
349 !pa_tagstruct_eof(t)) {
350
351 pa_context_fail(c, PA_ERR_PROTOCOL);
352 return;
353 }
354
355 if (subcommand != SUBCOMMAND_EVENT) {
356 pa_context_fail(c, PA_ERR_PROTOCOL);
357 return;
358 }
359
360 if (c->ext_stream_restore.callback)
361 c->ext_stream_restore.callback(c, c->ext_stream_restore.userdata);
362 }