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