]> code.delx.au - pulseaudio/blob - src/pulsecore/source-output.c
really create glitch-free branch
[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], cm[PA_CHANNEL_MAP_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_return_null_if_fail(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 (flags & PA_SOURCE_OUTPUT_FIX_FORMAT)
107 data->sample_spec.format = data->source->sample_spec.format;
108
109 if (flags & PA_SOURCE_OUTPUT_FIX_RATE)
110 data->sample_spec.rate = data->source->sample_spec.rate;
111
112 if (flags & PA_SOURCE_OUTPUT_FIX_CHANNELS) {
113 data->sample_spec.channels = data->source->sample_spec.channels;
114 data->channel_map = data->source->channel_map;
115 }
116
117 pa_assert(pa_sample_spec_valid(&data->sample_spec));
118 pa_assert(pa_channel_map_valid(&data->channel_map));
119
120 if (data->resample_method == PA_RESAMPLER_INVALID)
121 data->resample_method = core->resample_method;
122
123 pa_return_null_if_fail(data->resample_method < PA_RESAMPLER_MAX);
124
125 if (pa_hook_fire(&core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_FIXATE], data) < 0)
126 return NULL;
127
128 if (pa_idxset_size(data->source->outputs) >= PA_MAX_OUTPUTS_PER_SOURCE) {
129 pa_log("Failed to create source output: too many outputs per source.");
130 return NULL;
131 }
132
133 if ((flags & PA_SOURCE_OUTPUT_VARIABLE_RATE) ||
134 !pa_sample_spec_equal(&data->sample_spec, &data->source->sample_spec) ||
135 !pa_channel_map_equal(&data->channel_map, &data->source->channel_map)) {
136
137 if (!(resampler = pa_resampler_new(
138 core->mempool,
139 &data->source->sample_spec, &data->source->channel_map,
140 &data->sample_spec, &data->channel_map,
141 data->resample_method,
142 ((flags & PA_SOURCE_OUTPUT_VARIABLE_RATE) ? PA_RESAMPLER_VARIABLE_RATE : 0) |
143 ((flags & PA_SOURCE_OUTPUT_NO_REMAP) ? PA_RESAMPLER_NO_REMAP : 0) |
144 (core->disable_remixing || (flags & PA_SOURCE_OUTPUT_NO_REMIX) ? PA_RESAMPLER_NO_REMIX : 0)))) {
145 pa_log_warn("Unsupported resampling operation.");
146 return NULL;
147 }
148
149 data->resample_method = pa_resampler_get_method(resampler);
150 }
151
152 o = pa_msgobject_new(pa_source_output);
153 o->parent.parent.free = source_output_free;
154 o->parent.process_msg = pa_source_output_process_msg;
155
156 o->core = core;
157 o->state = PA_SOURCE_OUTPUT_INIT;
158 o->flags = flags;
159 o->name = pa_xstrdup(data->name);
160 o->driver = pa_xstrdup(data->driver);
161 o->module = data->module;
162 o->source = data->source;
163 o->client = data->client;
164
165 o->resample_method = data->resample_method;
166 o->sample_spec = data->sample_spec;
167 o->channel_map = data->channel_map;
168
169 o->push = NULL;
170 o->kill = NULL;
171 o->get_latency = NULL;
172 o->detach = NULL;
173 o->attach = NULL;
174 o->suspend = NULL;
175 o->moved = NULL;
176 o->userdata = NULL;
177
178 o->thread_info.state = o->state;
179 o->thread_info.attached = FALSE;
180 o->thread_info.sample_spec = o->sample_spec;
181 o->thread_info.resampler = resampler;
182
183 pa_assert_se(pa_idxset_put(core->source_outputs, o, &o->index) == 0);
184 pa_assert_se(pa_idxset_put(o->source->outputs, pa_source_output_ref(o), NULL) == 0);
185
186 pa_log_info("Created output %u \"%s\" on %s with sample spec %s and channel map %s",
187 o->index,
188 o->name,
189 o->source->name,
190 pa_sample_spec_snprint(st, sizeof(st), &o->sample_spec),
191 pa_channel_map_snprint(cm, sizeof(cm), &o->channel_map));
192
193 /* Don't forget to call pa_source_output_put! */
194
195 return o;
196 }
197
198 static int source_output_set_state(pa_source_output *o, pa_source_output_state_t state) {
199 pa_assert(o);
200
201 if (o->state == state)
202 return 0;
203
204 if (pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o), PA_SOURCE_OUTPUT_MESSAGE_SET_STATE, PA_UINT_TO_PTR(state), 0, NULL) < 0)
205 return -1;
206
207 if (o->state == PA_SOURCE_OUTPUT_CORKED && state != PA_SOURCE_OUTPUT_CORKED)
208 pa_assert_se(o->source->n_corked -- >= 1);
209 else if (o->state != PA_SOURCE_OUTPUT_CORKED && state == PA_SOURCE_OUTPUT_CORKED)
210 o->source->n_corked++;
211
212 pa_source_update_status(o->source);
213
214 o->state = state;
215
216 if (state != PA_SOURCE_OUTPUT_UNLINKED)
217 pa_hook_fire(&o->source->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_STATE_CHANGED], o);
218
219 return 0;
220 }
221
222 void pa_source_output_unlink(pa_source_output*o) {
223 pa_bool_t linked;
224 pa_assert(o);
225
226 /* See pa_sink_unlink() for a couple of comments how this function
227 * works */
228
229 pa_source_output_ref(o);
230
231 linked = PA_SOURCE_OUTPUT_LINKED(o->state);
232
233 if (linked)
234 pa_hook_fire(&o->source->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_UNLINK], o);
235
236 pa_idxset_remove_by_data(o->source->core->source_outputs, o, NULL);
237 if (pa_idxset_remove_by_data(o->source->outputs, o, NULL))
238 pa_source_output_unref(o);
239
240 if (linked) {
241 pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o->source), PA_SOURCE_MESSAGE_REMOVE_OUTPUT, o, 0, NULL);
242 source_output_set_state(o, PA_SOURCE_OUTPUT_UNLINKED);
243 pa_source_update_status(o->source);
244 } else
245 o->state = PA_SOURCE_OUTPUT_UNLINKED;
246
247 o->push = NULL;
248 o->kill = NULL;
249 o->get_latency = NULL;
250 o->attach = NULL;
251 o->detach = NULL;
252 o->suspend = NULL;
253 o->moved = NULL;
254
255 if (linked) {
256 pa_subscription_post(o->source->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_REMOVE, o->index);
257 pa_hook_fire(&o->source->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_UNLINK_POST], o);
258 }
259
260 o->source = NULL;
261 pa_source_output_unref(o);
262 }
263
264 static void source_output_free(pa_object* mo) {
265 pa_source_output *o = PA_SOURCE_OUTPUT(mo);
266
267 pa_assert(pa_source_output_refcnt(o) == 0);
268
269 if (PA_SOURCE_OUTPUT_LINKED(o->state))
270 pa_source_output_unlink(o);
271
272 pa_log_info("Freeing output %u \"%s\"", o->index, o->name);
273
274 pa_assert(!o->thread_info.attached);
275
276 if (o->thread_info.resampler)
277 pa_resampler_free(o->thread_info.resampler);
278
279 pa_xfree(o->name);
280 pa_xfree(o->driver);
281 pa_xfree(o);
282 }
283
284 void pa_source_output_put(pa_source_output *o) {
285 pa_source_output_assert_ref(o);
286
287 pa_assert(o->state == PA_SOURCE_OUTPUT_INIT);
288 pa_assert(o->push);
289
290 o->thread_info.state = o->state = o->flags & PA_SOURCE_OUTPUT_START_CORKED ? PA_SOURCE_OUTPUT_CORKED : PA_SOURCE_OUTPUT_RUNNING;
291
292 if (o->state == PA_SOURCE_OUTPUT_CORKED)
293 o->source->n_corked++;
294
295 pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o->source), PA_SOURCE_MESSAGE_ADD_OUTPUT, o, 0, NULL);
296 pa_source_update_status(o->source);
297
298 pa_subscription_post(o->source->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_NEW, o->index);
299
300 pa_hook_fire(&o->source->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_PUT], o);
301 }
302
303 void pa_source_output_kill(pa_source_output*o) {
304 pa_source_output_assert_ref(o);
305 pa_assert(PA_SOURCE_OUTPUT_LINKED(o->state));
306
307 if (o->kill)
308 o->kill(o);
309 }
310
311 pa_usec_t pa_source_output_get_latency(pa_source_output *o) {
312 pa_usec_t r = 0;
313
314 pa_source_output_assert_ref(o);
315 pa_assert(PA_SOURCE_OUTPUT_LINKED(o->state));
316
317 if (pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o), PA_SOURCE_OUTPUT_MESSAGE_GET_LATENCY, &r, 0, NULL) < 0)
318 r = 0;
319
320 if (o->get_latency)
321 r += o->get_latency(o);
322
323 return r;
324 }
325
326 /* Called from thread context */
327 void pa_source_output_push(pa_source_output *o, const pa_memchunk *chunk) {
328 pa_memchunk rchunk;
329
330 pa_source_output_assert_ref(o);
331 pa_assert(PA_SOURCE_OUTPUT_LINKED(o->thread_info.state));
332 pa_assert(chunk);
333 pa_assert(chunk->length);
334
335 if (!o->push || o->state == PA_SOURCE_OUTPUT_CORKED)
336 return;
337
338 pa_assert(o->state == PA_SOURCE_OUTPUT_RUNNING);
339
340 if (!o->thread_info.resampler) {
341 o->push(o, chunk);
342 return;
343 }
344
345 pa_resampler_run(o->thread_info.resampler, chunk, &rchunk);
346 if (!rchunk.length)
347 return;
348
349 pa_assert(rchunk.memblock);
350 o->push(o, &rchunk);
351 pa_memblock_unref(rchunk.memblock);
352 }
353
354 void pa_source_output_cork(pa_source_output *o, pa_bool_t b) {
355 pa_source_output_assert_ref(o);
356 pa_assert(PA_SOURCE_OUTPUT_LINKED(o->state));
357
358 source_output_set_state(o, b ? PA_SOURCE_OUTPUT_CORKED : PA_SOURCE_OUTPUT_RUNNING);
359 }
360
361 int pa_source_output_set_rate(pa_source_output *o, uint32_t rate) {
362 pa_source_output_assert_ref(o);
363 pa_assert(PA_SOURCE_OUTPUT_LINKED(o->state));
364 pa_return_val_if_fail(o->thread_info.resampler, -1);
365
366 if (o->sample_spec.rate == rate)
367 return 0;
368
369 o->sample_spec.rate = rate;
370
371 pa_asyncmsgq_post(o->source->asyncmsgq, PA_MSGOBJECT(o), PA_SOURCE_OUTPUT_MESSAGE_SET_RATE, PA_UINT_TO_PTR(rate), 0, NULL, NULL);
372
373 pa_subscription_post(o->source->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
374 return 0;
375 }
376
377 void pa_source_output_set_name(pa_source_output *o, const char *name) {
378 pa_source_output_assert_ref(o);
379
380 if (!o->name && !name)
381 return;
382
383 if (o->name && name && !strcmp(o->name, name))
384 return;
385
386 pa_xfree(o->name);
387 o->name = pa_xstrdup(name);
388
389 if (PA_SOURCE_OUTPUT_LINKED(o->state)) {
390 pa_hook_fire(&o->source->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_NAME_CHANGED], o);
391 pa_subscription_post(o->source->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
392 }
393 }
394
395 pa_resample_method_t pa_source_output_get_resample_method(pa_source_output *o) {
396 pa_source_output_assert_ref(o);
397
398 return o->resample_method;
399 }
400
401 int pa_source_output_move_to(pa_source_output *o, pa_source *dest) {
402 pa_source *origin;
403 pa_resampler *new_resampler = NULL;
404 pa_source_output_move_hook_data hook_data;
405
406 pa_source_output_assert_ref(o);
407 pa_assert(PA_SOURCE_OUTPUT_LINKED(o->state));
408 pa_source_assert_ref(dest);
409
410 origin = o->source;
411
412 if (dest == origin)
413 return 0;
414
415 if (o->flags & PA_SOURCE_OUTPUT_DONT_MOVE)
416 return -1;
417
418 if (pa_idxset_size(dest->outputs) >= PA_MAX_OUTPUTS_PER_SOURCE) {
419 pa_log_warn("Failed to move source output: too many outputs per source.");
420 return -1;
421 }
422
423 if (o->thread_info.resampler &&
424 pa_sample_spec_equal(&origin->sample_spec, &dest->sample_spec) &&
425 pa_channel_map_equal(&origin->channel_map, &dest->channel_map))
426
427 /* Try to reuse the old resampler if possible */
428 new_resampler = o->thread_info.resampler;
429
430 else if ((o->flags & PA_SOURCE_OUTPUT_VARIABLE_RATE) ||
431 !pa_sample_spec_equal(&o->sample_spec, &dest->sample_spec) ||
432 !pa_channel_map_equal(&o->channel_map, &dest->channel_map)) {
433
434 /* Okey, we need a new resampler for the new source */
435
436 if (!(new_resampler = pa_resampler_new(
437 dest->core->mempool,
438 &dest->sample_spec, &dest->channel_map,
439 &o->sample_spec, &o->channel_map,
440 o->resample_method,
441 ((o->flags & PA_SOURCE_OUTPUT_VARIABLE_RATE) ? PA_RESAMPLER_VARIABLE_RATE : 0) |
442 ((o->flags & PA_SOURCE_OUTPUT_NO_REMAP) ? PA_RESAMPLER_NO_REMAP : 0) |
443 (o->core->disable_remixing || (o->flags & PA_SOURCE_OUTPUT_NO_REMIX) ? PA_RESAMPLER_NO_REMIX : 0)))) {
444 pa_log_warn("Unsupported resampling operation.");
445 return -1;
446 }
447 }
448
449 hook_data.source_output = o;
450 hook_data.destination = dest;
451 pa_hook_fire(&o->source->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_MOVE], &hook_data);
452
453 /* Okey, let's move it */
454 pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o->source), PA_SOURCE_MESSAGE_REMOVE_OUTPUT, o, 0, NULL);
455
456 pa_idxset_remove_by_data(origin->outputs, o, NULL);
457 pa_idxset_put(dest->outputs, o, NULL);
458 o->source = dest;
459
460 if (pa_source_output_get_state(o) == PA_SOURCE_OUTPUT_CORKED) {
461 pa_assert_se(origin->n_corked-- >= 1);
462 dest->n_corked++;
463 }
464
465 /* Replace resampler */
466 if (new_resampler != o->thread_info.resampler) {
467 if (o->thread_info.resampler)
468 pa_resampler_free(o->thread_info.resampler);
469 o->thread_info.resampler = new_resampler;
470 }
471
472 pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o->source), PA_SOURCE_MESSAGE_ADD_OUTPUT, o, 0, NULL);
473
474 pa_source_update_status(origin);
475 pa_source_update_status(dest);
476
477 if (o->moved)
478 o->moved(o);
479
480 pa_hook_fire(&o->source->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_MOVE_POST], o);
481
482 pa_log_debug("Successfully moved source output %i from %s to %s.", o->index, origin->name, dest->name);
483
484 /* Notify everyone */
485 pa_subscription_post(o->source->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
486
487 return 0;
488 }
489
490 /* Called from thread context */
491 int pa_source_output_process_msg(pa_msgobject *mo, int code, void *userdata, int64_t offset, pa_memchunk* chunk) {
492 pa_source_output *o = PA_SOURCE_OUTPUT(mo);
493
494 pa_source_output_assert_ref(o);
495 pa_assert(PA_SOURCE_OUTPUT_LINKED(o->thread_info.state));
496
497 switch (code) {
498
499 case PA_SOURCE_OUTPUT_MESSAGE_SET_RATE: {
500
501 o->thread_info.sample_spec.rate = PA_PTR_TO_UINT(userdata);
502 pa_resampler_set_output_rate(o->thread_info.resampler, PA_PTR_TO_UINT(userdata));
503
504 return 0;
505 }
506
507 case PA_SOURCE_OUTPUT_MESSAGE_SET_STATE: {
508 o->thread_info.state = PA_PTR_TO_UINT(userdata);
509
510 return 0;
511 }
512 }
513
514 return -1;
515 }