when changing volume, store whether it is worth remembering or no
[profile/ivi/pulseaudio-panda.git] / src / pulsecore / sink-input.c
1 /***
2   This file is part of PulseAudio.
3
4   Copyright 2004-2006 Lennart Poettering
5   Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
6
7   PulseAudio is free software; you can redistribute it and/or modify
8   it under the terms of the GNU Lesser General Public License as published
9   by the Free Software Foundation; either version 2 of the License,
10   or (at your option) any later version.
11
12   PulseAudio is distributed in the hope that it will be useful, but
13   WITHOUT ANY WARRANTY; without even the implied warranty of
14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15   General Public License for more details.
16
17   You should have received a copy of the GNU Lesser General Public License
18   along with PulseAudio; if not, write to the Free Software
19   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
20   USA.
21 ***/
22
23 #ifdef HAVE_CONFIG_H
24 #include <config.h>
25 #endif
26
27 #include <stdio.h>
28 #include <stdlib.h>
29 #include <string.h>
30
31 #include <pulse/utf8.h>
32 #include <pulse/xmalloc.h>
33 #include <pulse/util.h>
34
35 #include <pulsecore/sample-util.h>
36 #include <pulsecore/core-subscribe.h>
37 #include <pulsecore/log.h>
38 #include <pulsecore/play-memblockq.h>
39 #include <pulsecore/namereg.h>
40 #include <pulsecore/core-util.h>
41
42 #include "sink-input.h"
43
44 #define MEMBLOCKQ_MAXLENGTH (32*1024*1024)
45 #define CONVERT_BUFFER_LENGTH (PA_PAGE_SIZE)
46
47 static PA_DEFINE_CHECK_TYPE(pa_sink_input, pa_msgobject);
48
49 static void sink_input_free(pa_object *o);
50
51 pa_sink_input_new_data* pa_sink_input_new_data_init(pa_sink_input_new_data *data) {
52     pa_assert(data);
53
54     memset(data, 0, sizeof(*data));
55     data->resample_method = PA_RESAMPLER_INVALID;
56     data->proplist = pa_proplist_new();
57
58     return data;
59 }
60
61 void pa_sink_input_new_data_set_sample_spec(pa_sink_input_new_data *data, const pa_sample_spec *spec) {
62     pa_assert(data);
63
64     if ((data->sample_spec_is_set = !!spec))
65         data->sample_spec = *spec;
66 }
67
68 void pa_sink_input_new_data_set_channel_map(pa_sink_input_new_data *data, const pa_channel_map *map) {
69     pa_assert(data);
70
71     if ((data->channel_map_is_set = !!map))
72         data->channel_map = *map;
73 }
74
75 void pa_sink_input_new_data_set_soft_volume(pa_sink_input_new_data *data, const pa_cvolume *volume) {
76     pa_assert(data);
77
78     if ((data->soft_volume_is_set = !!volume))
79         data->soft_volume = *volume;
80 }
81
82 void pa_sink_input_new_data_set_virtual_volume(pa_sink_input_new_data *data, const pa_cvolume *volume) {
83     pa_assert(data);
84
85     if ((data->virtual_volume_is_set = !!volume))
86         data->virtual_volume = *volume;
87 }
88
89 void pa_sink_input_new_data_set_muted(pa_sink_input_new_data *data, pa_bool_t mute) {
90     pa_assert(data);
91
92     data->muted_is_set = TRUE;
93     data->muted = !!mute;
94 }
95
96 void pa_sink_input_new_data_done(pa_sink_input_new_data *data) {
97     pa_assert(data);
98
99     pa_proplist_free(data->proplist);
100 }
101
102 /* Called from main context */
103 static void reset_callbacks(pa_sink_input *i) {
104     pa_assert(i);
105
106     i->pop = NULL;
107     i->process_rewind = NULL;
108     i->update_max_rewind = NULL;
109     i->update_max_request = NULL;
110     i->update_sink_requested_latency = NULL;
111     i->update_sink_latency_range = NULL;
112     i->attach = NULL;
113     i->detach = NULL;
114     i->suspend = NULL;
115     i->moved = NULL;
116     i->kill = NULL;
117     i->get_latency = NULL;
118     i->state_change = NULL;
119     i->may_move_to = NULL;
120 }
121
122 /* Called from main context */
123 pa_sink_input* pa_sink_input_new(
124         pa_core *core,
125         pa_sink_input_new_data *data,
126         pa_sink_input_flags_t flags) {
127
128     pa_sink_input *i;
129     pa_resampler *resampler = NULL;
130     char st[PA_SAMPLE_SPEC_SNPRINT_MAX], cm[PA_CHANNEL_MAP_SNPRINT_MAX];
131     pa_channel_map original_cm;
132
133     pa_assert(core);
134     pa_assert(data);
135
136     if (pa_hook_fire(&core->hooks[PA_CORE_HOOK_SINK_INPUT_NEW], data) < 0)
137         return NULL;
138
139     pa_return_null_if_fail(!data->driver || pa_utf8_valid(data->driver));
140
141     if (!data->sink) {
142         data->sink = pa_namereg_get(core, NULL, PA_NAMEREG_SINK);
143         data->save_sink = FALSE;
144     }
145
146     pa_return_null_if_fail(data->sink);
147     pa_return_null_if_fail(pa_sink_get_state(data->sink) != PA_SINK_UNLINKED);
148     pa_return_null_if_fail(!data->sync_base || (data->sync_base->sink == data->sink && pa_sink_input_get_state(data->sync_base) == PA_SINK_INPUT_CORKED));
149
150     if (!data->sample_spec_is_set)
151         data->sample_spec = data->sink->sample_spec;
152
153     pa_return_null_if_fail(pa_sample_spec_valid(&data->sample_spec));
154
155     if (!data->channel_map_is_set) {
156         if (pa_channel_map_compatible(&data->sink->channel_map, &data->sample_spec))
157             data->channel_map = data->sink->channel_map;
158         else
159             pa_channel_map_init_extend(&data->channel_map, data->sample_spec.channels, PA_CHANNEL_MAP_DEFAULT);
160     }
161
162     pa_return_null_if_fail(pa_channel_map_valid(&data->channel_map));
163     pa_return_null_if_fail(pa_channel_map_compatible(&data->channel_map, &data->sample_spec));
164
165     if (!data->virtual_volume_is_set) {
166
167         if (data->sink->flags & PA_SINK_FLAT_VOLUME) {
168             data->virtual_volume = data->sink->virtual_volume;
169             pa_cvolume_remap(&data->virtual_volume, &data->sink->channel_map, &data->channel_map);
170         } else
171             pa_cvolume_reset(&data->virtual_volume, data->sample_spec.channels);
172
173         data->save_volume = FALSE;
174
175     } else if (!data->virtual_volume_is_absolute) {
176
177         /* When the 'absolute' bool is set then we'll treat the volume
178          * as relative to the sink volume even in flat volume mode */
179         if (data->sink->flags & PA_SINK_FLAT_VOLUME) {
180             pa_cvolume t = data->sink->virtual_volume;
181             pa_cvolume_remap(&t, &data->sink->channel_map, &data->channel_map);
182             pa_sw_cvolume_multiply(&data->virtual_volume, &data->virtual_volume, &t);
183         }
184     }
185
186     pa_return_null_if_fail(pa_cvolume_valid(&data->virtual_volume));
187     pa_return_null_if_fail(pa_cvolume_compatible(&data->virtual_volume, &data->sample_spec));
188
189     if (!data->soft_volume_is_set)
190         data->soft_volume = data->virtual_volume;
191
192     pa_return_null_if_fail(pa_cvolume_valid(&data->soft_volume));
193     pa_return_null_if_fail(pa_cvolume_compatible(&data->soft_volume, &data->sample_spec));
194
195     if (!data->muted_is_set)
196         data->muted = FALSE;
197
198     if (flags & PA_SINK_INPUT_FIX_FORMAT)
199         data->sample_spec.format = data->sink->sample_spec.format;
200
201     if (flags & PA_SINK_INPUT_FIX_RATE)
202         data->sample_spec.rate = data->sink->sample_spec.rate;
203
204     original_cm = data->channel_map;
205
206     if (flags & PA_SINK_INPUT_FIX_CHANNELS) {
207         data->sample_spec.channels = data->sink->sample_spec.channels;
208         data->channel_map = data->sink->channel_map;
209     }
210
211     pa_assert(pa_sample_spec_valid(&data->sample_spec));
212     pa_assert(pa_channel_map_valid(&data->channel_map));
213
214     /* Due to the fixing of the sample spec the volume might not match anymore */
215     pa_cvolume_remap(&data->soft_volume, &original_cm, &data->channel_map);
216     pa_cvolume_remap(&data->virtual_volume, &original_cm, &data->channel_map);
217
218     if (data->resample_method == PA_RESAMPLER_INVALID)
219         data->resample_method = core->resample_method;
220
221     pa_return_null_if_fail(data->resample_method < PA_RESAMPLER_MAX);
222
223     if (data->client)
224         pa_proplist_update(data->proplist, PA_UPDATE_MERGE, data->client->proplist);
225
226     if (pa_hook_fire(&core->hooks[PA_CORE_HOOK_SINK_INPUT_FIXATE], data) < 0)
227         return NULL;
228
229     if (pa_idxset_size(data->sink->inputs) >= PA_MAX_INPUTS_PER_SINK) {
230         pa_log_warn("Failed to create sink input: too many inputs per sink.");
231         return NULL;
232     }
233
234     if ((flags & PA_SINK_INPUT_VARIABLE_RATE) ||
235         !pa_sample_spec_equal(&data->sample_spec, &data->sink->sample_spec) ||
236         !pa_channel_map_equal(&data->channel_map, &data->sink->channel_map)) {
237
238         if (!(resampler = pa_resampler_new(
239                       core->mempool,
240                       &data->sample_spec, &data->channel_map,
241                       &data->sink->sample_spec, &data->sink->channel_map,
242                       data->resample_method,
243                       ((flags & PA_SINK_INPUT_VARIABLE_RATE) ? PA_RESAMPLER_VARIABLE_RATE : 0) |
244                       ((flags & PA_SINK_INPUT_NO_REMAP) ? PA_RESAMPLER_NO_REMAP : 0) |
245                       (core->disable_remixing || (flags & PA_SINK_INPUT_NO_REMIX) ? PA_RESAMPLER_NO_REMIX : 0) |
246                       (core->disable_lfe_remixing ? PA_RESAMPLER_NO_LFE : 0)))) {
247             pa_log_warn("Unsupported resampling operation.");
248             return NULL;
249         }
250     }
251
252     i = pa_msgobject_new(pa_sink_input);
253     i->parent.parent.free = sink_input_free;
254     i->parent.process_msg = pa_sink_input_process_msg;
255
256     i->core = core;
257     i->state = PA_SINK_INPUT_INIT;
258     i->flags = flags;
259     i->proplist = pa_proplist_copy(data->proplist);
260     i->driver = pa_xstrdup(pa_path_get_filename(data->driver));
261     i->module = data->module;
262     i->sink = data->sink;
263     i->client = data->client;
264
265     i->requested_resample_method = data->resample_method;
266     i->actual_resample_method = resampler ? pa_resampler_get_method(resampler) : PA_RESAMPLER_INVALID;
267     i->sample_spec = data->sample_spec;
268     i->channel_map = data->channel_map;
269
270     i->virtual_volume = data->virtual_volume;
271     i->soft_volume = data->soft_volume;
272     i->save_volume = data->save_volume;
273     i->save_sink = data->save_sink;
274     i->save_muted = data->save_muted;
275
276     i->muted = data->muted;
277
278     if (data->sync_base) {
279         i->sync_next = data->sync_base->sync_next;
280         i->sync_prev = data->sync_base;
281
282         if (data->sync_base->sync_next)
283             data->sync_base->sync_next->sync_prev = i;
284         data->sync_base->sync_next = i;
285     } else
286         i->sync_next = i->sync_prev = NULL;
287
288     i->direct_outputs = pa_idxset_new(NULL, NULL);
289
290     reset_callbacks(i);
291     i->userdata = NULL;
292
293     i->thread_info.state = i->state;
294     i->thread_info.attached = FALSE;
295     pa_atomic_store(&i->thread_info.drained, 1);
296     i->thread_info.sample_spec = i->sample_spec;
297     i->thread_info.resampler = resampler;
298     i->thread_info.soft_volume = i->soft_volume;
299     i->thread_info.muted = i->muted;
300     i->thread_info.requested_sink_latency = (pa_usec_t) -1;
301     i->thread_info.rewrite_nbytes = 0;
302     i->thread_info.rewrite_flush = FALSE;
303     i->thread_info.dont_rewind_render = FALSE;
304     i->thread_info.underrun_for = (uint64_t) -1;
305     i->thread_info.playing_for = 0;
306     i->thread_info.direct_outputs = pa_hashmap_new(pa_idxset_trivial_hash_func, pa_idxset_trivial_compare_func);
307
308     i->thread_info.render_memblockq = pa_memblockq_new(
309             0,
310             MEMBLOCKQ_MAXLENGTH,
311             0,
312             pa_frame_size(&i->sink->sample_spec),
313             0,
314             1,
315             0,
316             &i->sink->silence);
317
318     pa_assert_se(pa_idxset_put(core->sink_inputs, pa_sink_input_ref(i), &i->index) == 0);
319     pa_assert_se(pa_idxset_put(i->sink->inputs, i, NULL) == 0);
320
321     if (i->client)
322         pa_assert_se(pa_idxset_put(i->client->sink_inputs, i, NULL) >= 0);
323
324     pa_log_info("Created input %u \"%s\" on %s with sample spec %s and channel map %s",
325                 i->index,
326                 pa_strnull(pa_proplist_gets(i->proplist, PA_PROP_MEDIA_NAME)),
327                 i->sink->name,
328                 pa_sample_spec_snprint(st, sizeof(st), &i->sample_spec),
329                 pa_channel_map_snprint(cm, sizeof(cm), &i->channel_map));
330
331     /* Don't forget to call pa_sink_input_put! */
332
333     return i;
334 }
335
336 /* Called from main context */
337 static void update_n_corked(pa_sink_input *i, pa_sink_input_state_t state) {
338     pa_assert(i);
339
340     if (!i->sink)
341         return;
342
343     if (i->state == PA_SINK_INPUT_CORKED && state != PA_SINK_INPUT_CORKED)
344         pa_assert_se(i->sink->n_corked -- >= 1);
345     else if (i->state != PA_SINK_INPUT_CORKED && state == PA_SINK_INPUT_CORKED)
346         i->sink->n_corked++;
347 }
348
349 /* Called from main context */
350 static int sink_input_set_state(pa_sink_input *i, pa_sink_input_state_t state) {
351     pa_sink_input *ssync;
352     pa_assert(i);
353
354     if (state == PA_SINK_INPUT_DRAINED)
355         state = PA_SINK_INPUT_RUNNING;
356
357     if (i->state == state)
358         return 0;
359
360     pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_SET_STATE, PA_UINT_TO_PTR(state), 0, NULL) == 0);
361
362     update_n_corked(i, state);
363     i->state = state;
364
365     for (ssync = i->sync_prev; ssync; ssync = ssync->sync_prev) {
366         update_n_corked(ssync, state);
367         ssync->state = state;
368     }
369     for (ssync = i->sync_next; ssync; ssync = ssync->sync_next) {
370         update_n_corked(ssync, state);
371         ssync->state = state;
372     }
373
374     if (state != PA_SINK_INPUT_UNLINKED) {
375         pa_hook_fire(&i->core->hooks[PA_CORE_HOOK_SINK_INPUT_STATE_CHANGED], i);
376
377         for (ssync = i->sync_prev; ssync; ssync = ssync->sync_prev)
378             pa_hook_fire(&i->core->hooks[PA_CORE_HOOK_SINK_INPUT_STATE_CHANGED], ssync);
379
380         for (ssync = i->sync_next; ssync; ssync = ssync->sync_next)
381             pa_hook_fire(&i->core->hooks[PA_CORE_HOOK_SINK_INPUT_STATE_CHANGED], ssync);
382     }
383
384     pa_sink_update_status(i->sink);
385
386     return 0;
387 }
388
389 /* Called from main context */
390 void pa_sink_input_unlink(pa_sink_input *i) {
391     pa_bool_t linked;
392     pa_source_output *o, *p =  NULL;
393     pa_assert(i);
394
395     /* See pa_sink_unlink() for a couple of comments how this function
396      * works */
397
398     pa_sink_input_ref(i);
399
400     linked = PA_SINK_INPUT_IS_LINKED(i->state);
401
402     if (linked)
403         pa_hook_fire(&i->core->hooks[PA_CORE_HOOK_SINK_INPUT_UNLINK], i);
404
405     if (i->sync_prev)
406         i->sync_prev->sync_next = i->sync_next;
407     if (i->sync_next)
408         i->sync_next->sync_prev = i->sync_prev;
409
410     i->sync_prev = i->sync_next = NULL;
411
412     pa_idxset_remove_by_data(i->core->sink_inputs, i, NULL);
413
414     if (i->sink)
415         if (pa_idxset_remove_by_data(i->sink->inputs, i, NULL))
416             pa_sink_input_unref(i);
417
418     if (i->client)
419         pa_idxset_remove_by_data(i->client->sink_inputs, i, NULL);
420
421     while ((o = pa_idxset_first(i->direct_outputs, NULL))) {
422         pa_assert(o != p);
423         pa_source_output_kill(o);
424         p = o;
425     }
426
427     update_n_corked(i, PA_SINK_INPUT_UNLINKED);
428     i->state = PA_SINK_INPUT_UNLINKED;
429
430     if (linked && i->sink) {
431         /* We might need to update the sink's volume if we are in flat volume mode. */
432         if (i->sink->flags & PA_SINK_FLAT_VOLUME) {
433             pa_cvolume new_volume;
434             pa_sink_update_flat_volume(i->sink, &new_volume);
435             pa_sink_set_volume(i->sink, &new_volume, FALSE, FALSE);
436         }
437
438         if (i->sink->asyncmsgq)
439             pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i->sink), PA_SINK_MESSAGE_REMOVE_INPUT, i, 0, NULL) == 0);
440     }
441
442     reset_callbacks(i);
443
444     if (linked) {
445         pa_subscription_post(i->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_REMOVE, i->index);
446         pa_hook_fire(&i->core->hooks[PA_CORE_HOOK_SINK_INPUT_UNLINK_POST], i);
447     }
448
449     if (i->sink) {
450         pa_sink_update_status(i->sink);
451         i->sink = NULL;
452     }
453
454     pa_sink_input_unref(i);
455 }
456
457 /* Called from main context */
458 static void sink_input_free(pa_object *o) {
459     pa_sink_input* i = PA_SINK_INPUT(o);
460
461     pa_assert(i);
462     pa_assert(pa_sink_input_refcnt(i) == 0);
463
464     if (PA_SINK_INPUT_IS_LINKED(i->state))
465         pa_sink_input_unlink(i);
466
467     pa_log_info("Freeing input %u \"%s\"", i->index, pa_strnull(pa_proplist_gets(i->proplist, PA_PROP_MEDIA_NAME)));
468
469     pa_assert(!i->thread_info.attached);
470
471     if (i->thread_info.render_memblockq)
472         pa_memblockq_free(i->thread_info.render_memblockq);
473
474     if (i->thread_info.resampler)
475         pa_resampler_free(i->thread_info.resampler);
476
477     if (i->proplist)
478         pa_proplist_free(i->proplist);
479
480     if (i->direct_outputs)
481         pa_idxset_free(i->direct_outputs, NULL, NULL);
482
483     if (i->thread_info.direct_outputs)
484         pa_hashmap_free(i->thread_info.direct_outputs, NULL, NULL);
485
486     pa_xfree(i->driver);
487     pa_xfree(i);
488 }
489
490 /* Called from main context */
491 void pa_sink_input_put(pa_sink_input *i) {
492     pa_sink_input_state_t state;
493     pa_sink_input_assert_ref(i);
494
495     pa_assert(i->state == PA_SINK_INPUT_INIT);
496
497     /* The following fields must be initialized properly */
498     pa_assert(i->pop);
499     pa_assert(i->process_rewind);
500     pa_assert(i->kill);
501
502     i->thread_info.soft_volume = i->soft_volume;
503     i->thread_info.muted = i->muted;
504
505     state = i->flags & PA_SINK_INPUT_START_CORKED ? PA_SINK_INPUT_CORKED : PA_SINK_INPUT_RUNNING;
506
507     update_n_corked(i, state);
508     i->state = state;
509
510     /* We might need to update the sink's volume if we are in flat volume mode. */
511     if (i->sink->flags & PA_SINK_FLAT_VOLUME) {
512         pa_cvolume new_volume;
513         pa_sink_update_flat_volume(i->sink, &new_volume);
514         pa_sink_set_volume(i->sink, &new_volume, FALSE, FALSE);
515     }
516
517     pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i->sink), PA_SINK_MESSAGE_ADD_INPUT, i, 0, NULL) == 0);
518
519     pa_subscription_post(i->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_NEW, i->index);
520     pa_hook_fire(&i->core->hooks[PA_CORE_HOOK_SINK_INPUT_PUT], i);
521
522     pa_sink_update_status(i->sink);
523 }
524
525 /* Called from main context */
526 void pa_sink_input_kill(pa_sink_input*i) {
527     pa_sink_input_assert_ref(i);
528     pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
529
530     i->kill(i);
531 }
532
533 /* Called from main context */
534 pa_usec_t pa_sink_input_get_latency(pa_sink_input *i, pa_usec_t *sink_latency) {
535     pa_usec_t r[2] = { 0, 0 };
536
537     pa_sink_input_assert_ref(i);
538     pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
539
540     pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_GET_LATENCY, r, 0, NULL) == 0);
541
542     if (i->get_latency)
543         r[0] += i->get_latency(i);
544
545     if (sink_latency)
546         *sink_latency = r[1];
547
548     return r[0];
549 }
550
551 /* Called from thread context */
552 int pa_sink_input_peek(pa_sink_input *i, size_t slength /* in sink frames */, pa_memchunk *chunk, pa_cvolume *volume) {
553     pa_bool_t do_volume_adj_here;
554     pa_bool_t volume_is_norm;
555     size_t block_size_max_sink, block_size_max_sink_input;
556     size_t ilength;
557
558     pa_sink_input_assert_ref(i);
559     pa_assert(PA_SINK_INPUT_IS_LINKED(i->thread_info.state));
560     pa_assert(pa_frame_aligned(slength, &i->sink->sample_spec));
561     pa_assert(chunk);
562     pa_assert(volume);
563
564 /*     pa_log_debug("peek"); */
565
566     if (!i->pop)
567         return -1;
568
569     pa_assert(i->thread_info.state == PA_SINK_INPUT_RUNNING ||
570               i->thread_info.state == PA_SINK_INPUT_CORKED ||
571               i->thread_info.state == PA_SINK_INPUT_DRAINED);
572
573     block_size_max_sink_input = i->thread_info.resampler ?
574         pa_resampler_max_block_size(i->thread_info.resampler) :
575         pa_frame_align(pa_mempool_block_size_max(i->core->mempool), &i->sample_spec);
576
577     block_size_max_sink = pa_frame_align(pa_mempool_block_size_max(i->core->mempool), &i->sink->sample_spec);
578
579     /* Default buffer size */
580     if (slength <= 0)
581         slength = pa_frame_align(CONVERT_BUFFER_LENGTH, &i->sink->sample_spec);
582
583     if (slength > block_size_max_sink)
584         slength = block_size_max_sink;
585
586     if (i->thread_info.resampler) {
587         ilength = pa_resampler_request(i->thread_info.resampler, slength);
588
589         if (ilength <= 0)
590             ilength = pa_frame_align(CONVERT_BUFFER_LENGTH, &i->sample_spec);
591     } else
592         ilength = slength;
593
594     if (ilength > block_size_max_sink_input)
595         ilength = block_size_max_sink_input;
596
597     /* If the channel maps of the sink and this stream differ, we need
598      * to adjust the volume *before* we resample. Otherwise we can do
599      * it after and leave it for the sink code */
600
601     do_volume_adj_here = !pa_channel_map_equal(&i->channel_map, &i->sink->channel_map);
602     volume_is_norm = pa_cvolume_is_norm(&i->thread_info.soft_volume) && !i->thread_info.muted;
603
604     while (!pa_memblockq_is_readable(i->thread_info.render_memblockq)) {
605         pa_memchunk tchunk;
606
607         /* There's nothing in our render queue. We need to fill it up
608          * with data from the implementor. */
609
610         if (i->thread_info.state == PA_SINK_INPUT_CORKED ||
611             i->pop(i, ilength, &tchunk) < 0) {
612
613             /* OK, we're corked or the implementor didn't give us any
614              * data, so let's just hand out silence */
615             pa_atomic_store(&i->thread_info.drained, 1);
616
617             pa_memblockq_seek(i->thread_info.render_memblockq, (int64_t) slength, PA_SEEK_RELATIVE);
618             i->thread_info.playing_for = 0;
619             if (i->thread_info.underrun_for != (uint64_t) -1)
620                 i->thread_info.underrun_for += ilength;
621             break;
622         }
623
624         pa_atomic_store(&i->thread_info.drained, 0);
625
626         pa_assert(tchunk.length > 0);
627         pa_assert(tchunk.memblock);
628
629         i->thread_info.underrun_for = 0;
630         i->thread_info.playing_for += tchunk.length;
631
632         while (tchunk.length > 0) {
633             pa_memchunk wchunk;
634
635             wchunk = tchunk;
636             pa_memblock_ref(wchunk.memblock);
637
638             if (wchunk.length > block_size_max_sink_input)
639                 wchunk.length = block_size_max_sink_input;
640
641             /* It might be necessary to adjust the volume here */
642             if (do_volume_adj_here && !volume_is_norm) {
643                 pa_memchunk_make_writable(&wchunk, 0);
644
645                 if (i->thread_info.muted)
646                     pa_silence_memchunk(&wchunk, &i->thread_info.sample_spec);
647                 else
648                     pa_volume_memchunk(&wchunk, &i->thread_info.sample_spec, &i->thread_info.soft_volume);
649             }
650
651             if (!i->thread_info.resampler)
652                 pa_memblockq_push_align(i->thread_info.render_memblockq, &wchunk);
653             else {
654                 pa_memchunk rchunk;
655                 pa_resampler_run(i->thread_info.resampler, &wchunk, &rchunk);
656
657 /*                 pa_log_debug("pushing %lu", (unsigned long) rchunk.length); */
658
659                 if (rchunk.memblock) {
660                     pa_memblockq_push_align(i->thread_info.render_memblockq, &rchunk);
661                     pa_memblock_unref(rchunk.memblock);
662                 }
663             }
664
665             pa_memblock_unref(wchunk.memblock);
666
667             tchunk.index += wchunk.length;
668             tchunk.length -= wchunk.length;
669         }
670
671         pa_memblock_unref(tchunk.memblock);
672     }
673
674     pa_assert_se(pa_memblockq_peek(i->thread_info.render_memblockq, chunk) >= 0);
675
676     pa_assert(chunk->length > 0);
677     pa_assert(chunk->memblock);
678
679 /*     pa_log_debug("peeking %lu", (unsigned long) chunk->length); */
680
681     if (chunk->length > block_size_max_sink)
682         chunk->length = block_size_max_sink;
683
684     /* Let's see if we had to apply the volume adjustment ourselves,
685      * or if this can be done by the sink for us */
686
687     if (do_volume_adj_here)
688         /* We had different channel maps, so we already did the adjustment */
689         pa_cvolume_reset(volume, i->sink->sample_spec.channels);
690     else if (i->thread_info.muted)
691         /* We've both the same channel map, so let's have the sink do the adjustment for us*/
692         pa_cvolume_mute(volume, i->sink->sample_spec.channels);
693     else
694         *volume = i->thread_info.soft_volume;
695
696     return 0;
697 }
698
699 /* Called from thread context */
700 void pa_sink_input_drop(pa_sink_input *i, size_t nbytes /* in sink sample spec */) {
701     pa_sink_input_assert_ref(i);
702
703     pa_assert(PA_SINK_INPUT_IS_LINKED(i->thread_info.state));
704     pa_assert(pa_frame_aligned(nbytes, &i->sink->sample_spec));
705     pa_assert(nbytes > 0);
706
707 /*     pa_log_debug("dropping %lu", (unsigned long) nbytes); */
708
709     pa_memblockq_drop(i->thread_info.render_memblockq, nbytes);
710 }
711
712 /* Called from thread context */
713 void pa_sink_input_process_rewind(pa_sink_input *i, size_t nbytes /* in sink sample spec */) {
714     size_t lbq;
715     pa_bool_t called = FALSE;
716     pa_sink_input_assert_ref(i);
717
718     pa_assert(PA_SINK_INPUT_IS_LINKED(i->thread_info.state));
719     pa_assert(pa_frame_aligned(nbytes, &i->sink->sample_spec));
720
721 /*     pa_log_debug("rewind(%lu, %lu)", (unsigned long) nbytes, (unsigned long) i->thread_info.rewrite_nbytes); */
722
723     lbq = pa_memblockq_get_length(i->thread_info.render_memblockq);
724
725     if (nbytes > 0 && !i->thread_info.dont_rewind_render) {
726         pa_log_debug("Have to rewind %lu bytes on render memblockq.", (unsigned long) nbytes);
727         pa_memblockq_rewind(i->thread_info.render_memblockq, nbytes);
728     }
729
730     if (i->thread_info.rewrite_nbytes == (size_t) -1) {
731
732         /* We were asked to drop all buffered data, and rerequest new
733          * data from implementor the next time push() is called */
734
735         pa_memblockq_flush_write(i->thread_info.render_memblockq);
736
737     } else if (i->thread_info.rewrite_nbytes > 0) {
738         size_t max_rewrite, amount;
739
740         /* Calculate how much make sense to rewrite at most */
741         max_rewrite = nbytes + lbq;
742
743         /* Transform into local domain */
744         if (i->thread_info.resampler)
745             max_rewrite = pa_resampler_request(i->thread_info.resampler, max_rewrite);
746
747         /* Calculate how much of the rewinded data should actually be rewritten */
748         amount = PA_MIN(i->thread_info.rewrite_nbytes, max_rewrite);
749
750         if (amount > 0) {
751             pa_log_debug("Have to rewind %lu bytes on implementor.", (unsigned long) amount);
752
753             /* Tell the implementor */
754             if (i->process_rewind)
755                 i->process_rewind(i, amount);
756             called = TRUE;
757
758             /* Convert back to to sink domain */
759             if (i->thread_info.resampler)
760                 amount = pa_resampler_result(i->thread_info.resampler, amount);
761
762             if (amount > 0)
763                 /* Ok, now update the write pointer */
764                 pa_memblockq_seek(i->thread_info.render_memblockq, - ((int64_t) amount), PA_SEEK_RELATIVE);
765
766             if (i->thread_info.rewrite_flush)
767                 pa_memblockq_silence(i->thread_info.render_memblockq);
768
769             /* And reset the resampler */
770             if (i->thread_info.resampler)
771                 pa_resampler_reset(i->thread_info.resampler);
772         }
773     }
774
775     if (!called)
776         if (i->process_rewind)
777             i->process_rewind(i, 0);
778
779     i->thread_info.rewrite_nbytes = 0;
780     i->thread_info.rewrite_flush = FALSE;
781     i->thread_info.dont_rewind_render = FALSE;
782 }
783
784 /* Called from thread context */
785 void pa_sink_input_update_max_rewind(pa_sink_input *i, size_t nbytes  /* in the sink's sample spec */) {
786     pa_sink_input_assert_ref(i);
787     pa_assert(PA_SINK_INPUT_IS_LINKED(i->thread_info.state));
788     pa_assert(pa_frame_aligned(nbytes, &i->sink->sample_spec));
789
790     pa_memblockq_set_maxrewind(i->thread_info.render_memblockq, nbytes);
791
792     if (i->update_max_rewind)
793         i->update_max_rewind(i, i->thread_info.resampler ? pa_resampler_request(i->thread_info.resampler, nbytes) : nbytes);
794 }
795
796 /* Called from thread context */
797 void pa_sink_input_update_max_request(pa_sink_input *i, size_t nbytes  /* in the sink's sample spec */) {
798     pa_sink_input_assert_ref(i);
799     pa_assert(PA_SINK_INPUT_IS_LINKED(i->thread_info.state));
800     pa_assert(pa_frame_aligned(nbytes, &i->sink->sample_spec));
801
802     if (i->update_max_request)
803         i->update_max_request(i, i->thread_info.resampler ? pa_resampler_request(i->thread_info.resampler, nbytes) : nbytes);
804 }
805
806 /* Called from thread context */
807 static pa_usec_t fixup_latency(pa_sink *s, pa_usec_t usec) {
808     pa_sink_assert_ref(s);
809
810     if (usec == (pa_usec_t) -1)
811         return usec;
812
813     if (s->thread_info.max_latency > 0 && usec > s->thread_info.max_latency)
814         usec = s->thread_info.max_latency;
815
816     if (s->thread_info.min_latency > 0 && usec < s->thread_info.min_latency)
817         usec = s->thread_info.min_latency;
818
819     return usec;
820 }
821
822 /* Called from thread context */
823 pa_usec_t pa_sink_input_set_requested_latency_within_thread(pa_sink_input *i, pa_usec_t usec) {
824     pa_sink_input_assert_ref(i);
825
826     usec = fixup_latency(i->sink, usec);
827     i->thread_info.requested_sink_latency = usec;
828     pa_sink_invalidate_requested_latency(i->sink);
829
830     return usec;
831 }
832
833 /* Called from main context */
834 pa_usec_t pa_sink_input_set_requested_latency(pa_sink_input *i, pa_usec_t usec) {
835     pa_sink_input_assert_ref(i);
836
837     if (PA_SINK_INPUT_IS_LINKED(i->state))
838         pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_SET_REQUESTED_LATENCY, &usec, 0, NULL) == 0);
839     else
840         /* If this sink input is not realized yet, we have to touch
841          * the thread info data directly */
842
843         i->thread_info.requested_sink_latency = usec;
844
845     return usec;
846 }
847
848 /* Called from main context */
849 pa_usec_t pa_sink_input_get_requested_latency(pa_sink_input *i) {
850     pa_usec_t usec = 0;
851
852     pa_sink_input_assert_ref(i);
853
854     if (PA_SINK_INPUT_IS_LINKED(i->state))
855         pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_GET_REQUESTED_LATENCY, &usec, 0, NULL) == 0);
856     else
857         /* If this sink input is not realized yet, we have to touch
858          * the thread info data directly */
859         usec = i->thread_info.requested_sink_latency;
860
861     return usec;
862 }
863
864 /* Called from main context */
865 void pa_sink_input_set_volume(pa_sink_input *i, const pa_cvolume *volume, pa_bool_t save) {
866     pa_sink_input_assert_ref(i);
867     pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
868     pa_assert(volume);
869     pa_assert(pa_cvolume_valid(volume));
870     pa_assert(pa_cvolume_compatible(volume, &i->sample_spec));
871
872     if (pa_cvolume_equal(volume, &i->virtual_volume))
873         return;
874
875     i->virtual_volume = *volume;
876     i->save_volume = save;
877
878     if (i->sink->flags & PA_SINK_FLAT_VOLUME) {
879         pa_cvolume new_volume;
880
881         /* We are in flat volume mode, so let's update all sink input
882          * volumes and update the flat volume of the sink */
883
884         pa_sink_update_flat_volume(i->sink, &new_volume);
885         pa_sink_set_volume(i->sink, &new_volume, FALSE, TRUE);
886
887     } else {
888
889         /* OK, we are in normal volume mode. The volume only affects
890          * ourselves */
891
892         i->soft_volume = *volume;
893
894         /* Hooks have the ability to play games with i->soft_volume */
895         pa_hook_fire(&i->core->hooks[PA_CORE_HOOK_SINK_INPUT_SET_VOLUME], i);
896
897         pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_SET_SOFT_VOLUME, NULL, 0, NULL) == 0);
898     }
899
900     /* The virtual volume changed, let's tell people so */
901     pa_subscription_post(i->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
902 }
903
904 /* Called from main context */
905 const pa_cvolume *pa_sink_input_get_volume(pa_sink_input *i) {
906     pa_sink_input_assert_ref(i);
907     pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
908
909     return &i->virtual_volume;
910 }
911
912 /* Called from main context */
913 void pa_sink_input_set_mute(pa_sink_input *i, pa_bool_t mute, pa_bool_t save) {
914     pa_assert(i);
915     pa_sink_input_assert_ref(i);
916     pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
917
918     if (!i->muted == !mute)
919         return;
920
921     i->muted = mute;
922     i->save_muted = save;
923
924     pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_SET_SOFT_MUTE, NULL, 0, NULL) == 0);
925     pa_subscription_post(i->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
926 }
927
928 /* Called from main context */
929 pa_bool_t pa_sink_input_get_mute(pa_sink_input *i) {
930     pa_sink_input_assert_ref(i);
931     pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
932
933     return i->muted;
934 }
935
936 /* Called from main thread */
937 pa_bool_t pa_sink_input_update_proplist(pa_sink_input *i, pa_update_mode_t mode, pa_proplist *p) {
938
939   pa_sink_input_assert_ref(i);
940
941   pa_proplist_update(i->proplist, mode, p);
942
943   if (PA_SINK_IS_LINKED(i->state)) {
944       pa_hook_fire(&i->core->hooks[PA_CORE_HOOK_SINK_INPUT_PROPLIST_CHANGED], i);
945       pa_subscription_post(i->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
946   }
947
948   return TRUE;
949 }
950
951 /* Called from main context */
952 void pa_sink_input_cork(pa_sink_input *i, pa_bool_t b) {
953     pa_sink_input_assert_ref(i);
954     pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
955
956     sink_input_set_state(i, b ? PA_SINK_INPUT_CORKED : PA_SINK_INPUT_RUNNING);
957 }
958
959 /* Called from main context */
960 int pa_sink_input_set_rate(pa_sink_input *i, uint32_t rate) {
961     pa_sink_input_assert_ref(i);
962     pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
963     pa_return_val_if_fail(i->thread_info.resampler, -1);
964
965     if (i->sample_spec.rate == rate)
966         return 0;
967
968     i->sample_spec.rate = rate;
969
970     pa_asyncmsgq_post(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_SET_RATE, PA_UINT_TO_PTR(rate), 0, NULL, NULL);
971
972     pa_subscription_post(i->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
973     return 0;
974 }
975
976 /* Called from main context */
977 void pa_sink_input_set_name(pa_sink_input *i, const char *name) {
978     const char *old;
979     pa_sink_input_assert_ref(i);
980
981     if (!name && !pa_proplist_contains(i->proplist, PA_PROP_MEDIA_NAME))
982         return;
983
984     old = pa_proplist_gets(i->proplist, PA_PROP_MEDIA_NAME);
985
986     if (old && name && !strcmp(old, name))
987         return;
988
989     if (name)
990         pa_proplist_sets(i->proplist, PA_PROP_MEDIA_NAME, name);
991     else
992         pa_proplist_unset(i->proplist, PA_PROP_MEDIA_NAME);
993
994     if (PA_SINK_INPUT_IS_LINKED(i->state)) {
995         pa_hook_fire(&i->core->hooks[PA_CORE_HOOK_SINK_INPUT_PROPLIST_CHANGED], i);
996         pa_subscription_post(i->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
997     }
998 }
999
1000 /* Called from main context */
1001 pa_resample_method_t pa_sink_input_get_resample_method(pa_sink_input *i) {
1002     pa_sink_input_assert_ref(i);
1003
1004     return i->actual_resample_method;
1005 }
1006
1007 /* Called from main context */
1008 pa_bool_t pa_sink_input_may_move(pa_sink_input *i) {
1009     pa_sink_input_assert_ref(i);
1010     pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
1011
1012     if (i->flags & PA_SINK_INPUT_DONT_MOVE)
1013         return FALSE;
1014
1015     if (i->sync_next || i->sync_prev) {
1016         pa_log_warn("Moving synchronised streams not supported.");
1017         return FALSE;
1018     }
1019
1020     return TRUE;
1021 }
1022
1023 /* Called from main context */
1024 pa_bool_t pa_sink_input_may_move_to(pa_sink_input *i, pa_sink *dest) {
1025     pa_sink_input_assert_ref(i);
1026     pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
1027     pa_sink_assert_ref(dest);
1028
1029     if (dest == i->sink)
1030         return TRUE;
1031
1032     if (!pa_sink_input_may_move(i))
1033         return FALSE;
1034
1035     if (pa_idxset_size(dest->inputs) >= PA_MAX_INPUTS_PER_SINK) {
1036         pa_log_warn("Failed to move sink input: too many inputs per sink.");
1037         return FALSE;
1038     }
1039
1040     if (i->may_move_to)
1041         if (!i->may_move_to(i, dest))
1042             return FALSE;
1043
1044     return TRUE;
1045 }
1046
1047 /* Called from main context */
1048 int pa_sink_input_start_move(pa_sink_input *i) {
1049     pa_source_output *o, *p = NULL;
1050     pa_sink *origin;
1051
1052     pa_sink_input_assert_ref(i);
1053     pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
1054     pa_assert(i->sink);
1055
1056     if (!pa_sink_input_may_move(i))
1057         return -1;
1058
1059     if (pa_hook_fire(&i->core->hooks[PA_CORE_HOOK_SINK_INPUT_MOVE_START], i) < 0)
1060         return -1;
1061
1062     origin = i->sink;
1063
1064     /* Kill directly connected outputs */
1065     while ((o = pa_idxset_first(i->direct_outputs, NULL))) {
1066         pa_assert(o != p);
1067         pa_source_output_kill(o);
1068         p = o;
1069     }
1070     pa_assert(pa_idxset_isempty(i->direct_outputs));
1071
1072     pa_idxset_remove_by_data(i->sink->inputs, i, NULL);
1073
1074     if (pa_sink_input_get_state(i) == PA_SINK_INPUT_CORKED)
1075         pa_assert_se(i->sink->n_corked-- >= 1);
1076
1077     /* We might need to update the sink's volume if we are in flat volume mode. */
1078     if (i->sink->flags & PA_SINK_FLAT_VOLUME) {
1079         pa_cvolume new_volume;
1080         pa_sink_update_flat_volume(i->sink, &new_volume);
1081         pa_sink_set_volume(i->sink, &new_volume, FALSE, FALSE);
1082     }
1083
1084     pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i->sink), PA_SINK_MESSAGE_START_MOVE, i, 0, NULL) == 0);
1085
1086     pa_sink_update_status(i->sink);
1087     i->sink = NULL;
1088
1089     return 0;
1090 }
1091
1092 /* Called from main context */
1093 int pa_sink_input_finish_move(pa_sink_input *i, pa_sink *dest, pa_bool_t save) {
1094     pa_resampler *new_resampler;
1095
1096     pa_sink_input_assert_ref(i);
1097     pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
1098     pa_assert(!i->sink);
1099     pa_sink_assert_ref(dest);
1100
1101     if (!pa_sink_input_may_move_to(i, dest))
1102         return -1;
1103
1104     i->sink = dest;
1105     i->save_sink = save;
1106     pa_idxset_put(dest->inputs, i, NULL);
1107
1108     if (pa_sink_input_get_state(i) == PA_SINK_INPUT_CORKED)
1109         i->sink->n_corked++;
1110
1111     if (i->thread_info.resampler &&
1112         pa_sample_spec_equal(pa_resampler_output_sample_spec(i->thread_info.resampler), &dest->sample_spec) &&
1113         pa_channel_map_equal(pa_resampler_output_channel_map(i->thread_info.resampler), &dest->channel_map))
1114
1115         /* Try to reuse the old resampler if possible */
1116         new_resampler = i->thread_info.resampler;
1117
1118     else if ((i->flags & PA_SINK_INPUT_VARIABLE_RATE) ||
1119              !pa_sample_spec_equal(&i->sample_spec, &dest->sample_spec) ||
1120              !pa_channel_map_equal(&i->channel_map, &dest->channel_map)) {
1121
1122         /* Okey, we need a new resampler for the new sink */
1123
1124         if (!(new_resampler = pa_resampler_new(
1125                       i->core->mempool,
1126                       &i->sample_spec, &i->channel_map,
1127                       &dest->sample_spec, &dest->channel_map,
1128                       i->requested_resample_method,
1129                       ((i->flags & PA_SINK_INPUT_VARIABLE_RATE) ? PA_RESAMPLER_VARIABLE_RATE : 0) |
1130                       ((i->flags & PA_SINK_INPUT_NO_REMAP) ? PA_RESAMPLER_NO_REMAP : 0) |
1131                       (i->core->disable_remixing || (i->flags & PA_SINK_INPUT_NO_REMIX) ? PA_RESAMPLER_NO_REMIX : 0)))) {
1132             pa_log_warn("Unsupported resampling operation.");
1133             return -1;
1134         }
1135     } else
1136         new_resampler = NULL;
1137
1138     /* Replace resampler and render queue */
1139     if (new_resampler != i->thread_info.resampler) {
1140
1141         if (i->thread_info.resampler)
1142             pa_resampler_free(i->thread_info.resampler);
1143         i->thread_info.resampler = new_resampler;
1144
1145         pa_memblockq_free(i->thread_info.render_memblockq);
1146
1147         i->thread_info.render_memblockq = pa_memblockq_new(
1148                 0,
1149                 MEMBLOCKQ_MAXLENGTH,
1150                 0,
1151                 pa_frame_size(&i->sink->sample_spec),
1152                 0,
1153                 1,
1154                 0,
1155                 &i->sink->silence);
1156     }
1157
1158     pa_sink_update_status(dest);
1159
1160     /* We might need to update the sink's volume if we are in flat volume mode. */
1161     if (i->sink->flags & PA_SINK_FLAT_VOLUME) {
1162         pa_cvolume new_volume;
1163         pa_sink_update_flat_volume(i->sink, &new_volume);
1164         pa_sink_set_volume(i->sink, &new_volume, FALSE, FALSE);
1165     }
1166
1167     pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i->sink), PA_SINK_MESSAGE_FINISH_MOVE, i, 0, NULL) == 0);
1168
1169     pa_log_debug("Successfully moved sink input %i to %s.", i->index, dest->name);
1170
1171     /* Notify everyone */
1172     if (i->moved)
1173         i->moved(i);
1174
1175     pa_hook_fire(&i->core->hooks[PA_CORE_HOOK_SINK_INPUT_MOVE_FINISH], i);
1176     pa_subscription_post(i->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
1177
1178     return 0;
1179 }
1180
1181 /* Called from main context */
1182 int pa_sink_input_move_to(pa_sink_input *i, pa_sink *dest, pa_bool_t save) {
1183     pa_sink_input_assert_ref(i);
1184     pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
1185     pa_assert(i->sink);
1186     pa_sink_assert_ref(dest);
1187
1188     if (dest == i->sink)
1189         return 0;
1190
1191     if (!pa_sink_input_may_move_to(i, dest))
1192         return -1;
1193
1194     if (pa_sink_input_start_move(i) < 0)
1195         return -1;
1196
1197     if (pa_sink_input_finish_move(i, dest, save) < 0)
1198         return -1;
1199
1200     return 0;
1201 }
1202
1203 /* Called from IO thread context */
1204 void pa_sink_input_set_state_within_thread(pa_sink_input *i, pa_sink_input_state_t state) {
1205     pa_bool_t corking, uncorking;
1206     pa_sink_input_assert_ref(i);
1207
1208     if (state == i->thread_info.state)
1209         return;
1210
1211     if ((state == PA_SINK_INPUT_DRAINED || state == PA_SINK_INPUT_RUNNING) &&
1212         !(i->thread_info.state == PA_SINK_INPUT_DRAINED || i->thread_info.state != PA_SINK_INPUT_RUNNING))
1213         pa_atomic_store(&i->thread_info.drained, 1);
1214
1215     corking = state == PA_SINK_INPUT_CORKED && i->thread_info.state == PA_SINK_INPUT_RUNNING;
1216     uncorking = i->thread_info.state == PA_SINK_INPUT_CORKED && state == PA_SINK_INPUT_RUNNING;
1217
1218     if (i->state_change)
1219         i->state_change(i, state);
1220
1221     i->thread_info.state = state;
1222
1223     if (corking) {
1224
1225         pa_log_debug("Requesting rewind due to corking");
1226
1227         /* This will tell the implementing sink input driver to rewind
1228          * so that the unplayed already mixed data is not lost */
1229         pa_sink_input_request_rewind(i, 0, TRUE, TRUE, FALSE);
1230
1231     } else if (uncorking) {
1232
1233         i->thread_info.underrun_for = (uint64_t) -1;
1234         i->thread_info.playing_for = 0;
1235
1236         pa_log_debug("Requesting rewind due to uncorking");
1237
1238         /* OK, we're being uncorked. Make sure we're not rewound when
1239          * the hw buffer is remixed and request a remix. */
1240         pa_sink_input_request_rewind(i, 0, FALSE, TRUE, TRUE);
1241     }
1242 }
1243
1244 /* Called from thread context, except when it is not. */
1245 int pa_sink_input_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offset, pa_memchunk *chunk) {
1246     pa_sink_input *i = PA_SINK_INPUT(o);
1247     pa_sink_input_assert_ref(i);
1248
1249     switch (code) {
1250
1251         case PA_SINK_INPUT_MESSAGE_SET_SOFT_VOLUME:
1252             if (!pa_cvolume_equal(&i->thread_info.soft_volume, &i->soft_volume)) {
1253                 i->thread_info.soft_volume = i->soft_volume;
1254                 pa_sink_input_request_rewind(i, 0, TRUE, FALSE, FALSE);
1255             }
1256             return 0;
1257
1258         case PA_SINK_INPUT_MESSAGE_SET_SOFT_MUTE:
1259             if (i->thread_info.muted != i->muted) {
1260                 i->thread_info.muted = i->muted;
1261                 pa_sink_input_request_rewind(i, 0, TRUE, FALSE, FALSE);
1262             }
1263             return 0;
1264
1265         case PA_SINK_INPUT_MESSAGE_GET_LATENCY: {
1266             pa_usec_t *r = userdata;
1267             pa_usec_t sink_usec = 0;
1268
1269             r[0] += pa_bytes_to_usec(pa_memblockq_get_length(i->thread_info.render_memblockq), &i->sink->sample_spec);
1270
1271             if (i->sink->parent.process_msg(PA_MSGOBJECT(i->sink), PA_SINK_MESSAGE_GET_LATENCY, &sink_usec, 0, NULL) >= 0)
1272                 r[1] += sink_usec;
1273
1274             return 0;
1275         }
1276
1277         case PA_SINK_INPUT_MESSAGE_SET_RATE:
1278
1279             i->thread_info.sample_spec.rate = PA_PTR_TO_UINT(userdata);
1280             pa_resampler_set_input_rate(i->thread_info.resampler, PA_PTR_TO_UINT(userdata));
1281
1282             return 0;
1283
1284         case PA_SINK_INPUT_MESSAGE_SET_STATE: {
1285             pa_sink_input *ssync;
1286
1287             pa_sink_input_set_state_within_thread(i, PA_PTR_TO_UINT(userdata));
1288
1289             for (ssync = i->thread_info.sync_prev; ssync; ssync = ssync->thread_info.sync_prev)
1290                 pa_sink_input_set_state_within_thread(ssync, PA_PTR_TO_UINT(userdata));
1291
1292             for (ssync = i->thread_info.sync_next; ssync; ssync = ssync->thread_info.sync_next)
1293                 pa_sink_input_set_state_within_thread(ssync, PA_PTR_TO_UINT(userdata));
1294
1295             return 0;
1296         }
1297
1298         case PA_SINK_INPUT_MESSAGE_SET_REQUESTED_LATENCY: {
1299             pa_usec_t *usec = userdata;
1300
1301             *usec = pa_sink_input_set_requested_latency_within_thread(i, *usec);
1302             return 0;
1303         }
1304
1305         case PA_SINK_INPUT_MESSAGE_GET_REQUESTED_LATENCY: {
1306             pa_usec_t *r = userdata;
1307
1308             *r = i->thread_info.requested_sink_latency;
1309             return 0;
1310         }
1311     }
1312
1313     return -1;
1314 }
1315
1316 /* Called from main thread */
1317 pa_sink_input_state_t pa_sink_input_get_state(pa_sink_input *i) {
1318     pa_sink_input_assert_ref(i);
1319
1320     if (i->state == PA_SINK_INPUT_RUNNING || i->state == PA_SINK_INPUT_DRAINED)
1321         return pa_atomic_load(&i->thread_info.drained) ? PA_SINK_INPUT_DRAINED : PA_SINK_INPUT_RUNNING;
1322
1323     return i->state;
1324 }
1325
1326 /* Called from IO context */
1327 pa_bool_t pa_sink_input_safe_to_remove(pa_sink_input *i) {
1328     pa_sink_input_assert_ref(i);
1329
1330     if (PA_SINK_INPUT_IS_LINKED(i->thread_info.state))
1331         return pa_memblockq_is_empty(i->thread_info.render_memblockq);
1332
1333     return TRUE;
1334 }
1335
1336 /* Called from IO context */
1337 void pa_sink_input_request_rewind(pa_sink_input *i, size_t nbytes  /* in our sample spec */, pa_bool_t rewrite, pa_bool_t flush, pa_bool_t dont_rewind_render) {
1338     size_t lbq;
1339
1340     /* If 'rewrite' is TRUE the sink is rewound as far as requested
1341      * and possible and the exact value of this is passed back the
1342      * implementor via process_rewind(). If 'flush' is also TRUE all
1343      * already rendered data is also dropped.
1344      *
1345      * If 'rewrite' is FALSE the sink is rewound as far as requested
1346      * and possible and the already rendered data is dropped so that
1347      * in the next iteration we read new data from the
1348      * implementor. This implies 'flush' is TRUE.  If
1349      * dont_rewind_render is TRUE then the render memblockq is not
1350      * rewound. */
1351
1352     pa_sink_input_assert_ref(i);
1353
1354     nbytes = PA_MAX(i->thread_info.rewrite_nbytes, nbytes);
1355
1356 /*     pa_log_debug("request rewrite %lu", (unsigned long) nbytes); */
1357
1358     /* We don't take rewind requests while we are corked */
1359     if (i->thread_info.state == PA_SINK_INPUT_CORKED)
1360         return;
1361
1362     pa_assert(rewrite || flush);
1363     pa_assert(!dont_rewind_render || !rewrite);
1364
1365     /* Calculate how much we can rewind locally without having to
1366      * touch the sink */
1367     if (rewrite)
1368         lbq = pa_memblockq_get_length(i->thread_info.render_memblockq);
1369     else
1370         lbq = 0;
1371
1372     /* Check if rewinding for the maximum is requested, and if so, fix up */
1373     if (nbytes <= 0) {
1374
1375         /* Calculate maximum number of bytes that could be rewound in theory */
1376         nbytes = i->sink->thread_info.max_rewind + lbq;
1377
1378         /* Transform from sink domain */
1379         if (i->thread_info.resampler)
1380             nbytes = pa_resampler_request(i->thread_info.resampler, nbytes);
1381     }
1382
1383     if (i->thread_info.rewrite_nbytes != (size_t) -1) {
1384         if (rewrite) {
1385             /* Make sure to not overwrite over underruns */
1386             if (nbytes > i->thread_info.playing_for)
1387                 nbytes = (size_t) i->thread_info.playing_for;
1388
1389             i->thread_info.rewrite_nbytes = nbytes;
1390         } else
1391             i->thread_info.rewrite_nbytes = (size_t) -1;
1392     }
1393
1394     i->thread_info.rewrite_flush =
1395         i->thread_info.rewrite_flush ||
1396         (flush && i->thread_info.rewrite_nbytes != 0);
1397
1398     i->thread_info.dont_rewind_render =
1399         i->thread_info.dont_rewind_render ||
1400         dont_rewind_render;
1401
1402     if (nbytes != (size_t) -1) {
1403
1404         /* Transform to sink domain */
1405         if (i->thread_info.resampler)
1406             nbytes = pa_resampler_result(i->thread_info.resampler, nbytes);
1407
1408         if (nbytes > lbq)
1409             pa_sink_request_rewind(i->sink, nbytes - lbq);
1410         else
1411             /* This call will make sure process_rewind() is called later */
1412             pa_sink_request_rewind(i->sink, 0);
1413     }
1414 }
1415
1416 /* Called from main context */
1417 pa_memchunk* pa_sink_input_get_silence(pa_sink_input *i, pa_memchunk *ret) {
1418     pa_sink_input_assert_ref(i);
1419     pa_assert(ret);
1420
1421     pa_silence_memchunk_get(
1422                 &i->core->silence_cache,
1423                 i->core->mempool,
1424                 ret,
1425                 &i->sample_spec,
1426                 i->thread_info.resampler ? pa_resampler_max_block_size(i->thread_info.resampler) : 0);
1427
1428     return ret;
1429 }