mirror of
https://gitlab.freedesktop.org/pipewire/pipewire.git
synced 2025-11-10 13:30:05 -05:00
58667d6ced
Do not pass the params of the node in the node_info, instead, make a method to enumerate the params. This makes it possible for clients to only enumerate what they need and when they need it. Improve introspection of a port, add the name and properties. Add an enum_param method on the port that can be used to enumerate port formats. Change -monitor and -cli and add support for enum_params on the node and port.
564 lines
18 KiB
C
564 lines
18 KiB
C
/* PipeWire
|
|
* Copyright (C) 2015 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.
|
|
*/
|
|
|
|
#ifndef __PIPEWIRE_PRIVATE_H__
|
|
#define __PIPEWIRE_PRIVATE_H__
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include <sys/socket.h>
|
|
#include <sys/types.h> /* for pthread_t */
|
|
|
|
|
|
#include "pipewire/mem.h"
|
|
#include "pipewire/pipewire.h"
|
|
#include "pipewire/introspect.h"
|
|
|
|
#ifndef spa_debug
|
|
#define spa_debug pw_log_trace
|
|
#endif
|
|
|
|
#include <spa/graph/graph.h>
|
|
|
|
struct pw_command;
|
|
|
|
typedef int (*pw_command_func_t) (struct pw_command *command, struct pw_core *core, char **err);
|
|
|
|
/** \cond */
|
|
struct pw_command {
|
|
uint32_t id; /**< id of command */
|
|
struct spa_list link; /**< link in list of commands */
|
|
pw_command_func_t func;
|
|
char **args;
|
|
int n_args;
|
|
};
|
|
|
|
struct pw_protocol {
|
|
struct spa_list link; /**< link in core protocol_list */
|
|
struct pw_core *core; /**< core for this protocol */
|
|
|
|
char *name; /**< type name of the protocol */
|
|
|
|
struct spa_list marshal_list; /**< list of marshallers for supported interfaces */
|
|
struct spa_list client_list; /**< list of current clients */
|
|
struct spa_list server_list; /**< list of current servers */
|
|
struct spa_hook_list listener_list; /**< event listeners */
|
|
|
|
const struct pw_protocol_implementaton *implementation; /**< implementation of the protocol */
|
|
|
|
const void *extension; /**< extension API */
|
|
|
|
void *user_data; /**< user data for the implementation */
|
|
};
|
|
|
|
/** the permission function. It returns the allowed access permissions for \a global
|
|
* for \a client */
|
|
typedef uint32_t (*pw_permission_func_t) (struct pw_global *global,
|
|
struct pw_client *client, void *data);
|
|
|
|
struct pw_client {
|
|
struct pw_core *core; /**< core object */
|
|
struct spa_list link; /**< link in core object client list */
|
|
struct pw_global *global; /**< global object created for this client */
|
|
struct spa_hook global_listener;
|
|
bool registered;
|
|
|
|
pw_permission_func_t permission_func; /**< get permissions of an object */
|
|
void *permission_data; /**< data passed to permission function */
|
|
|
|
struct pw_properties *properties; /**< Client properties */
|
|
|
|
struct pw_client_info info; /**< client info */
|
|
bool ucred_valid; /**< if the ucred member is valid */
|
|
struct ucred ucred; /**< ucred information */
|
|
|
|
struct pw_resource *core_resource; /**< core resource object */
|
|
|
|
struct pw_map objects; /**< list of resource objects */
|
|
uint32_t n_types; /**< number of client types */
|
|
struct pw_map types; /**< map of client types */
|
|
|
|
struct spa_list resource_list; /**< The list of resources of this client */
|
|
|
|
bool busy;
|
|
|
|
struct spa_hook_list listener_list;
|
|
|
|
struct pw_protocol *protocol; /**< protocol in use */
|
|
struct spa_list protocol_link; /**< link in the protocol client_list */
|
|
|
|
void *user_data; /**< extra user data */
|
|
};
|
|
|
|
struct pw_global {
|
|
struct pw_core *core; /**< the core */
|
|
struct pw_client *owner; /**< the owner of this object, NULL when the
|
|
* PipeWire server is the owner */
|
|
|
|
struct spa_list link; /**< link in core list of globals */
|
|
uint32_t id; /**< server id of the object */
|
|
struct pw_global *parent; /**< parent global */
|
|
|
|
struct pw_properties *properties; /**< properties of the global */
|
|
|
|
struct spa_hook_list listener_list;
|
|
|
|
uint32_t type; /**< type of interface */
|
|
uint32_t version; /**< version of interface */
|
|
|
|
void *object; /**< object associated with the interface */
|
|
};
|
|
|
|
struct pw_core {
|
|
struct pw_global *global; /**< the global of the core */
|
|
struct spa_hook global_listener;
|
|
|
|
struct pw_core_info info; /**< info about the core */
|
|
|
|
struct pw_properties *properties; /**< properties of the core */
|
|
|
|
struct pw_type type; /**< type map and common types */
|
|
|
|
struct pw_map globals; /**< map of globals */
|
|
|
|
struct spa_list protocol_list; /**< list of protocols */
|
|
struct spa_list remote_list; /**< list of remote connections */
|
|
struct spa_list resource_list; /**< list of core resources */
|
|
struct spa_list registry_resource_list; /**< list of registry resources */
|
|
struct spa_list module_list; /**< list of modules */
|
|
struct spa_list global_list; /**< list of globals */
|
|
struct spa_list client_list; /**< list of clients */
|
|
struct spa_list node_list; /**< list of nodes */
|
|
struct spa_list factory_list; /**< list of factories */
|
|
struct spa_list link_list; /**< list of links */
|
|
struct spa_list control_list[2]; /**< list of controls, indexed by direction */
|
|
|
|
struct spa_hook_list listener_list;
|
|
|
|
struct pw_loop *main_loop; /**< main loop for control */
|
|
struct pw_loop *data_loop; /**< data loop for data passing */
|
|
struct pw_data_loop *data_loop_impl;
|
|
|
|
struct spa_support support[16]; /**< support for spa plugins */
|
|
uint32_t n_support; /**< number of support items */
|
|
|
|
struct pw_client *current_client; /**< client currently executing code in mainloop */
|
|
|
|
long sc_pagesize;
|
|
|
|
struct {
|
|
struct spa_graph graph;
|
|
} rt;
|
|
};
|
|
|
|
struct pw_data_loop {
|
|
struct pw_loop *loop;
|
|
|
|
struct spa_hook_list listener_list;
|
|
|
|
struct spa_source *event;
|
|
|
|
bool running;
|
|
pthread_t thread;
|
|
};
|
|
|
|
struct pw_main_loop {
|
|
struct pw_loop *loop;
|
|
|
|
struct spa_hook_list listener_list;
|
|
struct spa_source *event;
|
|
|
|
bool running;
|
|
};
|
|
|
|
struct pw_link {
|
|
struct pw_core *core; /**< core object */
|
|
struct spa_list link; /**< link in core link_list */
|
|
struct pw_global *global; /**< global for this link */
|
|
struct spa_hook global_listener;
|
|
bool registered;
|
|
|
|
struct pw_link_info info; /**< introspectable link info */
|
|
struct pw_properties *properties; /**< extra link properties */
|
|
|
|
enum pw_link_state state; /**< link state */
|
|
char *error; /**< error message when state error */
|
|
|
|
struct spa_list resource_list; /**< list of bound resources */
|
|
|
|
struct spa_io_buffers io; /**< link io area */
|
|
|
|
struct pw_port *output; /**< output port */
|
|
struct spa_list output_link; /**< link in output port links */
|
|
struct pw_port *input; /**< input port */
|
|
struct spa_list input_link; /**< link in input port links */
|
|
|
|
struct spa_hook_list listener_list;
|
|
|
|
void *buffer_owner;
|
|
struct pw_memblock *buffer_mem;
|
|
struct spa_buffer **buffers;
|
|
uint32_t n_buffers;
|
|
|
|
struct {
|
|
struct spa_graph_port out_port;
|
|
struct spa_graph_port in_port;
|
|
} rt;
|
|
|
|
void *user_data;
|
|
};
|
|
|
|
struct pw_module {
|
|
struct pw_core *core; /**< the core object */
|
|
struct spa_list link; /**< link in the core module_list */
|
|
struct pw_global *global; /**< global object for this module */
|
|
struct spa_hook global_listener;
|
|
|
|
struct pw_module_info info; /**< introspectable module info */
|
|
|
|
struct spa_list resource_list; /**< list of resources for this module */
|
|
|
|
struct spa_hook_list listener_list;
|
|
|
|
void *user_data; /**< module user_data */
|
|
};
|
|
|
|
struct pw_node {
|
|
struct pw_core *core; /**< core object */
|
|
struct spa_list link; /**< link in core node_list */
|
|
struct pw_global *global; /**< global for this node */
|
|
struct spa_hook global_listener;
|
|
bool registered;
|
|
|
|
struct pw_properties *properties; /**< properties of the node */
|
|
|
|
struct pw_node_info info; /**< introspectable node info */
|
|
|
|
bool enabled; /**< if the node is enabled */
|
|
bool active; /**< if the node is active */
|
|
bool live; /**< if the node is live */
|
|
struct spa_clock *clock; /**< handle to SPA clock if any */
|
|
struct spa_node *node; /**< SPA node implementation */
|
|
|
|
struct spa_list resource_list; /**< list of resources for this node */
|
|
|
|
struct spa_list input_ports; /**< list of input ports */
|
|
struct pw_map input_port_map; /**< map from port_id to port */
|
|
uint32_t n_used_input_links; /**< number of active input links */
|
|
uint32_t idle_used_input_links; /**< number of active input to be idle */
|
|
|
|
struct spa_list output_ports; /**< list of output ports */
|
|
struct pw_map output_port_map; /**< map from port_id to port */
|
|
uint32_t n_used_output_links; /**< number of active output links */
|
|
uint32_t idle_used_output_links; /**< number of active output to be idle */
|
|
|
|
struct spa_hook_list listener_list;
|
|
|
|
struct pw_loop *data_loop; /**< the data loop for this node */
|
|
|
|
struct {
|
|
struct spa_graph *graph;
|
|
struct spa_graph_node node;
|
|
} rt;
|
|
|
|
void *user_data; /**< extra user data */
|
|
};
|
|
|
|
struct pw_port {
|
|
struct spa_list link; /**< link in node port_list */
|
|
|
|
struct pw_node *node; /**< owner node */
|
|
struct pw_global *global; /**< global for this port */
|
|
struct spa_hook global_listener;
|
|
bool registered;
|
|
|
|
enum pw_direction direction; /**< port direction */
|
|
uint32_t port_id; /**< port id */
|
|
const struct spa_port_info *spa_info;
|
|
|
|
struct pw_properties *properties; /**< properties of the port */
|
|
struct pw_port_info info;
|
|
|
|
struct spa_list resource_list; /**< list of resources for this port */
|
|
|
|
enum pw_port_state state; /**< state of the port */
|
|
|
|
struct spa_io_buffers io; /**< io area of the port */
|
|
|
|
bool allocated; /**< if buffers are allocated */
|
|
struct pw_memblock *buffer_mem; /**< allocated buffer memory */
|
|
struct spa_buffer **buffers; /**< port buffers */
|
|
uint32_t n_buffers; /**< number of port buffers */
|
|
|
|
struct spa_list links; /**< list of \ref pw_link */
|
|
|
|
struct spa_list control_list[2]; /**< list of \ref pw_control indexed by direction */
|
|
|
|
struct spa_hook_list listener_list;
|
|
|
|
struct spa_node *mix; /**< optional port buffer mix/split */
|
|
|
|
struct {
|
|
struct spa_graph *graph;
|
|
struct spa_graph_port port; /**< this graph port, linked to mix_port */
|
|
struct spa_graph_port mix_port; /**< port from the mixer */
|
|
struct spa_graph_node mix_node; /**< mixer node */
|
|
} rt; /**< data only accessed from the data thread */
|
|
|
|
void *user_data; /**< extra user data */
|
|
};
|
|
|
|
|
|
struct pw_resource {
|
|
struct pw_core *core; /**< the core object */
|
|
struct spa_list link; /**< link in object resource_list */
|
|
|
|
struct pw_client *client; /**< owner client */
|
|
|
|
uint32_t id; /**< per client unique id, index in client objects */
|
|
uint32_t permissions; /**< resource permissions */
|
|
uint32_t type; /**< type of the client interface */
|
|
uint32_t version; /**< version of the client interface */
|
|
|
|
struct spa_hook implementation;
|
|
struct spa_hook_list implementation_list;
|
|
struct spa_hook_list listener_list;
|
|
|
|
const struct pw_protocol_marshal *marshal;
|
|
|
|
void *access_private; /**< private data for access control */
|
|
void *user_data; /**< extra user data */
|
|
};
|
|
|
|
|
|
struct pw_proxy {
|
|
struct pw_remote *remote; /**< the owner remote of this proxy */
|
|
struct spa_list link; /**< link in the remote */
|
|
|
|
uint32_t id; /**< client side id */
|
|
|
|
struct spa_hook_list listener_list;
|
|
struct spa_hook_list proxy_listener_list;
|
|
|
|
const struct pw_protocol_marshal *marshal; /**< protocol specific marshal functions */
|
|
|
|
void *user_data; /**< extra user data */
|
|
};
|
|
|
|
struct pw_remote {
|
|
struct pw_core *core; /**< core */
|
|
struct spa_list link; /**< link in core remote_list */
|
|
struct pw_properties *properties; /**< extra properties */
|
|
|
|
struct pw_core_proxy *core_proxy; /**< proxy for the core object */
|
|
struct pw_map objects; /**< map of client side proxy objects
|
|
* indexed with the client id */
|
|
struct pw_core_info *info; /**< info about the remote core */
|
|
|
|
uint32_t n_types; /**< number of client types */
|
|
struct pw_map types; /**< client types */
|
|
|
|
struct spa_list proxy_list; /**< list of \ref pw_proxy objects */
|
|
struct spa_list stream_list; /**< list of \ref pw_stream objects */
|
|
struct spa_list remote_node_list; /**< list of \ref pw_remote_node objects */
|
|
|
|
struct pw_protocol_client *conn; /**< the protocol client connection */
|
|
|
|
enum pw_remote_state state;
|
|
char *error;
|
|
|
|
struct spa_hook_list listener_list;
|
|
|
|
void *user_data; /**< extra user data */
|
|
};
|
|
|
|
|
|
struct pw_stream {
|
|
struct pw_remote *remote; /**< the owner remote */
|
|
struct spa_list link; /**< link in the remote */
|
|
|
|
char *name; /**< the name of the stream */
|
|
uint32_t node_id; /**< node id for remote node, available from
|
|
* CONFIGURE state and higher */
|
|
struct pw_properties *properties; /**< properties of the stream */
|
|
|
|
enum pw_stream_state state; /**< stream state */
|
|
char *error; /**< error reason when state is in error */
|
|
|
|
struct spa_hook_list listener_list;
|
|
};
|
|
|
|
struct pw_factory {
|
|
struct pw_core *core; /**< the core */
|
|
struct spa_list link; /**< link in core node_factory_list */
|
|
struct pw_global *global; /**< global for this factory */
|
|
struct spa_hook global_listener;
|
|
bool registered;
|
|
|
|
struct pw_factory_info info; /**< introspectable factory info */
|
|
struct pw_properties *properties; /**< properties of the factory */
|
|
|
|
struct spa_hook_list listener_list; /**< event listeners */
|
|
|
|
const struct pw_factory_implementation *implementation;
|
|
void *implementation_data;
|
|
|
|
struct spa_list resource_list; /**< The list of resources of this factory */
|
|
|
|
void *user_data;
|
|
};
|
|
|
|
struct pw_control {
|
|
struct spa_list link; /**< link in core control_list */
|
|
struct pw_core *core; /**< the core */
|
|
|
|
struct pw_port *port; /**< owner port or NULL */
|
|
struct spa_list port_link; /**< link in port control_list */
|
|
|
|
enum spa_direction direction; /**< the direction */
|
|
struct spa_pod *param; /**< control params */
|
|
|
|
struct pw_control *output; /**< pointer to linked output control */
|
|
|
|
struct spa_list inputs; /**< list of linked input controls */
|
|
struct spa_list inputs_link; /**< link in linked input control */
|
|
|
|
uint32_t id;
|
|
uint32_t prop_id;
|
|
int32_t size;
|
|
|
|
struct spa_hook_list listener_list;
|
|
|
|
void *user_data;
|
|
};
|
|
|
|
|
|
/** Find a good format between 2 ports */
|
|
int pw_core_find_format(struct pw_core *core,
|
|
struct pw_port *output,
|
|
struct pw_port *input,
|
|
struct pw_properties *props,
|
|
uint32_t n_format_filters,
|
|
struct spa_pod **format_filters,
|
|
struct spa_pod **format,
|
|
struct spa_pod_builder *builder,
|
|
char **error);
|
|
|
|
/** Find a ports compatible with \a other_port and the format filters */
|
|
struct pw_port *
|
|
pw_core_find_port(struct pw_core *core,
|
|
struct pw_port *other_port,
|
|
uint32_t id,
|
|
struct pw_properties *props,
|
|
uint32_t n_format_filters,
|
|
struct spa_pod **format_filters,
|
|
char **error);
|
|
|
|
/** Create a new port \memberof pw_port
|
|
* \return a newly allocated port */
|
|
struct pw_port *
|
|
pw_port_new(enum pw_direction direction,
|
|
uint32_t port_id,
|
|
struct pw_properties *properties,
|
|
size_t user_data_size);
|
|
|
|
int pw_port_register(struct pw_port *port,
|
|
struct pw_client *owner,
|
|
struct pw_global *parent,
|
|
struct pw_properties *properties);
|
|
|
|
/** Get the user data of a port, the size of the memory was given \ref in pw_port_new */
|
|
void * pw_port_get_user_data(struct pw_port *port);
|
|
|
|
/** Add a port to a node \memberof pw_port */
|
|
int pw_port_add(struct pw_port *port, struct pw_node *node);
|
|
|
|
/** Unlink a port \memberof pw_port */
|
|
void pw_port_unlink(struct pw_port *port);
|
|
|
|
/** Destroy a port \memberof pw_port */
|
|
void pw_port_destroy(struct pw_port *port);
|
|
|
|
/** Iterate the params of the given port. The callback should return
|
|
* 1 to fetch the next item, 0 to stop iteration or <0 on error.
|
|
* The function returns 0 on success or the error returned by the callback. */
|
|
int pw_port_for_each_param(struct pw_port *port,
|
|
uint32_t param_id,
|
|
uint32_t index, uint32_t max,
|
|
const struct spa_pod *filter,
|
|
int (*callback) (void *data,
|
|
uint32_t id, uint32_t index, uint32_t next,
|
|
struct spa_pod *param),
|
|
void *data);
|
|
|
|
int pw_port_for_each_filtered_param(struct pw_port *in_port,
|
|
struct pw_port *out_port,
|
|
uint32_t in_param_id,
|
|
uint32_t out_param_id,
|
|
int (*callback) (void *data,
|
|
uint32_t id, uint32_t index, uint32_t next,
|
|
struct spa_pod *param),
|
|
void *data);
|
|
|
|
/** Set a param on a port \memberof pw_port */
|
|
int pw_port_set_param(struct pw_port *port, uint32_t id, uint32_t flags,
|
|
const struct spa_pod *param);
|
|
|
|
/** Use buffers on a port \memberof pw_port */
|
|
int pw_port_use_buffers(struct pw_port *port, struct spa_buffer **buffers, uint32_t n_buffers);
|
|
|
|
/** Allocate memory for buffers on a port \memberof pw_port */
|
|
int pw_port_alloc_buffers(struct pw_port *port,
|
|
struct spa_pod **params, uint32_t n_params,
|
|
struct spa_buffer **buffers, uint32_t *n_buffers);
|
|
|
|
/** Send a command to a port */
|
|
int pw_port_send_command(struct pw_port *port, bool block, const struct spa_command *command);
|
|
|
|
/** Change the state of the node */
|
|
int pw_node_set_state(struct pw_node *node, enum pw_node_state state);
|
|
|
|
/** Update the state of the node, mostly used by node implementations */
|
|
void pw_node_update_state(struct pw_node *node, enum pw_node_state state, char *error);
|
|
|
|
/** Activate a link \memberof pw_link
|
|
* Starts the negotiation of formats and buffers on \a link and then
|
|
* starts data streaming */
|
|
int pw_link_activate(struct pw_link *link);
|
|
|
|
/** Deactivate a link \memberof pw_link */
|
|
int pw_link_deactivate(struct pw_link *link);
|
|
|
|
struct pw_control *
|
|
pw_control_new(struct pw_core *core,
|
|
struct pw_port *owner, /**< can be NULL */
|
|
const struct spa_pod *param, /**< copy is taken */
|
|
size_t user_data_size /**< extra user data */);
|
|
|
|
void pw_control_destroy(struct pw_control *control);
|
|
|
|
/** \endcond */
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __PIPEWIRE_PRIVATE_H__ */
|