/* Spa * Copyright (C) 2016 Wim Taymans * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Library General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Library General Public License for more details. * * You should have received a copy of the GNU Library General Public * License along with this library; if not, write to the * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, * Boston, MA 02110-1301, USA. */ #include #include #include #include #include #include #include #include #include #include #include #include #include #define NAME "volume" #define DEFAULT_VOLUME 1.0 #define DEFAULT_MUTE false struct props { double volume; bool mute; }; static void reset_props(struct props *props) { props->volume = DEFAULT_VOLUME; props->mute = DEFAULT_MUTE; } #define MAX_BUFFERS 16 struct buffer { struct spa_buffer *outbuf; bool outstanding; struct spa_meta_header *h; void *ptr; size_t size; struct spa_list link; }; struct port { bool have_format; struct spa_port_info info; struct buffer buffers[MAX_BUFFERS]; uint32_t n_buffers; struct spa_io_buffers *io; struct spa_io_control_range *range; struct spa_list empty; }; struct type { uint32_t node; uint32_t format; uint32_t props; uint32_t prop_volume; uint32_t prop_mute; struct spa_type_io io; struct spa_type_param param; struct spa_type_meta meta; struct spa_type_data data; struct spa_type_media_type media_type; struct spa_type_media_subtype media_subtype; struct spa_type_format_audio format_audio; struct spa_type_audio_format audio_format; struct spa_type_event_node event_node; struct spa_type_command_node command_node; struct spa_type_param_buffers param_buffers; struct spa_type_param_meta param_meta; struct spa_type_param_io param_io; }; static inline void init_type(struct type *type, struct spa_type_map *map) { type->node = spa_type_map_get_id(map, SPA_TYPE__Node); type->format = spa_type_map_get_id(map, SPA_TYPE__Format); type->props = spa_type_map_get_id(map, SPA_TYPE__Props); type->prop_volume = spa_type_map_get_id(map, SPA_TYPE_PROPS__volume); type->prop_mute = spa_type_map_get_id(map, SPA_TYPE_PROPS__mute); spa_type_io_map(map, &type->io); spa_type_param_map(map, &type->param); spa_type_meta_map(map, &type->meta); spa_type_data_map(map, &type->data); spa_type_media_type_map(map, &type->media_type); spa_type_media_subtype_map(map, &type->media_subtype); spa_type_format_audio_map(map, &type->format_audio); spa_type_audio_format_map(map, &type->audio_format); spa_type_event_node_map(map, &type->event_node); spa_type_command_node_map(map, &type->command_node); spa_type_param_buffers_map(map, &type->param_buffers); spa_type_param_meta_map(map, &type->param_meta); spa_type_param_io_map(map, &type->param_io); } struct impl { struct spa_handle handle; struct spa_node node; struct type type; struct spa_type_map *map; struct spa_log *log; struct props props; const struct spa_node_callbacks *callbacks; void *callbacks_data; struct spa_audio_info current_format; int bpf; struct port in_ports[1]; struct port out_ports[1]; bool started; }; #define CHECK_IN_PORT(this,d,p) ((d) == SPA_DIRECTION_INPUT && (p) == 0) #define CHECK_OUT_PORT(this,d,p) ((d) == SPA_DIRECTION_OUTPUT && (p) == 0) #define CHECK_PORT(this,d,p) ((p) == 0) #define GET_IN_PORT(this,p) (&this->in_ports[p]) #define GET_OUT_PORT(this,p) (&this->out_ports[p]) #define GET_PORT(this,d,p) (d == SPA_DIRECTION_INPUT ? GET_IN_PORT(this,p) : GET_OUT_PORT(this,p)) static int impl_node_enum_params(struct spa_node *node, uint32_t id, uint32_t *index, const struct spa_pod *filter, struct spa_pod **result, struct spa_pod_builder *builder) { struct impl *this; struct type *t; struct spa_pod_builder b = { 0 }; uint8_t buffer[1024]; struct spa_pod *param; struct props *p; spa_return_val_if_fail(node != NULL, -EINVAL); spa_return_val_if_fail(index != NULL, -EINVAL); spa_return_val_if_fail(builder != NULL, -EINVAL); this = SPA_CONTAINER_OF(node, struct impl, node); t = &this->type; p = &this->props; next: spa_pod_builder_init(&b, buffer, sizeof(buffer)); if (id == t->param.idList) { uint32_t list[] = { t->param.idPropInfo, t->param.idProps }; if (*index < SPA_N_ELEMENTS(list)) param = spa_pod_builder_object(&b, id, t->param.List, ":", t->param.listId, "I", list[*index]); else return 0; } else if (id == t->param.idPropInfo) { switch (*index) { case 0: param = spa_pod_builder_object(&b, id, t->param.PropInfo, ":", t->param.propId, "I", t->prop_volume, ":", t->param.propName, "s", "The volume", ":", t->param.propType, "dr", p->volume, SPA_POD_PROP_MIN_MAX(0.0, 10.0)); break; case 1: param = spa_pod_builder_object(&b, id, t->param.PropInfo, ":", t->param.propId, "I", t->prop_mute, ":", t->param.propName, "s", "Mute", ":", t->param.propType, "b", p->mute); break; default: return 0; } } else if (id == t->param.idProps) { switch (*index) { case 0: param = spa_pod_builder_object(&b, id, t->props, ":", t->prop_volume, "d", p->volume, ":", t->prop_mute, "b", p->mute); break; default: return 0; } } else return -ENOENT; (*index)++; if (spa_pod_filter(builder, result, param, filter) < 0) goto next; return 1; } static int impl_node_set_param(struct spa_node *node, uint32_t id, uint32_t flags, const struct spa_pod *param) { struct impl *this; struct type *t; spa_return_val_if_fail(node != NULL, -EINVAL); this = SPA_CONTAINER_OF(node, struct impl, node); t = &this->type; if (id == t->param.idProps) { struct props *p = &this->props; if (param == NULL) { reset_props(p); return 0; } spa_pod_object_parse(param, ":", t->prop_volume, "?d", &p->volume, ":", t->prop_mute, "?b", &p->mute, NULL); } else return -ENOENT; return 0; } static int impl_node_send_command(struct spa_node *node, const struct spa_command *command) { struct impl *this; spa_return_val_if_fail(node != NULL, -EINVAL); spa_return_val_if_fail(command != NULL, -EINVAL); this = SPA_CONTAINER_OF(node, struct impl, node); if (SPA_COMMAND_TYPE(command) == this->type.command_node.Start) { this->started = true; } else if (SPA_COMMAND_TYPE(command) == this->type.command_node.Pause) { this->started = false; } else return -ENOTSUP; return 0; } static int impl_node_set_callbacks(struct spa_node *node, const struct spa_node_callbacks *callbacks, void *data) { struct impl *this; spa_return_val_if_fail(node != NULL, -EINVAL); this = SPA_CONTAINER_OF(node, struct impl, node); this->callbacks = callbacks; this->callbacks_data = data; return 0; } static int impl_node_get_n_ports(struct spa_node *node, uint32_t *n_input_ports, uint32_t *max_input_ports, uint32_t *n_output_ports, uint32_t *max_output_ports) { spa_return_val_if_fail(node != NULL, -EINVAL); if (n_input_ports) *n_input_ports = 1; if (max_input_ports) *max_input_ports = 1; if (n_output_ports) *n_output_ports = 1; if (max_output_ports) *max_output_ports = 1; return 0; } static int impl_node_get_port_ids(struct spa_node *node, uint32_t *input_ids, uint32_t n_input_ids, uint32_t *output_ids, uint32_t n_output_ids) { spa_return_val_if_fail(node != NULL, -EINVAL); if (n_input_ids > 0 && input_ids) input_ids[0] = 0; if (n_output_ids > 0 && output_ids) output_ids[0] = 0; return 0; } static int impl_node_add_port(struct spa_node *node, enum spa_direction direction, uint32_t port_id) { return -ENOTSUP; } static int impl_node_remove_port(struct spa_node *node, enum spa_direction direction, uint32_t port_id) { return -ENOTSUP; } static int impl_node_port_get_info(struct spa_node *node, enum spa_direction direction, uint32_t port_id, const struct spa_port_info **info) { struct impl *this; struct port *port; spa_return_val_if_fail(node != NULL, -EINVAL); spa_return_val_if_fail(info != NULL, -EINVAL); this = SPA_CONTAINER_OF(node, struct impl, node); spa_return_val_if_fail(CHECK_PORT(this, direction, port_id), -EINVAL); port = GET_PORT(this, direction, port_id); *info = &port->info; return 0; } static int port_enum_formats(struct spa_node *node, 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) { struct impl *this = SPA_CONTAINER_OF(node, struct impl, node); struct type *t = &this->type; switch (*index) { case 0: *param = spa_pod_builder_object(builder, t->param.idEnumFormat, t->format, "I", t->media_type.audio, "I", t->media_subtype.raw, ":", t->format_audio.format, "Ieu", t->audio_format.S16, SPA_POD_PROP_ENUM(2, t->audio_format.S16, t->audio_format.S32), ":", t->format_audio.rate, "iru", 44100, SPA_POD_PROP_MIN_MAX(1, INT32_MAX), ":", t->format_audio.channels,"iru", 2, SPA_POD_PROP_MIN_MAX(1, INT32_MAX)); break; default: return 0; } return 1; } static int port_get_format(struct spa_node *node, 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) { struct impl *this = SPA_CONTAINER_OF(node, struct impl, node); struct port *port; struct type *t = &this->type; port = GET_PORT(this, direction, port_id); if (!port->have_format) return -EIO; if (*index > 0) return 0; *param = spa_pod_builder_object(builder, t->param.idFormat, t->format, "I", t->media_type.audio, "I", t->media_subtype.raw, ":", t->format_audio.format, "I", this->current_format.info.raw.format, ":", t->format_audio.rate, "i", this->current_format.info.raw.rate, ":", t->format_audio.channels, "i", this->current_format.info.raw.channels); return 1; } static int impl_node_port_enum_params(struct spa_node *node, enum spa_direction direction, uint32_t port_id, uint32_t id, uint32_t *index, const struct spa_pod *filter, struct spa_pod **result, struct spa_pod_builder *builder) { struct impl *this; struct type *t; struct port *port; struct spa_pod_builder b = { 0 }; uint8_t buffer[1024]; struct spa_pod *param; int res; spa_return_val_if_fail(node != NULL, -EINVAL); spa_return_val_if_fail(index != NULL, -EINVAL); spa_return_val_if_fail(builder != NULL, -EINVAL); this = SPA_CONTAINER_OF(node, struct impl, node); t = &this->type; spa_return_val_if_fail(CHECK_PORT(this, direction, port_id), -EINVAL); port = GET_PORT(this, direction, port_id); next: spa_pod_builder_init(&b, buffer, sizeof(buffer)); if (id == t->param.idList) { uint32_t list[] = { t->param.idEnumFormat, t->param.idFormat, t->param.idBuffers, t->param.idMeta, t->param_io.idBuffers, t->param_io.idControl }; if (*index < SPA_N_ELEMENTS(list)) param = spa_pod_builder_object(&b, id, t->param.List, ":", t->param.listId, "I", list[*index]); else return 0; } else if (id == t->param.idEnumFormat) { if ((res = port_enum_formats(node, direction, port_id, index, filter, ¶m, &b)) <= 0) return res; } else if (id == t->param.idFormat) { if ((res = port_get_format(node, direction, port_id, index, filter, ¶m, &b)) <= 0) return res; } else if (id == t->param.idBuffers) { if (!port->have_format) return -EIO; if (*index > 0) return 0; param = spa_pod_builder_object(&b, id, t->param_buffers.Buffers, ":", t->param_buffers.size, "iru", 1024 * this->bpf, SPA_POD_PROP_MIN_MAX(16 * this->bpf, INT32_MAX / this->bpf), ":", t->param_buffers.stride, "i", 0, ":", t->param_buffers.buffers, "iru", 2, SPA_POD_PROP_MIN_MAX(1, MAX_BUFFERS), ":", t->param_buffers.align, "i", 16); } else if (id == t->param.idMeta) { switch (*index) { case 0: param = spa_pod_builder_object(&b, id, t->param_meta.Meta, ":", t->param_meta.type, "I", t->meta.Header, ":", t->param_meta.size, "i", sizeof(struct spa_meta_header)); break; default: return 0; } } else if (id == t->param_io.idBuffers) { switch (*index) { case 0: param = spa_pod_builder_object(&b, id, t->param_io.Buffers, ":", t->param_io.id, "I", t->io.Buffers, ":", t->param_io.size, "i", sizeof(struct spa_io_buffers)); break; default: return 0; } } else if (id == t->param_io.idControl) { switch (*index) { case 0: param = spa_pod_builder_object(&b, id, t->param_io.Control, ":", t->param_io.id, "I", t->io.ControlRange, ":", t->param_io.size, "i", sizeof(struct spa_io_control_range)); break; default: return 0; } } else return -ENOENT; (*index)++; if (spa_pod_filter(builder, result, param, filter) < 0) goto next; return 1; } 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; spa_list_init(&port->empty); } return 0; } static int port_set_format(struct spa_node *node, enum spa_direction direction, uint32_t port_id, uint32_t flags, const struct spa_pod *format) { struct impl *this = SPA_CONTAINER_OF(node, struct impl, node); struct port *port; port = GET_PORT(this, direction, port_id); if (format == NULL) { port->have_format = false; clear_buffers(this, port); } else { struct spa_audio_info info = { 0 }; spa_pod_object_parse(format, "I", &info.media_type, "I", &info.media_subtype); if (info.media_type != this->type.media_type.audio || info.media_subtype != this->type.media_subtype.raw) return -EINVAL; if (spa_format_audio_raw_parse(format, &info.info.raw, &this->type.format_audio) < 0) return -EINVAL; this->bpf = 2 * info.info.raw.channels; this->current_format = info; port->have_format = true; } return 0; } static int impl_node_port_set_param(struct spa_node *node, enum spa_direction direction, uint32_t port_id, uint32_t id, uint32_t flags, const struct spa_pod *param) { struct impl *this; struct type *t; spa_return_val_if_fail(node != NULL, -EINVAL); this = SPA_CONTAINER_OF(node, struct impl, node); t = &this->type; spa_return_val_if_fail(CHECK_PORT(this, direction, port_id), -EINVAL); if (id == t->param.idFormat) { return port_set_format(node, direction, port_id, flags, param); } else return -ENOENT; } static int impl_node_port_use_buffers(struct spa_node *node, enum spa_direction direction, uint32_t port_id, struct spa_buffer **buffers, uint32_t n_buffers) { struct impl *this; struct port *port; uint32_t i; struct type *t; spa_return_val_if_fail(node != NULL, -EINVAL); this = SPA_CONTAINER_OF(node, struct impl, node); 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; t = &this->type; clear_buffers(this, port); for (i = 0; i < n_buffers; i++) { struct buffer *b; struct spa_data *d = buffers[i]->datas; b = &port->buffers[i]; b->outbuf = buffers[i]; b->outstanding = direction == SPA_DIRECTION_INPUT; b->h = spa_buffer_find_meta_data(buffers[i], t->meta.Header, sizeof(*b->h)); if ((d[0].type == t->data.MemPtr || d[0].type == t->data.MemFd || d[0].type == t->data.DmaBuf) && d[0].data != NULL) { b->ptr = d[0].data; b->size = d[0].maxsize; } else { spa_log_error(this->log, NAME " %p: invalid memory on buffer %p", this, buffers[i]); return -EINVAL; } if (!b->outstanding) spa_list_append(&port->empty, &b->link); } port->n_buffers = n_buffers; return 0; } static int impl_node_port_alloc_buffers(struct spa_node *node, enum spa_direction direction, uint32_t port_id, struct spa_pod **params, uint32_t n_params, struct spa_buffer **buffers, uint32_t *n_buffers) { return -ENOTSUP; } static int impl_node_port_set_io(struct spa_node *node, enum spa_direction direction, uint32_t port_id, uint32_t id, void *data, size_t size) { struct impl *this; struct port *port; struct type *t; spa_return_val_if_fail(node != NULL, -EINVAL); this = SPA_CONTAINER_OF(node, struct impl, node); t = &this->type; spa_return_val_if_fail(CHECK_PORT(this, direction, port_id), -EINVAL); port = GET_PORT(this, direction, port_id); if (id == t->io.Buffers) port->io = data; else if (id == t->io.ControlRange) port->range = data; else return -ENOENT; return 0; } static void recycle_buffer(struct impl *this, uint32_t id) { struct port *port = GET_OUT_PORT(this, 0); struct buffer *b = &port->buffers[id]; if (!b->outstanding) { spa_log_warn(this->log, NAME " %p: buffer %d not outstanding", this, id); return; } spa_list_append(&port->empty, &b->link); b->outstanding = false; spa_log_trace(this->log, NAME " %p: recycle buffer %d", this, id); } static int impl_node_port_reuse_buffer(struct spa_node *node, uint32_t port_id, uint32_t buffer_id) { struct impl *this; struct port *port; spa_return_val_if_fail(node != NULL, -EINVAL); this = SPA_CONTAINER_OF(node, struct impl, node); spa_return_val_if_fail(CHECK_PORT(this, SPA_DIRECTION_OUTPUT, port_id), -EINVAL); port = GET_OUT_PORT(this, port_id); if (buffer_id >= port->n_buffers) return -EINVAL; recycle_buffer(this, buffer_id); return 0; } static int impl_node_port_send_command(struct spa_node *node, enum spa_direction direction, uint32_t port_id, const struct spa_command *command) { return -ENOTSUP; } static struct spa_buffer *find_free_buffer(struct impl *this, struct port *port) { struct buffer *b; if (spa_list_is_empty(&port->empty)) return NULL; b = spa_list_first(&port->empty, struct buffer, link); spa_list_remove(&b->link); b->outstanding = true; return b->outbuf; } static void do_volume(struct impl *this, struct spa_buffer *dbuf, struct spa_buffer *sbuf) { uint32_t i, n_samples, n_bytes; struct spa_data *sd, *dd; int16_t *src, *dst; double volume; uint32_t written, towrite, savail, davail; uint32_t sindex, dindex; volume = this->props.volume; sd = sbuf->datas; dd = dbuf->datas; savail = SPA_MIN(sd[0].chunk->size, sd[0].maxsize); sindex = sd[0].chunk->offset; davail = 0; dindex = 0; davail = dd[0].maxsize - davail; towrite = SPA_MIN(savail, davail); written = 0; while (written < towrite) { uint32_t soffset = sindex % sd[0].maxsize; uint32_t doffset = dindex % dd[0].maxsize; src = SPA_MEMBER(sd[0].data, soffset, int16_t); dst = SPA_MEMBER(dd[0].data, doffset, int16_t); n_bytes = SPA_MIN(towrite, sd[0].maxsize - soffset); n_bytes = SPA_MIN(n_bytes, dd[0].maxsize - doffset); n_samples = n_bytes / sizeof(int16_t); for (i = 0; i < n_samples; i++) dst[i] = src[i] * volume; sindex += n_bytes; dindex += n_bytes; written += n_bytes; } dd[0].chunk->offset = 0; dd[0].chunk->size = written; dd[0].chunk->stride = 0; } static int impl_node_process(struct spa_node *node) { struct impl *this; struct port *in_port, *out_port; struct spa_io_buffers *input, *output; struct spa_buffer *dbuf, *sbuf; spa_return_val_if_fail(node != NULL, -EINVAL); this = SPA_CONTAINER_OF(node, struct impl, node); out_port = GET_OUT_PORT(this, 0); output = out_port->io; spa_return_val_if_fail(output != NULL, -EIO); if (output->status == SPA_STATUS_HAVE_BUFFER) return SPA_STATUS_HAVE_BUFFER; /* recycle */ if (output->buffer_id < out_port->n_buffers) { recycle_buffer(this, output->buffer_id); output->buffer_id = SPA_ID_INVALID; } in_port = GET_IN_PORT(this, 0); input = in_port->io; spa_return_val_if_fail(input != NULL, -EIO); if (input->status != SPA_STATUS_HAVE_BUFFER) return SPA_STATUS_NEED_BUFFER; if (input->buffer_id >= in_port->n_buffers) { input->status = -EINVAL; return -EINVAL; } if ((dbuf = find_free_buffer(this, out_port)) == NULL) { spa_log_error(this->log, NAME " %p: out of buffers", this); return -EPIPE; } sbuf = in_port->buffers[input->buffer_id].outbuf; spa_log_trace(this->log, NAME " %p: do volume %d -> %d", this, sbuf->id, dbuf->id); do_volume(this, dbuf, sbuf); output->buffer_id = dbuf->id; output->status = SPA_STATUS_HAVE_BUFFER; if (in_port->range && out_port->range) *in_port->range = *out_port->range; input->status = SPA_STATUS_NEED_BUFFER; return SPA_STATUS_HAVE_BUFFER; } static const struct spa_node impl_node = { SPA_VERSION_NODE, NULL, impl_node_enum_params, impl_node_set_param, impl_node_send_command, impl_node_set_callbacks, impl_node_get_n_ports, impl_node_get_port_ids, impl_node_add_port, impl_node_remove_port, impl_node_port_get_info, impl_node_port_enum_params, impl_node_port_set_param, impl_node_port_use_buffers, impl_node_port_alloc_buffers, impl_node_port_set_io, impl_node_port_reuse_buffer, impl_node_port_send_command, impl_node_process, }; static int impl_get_interface(struct spa_handle *handle, uint32_t interface_id, 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 (interface_id == this->type.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 (strcmp(support[i].type, SPA_TYPE__TypeMap) == 0) this->map = support[i].data; else if (strcmp(support[i].type, SPA_TYPE__Log) == 0) this->log = support[i].data; } if (this->map == NULL) { spa_log_error(this->log, "a type-map is needed"); return -EINVAL; } init_type(&this->type, this->map); this->node = impl_node; reset_props(&this->props); this->in_ports[0].info.flags = SPA_PORT_INFO_FLAG_CAN_USE_BUFFERS | SPA_PORT_INFO_FLAG_IN_PLACE; spa_list_init(&this->in_ports[0].empty); this->out_ports[0].info.flags = SPA_PORT_INFO_FLAG_CAN_USE_BUFFERS | SPA_PORT_INFO_FLAG_NO_REF; spa_list_init(&this->out_ports[0].empty); return 0; } static const struct spa_interface_info impl_interfaces[] = { {SPA_TYPE__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; } const struct spa_handle_factory spa_volume_factory = { SPA_VERSION_HANDLE_FACTORY, NAME, NULL, impl_get_size, impl_init, impl_enum_interface_info, };