audio/Makefile.objs | 5 + audio/audio.c | 1 + audio/audio_template.h | 2 + audio/jackaudio.c | 677 +++++++++++++++++++++++++++++++++++++++++ configure | 17 ++ qapi/audio.json | 56 +++- 6 files changed, 756 insertions(+), 2 deletions(-) create mode 100644 audio/jackaudio.c
This commit adds a new audiodev backend to allow QEMU to use JACK as
both an audio sink and source.
Signed-off-by: Geoffrey McRae <geoff@hostfission.com>
---
audio/Makefile.objs | 5 +
audio/audio.c | 1 +
audio/audio_template.h | 2 +
audio/jackaudio.c | 677 +++++++++++++++++++++++++++++++++++++++++
configure | 17 ++
qapi/audio.json | 56 +++-
6 files changed, 756 insertions(+), 2 deletions(-)
create mode 100644 audio/jackaudio.c
diff --git a/audio/Makefile.objs b/audio/Makefile.objs
index d7490a379f..b4a4c11f31 100644
--- a/audio/Makefile.objs
+++ b/audio/Makefile.objs
@@ -28,3 +28,8 @@ common-obj-$(CONFIG_AUDIO_SDL) += sdl.mo
sdl.mo-objs = sdlaudio.o
sdl.mo-cflags := $(SDL_CFLAGS)
sdl.mo-libs := $(SDL_LIBS)
+
+# jack module
+common-obj-$(CONFIG_AUDIO_JACK) += jack.mo
+jack.mo-objs = jackaudio.o
+jack.mo-libs := $(JACK_LIBS)
diff --git a/audio/audio.c b/audio/audio.c
index 7a9e680355..95d9fb16ca 100644
--- a/audio/audio.c
+++ b/audio/audio.c
@@ -1969,6 +1969,7 @@ void audio_create_pdos(Audiodev *dev)
CASE(ALSA, alsa, Alsa);
CASE(COREAUDIO, coreaudio, Coreaudio);
CASE(DSOUND, dsound, );
+ CASE(JACK, jack, Jack);
CASE(OSS, oss, Oss);
CASE(PA, pa, Pa);
CASE(SDL, sdl, );
diff --git a/audio/audio_template.h b/audio/audio_template.h
index 7013d3041f..8dd48ce14e 100644
--- a/audio/audio_template.h
+++ b/audio/audio_template.h
@@ -330,6 +330,8 @@ AudiodevPerDirectionOptions *glue(audio_get_pdo_, TYPE)(Audiodev *dev)
dev->u.coreaudio.TYPE);
case AUDIODEV_DRIVER_DSOUND:
return dev->u.dsound.TYPE;
+ case AUDIODEV_DRIVER_JACK:
+ return qapi_AudiodevJackPerDirectionOptions_base(dev->u.jack.TYPE);
case AUDIODEV_DRIVER_OSS:
return qapi_AudiodevOssPerDirectionOptions_base(dev->u.oss.TYPE);
case AUDIODEV_DRIVER_PA:
diff --git a/audio/jackaudio.c b/audio/jackaudio.c
new file mode 100644
index 0000000000..34563f5a13
--- /dev/null
+++ b/audio/jackaudio.c
@@ -0,0 +1,677 @@
+/*
+ * QEMU JACK Audio Connection Kit Client
+ *
+ * Copyright (c) 2020 Geoffrey McRae (gnif)
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#include "qemu/osdep.h"
+#include "qemu/module.h"
+#include "qemu/fifo8.h"
+#include "qemu-common.h"
+#include "audio.h"
+
+#define AUDIO_CAP "jack"
+#include "audio_int.h"
+
+#include <stdatomic.h>
+#include <jack/jack.h>
+#include <jack/thread.h>
+
+struct QJack;
+
+typedef enum QJackState {
+ QJACK_STATE_DISCONNECTED,
+ QJACK_STATE_STOPPED,
+ QJACK_STATE_RUNNING,
+ QJACK_STATE_SHUTDOWN
+}
+QJackState;
+
+typedef struct QJackBuffer {
+ int channels;
+ int frames;
+ _Atomic(int) used;
+ int rptr, wptr;
+ float **data;
+}
+QJackBuffer;
+
+typedef struct QJackClient {
+ AudiodevJackPerDirectionOptions *opt;
+
+ bool out;
+ bool finished;
+ bool connect_ports;
+ int packets;
+
+ QJackState state;
+ jack_client_t *client;
+ jack_nframes_t freq;
+
+ struct QJack *j;
+ int nchannels;
+ int buffersize;
+ jack_port_t **port;
+ QJackBuffer fifo;
+}
+QJackClient;
+
+typedef struct QJackOut {
+ HWVoiceOut hw;
+ QJackClient c;
+}
+QJackOut;
+
+typedef struct QJackIn {
+ HWVoiceIn hw;
+ QJackClient c;
+}
+QJackIn;
+
+static int qjack_client_init(QJackClient *c);
+static void qjack_client_connect_ports(QJackClient *c);
+static void qjack_client_fini(QJackClient *c);
+
+static void qjack_buffer_create(QJackBuffer *buffer, int channels, int frames)
+{
+ buffer->channels = channels;
+ buffer->frames = frames;
+ buffer->used = 0;
+ buffer->rptr = 0;
+ buffer->wptr = 0;
+ buffer->data = g_malloc(channels * sizeof(float *));
+ for (int i = 0; i < channels; ++i) {
+ buffer->data[i] = g_malloc(frames * sizeof(float));
+ }
+}
+
+static void qjack_buffer_clear(QJackBuffer *buffer)
+{
+ assert(buffer->data);
+ atomic_store_explicit(&buffer->used, 0, memory_order_relaxed);
+ buffer->rptr = 0;
+ buffer->wptr = 0;
+}
+
+static void qjack_buffer_free(QJackBuffer *buffer)
+{
+ if (!buffer->data) {
+ return;
+ }
+
+ for (int i = 0; i < buffer->channels; ++i) {
+ g_free(buffer->data[i]);
+ }
+
+ g_free(buffer->data);
+ buffer->data = NULL;
+}
+
+static inline int qjack_buffer_used(QJackBuffer *buffer)
+{
+ assert(buffer->data);
+ return atomic_load_explicit(&buffer->used, memory_order_relaxed);
+}
+
+/* write PCM interleaved */
+static int qjack_buffer_write(QJackBuffer *buffer, float *data, int size)
+{
+ assert(buffer->data);
+ const int samples = size / sizeof(float);
+ int frames = samples / buffer->channels;
+ const int avail = buffer->frames -
+ atomic_load_explicit(&buffer->used, memory_order_acquire);
+
+ if (frames > avail) {
+ frames = avail;
+ }
+
+ int copy = frames;
+ int wptr = buffer->wptr;
+
+ while (copy) {
+
+ for (int c = 0; c < buffer->channels; ++c) {
+ buffer->data[c][wptr] = *data++;
+ }
+
+ if (++wptr == buffer->frames) {
+ wptr = 0;
+ }
+
+ --copy;
+ }
+
+ buffer->wptr = wptr;
+
+ atomic_fetch_add_explicit(&buffer->used, frames, memory_order_release);
+ return frames * buffer->channels * sizeof(float);
+};
+
+/* write PCM linear */
+static int qjack_buffer_write_l(QJackBuffer *buffer, float **dest, int frames)
+{
+ assert(buffer->data);
+ const int avail = buffer->frames -
+ atomic_load_explicit(&buffer->used, memory_order_acquire);
+ int wptr = buffer->wptr;
+
+ if (frames > avail) {
+ frames = avail;
+ }
+
+ int right = buffer->frames - wptr;
+ if (right > frames) {
+ right = frames;
+ }
+
+ const int left = frames - right;
+ for (int c = 0; c < buffer->channels; ++c) {
+ memcpy(buffer->data[c] + wptr, dest[c] , right * sizeof(float));
+ memcpy(buffer->data[c] , dest[c] + right, left * sizeof(float));
+ }
+
+ wptr += frames;
+ if (wptr >= buffer->frames) {
+ wptr -= buffer->frames;
+ }
+ buffer->wptr = wptr;
+
+ atomic_fetch_add_explicit(&buffer->used, frames, memory_order_release);
+ return frames;
+}
+
+/* read PCM interleaved */
+static int qjack_buffer_read(QJackBuffer *buffer, float *dest, int size)
+{
+ assert(buffer->data);
+ const int samples = size / sizeof(float);
+ int frames = samples / buffer->channels;
+ const int avail =
+ atomic_load_explicit(&buffer->used, memory_order_acquire);
+
+ if (frames > avail) {
+ frames = avail;
+ }
+
+ int copy = frames;
+ int rptr = buffer->rptr;
+
+ while (copy) {
+
+ for (int c = 0; c < buffer->channels; ++c) {
+ *dest++ = buffer->data[c][rptr];
+ }
+
+ if (++rptr == buffer->frames) {
+ rptr = 0;
+ }
+
+ --copy;
+ }
+
+ buffer->rptr = rptr;
+
+ atomic_fetch_sub_explicit(&buffer->used, frames, memory_order_release);
+ return frames * buffer->channels * sizeof(float);
+}
+
+/* read PCM linear */
+static int qjack_buffer_read_l(QJackBuffer *buffer, float **dest, int frames)
+{
+ assert(buffer->data);
+ int copy = frames;
+ const int used = atomic_load_explicit(&buffer->used, memory_order_acquire);
+ int rptr = buffer->rptr;
+
+ if (copy > used) {
+ copy = used;
+ }
+
+ int right = buffer->frames - rptr;
+ if (right > copy) {
+ right = copy;
+ }
+
+ const int left = copy - right;
+ for (int c = 0; c < buffer->channels; ++c) {
+ memcpy(dest[c] , buffer->data[c] + rptr, right * sizeof(float));
+ memcpy(dest[c] + right, buffer->data[c] , left * sizeof(float));
+ }
+
+ rptr += copy;
+ if (rptr >= buffer->frames) {
+ rptr -= buffer->frames;
+ }
+ buffer->rptr = rptr;
+
+ atomic_fetch_sub_explicit(&buffer->used, copy, memory_order_release);
+ return copy;
+}
+
+static int qjack_process(jack_nframes_t nframes, void *arg)
+{
+ QJackClient *c = (QJackClient *)arg;
+
+ if (c->state != QJACK_STATE_RUNNING) {
+ return 0;
+ }
+
+ /* get the buffers for the ports */
+ float *buffers[c->nchannels];
+ for (int i = 0; i < c->nchannels; ++i) {
+ buffers[i] = jack_port_get_buffer(c->port[i], nframes);
+ }
+
+ if (c->out) {
+ qjack_buffer_read_l(&c->fifo, buffers, nframes);
+ } else {
+ qjack_buffer_write_l(&c->fifo, buffers, nframes);
+ }
+
+ return 0;
+}
+
+static void qjack_port_registration(jack_port_id_t port, int reg, void *arg)
+{
+ if (reg) {
+ QJackClient *c = (QJackClient *)arg;
+ c->connect_ports = true;
+ }
+}
+
+static int qjack_xrun(void *arg)
+{
+ QJackClient *c = (QJackClient *)arg;
+ if (c->state != QJACK_STATE_RUNNING) {
+ return 0;
+ }
+
+ qjack_buffer_clear(&c->fifo);
+ return 0;
+}
+
+static void qjack_shutdown(void *arg)
+{
+ QJackClient *c = (QJackClient *)arg;
+ c->state = QJACK_STATE_SHUTDOWN;
+}
+
+static void qjack_client_recover(QJackClient *c)
+{
+ if (c->state == QJACK_STATE_SHUTDOWN) {
+ qjack_client_fini(c);
+ }
+
+ /* packets is used simply to throttle this */
+ if (c->state == QJACK_STATE_DISCONNECTED &&
+ c->packets % 100 == 0) {
+
+ /* if not finished then attempt to recover */
+ if (!c->finished) {
+ dolog("attempting to reconnect to server\n");
+ qjack_client_init(c);
+ }
+ }
+}
+
+static size_t qjack_write(HWVoiceOut *hw, void *buf, size_t len)
+{
+ QJackOut *jo = (QJackOut *)hw;
+ ++jo->c.packets;
+
+ if (jo->c.state != QJACK_STATE_RUNNING) {
+ qjack_client_recover(&jo->c);
+ return len;
+ }
+
+ qjack_client_connect_ports(&jo->c);
+ return qjack_buffer_write(&jo->c.fifo, buf, len);
+}
+
+static size_t qjack_read(HWVoiceIn *hw, void *buf, size_t len)
+{
+ QJackIn *ji = (QJackIn *)hw;
+ ++ji->c.packets;
+
+ if (ji->c.state != QJACK_STATE_RUNNING) {
+ qjack_client_recover(&ji->c);
+ return len;
+ }
+
+ qjack_client_connect_ports(&ji->c);
+ return qjack_buffer_read(&ji->c.fifo, buf, len);
+}
+
+static void qjack_client_connect_ports(QJackClient *c)
+{
+ if (!c->connect_ports || !c->opt->connect_ports) {
+ return;
+ }
+
+ c->connect_ports = false;
+ const char **ports;
+ ports = jack_get_ports(c->client, c->opt->connect_ports, NULL,
+ c->out ? JackPortIsInput : JackPortIsOutput);
+
+ if (!ports) {
+ return;
+ }
+
+ for (int i = 0; i < c->nchannels && ports[i]; ++i) {
+ const char *p = jack_port_name(c->port[i]);
+ if (jack_port_connected_to(c->port[i], ports[i])) {
+ continue;
+ }
+
+ if (c->out) {
+ dolog("connect %s -> %s\n", p, ports[i]);
+ jack_connect(c->client, p, ports[i]);
+ } else {
+ dolog("connect %s -> %s\n", ports[i], p);
+ jack_connect(c->client, ports[i], p);
+ }
+ }
+}
+
+static int qjack_client_init(QJackClient *c)
+{
+ jack_status_t status;
+ char client_name[jack_client_name_size()];
+ jack_options_t options = JackNullOption;
+
+ c->finished = false;
+ c->connect_ports = true;
+
+ snprintf(client_name, sizeof(client_name), "%s-%s",
+ c->out ? "out" : "in",
+ c->opt->client_name ? c->opt->client_name : qemu_get_vm_name());
+
+ if (c->opt->exact_name) {
+ options |= JackUseExactName;
+ }
+
+ if (!c->opt->start_server) {
+ options |= JackNoStartServer;
+ }
+
+ if (c->opt->server_name) {
+ options |= JackServerName;
+ }
+
+ c->client = jack_client_open(client_name, options, &status,
+ c->opt->server_name);
+
+ if (c->client == NULL) {
+ dolog("jack_client_open failed: status = 0x%2.0x\n", status);
+ if (status & JackServerFailed) {
+ dolog("unable to connect to JACK server\n");
+ }
+ return -1;
+ }
+
+ c->freq = jack_get_sample_rate(c->client);
+
+ if (status & JackServerStarted) {
+ dolog("JACK server started\n");
+ }
+
+ if (status & JackNameNotUnique) {
+ dolog("JACK unique name assigned %s\n",
+ jack_get_client_name(c->client));
+ }
+
+ jack_set_process_callback(c->client, qjack_process , c);
+ jack_set_port_registration_callback(c->client, qjack_port_registration, c);
+ jack_set_xrun_callback(c->client, qjack_xrun, c);
+ jack_on_shutdown(c->client, qjack_shutdown, c);
+
+ /*
+ * ensure the buffersize is no smaller then 512 samples, some (all?) qemu
+ * virtual devices do not work correctly otherwise
+ */
+ if (c->buffersize < 512) {
+ c->buffersize = 512;
+ }
+
+ /* create a 2 period buffer */
+ qjack_buffer_create(&c->fifo, c->nchannels, c->buffersize * 2);
+
+ /* allocate and register the ports */
+ c->port = g_malloc(sizeof(jack_port_t *) * c->nchannels);
+ for (int i = 0; i < c->nchannels; ++i) {
+
+ char port_name[16];
+ snprintf(
+ port_name,
+ sizeof(port_name),
+ c->out ? "output %d" : "input %d",
+ i);
+
+ c->port[i] = jack_port_register(
+ c->client,
+ port_name,
+ JACK_DEFAULT_AUDIO_TYPE,
+ c->out ? JackPortIsOutput : JackPortIsInput,
+ 0);
+ }
+
+ /* activate the session */
+ jack_activate(c->client);
+ c->buffersize = jack_get_buffer_size(c->client);
+
+ qjack_client_connect_ports(c);
+ c->state = QJACK_STATE_RUNNING;
+ return 0;
+}
+
+static int qjack_init_out(HWVoiceOut *hw, struct audsettings *as,
+ void *drv_opaque)
+{
+ QJackOut *jo = (QJackOut *)hw;
+ Audiodev *dev = (Audiodev *)drv_opaque;
+
+ if (jo->c.state != QJACK_STATE_DISCONNECTED) {
+ return 0;
+ }
+
+ jo->c.out = true;
+ jo->c.nchannels = as->nchannels;
+ jo->c.opt = dev->u.jack.out;
+ int ret = qjack_client_init(&jo->c);
+ if (ret != 0) {
+ return ret;
+ }
+
+ /* report the buffer size to qemu */
+ hw->samples = jo->c.buffersize;
+
+ /* report the audio format we support */
+ struct audsettings os = {
+ .freq = jo->c.freq,
+ .nchannels = jo->c.nchannels,
+ .fmt = AUDIO_FORMAT_F32,
+ .endianness = 0
+ };
+ audio_pcm_init_info(&hw->info, &os);
+
+ dolog("JACK output configured for %dHz (%d samples)\n",
+ jo->c.freq, jo->c.buffersize);
+
+ return 0;
+}
+
+static int qjack_init_in(HWVoiceIn *hw, struct audsettings *as,
+ void *drv_opaque)
+{
+ QJackIn *ji = (QJackIn *)hw;
+ Audiodev *dev = (Audiodev *)drv_opaque;
+
+ if (ji->c.state != QJACK_STATE_DISCONNECTED) {
+ return 0;
+ }
+
+ ji->c.out = false;
+ ji->c.nchannels = as->nchannels;
+ ji->c.opt = dev->u.jack.in;
+ int ret = qjack_client_init(&ji->c);
+ if (ret != 0) {
+ return ret;
+ }
+
+ /* report the buffer size to qemu */
+ hw->samples = ji->c.buffersize;
+
+ /* report the audio format we support */
+ struct audsettings is = {
+ .freq = ji->c.freq,
+ .nchannels = ji->c.nchannels,
+ .fmt = AUDIO_FORMAT_F32,
+ .endianness = 0
+ };
+ audio_pcm_init_info(&hw->info, &is);
+
+ dolog("JACK input configured for %dHz (%d samples)\n",
+ ji->c.freq, ji->c.buffersize);
+
+ return 0;
+}
+
+static void qjack_client_fini(QJackClient *c)
+{
+ switch (c->state) {
+ case QJACK_STATE_RUNNING:
+ /* fallthrough */
+
+ case QJACK_STATE_STOPPED:
+ for (int i = 0; i < c->nchannels; ++i) {
+ jack_port_unregister(c->client, c->port[i]);
+ }
+ jack_deactivate(c->client);
+ /* fallthrough */
+
+ case QJACK_STATE_SHUTDOWN:
+ jack_client_close(c->client);
+ /* fallthrough */
+
+ case QJACK_STATE_DISCONNECTED:
+ break;
+ }
+
+ qjack_buffer_free(&c->fifo);
+ g_free(c->port);
+
+ c->state = QJACK_STATE_DISCONNECTED;
+}
+
+static void qjack_fini_out(HWVoiceOut *hw)
+{
+ QJackOut *jo = (QJackOut *)hw;
+ jo->c.finished = true;
+ qjack_client_fini(&jo->c);
+}
+
+static void qjack_fini_in(HWVoiceIn *hw)
+{
+ QJackIn *ji = (QJackIn *)hw;
+ ji->c.finished = true;
+ qjack_client_fini(&ji->c);
+}
+
+static void qjack_enable_out(HWVoiceOut *hw, bool enable)
+{
+}
+
+static void qjack_enable_in(HWVoiceIn *hw, bool enable)
+{
+}
+
+static int qjack_thread_creator(jack_native_thread_t *thread,
+ const pthread_attr_t *attr, void *(*function)(void *), void *arg)
+{
+ int ret = pthread_create(thread, attr, function, arg);
+ if (ret != 0) {
+ return ret;
+ }
+
+ /* set the name of the thread */
+ pthread_setname_np(*thread, "jack-client");
+
+ return ret;
+}
+
+static void *qjack_init(Audiodev *dev)
+{
+ assert(dev->driver == AUDIODEV_DRIVER_JACK);
+
+ dev->u.jack.has_in = false;
+
+ return dev;
+}
+
+static void qjack_fini(void *opaque)
+{
+}
+
+static struct audio_pcm_ops jack_pcm_ops = {
+ .init_out = qjack_init_out,
+ .fini_out = qjack_fini_out,
+ .write = qjack_write,
+ .run_buffer_out = audio_generic_run_buffer_out,
+ .enable_out = qjack_enable_out,
+
+ .init_in = qjack_init_in,
+ .fini_in = qjack_fini_in,
+ .read = qjack_read,
+ .enable_in = qjack_enable_in
+};
+
+static struct audio_driver jack_driver = {
+ .name = "jack",
+ .descr = "JACK Audio Connection Kit Client",
+ .init = qjack_init,
+ .fini = qjack_fini,
+ .pcm_ops = &jack_pcm_ops,
+ .can_be_default = 1,
+ .max_voices_out = INT_MAX,
+ .max_voices_in = INT_MAX,
+ .voice_size_out = sizeof(QJackOut),
+ .voice_size_in = sizeof(QJackIn)
+};
+
+static void qjack_error(const char *msg)
+{
+ dolog("E: %s\n", msg);
+}
+
+static void qjack_info(const char *msg)
+{
+ dolog("I: %s\n", msg);
+}
+
+static void register_audio_jack(void)
+{
+ audio_driver_register(&jack_driver);
+ jack_set_thread_creator(qjack_thread_creator);
+ jack_set_error_function(qjack_error);
+ jack_set_info_function(qjack_info);
+}
+type_init(register_audio_jack);
diff --git a/configure b/configure
index 23b5e93752..004502c775 100755
--- a/configure
+++ b/configure
@@ -3629,6 +3629,22 @@ for drv in $audio_drv_list; do
oss_libs="$oss_lib"
;;
+ jack | try-jack)
+ if $pkg_config jack --exists; then
+ jack_libs=$($pkg_config jack --libs)
+ if test "$drv" = "try-jack"; then
+ audio_drv_list=$(echo "$audio_drv_list" | sed -e 's/try-jack/jack/')
+ fi
+ else
+ if test "$drv" = "try-jack"; then
+ audio_drv_list=$(echo "$audio_drv_list" | sed -e 's/try-jack//')
+ else
+ error_exit "$drv check failed" \
+ "Make sure to have the $drv libs and headers installed."
+ fi
+ fi
+ ;;
+
*)
echo "$audio_possible_drivers" | grep -q "\<$drv\>" || {
error_exit "Unknown driver '$drv' selected" \
@@ -6904,6 +6920,7 @@ echo "PULSE_LIBS=$pulse_libs" >> $config_host_mak
echo "COREAUDIO_LIBS=$coreaudio_libs" >> $config_host_mak
echo "DSOUND_LIBS=$dsound_libs" >> $config_host_mak
echo "OSS_LIBS=$oss_libs" >> $config_host_mak
+echo "JACK_LIBS=$jack_libs" >> $config_host_mak
if test "$audio_win_int" = "yes" ; then
echo "CONFIG_AUDIO_WIN_INT=y" >> $config_host_mak
fi
diff --git a/qapi/audio.json b/qapi/audio.json
index c31251f45b..bdb0552d15 100644
--- a/qapi/audio.json
+++ b/qapi/audio.json
@@ -152,6 +152,55 @@
'*out': 'AudiodevPerDirectionOptions',
'*latency': 'uint32' } }
+##
+# @AudiodevJackPerDirectionOptions:
+#
+# Options of the JACK backend that are used for both playback and
+# recording.
+#
+# @server-name: select from among several possible concurrent server instances.
+# If unspecified, use "default" unless $JACK_DEFAULT_SERVER is defined in the
+# process environment.
+#
+# @client-name: the client name to use. The server will modify this name to
+# create a unique variant, if needed unless @exact_name is true.
+#
+# @connect-ports: if set, a regular expression of port name(s) to match to auto
+# connect to at startup.
+#
+# @start-server: set to true to start a jack server instance if one is not
+# present.
+#
+# @exact-name: use the exact name requested otherwise JACK automatically
+# generates a unique one, if needed.
+#
+# Since: 5.1
+##
+{ 'struct': 'AudiodevJackPerDirectionOptions',
+ 'base': 'AudiodevPerDirectionOptions',
+ 'data': {
+ '*server-name': 'str',
+ '*client-name': 'str',
+ '*connect-ports': 'str',
+ '*start-server': 'bool',
+ '*exact-name': 'bool' } }
+
+##
+# @AudiodevJackOptions:
+#
+# Options of the JACK audio backend.
+#
+# @in: options of the capture stream
+#
+# @out: options of the playback stream
+#
+# Since: 5.1
+##
+{ 'struct': 'AudiodevJackOptions',
+ 'data': {
+ '*in': 'AudiodevJackPerDirectionOptions',
+ '*out': 'AudiodevJackPerDirectionOptions' } }
+
##
# @AudiodevOssPerDirectionOptions:
#
@@ -297,11 +346,13 @@
#
# An enumeration of possible audio backend drivers.
#
+# @jack: JACK audio backend (since 5.1)
+#
# Since: 4.0
##
{ 'enum': 'AudiodevDriver',
- 'data': [ 'none', 'alsa', 'coreaudio', 'dsound', 'oss', 'pa', 'sdl',
- 'spice', 'wav' ] }
+ 'data': [ 'none', 'alsa', 'coreaudio', 'dsound', 'jack', 'oss', 'pa',
+ 'sdl', 'spice', 'wav' ] }
##
# @Audiodev:
@@ -327,6 +378,7 @@
'alsa': 'AudiodevAlsaOptions',
'coreaudio': 'AudiodevCoreaudioOptions',
'dsound': 'AudiodevDsoundOptions',
+ 'jack': 'AudiodevJackOptions',
'oss': 'AudiodevOssOptions',
'pa': 'AudiodevPaOptions',
'sdl': 'AudiodevGenericOptions',
--
2.20.1
You neglected to cc: the audio maintainer. Doing that for you now. You
can use scripts/get_maintainer.pl to find maintainers.
Find my QAPI schema review inline.
Geoffrey McRae <geoff@hostfission.com> writes:
> This commit adds a new audiodev backend to allow QEMU to use JACK as
> both an audio sink and source.
>
> Signed-off-by: Geoffrey McRae <geoff@hostfission.com>
> ---
> audio/Makefile.objs | 5 +
> audio/audio.c | 1 +
> audio/audio_template.h | 2 +
> audio/jackaudio.c | 677 +++++++++++++++++++++++++++++++++++++++++
> configure | 17 ++
> qapi/audio.json | 56 +++-
> 6 files changed, 756 insertions(+), 2 deletions(-)
> create mode 100644 audio/jackaudio.c
>
> diff --git a/audio/Makefile.objs b/audio/Makefile.objs
> index d7490a379f..b4a4c11f31 100644
> --- a/audio/Makefile.objs
> +++ b/audio/Makefile.objs
> @@ -28,3 +28,8 @@ common-obj-$(CONFIG_AUDIO_SDL) += sdl.mo
> sdl.mo-objs = sdlaudio.o
> sdl.mo-cflags := $(SDL_CFLAGS)
> sdl.mo-libs := $(SDL_LIBS)
> +
> +# jack module
> +common-obj-$(CONFIG_AUDIO_JACK) += jack.mo
> +jack.mo-objs = jackaudio.o
> +jack.mo-libs := $(JACK_LIBS)
> diff --git a/audio/audio.c b/audio/audio.c
> index 7a9e680355..95d9fb16ca 100644
> --- a/audio/audio.c
> +++ b/audio/audio.c
> @@ -1969,6 +1969,7 @@ void audio_create_pdos(Audiodev *dev)
> CASE(ALSA, alsa, Alsa);
> CASE(COREAUDIO, coreaudio, Coreaudio);
> CASE(DSOUND, dsound, );
> + CASE(JACK, jack, Jack);
> CASE(OSS, oss, Oss);
> CASE(PA, pa, Pa);
> CASE(SDL, sdl, );
> diff --git a/audio/audio_template.h b/audio/audio_template.h
> index 7013d3041f..8dd48ce14e 100644
> --- a/audio/audio_template.h
> +++ b/audio/audio_template.h
> @@ -330,6 +330,8 @@ AudiodevPerDirectionOptions *glue(audio_get_pdo_, TYPE)(Audiodev *dev)
> dev->u.coreaudio.TYPE);
> case AUDIODEV_DRIVER_DSOUND:
> return dev->u.dsound.TYPE;
> + case AUDIODEV_DRIVER_JACK:
> + return qapi_AudiodevJackPerDirectionOptions_base(dev->u.jack.TYPE);
> case AUDIODEV_DRIVER_OSS:
> return qapi_AudiodevOssPerDirectionOptions_base(dev->u.oss.TYPE);
> case AUDIODEV_DRIVER_PA:
> diff --git a/audio/jackaudio.c b/audio/jackaudio.c
> new file mode 100644
> index 0000000000..34563f5a13
> --- /dev/null
> +++ b/audio/jackaudio.c
> @@ -0,0 +1,677 @@
> +/*
> + * QEMU JACK Audio Connection Kit Client
> + *
> + * Copyright (c) 2020 Geoffrey McRae (gnif)
> + *
> + * Permission is hereby granted, free of charge, to any person obtaining a copy
> + * of this software and associated documentation files (the "Software"), to deal
> + * in the Software without restriction, including without limitation the rights
> + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
> + * copies of the Software, and to permit persons to whom the Software is
> + * furnished to do so, subject to the following conditions:
> + *
> + * The above copyright notice and this permission notice shall be included in
> + * all copies or substantial portions of the Software.
> + *
> + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
> + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
> + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
> + * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
> + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
> + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
> + * THE SOFTWARE.
> + */
> +
> +#include "qemu/osdep.h"
> +#include "qemu/module.h"
> +#include "qemu/fifo8.h"
> +#include "qemu-common.h"
> +#include "audio.h"
> +
> +#define AUDIO_CAP "jack"
> +#include "audio_int.h"
> +
> +#include <stdatomic.h>
> +#include <jack/jack.h>
> +#include <jack/thread.h>
> +
> +struct QJack;
> +
> +typedef enum QJackState {
> + QJACK_STATE_DISCONNECTED,
> + QJACK_STATE_STOPPED,
> + QJACK_STATE_RUNNING,
> + QJACK_STATE_SHUTDOWN
> +}
> +QJackState;
> +
> +typedef struct QJackBuffer {
> + int channels;
> + int frames;
> + _Atomic(int) used;
> + int rptr, wptr;
> + float **data;
> +}
> +QJackBuffer;
> +
> +typedef struct QJackClient {
> + AudiodevJackPerDirectionOptions *opt;
> +
> + bool out;
> + bool finished;
> + bool connect_ports;
> + int packets;
> +
> + QJackState state;
> + jack_client_t *client;
> + jack_nframes_t freq;
> +
> + struct QJack *j;
> + int nchannels;
> + int buffersize;
> + jack_port_t **port;
> + QJackBuffer fifo;
> +}
> +QJackClient;
> +
> +typedef struct QJackOut {
> + HWVoiceOut hw;
> + QJackClient c;
> +}
> +QJackOut;
> +
> +typedef struct QJackIn {
> + HWVoiceIn hw;
> + QJackClient c;
> +}
> +QJackIn;
> +
> +static int qjack_client_init(QJackClient *c);
> +static void qjack_client_connect_ports(QJackClient *c);
> +static void qjack_client_fini(QJackClient *c);
> +
> +static void qjack_buffer_create(QJackBuffer *buffer, int channels, int frames)
> +{
> + buffer->channels = channels;
> + buffer->frames = frames;
> + buffer->used = 0;
> + buffer->rptr = 0;
> + buffer->wptr = 0;
> + buffer->data = g_malloc(channels * sizeof(float *));
> + for (int i = 0; i < channels; ++i) {
> + buffer->data[i] = g_malloc(frames * sizeof(float));
> + }
> +}
> +
> +static void qjack_buffer_clear(QJackBuffer *buffer)
> +{
> + assert(buffer->data);
> + atomic_store_explicit(&buffer->used, 0, memory_order_relaxed);
> + buffer->rptr = 0;
> + buffer->wptr = 0;
> +}
> +
> +static void qjack_buffer_free(QJackBuffer *buffer)
> +{
> + if (!buffer->data) {
> + return;
> + }
> +
> + for (int i = 0; i < buffer->channels; ++i) {
> + g_free(buffer->data[i]);
> + }
> +
> + g_free(buffer->data);
> + buffer->data = NULL;
> +}
> +
> +static inline int qjack_buffer_used(QJackBuffer *buffer)
> +{
> + assert(buffer->data);
> + return atomic_load_explicit(&buffer->used, memory_order_relaxed);
> +}
> +
> +/* write PCM interleaved */
> +static int qjack_buffer_write(QJackBuffer *buffer, float *data, int size)
> +{
> + assert(buffer->data);
> + const int samples = size / sizeof(float);
> + int frames = samples / buffer->channels;
> + const int avail = buffer->frames -
> + atomic_load_explicit(&buffer->used, memory_order_acquire);
> +
> + if (frames > avail) {
> + frames = avail;
> + }
> +
> + int copy = frames;
> + int wptr = buffer->wptr;
> +
> + while (copy) {
> +
> + for (int c = 0; c < buffer->channels; ++c) {
> + buffer->data[c][wptr] = *data++;
> + }
> +
> + if (++wptr == buffer->frames) {
> + wptr = 0;
> + }
> +
> + --copy;
> + }
> +
> + buffer->wptr = wptr;
> +
> + atomic_fetch_add_explicit(&buffer->used, frames, memory_order_release);
> + return frames * buffer->channels * sizeof(float);
> +};
> +
> +/* write PCM linear */
> +static int qjack_buffer_write_l(QJackBuffer *buffer, float **dest, int frames)
> +{
> + assert(buffer->data);
> + const int avail = buffer->frames -
> + atomic_load_explicit(&buffer->used, memory_order_acquire);
> + int wptr = buffer->wptr;
> +
> + if (frames > avail) {
> + frames = avail;
> + }
> +
> + int right = buffer->frames - wptr;
> + if (right > frames) {
> + right = frames;
> + }
> +
> + const int left = frames - right;
> + for (int c = 0; c < buffer->channels; ++c) {
> + memcpy(buffer->data[c] + wptr, dest[c] , right * sizeof(float));
> + memcpy(buffer->data[c] , dest[c] + right, left * sizeof(float));
> + }
> +
> + wptr += frames;
> + if (wptr >= buffer->frames) {
> + wptr -= buffer->frames;
> + }
> + buffer->wptr = wptr;
> +
> + atomic_fetch_add_explicit(&buffer->used, frames, memory_order_release);
> + return frames;
> +}
> +
> +/* read PCM interleaved */
> +static int qjack_buffer_read(QJackBuffer *buffer, float *dest, int size)
> +{
> + assert(buffer->data);
> + const int samples = size / sizeof(float);
> + int frames = samples / buffer->channels;
> + const int avail =
> + atomic_load_explicit(&buffer->used, memory_order_acquire);
> +
> + if (frames > avail) {
> + frames = avail;
> + }
> +
> + int copy = frames;
> + int rptr = buffer->rptr;
> +
> + while (copy) {
> +
> + for (int c = 0; c < buffer->channels; ++c) {
> + *dest++ = buffer->data[c][rptr];
> + }
> +
> + if (++rptr == buffer->frames) {
> + rptr = 0;
> + }
> +
> + --copy;
> + }
> +
> + buffer->rptr = rptr;
> +
> + atomic_fetch_sub_explicit(&buffer->used, frames, memory_order_release);
> + return frames * buffer->channels * sizeof(float);
> +}
> +
> +/* read PCM linear */
> +static int qjack_buffer_read_l(QJackBuffer *buffer, float **dest, int frames)
> +{
> + assert(buffer->data);
> + int copy = frames;
> + const int used = atomic_load_explicit(&buffer->used, memory_order_acquire);
> + int rptr = buffer->rptr;
> +
> + if (copy > used) {
> + copy = used;
> + }
> +
> + int right = buffer->frames - rptr;
> + if (right > copy) {
> + right = copy;
> + }
> +
> + const int left = copy - right;
> + for (int c = 0; c < buffer->channels; ++c) {
> + memcpy(dest[c] , buffer->data[c] + rptr, right * sizeof(float));
> + memcpy(dest[c] + right, buffer->data[c] , left * sizeof(float));
> + }
> +
> + rptr += copy;
> + if (rptr >= buffer->frames) {
> + rptr -= buffer->frames;
> + }
> + buffer->rptr = rptr;
> +
> + atomic_fetch_sub_explicit(&buffer->used, copy, memory_order_release);
> + return copy;
> +}
> +
> +static int qjack_process(jack_nframes_t nframes, void *arg)
> +{
> + QJackClient *c = (QJackClient *)arg;
> +
> + if (c->state != QJACK_STATE_RUNNING) {
> + return 0;
> + }
> +
> + /* get the buffers for the ports */
> + float *buffers[c->nchannels];
> + for (int i = 0; i < c->nchannels; ++i) {
> + buffers[i] = jack_port_get_buffer(c->port[i], nframes);
> + }
> +
> + if (c->out) {
> + qjack_buffer_read_l(&c->fifo, buffers, nframes);
> + } else {
> + qjack_buffer_write_l(&c->fifo, buffers, nframes);
> + }
> +
> + return 0;
> +}
> +
> +static void qjack_port_registration(jack_port_id_t port, int reg, void *arg)
> +{
> + if (reg) {
> + QJackClient *c = (QJackClient *)arg;
> + c->connect_ports = true;
> + }
> +}
> +
> +static int qjack_xrun(void *arg)
> +{
> + QJackClient *c = (QJackClient *)arg;
> + if (c->state != QJACK_STATE_RUNNING) {
> + return 0;
> + }
> +
> + qjack_buffer_clear(&c->fifo);
> + return 0;
> +}
> +
> +static void qjack_shutdown(void *arg)
> +{
> + QJackClient *c = (QJackClient *)arg;
> + c->state = QJACK_STATE_SHUTDOWN;
> +}
> +
> +static void qjack_client_recover(QJackClient *c)
> +{
> + if (c->state == QJACK_STATE_SHUTDOWN) {
> + qjack_client_fini(c);
> + }
> +
> + /* packets is used simply to throttle this */
> + if (c->state == QJACK_STATE_DISCONNECTED &&
> + c->packets % 100 == 0) {
> +
> + /* if not finished then attempt to recover */
> + if (!c->finished) {
> + dolog("attempting to reconnect to server\n");
> + qjack_client_init(c);
> + }
> + }
> +}
> +
> +static size_t qjack_write(HWVoiceOut *hw, void *buf, size_t len)
> +{
> + QJackOut *jo = (QJackOut *)hw;
> + ++jo->c.packets;
> +
> + if (jo->c.state != QJACK_STATE_RUNNING) {
> + qjack_client_recover(&jo->c);
> + return len;
> + }
> +
> + qjack_client_connect_ports(&jo->c);
> + return qjack_buffer_write(&jo->c.fifo, buf, len);
> +}
> +
> +static size_t qjack_read(HWVoiceIn *hw, void *buf, size_t len)
> +{
> + QJackIn *ji = (QJackIn *)hw;
> + ++ji->c.packets;
> +
> + if (ji->c.state != QJACK_STATE_RUNNING) {
> + qjack_client_recover(&ji->c);
> + return len;
> + }
> +
> + qjack_client_connect_ports(&ji->c);
> + return qjack_buffer_read(&ji->c.fifo, buf, len);
> +}
> +
> +static void qjack_client_connect_ports(QJackClient *c)
> +{
> + if (!c->connect_ports || !c->opt->connect_ports) {
> + return;
> + }
> +
> + c->connect_ports = false;
> + const char **ports;
> + ports = jack_get_ports(c->client, c->opt->connect_ports, NULL,
> + c->out ? JackPortIsInput : JackPortIsOutput);
> +
> + if (!ports) {
> + return;
> + }
> +
> + for (int i = 0; i < c->nchannels && ports[i]; ++i) {
> + const char *p = jack_port_name(c->port[i]);
> + if (jack_port_connected_to(c->port[i], ports[i])) {
> + continue;
> + }
> +
> + if (c->out) {
> + dolog("connect %s -> %s\n", p, ports[i]);
> + jack_connect(c->client, p, ports[i]);
> + } else {
> + dolog("connect %s -> %s\n", ports[i], p);
> + jack_connect(c->client, ports[i], p);
> + }
> + }
> +}
> +
> +static int qjack_client_init(QJackClient *c)
> +{
> + jack_status_t status;
> + char client_name[jack_client_name_size()];
> + jack_options_t options = JackNullOption;
> +
> + c->finished = false;
> + c->connect_ports = true;
> +
> + snprintf(client_name, sizeof(client_name), "%s-%s",
> + c->out ? "out" : "in",
> + c->opt->client_name ? c->opt->client_name : qemu_get_vm_name());
> +
> + if (c->opt->exact_name) {
> + options |= JackUseExactName;
> + }
> +
> + if (!c->opt->start_server) {
> + options |= JackNoStartServer;
> + }
> +
> + if (c->opt->server_name) {
> + options |= JackServerName;
> + }
> +
> + c->client = jack_client_open(client_name, options, &status,
> + c->opt->server_name);
> +
> + if (c->client == NULL) {
> + dolog("jack_client_open failed: status = 0x%2.0x\n", status);
> + if (status & JackServerFailed) {
> + dolog("unable to connect to JACK server\n");
> + }
> + return -1;
> + }
> +
> + c->freq = jack_get_sample_rate(c->client);
> +
> + if (status & JackServerStarted) {
> + dolog("JACK server started\n");
> + }
> +
> + if (status & JackNameNotUnique) {
> + dolog("JACK unique name assigned %s\n",
> + jack_get_client_name(c->client));
> + }
> +
> + jack_set_process_callback(c->client, qjack_process , c);
> + jack_set_port_registration_callback(c->client, qjack_port_registration, c);
> + jack_set_xrun_callback(c->client, qjack_xrun, c);
> + jack_on_shutdown(c->client, qjack_shutdown, c);
> +
> + /*
> + * ensure the buffersize is no smaller then 512 samples, some (all?) qemu
> + * virtual devices do not work correctly otherwise
> + */
> + if (c->buffersize < 512) {
> + c->buffersize = 512;
> + }
> +
> + /* create a 2 period buffer */
> + qjack_buffer_create(&c->fifo, c->nchannels, c->buffersize * 2);
> +
> + /* allocate and register the ports */
> + c->port = g_malloc(sizeof(jack_port_t *) * c->nchannels);
> + for (int i = 0; i < c->nchannels; ++i) {
> +
> + char port_name[16];
> + snprintf(
> + port_name,
> + sizeof(port_name),
> + c->out ? "output %d" : "input %d",
> + i);
> +
> + c->port[i] = jack_port_register(
> + c->client,
> + port_name,
> + JACK_DEFAULT_AUDIO_TYPE,
> + c->out ? JackPortIsOutput : JackPortIsInput,
> + 0);
> + }
> +
> + /* activate the session */
> + jack_activate(c->client);
> + c->buffersize = jack_get_buffer_size(c->client);
> +
> + qjack_client_connect_ports(c);
> + c->state = QJACK_STATE_RUNNING;
> + return 0;
> +}
> +
> +static int qjack_init_out(HWVoiceOut *hw, struct audsettings *as,
> + void *drv_opaque)
> +{
> + QJackOut *jo = (QJackOut *)hw;
> + Audiodev *dev = (Audiodev *)drv_opaque;
> +
> + if (jo->c.state != QJACK_STATE_DISCONNECTED) {
> + return 0;
> + }
> +
> + jo->c.out = true;
> + jo->c.nchannels = as->nchannels;
> + jo->c.opt = dev->u.jack.out;
> + int ret = qjack_client_init(&jo->c);
> + if (ret != 0) {
> + return ret;
> + }
> +
> + /* report the buffer size to qemu */
> + hw->samples = jo->c.buffersize;
> +
> + /* report the audio format we support */
> + struct audsettings os = {
> + .freq = jo->c.freq,
> + .nchannels = jo->c.nchannels,
> + .fmt = AUDIO_FORMAT_F32,
> + .endianness = 0
> + };
> + audio_pcm_init_info(&hw->info, &os);
> +
> + dolog("JACK output configured for %dHz (%d samples)\n",
> + jo->c.freq, jo->c.buffersize);
> +
> + return 0;
> +}
> +
> +static int qjack_init_in(HWVoiceIn *hw, struct audsettings *as,
> + void *drv_opaque)
> +{
> + QJackIn *ji = (QJackIn *)hw;
> + Audiodev *dev = (Audiodev *)drv_opaque;
> +
> + if (ji->c.state != QJACK_STATE_DISCONNECTED) {
> + return 0;
> + }
> +
> + ji->c.out = false;
> + ji->c.nchannels = as->nchannels;
> + ji->c.opt = dev->u.jack.in;
> + int ret = qjack_client_init(&ji->c);
> + if (ret != 0) {
> + return ret;
> + }
> +
> + /* report the buffer size to qemu */
> + hw->samples = ji->c.buffersize;
> +
> + /* report the audio format we support */
> + struct audsettings is = {
> + .freq = ji->c.freq,
> + .nchannels = ji->c.nchannels,
> + .fmt = AUDIO_FORMAT_F32,
> + .endianness = 0
> + };
> + audio_pcm_init_info(&hw->info, &is);
> +
> + dolog("JACK input configured for %dHz (%d samples)\n",
> + ji->c.freq, ji->c.buffersize);
> +
> + return 0;
> +}
> +
> +static void qjack_client_fini(QJackClient *c)
> +{
> + switch (c->state) {
> + case QJACK_STATE_RUNNING:
> + /* fallthrough */
> +
> + case QJACK_STATE_STOPPED:
> + for (int i = 0; i < c->nchannels; ++i) {
> + jack_port_unregister(c->client, c->port[i]);
> + }
> + jack_deactivate(c->client);
> + /* fallthrough */
> +
> + case QJACK_STATE_SHUTDOWN:
> + jack_client_close(c->client);
> + /* fallthrough */
> +
> + case QJACK_STATE_DISCONNECTED:
> + break;
> + }
> +
> + qjack_buffer_free(&c->fifo);
> + g_free(c->port);
> +
> + c->state = QJACK_STATE_DISCONNECTED;
> +}
> +
> +static void qjack_fini_out(HWVoiceOut *hw)
> +{
> + QJackOut *jo = (QJackOut *)hw;
> + jo->c.finished = true;
> + qjack_client_fini(&jo->c);
> +}
> +
> +static void qjack_fini_in(HWVoiceIn *hw)
> +{
> + QJackIn *ji = (QJackIn *)hw;
> + ji->c.finished = true;
> + qjack_client_fini(&ji->c);
> +}
> +
> +static void qjack_enable_out(HWVoiceOut *hw, bool enable)
> +{
> +}
> +
> +static void qjack_enable_in(HWVoiceIn *hw, bool enable)
> +{
> +}
> +
> +static int qjack_thread_creator(jack_native_thread_t *thread,
> + const pthread_attr_t *attr, void *(*function)(void *), void *arg)
> +{
> + int ret = pthread_create(thread, attr, function, arg);
> + if (ret != 0) {
> + return ret;
> + }
> +
> + /* set the name of the thread */
> + pthread_setname_np(*thread, "jack-client");
> +
> + return ret;
> +}
> +
> +static void *qjack_init(Audiodev *dev)
> +{
> + assert(dev->driver == AUDIODEV_DRIVER_JACK);
> +
> + dev->u.jack.has_in = false;
> +
> + return dev;
> +}
> +
> +static void qjack_fini(void *opaque)
> +{
> +}
> +
> +static struct audio_pcm_ops jack_pcm_ops = {
> + .init_out = qjack_init_out,
> + .fini_out = qjack_fini_out,
> + .write = qjack_write,
> + .run_buffer_out = audio_generic_run_buffer_out,
> + .enable_out = qjack_enable_out,
> +
> + .init_in = qjack_init_in,
> + .fini_in = qjack_fini_in,
> + .read = qjack_read,
> + .enable_in = qjack_enable_in
> +};
> +
> +static struct audio_driver jack_driver = {
> + .name = "jack",
> + .descr = "JACK Audio Connection Kit Client",
> + .init = qjack_init,
> + .fini = qjack_fini,
> + .pcm_ops = &jack_pcm_ops,
> + .can_be_default = 1,
> + .max_voices_out = INT_MAX,
> + .max_voices_in = INT_MAX,
> + .voice_size_out = sizeof(QJackOut),
> + .voice_size_in = sizeof(QJackIn)
> +};
> +
> +static void qjack_error(const char *msg)
> +{
> + dolog("E: %s\n", msg);
> +}
> +
> +static void qjack_info(const char *msg)
> +{
> + dolog("I: %s\n", msg);
> +}
> +
> +static void register_audio_jack(void)
> +{
> + audio_driver_register(&jack_driver);
> + jack_set_thread_creator(qjack_thread_creator);
> + jack_set_error_function(qjack_error);
> + jack_set_info_function(qjack_info);
> +}
> +type_init(register_audio_jack);
> diff --git a/configure b/configure
> index 23b5e93752..004502c775 100755
> --- a/configure
> +++ b/configure
> @@ -3629,6 +3629,22 @@ for drv in $audio_drv_list; do
> oss_libs="$oss_lib"
> ;;
>
> + jack | try-jack)
> + if $pkg_config jack --exists; then
> + jack_libs=$($pkg_config jack --libs)
> + if test "$drv" = "try-jack"; then
> + audio_drv_list=$(echo "$audio_drv_list" | sed -e 's/try-jack/jack/')
> + fi
> + else
> + if test "$drv" = "try-jack"; then
> + audio_drv_list=$(echo "$audio_drv_list" | sed -e 's/try-jack//')
> + else
> + error_exit "$drv check failed" \
> + "Make sure to have the $drv libs and headers installed."
> + fi
> + fi
> + ;;
> +
> *)
> echo "$audio_possible_drivers" | grep -q "\<$drv\>" || {
> error_exit "Unknown driver '$drv' selected" \
> @@ -6904,6 +6920,7 @@ echo "PULSE_LIBS=$pulse_libs" >> $config_host_mak
> echo "COREAUDIO_LIBS=$coreaudio_libs" >> $config_host_mak
> echo "DSOUND_LIBS=$dsound_libs" >> $config_host_mak
> echo "OSS_LIBS=$oss_libs" >> $config_host_mak
> +echo "JACK_LIBS=$jack_libs" >> $config_host_mak
> if test "$audio_win_int" = "yes" ; then
> echo "CONFIG_AUDIO_WIN_INT=y" >> $config_host_mak
> fi
> diff --git a/qapi/audio.json b/qapi/audio.json
> index c31251f45b..bdb0552d15 100644
> --- a/qapi/audio.json
> +++ b/qapi/audio.json
> @@ -152,6 +152,55 @@
> '*out': 'AudiodevPerDirectionOptions',
> '*latency': 'uint32' } }
>
> +##
> +# @AudiodevJackPerDirectionOptions:
> +#
> +# Options of the JACK backend that are used for both playback and
> +# recording.
> +#
> +# @server-name: select from among several possible concurrent server instances.
> +# If unspecified, use "default" unless $JACK_DEFAULT_SERVER is defined in the
> +# process environment.
Suggest something like
# (default environment variable $JACK_DEFAULT_SERVER if set, else
# "default").
> +#
> +# @client-name: the client name to use. The server will modify this name to
> +# create a unique variant, if needed unless @exact_name is true.
Do we really need this much magic?
What would we lose with just @client-name? If it's present, use it as
is (no magic), else make up a client name.
> +#
> +# @connect-ports: if set, a regular expression of port name(s) to match to auto
> +# connect to at startup.
Pardon my ignorance... where do the port names being matched come from?
> +#
> +# @start-server: set to true to start a jack server instance if one is not
> +# present.
Is this an external server program?
> +#
> +# @exact-name: use the exact name requested otherwise JACK automatically
> +# generates a unique one, if needed.
> +#
> +# Since: 5.1
> +##
> +{ 'struct': 'AudiodevJackPerDirectionOptions',
> + 'base': 'AudiodevPerDirectionOptions',
> + 'data': {
> + '*server-name': 'str',
> + '*client-name': 'str',
> + '*connect-ports': 'str',
> + '*start-server': 'bool',
> + '*exact-name': 'bool' } }
> +
> +##
> +# @AudiodevJackOptions:
> +#
> +# Options of the JACK audio backend.
> +#
> +# @in: options of the capture stream
> +#
> +# @out: options of the playback stream
> +#
> +# Since: 5.1
> +##
> +{ 'struct': 'AudiodevJackOptions',
> + 'data': {
> + '*in': 'AudiodevJackPerDirectionOptions',
> + '*out': 'AudiodevJackPerDirectionOptions' } }
> +
> ##
> # @AudiodevOssPerDirectionOptions:
> #
> @@ -297,11 +346,13 @@
> #
> # An enumeration of possible audio backend drivers.
> #
> +# @jack: JACK audio backend (since 5.1)
> +#
> # Since: 4.0
> ##
> { 'enum': 'AudiodevDriver',
> - 'data': [ 'none', 'alsa', 'coreaudio', 'dsound', 'oss', 'pa', 'sdl',
> - 'spice', 'wav' ] }
> + 'data': [ 'none', 'alsa', 'coreaudio', 'dsound', 'jack', 'oss', 'pa',
> + 'sdl', 'spice', 'wav' ] }
>
> ##
> # @Audiodev:
> @@ -327,6 +378,7 @@
> 'alsa': 'AudiodevAlsaOptions',
> 'coreaudio': 'AudiodevCoreaudioOptions',
> 'dsound': 'AudiodevDsoundOptions',
> + 'jack': 'AudiodevJackOptions',
> 'oss': 'AudiodevOssOptions',
> 'pa': 'AudiodevPaOptions',
> 'sdl': 'AudiodevGenericOptions',
On 2020-05-06 16:06, Markus Armbruster wrote:
> You neglected to cc: the audio maintainer. Doing that for you now.
> You
> can use scripts/get_maintainer.pl to find maintainers.
Thanks, I was unaware.
>
> Find my QAPI schema review inline.
>
Ditto
> Geoffrey McRae <geoff@hostfission.com> writes:
>
>> This commit adds a new audiodev backend to allow QEMU to use JACK as
>> both an audio sink and source.
>>
>> Signed-off-by: Geoffrey McRae <geoff@hostfission.com>
>> ---
>> audio/Makefile.objs | 5 +
>> audio/audio.c | 1 +
>> audio/audio_template.h | 2 +
>> audio/jackaudio.c | 677
>> +++++++++++++++++++++++++++++++++++++++++
>> configure | 17 ++
>> qapi/audio.json | 56 +++-
>> 6 files changed, 756 insertions(+), 2 deletions(-)
>> create mode 100644 audio/jackaudio.c
>>
>> diff --git a/audio/Makefile.objs b/audio/Makefile.objs
>> index d7490a379f..b4a4c11f31 100644
>> --- a/audio/Makefile.objs
>> +++ b/audio/Makefile.objs
>> @@ -28,3 +28,8 @@ common-obj-$(CONFIG_AUDIO_SDL) += sdl.mo
>> sdl.mo-objs = sdlaudio.o
>> sdl.mo-cflags := $(SDL_CFLAGS)
>> sdl.mo-libs := $(SDL_LIBS)
>> +
>> +# jack module
>> +common-obj-$(CONFIG_AUDIO_JACK) += jack.mo
>> +jack.mo-objs = jackaudio.o
>> +jack.mo-libs := $(JACK_LIBS)
>> diff --git a/audio/audio.c b/audio/audio.c
>> index 7a9e680355..95d9fb16ca 100644
>> --- a/audio/audio.c
>> +++ b/audio/audio.c
>> @@ -1969,6 +1969,7 @@ void audio_create_pdos(Audiodev *dev)
>> CASE(ALSA, alsa, Alsa);
>> CASE(COREAUDIO, coreaudio, Coreaudio);
>> CASE(DSOUND, dsound, );
>> + CASE(JACK, jack, Jack);
>> CASE(OSS, oss, Oss);
>> CASE(PA, pa, Pa);
>> CASE(SDL, sdl, );
>> diff --git a/audio/audio_template.h b/audio/audio_template.h
>> index 7013d3041f..8dd48ce14e 100644
>> --- a/audio/audio_template.h
>> +++ b/audio/audio_template.h
>> @@ -330,6 +330,8 @@ AudiodevPerDirectionOptions *glue(audio_get_pdo_,
>> TYPE)(Audiodev *dev)
>> dev->u.coreaudio.TYPE);
>> case AUDIODEV_DRIVER_DSOUND:
>> return dev->u.dsound.TYPE;
>> + case AUDIODEV_DRIVER_JACK:
>> + return
>> qapi_AudiodevJackPerDirectionOptions_base(dev->u.jack.TYPE);
>> case AUDIODEV_DRIVER_OSS:
>> return
>> qapi_AudiodevOssPerDirectionOptions_base(dev->u.oss.TYPE);
>> case AUDIODEV_DRIVER_PA:
>> diff --git a/audio/jackaudio.c b/audio/jackaudio.c
>> new file mode 100644
>> index 0000000000..34563f5a13
>> --- /dev/null
>> +++ b/audio/jackaudio.c
>> @@ -0,0 +1,677 @@
>> +/*
>> + * QEMU JACK Audio Connection Kit Client
>> + *
>> + * Copyright (c) 2020 Geoffrey McRae (gnif)
>> + *
>> + * Permission is hereby granted, free of charge, to any person
>> obtaining a copy
>> + * of this software and associated documentation files (the
>> "Software"), to deal
>> + * in the Software without restriction, including without limitation
>> the rights
>> + * to use, copy, modify, merge, publish, distribute, sublicense,
>> and/or sell
>> + * copies of the Software, and to permit persons to whom the Software
>> is
>> + * furnished to do so, subject to the following conditions:
>> + *
>> + * The above copyright notice and this permission notice shall be
>> included in
>> + * all copies or substantial portions of the Software.
>> + *
>> + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
>> EXPRESS OR
>> + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
>> MERCHANTABILITY,
>> + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
>> SHALL
>> + * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES
>> OR OTHER
>> + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
>> ARISING FROM,
>> + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
>> DEALINGS IN
>> + * THE SOFTWARE.
>> + */
>> +
>> +#include "qemu/osdep.h"
>> +#include "qemu/module.h"
>> +#include "qemu/fifo8.h"
>> +#include "qemu-common.h"
>> +#include "audio.h"
>> +
>> +#define AUDIO_CAP "jack"
>> +#include "audio_int.h"
>> +
>> +#include <stdatomic.h>
>> +#include <jack/jack.h>
>> +#include <jack/thread.h>
>> +
>> +struct QJack;
>> +
>> +typedef enum QJackState {
>> + QJACK_STATE_DISCONNECTED,
>> + QJACK_STATE_STOPPED,
>> + QJACK_STATE_RUNNING,
>> + QJACK_STATE_SHUTDOWN
>> +}
>> +QJackState;
>> +
>> +typedef struct QJackBuffer {
>> + int channels;
>> + int frames;
>> + _Atomic(int) used;
>> + int rptr, wptr;
>> + float **data;
>> +}
>> +QJackBuffer;
>> +
>> +typedef struct QJackClient {
>> + AudiodevJackPerDirectionOptions *opt;
>> +
>> + bool out;
>> + bool finished;
>> + bool connect_ports;
>> + int packets;
>> +
>> + QJackState state;
>> + jack_client_t *client;
>> + jack_nframes_t freq;
>> +
>> + struct QJack *j;
>> + int nchannels;
>> + int buffersize;
>> + jack_port_t **port;
>> + QJackBuffer fifo;
>> +}
>> +QJackClient;
>> +
>> +typedef struct QJackOut {
>> + HWVoiceOut hw;
>> + QJackClient c;
>> +}
>> +QJackOut;
>> +
>> +typedef struct QJackIn {
>> + HWVoiceIn hw;
>> + QJackClient c;
>> +}
>> +QJackIn;
>> +
>> +static int qjack_client_init(QJackClient *c);
>> +static void qjack_client_connect_ports(QJackClient *c);
>> +static void qjack_client_fini(QJackClient *c);
>> +
>> +static void qjack_buffer_create(QJackBuffer *buffer, int channels,
>> int frames)
>> +{
>> + buffer->channels = channels;
>> + buffer->frames = frames;
>> + buffer->used = 0;
>> + buffer->rptr = 0;
>> + buffer->wptr = 0;
>> + buffer->data = g_malloc(channels * sizeof(float *));
>> + for (int i = 0; i < channels; ++i) {
>> + buffer->data[i] = g_malloc(frames * sizeof(float));
>> + }
>> +}
>> +
>> +static void qjack_buffer_clear(QJackBuffer *buffer)
>> +{
>> + assert(buffer->data);
>> + atomic_store_explicit(&buffer->used, 0, memory_order_relaxed);
>> + buffer->rptr = 0;
>> + buffer->wptr = 0;
>> +}
>> +
>> +static void qjack_buffer_free(QJackBuffer *buffer)
>> +{
>> + if (!buffer->data) {
>> + return;
>> + }
>> +
>> + for (int i = 0; i < buffer->channels; ++i) {
>> + g_free(buffer->data[i]);
>> + }
>> +
>> + g_free(buffer->data);
>> + buffer->data = NULL;
>> +}
>> +
>> +static inline int qjack_buffer_used(QJackBuffer *buffer)
>> +{
>> + assert(buffer->data);
>> + return atomic_load_explicit(&buffer->used, memory_order_relaxed);
>> +}
>> +
>> +/* write PCM interleaved */
>> +static int qjack_buffer_write(QJackBuffer *buffer, float *data, int
>> size)
>> +{
>> + assert(buffer->data);
>> + const int samples = size / sizeof(float);
>> + int frames = samples / buffer->channels;
>> + const int avail = buffer->frames -
>> + atomic_load_explicit(&buffer->used, memory_order_acquire);
>> +
>> + if (frames > avail) {
>> + frames = avail;
>> + }
>> +
>> + int copy = frames;
>> + int wptr = buffer->wptr;
>> +
>> + while (copy) {
>> +
>> + for (int c = 0; c < buffer->channels; ++c) {
>> + buffer->data[c][wptr] = *data++;
>> + }
>> +
>> + if (++wptr == buffer->frames) {
>> + wptr = 0;
>> + }
>> +
>> + --copy;
>> + }
>> +
>> + buffer->wptr = wptr;
>> +
>> + atomic_fetch_add_explicit(&buffer->used, frames,
>> memory_order_release);
>> + return frames * buffer->channels * sizeof(float);
>> +};
>> +
>> +/* write PCM linear */
>> +static int qjack_buffer_write_l(QJackBuffer *buffer, float **dest,
>> int frames)
>> +{
>> + assert(buffer->data);
>> + const int avail = buffer->frames -
>> + atomic_load_explicit(&buffer->used, memory_order_acquire);
>> + int wptr = buffer->wptr;
>> +
>> + if (frames > avail) {
>> + frames = avail;
>> + }
>> +
>> + int right = buffer->frames - wptr;
>> + if (right > frames) {
>> + right = frames;
>> + }
>> +
>> + const int left = frames - right;
>> + for (int c = 0; c < buffer->channels; ++c) {
>> + memcpy(buffer->data[c] + wptr, dest[c] , right *
>> sizeof(float));
>> + memcpy(buffer->data[c] , dest[c] + right, left *
>> sizeof(float));
>> + }
>> +
>> + wptr += frames;
>> + if (wptr >= buffer->frames) {
>> + wptr -= buffer->frames;
>> + }
>> + buffer->wptr = wptr;
>> +
>> + atomic_fetch_add_explicit(&buffer->used, frames,
>> memory_order_release);
>> + return frames;
>> +}
>> +
>> +/* read PCM interleaved */
>> +static int qjack_buffer_read(QJackBuffer *buffer, float *dest, int
>> size)
>> +{
>> + assert(buffer->data);
>> + const int samples = size / sizeof(float);
>> + int frames = samples / buffer->channels;
>> + const int avail =
>> + atomic_load_explicit(&buffer->used, memory_order_acquire);
>> +
>> + if (frames > avail) {
>> + frames = avail;
>> + }
>> +
>> + int copy = frames;
>> + int rptr = buffer->rptr;
>> +
>> + while (copy) {
>> +
>> + for (int c = 0; c < buffer->channels; ++c) {
>> + *dest++ = buffer->data[c][rptr];
>> + }
>> +
>> + if (++rptr == buffer->frames) {
>> + rptr = 0;
>> + }
>> +
>> + --copy;
>> + }
>> +
>> + buffer->rptr = rptr;
>> +
>> + atomic_fetch_sub_explicit(&buffer->used, frames,
>> memory_order_release);
>> + return frames * buffer->channels * sizeof(float);
>> +}
>> +
>> +/* read PCM linear */
>> +static int qjack_buffer_read_l(QJackBuffer *buffer, float **dest, int
>> frames)
>> +{
>> + assert(buffer->data);
>> + int copy = frames;
>> + const int used = atomic_load_explicit(&buffer->used,
>> memory_order_acquire);
>> + int rptr = buffer->rptr;
>> +
>> + if (copy > used) {
>> + copy = used;
>> + }
>> +
>> + int right = buffer->frames - rptr;
>> + if (right > copy) {
>> + right = copy;
>> + }
>> +
>> + const int left = copy - right;
>> + for (int c = 0; c < buffer->channels; ++c) {
>> + memcpy(dest[c] , buffer->data[c] + rptr, right *
>> sizeof(float));
>> + memcpy(dest[c] + right, buffer->data[c] , left *
>> sizeof(float));
>> + }
>> +
>> + rptr += copy;
>> + if (rptr >= buffer->frames) {
>> + rptr -= buffer->frames;
>> + }
>> + buffer->rptr = rptr;
>> +
>> + atomic_fetch_sub_explicit(&buffer->used, copy,
>> memory_order_release);
>> + return copy;
>> +}
>> +
>> +static int qjack_process(jack_nframes_t nframes, void *arg)
>> +{
>> + QJackClient *c = (QJackClient *)arg;
>> +
>> + if (c->state != QJACK_STATE_RUNNING) {
>> + return 0;
>> + }
>> +
>> + /* get the buffers for the ports */
>> + float *buffers[c->nchannels];
>> + for (int i = 0; i < c->nchannels; ++i) {
>> + buffers[i] = jack_port_get_buffer(c->port[i], nframes);
>> + }
>> +
>> + if (c->out) {
>> + qjack_buffer_read_l(&c->fifo, buffers, nframes);
>> + } else {
>> + qjack_buffer_write_l(&c->fifo, buffers, nframes);
>> + }
>> +
>> + return 0;
>> +}
>> +
>> +static void qjack_port_registration(jack_port_id_t port, int reg,
>> void *arg)
>> +{
>> + if (reg) {
>> + QJackClient *c = (QJackClient *)arg;
>> + c->connect_ports = true;
>> + }
>> +}
>> +
>> +static int qjack_xrun(void *arg)
>> +{
>> + QJackClient *c = (QJackClient *)arg;
>> + if (c->state != QJACK_STATE_RUNNING) {
>> + return 0;
>> + }
>> +
>> + qjack_buffer_clear(&c->fifo);
>> + return 0;
>> +}
>> +
>> +static void qjack_shutdown(void *arg)
>> +{
>> + QJackClient *c = (QJackClient *)arg;
>> + c->state = QJACK_STATE_SHUTDOWN;
>> +}
>> +
>> +static void qjack_client_recover(QJackClient *c)
>> +{
>> + if (c->state == QJACK_STATE_SHUTDOWN) {
>> + qjack_client_fini(c);
>> + }
>> +
>> + /* packets is used simply to throttle this */
>> + if (c->state == QJACK_STATE_DISCONNECTED &&
>> + c->packets % 100 == 0) {
>> +
>> + /* if not finished then attempt to recover */
>> + if (!c->finished) {
>> + dolog("attempting to reconnect to server\n");
>> + qjack_client_init(c);
>> + }
>> + }
>> +}
>> +
>> +static size_t qjack_write(HWVoiceOut *hw, void *buf, size_t len)
>> +{
>> + QJackOut *jo = (QJackOut *)hw;
>> + ++jo->c.packets;
>> +
>> + if (jo->c.state != QJACK_STATE_RUNNING) {
>> + qjack_client_recover(&jo->c);
>> + return len;
>> + }
>> +
>> + qjack_client_connect_ports(&jo->c);
>> + return qjack_buffer_write(&jo->c.fifo, buf, len);
>> +}
>> +
>> +static size_t qjack_read(HWVoiceIn *hw, void *buf, size_t len)
>> +{
>> + QJackIn *ji = (QJackIn *)hw;
>> + ++ji->c.packets;
>> +
>> + if (ji->c.state != QJACK_STATE_RUNNING) {
>> + qjack_client_recover(&ji->c);
>> + return len;
>> + }
>> +
>> + qjack_client_connect_ports(&ji->c);
>> + return qjack_buffer_read(&ji->c.fifo, buf, len);
>> +}
>> +
>> +static void qjack_client_connect_ports(QJackClient *c)
>> +{
>> + if (!c->connect_ports || !c->opt->connect_ports) {
>> + return;
>> + }
>> +
>> + c->connect_ports = false;
>> + const char **ports;
>> + ports = jack_get_ports(c->client, c->opt->connect_ports, NULL,
>> + c->out ? JackPortIsInput : JackPortIsOutput);
>> +
>> + if (!ports) {
>> + return;
>> + }
>> +
>> + for (int i = 0; i < c->nchannels && ports[i]; ++i) {
>> + const char *p = jack_port_name(c->port[i]);
>> + if (jack_port_connected_to(c->port[i], ports[i])) {
>> + continue;
>> + }
>> +
>> + if (c->out) {
>> + dolog("connect %s -> %s\n", p, ports[i]);
>> + jack_connect(c->client, p, ports[i]);
>> + } else {
>> + dolog("connect %s -> %s\n", ports[i], p);
>> + jack_connect(c->client, ports[i], p);
>> + }
>> + }
>> +}
>> +
>> +static int qjack_client_init(QJackClient *c)
>> +{
>> + jack_status_t status;
>> + char client_name[jack_client_name_size()];
>> + jack_options_t options = JackNullOption;
>> +
>> + c->finished = false;
>> + c->connect_ports = true;
>> +
>> + snprintf(client_name, sizeof(client_name), "%s-%s",
>> + c->out ? "out" : "in",
>> + c->opt->client_name ? c->opt->client_name :
>> qemu_get_vm_name());
>> +
>> + if (c->opt->exact_name) {
>> + options |= JackUseExactName;
>> + }
>> +
>> + if (!c->opt->start_server) {
>> + options |= JackNoStartServer;
>> + }
>> +
>> + if (c->opt->server_name) {
>> + options |= JackServerName;
>> + }
>> +
>> + c->client = jack_client_open(client_name, options, &status,
>> + c->opt->server_name);
>> +
>> + if (c->client == NULL) {
>> + dolog("jack_client_open failed: status = 0x%2.0x\n", status);
>> + if (status & JackServerFailed) {
>> + dolog("unable to connect to JACK server\n");
>> + }
>> + return -1;
>> + }
>> +
>> + c->freq = jack_get_sample_rate(c->client);
>> +
>> + if (status & JackServerStarted) {
>> + dolog("JACK server started\n");
>> + }
>> +
>> + if (status & JackNameNotUnique) {
>> + dolog("JACK unique name assigned %s\n",
>> + jack_get_client_name(c->client));
>> + }
>> +
>> + jack_set_process_callback(c->client, qjack_process , c);
>> + jack_set_port_registration_callback(c->client,
>> qjack_port_registration, c);
>> + jack_set_xrun_callback(c->client, qjack_xrun, c);
>> + jack_on_shutdown(c->client, qjack_shutdown, c);
>> +
>> + /*
>> + * ensure the buffersize is no smaller then 512 samples, some
>> (all?) qemu
>> + * virtual devices do not work correctly otherwise
>> + */
>> + if (c->buffersize < 512) {
>> + c->buffersize = 512;
>> + }
>> +
>> + /* create a 2 period buffer */
>> + qjack_buffer_create(&c->fifo, c->nchannels, c->buffersize * 2);
>> +
>> + /* allocate and register the ports */
>> + c->port = g_malloc(sizeof(jack_port_t *) * c->nchannels);
>> + for (int i = 0; i < c->nchannels; ++i) {
>> +
>> + char port_name[16];
>> + snprintf(
>> + port_name,
>> + sizeof(port_name),
>> + c->out ? "output %d" : "input %d",
>> + i);
>> +
>> + c->port[i] = jack_port_register(
>> + c->client,
>> + port_name,
>> + JACK_DEFAULT_AUDIO_TYPE,
>> + c->out ? JackPortIsOutput : JackPortIsInput,
>> + 0);
>> + }
>> +
>> + /* activate the session */
>> + jack_activate(c->client);
>> + c->buffersize = jack_get_buffer_size(c->client);
>> +
>> + qjack_client_connect_ports(c);
>> + c->state = QJACK_STATE_RUNNING;
>> + return 0;
>> +}
>> +
>> +static int qjack_init_out(HWVoiceOut *hw, struct audsettings *as,
>> + void *drv_opaque)
>> +{
>> + QJackOut *jo = (QJackOut *)hw;
>> + Audiodev *dev = (Audiodev *)drv_opaque;
>> +
>> + if (jo->c.state != QJACK_STATE_DISCONNECTED) {
>> + return 0;
>> + }
>> +
>> + jo->c.out = true;
>> + jo->c.nchannels = as->nchannels;
>> + jo->c.opt = dev->u.jack.out;
>> + int ret = qjack_client_init(&jo->c);
>> + if (ret != 0) {
>> + return ret;
>> + }
>> +
>> + /* report the buffer size to qemu */
>> + hw->samples = jo->c.buffersize;
>> +
>> + /* report the audio format we support */
>> + struct audsettings os = {
>> + .freq = jo->c.freq,
>> + .nchannels = jo->c.nchannels,
>> + .fmt = AUDIO_FORMAT_F32,
>> + .endianness = 0
>> + };
>> + audio_pcm_init_info(&hw->info, &os);
>> +
>> + dolog("JACK output configured for %dHz (%d samples)\n",
>> + jo->c.freq, jo->c.buffersize);
>> +
>> + return 0;
>> +}
>> +
>> +static int qjack_init_in(HWVoiceIn *hw, struct audsettings *as,
>> + void *drv_opaque)
>> +{
>> + QJackIn *ji = (QJackIn *)hw;
>> + Audiodev *dev = (Audiodev *)drv_opaque;
>> +
>> + if (ji->c.state != QJACK_STATE_DISCONNECTED) {
>> + return 0;
>> + }
>> +
>> + ji->c.out = false;
>> + ji->c.nchannels = as->nchannels;
>> + ji->c.opt = dev->u.jack.in;
>> + int ret = qjack_client_init(&ji->c);
>> + if (ret != 0) {
>> + return ret;
>> + }
>> +
>> + /* report the buffer size to qemu */
>> + hw->samples = ji->c.buffersize;
>> +
>> + /* report the audio format we support */
>> + struct audsettings is = {
>> + .freq = ji->c.freq,
>> + .nchannels = ji->c.nchannels,
>> + .fmt = AUDIO_FORMAT_F32,
>> + .endianness = 0
>> + };
>> + audio_pcm_init_info(&hw->info, &is);
>> +
>> + dolog("JACK input configured for %dHz (%d samples)\n",
>> + ji->c.freq, ji->c.buffersize);
>> +
>> + return 0;
>> +}
>> +
>> +static void qjack_client_fini(QJackClient *c)
>> +{
>> + switch (c->state) {
>> + case QJACK_STATE_RUNNING:
>> + /* fallthrough */
>> +
>> + case QJACK_STATE_STOPPED:
>> + for (int i = 0; i < c->nchannels; ++i) {
>> + jack_port_unregister(c->client, c->port[i]);
>> + }
>> + jack_deactivate(c->client);
>> + /* fallthrough */
>> +
>> + case QJACK_STATE_SHUTDOWN:
>> + jack_client_close(c->client);
>> + /* fallthrough */
>> +
>> + case QJACK_STATE_DISCONNECTED:
>> + break;
>> + }
>> +
>> + qjack_buffer_free(&c->fifo);
>> + g_free(c->port);
>> +
>> + c->state = QJACK_STATE_DISCONNECTED;
>> +}
>> +
>> +static void qjack_fini_out(HWVoiceOut *hw)
>> +{
>> + QJackOut *jo = (QJackOut *)hw;
>> + jo->c.finished = true;
>> + qjack_client_fini(&jo->c);
>> +}
>> +
>> +static void qjack_fini_in(HWVoiceIn *hw)
>> +{
>> + QJackIn *ji = (QJackIn *)hw;
>> + ji->c.finished = true;
>> + qjack_client_fini(&ji->c);
>> +}
>> +
>> +static void qjack_enable_out(HWVoiceOut *hw, bool enable)
>> +{
>> +}
>> +
>> +static void qjack_enable_in(HWVoiceIn *hw, bool enable)
>> +{
>> +}
>> +
>> +static int qjack_thread_creator(jack_native_thread_t *thread,
>> + const pthread_attr_t *attr, void *(*function)(void *), void *arg)
>> +{
>> + int ret = pthread_create(thread, attr, function, arg);
>> + if (ret != 0) {
>> + return ret;
>> + }
>> +
>> + /* set the name of the thread */
>> + pthread_setname_np(*thread, "jack-client");
>> +
>> + return ret;
>> +}
>> +
>> +static void *qjack_init(Audiodev *dev)
>> +{
>> + assert(dev->driver == AUDIODEV_DRIVER_JACK);
>> +
>> + dev->u.jack.has_in = false;
>> +
>> + return dev;
>> +}
>> +
>> +static void qjack_fini(void *opaque)
>> +{
>> +}
>> +
>> +static struct audio_pcm_ops jack_pcm_ops = {
>> + .init_out = qjack_init_out,
>> + .fini_out = qjack_fini_out,
>> + .write = qjack_write,
>> + .run_buffer_out = audio_generic_run_buffer_out,
>> + .enable_out = qjack_enable_out,
>> +
>> + .init_in = qjack_init_in,
>> + .fini_in = qjack_fini_in,
>> + .read = qjack_read,
>> + .enable_in = qjack_enable_in
>> +};
>> +
>> +static struct audio_driver jack_driver = {
>> + .name = "jack",
>> + .descr = "JACK Audio Connection Kit Client",
>> + .init = qjack_init,
>> + .fini = qjack_fini,
>> + .pcm_ops = &jack_pcm_ops,
>> + .can_be_default = 1,
>> + .max_voices_out = INT_MAX,
>> + .max_voices_in = INT_MAX,
>> + .voice_size_out = sizeof(QJackOut),
>> + .voice_size_in = sizeof(QJackIn)
>> +};
>> +
>> +static void qjack_error(const char *msg)
>> +{
>> + dolog("E: %s\n", msg);
>> +}
>> +
>> +static void qjack_info(const char *msg)
>> +{
>> + dolog("I: %s\n", msg);
>> +}
>> +
>> +static void register_audio_jack(void)
>> +{
>> + audio_driver_register(&jack_driver);
>> + jack_set_thread_creator(qjack_thread_creator);
>> + jack_set_error_function(qjack_error);
>> + jack_set_info_function(qjack_info);
>> +}
>> +type_init(register_audio_jack);
>> diff --git a/configure b/configure
>> index 23b5e93752..004502c775 100755
>> --- a/configure
>> +++ b/configure
>> @@ -3629,6 +3629,22 @@ for drv in $audio_drv_list; do
>> oss_libs="$oss_lib"
>> ;;
>>
>> + jack | try-jack)
>> + if $pkg_config jack --exists; then
>> + jack_libs=$($pkg_config jack --libs)
>> + if test "$drv" = "try-jack"; then
>> + audio_drv_list=$(echo "$audio_drv_list" | sed -e
>> 's/try-jack/jack/')
>> + fi
>> + else
>> + if test "$drv" = "try-jack"; then
>> + audio_drv_list=$(echo "$audio_drv_list" | sed -e
>> 's/try-jack//')
>> + else
>> + error_exit "$drv check failed" \
>> + "Make sure to have the $drv libs and headers
>> installed."
>> + fi
>> + fi
>> + ;;
>> +
>> *)
>> echo "$audio_possible_drivers" | grep -q "\<$drv\>" || {
>> error_exit "Unknown driver '$drv' selected" \
>> @@ -6904,6 +6920,7 @@ echo "PULSE_LIBS=$pulse_libs" >>
>> $config_host_mak
>> echo "COREAUDIO_LIBS=$coreaudio_libs" >> $config_host_mak
>> echo "DSOUND_LIBS=$dsound_libs" >> $config_host_mak
>> echo "OSS_LIBS=$oss_libs" >> $config_host_mak
>> +echo "JACK_LIBS=$jack_libs" >> $config_host_mak
>> if test "$audio_win_int" = "yes" ; then
>> echo "CONFIG_AUDIO_WIN_INT=y" >> $config_host_mak
>> fi
>> diff --git a/qapi/audio.json b/qapi/audio.json
>> index c31251f45b..bdb0552d15 100644
>> --- a/qapi/audio.json
>> +++ b/qapi/audio.json
>> @@ -152,6 +152,55 @@
>> '*out': 'AudiodevPerDirectionOptions',
>> '*latency': 'uint32' } }
>>
>> +##
>> +# @AudiodevJackPerDirectionOptions:
>> +#
>> +# Options of the JACK backend that are used for both playback and
>> +# recording.
>> +#
>> +# @server-name: select from among several possible concurrent server
>> instances.
>> +# If unspecified, use "default" unless $JACK_DEFAULT_SERVER is
>> defined in the
>> +# process environment.
>
> Suggest something like
>
> # (default environment variable $JACK_DEFAULT_SERVER if set, else
> # "default").
>
I'd be happy to change this, however, this terminology reflects the JACK
documentation which people already using JACK will be familiar with.
>> +#
>> +# @client-name: the client name to use. The server will modify this
>> name to
>> +# create a unique variant, if needed unless @exact_name is true.
>
> Do we really need this much magic?
>
> What would we lose with just @client-name? If it's present, use it as
> is (no magic), else make up a client name.
There is no magic on our part, this is how the JACK server works and is
the default.
>
>> +#
>> +# @connect-ports: if set, a regular expression of port name(s) to
>> match to auto
>> +# connect to at startup.
>
> Pardon my ignorance... where do the port names being matched come from?
Other JACK client ports. QEMU become a JACK client which has audio ports
and can be patched into the system sound device, or any number of other
ports for DSP.
>
>> +#
>> +# @start-server: set to true to start a jack server instance if one
>> is not
>> +# present.
>
> Is this an external server program?
Yes, the jack library can start the jack server much like PulseAudio
auto spawns a process on most systems. People using JACK will be
familiar with this already.
>
>> +#
>> +# @exact-name: use the exact name requested otherwise JACK
>> automatically
>> +# generates a unique one, if needed.
>> +#
>> +# Since: 5.1
>> +##
>> +{ 'struct': 'AudiodevJackPerDirectionOptions',
>> + 'base': 'AudiodevPerDirectionOptions',
>> + 'data': {
>> + '*server-name': 'str',
>> + '*client-name': 'str',
>> + '*connect-ports': 'str',
>> + '*start-server': 'bool',
>> + '*exact-name': 'bool' } }
>> +
>> +##
>> +# @AudiodevJackOptions:
>> +#
>> +# Options of the JACK audio backend.
>> +#
>> +# @in: options of the capture stream
>> +#
>> +# @out: options of the playback stream
>> +#
>> +# Since: 5.1
>> +##
>> +{ 'struct': 'AudiodevJackOptions',
>> + 'data': {
>> + '*in': 'AudiodevJackPerDirectionOptions',
>> + '*out': 'AudiodevJackPerDirectionOptions' } }
>> +
>> ##
>> # @AudiodevOssPerDirectionOptions:
>> #
>> @@ -297,11 +346,13 @@
>> #
>> # An enumeration of possible audio backend drivers.
>> #
>> +# @jack: JACK audio backend (since 5.1)
>> +#
>> # Since: 4.0
>> ##
>> { 'enum': 'AudiodevDriver',
>> - 'data': [ 'none', 'alsa', 'coreaudio', 'dsound', 'oss', 'pa',
>> 'sdl',
>> - 'spice', 'wav' ] }
>> + 'data': [ 'none', 'alsa', 'coreaudio', 'dsound', 'jack', 'oss',
>> 'pa',
>> + 'sdl', 'spice', 'wav' ] }
>>
>> ##
>> # @Audiodev:
>> @@ -327,6 +378,7 @@
>> 'alsa': 'AudiodevAlsaOptions',
>> 'coreaudio': 'AudiodevCoreaudioOptions',
>> 'dsound': 'AudiodevDsoundOptions',
>> + 'jack': 'AudiodevJackOptions',
>> 'oss': 'AudiodevOssOptions',
>> 'pa': 'AudiodevPaOptions',
>> 'sdl': 'AudiodevGenericOptions',
Geoffrey McRae <geoff@hostfission.com> writes:
> On 2020-05-06 16:06, Markus Armbruster wrote:
>> You neglected to cc: the audio maintainer. Doing that for you now.
>> You
>> can use scripts/get_maintainer.pl to find maintainers.
>
> Thanks, I was unaware.
Happy to help :)
>>
>> Find my QAPI schema review inline.
>>
>
> Ditto
>
>> Geoffrey McRae <geoff@hostfission.com> writes:
>>
>>> This commit adds a new audiodev backend to allow QEMU to use JACK as
>>> both an audio sink and source.
>>>
>>> Signed-off-by: Geoffrey McRae <geoff@hostfission.com>
>>> ---
>>> audio/Makefile.objs | 5 +
>>> audio/audio.c | 1 +
>>> audio/audio_template.h | 2 +
>>> audio/jackaudio.c | 677
>>> +++++++++++++++++++++++++++++++++++++++++
>>> configure | 17 ++
>>> qapi/audio.json | 56 +++-
>>> 6 files changed, 756 insertions(+), 2 deletions(-)
>>> create mode 100644 audio/jackaudio.c
[...]
>>> diff --git a/qapi/audio.json b/qapi/audio.json
>>> index c31251f45b..bdb0552d15 100644
>>> --- a/qapi/audio.json
>>> +++ b/qapi/audio.json
>>> @@ -152,6 +152,55 @@
>>> '*out': 'AudiodevPerDirectionOptions',
>>> '*latency': 'uint32' } }
>>>
>>> +##
>>> +# @AudiodevJackPerDirectionOptions:
>>> +#
>>> +# Options of the JACK backend that are used for both playback and
>>> +# recording.
>>> +#
>>> +# @server-name: select from among several possible concurrent
>>> server instances.
>>> +# If unspecified, use "default" unless $JACK_DEFAULT_SERVER is
>>> defined in the
>>> +# process environment.
>>
>> Suggest something like
>>
>> # (default environment variable $JACK_DEFAULT_SERVER if set, else
>> # "default").
Uh, needs a colon after "(default" for clarity.
>>
>
> I'd be happy to change this, however, this terminology reflects the
> JACK documentation which people already using JACK will be familiar
> with.
There's a tension between your (sensible) desire to stay close to JACK
documentation, and our need for reasonably consistent QMP reference
documentation.
Where we're talking about genuine JACK stuff, staying close to JACK
documentation feels more important.
Where we're doing general QMP things, doing them the established QMP way
feels more important.
Phrasing "this is the optional member's default value" is QMP. We do it
all over the place like (default: WHATEVER). Please stick to this
conventional QMP format.
The WHATEVER is JACK stuff. Feel free to improve on my suggested
phrasing there.
>>> +#
>>> +# @client-name: the client name to use. The server will modify
>>> this name to
>>> +# create a unique variant, if needed unless @exact_name is true.
>>
>> Do we really need this much magic?
>>
>> What would we lose with just @client-name? If it's present, use it as
>> is (no magic), else make up a client name.
>
> There is no magic on our part, this is how the JACK server works and
> is the default.
Aha!
Please bear with my ignorant questions...
QEMU doesn'r have to expose everything the JACK library and server
provide, only the stuff that is useful to QEMU's users.
There seem to be several variations:
* @client-name absent, @exact_name false
JACK picks a name.
* @client-name absent, @exact_name true
Error? @exact_name silently ignored?
* @client-name present, @exact_name false
JACK picks a name, using @client-name as inspiration somehow.
* @client-name present, @exact_name true
JACK uses @client-name if possible, else error.
Use cases for the three variations that make sense?
When letting JACK pick a name, how do users learn the name?
>>> +#
>>> +# @connect-ports: if set, a regular expression of port name(s) to
>>> match to auto
>>> +# connect to at startup.
>>
>> Pardon my ignorance... where do the port names being matched come from?
>
> Other JACK client ports. QEMU become a JACK client which has audio
> ports and can be patched into the system sound device, or any number
> of other ports for DSP.
I think a slightly less terse doc comment would be a lot easier to
understand. At least "s/ of port name(s)/of JACK client port name(s)/.
Also, "to auto connect to" is quite vague on what gets connected to
these ports. Can we do a bit better?
>>> +#
>>> +# @start-server: set to true to start a jack server instance if
>>> one is not
>>> +# present.
Default?
>>
>> Is this an external server program?
>
> Yes, the jack library can start the jack server much like PulseAudio
> auto spawns a process on most systems. People using JACK will be
> familiar with this already.
Replace "server instance" by "server process"?
>>> +#
>>> +# @exact-name: use the exact name requested otherwise JACK
>>> automatically
>>> +# generates a unique one, if needed.
Default?
>>> +#
>>> +# Since: 5.1
>>> +##
>>> +{ 'struct': 'AudiodevJackPerDirectionOptions',
>>> + 'base': 'AudiodevPerDirectionOptions',
>>> + 'data': {
>>> + '*server-name': 'str',
>>> + '*client-name': 'str',
>>> + '*connect-ports': 'str',
>>> + '*start-server': 'bool',
>>> + '*exact-name': 'bool' } }
>>> +
>>> +##
>>> +# @AudiodevJackOptions:
>>> +#
>>> +# Options of the JACK audio backend.
>>> +#
>>> +# @in: options of the capture stream
>>> +#
>>> +# @out: options of the playback stream
>>> +#
>>> +# Since: 5.1
>>> +##
>>> +{ 'struct': 'AudiodevJackOptions',
>>> + 'data': {
>>> + '*in': 'AudiodevJackPerDirectionOptions',
>>> + '*out': 'AudiodevJackPerDirectionOptions' } }
>>> +
>>> ##
>>> # @AudiodevOssPerDirectionOptions:
>>> #
>>> @@ -297,11 +346,13 @@
>>> #
>>> # An enumeration of possible audio backend drivers.
>>> #
>>> +# @jack: JACK audio backend (since 5.1)
>>> +#
>>> # Since: 4.0
>>> ##
>>> { 'enum': 'AudiodevDriver',
>>> - 'data': [ 'none', 'alsa', 'coreaudio', 'dsound', 'oss', 'pa',
>>> 'sdl',
>>> - 'spice', 'wav' ] }
>>> + 'data': [ 'none', 'alsa', 'coreaudio', 'dsound', 'jack', 'oss',
>>> 'pa',
>>> + 'sdl', 'spice', 'wav' ] }
>>>
>>> ##
>>> # @Audiodev:
>>> @@ -327,6 +378,7 @@
>>> 'alsa': 'AudiodevAlsaOptions',
>>> 'coreaudio': 'AudiodevCoreaudioOptions',
>>> 'dsound': 'AudiodevDsoundOptions',
>>> + 'jack': 'AudiodevJackOptions',
>>> 'oss': 'AudiodevOssOptions',
>>> 'pa': 'AudiodevPaOptions',
>>> 'sdl': 'AudiodevGenericOptions',
On 2020-05-08 16:34, Markus Armbruster wrote:
> Geoffrey McRae <geoff@hostfission.com> writes:
>
>> On 2020-05-06 16:06, Markus Armbruster wrote:
>>> You neglected to cc: the audio maintainer. Doing that for you now.
>>> You
>>> can use scripts/get_maintainer.pl to find maintainers.
>>
>> Thanks, I was unaware.
>
> Happy to help :)
>
>>>
>>> Find my QAPI schema review inline.
>>>
>>
>> Ditto
>>
>>> Geoffrey McRae <geoff@hostfission.com> writes:
>>>
>>>> This commit adds a new audiodev backend to allow QEMU to use JACK as
>>>> both an audio sink and source.
>>>>
>>>> Signed-off-by: Geoffrey McRae <geoff@hostfission.com>
>>>> ---
>>>> audio/Makefile.objs | 5 +
>>>> audio/audio.c | 1 +
>>>> audio/audio_template.h | 2 +
>>>> audio/jackaudio.c | 677
>>>> +++++++++++++++++++++++++++++++++++++++++
>>>> configure | 17 ++
>>>> qapi/audio.json | 56 +++-
>>>> 6 files changed, 756 insertions(+), 2 deletions(-)
>>>> create mode 100644 audio/jackaudio.c
> [...]
>>>> diff --git a/qapi/audio.json b/qapi/audio.json
>>>> index c31251f45b..bdb0552d15 100644
>>>> --- a/qapi/audio.json
>>>> +++ b/qapi/audio.json
>>>> @@ -152,6 +152,55 @@
>>>> '*out': 'AudiodevPerDirectionOptions',
>>>> '*latency': 'uint32' } }
>>>>
>>>> +##
>>>> +# @AudiodevJackPerDirectionOptions:
>>>> +#
>>>> +# Options of the JACK backend that are used for both playback and
>>>> +# recording.
>>>> +#
>>>> +# @server-name: select from among several possible concurrent
>>>> server instances.
>>>> +# If unspecified, use "default" unless $JACK_DEFAULT_SERVER is
>>>> defined in the
>>>> +# process environment.
>>>
>>> Suggest something like
>>>
>>> # (default environment variable $JACK_DEFAULT_SERVER if set, else
>>> # "default").
>
> Uh, needs a colon after "(default" for clarity.
>
>>>
>>
>> I'd be happy to change this, however, this terminology reflects the
>> JACK documentation which people already using JACK will be familiar
>> with.
>
> There's a tension between your (sensible) desire to stay close to JACK
> documentation, and our need for reasonably consistent QMP reference
> documentation.
>
> Where we're talking about genuine JACK stuff, staying close to JACK
> documentation feels more important.
>
> Where we're doing general QMP things, doing them the established QMP
> way
> feels more important.
>
> Phrasing "this is the optional member's default value" is QMP. We do
> it
> all over the place like (default: WHATEVER). Please stick to this
> conventional QMP format.
>
> The WHATEVER is JACK stuff. Feel free to improve on my suggested
> phrasing there.
>
Not a problem, I will reword this as requested.
>>>> +#
>>>> +# @client-name: the client name to use. The server will modify
>>>> this name to
>>>> +# create a unique variant, if needed unless @exact_name is true.
>>>
>>> Do we really need this much magic?
>>>
>>> What would we lose with just @client-name? If it's present, use it
>>> as
>>> is (no magic), else make up a client name.
>>
>> There is no magic on our part, this is how the JACK server works and
>> is the default.
>
> Aha!
>
> Please bear with my ignorant questions...
>
> QEMU doesn'r have to expose everything the JACK library and server
> provide, only the stuff that is useful to QEMU's users.
>
> There seem to be several variations:
>
> * @client-name absent, @exact_name false
>
> JACK picks a name.
>
> * @client-name absent, @exact_name true
>
> Error? @exact_name silently ignored?
>
The @client-name is set to the VM's name as the default if absent.
> * @client-name present, @exact_name false
>
> JACK picks a name, using @client-name as inspiration somehow.
>
JACK picks a name only if there is a name clash, a duplicate, otherwise,
it honours the requested name.
> * @client-name present, @exact_name true
>
> JACK uses @client-name if possible, else error.
>
> Use cases for the three variations that make sense?
JACK is extremely configurable and is used in both general-purpose audio
through to professional audio mastering and distribution in conferences
and stadiums. As such all these use cases are completely valid and need
to be present otherwise it limits the usefulness of this audio dev. The
plumbing of jack is entirely left up to the user and as such there are
countless different possible configurations and use cases.
>
> When letting JACK pick a name, how do users learn the name?
We print it out if jack did this:
if (status & JackNameNotUnique) {
dolog("JACK unique name assigned %s\n",
jack_get_client_name(c->client));
}
The user can also learn the name through various methods such as running
`jack_lsp` or using `qjackctl`, or any number of potential jack
plugboards such as `Carla`, etc.
>
>>>> +#
>>>> +# @connect-ports: if set, a regular expression of port name(s) to
>>>> match to auto
>>>> +# connect to at startup.
>>>
>>> Pardon my ignorance... where do the port names being matched come
>>> from?
>>
>> Other JACK client ports. QEMU become a JACK client which has audio
>> ports and can be patched into the system sound device, or any number
>> of other ports for DSP.
>
> I think a slightly less terse doc comment would be a lot easier to
> understand. At least "s/ of port name(s)/of JACK client port name(s)/.
> Also, "to auto connect to" is quite vague on what gets connected to
> these ports. Can we do a bit better?
>
The wording may need correcting however as jack is so flexible, what it
gets connected to can not be stated. It could be anything depending on
what clients/plugins the user are using already, the jack allows for a
very complex and complete audio system. I have attached a screenshot of
my JACK graph for a simple example of what this looks like.
>>>> +#
>>>> +# @start-server: set to true to start a jack server instance if
>>>> one is not
>>>> +# present.
>
> Default?
False :), I will add this.
>
>>>
>>> Is this an external server program?
>>
>> Yes, the jack library can start the jack server much like PulseAudio
>> auto spawns a process on most systems. People using JACK will be
>> familiar with this already.
>
> Replace "server instance" by "server process"?
I have no issue with this, however, FYI there can be multiple jack
instances running with different server names managing different sound
devices. Please let me know which you would like as I have no opinion in
either instance.
>
>>>> +#
>>>> +# @exact-name: use the exact name requested otherwise JACK
>>>> automatically
>>>> +# generates a unique one, if needed.
>
> Default?
False :), I will add this
>
>>>> +#
>>>> +# Since: 5.1
>>>> +##
>>>> +{ 'struct': 'AudiodevJackPerDirectionOptions',
>>>> + 'base': 'AudiodevPerDirectionOptions',
>>>> + 'data': {
>>>> + '*server-name': 'str',
>>>> + '*client-name': 'str',
>>>> + '*connect-ports': 'str',
>>>> + '*start-server': 'bool',
>>>> + '*exact-name': 'bool' } }
>>>> +
>>>> +##
>>>> +# @AudiodevJackOptions:
>>>> +#
>>>> +# Options of the JACK audio backend.
>>>> +#
>>>> +# @in: options of the capture stream
>>>> +#
>>>> +# @out: options of the playback stream
>>>> +#
>>>> +# Since: 5.1
>>>> +##
>>>> +{ 'struct': 'AudiodevJackOptions',
>>>> + 'data': {
>>>> + '*in': 'AudiodevJackPerDirectionOptions',
>>>> + '*out': 'AudiodevJackPerDirectionOptions' } }
>>>> +
>>>> ##
>>>> # @AudiodevOssPerDirectionOptions:
>>>> #
>>>> @@ -297,11 +346,13 @@
>>>> #
>>>> # An enumeration of possible audio backend drivers.
>>>> #
>>>> +# @jack: JACK audio backend (since 5.1)
>>>> +#
>>>> # Since: 4.0
>>>> ##
>>>> { 'enum': 'AudiodevDriver',
>>>> - 'data': [ 'none', 'alsa', 'coreaudio', 'dsound', 'oss', 'pa',
>>>> 'sdl',
>>>> - 'spice', 'wav' ] }
>>>> + 'data': [ 'none', 'alsa', 'coreaudio', 'dsound', 'jack', 'oss',
>>>> 'pa',
>>>> + 'sdl', 'spice', 'wav' ] }
>>>>
>>>> ##
>>>> # @Audiodev:
>>>> @@ -327,6 +378,7 @@
>>>> 'alsa': 'AudiodevAlsaOptions',
>>>> 'coreaudio': 'AudiodevCoreaudioOptions',
>>>> 'dsound': 'AudiodevDsoundOptions',
>>>> + 'jack': 'AudiodevJackOptions',
>>>> 'oss': 'AudiodevOssOptions',
>>>> 'pa': 'AudiodevPaOptions',
>>>> 'sdl': 'AudiodevGenericOptions',
I sincerely apologize for the excessive delay.
Geoffrey McRae <geoff@hostfission.com> writes:
> On 2020-05-08 16:34, Markus Armbruster wrote:
>> Geoffrey McRae <geoff@hostfission.com> writes:
>>
>>> On 2020-05-06 16:06, Markus Armbruster wrote:
>>>> You neglected to cc: the audio maintainer. Doing that for you now.
>>>> You
>>>> can use scripts/get_maintainer.pl to find maintainers.
>>>
>>> Thanks, I was unaware.
>>
>> Happy to help :)
>>
>>>>
>>>> Find my QAPI schema review inline.
>>>>
>>>
>>> Ditto
>>>
>>>> Geoffrey McRae <geoff@hostfission.com> writes:
>>>>
>>>>> This commit adds a new audiodev backend to allow QEMU to use JACK as
>>>>> both an audio sink and source.
>>>>>
>>>>> Signed-off-by: Geoffrey McRae <geoff@hostfission.com>
>>>>> ---
>>>>> audio/Makefile.objs | 5 +
>>>>> audio/audio.c | 1 +
>>>>> audio/audio_template.h | 2 +
>>>>> audio/jackaudio.c | 677
>>>>> +++++++++++++++++++++++++++++++++++++++++
>>>>> configure | 17 ++
>>>>> qapi/audio.json | 56 +++-
>>>>> 6 files changed, 756 insertions(+), 2 deletions(-)
>>>>> create mode 100644 audio/jackaudio.c
>> [...]
>>>>> diff --git a/qapi/audio.json b/qapi/audio.json
>>>>> index c31251f45b..bdb0552d15 100644
>>>>> --- a/qapi/audio.json
>>>>> +++ b/qapi/audio.json
>>>>> @@ -152,6 +152,55 @@
>>>>> '*out': 'AudiodevPerDirectionOptions',
>>>>> '*latency': 'uint32' } }
>>>>>
>>>>> +##
>>>>> +# @AudiodevJackPerDirectionOptions:
>>>>> +#
>>>>> +# Options of the JACK backend that are used for both playback and
>>>>> +# recording.
>>>>> +#
>>>>> +# @server-name: select from among several possible concurrent
>>>>> server instances.
>>>>> +# If unspecified, use "default" unless $JACK_DEFAULT_SERVER is
>>>>> defined in the
>>>>> +# process environment.
>>>>
>>>> Suggest something like
>>>>
>>>> # (default environment variable $JACK_DEFAULT_SERVER if set, else
>>>> # "default").
>>
>> Uh, needs a colon after "(default" for clarity.
>>
>>>>
>>>
>>> I'd be happy to change this, however, this terminology reflects the
>>> JACK documentation which people already using JACK will be familiar
>>> with.
>>
>> There's a tension between your (sensible) desire to stay close to JACK
>> documentation, and our need for reasonably consistent QMP reference
>> documentation.
>>
>> Where we're talking about genuine JACK stuff, staying close to JACK
>> documentation feels more important.
>>
>> Where we're doing general QMP things, doing them the established QMP
>> way
>> feels more important.
>>
>> Phrasing "this is the optional member's default value" is QMP. We
>> do it
>> all over the place like (default: WHATEVER). Please stick to this
>> conventional QMP format.
>>
>> The WHATEVER is JACK stuff. Feel free to improve on my suggested
>> phrasing there.
>>
>
> Not a problem, I will reword this as requested.
>
>>>>> +#
>>>>> +# @client-name: the client name to use. The server will modify
>>>>> this name to
>>>>> +# create a unique variant, if needed unless @exact_name is true.
>>>>
>>>> Do we really need this much magic?
>>>>
>>>> What would we lose with just @client-name? If it's present, use
>>>> it as
>>>> is (no magic), else make up a client name.
>>>
>>> There is no magic on our part, this is how the JACK server works and
>>> is the default.
>>
>> Aha!
>>
>> Please bear with my ignorant questions...
>>
>> QEMU doesn'r have to expose everything the JACK library and server
>> provide, only the stuff that is useful to QEMU's users.
>>
>> There seem to be several variations:
>>
>> * @client-name absent, @exact_name false
>>
>> JACK picks a name.
>>
>> * @client-name absent, @exact_name true
>>
>> Error? @exact_name silently ignored?
>>
>
> The @client-name is set to the VM's name as the default if absent.
>
>> * @client-name present, @exact_name false
>>
>> JACK picks a name, using @client-name as inspiration somehow.
>>
>
> JACK picks a name only if there is a name clash, a duplicate,
> otherwise, it honours the requested name.
>
>> * @client-name present, @exact_name true
>>
>> JACK uses @client-name if possible, else error.
>>
>> Use cases for the three variations that make sense?
>
> JACK is extremely configurable and is used in both general-purpose
> audio through to professional audio mastering and distribution in
> conferences and stadiums. As such all these use cases are completely
> valid and need to be present otherwise it limits the usefulness of
> this audio dev. The plumbing of jack is entirely left up to the user
> and as such there are countless different possible configurations and
> use cases.
>
>>
>> When letting JACK pick a name, how do users learn the name?
>
> We print it out if jack did this:
>
> if (status & JackNameNotUnique) {
> dolog("JACK unique name assigned %s\n",
> jack_get_client_name(c->client));
> }
Having to extract the name out of a log file is not machine-friendly.
Should we have some query-audio command?
> The user can also learn the name through various methods such as
> running `jack_lsp` or using `qjackctl`, or any number of potential
> jack plugboards such as `Carla`, etc.
How would I identify which of the possibly several names belongs to the
thing I set up via QMP?
>>>>> +#
>>>>> +# @connect-ports: if set, a regular expression of port name(s) to
>>>>> match to auto
>>>>> +# connect to at startup.
>>>>
>>>> Pardon my ignorance... where do the port names being matched come
>>>> from?
>>>
>>> Other JACK client ports. QEMU become a JACK client which has audio
>>> ports and can be patched into the system sound device, or any number
>>> of other ports for DSP.
>>
>> I think a slightly less terse doc comment would be a lot easier to
>> understand. At least "s/ of port name(s)/of JACK client port name(s)/.
>> Also, "to auto connect to" is quite vague on what gets connected to
>> these ports. Can we do a bit better?
>>
>
> The wording may need correcting however as jack is so flexible, what
> it gets connected to can not be stated. It could be anything depending
> on what clients/plugins the user are using already, the jack allows
> for a very complex and complete audio system. I have attached a
> screenshot of my JACK graph for a simple example of what this looks
> like.
Okay, I understand specifying here what JACK does makes no sense. But
let's try to phrase what we can specify as clearly as possible.
[...]
© 2016 - 2024 Red Hat, Inc.