2 This file is part of PulseAudio.
4 Copyright 2006 Lennart Poettering
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.
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.
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
32 #include <jack/jack.h>
34 #include <pulse/xmalloc.h>
36 #include <pulsecore/sink.h>
37 #include <pulsecore/module.h>
38 #include <pulsecore/core-util.h>
39 #include <pulsecore/modargs.h>
40 #include <pulsecore/log.h>
41 #include <pulsecore/thread.h>
42 #include <pulsecore/thread-mq.h>
43 #include <pulsecore/rtpoll.h>
44 #include <pulsecore/sample-util.h>
46 #include "module-jack-sink-symdef.h"
50 * Because JACK has a very inflexible event loop management which
51 * doesn't allow us to add our own event sources to the event thread
52 * we cannot use the JACK real-time thread for dispatching our PA
53 * work. Instead, we run an additional RT thread which does most of
54 * the PA handling, and have the JACK RT thread request data from it
55 * via pa_asyncmsgq. The cost is an additional context switch which
56 * should hopefully not be that expensive if RT scheduling is
57 * enabled. A better fix would only be possible with additional event
58 * source support in JACK.
61 PA_MODULE_AUTHOR("Lennart Poettering");
62 PA_MODULE_DESCRIPTION("JACK Sink");
63 PA_MODULE_LOAD_ONCE(true);
64 PA_MODULE_VERSION(PACKAGE_VERSION
);
66 "sink_name=<name for the sink> "
67 "sink_properties=<properties for the card> "
68 "server_name=<jack server name> "
69 "client_name=<jack client name> "
70 "channels=<number of channels> "
71 "channel_map=<channel map> "
72 "connect=<connect ports?>");
74 #define DEFAULT_SINK_NAME "jack_out"
83 jack_port_t
* port
[PA_CHANNELS_MAX
];
84 jack_client_t
*client
;
86 void *buffer
[PA_CHANNELS_MAX
];
88 pa_thread_mq thread_mq
;
89 pa_asyncmsgq
*jack_msgq
;
91 pa_rtpoll_item
*rtpoll_item
;
95 jack_nframes_t frames_in_buffer
;
96 jack_nframes_t saved_frame_time
;
97 bool saved_frame_time_valid
;
100 static const char* const valid_modargs
[] = {
112 SINK_MESSAGE_RENDER
= PA_SINK_MESSAGE_MAX
,
113 SINK_MESSAGE_BUFFER_SIZE
,
114 SINK_MESSAGE_ON_SHUTDOWN
117 static int sink_process_msg(pa_msgobject
*o
, int code
, void *data
, int64_t offset
, pa_memchunk
*memchunk
) {
118 struct userdata
*u
= PA_SINK(o
)->userdata
;
122 case SINK_MESSAGE_RENDER
:
124 /* Handle the request from the JACK thread */
126 if (u
->sink
->thread_info
.state
== PA_SINK_RUNNING
) {
131 pa_assert(offset
> 0);
132 nbytes
= (size_t) offset
* pa_frame_size(&u
->sink
->sample_spec
);
134 pa_sink_render_full(u
->sink
, nbytes
, &chunk
);
136 p
= pa_memblock_acquire_chunk(&chunk
);
137 pa_deinterleave(p
, u
->buffer
, u
->channels
, sizeof(float), (unsigned) offset
);
138 pa_memblock_release(chunk
.memblock
);
140 pa_memblock_unref(chunk
.memblock
);
145 /* Humm, we're not RUNNING, hence let's write some silence */
146 /* This can happen if we're paused, or during shutdown (when we're unlinked but jack is still running). */
148 ss
= u
->sink
->sample_spec
;
151 for (c
= 0; c
< u
->channels
; c
++)
152 pa_silence_memory(u
->buffer
[c
], (size_t) offset
* pa_sample_size(&ss
), &ss
);
155 u
->frames_in_buffer
= (jack_nframes_t
) offset
;
156 u
->saved_frame_time
= * (jack_nframes_t
*) data
;
157 u
->saved_frame_time_valid
= true;
161 case SINK_MESSAGE_BUFFER_SIZE
:
162 pa_sink_set_max_request_within_thread(u
->sink
, (size_t) offset
* pa_frame_size(&u
->sink
->sample_spec
));
165 case SINK_MESSAGE_ON_SHUTDOWN
:
166 pa_asyncmsgq_post(u
->thread_mq
.outq
, PA_MSGOBJECT(u
->core
), PA_CORE_MESSAGE_UNLOAD_MODULE
, u
->module
, 0, NULL
, NULL
);
169 case PA_SINK_MESSAGE_GET_LATENCY
: {
170 jack_nframes_t l
, ft
, d
;
171 jack_latency_range_t r
;
174 /* This is the "worst-case" latency */
175 jack_port_get_latency_range(u
->port
[0], JackPlaybackLatency
, &r
);
176 l
= r
.max
+ u
->frames_in_buffer
;
178 if (u
->saved_frame_time_valid
) {
179 /* Adjust the worst case latency by the time that
180 * passed since we last handed data to JACK */
182 ft
= jack_frame_time(u
->client
);
183 d
= ft
> u
->saved_frame_time
? ft
- u
->saved_frame_time
: 0;
184 l
= l
> d
? l
- d
: 0;
187 /* Convert it to usec */
188 n
= l
* pa_frame_size(&u
->sink
->sample_spec
);
189 *((pa_usec_t
*) data
) = pa_bytes_to_usec(n
, &u
->sink
->sample_spec
);
196 return pa_sink_process_msg(o
, code
, data
, offset
, memchunk
);
199 /* JACK Callback: This is called when JACK needs some data */
200 static int jack_process(jack_nframes_t nframes
, void *arg
) {
201 struct userdata
*u
= arg
;
203 jack_nframes_t frame_time
;
206 /* We just forward the request to our other RT thread */
208 for (c
= 0; c
< u
->channels
; c
++)
209 pa_assert_se(u
->buffer
[c
] = jack_port_get_buffer(u
->port
[c
], nframes
));
211 frame_time
= jack_frame_time(u
->client
);
213 pa_assert_se(pa_asyncmsgq_send(u
->jack_msgq
, PA_MSGOBJECT(u
->sink
), SINK_MESSAGE_RENDER
, &frame_time
, nframes
, NULL
) == 0);
217 static void thread_func(void *userdata
) {
218 struct userdata
*u
= userdata
;
222 pa_log_debug("Thread starting up");
224 if (u
->core
->realtime_scheduling
)
225 pa_make_realtime(u
->core
->realtime_priority
);
227 pa_thread_mq_install(&u
->thread_mq
);
232 if (PA_UNLIKELY(u
->sink
->thread_info
.rewind_requested
))
233 pa_sink_process_rewind(u
->sink
, 0);
235 if ((ret
= pa_rtpoll_run(u
->rtpoll
, true)) < 0)
243 /* If this was no regular exit from the loop we have to continue
244 * processing messages until we received PA_MESSAGE_SHUTDOWN */
245 pa_asyncmsgq_post(u
->thread_mq
.outq
, PA_MSGOBJECT(u
->core
), PA_CORE_MESSAGE_UNLOAD_MODULE
, u
->module
, 0, NULL
, NULL
);
246 pa_asyncmsgq_wait_for(u
->thread_mq
.inq
, PA_MESSAGE_SHUTDOWN
);
249 pa_log_debug("Thread shutting down");
252 /* JACK Callback: This is called when JACK triggers an error */
253 static void jack_error_func(const char*t
) {
256 s
= pa_xstrndup(t
, strcspn(t
, "\n\r"));
257 pa_log_warn("JACK error >%s<", s
);
261 /* JACK Callback: This is called when JACK is set up */
262 static void jack_init(void *arg
) {
263 struct userdata
*u
= arg
;
265 pa_log_info("JACK thread starting up.");
267 if (u
->core
->realtime_scheduling
)
268 pa_make_realtime(u
->core
->realtime_priority
+4);
271 /* JACK Callback: This is called when JACK kicks us */
272 static void jack_shutdown(void* arg
) {
273 struct userdata
*u
= arg
;
275 pa_log_info("JACK thread shutting down.");
276 pa_asyncmsgq_post(u
->jack_msgq
, PA_MSGOBJECT(u
->sink
), SINK_MESSAGE_ON_SHUTDOWN
, NULL
, 0, NULL
, NULL
);
279 /* JACK Callback: This is called when JACK changes the buffer size */
280 static int jack_buffer_size(jack_nframes_t nframes
, void *arg
) {
281 struct userdata
*u
= arg
;
283 pa_log_info("JACK buffer size changed.");
284 pa_asyncmsgq_post(u
->jack_msgq
, PA_MSGOBJECT(u
->sink
), SINK_MESSAGE_BUFFER_SIZE
, NULL
, nframes
, NULL
, NULL
);
288 int pa__init(pa_module
*m
) {
289 struct userdata
*u
= NULL
;
292 pa_modargs
*ma
= NULL
;
293 jack_status_t status
;
294 const char *server_name
, *client_name
;
295 uint32_t channels
= 0;
296 bool do_connect
= true;
298 const char **ports
= NULL
, **p
;
299 pa_sink_new_data data
;
300 jack_latency_range_t r
;
305 jack_set_error_function(jack_error_func
);
307 if (!(ma
= pa_modargs_new(m
->argument
, valid_modargs
))) {
308 pa_log("Failed to parse module arguments.");
312 if (pa_modargs_get_value_boolean(ma
, "connect", &do_connect
) < 0) {
313 pa_log("Failed to parse connect= argument.");
317 server_name
= pa_modargs_get_value(ma
, "server_name", NULL
);
318 client_name
= pa_modargs_get_value(ma
, "client_name", "PulseAudio JACK Sink");
320 m
->userdata
= u
= pa_xnew0(struct userdata
, 1);
323 u
->saved_frame_time_valid
= false;
324 u
->rtpoll
= pa_rtpoll_new();
325 pa_thread_mq_init(&u
->thread_mq
, m
->core
->mainloop
, u
->rtpoll
);
327 /* The queue linking the JACK thread and our RT thread */
328 u
->jack_msgq
= pa_asyncmsgq_new(0);
330 /* The msgq from the JACK RT thread should have an even higher
331 * priority than the normal message queues, to match the guarantee
332 * all other drivers make: supplying the audio device with data is
333 * the top priority -- and as long as that is possible we don't do
335 u
->rtpoll_item
= pa_rtpoll_item_new_asyncmsgq_read(u
->rtpoll
, PA_RTPOLL_EARLY
-1, u
->jack_msgq
);
337 if (!(u
->client
= jack_client_open(client_name
, server_name
? JackServerName
: JackNullOption
, &status
, server_name
))) {
338 pa_log("jack_client_open() failed.");
342 ports
= jack_get_ports(u
->client
, NULL
, JACK_DEFAULT_AUDIO_TYPE
, JackPortIsPhysical
|JackPortIsInput
);
346 for (p
= ports
; *p
; p
++)
350 channels
= m
->core
->default_sample_spec
.channels
;
352 if (pa_modargs_get_value_u32(ma
, "channels", &channels
) < 0 ||
353 !pa_channels_valid(channels
)) {
354 pa_log("Failed to parse channels= argument.");
358 if (channels
== m
->core
->default_channel_map
.channels
)
359 map
= m
->core
->default_channel_map
;
361 pa_channel_map_init_extend(&map
, channels
, PA_CHANNEL_MAP_ALSA
);
363 if (pa_modargs_get_channel_map(ma
, NULL
, &map
) < 0 || map
.channels
!= channels
) {
364 pa_log("Failed to parse channel_map= argument.");
368 pa_log_info("Successfully connected as '%s'", jack_get_client_name(u
->client
));
370 u
->channels
= ss
.channels
= (uint8_t) channels
;
371 ss
.rate
= jack_get_sample_rate(u
->client
);
372 ss
.format
= PA_SAMPLE_FLOAT32NE
;
374 pa_assert(pa_sample_spec_valid(&ss
));
376 for (i
= 0; i
< ss
.channels
; i
++) {
377 if (!(u
->port
[i
] = jack_port_register(u
->client
, pa_channel_position_to_string(map
.map
[i
]), JACK_DEFAULT_AUDIO_TYPE
, JackPortIsOutput
|JackPortIsTerminal
, 0))) {
378 pa_log("jack_port_register() failed.");
383 pa_sink_new_data_init(&data
);
384 data
.driver
= __FILE__
;
386 pa_sink_new_data_set_name(&data
, pa_modargs_get_value(ma
, "sink_name", DEFAULT_SINK_NAME
));
387 pa_sink_new_data_set_sample_spec(&data
, &ss
);
388 pa_sink_new_data_set_channel_map(&data
, &map
);
389 pa_proplist_sets(data
.proplist
, PA_PROP_DEVICE_API
, "jack");
391 pa_proplist_sets(data
.proplist
, PA_PROP_DEVICE_STRING
, server_name
);
392 pa_proplist_setf(data
.proplist
, PA_PROP_DEVICE_DESCRIPTION
, "Jack sink (%s)", jack_get_client_name(u
->client
));
393 pa_proplist_sets(data
.proplist
, "jack.client_name", jack_get_client_name(u
->client
));
395 if (pa_modargs_get_proplist(ma
, "sink_properties", data
.proplist
, PA_UPDATE_REPLACE
) < 0) {
396 pa_log("Invalid properties");
397 pa_sink_new_data_done(&data
);
401 u
->sink
= pa_sink_new(m
->core
, &data
, PA_SINK_LATENCY
);
402 pa_sink_new_data_done(&data
);
405 pa_log("Failed to create sink.");
409 u
->sink
->parent
.process_msg
= sink_process_msg
;
410 u
->sink
->userdata
= u
;
412 pa_sink_set_asyncmsgq(u
->sink
, u
->thread_mq
.inq
);
413 pa_sink_set_rtpoll(u
->sink
, u
->rtpoll
);
414 pa_sink_set_max_request(u
->sink
, jack_get_buffer_size(u
->client
) * pa_frame_size(&u
->sink
->sample_spec
));
416 jack_set_process_callback(u
->client
, jack_process
, u
);
417 jack_on_shutdown(u
->client
, jack_shutdown
, u
);
418 jack_set_thread_init_callback(u
->client
, jack_init
, u
);
419 jack_set_buffer_size_callback(u
->client
, jack_buffer_size
, u
);
421 if (!(u
->thread
= pa_thread_new("jack-sink", thread_func
, u
))) {
422 pa_log("Failed to create thread.");
426 if (jack_activate(u
->client
)) {
427 pa_log("jack_activate() failed");
432 for (i
= 0, p
= ports
; i
< ss
.channels
; i
++, p
++) {
435 pa_log("Not enough physical output ports, leaving unconnected.");
439 pa_log_info("Connecting %s to %s", jack_port_name(u
->port
[i
]), *p
);
441 if (jack_connect(u
->client
, jack_port_name(u
->port
[i
]), *p
)) {
442 pa_log("Failed to connect %s to %s, leaving unconnected.", jack_port_name(u
->port
[i
]), *p
);
448 jack_port_get_latency_range(u
->port
[0], JackPlaybackLatency
, &r
);
449 n
= r
.max
* pa_frame_size(&u
->sink
->sample_spec
);
450 pa_sink_set_fixed_latency(u
->sink
, pa_bytes_to_usec(n
, &u
->sink
->sample_spec
));
451 pa_sink_put(u
->sink
);
471 int pa__get_n_used(pa_module
*m
) {
475 pa_assert_se(u
= m
->userdata
);
477 return pa_sink_linked_by(u
->sink
);
480 void pa__done(pa_module
*m
) {
485 if (!(u
= m
->userdata
))
489 pa_sink_unlink(u
->sink
);
492 jack_client_close(u
->client
);
495 pa_asyncmsgq_send(u
->thread_mq
.inq
, NULL
, PA_MESSAGE_SHUTDOWN
, NULL
, 0, NULL
);
496 pa_thread_free(u
->thread
);
499 pa_thread_mq_done(&u
->thread_mq
);
502 pa_sink_unref(u
->sink
);
505 pa_rtpoll_item_free(u
->rtpoll_item
);
508 pa_asyncmsgq_unref(u
->jack_msgq
);
511 pa_rtpoll_free(u
->rtpoll
);