protocol.h

Go to the documentation of this file.

/* PipeWire
 *
 * Copyright © 2018 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.
 */
 
#ifndef PIPEWIRE_PROTOCOL_H
#define PIPEWIRE_PROTOCOL_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <spa/utils/list.h>
 
struct pw_protocol;
 
#include <pipewire/context.h>
#include <pipewire/properties.h>
#include <pipewire/utils.h>
 
#define PW_TYPE_INFO_Protocol           "PipeWire:Protocol"
#define PW_TYPE_INFO_PROTOCOL_BASE      PW_TYPE_INFO_Protocol ":"
 
struct pw_protocol_client {
        struct spa_list link;           
        struct pw_protocol *protocol;   
        struct pw_core *core;
 
        int (*connect) (struct pw_protocol_client *client,
                        const struct spa_dict *props,
                        void (*done_callback) (void *data, int result),
                        void *data);
        int (*connect_fd) (struct pw_protocol_client *client, int fd, bool close);
        int (*steal_fd) (struct pw_protocol_client *client);
        void (*disconnect) (struct pw_protocol_client *client);
        void (*destroy) (struct pw_protocol_client *client);
        int (*set_paused) (struct pw_protocol_client *client, bool paused);
};
 
#define pw_protocol_client_connect(c,p,cb,d)    ((c)->connect(c,p,cb,d))
#define pw_protocol_client_connect_fd(c,fd,cl)  ((c)->connect_fd(c,fd,cl))
#define pw_protocol_client_steal_fd(c)          ((c)->steal_fd(c))
#define pw_protocol_client_disconnect(c)        ((c)->disconnect(c))
#define pw_protocol_client_destroy(c)           ((c)->destroy(c))
#define pw_protocol_client_set_paused(c,p)      ((c)->set_paused(c,p))
 
struct pw_protocol_server {
        struct spa_list link;           
        struct pw_protocol *protocol;   
        struct pw_impl_core *core;
 
        struct spa_list client_list;    
        void (*destroy) (struct pw_protocol_server *listen);
};
 
#define pw_protocol_server_destroy(l)   ((l)->destroy(l))
 
struct pw_protocol_marshal {
        const char *type;               
        uint32_t version;               
#define PW_PROTOCOL_MARSHAL_FLAG_IMPL   (1 << 0)        
        uint32_t flags;                 
        uint32_t n_client_methods;      
        uint32_t n_server_methods;      
        const void *client_marshal;
        const void *server_demarshal;
        const void *server_marshal;
        const void *client_demarshal;
};
 
struct pw_protocol_implementaton {
#define PW_VERSION_PROTOCOL_IMPLEMENTATION      0
        uint32_t version;
 
        struct pw_protocol_client * (*new_client) (struct pw_protocol *protocol,
                                                   struct pw_core *core,
                                                   const struct spa_dict *props);
        struct pw_protocol_server * (*add_server) (struct pw_protocol *protocol,
                                                   struct pw_impl_core *core,
                                                   const struct spa_dict *props);
};
 
struct pw_protocol_events {
#define PW_VERSION_PROTOCOL_EVENTS              0
        uint32_t version;
 
        void (*destroy) (void *data);
};
 
#define pw_protocol_new_client(p,...)   (pw_protocol_get_implementation(p)->new_client(p,__VA_ARGS__))
#define pw_protocol_add_server(p,...)   (pw_protocol_get_implementation(p)->add_server(p,__VA_ARGS__))
#define pw_protocol_ext(p,type,method,...)      (((type*)pw_protocol_get_extension(p))->method( __VA_ARGS__))
 
struct pw_protocol *pw_protocol_new(struct pw_context *context, const char *name, size_t user_data_size);
 
void pw_protocol_destroy(struct pw_protocol *protocol);
 
struct pw_context *pw_protocol_get_context(struct pw_protocol *protocol);
 
void *pw_protocol_get_user_data(struct pw_protocol *protocol);
 
const struct pw_protocol_implementaton *
pw_protocol_get_implementation(struct pw_protocol *protocol);
 
const void *
pw_protocol_get_extension(struct pw_protocol *protocol);
 
 
void pw_protocol_add_listener(struct pw_protocol *protocol,
                              struct spa_hook *listener,
                              const struct pw_protocol_events *events,
                              void *data);
 
int pw_protocol_add_marshal(struct pw_protocol *protocol,
                            const struct pw_protocol_marshal *marshal);
 
const struct pw_protocol_marshal *
pw_protocol_get_marshal(struct pw_protocol *protocol, const char *type, uint32_t version, uint32_t flags);
 
struct pw_protocol * pw_context_find_protocol(struct pw_context *context, const char *name);
 
#ifdef __cplusplus
}  /* extern "C" */
#endif
 
#endif /* PIPEWIRE_PROTOCOL_H */