pipewire/src/modules/module-client-node/client-stream.c

/* PipeWire
 * Copyright (C) 2018 Wim Taymans <wim.taymans@gmail.com>
 *
 * 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 <string.h>
#include <stddef.h>
#include <stdio.h>
#include <errno.h>
#include <unistd.h>
#include <fcntl.h>
#include <dlfcn.h>
#include <sys/socket.h>
#include <sys/mman.h>
#include <sys/eventfd.h>

#include <spa/node/node.h>
#include <spa/buffer/alloc.h>
#include <spa/pod/parser.h>
#include <spa/param/audio/format-utils.h>

#include <spa/lib/pod.h>

#include "pipewire/pipewire.h"
#include "pipewire/interfaces.h"
#include "pipewire/private.h"

#include "pipewire/core.h"
#include "modules/spa/spa-node.h"
#include "client-node.h"
#include "client-stream.h"

#include <spa/lib/debug.h>

/** \cond */

struct type {
	struct spa_type_media_type media_type;
	struct spa_type_media_subtype media_subtype;
};

static inline void init_type(struct type *type, struct spa_type_map *map)
{
	spa_type_media_type_map(map, &type->media_type);
	spa_type_media_subtype_map(map, &type->media_subtype);
}

struct node {
	struct spa_node node;

	struct impl *impl;

	struct spa_type_map *map;
	struct spa_log *log;

	const struct spa_node_callbacks *callbacks;
	void *callbacks_data;

	uint32_t seq;
};

struct impl {
	struct pw_client_stream this;

	struct type type;

	struct pw_core *core;
	struct pw_type *t;

	struct node node;

	struct spa_hook node_listener;
	struct spa_hook client_node_listener;
	struct spa_hook resource_listener;

	enum spa_direction direction;

	struct spa_node *cnode;
	struct spa_node *adapter;

	bool use_converter;
	struct pw_client_node *client_node;
	struct pw_port *client_port;
	struct pw_port_mix client_port_mix;

	struct spa_buffer **buffers;
	uint32_t n_buffers;
	struct pw_memblock *mem;
};

/** \endcond */

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)
{
	return 0;
}

static int impl_node_set_param(struct spa_node *node, uint32_t id, uint32_t flags,
			       const struct spa_pod *param)
{
	return 0;
}

static int impl_node_send_command(struct spa_node *node, const struct spa_command *command)
{
	struct node *this;
	struct impl *impl;
	int res;

	spa_return_val_if_fail(node != NULL, -EINVAL);

	this = SPA_CONTAINER_OF(node, struct node, node);
	impl = this->impl;

	if ((res = spa_node_send_command(impl->adapter, command)) < 0)
		return res;

	if ((res = spa_node_send_command(impl->cnode, command)) < 0)
		return res;

	return 0;
}

