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 unflexible 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 pa_bool_t 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
= (uint8_t*) pa_memblock_acquire(chunk
.memblock
) + chunk
.index
;
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
;
173 /* This is the "worst-case" latency */
174 l
= jack_port_get_total_latency(u
->client
, u
->port
[0]) + u
->frames_in_buffer
;
176 if (u
->saved_frame_time_valid
) {
177 /* Adjust the worst case latency by the time that
178 * passed since we last handed data to JACK */
180 ft
= jack_frame_time(u
->client
);
181 d
= ft
> u
->saved_frame_time
? ft
- u
->saved_frame_time
: 0;
182 l
= l
> d
? l
- d
: 0;
185 /* Convert it to usec */
186 n
= l
* pa_frame_size(&u
->sink
->sample_spec
);
187 *((pa_usec_t
*) data
) = pa_bytes_to_usec(n
, &u
->sink
->sample_spec
);
194 return pa_sink_process_msg(o
, code
, data
, offset
, memchunk
);
197 /* JACK Callback: This is called when JACK needs some data */
198 static int jack_process(jack_nframes_t nframes
, void *arg
) {
199 struct userdata
*u
= arg
;
201 jack_nframes_t frame_time
;
204 /* We just forward the request to our other RT thread */
206 for (c
= 0; c
< u
->channels
; c
++)
207 pa_assert_se(u
->buffer
[c
] = jack_port_get_buffer(u
->port
[c
], nframes
));
209 frame_time
= jack_frame_time(u
->client
);
211 pa_assert_se(pa_asyncmsgq_send(u
->jack_msgq
, PA_MSGOBJECT(u
->sink
), SINK_MESSAGE_RENDER
, &frame_time
, nframes
, NULL
) == 0);
215 static void thread_func(void *userdata
) {
216 struct userdata
*u
= userdata
;
220 pa_log_debug("Thread starting up");
222 if (u
->core
->realtime_scheduling
)
223 pa_make_realtime(u
->core
->realtime_priority
);
225 pa_thread_mq_install(&u
->thread_mq
);
230 if (PA_SINK_IS_OPENED(u
->sink
->thread_info
.state
))
231 if (u
->sink
->thread_info
.rewind_requested
)
232 pa_sink_process_rewind(u
->sink
, 0);
234 if ((ret
= pa_rtpoll_run(u
->rtpoll
, TRUE
)) < 0)
242 /* If this was no regular exit from the loop we have to continue
243 * processing messages until we received PA_MESSAGE_SHUTDOWN */
244 pa_asyncmsgq_post(u
->thread_mq
.outq
, PA_MSGOBJECT(u
->core
), PA_CORE_MESSAGE_UNLOAD_MODULE
, u
->module
, 0, NULL
, NULL
);
245 pa_asyncmsgq_wait_for(u
->thread_mq
.inq
, PA_MESSAGE_SHUTDOWN
);
248 pa_log_debug("Thread shutting down");
251 /* JACK Callback: This is called when JACK triggers an error */
252 static void jack_error_func(const char*t
) {
255 s
= pa_xstrndup(t
, strcspn(t
, "\n\r"));
256 pa_log_warn("JACK error >%s<", s
);
260 /* JACK Callback: This is called when JACK is set up */
261 static void jack_init(void *arg
) {
262 struct userdata
*u
= arg
;
264 pa_log_info("JACK thread starting up.");
266 if (u
->core
->realtime_scheduling
)
267 pa_make_realtime(u
->core
->realtime_priority
+4);
270 /* JACK Callback: This is called when JACK kicks us */
271 static void jack_shutdown(void* arg
) {
272 struct userdata
*u
= arg
;
274 pa_log_info("JACK thread shutting down.");
275 pa_asyncmsgq_post(u
->jack_msgq
, PA_MSGOBJECT(u
->sink
), SINK_MESSAGE_ON_SHUTDOWN
, NULL
, 0, NULL
, NULL
);
278 /* JACK Callback: This is called when JACK changes the buffer size */
279 static int jack_buffer_size(jack_nframes_t nframes
, void *arg
) {
280 struct userdata
*u
= arg
;
282 pa_log_info("JACK buffer size changed.");
283 pa_asyncmsgq_post(u
->jack_msgq
, PA_MSGOBJECT(u
->sink
), SINK_MESSAGE_BUFFER_SIZE
, NULL
, nframes
, NULL
, NULL
);
287 int pa__init(pa_module
*m
) {
288 struct userdata
*u
= NULL
;
291 pa_modargs
*ma
= NULL
;
292 jack_status_t status
;
293 const char *server_name
, *client_name
;
294 uint32_t channels
= 0;
295 pa_bool_t do_connect
= TRUE
;
297 const char **ports
= NULL
, **p
;
298 pa_sink_new_data data
;
302 jack_set_error_function(jack_error_func
);
304 if (!(ma
= pa_modargs_new(m
->argument
, valid_modargs
))) {
305 pa_log("Failed to parse module arguments.");
309 if (pa_modargs_get_value_boolean(ma
, "connect", &do_connect
) < 0) {
310 pa_log("Failed to parse connect= argument.");
314 server_name
= pa_modargs_get_value(ma
, "server_name", NULL
);
315 client_name
= pa_modargs_get_value(ma
, "client_name", "PulseAudio JACK Sink");
317 m
->userdata
= u
= pa_xnew0(struct userdata
, 1);
320 u
->saved_frame_time_valid
= FALSE
;
321 u
->rtpoll
= pa_rtpoll_new();
322 pa_thread_mq_init(&u
->thread_mq
, m
->core
->mainloop
, u
->rtpoll
);
324 /* The queue linking the JACK thread and our RT thread */
325 u
->jack_msgq
= pa_asyncmsgq_new(0);
327 /* The msgq from the JACK RT thread should have an even higher
328 * priority than the normal message queues, to match the guarantee
329 * all other drivers make: supplying the audio device with data is
330 * the top priority -- and as long as that is possible we don't do
332 u
->rtpoll_item
= pa_rtpoll_item_new_asyncmsgq_read(u
->rtpoll
, PA_RTPOLL_EARLY
-1, u
->jack_msgq
);
334 if (!(u
->client
= jack_client_open(client_name
, server_name
? JackServerName
: JackNullOption
, &status
, server_name
))) {
335 pa_log("jack_client_open() failed.");
339 ports
= jack_get_ports(u
->client
, NULL
, JACK_DEFAULT_AUDIO_TYPE
, JackPortIsPhysical
|JackPortIsInput
);
343 for (p
= ports
; *p
; p
++)
347 channels
= m
->core
->default_sample_spec
.channels
;
349 if (pa_modargs_get_value_u32(ma
, "channels", &channels
) < 0 ||
351 channels
> PA_CHANNELS_MAX
) {
352 pa_log("Failed to parse channels= argument.");
356 if (channels
== m
->core
->default_channel_map
.channels
)
357 map
= m
->core
->default_channel_map
;
359 pa_channel_map_init_extend(&map
, channels
, PA_CHANNEL_MAP_ALSA
);
361 if (pa_modargs_get_channel_map(ma
, NULL
, &map
) < 0 || map
.channels
!= channels
) {
362 pa_log("Failed to parse channel_map= argument.");
366 pa_log_info("Successfully connected as '%s'", jack_get_client_name(u
->client
));
368 u
->channels
= ss
.channels
= (uint8_t) channels
;
369 ss
.rate
= jack_get_sample_rate(u
->client
);
370 ss
.format
= PA_SAMPLE_FLOAT32NE
;
372 pa_assert(pa_sample_spec_valid(&ss
));
374 for (i
= 0; i
< ss
.channels
; i
++) {
375 if (!(u
->port
[i
] = jack_port_register(u
->client
, pa_channel_position_to_string(map
.map
[i
]), JACK_DEFAULT_AUDIO_TYPE
, JackPortIsOutput
|JackPortIsTerminal
, 0))) {
376 pa_log("jack_port_register() failed.");
381 pa_sink_new_data_init(&data
);
382 data
.driver
= __FILE__
;
384 pa_sink_new_data_set_name(&data
, pa_modargs_get_value(ma
, "sink_name", DEFAULT_SINK_NAME
));
385 pa_sink_new_data_set_sample_spec(&data
, &ss
);
386 pa_sink_new_data_set_channel_map(&data
, &map
);
387 pa_proplist_sets(data
.proplist
, PA_PROP_DEVICE_API
, "jack");
389 pa_proplist_sets(data
.proplist
, PA_PROP_DEVICE_STRING
, server_name
);
390 pa_proplist_setf(data
.proplist
, PA_PROP_DEVICE_DESCRIPTION
, "Jack sink (%s)", jack_get_client_name(u
->client
));
391 pa_proplist_sets(data
.proplist
, "jack.client_name", jack_get_client_name(u
->client
));
393 if (pa_modargs_get_proplist(ma
, "sink_properties", data
.proplist
, PA_UPDATE_REPLACE
) < 0) {
394 pa_log("Invalid properties");
395 pa_sink_new_data_done(&data
);
399 u
->sink
= pa_sink_new(m
->core
, &data
, PA_SINK_LATENCY
);
400 pa_sink_new_data_done(&data
);
403 pa_log("Failed to create sink.");
407 u
->sink
->parent
.process_msg
= sink_process_msg
;
408 u
->sink
->userdata
= u
;
410 pa_sink_set_asyncmsgq(u
->sink
, u
->thread_mq
.inq
);
411 pa_sink_set_rtpoll(u
->sink
, u
->rtpoll
);
412 pa_sink_set_max_request(u
->sink
, jack_get_buffer_size(u
->client
) * pa_frame_size(&u
->sink
->sample_spec
));
414 jack_set_process_callback(u
->client
, jack_process
, u
);
415 jack_on_shutdown(u
->client
, jack_shutdown
, u
);
416 jack_set_thread_init_callback(u
->client
, jack_init
, u
);
417 jack_set_buffer_size_callback(u
->client
, jack_buffer_size
, u
);
419 if (!(u
->thread
= pa_thread_new("jack-sink", thread_func
, u
))) {
420 pa_log("Failed to create thread.");
424 if (jack_activate(u
->client
)) {
425 pa_log("jack_activate() failed");
430 for (i
= 0, p
= ports
; i
< ss
.channels
; i
++, p
++) {
433 pa_log("Not enough physical output ports, leaving unconnected.");
437 pa_log_info("Connecting %s to %s", jack_port_name(u
->port
[i
]), *p
);
439 if (jack_connect(u
->client
, jack_port_name(u
->port
[i
]), *p
)) {
440 pa_log("Failed to connect %s to %s, leaving unconnected.", jack_port_name(u
->port
[i
]), *p
);
446 pa_sink_put(u
->sink
);
466 int pa__get_n_used(pa_module
*m
) {
470 pa_assert_se(u
= m
->userdata
);
472 return pa_sink_linked_by(u
->sink
);
475 void pa__done(pa_module
*m
) {
480 if (!(u
= m
->userdata
))
484 pa_sink_unlink(u
->sink
);
487 jack_client_close(u
->client
);
490 pa_asyncmsgq_send(u
->thread_mq
.inq
, NULL
, PA_MESSAGE_SHUTDOWN
, NULL
, 0, NULL
);
491 pa_thread_free(u
->thread
);
494 pa_thread_mq_done(&u
->thread_mq
);
497 pa_sink_unref(u
->sink
);
500 pa_rtpoll_item_free(u
->rtpoll_item
);
503 pa_asyncmsgq_unref(u
->jack_msgq
);
506 pa_rtpoll_free(u
->rtpoll
);