mirror of
https://gitlab.freedesktop.org/pipewire/pipewire.git
synced 2025-10-29 05:40:27 -04:00
9bb5780cc2
Change the GenericFd data type to SyncObj. It's probably better to explicitly state the data type than to make something generic. Otherwise we would need to transfer the specific fd type somewhere else and there is no room for that in the buffer and the the metadata is not a good idea either because it can be modified and corrupted at runtime. Add the SyncTimeline metadata. This contains 2 points on two timelines (SyncObj datas in the buffer). The buffer can be accessed when the acquire_point is signaled on the timeline and when the buffer can be released, the release_point on the timeline should be signaled.
121 lines
3.9 KiB
C
121 lines
3.9 KiB
C
/* Simple Plugin API */
|
|
/* SPDX-FileCopyrightText: Copyright © 2018 Wim Taymans */
|
|
/* SPDX-License-Identifier: MIT */
|
|
|
|
#ifndef SPA_BUFFER_H
|
|
#define SPA_BUFFER_H
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include <spa/utils/defs.h>
|
|
#include <spa/buffer/meta.h>
|
|
|
|
/** \defgroup spa_buffer Buffers
|
|
*
|
|
* Buffers describe the data and metadata that is exchanged between
|
|
* ports of a node.
|
|
*/
|
|
|
|
/**
|
|
* \addtogroup spa_buffer
|
|
* \{
|
|
*/
|
|
|
|
enum spa_data_type {
|
|
SPA_DATA_Invalid,
|
|
SPA_DATA_MemPtr, /**< pointer to memory, the data field in
|
|
* struct spa_data is set. */
|
|
SPA_DATA_MemFd, /**< memfd, mmap to get to memory. */
|
|
SPA_DATA_DmaBuf, /**< fd to dmabuf memory. This might not be readily
|
|
* mappable (unless the MAPPABLE flag is set) and should
|
|
* normally be handled with DMABUF apis. */
|
|
SPA_DATA_MemId, /**< memory is identified with an id. The actual memory
|
|
* can be obtained in some other way and can be identified
|
|
* with this id. */
|
|
SPA_DATA_SyncObj, /**< a syncobj, usually requires a spa_meta_sync_timeline metadata
|
|
* with timeline points. */
|
|
|
|
_SPA_DATA_LAST, /**< not part of ABI */
|
|
};
|
|
|
|
/** Chunk of memory, can change for each buffer */
|
|
struct spa_chunk {
|
|
uint32_t offset; /**< offset of valid data. Should be taken
|
|
* modulo the data maxsize to get the offset
|
|
* in the data memory. */
|
|
uint32_t size; /**< size of valid data. Should be clamped to
|
|
* maxsize. */
|
|
int32_t stride; /**< stride of valid data */
|
|
#define SPA_CHUNK_FLAG_NONE 0
|
|
#define SPA_CHUNK_FLAG_CORRUPTED (1u<<0) /**< chunk data is corrupted in some way */
|
|
#define SPA_CHUNK_FLAG_EMPTY (1u<<1) /**< chunk data is empty with media specific
|
|
* neutral data such as silence or black. This
|
|
* could be used to optimize processing. */
|
|
int32_t flags; /**< chunk flags */
|
|
};
|
|
|
|
/** Data for a buffer this stays constant for a buffer */
|
|
struct spa_data {
|
|
uint32_t type; /**< memory type, one of enum spa_data_type, when
|
|
* allocating memory, the type contains a bitmask
|
|
* of allowed types. SPA_ID_INVALID is a special
|
|
* value for the allocator to indicate that the
|
|
* other side did not explicitly specify any
|
|
* supported data types. It should probably use
|
|
* a memory type that does not require special
|
|
* handling in addition to simple mmap/munmap. */
|
|
#define SPA_DATA_FLAG_NONE 0
|
|
#define SPA_DATA_FLAG_READABLE (1u<<0) /**< data is readable */
|
|
#define SPA_DATA_FLAG_WRITABLE (1u<<1) /**< data is writable */
|
|
#define SPA_DATA_FLAG_DYNAMIC (1u<<2) /**< data pointer can be changed */
|
|
#define SPA_DATA_FLAG_READWRITE (SPA_DATA_FLAG_READABLE|SPA_DATA_FLAG_WRITABLE)
|
|
#define SPA_DATA_FLAG_MAPPABLE (1u<<3) /**< data is mappable with simple mmap/munmap. Some memory
|
|
* types are not simply mappable (DmaBuf) unless explicitly
|
|
* specified with this flag. */
|
|
uint32_t flags; /**< data flags */
|
|
int64_t fd; /**< optional fd for data */
|
|
uint32_t mapoffset; /**< offset to map fd at */
|
|
uint32_t maxsize; /**< max size of data */
|
|
void *data; /**< optional data pointer */
|
|
struct spa_chunk *chunk; /**< valid chunk of memory */
|
|
};
|
|
|
|
/** A Buffer */
|
|
struct spa_buffer {
|
|
uint32_t n_metas; /**< number of metadata */
|
|
uint32_t n_datas; /**< number of data members */
|
|
struct spa_meta *metas; /**< array of metadata */
|
|
struct spa_data *datas; /**< array of data members */
|
|
};
|
|
|
|
/** Find metadata in a buffer */
|
|
static inline struct spa_meta *spa_buffer_find_meta(const struct spa_buffer *b, uint32_t type)
|
|
{
|
|
uint32_t i;
|
|
|
|
for (i = 0; i < b->n_metas; i++)
|
|
if (b->metas[i].type == type)
|
|
return &b->metas[i];
|
|
|
|
return NULL;
|
|
}
|
|
|
|
static inline void *spa_buffer_find_meta_data(const struct spa_buffer *b, uint32_t type, size_t size)
|
|
{
|
|
struct spa_meta *m;
|
|
if ((m = spa_buffer_find_meta(b, type)) && m->size >= size)
|
|
return m->data;
|
|
return NULL;
|
|
}
|
|
|
|
/**
|
|
* \}
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
} /* extern "C" */
|
|
#endif
|
|
|
|
#endif /* SPA_BUFFER_H */
|