format: Don't assert on errors in getters
[profile/ivi/pulseaudio-panda.git] / src / modules / module-remap-sink.c
1 /***
2   This file is part of PulseAudio.
3
4   Copyright 2004-2009 Lennart Poettering
5
6   PulseAudio is free software; you can redistribute it and/or modify
7   it under the terms of the GNU Lesser General Public License as published
8   by the Free Software Foundation; either version 2.1 of the License,
9   or (at your option) any later version.
10
11   PulseAudio is distributed in the hope that it will be useful, but
12   WITHOUT ANY WARRANTY; without even the implied warranty of
13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14   General Public License for more details.
15
16   You should have received a copy of the GNU Lesser General Public License
17   along with PulseAudio; if not, write to the Free Software
18   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
19   USA.
20 ***/
21
22 #ifdef HAVE_CONFIG_H
23 #include <config.h>
24 #endif
25
26 #include <pulse/xmalloc.h>
27
28 #include <pulsecore/namereg.h>
29 #include <pulsecore/sink.h>
30 #include <pulsecore/module.h>
31 #include <pulsecore/core-util.h>
32 #include <pulsecore/modargs.h>
33 #include <pulsecore/log.h>
34 #include <pulsecore/rtpoll.h>
35
36 #include "module-remap-sink-symdef.h"
37
38 PA_MODULE_AUTHOR("Lennart Poettering");
39 PA_MODULE_DESCRIPTION("Virtual channel remapping sink");
40 PA_MODULE_VERSION(PACKAGE_VERSION);
41 PA_MODULE_LOAD_ONCE(FALSE);
42 PA_MODULE_USAGE(
43         "sink_name=<name for the sink> "
44         "sink_properties=<properties for the sink> "
45         "master=<name of sink to remap> "
46         "master_channel_map=<channel map> "
47         "format=<sample format> "
48         "rate=<sample rate> "
49         "channels=<number of channels> "
50         "channel_map=<channel map> "
51         "remix=<remix channels?>");
52
53 struct userdata {
54     pa_module *module;
55
56     pa_sink *sink;
57     pa_sink_input *sink_input;
58
59     pa_bool_t auto_desc;
60 };
61
62 static const char* const valid_modargs[] = {
63     "sink_name",
64     "sink_properties",
65     "master",
66     "master_channel_map",
67     "format",
68     "rate",
69     "channels",
70     "channel_map",
71     "remix",
72     NULL
73 };
74
75 /* Called from I/O thread context */
76 static int sink_process_msg(pa_msgobject *o, int code, void *data, int64_t offset, pa_memchunk *chunk) {
77     struct userdata *u = PA_SINK(o)->userdata;
78
79     switch (code) {
80
81         case PA_SINK_MESSAGE_GET_LATENCY:
82
83             /* The sink is _put() before the sink input is, so let's
84              * make sure we don't access it yet */
85             if (!PA_SINK_IS_LINKED(u->sink->thread_info.state) ||
86                 !PA_SINK_INPUT_IS_LINKED(u->sink_input->thread_info.state)) {
87                 *((pa_usec_t*) data) = 0;
88                 return 0;
89             }
90
91             *((pa_usec_t*) data) =
92                 /* Get the latency of the master sink */
93                 pa_sink_get_latency_within_thread(u->sink_input->sink) +
94
95                 /* Add the latency internal to our sink input on top */
96                 pa_bytes_to_usec(pa_memblockq_get_length(u->sink_input->thread_info.render_memblockq), &u->sink_input->sink->sample_spec);
97
98             return 0;
99     }
100
101     return pa_sink_process_msg(o, code, data, offset, chunk);
102 }
103
104 /* Called from main context */
105 static int sink_set_state(pa_sink *s, pa_sink_state_t state) {
106     struct userdata *u;
107
108     pa_sink_assert_ref(s);
109     pa_assert_se(u = s->userdata);
110
111     if (!PA_SINK_IS_LINKED(state) ||
112         !PA_SINK_INPUT_IS_LINKED(pa_sink_input_get_state(u->sink_input)))
113         return 0;
114
115     pa_sink_input_cork(u->sink_input, state == PA_SINK_SUSPENDED);
116     return 0;
117 }
118
119 /* Called from I/O thread context */
120 static void sink_request_rewind(pa_sink *s) {
121     struct userdata *u;
122
123     pa_sink_assert_ref(s);
124     pa_assert_se(u = s->userdata);
125
126     if (!PA_SINK_IS_LINKED(u->sink->thread_info.state) ||
127         !PA_SINK_INPUT_IS_LINKED(u->sink_input->thread_info.state))
128         return;
129
130     pa_sink_input_request_rewind(u->sink_input, s->thread_info.rewind_nbytes, TRUE, FALSE, FALSE);
131 }
132
133 /* Called from I/O thread context */
134 static void sink_update_requested_latency(pa_sink *s) {
135     struct userdata *u;
136
137     pa_sink_assert_ref(s);
138     pa_assert_se(u = s->userdata);
139
140     if (!PA_SINK_IS_LINKED(u->sink->thread_info.state) ||
141         !PA_SINK_INPUT_IS_LINKED(u->sink_input->thread_info.state))
142         return;
143
144     /* Just hand this one over to the master sink */
145     pa_sink_input_set_requested_latency_within_thread(
146             u->sink_input,
147             pa_sink_get_requested_latency_within_thread(s));
148 }
149
150 /* Called from I/O thread context */
151 static int sink_input_pop_cb(pa_sink_input *i, size_t nbytes, pa_memchunk *chunk) {
152     struct userdata *u;
153
154     pa_sink_input_assert_ref(i);
155     pa_assert(chunk);
156     pa_assert_se(u = i->userdata);
157
158     /* Hmm, process any rewind request that might be queued up */
159     pa_sink_process_rewind(u->sink, 0);
160
161     pa_sink_render(u->sink, nbytes, chunk);
162     return 0;
163 }
164
165 /* Called from I/O thread context */
166 static void sink_input_process_rewind_cb(pa_sink_input *i, size_t nbytes) {
167     size_t amount = 0;
168     struct userdata *u;
169
170     pa_sink_input_assert_ref(i);
171     pa_assert_se(u = i->userdata);
172
173     if (u->sink->thread_info.rewind_nbytes > 0) {
174         amount = PA_MIN(u->sink->thread_info.rewind_nbytes, nbytes);
175         u->sink->thread_info.rewind_nbytes = 0;
176     }
177
178     pa_sink_process_rewind(u->sink, amount);
179 }
180
181 /* Called from I/O thread context */
182 static void sink_input_update_max_rewind_cb(pa_sink_input *i, size_t nbytes) {
183     struct userdata *u;
184
185     pa_sink_input_assert_ref(i);
186     pa_assert_se(u = i->userdata);
187
188     pa_sink_set_max_rewind_within_thread(u->sink, nbytes);
189 }
190
191 /* Called from I/O thread context */
192 static void sink_input_update_max_request_cb(pa_sink_input *i, size_t nbytes) {
193     struct userdata *u;
194
195     pa_sink_input_assert_ref(i);
196     pa_assert_se(u = i->userdata);
197
198     pa_sink_set_max_request_within_thread(u->sink, nbytes);
199 }
200
201 /* Called from I/O thread context */
202 static void sink_input_update_sink_latency_range_cb(pa_sink_input *i) {
203     struct userdata *u;
204
205     pa_sink_input_assert_ref(i);
206     pa_assert_se(u = i->userdata);
207
208     pa_sink_set_latency_range_within_thread(u->sink, i->sink->thread_info.min_latency, i->sink->thread_info.max_latency);
209 }
210
211 /* Called from I/O thread context */
212 static void sink_input_update_sink_fixed_latency_cb(pa_sink_input *i) {
213     struct userdata *u;
214
215     pa_sink_input_assert_ref(i);
216     pa_assert_se(u = i->userdata);
217
218     pa_sink_set_fixed_latency_within_thread(u->sink, i->sink->thread_info.fixed_latency);
219 }
220
221 /* Called from I/O thread context */
222 static void sink_input_detach_cb(pa_sink_input *i) {
223     struct userdata *u;
224
225     pa_sink_input_assert_ref(i);
226     pa_assert_se(u = i->userdata);
227
228     pa_sink_detach_within_thread(u->sink);
229
230     pa_sink_set_rtpoll(u->sink, NULL);
231 }
232
233 /* Called from I/O thread context */
234 static void sink_input_attach_cb(pa_sink_input *i) {
235     struct userdata *u;
236
237     pa_sink_input_assert_ref(i);
238     pa_assert_se(u = i->userdata);
239
240     pa_sink_set_rtpoll(u->sink, i->sink->thread_info.rtpoll);
241     pa_sink_set_latency_range_within_thread(u->sink, i->sink->thread_info.min_latency, i->sink->thread_info.max_latency);
242     pa_sink_set_fixed_latency_within_thread(u->sink, i->sink->thread_info.fixed_latency);
243     pa_sink_set_max_request_within_thread(u->sink, pa_sink_input_get_max_request(i));
244     pa_sink_set_max_rewind_within_thread(u->sink, pa_sink_input_get_max_rewind(i));
245
246     pa_sink_attach_within_thread(u->sink);
247 }
248
249 /* Called from main context */
250 static void sink_input_kill_cb(pa_sink_input *i) {
251     struct userdata *u;
252
253     pa_sink_input_assert_ref(i);
254     pa_assert_se(u = i->userdata);
255
256     /* The order here matters! We first kill the sink input, followed
257      * by the sink. That means the sink callbacks must be protected
258      * against an unconnected sink input! */
259     pa_sink_input_unlink(u->sink_input);
260     pa_sink_unlink(u->sink);
261
262     pa_sink_input_unref(u->sink_input);
263     u->sink_input = NULL;
264
265     pa_sink_unref(u->sink);
266     u->sink = NULL;
267
268     pa_module_unload_request(u->module, TRUE);
269 }
270
271 /* Called from IO thread context */
272 static void sink_input_state_change_cb(pa_sink_input *i, pa_sink_input_state_t state) {
273     struct userdata *u;
274
275     pa_sink_input_assert_ref(i);
276     pa_assert_se(u = i->userdata);
277
278     /* If we are added for the first time, ask for a rewinding so that
279      * we are heard right-away. */
280     if (PA_SINK_INPUT_IS_LINKED(state) &&
281         i->thread_info.state == PA_SINK_INPUT_INIT) {
282         pa_log_debug("Requesting rewind due to state change.");
283         pa_sink_input_request_rewind(i, 0, FALSE, TRUE, TRUE);
284     }
285 }
286
287 /* Called from main context */
288 static pa_bool_t sink_input_may_move_to_cb(pa_sink_input *i, pa_sink *dest) {
289     struct userdata *u;
290
291     pa_sink_input_assert_ref(i);
292     pa_assert_se(u = i->userdata);
293
294     return u->sink != dest;
295 }
296
297 /* Called from main context */
298 static void sink_input_moving_cb(pa_sink_input *i, pa_sink *dest) {
299     struct userdata *u;
300
301     pa_sink_input_assert_ref(i);
302     pa_assert_se(u = i->userdata);
303
304     if (dest) {
305         pa_sink_set_asyncmsgq(u->sink, dest->asyncmsgq);
306         pa_sink_update_flags(u->sink, PA_SINK_LATENCY|PA_SINK_DYNAMIC_LATENCY, dest->flags);
307     } else
308         pa_sink_set_asyncmsgq(u->sink, NULL);
309
310     if (u->auto_desc && dest) {
311         const char *k;
312         pa_proplist *pl;
313
314         pl = pa_proplist_new();
315         k = pa_proplist_gets(dest->proplist, PA_PROP_DEVICE_DESCRIPTION);
316         pa_proplist_setf(pl, PA_PROP_DEVICE_DESCRIPTION, "Remapped %s", k ? k : dest->name);
317
318         pa_sink_update_proplist(u->sink, PA_UPDATE_REPLACE, pl);
319         pa_proplist_free(pl);
320     }
321 }
322
323 int pa__init(pa_module*m) {
324     struct userdata *u;
325     pa_sample_spec ss;
326     pa_channel_map sink_map, stream_map;
327     pa_modargs *ma;
328     pa_sink *master;
329     pa_sink_input_new_data sink_input_data;
330     pa_sink_new_data sink_data;
331     pa_bool_t remix = TRUE;
332
333     pa_assert(m);
334
335     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
336         pa_log("Failed to parse module arguments.");
337         goto fail;
338     }
339
340     if (!(master = pa_namereg_get(m->core, pa_modargs_get_value(ma, "master", NULL), PA_NAMEREG_SINK))) {
341         pa_log("Master sink not found");
342         goto fail;
343     }
344
345     ss = master->sample_spec;
346     sink_map = master->channel_map;
347     if (pa_modargs_get_sample_spec_and_channel_map(ma, &ss, &sink_map, PA_CHANNEL_MAP_DEFAULT) < 0) {
348         pa_log("Invalid sample format specification or channel map");
349         goto fail;
350     }
351
352     stream_map = sink_map;
353     if (pa_modargs_get_channel_map(ma, "master_channel_map", &stream_map) < 0) {
354         pa_log("Invalid master channel map");
355         goto fail;
356     }
357
358     if (stream_map.channels != ss.channels) {
359         pa_log("Number of channels doesn't match");
360         goto fail;
361     }
362
363     if (pa_channel_map_equal(&stream_map, &master->channel_map))
364         pa_log_warn("No remapping configured, proceeding nonetheless!");
365
366     if (pa_modargs_get_value_boolean(ma, "remix", &remix) < 0) {
367         pa_log("Invalid boolean remix parameter");
368         goto fail;
369     }
370
371     u = pa_xnew0(struct userdata, 1);
372     u->module = m;
373     m->userdata = u;
374
375     /* Create sink */
376     pa_sink_new_data_init(&sink_data);
377     sink_data.driver = __FILE__;
378     sink_data.module = m;
379     if (!(sink_data.name = pa_xstrdup(pa_modargs_get_value(ma, "sink_name", NULL))))
380         sink_data.name = pa_sprintf_malloc("%s.remapped", master->name);
381     pa_sink_new_data_set_sample_spec(&sink_data, &ss);
382     pa_sink_new_data_set_channel_map(&sink_data, &sink_map);
383     pa_proplist_sets(sink_data.proplist, PA_PROP_DEVICE_MASTER_DEVICE, master->name);
384     pa_proplist_sets(sink_data.proplist, PA_PROP_DEVICE_CLASS, "filter");
385
386     if (pa_modargs_get_proplist(ma, "sink_properties", sink_data.proplist, PA_UPDATE_REPLACE) < 0) {
387         pa_log("Invalid properties");
388         pa_sink_new_data_done(&sink_data);
389         goto fail;
390     }
391
392     if ((u->auto_desc = !pa_proplist_contains(sink_data.proplist, PA_PROP_DEVICE_DESCRIPTION))) {
393         const char *k;
394
395         k = pa_proplist_gets(master->proplist, PA_PROP_DEVICE_DESCRIPTION);
396         pa_proplist_setf(sink_data.proplist, PA_PROP_DEVICE_DESCRIPTION, "Remapped %s", k ? k : master->name);
397     }
398
399     u->sink = pa_sink_new(m->core, &sink_data, master->flags & (PA_SINK_LATENCY|PA_SINK_DYNAMIC_LATENCY));
400     pa_sink_new_data_done(&sink_data);
401
402     if (!u->sink) {
403         pa_log("Failed to create sink.");
404         goto fail;
405     }
406
407     u->sink->parent.process_msg = sink_process_msg;
408     u->sink->set_state = sink_set_state;
409     u->sink->update_requested_latency = sink_update_requested_latency;
410     u->sink->request_rewind = sink_request_rewind;
411     u->sink->userdata = u;
412
413     pa_sink_set_asyncmsgq(u->sink, master->asyncmsgq);
414
415     /* Create sink input */
416     pa_sink_input_new_data_init(&sink_input_data);
417     sink_input_data.driver = __FILE__;
418     sink_input_data.module = m;
419     pa_sink_input_new_data_set_sink(&sink_input_data, master, FALSE);
420     sink_input_data.origin_sink = u->sink;
421     pa_proplist_sets(sink_input_data.proplist, PA_PROP_MEDIA_NAME, "Remapped Stream");
422     pa_proplist_sets(sink_input_data.proplist, PA_PROP_MEDIA_ROLE, "filter");
423     pa_sink_input_new_data_set_sample_spec(&sink_input_data, &ss);
424     pa_sink_input_new_data_set_channel_map(&sink_input_data, &stream_map);
425     sink_input_data.flags = (remix ? 0 : PA_SINK_INPUT_NO_REMIX);
426
427     pa_sink_input_new(&u->sink_input, m->core, &sink_input_data);
428     pa_sink_input_new_data_done(&sink_input_data);
429
430     if (!u->sink_input)
431         goto fail;
432
433     u->sink_input->pop = sink_input_pop_cb;
434     u->sink_input->process_rewind = sink_input_process_rewind_cb;
435     u->sink_input->update_max_rewind = sink_input_update_max_rewind_cb;
436     u->sink_input->update_max_request = sink_input_update_max_request_cb;
437     u->sink_input->update_sink_latency_range = sink_input_update_sink_latency_range_cb;
438     u->sink_input->update_sink_fixed_latency = sink_input_update_sink_fixed_latency_cb;
439     u->sink_input->attach = sink_input_attach_cb;
440     u->sink_input->detach = sink_input_detach_cb;
441     u->sink_input->kill = sink_input_kill_cb;
442     u->sink_input->state_change = sink_input_state_change_cb;
443     u->sink_input->may_move_to = sink_input_may_move_to_cb;
444     u->sink_input->moving = sink_input_moving_cb;
445     u->sink_input->userdata = u;
446
447     u->sink->input_to_master = u->sink_input;
448
449     pa_sink_put(u->sink);
450     pa_sink_input_put(u->sink_input);
451
452     pa_modargs_free(ma);
453
454     return 0;
455
456 fail:
457     if (ma)
458         pa_modargs_free(ma);
459
460     pa__done(m);
461
462     return -1;
463 }
464
465 int pa__get_n_used(pa_module *m) {
466     struct userdata *u;
467
468     pa_assert(m);
469     pa_assert_se(u = m->userdata);
470
471     return pa_sink_linked_by(u->sink);
472 }
473
474 void pa__done(pa_module*m) {
475     struct userdata *u;
476
477     pa_assert(m);
478
479     if (!(u = m->userdata))
480         return;
481
482     /* See comments in sink_input_kill_cb() above regarding
483      * destruction order! */
484
485     if (u->sink_input)
486         pa_sink_input_unlink(u->sink_input);
487
488     if (u->sink)
489         pa_sink_unlink(u->sink);
490
491     if (u->sink_input)
492         pa_sink_input_unref(u->sink_input);
493
494     if (u->sink)
495         pa_sink_unref(u->sink);
496
497     pa_xfree(u);
498 }