static int
impl_node_set_callbacks(struct spa_node *node,
			const struct spa_node_callbacks *callbacks,
			void *data)
{
	struct node *this;

	spa_return_val_if_fail(node != NULL, -EINVAL);

	this = SPA_CONTAINER_OF(node, struct node, 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)
{
	struct node *this;
	struct impl *impl;

	spa_return_val_if_fail(node != NULL, -EINVAL);

	this = SPA_CONTAINER_OF(node, struct node, node);
	impl = this->impl;

	if (impl->adapter) {
		spa_node_get_n_ports(impl->adapter,
				n_input_ports,
				max_input_ports,
				n_output_ports,
				max_output_ports);

		if (impl->direction == SPA_DIRECTION_OUTPUT) {
			if (n_input_ports)
				*n_input_ports = 0;
			if (max_input_ports)
				*max_input_ports = 0;
		} else {
			if (n_output_ports)
				*n_output_ports = 0;
			if (max_output_ports)
				*max_output_ports = 0;
		}
	} else {
		uint32_t n_inputs = 0, n_outputs = 0;

		if (impl->direction == SPA_DIRECTION_OUTPUT)
			n_outputs++;
		else
			n_inputs++;

		if (n_input_ports)
			*n_input_ports = n_inputs;
		if (max_input_ports)
			*max_input_ports = n_inputs;
		if (n_output_ports)
			*n_output_ports = n_outputs;
		if (max_output_ports)
			*max_output_ports = n_outputs;
	}
	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)
{
	struct node *this;

	spa_return_val_if_fail(node != NULL, -EINVAL);

	this = SPA_CONTAINER_OF(node, struct node, node);

	if (this->impl->adapter) {
		return spa_node_get_port_ids(this->impl->adapter,
				input_ids,
				n_input_ids,
				output_ids,
				n_output_ids);
	}
	else {
		if (input_ids && n_input_ids > 0)
			input_ids[0] = 0;
		if (output_ids && n_output_ids > 0)
			output_ids[0] = 0;
	}

	return 0;
}

static int
impl_node_add_port(struct spa_node *node, enum spa_direction direction, uint32_t port_id)
{
	struct node *this;
	struct impl *impl;

	spa_return_val_if_fail(node != NULL, -EINVAL);

	this = SPA_CONTAINER_OF(node, struct node, node);
	impl = this->impl;

	if (direction != impl->direction)
		return -EINVAL;

	return spa_node_add_port(impl->adapter, direction, port_id);
}

static int
impl_node_remove_port(struct spa_node *node, enum spa_direction direction, uint32_t port_id)
{
	struct node *this;
	struct impl *impl;

	spa_return_val_if_fail(node != NULL, -EINVAL);

	this = SPA_CONTAINER_OF(node, struct node, node);
	impl = this->impl;

	if (direction != this->impl->direction)
		return -EINVAL;

	return spa_node_remove_port(impl->adapter, direction, port_id);
}

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 node *this;
	struct impl *impl;

	if (node == NULL || info == NULL)
		return -EINVAL;

	this = SPA_CONTAINER_OF(node, struct node, node);
	impl = this->impl;

	if (direction != impl->direction)
		return -EINVAL;

	return spa_node_port_get_info(impl->adapter, direction, port_id, info);
}

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 node *this;
	struct impl *impl;

	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 node, node);
	impl = this->impl;

	if (direction != impl->direction)
		return -EINVAL;

	return spa_node_port_enum_params(impl->adapter, direction, port_id, id,
			index, filter, result, builder);
}

static int negotiate_format(struct impl *impl)
{
	struct node *this = &impl->node;
	uint32_t state;
	struct spa_pod *format;
	uint8_t buffer[4096];
	struct spa_pod_builder b = { 0 };
	struct pw_type *t = impl->t;
	int res;

	spa_pod_builder_init(&b, buffer, sizeof(buffer));

	spa_log_info(this->log, "%p: negiotiate", impl);

	state = 0;
	if ((res = spa_node_port_enum_params(impl->adapter,
			       SPA_DIRECTION_INPUT, 0,
			       t->param.idEnumFormat, &state,
			       NULL, &format, &b)) <= 0)
		return -ENOTSUP;

	state = 0;
	if ((res = spa_node_port_enum_params(impl->cnode,
				       SPA_DIRECTION_OUTPUT, 0,
				       t->param.idEnumFormat, &state,
				       format, &format, &b)) <= 0)
			return -ENOTSUP;

	spa_pod_fixate(format);

	if ((res = spa_node_port_set_param(impl->adapter,
				   SPA_DIRECTION_INPUT, 0,
				   t->param.idFormat, 0,
				   format)) < 0)
			return res;

	if ((res = spa_node_port_set_param(impl->cnode,
					   SPA_DIRECTION_OUTPUT, 0,
					   t->param.idFormat, 0,
					   format)) < 0)
			return res;

	return res;
}

