1 /*****************************************************************************
2 * pulse.c : Pulseaudio output plugin for vlc
3 *****************************************************************************
4 * Copyright (C) 2008 VLC authors and VideoLAN
5 * Copyright (C) 2009-2011 RĂ©mi Denis-Courmont
7 * Authors: Martin Hamrle <hamrle @ post . cz>
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU Lesser General Public License as published by
11 * the Free Software Foundation; either version 2.1 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public License
20 * along with this program; if not, write to the Free Software Foundation,
21 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
29 #include <vlc_common.h>
30 #include <vlc_plugin.h>
34 #include <pulse/pulseaudio.h>
36 #if !PA_CHECK_VERSION(0,9,22)
37 # include <vlc_xlib.h>
40 static int Open ( vlc_object_t * );
41 static void Close ( vlc_object_t * );
44 set_shortname( "PulseAudio" )
45 set_description( N_("Pulseaudio audio output") )
46 set_capability( "audio output", 160 )
47 set_category( CAT_AUDIO )
48 set_subcategory( SUBCAT_AUDIO_AOUT )
49 add_shortcut( "pulseaudio", "pa" )
50 set_callbacks( Open, Close )
54 * Be careful what you do when the PulseAudio mainloop is held, which is to say
55 * within PulseAudio callbacks, or after pa_threaded_mainloop_lock().
56 * In particular, a VLC variable callback cannot be triggered nor deleted with
57 * the PulseAudio mainloop lock held, if the callback acquires the lock. */
61 pa_stream *stream; /**< PulseAudio playback stream object */
62 pa_context *context; /**< PulseAudio connection context */
63 pa_threaded_mainloop *mainloop; /**< PulseAudio thread */
64 pa_time_event *trigger; /**< Deferred stream trigger */
65 pa_volume_t base_volume; /**< 0dB reference volume */
66 pa_cvolume cvolume; /**< actual sink input volume */
67 mtime_t first_pts; /**< Play time of buffer start */
68 mtime_t paused; /**< Time when (last) paused */
71 static void sink_list_cb(pa_context *, const pa_sink_info *, int, void *);
72 static void sink_input_info_cb(pa_context *, const pa_sink_input_info *,
76 static void context_cb(pa_context *ctx, pa_subscription_event_type_t type,
77 uint32_t idx, void *userdata)
79 audio_output_t *aout = userdata;
80 aout_sys_t *sys = aout->sys;
83 switch (type & PA_SUBSCRIPTION_EVENT_FACILITY_MASK)
85 case PA_SUBSCRIPTION_EVENT_SINK:
86 switch (type & PA_SUBSCRIPTION_EVENT_TYPE_MASK)
88 case PA_SUBSCRIPTION_EVENT_NEW:
89 case PA_SUBSCRIPTION_EVENT_CHANGE:
90 op = pa_context_get_sink_info_by_index(ctx, idx, sink_list_cb, aout);
91 if (likely(op != NULL))
92 pa_operation_unref(op);
95 case PA_SUBSCRIPTION_EVENT_REMOVE:
96 var_Change(aout, "audio-device", VLC_VAR_DELCHOICE,
97 &(vlc_value_t){ .i_int = idx }, NULL);
102 case PA_SUBSCRIPTION_EVENT_SINK_INPUT:
103 if (sys->stream == NULL || idx != pa_stream_get_index(sys->stream))
104 break; /* only interested in our sink input */
106 /* Gee... PA will not provide the infos directly in the event. */
107 switch (type & PA_SUBSCRIPTION_EVENT_TYPE_MASK)
109 case PA_SUBSCRIPTION_EVENT_REMOVE:
110 msg_Err(aout, "sink input killed!");
114 op = pa_context_get_sink_input_info(ctx, idx, sink_input_info_cb,
116 if (likely(op != NULL))
117 pa_operation_unref(op);
122 default: /* unsubscribed facility?! */
129 static void sink_list_cb(pa_context *c, const pa_sink_info *i, int eol,
132 audio_output_t *aout = userdata;
133 aout_sys_t *sys = aout->sys;
134 vlc_value_t val, text;
140 msg_Dbg(aout, "listing sink %s (%"PRIu32"): %s", i->name, i->index,
142 val.i_int = i->index;
143 text.psz_string = (char *)i->description;
144 /* FIXME: There is no way to replace a choice explicitly. */
145 var_Change(aout, "audio-device", VLC_VAR_DELCHOICE, &val, NULL);
146 var_Change(aout, "audio-device", VLC_VAR_ADDCHOICE, &val, &text);
147 /* FIXME: var_Change() can change the variable value if we remove the
148 * current value from the choice list, or if we add a choice while there
149 * was none. So force the correct value back. */
150 if (sys->stream != NULL)
152 val.i_int = pa_stream_get_device_index(sys->stream);
153 var_Change(aout, "audio-device", VLC_VAR_SETVALUE, &val, NULL);
157 static void sink_info_cb(pa_context *c, const pa_sink_info *i, int eol,
160 audio_output_t *aout = userdata;
161 aout_sys_t *sys = aout->sys;
167 /* PulseAudio flat volume NORM / 100% / 0dB corresponds to no software
168 * amplification and maximum hardware amplification.
169 * VLC maps DEFAULT / 100% to no gain at all (software/hardware).
170 * Thus we need to use the sink base_volume as a multiplier,
171 * if and only if flat volume is active for our current sink. */
172 if (i->flags & PA_SINK_FLAT_VOLUME)
173 sys->base_volume = i->base_volume;
175 sys->base_volume = PA_VOLUME_NORM;
176 msg_Dbg(aout, "base volume: %"PRIu32, sys->base_volume);
180 /*** Latency management and lip synchronization ***/
181 static void stream_start_now(pa_stream *s, audio_output_t *aout)
183 aout_sys_t *sys = aout->sys;
186 assert (sys->trigger == NULL);
188 op = pa_stream_cork(s, 0, NULL, NULL);
190 pa_operation_unref(op);
191 op = pa_stream_trigger(s, NULL, NULL);
192 if (likely(op != NULL))
193 pa_operation_unref(op);
196 static void stream_stop(pa_stream *s, audio_output_t *aout)
198 aout_sys_t *sys = aout->sys;
201 if (sys->trigger != NULL) {
202 vlc_pa_rttime_free(sys->mainloop, sys->trigger);
206 op = pa_stream_cork(s, 1, NULL, NULL);
208 pa_operation_unref(op);
211 static void stream_trigger_cb(pa_mainloop_api *api, pa_time_event *e,
212 const struct timeval *tv, void *userdata)
214 audio_output_t *aout = userdata;
215 aout_sys_t *sys = aout->sys;
217 assert (sys->trigger == e);
219 msg_Dbg(aout, "starting deferred");
220 vlc_pa_rttime_free(sys->mainloop, sys->trigger);
222 stream_start_now(sys->stream, aout);
223 (void) api; (void) e; (void) tv;
227 * Starts or resumes the playback stream.
228 * Tries start playing back audio samples at the most accurate time
229 * in order to minimize desync and resampling during early playback.
230 * @note PulseAudio lock required.
232 static void stream_start(pa_stream *s, audio_output_t *aout)
234 aout_sys_t *sys = aout->sys;
237 assert (sys->first_pts != VLC_TS_INVALID);
239 if (sys->trigger != NULL) {
240 vlc_pa_rttime_free(sys->mainloop, sys->trigger);
244 delta = vlc_pa_get_latency(aout, sys->context, s);
245 if (unlikely(delta == VLC_TS_INVALID)) {
246 msg_Dbg(aout, "cannot synchronize start");
247 delta = 0; /* screwed */
250 delta = (sys->first_pts - mdate()) - delta;
252 msg_Dbg(aout, "deferring start (%"PRId64" us)", delta);
253 delta += pa_rtclock_now();
254 sys->trigger = pa_context_rttime_new(sys->context, delta,
255 stream_trigger_cb, aout);
257 msg_Warn(aout, "starting late (%"PRId64" us)", delta);
258 stream_start_now(s, aout);
262 static void stream_latency_cb(pa_stream *s, void *userdata)
264 audio_output_t *aout = userdata;
265 aout_sys_t *sys = aout->sys;
267 if (sys->paused != VLC_TS_INVALID)
268 return; /* nothing to do while paused */
269 if (sys->first_pts == VLC_TS_INVALID)
270 return; /* nothing to do if buffers are (still) empty */
271 if (pa_stream_is_corked(s) > 0)
272 stream_start(s, aout);
276 /*** Stream helpers ***/
277 static void stream_state_cb(pa_stream *s, void *userdata)
279 pa_threaded_mainloop *mainloop = userdata;
281 switch (pa_stream_get_state(s)) {
282 case PA_STREAM_READY:
283 case PA_STREAM_FAILED:
284 case PA_STREAM_TERMINATED:
285 pa_threaded_mainloop_signal(mainloop, 0);
291 static void stream_buffer_attr_cb(pa_stream *s, void *userdata)
293 audio_output_t *aout = userdata;
294 const pa_buffer_attr *pba = pa_stream_get_buffer_attr(s);
296 msg_Dbg(aout, "changed buffer metrics: maxlength=%u, tlength=%u, "
297 "prebuf=%u, minreq=%u",
298 pba->maxlength, pba->tlength, pba->prebuf, pba->minreq);
301 static void stream_event_cb(pa_stream *s, const char *name, pa_proplist *pl,
304 audio_output_t *aout = userdata;
306 if (!strcmp(name, PA_STREAM_EVENT_REQUEST_CORK))
307 aout_PolicyReport(aout, true);
309 if (!strcmp(name, PA_STREAM_EVENT_REQUEST_UNCORK))
310 aout_PolicyReport(aout, false);
312 #if PA_CHECK_VERSION(1,0,0)
313 /* FIXME: expose aout_Restart() directly */
314 if (!strcmp(name, PA_STREAM_EVENT_FORMAT_LOST)) {
315 msg_Dbg (aout, "format lost");
316 aout_RestartRequest (aout, AOUT_RESTART_OUTPUT);
319 msg_Warn (aout, "unhandled stream event \"%s\"", name);
324 static void stream_moved_cb(pa_stream *s, void *userdata)
326 audio_output_t *aout = userdata;
327 aout_sys_t *sys = aout->sys;
329 uint32_t idx = pa_stream_get_device_index(s);
331 msg_Dbg(aout, "connected to sink %"PRIu32": %s", idx,
332 pa_stream_get_device_name(s));
333 op = pa_context_get_sink_info_by_index(sys->context, idx,
335 if (likely(op != NULL))
336 pa_operation_unref(op);
338 /* Update the variable if someone else moved our stream */
339 var_Change(aout, "audio-device", VLC_VAR_SETVALUE,
340 &(vlc_value_t){ .i_int = idx }, NULL);
342 /* Sink unknown as yet, create stub choice for it */
343 if (var_GetInteger(aout, "audio-device") != idx)
345 var_Change(aout, "audio-device", VLC_VAR_ADDCHOICE,
346 &(vlc_value_t){ .i_int = idx },
347 &(vlc_value_t){ .psz_string = (char *)"?" });
348 var_Change(aout, "audio-device", VLC_VAR_SETVALUE,
349 &(vlc_value_t){ .i_int = idx }, NULL);
353 static void stream_overflow_cb(pa_stream *s, void *userdata)
355 audio_output_t *aout = userdata;
356 aout_sys_t *sys = aout->sys;
359 msg_Err(aout, "overflow, flushing");
360 op = pa_stream_flush(s, NULL, NULL);
361 if (unlikely(op == NULL))
363 pa_operation_unref(op);
364 sys->first_pts = VLC_TS_INVALID;
367 static void stream_started_cb(pa_stream *s, void *userdata)
369 audio_output_t *aout = userdata;
371 msg_Dbg(aout, "started");
375 static void stream_suspended_cb(pa_stream *s, void *userdata)
377 audio_output_t *aout = userdata;
379 msg_Dbg(aout, "suspended");
383 static void stream_underflow_cb(pa_stream *s, void *userdata)
385 audio_output_t *aout = userdata;
387 msg_Dbg(aout, "underflow");
391 static int stream_wait(pa_stream *stream, pa_threaded_mainloop *mainloop)
393 pa_stream_state_t state;
395 while ((state = pa_stream_get_state(stream)) != PA_STREAM_READY) {
396 if (state == PA_STREAM_FAILED || state == PA_STREAM_TERMINATED)
398 pa_threaded_mainloop_wait(mainloop);
405 static void sink_input_info_cb(pa_context *ctx, const pa_sink_input_info *i,
406 int eol, void *userdata)
408 audio_output_t *aout = userdata;
409 aout_sys_t *sys = aout->sys;
415 sys->cvolume = i->volume; /* cache volume for balance preservation */
417 pa_volume_t volume = pa_cvolume_max(&i->volume);
418 volume = pa_sw_volume_divide(volume, sys->base_volume);
419 aout_VolumeReport(aout, (float)volume / PA_VOLUME_NORM);
420 aout_MuteReport(aout, i->mute);
424 /*** VLC audio output callbacks ***/
426 static int TimeGet(audio_output_t *aout, mtime_t *restrict delay)
428 aout_sys_t *sys = aout->sys;
429 pa_stream *s = sys->stream;
431 if (pa_stream_is_corked(s) > 0)
432 return -1; /* latency is irrelevant if corked */
434 mtime_t delta = vlc_pa_get_latency(aout, sys->context, s);
435 if (delta == VLC_TS_INVALID)
442 /* Memory free callback. The block_t address is in front of the data. */
443 static void data_free(void *data)
445 block_t **pp = data, *block;
447 memcpy(&block, pp - 1, sizeof (block));
448 block_Release(block);
451 static void *data_convert(block_t **pp)
453 block_t *block = *pp;
454 /* In most cases, there is enough head room, and this is really cheap: */
455 block = block_Realloc(block, sizeof (block), block->i_buffer);
457 if (unlikely(block == NULL))
460 memcpy(block->p_buffer, &block, sizeof (block));
461 block->p_buffer += sizeof (block);
462 block->i_buffer -= sizeof (block);
463 return block->p_buffer;
467 * Queue one audio frame to the playback stream
469 static void Play(audio_output_t *aout, block_t *block)
471 aout_sys_t *sys = aout->sys;
472 pa_stream *s = sys->stream;
474 assert (sys->paused == VLC_TS_INVALID);
476 const void *ptr = data_convert(&block);
477 if (unlikely(ptr == NULL))
480 size_t len = block->i_buffer;
482 /* Note: The core already holds the output FIFO lock at this point.
483 * Therefore we must not under any circumstances (try to) acquire the
484 * output FIFO lock while the PulseAudio threaded main loop lock is held
485 * (including from PulseAudio stream callbacks). Otherwise lock inversion
486 * will take place, and sooner or later a deadlock. */
487 pa_threaded_mainloop_lock(sys->mainloop);
489 if (sys->first_pts == VLC_TS_INVALID)
490 sys->first_pts = block->i_pts;
492 if (pa_stream_is_corked(s) > 0)
493 stream_start(s, aout);
495 #if 0 /* Fault injector to test underrun recovery */
496 static volatile unsigned u = 0;
497 if ((++u % 1000) == 0) {
498 msg_Err(aout, "fault injection");
499 pa_operation_unref(pa_stream_flush(s, NULL, NULL));
503 if (pa_stream_write(s, ptr, len, data_free, 0, PA_SEEK_RELATIVE) < 0) {
504 vlc_pa_error(aout, "cannot write", sys->context);
505 block_Release(block);
508 pa_threaded_mainloop_unlock(sys->mainloop);
512 * Cork or uncork the playback stream
514 static void Pause(audio_output_t *aout, bool paused, mtime_t date)
516 aout_sys_t *sys = aout->sys;
517 pa_stream *s = sys->stream;
519 pa_threaded_mainloop_lock(sys->mainloop);
523 stream_stop(s, aout);
525 assert (sys->paused != VLC_TS_INVALID);
527 msg_Dbg(aout, "resuming after %"PRId64" us", date);
528 sys->paused = VLC_TS_INVALID;
530 if (sys->first_pts != VLC_TS_INVALID) {
531 sys->first_pts += date;
532 stream_start(s, aout);
536 pa_threaded_mainloop_unlock(sys->mainloop);
540 * Flush or drain the playback stream
542 static void Flush(audio_output_t *aout, bool wait)
544 aout_sys_t *sys = aout->sys;
545 pa_stream *s = sys->stream;
548 pa_threaded_mainloop_lock(sys->mainloop);
551 op = pa_stream_drain(s, NULL, NULL);
552 /* TODO: wait for drain completion*/
554 op = pa_stream_flush(s, NULL, NULL);
556 pa_operation_unref(op);
557 pa_threaded_mainloop_unlock(sys->mainloop);
560 static int VolumeSet(audio_output_t *aout, float vol)
562 aout_sys_t *sys = aout->sys;
563 if (sys->stream == NULL)
565 msg_Err (aout, "cannot change volume while not playing");
569 /* VLC provides the software volume so convert directly to PulseAudio
570 * software volume, pa_volume_t. This is not a linear amplification factor
571 * so do not use PulseAudio linear amplification! */
572 vol *= PA_VOLUME_NORM;
573 if (unlikely(vol >= PA_VOLUME_MAX))
575 pa_volume_t volume = pa_sw_volume_multiply(lround(vol), sys->base_volume);
577 /* Preserve the balance (VLC does not support it). */
578 pa_cvolume cvolume = sys->cvolume;
579 pa_cvolume_scale(&cvolume, PA_VOLUME_NORM);
580 pa_sw_cvolume_multiply_scalar(&cvolume, &cvolume, volume);
581 assert(pa_cvolume_valid(&cvolume));
584 uint32_t idx = pa_stream_get_index(sys->stream);
585 pa_threaded_mainloop_lock(sys->mainloop);
586 op = pa_context_set_sink_input_volume(sys->context, idx, &cvolume,
588 if (likely(op != NULL))
589 pa_operation_unref(op);
590 pa_threaded_mainloop_unlock(sys->mainloop);
595 static int MuteSet(audio_output_t *aout, bool mute)
597 aout_sys_t *sys = aout->sys;
598 if (sys->stream == NULL)
600 msg_Err (aout, "cannot change volume while not playing");
605 uint32_t idx = pa_stream_get_index(sys->stream);
606 pa_threaded_mainloop_lock(sys->mainloop);
607 op = pa_context_set_sink_input_mute(sys->context, idx, mute, NULL, NULL);
608 if (likely(op != NULL))
609 pa_operation_unref(op);
610 pa_threaded_mainloop_unlock(sys->mainloop);
615 static int StreamMove(vlc_object_t *obj, const char *varname, vlc_value_t old,
616 vlc_value_t val, void *userdata)
618 audio_output_t *aout = (audio_output_t *)obj;
619 aout_sys_t *sys = aout->sys;
620 pa_stream *s = userdata;
622 uint32_t idx = pa_stream_get_index(s);
623 uint32_t sink_idx = val.i_int;
625 (void) varname; (void) old;
627 pa_threaded_mainloop_lock(sys->mainloop);
628 op = pa_context_move_sink_input_by_index(sys->context, idx, sink_idx,
630 if (likely(op != NULL)) {
631 pa_operation_unref(op);
632 msg_Dbg(aout, "moving to sink %"PRIu32, sink_idx);
634 vlc_pa_error(obj, "cannot move sink", sys->context);
635 pa_threaded_mainloop_unlock(sys->mainloop);
637 return (op != NULL) ? VLC_SUCCESS : VLC_EGENERIC;
640 static void Stop(audio_output_t *);
643 * Create a PulseAudio playback stream, a.k.a. a sink input.
645 static int Start(audio_output_t *aout, audio_sample_format_t *restrict fmt)
647 aout_sys_t *sys = aout->sys;
649 /* Sample format specification */
650 struct pa_sample_spec ss;
651 #if PA_CHECK_VERSION(1,0,0)
652 pa_encoding_t encoding = PA_ENCODING_INVALID;
655 switch (fmt->i_format)
658 fmt->i_format = VLC_CODEC_F32B;
660 ss.format = PA_SAMPLE_FLOAT32BE;
663 fmt->i_format = VLC_CODEC_F32L;
665 ss.format = PA_SAMPLE_FLOAT32LE;
668 ss.format = PA_SAMPLE_S32BE;
671 ss.format = PA_SAMPLE_S32LE;
674 ss.format = PA_SAMPLE_S24BE;
677 ss.format = PA_SAMPLE_S24LE;
680 ss.format = PA_SAMPLE_S16BE;
683 ss.format = PA_SAMPLE_S16LE;
686 ss.format = PA_SAMPLE_U8;
688 #if PA_CHECK_VERSION(1,0,0)
690 fmt->i_format = VLC_CODEC_SPDIFL;
691 encoding = PA_ENCODING_AC3_IEC61937;
692 ss.format = HAVE_FPU ? PA_SAMPLE_FLOAT32NE : PA_SAMPLE_S16NE;
694 /*case VLC_CODEC_EAC3:
695 fmt->i_format = VLC_CODEC_SPDIFL FIXME;
696 encoding = PA_ENCODING_EAC3_IEC61937;
697 ss.format = HAVE_FPU ? PA_SAMPLE_FLOAT32NE : PA_SAMPLE_S16NE;
700 fmt->i_format = VLC_CODEC_SPDIFL FIXME;
701 encoding = PA_ENCODING_MPEG_IEC61937;
702 ss.format = HAVE_FPU ? PA_SAMPLE_FLOAT32NE : PA_SAMPLE_S16NE;
705 fmt->i_format = VLC_CODEC_SPDIFL;
706 encoding = PA_ENCODING_DTS_IEC61937;
707 ss.format = HAVE_FPU ? PA_SAMPLE_FLOAT32NE : PA_SAMPLE_S16NE;
713 fmt->i_format = VLC_CODEC_FL32;
714 ss.format = PA_SAMPLE_FLOAT32NE;
718 fmt->i_format = VLC_CODEC_S16N;
719 ss.format = PA_SAMPLE_S16NE;
724 ss.rate = fmt->i_rate;
725 ss.channels = aout_FormatNbChannels(fmt);
726 if (!pa_sample_spec_valid(&ss)) {
727 msg_Err(aout, "unsupported sample specification");
731 /* Channel mapping (order defined in vlc_aout.h) */
732 struct pa_channel_map map;
735 if (fmt->i_physical_channels & AOUT_CHAN_LEFT)
736 map.map[map.channels++] = PA_CHANNEL_POSITION_FRONT_LEFT;
737 if (fmt->i_physical_channels & AOUT_CHAN_RIGHT)
738 map.map[map.channels++] = PA_CHANNEL_POSITION_FRONT_RIGHT;
739 if (fmt->i_physical_channels & AOUT_CHAN_MIDDLELEFT)
740 map.map[map.channels++] = PA_CHANNEL_POSITION_SIDE_LEFT;
741 if (fmt->i_physical_channels & AOUT_CHAN_MIDDLERIGHT)
742 map.map[map.channels++] = PA_CHANNEL_POSITION_SIDE_RIGHT;
743 if (fmt->i_physical_channels & AOUT_CHAN_REARLEFT)
744 map.map[map.channels++] = PA_CHANNEL_POSITION_REAR_LEFT;
745 if (fmt->i_physical_channels & AOUT_CHAN_REARRIGHT)
746 map.map[map.channels++] = PA_CHANNEL_POSITION_REAR_RIGHT;
747 if (fmt->i_physical_channels & AOUT_CHAN_REARCENTER)
748 map.map[map.channels++] = PA_CHANNEL_POSITION_REAR_CENTER;
749 if (fmt->i_physical_channels & AOUT_CHAN_CENTER)
751 if (ss.channels == 1)
752 map.map[map.channels++] = PA_CHANNEL_POSITION_MONO;
754 map.map[map.channels++] = PA_CHANNEL_POSITION_FRONT_CENTER;
756 if (fmt->i_physical_channels & AOUT_CHAN_LFE)
757 map.map[map.channels++] = PA_CHANNEL_POSITION_LFE;
759 for (unsigned i = 0; map.channels < ss.channels; i++) {
760 map.map[map.channels++] = PA_CHANNEL_POSITION_AUX0 + i;
761 msg_Warn(aout, "mapping channel %"PRIu8" to AUX%u", map.channels, i);
764 if (!pa_channel_map_valid(&map)) {
765 msg_Err(aout, "unsupported channel map");
768 const char *name = pa_channel_map_to_name(&map);
769 msg_Dbg(aout, "using %s channel map", (name != NULL) ? name : "?");
772 /* Stream parameters */
773 const pa_stream_flags_t flags = PA_STREAM_START_CORKED
774 | PA_STREAM_INTERPOLATE_TIMING
775 | PA_STREAM_NOT_MONOTONIC
776 | PA_STREAM_AUTO_TIMING_UPDATE
777 | PA_STREAM_FIX_RATE;
779 struct pa_buffer_attr attr;
781 /* PulseAudio goes berserk if the target length (tlength) is not
782 * significantly longer than 2 periods (minreq), or when the period length
783 * is unspecified and the target length is short. */
784 attr.tlength = pa_usec_to_bytes(3 * AOUT_MIN_PREPARE_TIME, &ss);
785 attr.prebuf = 0; /* trigger manually */
786 attr.minreq = pa_usec_to_bytes(AOUT_MIN_PREPARE_TIME, &ss);
787 attr.fragsize = 0; /* not used for output */
791 sys->first_pts = VLC_TS_INVALID;
792 sys->paused = VLC_TS_INVALID;
795 sys->base_volume = PA_VOLUME_NORM;
796 pa_cvolume_set(&sys->cvolume, ss.channels, PA_VOLUME_NORM);
798 #if PA_CHECK_VERSION(1,0,0)
799 pa_format_info *formatv[2];
800 unsigned formatc = 0;
802 /* Favor digital pass-through if available*/
803 if (encoding != PA_ENCODING_INVALID) {
804 formatv[formatc] = pa_format_info_new();
805 formatv[formatc]->encoding = encoding;
806 pa_format_info_set_rate(formatv[formatc], ss.rate);
807 pa_format_info_set_channels(formatv[formatc], ss.channels);
808 pa_format_info_set_channel_map(formatv[formatc], &map);
812 /* Fallback to PCM */
813 formatv[formatc] = pa_format_info_new();
814 formatv[formatc]->encoding = PA_ENCODING_PCM;
815 pa_format_info_set_sample_format(formatv[formatc], ss.format);
816 pa_format_info_set_rate(formatv[formatc], ss.rate);
817 pa_format_info_set_channels(formatv[formatc], ss.channels);
818 pa_format_info_set_channel_map(formatv[formatc], &map);
821 /* Create a playback stream */
823 pa_proplist *props = pa_proplist_new();
824 if (likely(props != NULL))
825 /* TODO: set other stream properties */
826 pa_proplist_sets (props, PA_PROP_MEDIA_ROLE, "video");
828 pa_threaded_mainloop_lock(sys->mainloop);
829 s = pa_stream_new_extended(sys->context, "audio stream", formatv, formatc,
831 if (likely(props != NULL))
832 pa_proplist_free(props);
834 for (unsigned i = 0; i < formatc; i++)
835 pa_format_info_free(formatv[i]);
837 pa_threaded_mainloop_lock(sys->mainloop);
838 pa_stream *s = pa_stream_new(sys->context, "audio stream", &ss, &map);
841 pa_threaded_mainloop_unlock(sys->mainloop);
842 vlc_pa_error(aout, "stream creation failure", sys->context);
846 pa_stream_set_state_callback(s, stream_state_cb, sys->mainloop);
847 pa_stream_set_buffer_attr_callback(s, stream_buffer_attr_cb, aout);
848 pa_stream_set_event_callback(s, stream_event_cb, aout);
849 pa_stream_set_latency_update_callback(s, stream_latency_cb, aout);
850 pa_stream_set_moved_callback(s, stream_moved_cb, aout);
851 pa_stream_set_overflow_callback(s, stream_overflow_cb, aout);
852 pa_stream_set_started_callback(s, stream_started_cb, aout);
853 pa_stream_set_suspended_callback(s, stream_suspended_cb, aout);
854 pa_stream_set_underflow_callback(s, stream_underflow_cb, aout);
856 if (pa_stream_connect_playback(s, NULL, &attr, flags, NULL, NULL) < 0
857 || stream_wait(s, sys->mainloop)) {
858 vlc_pa_error(aout, "stream connection failure", sys->context);
862 const struct pa_sample_spec *spec = pa_stream_get_sample_spec(s);
863 #if PA_CHECK_VERSION(1,0,0)
864 if (encoding != PA_ENCODING_INVALID) {
865 const pa_format_info *info = pa_stream_get_format_info(s);
867 assert (info != NULL);
868 if (pa_format_info_is_pcm (info)) {
869 msg_Dbg(aout, "digital pass-through not available");
870 fmt->i_format = HAVE_FPU ? VLC_CODEC_FL32 : VLC_CODEC_S16N;
872 msg_Dbg(aout, "digital pass-through enabled");
878 fmt->i_rate = spec->rate;
880 stream_buffer_attr_cb(s, aout);
881 stream_moved_cb(s, aout);
882 pa_threaded_mainloop_unlock(sys->mainloop);
883 var_AddCallback (aout, "audio-device", StreamMove, s);
888 pa_threaded_mainloop_unlock(sys->mainloop);
889 var_AddCallback (aout, "audio-device", StreamMove, s);
895 * Removes a PulseAudio playback stream
897 static void Stop(audio_output_t *aout)
899 aout_sys_t *sys = aout->sys;
900 pa_stream *s = sys->stream;
902 /* The callback takes mainloop lock, so it CANNOT be held here! */
903 var_DelCallback (aout, "audio-device", StreamMove, s);
905 pa_threaded_mainloop_lock(sys->mainloop);
906 if (unlikely(sys->trigger != NULL))
907 vlc_pa_rttime_free(sys->mainloop, sys->trigger);
908 pa_stream_disconnect(s);
910 /* Clear all callbacks */
911 pa_stream_set_state_callback(s, NULL, NULL);
912 pa_stream_set_buffer_attr_callback(s, NULL, NULL);
913 pa_stream_set_event_callback(s, NULL, NULL);
914 pa_stream_set_latency_update_callback(s, NULL, NULL);
915 pa_stream_set_moved_callback(s, NULL, NULL);
916 pa_stream_set_overflow_callback(s, NULL, NULL);
917 pa_stream_set_started_callback(s, NULL, NULL);
918 pa_stream_set_suspended_callback(s, NULL, NULL);
919 pa_stream_set_underflow_callback(s, NULL, NULL);
923 pa_threaded_mainloop_unlock(sys->mainloop);
926 static int Open(vlc_object_t *obj)
928 audio_output_t *aout = (audio_output_t *)obj;
929 aout_sys_t *sys = malloc(sizeof (*sys));
932 #if !PA_CHECK_VERSION(0,9,22)
933 if (!vlc_xlib_init(obj))
936 if (unlikely(sys == NULL))
939 /* Allocate structures */
940 pa_context *ctx = vlc_pa_connect(obj, &sys->mainloop);
952 aout->time_get = TimeGet;
956 aout->volume_set = VolumeSet;
957 aout->mute_set = MuteSet;
959 /* Devices (sinks) */
960 var_Create(aout, "audio-device", VLC_VAR_INTEGER|VLC_VAR_HASCHOICE);
961 var_Change(aout, "audio-device", VLC_VAR_SETTEXT,
962 &(vlc_value_t){ .psz_string = (char *)_("Audio device") },
965 pa_threaded_mainloop_lock(sys->mainloop);
966 op = pa_context_get_sink_info_list(sys->context, sink_list_cb, aout);
968 pa_operation_unref(op);
971 const pa_subscription_mask_t mask = PA_SUBSCRIPTION_MASK_SINK
972 | PA_SUBSCRIPTION_MASK_SINK_INPUT;
973 pa_context_set_subscribe_callback(sys->context, context_cb, aout);
974 op = pa_context_subscribe(sys->context, mask, NULL, NULL);
975 if (likely(op != NULL))
976 pa_operation_unref(op);
977 pa_threaded_mainloop_unlock(sys->mainloop);
982 static void Close(vlc_object_t *obj)
984 audio_output_t *aout = (audio_output_t *)obj;
985 aout_sys_t *sys = aout->sys;
986 pa_context *ctx = sys->context;
988 pa_threaded_mainloop_lock(sys->mainloop);
989 pa_context_set_subscribe_callback(sys->context, NULL, NULL);
990 pa_threaded_mainloop_unlock(sys->mainloop);
991 vlc_pa_disconnect(obj, ctx, sys->mainloop);
993 var_Destroy (aout, "audio-device");