impl-port.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_IMPL_PORT_H
#define PIPEWIRE_IMPL_PORT_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <spa/utils/hook.h>
 
struct pw_impl_port;
struct pw_impl_link;
struct pw_control;
 
#include <pipewire/impl.h>
 
enum pw_impl_port_state {
        PW_IMPL_PORT_STATE_ERROR = -1,  
        PW_IMPL_PORT_STATE_INIT = 0,            
        PW_IMPL_PORT_STATE_CONFIGURE = 1,       
        PW_IMPL_PORT_STATE_READY = 2,   
        PW_IMPL_PORT_STATE_PAUSED = 3,  
};
 
struct pw_impl_port_events {
#define PW_VERSION_IMPL_PORT_EVENTS 2
        uint32_t version;
 
        void (*destroy) (void *data);
 
        void (*free) (void *data);
 
        void (*initialized) (void *data);
 
        void (*info_changed) (void *data, const struct pw_port_info *info);
 
        void (*link_added) (void *data, struct pw_impl_link *link);
 
        void (*link_removed) (void *data, struct pw_impl_link *link);
 
        void (*state_changed) (void *data, enum pw_impl_port_state old,
                        enum pw_impl_port_state state, const char *error);
 
        void (*control_added) (void *data, struct pw_control *control);
 
        void (*control_removed) (void *data, struct pw_control *control);
 
        void (*param_changed) (void *data, uint32_t id);
 
        void (*latency_changed) (void *data);
};
 
struct pw_impl_port *
pw_context_create_port(struct pw_context *context,
        enum pw_direction direction,
        uint32_t port_id,
        const struct spa_port_info *info,
        size_t user_data_size);
 
enum pw_direction pw_impl_port_get_direction(struct pw_impl_port *port);
 
const struct pw_properties *pw_impl_port_get_properties(struct pw_impl_port *port);
 
int pw_impl_port_update_properties(struct pw_impl_port *port, const struct spa_dict *dict);
 
const struct pw_port_info *pw_impl_port_get_info(struct pw_impl_port *port);
 
uint32_t pw_impl_port_get_id(struct pw_impl_port *port);
 
struct pw_impl_node *pw_impl_port_get_node(struct pw_impl_port *port);
 
int pw_impl_port_is_linked(struct pw_impl_port *port);
 
int pw_impl_port_add(struct pw_impl_port *port, struct pw_impl_node *node);
 
void pw_impl_port_add_listener(struct pw_impl_port *port,
                          struct spa_hook *listener,
                          const struct pw_impl_port_events *events,
                          void *data);
 
#ifdef __cplusplus
}
#endif
 
#endif /* PIPEWIRE_IMPL_PORT_H */