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_PORT_H
#define PIPEWIRE_PORT_H
#ifdef __cplusplus
extern "C" {
#endif
#include <stdarg.h>
#include <errno.h>
#include <spa/utils/defs.h>
#include <spa/utils/hook.h>
#include <spa/param/param.h>
#include <pipewire/proxy.h>
#define PW_TYPE_INTERFACE_Port PW_TYPE_INFO_INTERFACE_BASE "Port"
#define PW_VERSION_PORT 3
struct pw_port;
#define pw_direction spa_direction
#define PW_DIRECTION_INPUT SPA_DIRECTION_INPUT
#define PW_DIRECTION_OUTPUT SPA_DIRECTION_OUTPUT
const char * pw_direction_as_string(enum pw_direction direction);
struct pw_port_info {
uint32_t id;
enum pw_direction direction;
#define PW_PORT_CHANGE_MASK_PROPS (1 << 0)
#define PW_PORT_CHANGE_MASK_PARAMS (1 << 1)
#define PW_PORT_CHANGE_MASK_ALL ((1 << 2)-1)
uint64_t change_mask;
struct spa_dict *props;
struct spa_param_info *params;
uint32_t n_params;
};
struct pw_port_info *
pw_port_info_update(struct pw_port_info *info,
const struct pw_port_info *update);
struct pw_port_info *
pw_port_info_merge(struct pw_port_info *info,
const struct pw_port_info *update, bool reset);
void
pw_port_info_free(struct pw_port_info *info);
#define PW_PORT_EVENT_INFO 0
#define PW_PORT_EVENT_PARAM 1
#define PW_PORT_EVENT_NUM 2
struct pw_port_events {
#define PW_VERSION_PORT_EVENTS 0
uint32_t version;
void (*info) (void *object, const struct pw_port_info *info);
void (*param) (void *object, int seq,
uint32_t id, uint32_t index, uint32_t next,
const struct spa_pod *param);
};
#define PW_PORT_METHOD_ADD_LISTENER 0
#define PW_PORT_METHOD_SUBSCRIBE_PARAMS 1
#define PW_PORT_METHOD_ENUM_PARAMS 2
#define PW_PORT_METHOD_NUM 3
struct pw_port_methods {
#define PW_VERSION_PORT_METHODS 0
uint32_t version;
int (*add_listener) (void *object,
struct spa_hook *listener,
const struct pw_port_events *events,
void *data);
int (*subscribe_params) (void *object, uint32_t *ids, uint32_t n_ids);
int (*enum_params) (void *object, int seq,
uint32_t id, uint32_t start, uint32_t num,
const struct spa_pod *filter);
};
#define pw_port_method(o,method,version,...) \
({ \
int _res = -ENOTSUP; \
spa_interface_call_res((struct spa_interface*)o, \
struct pw_port_methods, _res, \
method, version, ##__VA_ARGS__); \
_res; \
})
#define pw_port_add_listener(c,...) pw_port_method(c,add_listener,0,__VA_ARGS__)
#define pw_port_subscribe_params(c,...) pw_port_method(c,subscribe_params,0,__VA_ARGS__)
#define pw_port_enum_params(c,...) pw_port_method(c,enum_params,0,__VA_ARGS__)
#ifdef __cplusplus
} /* extern "C" */
#endif
#endif /* PIPEWIRE_PORT_H */
defs.h
spa/utils/defs.h
pw_direction_as_string
const char * pw_direction_as_string(enum pw_direction direction)
Convert a pw_direction to a readable string.
Definition: introspect.c:52
pw_port_info_free
void pw_port_info_free(struct pw_port_info *info)
Definition: introspect.c:308
pw_port_info_merge
struct pw_port_info * pw_port_info_merge(struct pw_port_info *info, const struct pw_port_info *update, bool reset)
Definition: introspect.c:253
pw_direction
#define pw_direction
The direction of a port.
Definition: port.h:63
pw_port_info_update
struct pw_port_info * pw_port_info_update(struct pw_port_info *info, const struct pw_port_info *update)
Definition: introspect.c:301
hook.h
spa/utils/hook.h
param.h
spa/param/param.h
proxy.h
pipewire/proxy.h
pw_port_events
Port events.
Definition: port.h:106
pw_port_events::info
void(* info)(void *object, const struct pw_port_info *info)
Notify port info.
Definition: port.h:115
pw_port_events::version
uint32_t version
Definition: port.h:109
pw_port_events::param
void(* param)(void *object, int seq, uint32_t id, uint32_t index, uint32_t next, const struct spa_pod *param)
Notify a port param.
Definition: port.h:127
pw_port_info
Definition: port.h:72
pw_port_info::n_params
uint32_t n_params
number of items in params
Definition: port.h:84
pw_port_info::params
struct spa_param_info * params
parameters
Definition: port.h:83
pw_port_info::change_mask
uint64_t change_mask
bitfield of changed fields since last call
Definition: port.h:81
pw_port_info::id
uint32_t id
id of the global
Definition: port.h:73
pw_port_info::direction
enum pw_direction direction
port direction
Definition: port.h:74
pw_port_methods
Port methods.
Definition: port.h:142
pw_port_methods::subscribe_params
int(* subscribe_params)(void *object, uint32_t *ids, uint32_t n_ids)
Subscribe to parameter changes.
Definition: port.h:160
pw_port_methods::version
uint32_t version
Definition: port.h:145
pw_port_methods::enum_params
int(* enum_params)(void *object, int seq, uint32_t id, uint32_t start, uint32_t num, const struct spa_pod *filter)
Enumerate port parameters.
Definition: port.h:174
pw_port_methods::add_listener
int(* add_listener)(void *object, struct spa_hook *listener, const struct pw_port_events *events, void *data)
Definition: port.h:147
pw_port
spa_dict
Definition: dict.h:59
spa_hook
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:342
spa_param_info
information about a parameter
Definition: param.h:70
spa_pod
Definition: pod.h:63