]> code.delx.au - pulseaudio/blob - src/pulsecore/source-output.c
s/pulsecore\/gccmacro.h/pulse\/gccmacro.h/
[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/sample-util.h>
36 #include <pulsecore/core-subscribe.h>
37 #include <pulsecore/log.h>
38 #include <pulsecore/namereg.h>
39 #include <pulsecore/core-util.h>
40
41 #include "source-output.h"
42
43 static PA_DEFINE_CHECK_TYPE(pa_source_output, pa_msgobject);
44
45 static void source_output_free(pa_object* mo);
46
47 pa_source_output_new_data* pa_source_output_new_data_init(pa_source_output_new_data *data) {
48 pa_assert(data);
49
50 memset(data, 0, sizeof(*data));
51 data->resample_method = PA_RESAMPLER_INVALID;
52 data->proplist = pa_proplist_new();
53
54 return data;
55 }
56
57 void pa_source_output_new_data_set_sample_spec(pa_source_output_new_data *data, const pa_sample_spec *spec) {
58 pa_assert(data);
59
60 if ((data->sample_spec_is_set = !!spec))
61 data->sample_spec = *spec;
62 }
63
64 void pa_source_output_new_data_set_channel_map(pa_source_output_new_data *data, const pa_channel_map *map) {
65 pa_assert(data);
66
67 if ((data->channel_map_is_set = !!map))
68 data->channel_map = *map;
69 }
70
71 void pa_source_output_new_data_done(pa_source_output_new_data *data) {
72 pa_assert(data);
73
74 pa_proplist_free(data->proplist);
75 }
76
77 pa_source_output* pa_source_output_new(
78 pa_core *core,
79 pa_source_output_new_data *data,
80 pa_source_output_flags_t flags) {
81
82 pa_source_output *o;
83 pa_resampler *resampler = NULL;
84 char st[PA_SAMPLE_SPEC_SNPRINT_MAX], cm[PA_CHANNEL_MAP_SNPRINT_MAX];
85
86 pa_assert(core);
87 pa_assert(data);
88
89 if (pa_hook_fire(&core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_NEW], data) < 0)
90 return NULL;
91
92 pa_return_null_if_fail(!data->driver || pa_utf8_valid(data->driver));
93
94 if (!data->source)
95 data->source = pa_namereg_get(core, NULL, PA_NAMEREG_SOURCE, 1);
96
97 pa_return_null_if_fail(data->source);
98 pa_return_null_if_fail(pa_source_get_state(data->source) != PA_SOURCE_UNLINKED);
99
100 if (!data->sample_spec_is_set)
101 data->sample_spec = data->source->sample_spec;
102
103 pa_return_null_if_fail(pa_sample_spec_valid(&data->sample_spec));
104
105 if (!data->channel_map_is_set) {
106 if (data->source->channel_map.channels == data->sample_spec.channels)
107 data->channel_map = data->source->channel_map;
108 else
109 pa_return_null_if_fail(pa_channel_map_init_auto(&data->channel_map, data->sample_spec.channels, PA_CHANNEL_MAP_DEFAULT));
110 }
111
112 pa_return_null_if_fail(pa_channel_map_valid(&data->channel_map));
113 pa_return_null_if_fail(data->channel_map.channels == data->sample_spec.channels);
114
115 if (flags & PA_SOURCE_OUTPUT_FIX_FORMAT)
116 data->sample_spec.format = data->source->sample_spec.format;
117
118 if (flags & PA_SOURCE_OUTPUT_FIX_RATE)
119 data->sample_spec.rate = data->source->sample_spec.rate;
120
121 if (flags & PA_SOURCE_OUTPUT_FIX_CHANNELS) {
122 data->sample_spec.channels = data->source->sample_spec.channels;
123 data->channel_map = data->source->channel_map;
124 }
125
126 pa_assert(pa_sample_spec_valid(&data->sample_spec));
127 pa_assert(pa_channel_map_valid(&data->channel_map));
128
129 if (data->resample_method == PA_RESAMPLER_INVALID)
130 data->resample_method = core->resample_method;
131
132 pa_return_null_if_fail(data->resample_method < PA_RESAMPLER_MAX);
133
134 if (pa_hook_fire(&core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_FIXATE], data) < 0)
135 return NULL;
136
137 if (pa_idxset_size(data->source->outputs) >= PA_MAX_OUTPUTS_PER_SOURCE) {
138 pa_log("Failed to create source output: too many outputs per source.");
139 return NULL;
140 }
141
142 if ((flags & PA_SOURCE_OUTPUT_VARIABLE_RATE) ||
143 !pa_sample_spec_equal(&data->sample_spec, &data->source->sample_spec) ||
144 !pa_channel_map_equal(&data->channel_map, &data->source->channel_map)) {
145
146 if (!(resampler = pa_resampler_new(
147 core->mempool,
148 &data->source->sample_spec, &data->source->channel_map,
149 &data->sample_spec, &data->channel_map,
150 data->resample_method,
151 ((flags & PA_SOURCE_OUTPUT_VARIABLE_RATE) ? PA_RESAMPLER_VARIABLE_RATE : 0) |
152 ((flags & PA_SOURCE_OUTPUT_NO_REMAP) ? PA_RESAMPLER_NO_REMAP : 0) |
153 (core->disable_remixing || (flags & PA_SOURCE_OUTPUT_NO_REMIX) ? PA_RESAMPLER_NO_REMIX : 0)))) {
154 pa_log_warn("Unsupported resampling operation.");
155 return NULL;
156 }
157
158 data->resample_method = pa_resampler_get_method(resampler);
159 }
160
161 o = pa_msgobject_new(pa_source_output);
162 o->parent.parent.free = source_output_free;
163 o->parent.process_msg = pa_source_output_process_msg;
164
165 o->core = core;
166 o->state = PA_SOURCE_OUTPUT_INIT;
167 o->flags = flags;
168 o->proplist = pa_proplist_copy(data->proplist);
169 o->driver = pa_xstrdup(data->driver);
170 o->module = data->module;
171 o->source = data->source;
172 o->client = data->client;
173
174 o->resample_method = data->resample_method;
175 o->sample_spec = data->sample_spec;
176 o->channel_map = data->channel_map;
177
178 o->push = NULL;
179 o->kill = NULL;
180 o->get_latency = NULL;
181 o->detach = NULL;
182 o->attach = NULL;
183 o->suspend = NULL;
184 o->moved = NULL;
185 o->userdata = NULL;
186
187 o->thread_info.state = o->state;
188 o->thread_info.attached = FALSE;
189 o->thread_info.sample_spec = o->sample_spec;
190 o->thread_info.resampler = resampler;
191 o->thread_info.requested_source_latency = 0;
192
193 pa_assert_se(pa_idxset_put(core->source_outputs, o, &o->index) == 0);
194 pa_assert_se(pa_idxset_put(o->source->outputs, pa_source_output_ref(o), NULL) == 0);
195
196 pa_log_info("Created output %u \"%s\" on %s with sample spec %s and channel map %s",
197 o->index,
198 pa_strnull(pa_proplist_gets(o->proplist, PA_PROP_MEDIA_NAME)),
199 o->source->name,
200 pa_sample_spec_snprint(st, sizeof(st), &o->sample_spec),
201 pa_channel_map_snprint(cm, sizeof(cm), &o->channel_map));
202
203 /* Don't forget to call pa_source_output_put! */
204
205 return o;
206 }
207
208 static int source_output_set_state(pa_source_output *o, pa_source_output_state_t state) {
209 pa_assert(o);
210
211 if (o->state == state)
212 return 0;
213
214 if (pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o), PA_SOURCE_OUTPUT_MESSAGE_SET_STATE, PA_UINT_TO_PTR(state), 0, NULL) < 0)
215 return -1;
216
217 if (o->state == PA_SOURCE_OUTPUT_CORKED && state != PA_SOURCE_OUTPUT_CORKED)
218 pa_assert_se(o->source->n_corked -- >= 1);
219 else if (o->state != PA_SOURCE_OUTPUT_CORKED && state == PA_SOURCE_OUTPUT_CORKED)
220 o->source->n_corked++;
221
222 pa_source_update_status(o->source);
223 o->state = state;
224
225 if (state != PA_SOURCE_OUTPUT_UNLINKED)
226 pa_hook_fire(&o->source->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_STATE_CHANGED], o);
227
228 return 0;
229 }
230
231 void pa_source_output_unlink(pa_source_output*o) {
232 pa_bool_t linked;
233 pa_assert(o);
234
235 /* See pa_sink_unlink() for a couple of comments how this function
236 * works */
237
238 pa_source_output_ref(o);
239
240 linked = PA_SOURCE_OUTPUT_LINKED(o->state);
241
242 if (linked)
243 pa_hook_fire(&o->source->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_UNLINK], o);
244
245 pa_idxset_remove_by_data(o->source->core->source_outputs, o, NULL);
246 if (pa_idxset_remove_by_data(o->source->outputs, o, NULL))
247 pa_source_output_unref(o);
248
249 if (linked) {
250 pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o->source), PA_SOURCE_MESSAGE_REMOVE_OUTPUT, o, 0, NULL);
251 source_output_set_state(o, PA_SOURCE_OUTPUT_UNLINKED);
252 pa_source_update_status(o->source);
253 } else
254 o->state = PA_SOURCE_OUTPUT_UNLINKED;
255
256 o->push = NULL;
257 o->kill = NULL;
258 o->get_latency = NULL;
259 o->attach = NULL;
260 o->detach = NULL;
261 o->suspend = NULL;
262 o->moved = NULL;
263
264 if (linked) {
265 pa_subscription_post(o->source->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_REMOVE, o->index);
266 pa_hook_fire(&o->source->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_UNLINK_POST], o);
267 }
268
269 o->source = NULL;
270 pa_source_output_unref(o);
271 }
272
273 static void source_output_free(pa_object* mo) {
274 pa_source_output *o = PA_SOURCE_OUTPUT(mo);
275
276 pa_assert(pa_source_output_refcnt(o) == 0);
277
278 if (PA_SOURCE_OUTPUT_LINKED(o->state))
279 pa_source_output_unlink(o);
280
281 pa_log_info("Freeing output %u \"%s\"", o->index, pa_strnull(pa_proplist_gets(o->proplist, PA_PROP_MEDIA_NAME)));
282
283 pa_assert(!o->thread_info.attached);
284
285 if (o->thread_info.resampler)
286 pa_resampler_free(o->thread_info.resampler);
287
288 if (o->proplist)
289 pa_proplist_free(o->proplist);
290
291 pa_xfree(o->driver);
292 pa_xfree(o);
293 }
294
295 void pa_source_output_put(pa_source_output *o) {
296 pa_source_output_assert_ref(o);
297
298 pa_assert(o->state == PA_SOURCE_OUTPUT_INIT);
299 pa_assert(o->push);
300
301 o->thread_info.state = o->state = o->flags & PA_SOURCE_OUTPUT_START_CORKED ? PA_SOURCE_OUTPUT_CORKED : PA_SOURCE_OUTPUT_RUNNING;
302
303 if (o->state == PA_SOURCE_OUTPUT_CORKED)
304 o->source->n_corked++;
305
306 pa_source_update_status(o->source);
307 pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o->source), PA_SOURCE_MESSAGE_ADD_OUTPUT, o, 0, NULL);
308
309 pa_subscription_post(o->source->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_NEW, o->index);
310 pa_hook_fire(&o->source->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_PUT], o);
311 }
312
313 void pa_source_output_kill(pa_source_output*o) {
314 pa_source_output_assert_ref(o);
315 pa_assert(PA_SOURCE_OUTPUT_LINKED(o->state));
316
317 if (o->kill)
318 o->kill(o);
319 }
320
321 pa_usec_t pa_source_output_get_latency(pa_source_output *o) {
322 pa_usec_t r = 0;
323
324 pa_source_output_assert_ref(o);
325 pa_assert(PA_SOURCE_OUTPUT_LINKED(o->state));
326
327 if (pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o), PA_SOURCE_OUTPUT_MESSAGE_GET_LATENCY, &r, 0, NULL) < 0)
328 r = 0;
329
330 if (o->get_latency)
331 r += o->get_latency(o);
332
333 return r;
334 }
335
336 /* Called from thread context */
337 void pa_source_output_push(pa_source_output *o, const pa_memchunk *chunk) {
338 pa_memchunk rchunk;
339
340 pa_source_output_assert_ref(o);
341 pa_assert(PA_SOURCE_OUTPUT_LINKED(o->thread_info.state));
342 pa_assert(chunk);
343 pa_assert(pa_frame_aligned(chunk->length, &o->source->sample_spec));
344
345 if (!o->push || o->state == PA_SOURCE_OUTPUT_CORKED)
346 return;
347
348 pa_assert(o->state == PA_SOURCE_OUTPUT_RUNNING);
349
350 if (!o->thread_info.resampler) {
351 o->push(o, chunk);
352 return;
353 }
354
355 pa_resampler_run(o->thread_info.resampler, chunk, &rchunk);
356 if (!rchunk.length)
357 return;
358
359 pa_assert(rchunk.memblock);
360 o->push(o, &rchunk);
361 pa_memblock_unref(rchunk.memblock);
362 }
363
364 pa_usec_t pa_source_output_set_requested_latency(pa_source_output *o, pa_usec_t usec) {
365 pa_source_output_assert_ref(o);
366 pa_assert(PA_SOURCE_OUTPUT_LINKED(o->state));
367
368 if (usec > 0) {
369
370 if (o->source->max_latency > 0 && usec > o->source->max_latency)
371 usec = o->source->max_latency;
372
373 if (o->source->min_latency > 0 && usec < o->source->min_latency)
374 usec = o->source->min_latency;
375
376 }
377
378 if (PA_SOURCE_OUTPUT_LINKED(o->state))
379 pa_asyncmsgq_post(o->source->asyncmsgq, PA_MSGOBJECT(o), PA_SOURCE_OUTPUT_MESSAGE_SET_REQUESTED_LATENCY, NULL, (int64_t) usec, NULL, NULL);
380 else {
381 o->thread_info.requested_source_latency = usec;
382 o->source->thread_info.requested_latency_valid = FALSE;
383 }
384
385 return usec;
386 }
387
388 void pa_source_output_cork(pa_source_output *o, pa_bool_t b) {
389 pa_source_output_assert_ref(o);
390 pa_assert(PA_SOURCE_OUTPUT_LINKED(o->state));
391
392 source_output_set_state(o, b ? PA_SOURCE_OUTPUT_CORKED : PA_SOURCE_OUTPUT_RUNNING);
393 }
394
395 int pa_source_output_set_rate(pa_source_output *o, uint32_t rate) {
396 pa_source_output_assert_ref(o);
397 pa_assert(PA_SOURCE_OUTPUT_LINKED(o->state));
398 pa_return_val_if_fail(o->thread_info.resampler, -1);
399
400 if (o->sample_spec.rate == rate)
401 return 0;
402
403 o->sample_spec.rate = rate;
404
405 pa_asyncmsgq_post(o->source->asyncmsgq, PA_MSGOBJECT(o), PA_SOURCE_OUTPUT_MESSAGE_SET_RATE, PA_UINT_TO_PTR(rate), 0, NULL, NULL);
406
407 pa_subscription_post(o->source->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
408 return 0;
409 }
410
411 void pa_source_output_set_name(pa_source_output *o, const char *name) {
412 const char *old;
413 pa_source_output_assert_ref(o);
414
415 old = pa_proplist_gets(o->proplist, PA_PROP_MEDIA_NAME);
416
417 if (!old && !name)
418 return;
419
420 if (old && name && !strcmp(old, name))
421 return;
422
423 if (name)
424 pa_proplist_sets(o->proplist, PA_PROP_MEDIA_NAME, name);
425 else
426 pa_proplist_unset(o->proplist, PA_PROP_MEDIA_NAME);
427
428 if (PA_SOURCE_OUTPUT_LINKED(o->state)) {
429 pa_hook_fire(&o->source->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_PROPLIST_CHANGED], o);
430 pa_subscription_post(o->source->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
431 }
432 }
433
434 pa_resample_method_t pa_source_output_get_resample_method(pa_source_output *o) {
435 pa_source_output_assert_ref(o);
436
437 return o->resample_method;
438 }
439
440 int pa_source_output_move_to(pa_source_output *o, pa_source *dest) {
441 pa_source *origin;
442 pa_resampler *new_resampler = NULL;
443 pa_source_output_move_hook_data hook_data;
444
445 pa_source_output_assert_ref(o);
446 pa_assert(PA_SOURCE_OUTPUT_LINKED(o->state));
447 pa_source_assert_ref(dest);
448
449 origin = o->source;
450
451 if (dest == origin)
452 return 0;
453
454 if (o->flags & PA_SOURCE_OUTPUT_DONT_MOVE)
455 return -1;
456
457 if (pa_idxset_size(dest->outputs) >= PA_MAX_OUTPUTS_PER_SOURCE) {
458 pa_log_warn("Failed to move source output: too many outputs per source.");
459 return -1;
460 }
461
462 if (o->thread_info.resampler &&
463 pa_sample_spec_equal(&origin->sample_spec, &dest->sample_spec) &&
464 pa_channel_map_equal(&origin->channel_map, &dest->channel_map))
465
466 /* Try to reuse the old resampler if possible */
467 new_resampler = o->thread_info.resampler;
468
469 else if ((o->flags & PA_SOURCE_OUTPUT_VARIABLE_RATE) ||
470 !pa_sample_spec_equal(&o->sample_spec, &dest->sample_spec) ||
471 !pa_channel_map_equal(&o->channel_map, &dest->channel_map)) {
472
473 /* Okey, we need a new resampler for the new source */
474
475 if (!(new_resampler = pa_resampler_new(
476 dest->core->mempool,
477 &dest->sample_spec, &dest->channel_map,
478 &o->sample_spec, &o->channel_map,
479 o->resample_method,
480 ((o->flags & PA_SOURCE_OUTPUT_VARIABLE_RATE) ? PA_RESAMPLER_VARIABLE_RATE : 0) |
481 ((o->flags & PA_SOURCE_OUTPUT_NO_REMAP) ? PA_RESAMPLER_NO_REMAP : 0) |
482 (o->core->disable_remixing || (o->flags & PA_SOURCE_OUTPUT_NO_REMIX) ? PA_RESAMPLER_NO_REMIX : 0)))) {
483 pa_log_warn("Unsupported resampling operation.");
484 return -1;
485 }
486 }
487
488 hook_data.source_output = o;
489 hook_data.destination = dest;
490 pa_hook_fire(&o->source->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_MOVE], &hook_data);
491
492 /* Okey, let's move it */
493 pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o->source), PA_SOURCE_MESSAGE_REMOVE_OUTPUT, o, 0, NULL);
494
495 pa_idxset_remove_by_data(origin->outputs, o, NULL);
496 pa_idxset_put(dest->outputs, o, NULL);
497 o->source = dest;
498
499 if (pa_source_output_get_state(o) == PA_SOURCE_OUTPUT_CORKED) {
500 pa_assert_se(origin->n_corked-- >= 1);
501 dest->n_corked++;
502 }
503
504 /* Replace resampler */
505 if (new_resampler != o->thread_info.resampler) {
506 if (o->thread_info.resampler)
507 pa_resampler_free(o->thread_info.resampler);
508 o->thread_info.resampler = new_resampler;
509 }
510
511 pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o->source), PA_SOURCE_MESSAGE_ADD_OUTPUT, o, 0, NULL);
512
513 pa_source_update_status(origin);
514 pa_source_update_status(dest);
515
516 if (o->moved)
517 o->moved(o);
518
519 pa_hook_fire(&o->source->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_MOVE_POST], o);
520
521 pa_log_debug("Successfully moved source output %i from %s to %s.", o->index, origin->name, dest->name);
522
523 /* Notify everyone */
524 pa_subscription_post(o->source->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
525
526 return 0;
527 }
528
529 /* Called from thread context */
530 int pa_source_output_process_msg(pa_msgobject *mo, int code, void *userdata, int64_t offset, pa_memchunk* chunk) {
531 pa_source_output *o = PA_SOURCE_OUTPUT(mo);
532
533 pa_source_output_assert_ref(o);
534 pa_assert(PA_SOURCE_OUTPUT_LINKED(o->thread_info.state));
535
536 switch (code) {
537
538 case PA_SOURCE_OUTPUT_MESSAGE_SET_RATE: {
539
540 o->thread_info.sample_spec.rate = PA_PTR_TO_UINT(userdata);
541 pa_resampler_set_output_rate(o->thread_info.resampler, PA_PTR_TO_UINT(userdata));
542
543 return 0;
544 }
545
546 case PA_SOURCE_OUTPUT_MESSAGE_SET_STATE: {
547 o->thread_info.state = PA_PTR_TO_UINT(userdata);
548
549 return 0;
550 }
551
552 case PA_SOURCE_OUTPUT_MESSAGE_SET_REQUESTED_LATENCY:
553
554 o->thread_info.requested_source_latency = (pa_usec_t) offset;
555 pa_source_invalidate_requested_latency(o->source);
556
557 return 0;
558 }
559
560 return -1;
561 }