client-node.h

Go to the documentation of this file.

/* PipeWire */
/* SPDX-FileCopyrightText: Copyright © 2018 Wim Taymans */
/* SPDX-License-Identifier: MIT */
 
#ifndef PIPEWIRE_EXT_CLIENT_NODE_H
#define PIPEWIRE_EXT_CLIENT_NODE_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <spa/utils/defs.h>
#include <spa/param/param.h>
 
#define PW_TYPE_INTERFACE_ClientNode            PW_TYPE_INFO_INTERFACE_BASE "ClientNode"
 
/*
 * version 4: new port_set_mix_info event added
 * version 5: driver nodes are scheduled on the client
 * version 6: client needs to set activation INACTIVE -> FINISHED
 */
#define PW_VERSION_CLIENT_NODE                  6
struct pw_client_node;
 
#define PW_EXTENSION_MODULE_CLIENT_NODE         PIPEWIRE_MODULE_PREFIX "module-client-node"
 
struct pw_client_node_buffer {
        uint32_t mem_id;                
        uint32_t offset;                
        uint32_t size;                  
        struct spa_buffer *buffer;      
};
 
#define PW_CLIENT_NODE_EVENT_TRANSPORT          0
#define PW_CLIENT_NODE_EVENT_SET_PARAM          1
#define PW_CLIENT_NODE_EVENT_SET_IO             2
#define PW_CLIENT_NODE_EVENT_EVENT              3
#define PW_CLIENT_NODE_EVENT_COMMAND            4
#define PW_CLIENT_NODE_EVENT_ADD_PORT           5
#define PW_CLIENT_NODE_EVENT_REMOVE_PORT        6
#define PW_CLIENT_NODE_EVENT_PORT_SET_PARAM     7
#define PW_CLIENT_NODE_EVENT_PORT_USE_BUFFERS   8
#define PW_CLIENT_NODE_EVENT_PORT_SET_IO        9
#define PW_CLIENT_NODE_EVENT_SET_ACTIVATION     10
#define PW_CLIENT_NODE_EVENT_PORT_SET_MIX_INFO  11
#define PW_CLIENT_NODE_EVENT_NUM                12
 
struct pw_client_node_events {
#define PW_VERSION_CLIENT_NODE_EVENTS           1
        uint32_t version;
        int (*transport) (void *data,
                          int readfd,
                          int writefd,
                          uint32_t mem_id,
                          uint32_t offset,
                          uint32_t size);
        int (*set_param) (void *data,
                          uint32_t id, uint32_t flags,
                          const struct spa_pod *param);
        int (*set_io) (void *data,
                        uint32_t id,
                        uint32_t mem_id,
                        uint32_t offset,
                        uint32_t size);
        int (*event) (void *data, const struct spa_event *event);
        int (*command) (void *data, const struct spa_command *command);
        int (*add_port) (void *data,
                          enum spa_direction direction,
                          uint32_t port_id,
                          const struct spa_dict *props);
        int (*remove_port) (void *data,
                             enum spa_direction direction,
                             uint32_t port_id);
        int (*port_set_param) (void *data,
                                enum spa_direction direction,
                                uint32_t port_id,
                                uint32_t id, uint32_t flags,
                                const struct spa_pod *param);
        int (*port_use_buffers) (void *data,
                                  enum spa_direction direction,
                                  uint32_t port_id,
                                  uint32_t mix_id,
                                  uint32_t flags,
                                  uint32_t n_buffers,
                                  struct pw_client_node_buffer *buffers);
        int (*port_set_io) (void *data,
                             enum spa_direction direction,
                             uint32_t port_id,
                             uint32_t mix_id,
                             uint32_t id,
                             uint32_t mem_id,
                             uint32_t offset,
                             uint32_t size);
 
        int (*set_activation) (void *data,
                                uint32_t node_id,
                                int signalfd,
                                uint32_t mem_id,
                                uint32_t offset,
                                uint32_t size);
 
        int (*port_set_mix_info) (void *data,
                        enum spa_direction direction,
                        uint32_t port_id,
                        uint32_t mix_id,
                        uint32_t peer_id,
                        const struct spa_dict *props);
};
 
#define PW_CLIENT_NODE_METHOD_ADD_LISTENER      0
#define PW_CLIENT_NODE_METHOD_GET_NODE          1
#define PW_CLIENT_NODE_METHOD_UPDATE            2
#define PW_CLIENT_NODE_METHOD_PORT_UPDATE       3
#define PW_CLIENT_NODE_METHOD_SET_ACTIVE        4
#define PW_CLIENT_NODE_METHOD_EVENT             5
#define PW_CLIENT_NODE_METHOD_PORT_BUFFERS      6
#define PW_CLIENT_NODE_METHOD_NUM               7
 
struct pw_client_node_methods {
#define PW_VERSION_CLIENT_NODE_METHODS          0
        uint32_t version;
 
        int (*add_listener) (void *object,
                        struct spa_hook *listener,
                        const struct pw_client_node_events *events,
                        void *data);
        struct pw_node * (*get_node) (void *object, uint32_t version, size_t user_data_size);
        int (*update) (void *object,
#define PW_CLIENT_NODE_UPDATE_PARAMS            (1 << 0)
#define PW_CLIENT_NODE_UPDATE_INFO              (1 << 1)
                        uint32_t change_mask,
                        uint32_t n_params,
                        const struct spa_pod **params,
                        const struct spa_node_info *info);
 
        int (*port_update) (void *object,
                             enum spa_direction direction,
                             uint32_t port_id,
#define PW_CLIENT_NODE_PORT_UPDATE_PARAMS            (1 << 0)
#define PW_CLIENT_NODE_PORT_UPDATE_INFO              (1 << 1)
                             uint32_t change_mask,
                             uint32_t n_params,
                             const struct spa_pod **params,
                             const struct spa_port_info *info);
        int (*set_active) (void *object, bool active);
        int (*event) (void *object, const struct spa_event *event);
 
        int (*port_buffers) (void *object,
                          enum spa_direction direction,
                          uint32_t port_id,
                          uint32_t mix_id,
                          uint32_t n_buffers,
                          struct spa_buffer **buffers);
};
 
 
#define pw_client_node_method(o,method,version,...)                     \
({                                                                      \
        int _res = -ENOTSUP;                                            \
        spa_interface_call_res((struct spa_interface*)o,                \
                        struct pw_client_node_methods, _res,            \
                        method, version, ##__VA_ARGS__);                \
        _res;                                                           \
})
 
#define pw_client_node_add_listener(c,...)      pw_client_node_method(c,add_listener,0,__VA_ARGS__)
 
static inline struct pw_node *
pw_client_node_get_node(struct pw_client_node *p, uint32_t version, size_t user_data_size)
{
        struct pw_node *res = NULL;
        spa_interface_call_res((struct spa_interface*)p,
                        struct pw_client_node_methods, res,
                        get_node, 0, version, user_data_size);
        return res;
}
 
#define pw_client_node_update(c,...)            pw_client_node_method(c,update,0,__VA_ARGS__)
#define pw_client_node_port_update(c,...)       pw_client_node_method(c,port_update,0,__VA_ARGS__)
#define pw_client_node_set_active(c,...)        pw_client_node_method(c,set_active,0,__VA_ARGS__)
#define pw_client_node_event(c,...)             pw_client_node_method(c,event,0,__VA_ARGS__)
#define pw_client_node_port_buffers(c,...)      pw_client_node_method(c,port_buffers,0,__VA_ARGS__)
 
#ifdef __cplusplus
}  /* extern "C" */
#endif
 
#endif /* PIPEWIRE_EXT_CLIENT_NODE_H */