/* Spa jack client * * Copyright © 2019 Wim Taymans * * 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 (including the next * paragraph) 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 #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include "jack-client.h" #define NAME "jack-sink" #define MAX_PORTS 128 #define MAX_BUFFERS 8 #define MAX_SAMPLES 1024 struct buffer { uint32_t id; #define BUFFER_FLAG_OUT (1<<0) uint32_t flags; struct spa_buffer *outbuf; struct spa_list link; }; struct port { uint32_t id; uint64_t info_all; struct spa_port_info info; struct spa_dict_item items[2]; struct spa_dict props; struct spa_param_info params[5]; unsigned int have_format:1; struct spa_audio_info current_format; int stride; struct spa_io_buffers *io; struct buffer buffers[MAX_BUFFERS]; uint32_t n_buffers; jack_port_t *jack_port; }; struct impl { struct spa_handle handle; struct spa_node node; struct spa_log *log; struct spa_loop *data_loop; uint64_t info_all; struct spa_node_info info; struct spa_param_info params[5]; struct spa_hook_list hooks; struct spa_callbacks callbacks; struct spa_io_clock *clock; struct spa_io_position *position; struct port in_ports[MAX_PORTS]; uint32_t n_in_ports; struct spa_audio_info current_format; struct spa_jack_client *client; struct spa_hook client_listener; unsigned int started:1; }; #define CHECK_IN_PORT(this,p) ((p) < this->n_in_ports) #define CHECK_PORT(this,d,p) (d == SPA_DIRECTION_INPUT && CHECK_IN_PORT(this,p)) #define GET_IN_PORT(this,p) (&this->in_ports[p]) #define GET_PORT(this,d,p) GET_IN_PORT(this,p) static int impl_node_enum_params(void *object, int seq, uint32_t id, uint32_t start, uint32_t num, const struct spa_pod *filter) { struct impl *this = object; struct spa_pod *param; struct spa_pod_builder b = { 0 }; uint8_t buffer[1024]; struct spa_result_node_params result; uint32_t count = 0; spa_return_val_if_fail(this != NULL, -EINVAL); spa_return_val_if_fail(num != 0, -EINVAL); result.id = id; result.next = start; next: result.index = result.next++; spa_pod_builder_init(&b, buffer, sizeof(buffer)); switch (id) { case SPA_PARAM_PropInfo: return 0; case SPA_PARAM_Props: return 0; case SPA_PARAM_EnumFormat: case SPA_PARAM_Format: switch (result.index) { case 0: param = spa_format_audio_raw_build(&b, id, &this->current_format.info.raw); break; default: return 0; } break; case SPA_PARAM_IO: switch (result.index) { case 0: param = spa_pod_builder_add_object(&b, SPA_TYPE_OBJECT_ParamIO, id, SPA_PARAM_IO_id, SPA_POD_Id(SPA_IO_Clock), SPA_PARAM_IO_size, SPA_POD_Int(sizeof(struct spa_io_clock))); break; case 1: param = spa_pod_builder_add_object(&b, SPA_TYPE_OBJECT_ParamIO, id, SPA_PARAM_IO_id, SPA_POD_Id(SPA_IO_Position), SPA_PARAM_IO_size, SPA_POD_Int(sizeof(struct spa_io_position))); break; default: return 0; } break; default: return -ENOENT; } if (spa_pod_filter(&b, &result.param, param, filter) < 0) goto next; spa_node_emit_result(&this->hooks, seq, 0, SPA_RESULT_TYPE_NODE_PARAMS, &result); if (++count != num) goto next; return 0; } static int impl_node_set_io(void *object, uint32_t id, void *data, size_t size) { struct impl *this = object; spa_return_val_if_fail(this != NULL, -EINVAL); switch (id) { case SPA_IO_Clock: this->clock = data; break; case SPA_IO_Position: this->position = data; break; default: return -ENOENT; } return 0; } static int impl_node_set_param(void *object, uint32_t id, uint32_t flags, const struct spa_pod *param) { struct impl *this = object; spa_return_val_if_fail(this != NULL, -EINVAL); switch (id) { default: return -ENOENT; } return 0; } static int impl_node_send_command(void *object, const struct spa_command *command) { struct impl *this = object; spa_return_val_if_fail(this != NULL, -EINVAL); spa_return_val_if_fail(command != NULL, -EINVAL); switch (SPA_NODE_COMMAND_ID(command)) { case SPA_NODE_COMMAND_Start: if (this->started) return 0; this->started = true; break; case SPA_NODE_COMMAND_Pause: if (!this->started) return 0; this->started = false; break; default: return -ENOTSUP; } return 0; } static void emit_node_info(struct impl *this, bool full) { if (full) this->info.change_mask = this->info_all; if (this->info.change_mask) { struct spa_dict_item items[5]; char latency[64]; snprintf(latency, sizeof(latency), "%d/%d", this->client->buffer_size, this->client->frame_rate); items[0] = SPA_DICT_ITEM_INIT(SPA_KEY_MEDIA_CLASS, "Audio/Sink"); items[1] = SPA_DICT_ITEM_INIT(SPA_KEY_NODE_NAME, "jack_system"); items[2] = SPA_DICT_ITEM_INIT(SPA_KEY_NODE_DRIVER, "true"); items[3] = SPA_DICT_ITEM_INIT(SPA_KEY_NODE_PAUSE_ON_IDLE, "false"); items[4] = SPA_DICT_ITEM_INIT(SPA_KEY_NODE_LATENCY, latency); this->info.props = &SPA_DICT_INIT_ARRAY(items); spa_node_emit_info(&this->hooks, &this->info); this->info.change_mask = 0; } } static void emit_port_info(struct impl *this, struct port *port, bool full) { if (full) port->info.change_mask = port->info_all; if (port->info.change_mask) { spa_node_emit_port_info(&this->hooks, SPA_DIRECTION_INPUT, port->id, &port->info); port->info.change_mask = 0; } } static int impl_node_add_listener(void *object, struct spa_hook *listener, const struct spa_node_events *events, void *data) { struct impl *this = object; struct spa_hook_list save; uint32_t i; spa_return_val_if_fail(this != NULL, -EINVAL); spa_hook_list_isolate(&this->hooks, &save, listener, events, data); emit_node_info(this, true); for (i = 0; i < this->n_in_ports; i++) emit_port_info(this, GET_IN_PORT(this, i), true); spa_hook_list_join(&this->hooks, &save); return 0; } static int impl_node_set_callbacks(void *object, const struct spa_node_callbacks *callbacks, void *data) { struct impl *this = object; spa_return_val_if_fail(this != NULL, -EINVAL); this->callbacks = SPA_CALLBACKS_INIT(callbacks, data); return 0; } static void client_process(void *data) { struct impl *this = data; if (this->clock) { struct spa_io_clock *c = this->clock; c->nsec = this->client->current_usecs * SPA_NSEC_PER_USEC; c->count = this->client->current_frames; c->rate = SPA_FRACTION(1, this->client->frame_rate); c->position = this->client->current_frames; c->duration = this->client->buffer_size; c->delay = 0; c->rate_diff = 1.0; c->next_nsec = this->client->next_usecs * SPA_NSEC_PER_USEC; } if (this->position) { jack_position_t *jp = &this->client->pos; struct spa_io_position *p = this->position; struct spa_io_segment *s; p->n_segments = 1; s = &p->segments[0]; s->flags = SPA_IO_SEGMENT_VALID_POSITION; s->position = jp->frame; s->rate = 1.0; s->valid = 0; if (jp->valid & JackPositionBBT) { s->valid |= SPA_IO_SEGMENT_VALID_BAR; if (jp->valid & JackBBTFrameOffset) s->bar.offset = jp->bbt_offset; else s->bar.offset = 0; s->bar.signature_num = jp->beats_per_bar; s->bar.signature_denom = jp->beat_type; s->bar.bpm = jp->beats_per_minute; s->bar.beat = jp->bar * jp->beats_per_bar + jp->beat; } } spa_node_call_ready(&this->callbacks, SPA_STATUS_NEED_BUFFER); } static const struct spa_jack_client_events client_events = { SPA_VERSION_JACK_CLIENT_EVENTS, .process = client_process, }; static int init_port(struct impl *this, struct port *port) { port->info_all = SPA_PORT_CHANGE_MASK_FLAGS | SPA_PORT_CHANGE_MASK_PROPS | SPA_PORT_CHANGE_MASK_PARAMS; port->info = SPA_PORT_INFO_INIT(); port->info.flags = SPA_PORT_FLAG_NO_REF; port->items[0] = SPA_DICT_ITEM_INIT(SPA_KEY_FORMAT_DSP, "32 bit float mono audio"); port->props = SPA_DICT_INIT(port->items, 1); port->info.props = &port->props; port->params[0] = SPA_PARAM_INFO(SPA_PARAM_EnumFormat, SPA_PARAM_INFO_READ); port->params[1] = SPA_PARAM_INFO(SPA_PARAM_Meta, SPA_PARAM_INFO_READ); port->params[2] = SPA_PARAM_INFO(SPA_PARAM_IO, SPA_PARAM_INFO_READ); port->params[3] = SPA_PARAM_INFO(SPA_PARAM_Format, SPA_PARAM_INFO_WRITE); port->params[4] = SPA_PARAM_INFO(SPA_PARAM_Buffers, 0); port->info.params = port->params; port->info.n_params = 5; return 0; } static int init_ports(struct impl *this) { const char **ports; uint32_t i; jack_client_t *client = this->client->client; int res; ports = jack_get_ports(client, NULL, JACK_DEFAULT_AUDIO_TYPE, JackPortIsPhysical|JackPortIsInput); if (ports == NULL) { spa_log_error(this->log, NAME" %p: can't enumerate ports", this); res = -ENODEV; goto exit; } for (i = 0; ports[i]; i++) { struct port *port = GET_IN_PORT(this, i); port->id = i; init_port(this, port); port->jack_port = jack_port_register(client, ports[i], JACK_DEFAULT_AUDIO_TYPE, JackPortIsOutput|JackPortIsTerminal, 0); if (port->jack_port == NULL) { spa_log_error(this->log, NAME" %p: jack_port_register() failed", this); res = -EFAULT; goto exit_free; } } this->n_in_ports = i; this->current_format.info.raw = SPA_AUDIO_INFO_RAW_INIT( .format = SPA_AUDIO_FORMAT_F32P, .flags = SPA_AUDIO_FLAG_UNPOSITIONED, .rate = jack_get_sample_rate(client), .channels = this->n_in_ports); spa_jack_client_add_listener(this->client, &this->client_listener, &client_events, this); jack_activate(client); for (i = 0; ports[i]; i++) { struct port *port = GET_IN_PORT(this, i); if (jack_connect(client, jack_port_name(port->jack_port), ports[i])) { spa_log_warn(this->log, NAME" %p: Failed to connect %s to %s", this, jack_port_name(port->jack_port), ports[i]); } } res = 0; exit_free: jack_free(ports); exit: return res; } static int impl_node_add_port(void *object, enum spa_direction direction, uint32_t port_id, const struct spa_dict *props) { return -ENOTSUP; } static int impl_node_remove_port(void *object, enum spa_direction direction, uint32_t port_id) { return -ENOTSUP; } static int port_enum_formats(void *object, enum spa_direction direction, uint32_t port_id, uint32_t index, const struct spa_pod *filter, struct spa_pod **param, struct spa_pod_builder *builder) { switch (index) { case 0: *param = spa_pod_builder_add_object(builder, SPA_TYPE_OBJECT_Format, SPA_PARAM_EnumFormat, SPA_FORMAT_mediaType, SPA_POD_Id(SPA_MEDIA_TYPE_audio), SPA_FORMAT_mediaSubtype, SPA_POD_Id(SPA_MEDIA_SUBTYPE_raw), SPA_FORMAT_AUDIO_format, SPA_POD_Id(SPA_AUDIO_FORMAT_F32P), SPA_FORMAT_AUDIO_channels, SPA_POD_Int(1)); break; default: return 0; } return 1; } static int impl_node_port_enum_params(void *object, int seq, enum spa_direction direction, uint32_t port_id, uint32_t id, uint32_t start, uint32_t num, const struct spa_pod *filter) { struct impl *this = object; struct port *port; struct spa_pod_builder b = { 0 }; uint8_t buffer[1024]; struct spa_pod *param; struct spa_result_node_params result; uint32_t count = 0; int res; spa_return_val_if_fail(this != NULL, -EINVAL); spa_return_val_if_fail(num != 0, -EINVAL); spa_return_val_if_fail(CHECK_PORT(this, direction, port_id), -EINVAL); port = GET_PORT(this, direction, port_id); result.id = id; result.next = start; next: result.index = result.next++; spa_pod_builder_init(&b, buffer, sizeof(buffer)); switch (id) { case SPA_PARAM_EnumFormat: if ((res = port_enum_formats(this, direction, port_id, result.index, filter, ¶m, &b)) <= 0) return res; break; case SPA_PARAM_Format: if (!port->have_format) return -EIO; if (result.index > 0) return 0; param = spa_format_audio_raw_build(&b, id, &port->current_format.info.raw); break; case SPA_PARAM_Buffers: { if (!port->have_format) return -EIO; if (result.index > 0) return 0; param = spa_pod_builder_add_object(&b, SPA_TYPE_OBJECT_ParamBuffers, id, SPA_PARAM_BUFFERS_buffers, SPA_POD_CHOICE_RANGE_Int(2, 1, MAX_BUFFERS), SPA_PARAM_BUFFERS_blocks, SPA_POD_Int(1), SPA_PARAM_BUFFERS_size, SPA_POD_CHOICE_RANGE_Int( 1024 * port->stride, 16 * port->stride, MAX_SAMPLES * port->stride), SPA_PARAM_BUFFERS_stride, SPA_POD_Int(port->stride), SPA_PARAM_BUFFERS_align, SPA_POD_Int(16)); break; } case SPA_PARAM_IO: switch (result.index) { case 0: param = spa_pod_builder_add_object(&b, SPA_TYPE_OBJECT_ParamIO, id, SPA_PARAM_IO_id, SPA_POD_Id(SPA_IO_Buffers), SPA_PARAM_IO_size, SPA_POD_Int(sizeof(struct spa_io_buffers))); break; default: return 0; } break; default: return -ENOENT; } if (spa_pod_filter(&b, &result.param, param, filter) < 0) goto next; spa_node_emit_result(&this->hooks, seq, 0, SPA_RESULT_TYPE_NODE_PARAMS, &result); if (++count != num) goto next; return 0; } static int clear_buffers(struct impl *this, struct port *port) { if (port->n_buffers > 0) { spa_log_info(this->log, NAME " %p: clear buffers", this); port->n_buffers = 0; this->started = false; } return 0; } static int port_set_format(struct impl *this, struct port *port, uint32_t flags, const struct spa_pod *format) { int res; if (format == NULL) { port->have_format = false; clear_buffers(this, port); } else { struct spa_audio_info info = { 0 }; if ((res = spa_format_parse(format, &info.media_type, &info.media_subtype)) < 0) return res; if (info.media_type != SPA_MEDIA_TYPE_audio && info.media_subtype != SPA_MEDIA_SUBTYPE_raw) return -EINVAL; if (spa_format_audio_raw_parse(format, &info.info.raw) < 0) return -EINVAL; if (info.info.raw.format == SPA_AUDIO_FORMAT_F32P) port->stride = 4; else return -EINVAL; port->current_format = info; port->have_format = true; } port->info.change_mask |= SPA_PORT_CHANGE_MASK_PARAMS; if (port->have_format) { port->params[3] = SPA_PARAM_INFO(SPA_PARAM_Format, SPA_PARAM_INFO_READWRITE); port->params[4] = SPA_PARAM_INFO(SPA_PARAM_Buffers, SPA_PARAM_INFO_READ); } else { port->params[3] = SPA_PARAM_INFO(SPA_PARAM_Format, SPA_PARAM_INFO_WRITE); port->params[4] = SPA_PARAM_INFO(SPA_PARAM_Buffers, 0); } emit_port_info(this, port, false); return 0; } static int impl_node_port_set_param(void *object, enum spa_direction direction, uint32_t port_id, uint32_t id, uint32_t flags, const struct spa_pod *param) { struct impl *this = object; struct port *port; int res; spa_return_val_if_fail(this != NULL, -EINVAL); spa_return_val_if_fail(CHECK_PORT(this, direction, port_id), -EINVAL); port = GET_PORT(this, direction, port_id); switch (id) { case SPA_PARAM_Format: res = port_set_format(this, port, flags, param); break; default: return -ENOENT; } return res; } static int impl_node_port_use_buffers(void *object, enum spa_direction direction, uint32_t port_id, uint32_t flags, struct spa_buffer **buffers, uint32_t n_buffers) { struct impl *this = object; struct port *port; uint32_t i; spa_return_val_if_fail(this != NULL, -EINVAL); spa_return_val_if_fail(CHECK_PORT(this, direction, port_id), -EINVAL); port = GET_PORT(this, direction, port_id); if (!port->have_format) return -EIO; clear_buffers(this, port); for (i = 0; i < n_buffers; i++) { struct buffer *b; b = &port->buffers[i]; b->id = i; b->outbuf = buffers[i]; b->flags = 0; } port->n_buffers = n_buffers; return 0; } static int impl_node_port_set_io(void *object, enum spa_direction direction, uint32_t port_id, uint32_t id, void *data, size_t size) { struct impl *this = object; struct port *port; spa_return_val_if_fail(this != NULL, -EINVAL); spa_return_val_if_fail(CHECK_PORT(this, direction, port_id), -EINVAL); port = GET_PORT(this, direction, port_id); switch (id) { case SPA_IO_Buffers: port->io = data; break; default: return -ENOENT; } return 0; } static int impl_node_port_reuse_buffer(void *object, uint32_t port_id, uint32_t buffer_id) { return -ENOTSUP; } static int impl_node_process(void *object) { struct impl *this = object; uint32_t i; int res = 0; spa_log_trace(this->log, NAME" %p: process %d", this, this->n_in_ports); for (i = 0; i < this->n_in_ports; i++) { struct port *port = GET_IN_PORT(this, i); struct spa_io_buffers *io = port->io; struct buffer *b; struct spa_data *src; uint32_t n_frames = this->client->buffer_size; void *dst; dst = jack_port_get_buffer(port->jack_port, n_frames); if (io == NULL || io->status != SPA_STATUS_HAVE_BUFFER || io->buffer_id >= port->n_buffers) { memset(dst, 0, n_frames * sizeof(float)); continue; } spa_log_trace(this->log, NAME" %p: port %d: buffer %d", this, i, io->buffer_id); b = &port->buffers[io->buffer_id]; src = &b->outbuf->datas[0]; memcpy(dst, src->data, n_frames * port->stride); io->status = SPA_STATUS_NEED_BUFFER; res |= SPA_STATUS_NEED_BUFFER; } return res; } static const struct spa_node_methods impl_node = { SPA_VERSION_NODE_METHODS, .add_listener = impl_node_add_listener, .set_callbacks = impl_node_set_callbacks, .enum_params = impl_node_enum_params, .set_param = impl_node_set_param, .set_io = impl_node_set_io, .send_command = impl_node_send_command, .add_port = impl_node_add_port, .remove_port = impl_node_remove_port, .port_enum_params = impl_node_port_enum_params, .port_set_param = impl_node_port_set_param, .port_use_buffers = impl_node_port_use_buffers, .port_set_io = impl_node_port_set_io, .port_reuse_buffer = impl_node_port_reuse_buffer, .process = impl_node_process, }; static int impl_get_interface(struct spa_handle *handle, uint32_t type, void **interface) { struct impl *this; spa_return_val_if_fail(handle != NULL, -EINVAL); spa_return_val_if_fail(interface != NULL, -EINVAL); this = (struct impl *) handle; if (type == SPA_TYPE_INTERFACE_Node) *interface = &this->node; else return -ENOENT; return 0; } static int impl_clear(struct spa_handle *handle) { return 0; } static size_t impl_get_size(const struct spa_handle_factory *factory, const struct spa_dict *params) { return sizeof(struct impl); } static int impl_init(const struct spa_handle_factory *factory, struct spa_handle *handle, const struct spa_dict *info, const struct spa_support *support, uint32_t n_support) { struct impl *this; uint32_t i; spa_return_val_if_fail(factory != NULL, -EINVAL); spa_return_val_if_fail(handle != NULL, -EINVAL); handle->get_interface = impl_get_interface; handle->clear = impl_clear; this = (struct impl *) handle; for (i = 0; i < n_support; i++) { if (support[i].type == SPA_TYPE_INTERFACE_Log) this->log = support[i].data; } for (i = 0; info && i < info->n_items; i++) { if (strcmp(info->items[i].key, SPA_KEY_API_JACK_CLIENT) == 0) sscanf(info->items[i].value, "pointer:%p", &this->client); } if (this->client == NULL) { spa_log_error(this->log, NAME" %p: missing "SPA_KEY_API_JACK_CLIENT " property", this); return -EINVAL; } spa_hook_list_init(&this->hooks); this->node.iface = SPA_INTERFACE_INIT( SPA_TYPE_INTERFACE_Node, SPA_VERSION_NODE, &impl_node, this); this->info_all = SPA_NODE_CHANGE_MASK_FLAGS | SPA_NODE_CHANGE_MASK_PROPS | SPA_NODE_CHANGE_MASK_PARAMS; this->info = SPA_NODE_INFO_INIT(); this->info.max_output_ports = MAX_PORTS; this->info.flags = SPA_NODE_FLAG_RT; this->params[0] = SPA_PARAM_INFO(SPA_PARAM_PropInfo, SPA_PARAM_INFO_READ); this->params[1] = SPA_PARAM_INFO(SPA_PARAM_Props, SPA_PARAM_INFO_READWRITE); this->params[2] = SPA_PARAM_INFO(SPA_PARAM_Format, SPA_PARAM_INFO_READ); this->params[3] = SPA_PARAM_INFO(SPA_PARAM_EnumFormat, SPA_PARAM_INFO_READ); this->params[4] = SPA_PARAM_INFO(SPA_PARAM_IO, SPA_PARAM_INFO_READ); this->info.params = this->params; this->info.n_params = 5; init_ports(this); spa_log_info(this->log, NAME " %p: initialized", this); return 0; } static const struct spa_interface_info impl_interfaces[] = { {SPA_TYPE_INTERFACE_Node,}, }; static int impl_enum_interface_info(const struct spa_handle_factory *factory, const struct spa_interface_info **info, uint32_t *index) { spa_return_val_if_fail(factory != NULL, -EINVAL); spa_return_val_if_fail(info != NULL, -EINVAL); spa_return_val_if_fail(index != NULL, -EINVAL); switch (*index) { case 0: *info = &impl_interfaces[*index]; break; default: return 0; } (*index)++; return 1; } static const struct spa_dict_item info_items[] = { { SPA_KEY_FACTORY_AUTHOR, "Wim Taymans " }, { SPA_KEY_FACTORY_DESCRIPTION, "Play audio with the JACK API" }, }; static const struct spa_dict info = SPA_DICT_INIT_ARRAY(info_items); const struct spa_handle_factory spa_jack_sink_factory = { SPA_VERSION_HANDLE_FACTORY, SPA_NAME_API_JACK_SINK, &info, impl_get_size, impl_init, impl_enum_interface_info, };