mirror of
https://gitlab.freedesktop.org/pipewire/pipewire.git
synced 2026-03-30 11:10:29 -04:00
941fc5f51c
Add a new SPA_TYPE_OBJECT_ParamDict object that contains a struct with key/value pairs. We're using something similar for Tags but this is a more generic version. Make a new Capability param that uses the ParamDict object. This is meant to be used to describe capabilities with the generic key/value struct. Make a new PeerParam object where the keys are generic ids of the peer objects and the values any Pod. The idea is to use this object to store a peer objects. Make some helpers to iterate the peers and their objects. Add a new PeerCapability param that uses the PeerParam object with Capability objects. This can be used to send the collection of Capabilities from all peers to a port. This is a bit like the tags but in a more generic way. The tags could also be implemented in this new generic way later. Make the PeerFormats use the same PeerParam of Format objects. The Capability param is set on ports. impl-link will collect all Capability objects into a PeerCapability object and send this to the peer. The difference with the Tag param is that these Capability params are not in any way forwared on the node automatically (like what is done in the loopback module) because they represent the capabilities of the ports betweem the link.
93 lines
3.4 KiB
C
93 lines
3.4 KiB
C
/* Simple Plugin API */
|
|
/* SPDX-FileCopyrightText: Copyright © 2018 Wim Taymans */
|
|
/* SPDX-License-Identifier: MIT */
|
|
|
|
#ifndef SPA_PARAM_H
|
|
#define SPA_PARAM_H
|
|
|
|
#include <spa/utils/defs.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/** \defgroup spa_param Parameters
|
|
* Parameter value enumerations and type information
|
|
*/
|
|
|
|
/**
|
|
* \addtogroup spa_param
|
|
* \{
|
|
*/
|
|
|
|
/** different parameter types that can be queried */
|
|
enum spa_param_type {
|
|
SPA_PARAM_Invalid, /**< invalid */
|
|
SPA_PARAM_PropInfo, /**< property information as SPA_TYPE_OBJECT_PropInfo */
|
|
SPA_PARAM_Props, /**< properties as SPA_TYPE_OBJECT_Props */
|
|
SPA_PARAM_EnumFormat, /**< available formats as SPA_TYPE_OBJECT_Format */
|
|
SPA_PARAM_Format, /**< configured format as SPA_TYPE_OBJECT_Format */
|
|
SPA_PARAM_Buffers, /**< buffer configurations as SPA_TYPE_OBJECT_ParamBuffers*/
|
|
SPA_PARAM_Meta, /**< allowed metadata for buffers as SPA_TYPE_OBJECT_ParamMeta*/
|
|
SPA_PARAM_IO, /**< configurable IO areas as SPA_TYPE_OBJECT_ParamIO */
|
|
SPA_PARAM_EnumProfile, /**< profile enumeration as SPA_TYPE_OBJECT_ParamProfile */
|
|
SPA_PARAM_Profile, /**< profile configuration as SPA_TYPE_OBJECT_ParamProfile */
|
|
SPA_PARAM_EnumPortConfig, /**< port configuration enumeration as SPA_TYPE_OBJECT_ParamPortConfig */
|
|
SPA_PARAM_PortConfig, /**< port configuration as SPA_TYPE_OBJECT_ParamPortConfig */
|
|
SPA_PARAM_EnumRoute, /**< routing enumeration as SPA_TYPE_OBJECT_ParamRoute */
|
|
SPA_PARAM_Route, /**< routing configuration as SPA_TYPE_OBJECT_ParamRoute */
|
|
SPA_PARAM_Control, /**< Control parameter, a SPA_TYPE_Sequence */
|
|
SPA_PARAM_Latency, /**< latency reporting, a SPA_TYPE_OBJECT_ParamLatency */
|
|
SPA_PARAM_ProcessLatency, /**< processing latency, a SPA_TYPE_OBJECT_ParamProcessLatency */
|
|
SPA_PARAM_Tag, /**< tag reporting, a SPA_TYPE_OBJECT_ParamTag. Since 0.3.79 */
|
|
SPA_PARAM_PeerEnumFormat, /**< peer formats, a SPA_TYPE_OBJECT_PeerParam with
|
|
* SPA_TYPE_OBJECT_Format. Since 1.5.0 */
|
|
SPA_PARAM_Capability, /**< capability info, a SPA_TYPE_OBJECT_ParamDict, Since 1.5.84 */
|
|
SPA_PARAM_PeerCapability, /**< peer capabilities, a SPA_TYPE_OBJECT_PeerParam with
|
|
* SPA_TYPE_OBJECT_ParamDict, since 1.5.84 */
|
|
};
|
|
|
|
/** information about a parameter */
|
|
struct spa_param_info {
|
|
uint32_t id; /**< enum spa_param_type */
|
|
#define SPA_PARAM_INFO_SERIAL (1<<0) /**< bit to signal update even when the
|
|
* read/write flags don't change */
|
|
#define SPA_PARAM_INFO_READ (1<<1)
|
|
#define SPA_PARAM_INFO_WRITE (1<<2)
|
|
#define SPA_PARAM_INFO_READWRITE (SPA_PARAM_INFO_WRITE|SPA_PARAM_INFO_READ)
|
|
uint32_t flags;
|
|
uint32_t user; /**< private user field. You can use this to keep
|
|
* state. */
|
|
int32_t seq; /**< private seq field. You can use this to keep
|
|
* state of a pending update. */
|
|
uint32_t padding[4];
|
|
};
|
|
|
|
#define SPA_PARAM_INFO(id,flags) ((struct spa_param_info){ (id), (flags) })
|
|
|
|
enum spa_param_bitorder {
|
|
SPA_PARAM_BITORDER_unknown, /**< unknown bitorder */
|
|
SPA_PARAM_BITORDER_msb, /**< most significant bit */
|
|
SPA_PARAM_BITORDER_lsb, /**< least significant bit */
|
|
};
|
|
|
|
enum spa_param_availability {
|
|
SPA_PARAM_AVAILABILITY_unknown, /**< unknown availability */
|
|
SPA_PARAM_AVAILABILITY_no, /**< not available */
|
|
SPA_PARAM_AVAILABILITY_yes, /**< available */
|
|
};
|
|
|
|
#include <spa/param/buffers.h>
|
|
#include <spa/param/profile.h>
|
|
#include <spa/param/port-config.h>
|
|
#include <spa/param/route.h>
|
|
|
|
/**
|
|
* \}
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
} /* extern "C" */
|
|
#endif
|
|
|
|
#endif /* SPA_PARAM_H */
|