PipeWire  1.4.3
buffer.h
Go to the documentation of this file.
1 /* Simple Plugin API */
2 /* SPDX-FileCopyrightText: Copyright © 2018 Wim Taymans */
3 /* SPDX-License-Identifier: MIT */
4 
5 #ifndef SPA_BUFFER_H
6 #define SPA_BUFFER_H
7 
8 #ifdef __cplusplus
9 extern "C" {
10 #endif
11 
12 #include <spa/utils/defs.h>
13 #include <spa/buffer/meta.h>
14 
15 #ifndef SPA_API_BUFFER
16  #ifdef SPA_API_IMPL
17  #define SPA_API_BUFFER SPA_API_IMPL
18  #else
19  #define SPA_API_BUFFER static inline
20  #endif
21 #endif
22 
34 enum spa_data_type {
49 };
50 
52 struct spa_chunk {
53  uint32_t offset;
56  uint32_t size;
58  int32_t stride;
59 #define SPA_CHUNK_FLAG_NONE 0
60 #define SPA_CHUNK_FLAG_CORRUPTED (1u<<0)
61 #define SPA_CHUNK_FLAG_EMPTY (1u<<1)
64  int32_t flags;
65 };
66 
68 struct spa_data {
69  uint32_t type;
77 #define SPA_DATA_FLAG_NONE 0
78 #define SPA_DATA_FLAG_READABLE (1u<<0)
79 #define SPA_DATA_FLAG_WRITABLE (1u<<1)
80 #define SPA_DATA_FLAG_DYNAMIC (1u<<2)
81 #define SPA_DATA_FLAG_READWRITE (SPA_DATA_FLAG_READABLE|SPA_DATA_FLAG_WRITABLE)
82 #define SPA_DATA_FLAG_MAPPABLE (1u<<3)
85  uint32_t flags;
86  int64_t fd;
87  uint32_t mapoffset;
88  uint32_t maxsize;
89  void *data;
90  struct spa_chunk *chunk;
91 };
92 
94 struct spa_buffer {
95  uint32_t n_metas;
96  uint32_t n_datas;
97  struct spa_meta *metas;
98  struct spa_data *datas;
99 };
100 
102 SPA_API_BUFFER struct spa_meta *spa_buffer_find_meta(const struct spa_buffer *b, uint32_t type)
103 {
104  uint32_t i;
105 
106  for (i = 0; i < b->n_metas; i++)
107  if (b->metas[i].type == type)
108  return &b->metas[i];
109 
110  return NULL;
111 }
112 
113 SPA_API_BUFFER void *spa_buffer_find_meta_data(const struct spa_buffer *b, uint32_t type, size_t size)
114 {
115  struct spa_meta *m;
116  if ((m = spa_buffer_find_meta(b, type)) && m->size >= size)
117  return m->data;
118  return NULL;
119 }
120 
125 #ifdef __cplusplus
126 } /* extern "C" */
127 #endif
128 
129 #endif /* SPA_BUFFER_H */
#define SPA_API_BUFFER
Definition: buffer.h:26
spa/utils/defs.h
SPA_API_BUFFER void * spa_buffer_find_meta_data(const struct spa_buffer *b, uint32_t type, size_t size)
Definition: buffer.h:129
SPA_API_BUFFER struct spa_meta * spa_buffer_find_meta(const struct spa_buffer *b, uint32_t type)
Find metadata in a buffer.
Definition: buffer.h:118
spa_data_type
Definition: buffer.h:41
@ _SPA_DATA_LAST
not part of ABI
Definition: buffer.h:55
@ SPA_DATA_MemFd
memfd, mmap to get to memory.
Definition: buffer.h:45
@ SPA_DATA_MemPtr
pointer to memory, the data field in struct spa_data is set.
Definition: buffer.h:43
@ SPA_DATA_SyncObj
a syncobj, usually requires a spa_meta_sync_timeline metadata with timeline points.
Definition: buffer.h:52
@ SPA_DATA_Invalid
Definition: buffer.h:42
@ SPA_DATA_MemId
memory is identified with an id.
Definition: buffer.h:49
@ SPA_DATA_DmaBuf
fd to dmabuf memory.
Definition: buffer.h:46
spa/buffer/meta.h
A Buffer.
Definition: buffer.h:110
uint32_t n_metas
number of metadata
Definition: buffer.h:111
struct spa_meta * metas
array of metadata
Definition: buffer.h:113
struct spa_data * datas
array of data members
Definition: buffer.h:114
uint32_t n_datas
number of data members
Definition: buffer.h:112
Chunk of memory, can change for each buffer.
Definition: buffer.h:59
int32_t stride
stride of valid data
Definition: buffer.h:65
uint32_t size
size of valid data.
Definition: buffer.h:63
int32_t flags
chunk flags
Definition: buffer.h:74
uint32_t offset
offset of valid data.
Definition: buffer.h:60
Data for a buffer this stays constant for a buffer.
Definition: buffer.h:78
struct spa_chunk * chunk
valid chunk of memory
Definition: buffer.h:106
int64_t fd
optional fd for data
Definition: buffer.h:102
uint32_t mapoffset
offset to map fd at, this is page aligned
Definition: buffer.h:103
uint32_t flags
data flags
Definition: buffer.h:101
void * data
optional data pointer
Definition: buffer.h:105
uint32_t maxsize
max size of data
Definition: buffer.h:104
uint32_t type
memory type, one of enum spa_data_type, when allocating memory, the type contains a bitmask of allowe...
Definition: buffer.h:79
A metadata element.
Definition: meta.h:58
uint32_t size
size of metadata
Definition: meta.h:60
uint32_t type
metadata type, one of enum spa_meta_type
Definition: meta.h:59
void * data
pointer to metadata
Definition: meta.h:61