static int negotiate_buffers(struct impl *impl)
{
	struct node *this = &impl->node;
	struct pw_type *t = impl->t;
	uint8_t buffer[4096];
	struct spa_pod_builder b = SPA_POD_BUILDER_INIT(buffer, sizeof(buffer));
	uint32_t state;
	struct spa_pod *param = NULL;
	int res, i;
	bool in_alloc, out_alloc;
	int32_t size, buffers, blocks, align, flags;
	uint32_t *aligns, data_size;
	struct spa_data *datas;
	const struct spa_port_info *in_info, *out_info;
        struct spa_buffer_alloc_info info = { 0, };
        void *skel;

	spa_log_info(this->log, "%p: %d", impl, impl->n_buffers);

	if (impl->n_buffers > 0)
		return 0;

	state = 0;
	if ((res = spa_node_port_enum_params(impl->cnode,
			       SPA_DIRECTION_OUTPUT, 0,
			       t->param.idBuffers, &state,
			       param, &param, &b)) < 0)
		return res;

	if (res == 0)
		param = NULL;

	state = 0;
	if ((res = spa_node_port_enum_params(impl->adapter,
			       SPA_DIRECTION_INPUT, 0,
			       t->param.idBuffers, &state,
			       param, &param, &b)) <= 0)
		return -ENOTSUP;

	spa_pod_fixate(param);

	if ((res = spa_node_port_get_info(impl->cnode,
					SPA_DIRECTION_OUTPUT, 0,
					&out_info)) < 0)
		return res;
	if ((res = spa_node_port_get_info(impl->adapter,
					SPA_DIRECTION_INPUT, 0,
					&in_info)) < 0)
		return res;

	in_alloc = SPA_FLAG_CHECK(in_info->flags, SPA_PORT_INFO_FLAG_CAN_ALLOC_BUFFERS);
	out_alloc = SPA_FLAG_CHECK(out_info->flags, SPA_PORT_INFO_FLAG_CAN_ALLOC_BUFFERS);

	flags = 0;
	if (out_alloc || in_alloc) {
		flags |= SPA_BUFFER_ALLOC_FLAG_NO_DATA;
		if (out_alloc)
			in_alloc = false;
	}

	if (spa_pod_object_parse(param,
			":", t->param_buffers.buffers, "i", &buffers,
			":", t->param_buffers.blocks, "i", &blocks,
			":", t->param_buffers.size, "i", &size,
			":", t->param_buffers.align, "i", &align,
			NULL) < 0)
		return -EINVAL;

	datas = alloca(sizeof(struct spa_data) * blocks);
	memset(datas, 0, sizeof(struct spa_data) * blocks);
	aligns = alloca(sizeof(uint32_t) * blocks);
	for (i = 0; i < blocks; i++) {
		datas[i].type = t->data.MemPtr;
		datas[i].maxsize = size;
		aligns[i] = align;
	}

	spa_buffer_alloc_fill_info(&info, 0, NULL, blocks, datas, aligns);
	info.skel_size = SPA_ROUND_UP_N(info.skel_size, 16);

	if (impl->buffers)
		free(impl->buffers);
	impl->buffers = calloc(blocks, sizeof(struct spa_buffer *) + info.skel_size);
	if (impl->buffers == NULL)
		return -ENOMEM;

        skel = SPA_MEMBER(impl->buffers, sizeof(struct spa_buffer *) * blocks, void);
	data_size = info.meta_size + info.chunk_size + info.data_size;

	if (impl->mem) {
		pw_memblock_free(impl->mem);
		impl->mem = NULL;
	}

	if ((res = pw_memblock_alloc(PW_MEMBLOCK_FLAG_WITH_FD |
				     PW_MEMBLOCK_FLAG_MAP_READWRITE |
				     PW_MEMBLOCK_FLAG_SEAL, blocks * data_size,
				     &impl->mem)) < 0)
		return res;

	impl->n_buffers = blocks;

        spa_buffer_alloc_layout_array(&info, impl->n_buffers, impl->buffers,
			skel, impl->mem->ptr);


	if (in_alloc) {
		if ((res = spa_node_port_alloc_buffers(impl->adapter,
			       SPA_DIRECTION_INPUT, 0,
			       NULL, 0,
			       impl->buffers, &impl->n_buffers)) < 0)
			return res;
	}
	else {
		if ((res = spa_node_port_use_buffers(impl->adapter,
			       SPA_DIRECTION_INPUT, 0,
			       impl->buffers, impl->n_buffers)) < 0)
			return res;
	}
	if (out_alloc) {
		if ((res = spa_node_port_alloc_buffers(impl->cnode,
			       SPA_DIRECTION_OUTPUT, 0,
			       NULL, 0,
			       impl->buffers, &impl->n_buffers)) < 0)
			return res;
	}
	else {
		if ((res = spa_node_port_use_buffers(impl->cnode,
			       SPA_DIRECTION_OUTPUT, 0,
			       impl->buffers, impl->n_buffers)) < 0)
			return res;
	}

	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 node *this;
	struct impl *impl;
	struct pw_type *t;
	int res;

	spa_return_val_if_fail(node != NULL, -EINVAL);

	this = SPA_CONTAINER_OF(node, struct node, node);
	impl = this->impl;
	t = impl->t;

	if (direction != impl->direction)
		return -EINVAL;

	if ((res = spa_node_port_set_param(impl->adapter, direction, port_id, id,
			flags, param)) < 0)
		return res;

	if (id == t->param.idFormat && impl->use_converter) {
		if (param == NULL) {
		}
		else {
			if (port_id == 0)
				res = negotiate_format(impl);
		}
	}
	return res;
}

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 node *this;
	struct impl *impl;

	spa_return_val_if_fail(node != NULL, -EINVAL);

	this = SPA_CONTAINER_OF(node, struct node, node);
	impl = this->impl;

	if (direction != impl->direction)
		return -EINVAL;

	return spa_node_port_set_io(impl->adapter, direction, port_id, id, data, size);
}

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 node *this;
	struct impl *impl;
	int res;

	spa_return_val_if_fail(node != NULL, -EINVAL);

	this = SPA_CONTAINER_OF(node, struct node, node);
	impl = this->impl;

	if (direction != impl->direction)
		return -EINVAL;

	if ((res = spa_node_port_use_buffers(impl->adapter,
					direction, port_id, buffers, n_buffers)) < 0)
		return res;


	spa_log_info(this->log, "%p: %d %d", impl, n_buffers, port_id);

	if (n_buffers > 0 && impl->use_converter) {
		if (port_id == 0)
			res = negotiate_buffers(impl);
	}
	return res;
}

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)
{
	struct node *this;
	struct impl *impl;

	spa_return_val_if_fail(node != NULL, -EINVAL);

	this = SPA_CONTAINER_OF(node, struct node, node);
	impl = this->impl;

	if (direction != impl->direction)
		return -EINVAL;

	return spa_node_port_alloc_buffers(impl->adapter, direction, port_id,
			params, n_params, buffers, n_buffers);
}

