]> code.delx.au - pulseaudio/blob - src/pulsecore/source-output.c
add hooks for name/description changes of sinks/source and streams
[pulseaudio] / src / pulsecore / source-output.c
1 /* $Id$ */
2
3 /***
4 This file is part of PulseAudio.
5
6 Copyright 2004-2006 Lennart Poettering
7
8 PulseAudio is free software; you can redistribute it and/or modify
9 it under the terms of the GNU Lesser General Public License as published
10 by the Free Software Foundation; either version 2 of the License,
11 or (at your option) any later version.
12
13 PulseAudio is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
17
18 You should have received a copy of the GNU Lesser General Public License
19 along with PulseAudio; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
21 USA.
22 ***/
23
24 #ifdef HAVE_CONFIG_H
25 #include <config.h>
26 #endif
27
28 #include <stdio.h>
29 #include <stdlib.h>
30 #include <string.h>
31
32 #include <pulse/utf8.h>
33 #include <pulse/xmalloc.h>
34
35 #include <pulsecore/core-subscribe.h>
36 #include <pulsecore/log.h>
37 #include <pulsecore/namereg.h>
38
39 #include "source-output.h"
40
41 static PA_DEFINE_CHECK_TYPE(pa_source_output, pa_msgobject);
42
43 static void source_output_free(pa_object* mo);
44
45 pa_source_output_new_data* pa_source_output_new_data_init(pa_source_output_new_data *data) {
46 pa_assert(data);
47
48 memset(data, 0, sizeof(*data));
49 data->resample_method = PA_RESAMPLER_INVALID;
50 return data;
51 }
52
53 void pa_source_output_new_data_set_channel_map(pa_source_output_new_data *data, const pa_channel_map *map) {
54 pa_assert(data);
55
56 if ((data->channel_map_is_set = !!map))
57 data->channel_map = *map;
58 }
59
60 void pa_source_output_new_data_set_sample_spec(pa_source_output_new_data *data, const pa_sample_spec *spec) {
61 pa_assert(data);
62
63 if ((data->sample_spec_is_set = !!spec))
64 data->sample_spec = *spec;
65 }
66
67 pa_source_output* pa_source_output_new(
68 pa_core *core,
69 pa_source_output_new_data *data,
70 pa_source_output_flags_t flags) {
71
72 pa_source_output *o;
73 pa_resampler *resampler = NULL;
74 char st[PA_SAMPLE_SPEC_SNPRINT_MAX];
75
76 pa_assert(core);
77 pa_assert(data);
78
79 if (pa_hook_fire(&core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_NEW], data) < 0)
80 return NULL;
81
82 pa_return_null_if_fail(!data->driver || pa_utf8_valid(data->driver));
83 pa_return_null_if_fail(!data->name || pa_utf8_valid(data->name));
84
85 if (!data->source)
86 data->source = pa_namereg_get(core, NULL, PA_NAMEREG_SOURCE, 1);
87
88 pa_return_null_if_fail(data->source);
89 pa_return_null_if_fail(pa_source_get_state(data->source) != PA_SOURCE_UNLINKED);
90
91 if (!data->sample_spec_is_set)
92 data->sample_spec = data->source->sample_spec;
93
94 pa_return_null_if_fail(pa_sample_spec_valid(&data->sample_spec));
95
96 if (!data->channel_map_is_set) {
97 if (data->source->channel_map.channels == data->sample_spec.channels)
98 data->channel_map = data->source->channel_map;
99 else
100 pa_channel_map_init_auto(&data->channel_map, data->sample_spec.channels, PA_CHANNEL_MAP_DEFAULT);
101 }
102
103 pa_return_null_if_fail(pa_channel_map_valid(&data->channel_map));
104 pa_return_null_if_fail(data->channel_map.channels == data->sample_spec.channels);
105
106 if (data->resample_method == PA_RESAMPLER_INVALID)
107 data->resample_method = core->resample_method;
108
109 pa_return_null_if_fail(data->resample_method < PA_RESAMPLER_MAX);
110
111 if (pa_idxset_size(data->source->outputs) >= PA_MAX_OUTPUTS_PER_SOURCE) {
112 pa_log("Failed to create source output: too many outputs per source.");
113 return NULL;
114 }
115
116 if ((flags & PA_SOURCE_OUTPUT_VARIABLE_RATE) ||
117 !pa_sample_spec_equal(&data->sample_spec, &data->source->sample_spec) ||
118 !pa_channel_map_equal(&data->channel_map, &data->source->channel_map)) {
119
120 if (!(resampler = pa_resampler_new(
121 core->mempool,
122 &data->source->sample_spec, &data->source->channel_map,
123 &data->sample_spec, &data->channel_map,
124 data->resample_method,
125 !!(flags & PA_SOURCE_OUTPUT_VARIABLE_RATE)))) {
126 pa_log_warn("Unsupported resampling operation.");
127 return NULL;
128 }
129
130 data->resample_method = pa_resampler_get_method(resampler);
131 }
132
133 o = pa_msgobject_new(pa_source_output);
134 o->parent.parent.free = source_output_free;
135 o->parent.process_msg = pa_source_output_process_msg;
136
137 o->core = core;
138 o->state = PA_SOURCE_OUTPUT_INIT;
139 o->flags = flags;
140 o->name = pa_xstrdup(data->name);
141 o->driver = pa_xstrdup(data->driver);
142 o->module = data->module;
143 o->source = data->source;
144 o->client = data->client;
145
146 o->resample_method = data->resample_method;
147 o->sample_spec = data->sample_spec;
148 o->channel_map = data->channel_map;
149
150 o->push = NULL;
151 o->kill = NULL;
152 o->get_latency = NULL;
153 o->detach = NULL;
154 o->attach = NULL;
155 o->suspend = NULL;
156 o->userdata = NULL;
157
158 o->thread_info.state = o->state;
159 o->thread_info.attached = FALSE;
160 o->thread_info.sample_spec = o->sample_spec;
161 o->thread_info.resampler = resampler;
162
163 pa_assert_se(pa_idxset_put(core->source_outputs, o, &o->index) == 0);
164 pa_assert_se(pa_idxset_put(o->source->outputs, pa_source_output_ref(o), NULL) == 0);
165
166 pa_log_info("Created output %u \"%s\" on %s with sample spec %s",
167 o->index,
168 o->name,
169 o->source->name,
170 pa_sample_spec_snprint(st, sizeof(st), &o->sample_spec));
171
172 /* Don't forget to call pa_source_output_put! */
173
174 return o;
175 }
176
177 static int source_output_set_state(pa_source_output *o, pa_source_output_state_t state) {
178 pa_assert(o);
179
180 if (o->state == state)
181 return 0;
182
183 if (pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o), PA_SOURCE_OUTPUT_MESSAGE_SET_STATE, PA_UINT_TO_PTR(state), 0, NULL) < 0)
184 return -1;
185
186 if (o->state == PA_SOURCE_OUTPUT_CORKED && state != PA_SOURCE_OUTPUT_CORKED)
187 pa_assert_se(o->source->n_corked -- >= 1);
188 else if (o->state != PA_SOURCE_OUTPUT_CORKED && state == PA_SOURCE_OUTPUT_CORKED)
189 o->source->n_corked++;
190
191 o->state = state;
192
193 return 0;
194 }
195
196 void pa_source_output_unlink(pa_source_output*o) {
197 pa_bool_t linked;
198 pa_assert(o);
199
200 /* See pa_sink_unlink() for a couple of comments how this function
201 * works */
202
203 pa_source_output_ref(o);
204
205 linked = PA_SOURCE_OUTPUT_LINKED(o->state);
206
207 if (linked)
208 pa_hook_fire(&o->source->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_UNLINK], o);
209
210 pa_idxset_remove_by_data(o->source->core->source_outputs, o, NULL);
211 if (pa_idxset_remove_by_data(o->source->outputs, o, NULL))
212 pa_source_output_unref(o);
213
214 if (linked) {
215 pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o->source), PA_SOURCE_MESSAGE_REMOVE_OUTPUT, o, 0, NULL);
216 source_output_set_state(o, PA_SOURCE_OUTPUT_UNLINKED);
217 pa_source_update_status(o->source);
218 } else
219 o->state = PA_SOURCE_OUTPUT_UNLINKED;
220
221 o->push = NULL;
222 o->kill = NULL;
223 o->get_latency = NULL;
224 o->attach = NULL;
225 o->detach = NULL;
226 o->suspend = NULL;
227
228 if (linked) {
229 pa_subscription_post(o->source->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_REMOVE, o->index);
230 pa_hook_fire(&o->source->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_UNLINK_POST], o);
231 }
232
233 o->source = NULL;
234 pa_source_output_unref(o);
235 }
236
237 static void source_output_free(pa_object* mo) {
238 pa_source_output *o = PA_SOURCE_OUTPUT(mo);
239
240 pa_assert(pa_source_output_refcnt(o) == 0);
241
242 if (PA_SOURCE_OUTPUT_LINKED(o->state))
243 pa_source_output_unlink(o);
244
245 pa_log_info("Freeing output %u \"%s\"", o->index, o->name);
246
247 pa_assert(!o->thread_info.attached);
248
249 if (o->thread_info.resampler)
250 pa_resampler_free(o->thread_info.resampler);
251
252 pa_xfree(o->name);
253 pa_xfree(o->driver);
254 pa_xfree(o);
255 }
256
257 void pa_source_output_put(pa_source_output *o) {
258 pa_source_output_assert_ref(o);
259
260 pa_assert(o->state == PA_SOURCE_OUTPUT_INIT);
261 pa_assert(o->push);
262
263 o->thread_info.state = o->state = o->flags & PA_SOURCE_OUTPUT_START_CORKED ? PA_SOURCE_OUTPUT_CORKED : PA_SOURCE_OUTPUT_RUNNING;
264
265 pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o->source), PA_SOURCE_MESSAGE_ADD_OUTPUT, o, 0, NULL);
266 pa_source_update_status(o->source);
267
268 pa_subscription_post(o->source->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_NEW, o->index);
269
270 pa_hook_fire(&o->source->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_PUT], o);
271 }
272
273 void pa_source_output_kill(pa_source_output*o) {
274 pa_source_output_assert_ref(o);
275 pa_assert(PA_SOURCE_OUTPUT_LINKED(o->state));
276
277 if (o->kill)
278 o->kill(o);
279 }
280
281 pa_usec_t pa_source_output_get_latency(pa_source_output *o) {
282 pa_usec_t r = 0;
283
284 pa_source_output_assert_ref(o);
285 pa_assert(PA_SOURCE_OUTPUT_LINKED(o->state));
286
287 if (pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o), PA_SOURCE_OUTPUT_MESSAGE_GET_LATENCY, &r, 0, NULL) < 0)
288 r = 0;
289
290 if (o->get_latency)
291 r += o->get_latency(o);
292
293 return r;
294 }
295
296 /* Called from thread context */
297 void pa_source_output_push(pa_source_output *o, const pa_memchunk *chunk) {
298 pa_memchunk rchunk;
299
300 pa_source_output_assert_ref(o);
301 pa_assert(PA_SOURCE_OUTPUT_LINKED(o->thread_info.state));
302 pa_assert(chunk);
303 pa_assert(chunk->length);
304
305 if (!o->push || o->state == PA_SOURCE_OUTPUT_CORKED)
306 return;
307
308 pa_assert(o->state == PA_SOURCE_OUTPUT_RUNNING);
309
310 if (!o->thread_info.resampler) {
311 o->push(o, chunk);
312 return;
313 }
314
315 pa_resampler_run(o->thread_info.resampler, chunk, &rchunk);
316 if (!rchunk.length)
317 return;
318
319 pa_assert(rchunk.memblock);
320 o->push(o, &rchunk);
321 pa_memblock_unref(rchunk.memblock);
322 }
323
324 void pa_source_output_cork(pa_source_output *o, pa_bool_t b) {
325 pa_source_output_assert_ref(o);
326 pa_assert(PA_SOURCE_OUTPUT_LINKED(o->state));
327
328 source_output_set_state(o, b ? PA_SOURCE_OUTPUT_CORKED : PA_SOURCE_OUTPUT_RUNNING);
329 }
330
331 int pa_source_output_set_rate(pa_source_output *o, uint32_t rate) {
332 pa_source_output_assert_ref(o);
333 pa_assert(PA_SOURCE_OUTPUT_LINKED(o->state));
334 pa_return_val_if_fail(o->thread_info.resampler, -1);
335
336 if (o->sample_spec.rate == rate)
337 return 0;
338
339 o->sample_spec.rate = rate;
340
341 pa_asyncmsgq_post(o->source->asyncmsgq, PA_MSGOBJECT(o), PA_SOURCE_OUTPUT_MESSAGE_SET_RATE, PA_UINT_TO_PTR(rate), 0, NULL, NULL);
342
343 pa_subscription_post(o->source->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
344 return 0;
345 }
346
347 void pa_source_output_set_name(pa_source_output *o, const char *name) {
348 pa_source_output_assert_ref(o);
349
350 if (!o->name && !name)
351 return;
352
353 if (o->name && name && !strcmp(o->name, name))
354 return;
355
356 pa_xfree(o->name);
357 o->name = pa_xstrdup(name);
358
359 if (PA_SOURCE_OUTPUT_LINKED(o->state)) {
360 pa_hook_fire(&o->source->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_NAME_CHANGED], o);
361 pa_subscription_post(o->source->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
362 }
363 }
364
365 pa_resample_method_t pa_source_output_get_resample_method(pa_source_output *o) {
366 pa_source_output_assert_ref(o);
367
368 return o->resample_method;
369 }
370
371 int pa_source_output_move_to(pa_source_output *o, pa_source *dest) {
372 pa_source *origin;
373 pa_resampler *new_resampler = NULL;
374
375 pa_source_output_assert_ref(o);
376 pa_assert(PA_SOURCE_OUTPUT_LINKED(o->state));
377 pa_source_assert_ref(dest);
378
379 origin = o->source;
380
381 if (dest == origin)
382 return 0;
383
384 if (o->flags & PA_SOURCE_OUTPUT_DONT_MOVE)
385 return -1;
386
387 if (pa_idxset_size(dest->outputs) >= PA_MAX_OUTPUTS_PER_SOURCE) {
388 pa_log_warn("Failed to move source output: too many outputs per source.");
389 return -1;
390 }
391
392 if (o->thread_info.resampler &&
393 pa_sample_spec_equal(&origin->sample_spec, &dest->sample_spec) &&
394 pa_channel_map_equal(&origin->channel_map, &dest->channel_map))
395
396 /* Try to reuse the old resampler if possible */
397 new_resampler = o->thread_info.resampler;
398
399 else if ((o->flags & PA_SOURCE_OUTPUT_VARIABLE_RATE) ||
400 !pa_sample_spec_equal(&o->sample_spec, &dest->sample_spec) ||
401 !pa_channel_map_equal(&o->channel_map, &dest->channel_map)) {
402
403 /* Okey, we need a new resampler for the new source */
404
405 if (!(new_resampler = pa_resampler_new(
406 dest->core->mempool,
407 &dest->sample_spec, &dest->channel_map,
408 &o->sample_spec, &o->channel_map,
409 o->resample_method,
410 !!(o->flags & PA_SOURCE_OUTPUT_VARIABLE_RATE)))) {
411 pa_log_warn("Unsupported resampling operation.");
412 return -1;
413 }
414 }
415
416 pa_hook_fire(&o->source->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_MOVE], o);
417
418 /* Okey, let's move it */
419 pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o->source), PA_SOURCE_MESSAGE_REMOVE_OUTPUT, o, 0, NULL);
420
421 pa_idxset_remove_by_data(origin->outputs, o, NULL);
422 pa_idxset_put(dest->outputs, o, NULL);
423 o->source = dest;
424
425 /* Replace resampler */
426 if (new_resampler != o->thread_info.resampler) {
427 if (o->thread_info.resampler)
428 pa_resampler_free(o->thread_info.resampler);
429 o->thread_info.resampler = new_resampler;
430 }
431
432 pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o->source), PA_SOURCE_MESSAGE_ADD_OUTPUT, o, 0, NULL);
433
434 pa_source_update_status(origin);
435 pa_source_update_status(dest);
436
437 pa_hook_fire(&o->source->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_MOVE_POST], o);
438
439 pa_log_debug("Successfully moved source output %i from %s to %s.", o->index, origin->name, dest->name);
440
441 /* Notify everyone */
442 pa_subscription_post(o->source->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
443
444 return 0;
445 }
446
447 /* Called from thread context */
448 int pa_source_output_process_msg(pa_msgobject *mo, int code, void *userdata, int64_t offset, pa_memchunk* chunk) {
449 pa_source_output *o = PA_SOURCE_OUTPUT(mo);
450
451 pa_source_output_assert_ref(o);
452 pa_assert(PA_SOURCE_OUTPUT_LINKED(o->thread_info.state));
453
454 switch (code) {
455
456 case PA_SOURCE_OUTPUT_MESSAGE_SET_RATE: {
457
458 o->thread_info.sample_spec.rate = PA_PTR_TO_UINT(userdata);
459 pa_resampler_set_output_rate(o->thread_info.resampler, PA_PTR_TO_UINT(userdata));
460
461 return 0;
462 }
463
464 case PA_SOURCE_OUTPUT_MESSAGE_SET_STATE: {
465 o->thread_info.state = PA_PTR_TO_UINT(userdata);
466
467 return 0;
468 }
469 }
470
471 return -1;
472 }