4 This file is part of PulseAudio.
6 Copyright 2006 Lennart Poettering
8 PulseAudio is free software; you can redistribute it and/or modify
9 it under the terms of the GNU Lesser General Public License as published
10 by the Free Software Foundation; either version 2 of the License,
11 or (at your option) any later version.
13 PulseAudio is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
18 You should have received a copy of the GNU Lesser General Public License
19 along with PulseAudio; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
39 #include <jack/jack.h>
41 #include <pulse/xmalloc.h>
43 #include <pulsecore/core-error.h>
44 #include <pulsecore/iochannel.h>
45 #include <pulsecore/sink.h>
46 #include <pulsecore/module.h>
47 #include <pulsecore/core-util.h>
48 #include <pulsecore/modargs.h>
49 #include <pulsecore/log.h>
50 #include <pulse/mainloop-api.h>
52 #include "module-jack-sink-symdef.h"
54 PA_MODULE_AUTHOR("Lennart Poettering")
55 PA_MODULE_DESCRIPTION("Jack Sink")
56 PA_MODULE_VERSION(PACKAGE_VERSION
)
58 "sink_name=<name of sink> "
59 "server_name=<jack server name> "
60 "client_name=<jack client name> "
61 "channels=<number of channels> "
62 "connect=<connect ports?> "
63 "channel_map=<channel map>")
65 #define DEFAULT_SINK_NAME "jack_out"
75 jack_port_t
* port
[PA_CHANNELS_MAX
];
76 jack_client_t
*client
;
78 pthread_mutex_t mutex
;
81 void * buffer
[PA_CHANNELS_MAX
];
82 jack_nframes_t frames_requested
;
87 pa_io_event
*io_event
;
89 jack_nframes_t frames_in_buffer
;
90 jack_nframes_t timestamp
;
93 static const char* const valid_modargs
[] = {
103 static void stop_sink(struct userdata
*u
) {
106 jack_client_close(u
->client
);
108 u
->core
->mainloop
->io_free(u
->io_event
);
110 pa_sink_disconnect(u
->sink
);
111 pa_sink_unref(u
->sink
);
113 pa_module_unload_request(u
->module
);
116 static void io_event_cb(pa_mainloop_api
*m
, pa_io_event
*e
, int fd
, pa_io_event_flags_t flags
, void *userdata
) {
117 struct userdata
*u
= userdata
;
122 assert(flags
== PA_IO_EVENT_INPUT
);
124 assert(u
->pipe_fds
[0] == fd
);
126 pa_read(fd
, &x
, 1, &u
->pipe_fd_type
);
128 if (u
->quit_requested
) {
130 u
->quit_requested
= 0;
134 pthread_mutex_lock(&u
->mutex
);
136 if (u
->frames_requested
> 0) {
138 jack_nframes_t frame_idx
;
141 fs
= pa_frame_size(&u
->sink
->sample_spec
);
143 pa_sink_render_full(u
->sink
, u
->frames_requested
* fs
, &chunk
);
145 for (frame_idx
= 0; frame_idx
< u
->frames_requested
; frame_idx
++) {
148 for (c
= 0; c
< u
->channels
; c
++) {
149 float *s
= ((float*) ((uint8_t*) chunk
.memblock
->data
+ chunk
.index
)) + (frame_idx
* u
->channels
) + c
;
150 float *d
= ((float*) u
->buffer
[c
]) + frame_idx
;
156 pa_memblock_unref(chunk
.memblock
);
158 u
->frames_requested
= 0;
160 pthread_cond_signal(&u
->cond
);
163 pthread_mutex_unlock(&u
->mutex
);
166 static void request_render(struct userdata
*u
) {
170 assert(u
->pipe_fds
[1] >= 0);
171 pa_write(u
->pipe_fds
[1], &c
, 1, &u
->pipe_fd_type
);
174 static void jack_shutdown(void *arg
) {
175 struct userdata
*u
= arg
;
178 u
->quit_requested
= 1;
182 static int jack_process(jack_nframes_t nframes
, void *arg
) {
183 struct userdata
*u
= arg
;
186 if (jack_transport_query(u
->client
, NULL
) == JackTransportRolling
) {
189 pthread_mutex_lock(&u
->mutex
);
191 u
->frames_requested
= nframes
;
193 for (c
= 0; c
< u
->channels
; c
++) {
194 u
->buffer
[c
] = jack_port_get_buffer(u
->port
[c
], nframes
);
195 assert(u
->buffer
[c
]);
200 pthread_cond_wait(&u
->cond
, &u
->mutex
);
202 u
->frames_in_buffer
= nframes
;
203 u
->timestamp
= jack_get_current_transport_frame(u
->client
);
205 pthread_mutex_unlock(&u
->mutex
);
211 static pa_usec_t
sink_get_latency_cb(pa_sink
*s
) {
213 jack_nframes_t n
, l
, d
;
218 if (jack_transport_query(u
->client
, NULL
) != JackTransportRolling
)
221 n
= jack_get_current_transport_frame(u
->client
);
223 if (n
< u
->timestamp
)
226 d
= n
- u
->timestamp
;
227 l
= jack_port_get_total_latency(u
->client
, u
->port
[0]) + u
->frames_in_buffer
;
232 return pa_bytes_to_usec((l
- d
) * pa_frame_size(&s
->sample_spec
), &s
->sample_spec
);
235 static void jack_error_func(const char*t
) {
236 pa_log_warn("JACK error >%s<", t
);
239 int pa__init(pa_core
*c
, pa_module
*m
) {
240 struct userdata
*u
= NULL
;
243 pa_modargs
*ma
= NULL
;
244 jack_status_t status
;
245 const char *server_name
, *client_name
;
246 uint32_t channels
= 0;
249 const char **ports
= NULL
, **p
;
255 jack_set_error_function(jack_error_func
);
257 if (!(ma
= pa_modargs_new(m
->argument
, valid_modargs
))) {
258 pa_log("failed to parse module arguments.");
262 if (pa_modargs_get_value_boolean(ma
, "connect", &do_connect
) < 0) {
263 pa_log("failed to parse connect= argument.");
267 server_name
= pa_modargs_get_value(ma
, "server_name", NULL
);
268 client_name
= pa_modargs_get_value(ma
, "client_name", "PulseAudio");
270 u
= pa_xnew0(struct userdata
, 1);
274 u
->pipe_fds
[0] = u
->pipe_fds
[1] = -1;
277 pthread_mutex_init(&u
->mutex
, NULL
);
278 pthread_cond_init(&u
->cond
, NULL
);
280 if (pipe(u
->pipe_fds
) < 0) {
281 pa_log("pipe() failed: %s", pa_cstrerror(errno
));
285 pa_make_nonblock_fd(u
->pipe_fds
[1]);
287 if (!(u
->client
= jack_client_open(client_name
, server_name
? JackServerName
: JackNullOption
, &status
, server_name
))) {
288 pa_log("jack_client_open() failed.");
292 ports
= jack_get_ports(u
->client
, NULL
, NULL
, JackPortIsPhysical
|JackPortIsInput
);
295 for (p
= ports
; *p
; p
++)
299 channels
= c
->default_sample_spec
.channels
;
301 if (pa_modargs_get_value_u32(ma
, "channels", &channels
) < 0 || channels
<= 0 || channels
>= PA_CHANNELS_MAX
) {
302 pa_log("failed to parse channels= argument.");
306 pa_channel_map_init_auto(&map
, channels
, PA_CHANNEL_MAP_ALSA
);
307 if (pa_modargs_get_channel_map(ma
, &map
) < 0 || map
.channels
!= channels
) {
308 pa_log("failed to parse channel_map= argument.");
312 pa_log_info("Successfully connected as '%s'", jack_get_client_name(u
->client
));
314 ss
.channels
= u
->channels
= channels
;
315 ss
.rate
= jack_get_sample_rate(u
->client
);
316 ss
.format
= PA_SAMPLE_FLOAT32NE
;
318 assert(pa_sample_spec_valid(&ss
));
320 for (i
= 0; i
< ss
.channels
; i
++) {
321 if (!(u
->port
[i
] = jack_port_register(u
->client
, pa_channel_position_to_string(map
.map
[i
]), JACK_DEFAULT_AUDIO_TYPE
, JackPortIsOutput
|JackPortIsTerminal
, 0))) {
322 pa_log("jack_port_register() failed.");
327 if (!(u
->sink
= pa_sink_new(c
, __FILE__
, pa_modargs_get_value(ma
, "sink_name", DEFAULT_SINK_NAME
), 0, &ss
, &map
))) {
328 pa_log("failed to create sink.");
332 u
->sink
->userdata
= u
;
333 pa_sink_set_owner(u
->sink
, m
);
334 pa_sink_set_description(u
->sink
, t
= pa_sprintf_malloc("Jack sink (%s)", jack_get_client_name(u
->client
)));
336 u
->sink
->get_latency
= sink_get_latency_cb
;
338 jack_set_process_callback(u
->client
, jack_process
, u
);
339 jack_on_shutdown(u
->client
, jack_shutdown
, u
);
341 if (jack_activate(u
->client
)) {
342 pa_log("jack_activate() failed");
347 for (i
= 0, p
= ports
; i
< ss
.channels
; i
++, p
++) {
350 pa_log("not enough physical output ports, leaving unconnected.");
354 pa_log_info("connecting %s to %s", jack_port_name(u
->port
[i
]), *p
);
356 if (jack_connect(u
->client
, jack_port_name(u
->port
[i
]), *p
)) {
357 pa_log("failed to connect %s to %s, leaving unconnected.", jack_port_name(u
->port
[i
]), *p
);
364 u
->io_event
= c
->mainloop
->io_new(c
->mainloop
, u
->pipe_fds
[0], PA_IO_EVENT_INPUT
, io_event_cb
, u
);
382 void pa__done(pa_core
*c
, pa_module
*m
) {
386 if (!(u
= m
->userdata
))
390 jack_client_close(u
->client
);
393 c
->mainloop
->io_free(u
->io_event
);
396 pa_sink_disconnect(u
->sink
);
397 pa_sink_unref(u
->sink
);
400 if (u
->pipe_fds
[0] >= 0)
401 close(u
->pipe_fds
[0]);
402 if (u
->pipe_fds
[1] >= 0)
403 close(u
->pipe_fds
[1]);
405 pthread_mutex_destroy(&u
->mutex
);
406 pthread_cond_destroy(&u
->cond
);