static int
impl_node_port_reuse_buffer(struct spa_node *node, uint32_t port_id, uint32_t buffer_id)
{
	struct node *this;
	struct impl *impl;

	spa_return_val_if_fail(node != NULL, -EINVAL);

	this = SPA_CONTAINER_OF(node, struct node, node);
	impl = this->impl;

	return spa_node_port_reuse_buffer(impl->adapter, port_id, buffer_id);
}

static int
impl_node_port_send_command(struct spa_node *node,
			    enum spa_direction direction,
			    uint32_t port_id, const struct spa_command *command)
{
	struct node *this;
	struct impl *impl;
	int res;

	spa_return_val_if_fail(node != NULL, -EINVAL);
	spa_return_val_if_fail(command != NULL, -EINVAL);

	this = SPA_CONTAINER_OF(node, struct node, node);
	impl = this->impl;

	if (direction != impl->direction)
		return -EINVAL;

	if ((res = spa_node_port_send_command(impl->adapter, direction, port_id, command)) < 0)
		return res;

	return res;
}

static int impl_node_process(struct spa_node *node)
{
	struct node *this = SPA_CONTAINER_OF(node, struct node, node);
	struct impl *impl = this->impl;
	int status;

	spa_log_trace(this->log, "%p: process", this);

	if (impl->use_converter)
		status = spa_node_process(impl->adapter);
	else
		status = SPA_STATUS_HAVE_BUFFER | SPA_STATUS_NEED_BUFFER;

	spa_log_trace(this->log, "%p: process %d", this, status);

//	if (SPA_FLAG_CHECK(status, SPA_STATUS_HAVE_BUFFER))
//		spa_graph_node_trigger(&impl->this.node->rt.node);

	if (SPA_FLAG_CHECK(status, SPA_STATUS_NEED_BUFFER))
		spa_graph_run(impl->client_node->node->rt.node.graph);

	return status;
}

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
node_init(struct node *this,
	  struct spa_dict *info,
	  const struct spa_support *support,
	  uint32_t n_support)
{
	uint32_t i;

	for (i = 0; i < n_support; i++) {
		if (strcmp(support[i].type, SPA_TYPE__Log) == 0)
			this->log = support[i].data;
		else if (strcmp(support[i].type, SPA_TYPE__TypeMap) == 0)
			this->map = support[i].data;
	}
	if (this->map == NULL) {
		spa_log_error(this->log, "a type map is needed");
		return -EINVAL;
	}

	this->node = impl_node;

	this->seq = 1;

	return SPA_RESULT_RETURN_ASYNC(this->seq++);
}

