]> code.delx.au - pulseaudio/blob - src/pulsecore/source-output.c
add comments describing the context these functions are called from
[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_DISCONNECTED);
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 pa_log_warn("Unsupported resampling operation.");
126 return NULL;
127 }
128
129 data->resample_method = pa_resampler_get_method(resampler);
130 }
131
132 o = pa_msgobject_new(pa_source_output);
133 o->parent.parent.free = source_output_free;
134 o->parent.process_msg = pa_source_output_process_msg;
135
136 o->core = core;
137 o->state = data->start_corked ? PA_SOURCE_OUTPUT_CORKED : PA_SOURCE_OUTPUT_RUNNING;
138 o->flags = flags;
139 o->name = pa_xstrdup(data->name);
140 o->driver = pa_xstrdup(data->driver);
141 o->module = data->module;
142 o->source = data->source;
143 o->client = data->client;
144
145 o->resample_method = data->resample_method;
146 o->sample_spec = data->sample_spec;
147 o->channel_map = data->channel_map;
148
149 o->push = NULL;
150 o->kill = NULL;
151 o->get_latency = NULL;
152 o->userdata = NULL;
153
154 o->thread_info.state = o->state;
155 o->thread_info.sample_spec = o->sample_spec;
156 o->thread_info.resampler = resampler;
157
158 pa_assert_se(pa_idxset_put(core->source_outputs, o, &o->index) == 0);
159 pa_assert_se(pa_idxset_put(o->source->outputs, pa_source_output_ref(o), NULL) == 0);
160
161 pa_log_info("Created output %u \"%s\" on %s with sample spec %s",
162 o->index,
163 o->name,
164 o->source->name,
165 pa_sample_spec_snprint(st, sizeof(st), &o->sample_spec));
166
167 /* Don't forget to call pa_source_output_put! */
168
169 return o;
170 }
171
172 static int source_output_set_state(pa_source_output *o, pa_source_output_state_t state) {
173 pa_assert(o);
174
175 if (o->state == state)
176 return 0;
177
178 if (pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o), PA_SOURCE_OUTPUT_MESSAGE_SET_STATE, PA_UINT_TO_PTR(state), 0, NULL) < 0)
179 return -1;
180
181 o->state = state;
182 return 0;
183 }
184
185 void pa_source_output_disconnect(pa_source_output*o) {
186 pa_assert(o);
187 pa_return_if_fail(o->state != PA_SOURCE_OUTPUT_DISCONNECTED);
188
189 pa_hook_fire(&o->source->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_DISCONNECT], o);
190
191 pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o->source), PA_SOURCE_MESSAGE_REMOVE_OUTPUT, o, 0, NULL);
192
193 pa_idxset_remove_by_data(o->source->core->source_outputs, o, NULL);
194 pa_idxset_remove_by_data(o->source->outputs, o, NULL);
195
196 pa_subscription_post(o->source->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_REMOVE, o->index);
197
198 source_output_set_state(o, PA_SOURCE_OUTPUT_DISCONNECTED);
199 pa_source_update_status(o->source);
200
201 o->push = NULL;
202 o->kill = NULL;
203 o->get_latency = NULL;
204
205 pa_hook_fire(&o->source->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_DISCONNECT_POST], o);
206
207 o->source = NULL;
208 pa_source_output_unref(o);
209 }
210
211 static void source_output_free(pa_object* mo) {
212 pa_source_output *o = PA_SOURCE_OUTPUT(mo);
213
214 pa_assert(pa_source_output_refcnt(o) == 0);
215
216 if (o->state != PA_SOURCE_OUTPUT_DISCONNECTED)
217 pa_source_output_disconnect(o);
218
219 pa_log_info("Freeing output %u \"%s\"", o->index, o->name);
220
221 if (o->thread_info.resampler)
222 pa_resampler_free(o->thread_info.resampler);
223
224 pa_xfree(o->name);
225 pa_xfree(o->driver);
226 pa_xfree(o);
227 }
228
229 void pa_source_output_put(pa_source_output *o) {
230 pa_source_output_assert_ref(o);
231
232 pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o->source), PA_SOURCE_MESSAGE_ADD_OUTPUT, o, 0, NULL);
233 pa_source_update_status(o->source);
234
235 pa_subscription_post(o->source->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_NEW, o->index);
236
237 pa_hook_fire(&o->source->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_PUT], o);
238 }
239
240 void pa_source_output_kill(pa_source_output*o) {
241 pa_source_output_assert_ref(o);
242
243 if (o->kill)
244 o->kill(o);
245 }
246
247 pa_usec_t pa_source_output_get_latency(pa_source_output *o) {
248 pa_usec_t r = 0;
249
250 pa_source_output_assert_ref(o);
251
252 if (pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o), PA_SOURCE_OUTPUT_MESSAGE_GET_LATENCY, &r, 0, NULL) < 0)
253 r = 0;
254
255 if (o->get_latency)
256 r += o->get_latency(o);
257
258 return r;
259 }
260
261 /* Called from thread context */
262 void pa_source_output_push(pa_source_output *o, const pa_memchunk *chunk) {
263 pa_memchunk rchunk;
264
265 pa_source_output_assert_ref(o);
266 pa_assert(chunk);
267 pa_assert(chunk->length);
268
269 if (!o->push || o->state == PA_SOURCE_OUTPUT_DISCONNECTED || o->state == PA_SOURCE_OUTPUT_CORKED)
270 return;
271
272 pa_assert(o->state == PA_SOURCE_OUTPUT_RUNNING);
273
274 if (!o->thread_info.resampler) {
275 o->push(o, chunk);
276 return;
277 }
278
279 pa_resampler_run(o->thread_info.resampler, chunk, &rchunk);
280 if (!rchunk.length)
281 return;
282
283 pa_assert(rchunk.memblock);
284 o->push(o, &rchunk);
285 pa_memblock_unref(rchunk.memblock);
286 }
287
288 void pa_source_output_cork(pa_source_output *o, int b) {
289 pa_source_output_assert_ref(o);
290
291 source_output_set_state(o, b ? PA_SOURCE_OUTPUT_CORKED : PA_SOURCE_OUTPUT_RUNNING);
292 }
293
294 int pa_source_output_set_rate(pa_source_output *o, uint32_t rate) {
295 pa_source_output_assert_ref(o);
296 pa_return_val_if_fail(o->thread_info.resampler, -1);
297
298 if (o->sample_spec.rate == rate)
299 return 0;
300
301 o->sample_spec.rate = rate;
302
303 pa_asyncmsgq_post(o->source->asyncmsgq, PA_MSGOBJECT(o), PA_SOURCE_OUTPUT_MESSAGE_SET_RATE, PA_UINT_TO_PTR(rate), 0, NULL, NULL);
304
305 pa_subscription_post(o->source->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
306 return 0;
307 }
308
309 void pa_source_output_set_name(pa_source_output *o, const char *name) {
310 pa_source_output_assert_ref(o);
311
312 if (!o->name && !name)
313 return;
314
315 if (o->name && name && !strcmp(o->name, name))
316 return;
317
318 pa_xfree(o->name);
319 o->name = pa_xstrdup(name);
320
321 pa_subscription_post(o->source->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
322 }
323
324 pa_resample_method_t pa_source_output_get_resample_method(pa_source_output *o) {
325 pa_source_output_assert_ref(o);
326
327 return o->resample_method;
328 }
329
330 int pa_source_output_move_to(pa_source_output *o, pa_source *dest) {
331 pa_source *origin;
332 pa_resampler *new_resampler = NULL;
333
334 pa_source_output_assert_ref(o);
335 pa_source_assert_ref(dest);
336
337 origin = o->source;
338
339 if (dest == origin)
340 return 0;
341
342 if (pa_idxset_size(dest->outputs) >= PA_MAX_OUTPUTS_PER_SOURCE) {
343 pa_log_warn("Failed to move source output: too many outputs per source.");
344 return -1;
345 }
346
347 if (o->thread_info.resampler &&
348 pa_sample_spec_equal(&origin->sample_spec, &dest->sample_spec) &&
349 pa_channel_map_equal(&origin->channel_map, &dest->channel_map))
350
351 /* Try to reuse the old resampler if possible */
352 new_resampler = o->thread_info.resampler;
353
354 else if (!pa_sample_spec_equal(&o->sample_spec, &dest->sample_spec) ||
355 !pa_channel_map_equal(&o->channel_map, &dest->channel_map)) {
356
357 /* Okey, we need a new resampler for the new source */
358
359 if (!(new_resampler = pa_resampler_new(
360 dest->core->mempool,
361 &dest->sample_spec, &dest->channel_map,
362 &o->sample_spec, &o->channel_map,
363 o->resample_method))) {
364 pa_log_warn("Unsupported resampling operation.");
365 return -1;
366 }
367 }
368
369 pa_hook_fire(&o->source->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_MOVE], o);
370
371 /* Okey, let's move it */
372 pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o->source), PA_SOURCE_MESSAGE_REMOVE_OUTPUT, o, 0, NULL);
373
374 pa_idxset_remove_by_data(origin->outputs, o, NULL);
375 pa_idxset_put(dest->outputs, o, NULL);
376 o->source = dest;
377
378 /* Replace resampler */
379 if (new_resampler != o->thread_info.resampler) {
380 if (o->thread_info.resampler)
381 pa_resampler_free(o->thread_info.resampler);
382 o->thread_info.resampler = new_resampler;
383 }
384
385 pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o->source), PA_SOURCE_MESSAGE_ADD_OUTPUT, o, 0, NULL);
386
387 pa_source_update_status(origin);
388 pa_source_update_status(dest);
389
390 pa_hook_fire(&o->source->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_MOVE_POST], o);
391
392 pa_log_debug("Successfully moved source output %i from %s to %s.", o->index, origin->name, dest->name);
393
394 /* Notify everyone */
395 pa_subscription_post(o->source->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
396
397 return 0;
398 }
399
400 /* Called from thread context */
401 int pa_source_output_process_msg(pa_msgobject *mo, int code, void *userdata, int64_t offset, pa_memchunk* chunk) {
402 pa_source_output *o = PA_SOURCE_OUTPUT(mo);
403
404 pa_source_output_assert_ref(o);
405
406 switch (code) {
407
408 case PA_SOURCE_OUTPUT_MESSAGE_SET_RATE: {
409
410 o->thread_info.sample_spec.rate = PA_PTR_TO_UINT(userdata);
411 pa_resampler_set_output_rate(o->thread_info.resampler, PA_PTR_TO_UINT(userdata));
412
413 return 0;
414 }
415
416 case PA_SOURCE_OUTPUT_MESSAGE_SET_STATE: {
417 o->thread_info.state = PA_PTR_TO_UINT(userdata);
418
419 return 0;
420 }
421
422 }
423
424 return -1;
425 }