static void client_node_initialized(void *data)
{
	struct impl *impl = data;
        uint32_t n_input_ports, n_output_ports, max_input_ports, max_output_ports, state;
	uint32_t media_type, media_subtype;
	struct pw_type *t = impl->t;
	struct spa_pod *format;
	uint8_t buffer[4096];
	struct spa_pod_builder b;
	int res;

	pw_log_debug("client-stream %p: initialized", &impl->this);

	impl->cnode = pw_node_get_implementation(impl->client_node->node);

	if ((res = spa_node_get_n_ports(impl->cnode,
			     &n_input_ports,
			     &max_input_ports,
			     &n_output_ports,
			     &max_output_ports)) < 0)
		return;

	if (n_input_ports > 0)
		impl->direction = SPA_DIRECTION_INPUT;
	else
		impl->direction = SPA_DIRECTION_OUTPUT;

	state = 0;
	spa_pod_builder_init(&b, buffer, sizeof(buffer));
	if ((res = spa_node_port_enum_params(impl->cnode,
				impl->direction, 0,
				t->param.idEnumFormat, &state,
				NULL, &format, &b)) <= 0)
		return;

	spa_pod_object_parse(format,
			"I", &media_type,
			"I", &media_subtype);

	pw_log_debug("client-stream %p: %s/%s", &impl->this,
			spa_type_map_get_type(t->map, media_type),
			spa_type_map_get_type(t->map, media_subtype));

	if (media_type == impl->type.media_type.audio &&
	    media_subtype == impl->type.media_subtype.raw) {
		if ((impl->adapter = pw_load_spa_interface("audioconvert/libspa-audioconvert",
				"splitter", SPA_TYPE__Node, NULL, 0)) == NULL)
			return;

		impl->client_port = pw_node_find_port(impl->client_node->node, impl->direction, 0);
		if (impl->client_port == NULL)
			return;

		if ((res = pw_port_init_mix(impl->client_port, &impl->client_port_mix)) < 0)
			return;

		if ((res = spa_node_port_set_io(impl->adapter,
					SPA_DIRECTION_INPUT, 0,
					t->io.Buffers,
					impl->client_port_mix.io,
					sizeof(impl->client_port_mix.io))) < 0)
			return;

		if ((res = spa_node_port_set_io(&impl->client_port->mix_node,
					SPA_DIRECTION_OUTPUT, 0,
					t->io.Buffers,
					impl->client_port_mix.io,
					sizeof(impl->client_port_mix.io))) < 0)
			return;

		impl->use_converter = true;
	}
	else {
		impl->adapter = impl->cnode;
		impl->use_converter = false;
	}


	pw_node_register(impl->this.node, NULL, NULL, NULL);

	pw_log_debug("client-stream %p: activating", &impl->this);

	pw_node_set_active(impl->this.node, true);
}

static void cleanup(struct impl *impl)
{
	if (impl->use_converter) {
		if (impl->adapter)
			pw_unload_spa_interface(impl->adapter);
	}

	if (impl->buffers)
		free(impl->buffers);
	if (impl->mem) {
		pw_memblock_free(impl->mem);
		impl->mem = NULL;
	}
	free(impl);
}

static void client_node_destroy(void *data)
{
	struct impl *impl = data;
	pw_log_debug("client-stream %p: destroy", &impl->this);

	spa_hook_remove(&impl->client_node_listener);

	spa_hook_remove(&impl->node_listener);
	pw_node_destroy(impl->this.node);
	cleanup(impl);
}

static void client_node_async_complete(void *data, uint32_t seq, int res)
{
	struct impl *impl = data;
	struct node *node = &impl->node;

	pw_log_debug("client-stream %p: async complete %d %d", &impl->this, seq, res);
	node->callbacks->done(node->callbacks_data, seq, res);
}

static void client_node_active_changed(void *data, bool active)
{
	struct impl *impl = data;

	pw_log_debug("client-stream %p: active %d", &impl->this, active);
	pw_node_set_active(impl->this.node, active);
}

static const struct pw_node_events client_node_events = {
	PW_VERSION_NODE_EVENTS,
	.destroy = client_node_destroy,
	.initialized = client_node_initialized,
	.async_complete = client_node_async_complete,
	.active_changed = client_node_active_changed,
};

static void node_destroy(void *data)
{
	struct impl *impl = data;

	pw_log_debug("client-stream %p: destroy", &impl->this);

	spa_hook_remove(&impl->client_node_listener);
	pw_client_node_destroy(impl->client_node);
	cleanup(impl);
}

static const struct pw_node_events node_events = {
	PW_VERSION_NODE_EVENTS,
	.destroy = node_destroy,
};

/** Create a new client stream
 * \param client an owner \ref pw_client
 * \param id an id
 * \param name a name
 * \param properties extra properties
 * \return a newly allocated client stream
 *
 * Create a new \ref pw_stream.
 *
 * \memberof pw_client_stream
 */
struct pw_client_stream *pw_client_stream_new(struct pw_resource *resource,
					  struct pw_properties *properties)
{
	struct impl *impl;
	struct pw_client_stream *this;
	struct pw_client *client = pw_resource_get_client(resource);
	struct pw_core *core = pw_client_get_core(client);
	const struct spa_support *support;
	uint32_t n_support;
	const char *name;

	impl = calloc(1, sizeof(struct impl));
	if (impl == NULL)
		return NULL;

	this = &impl->this;

	impl->core = core;
	impl->t = pw_core_get_type(core);

	init_type(&impl->type, impl->t->map);

	pw_log_debug("client-stream %p: new", impl);

	impl->client_node = pw_client_node_new(
			resource,
			pw_properties_copy(properties),
			false);
	if (impl->client_node == NULL)
		goto error_no_node;

	support = pw_core_get_support(impl->core, &n_support);

	node_init(&impl->node, NULL, support, n_support);
	impl->node.impl = impl;

	if ((name = pw_properties_get(properties, "node.name")) == NULL)
		name = "client-stream";

	this->node = pw_spa_node_new(core,
				     client,
				     NULL,
				     name,
				     PW_SPA_NODE_FLAG_ASYNC,
				     &impl->node.node,
				     NULL,
				     properties, 0);
	if (this->node == NULL)
		goto error_no_node;

	this->node->remote = true;

	pw_node_add_listener(impl->client_node->node,
			     &impl->client_node_listener,
			     &client_node_events, impl);
	pw_node_add_listener(this->node, &impl->node_listener, &node_events, impl);

	return this;

      error_no_node:
	pw_resource_destroy(resource);
	free(impl);
	return NULL;
}

/** Destroy a client stream
 * \param stream the client stream to destroy
 * \memberof pw_client_stream
 */
void pw_client_stream_destroy(struct pw_client_stream *stream)
{
	struct impl *impl = SPA_CONTAINER_OF(stream, struct impl, this);
	pw_client_node_destroy(impl->client_node);
}