PipeWire  1.0.4
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 
26 enum spa_data_type {
35 };
36 
38 struct spa_chunk {
39  uint32_t offset;
42  uint32_t size;
44  int32_t stride;
45 #define SPA_CHUNK_FLAG_NONE 0
46 #define SPA_CHUNK_FLAG_CORRUPTED (1u<<0)
47 #define SPA_CHUNK_FLAG_EMPTY (1u<<1)
50  int32_t flags;
51 };
52 
54 struct spa_data {
55  uint32_t type;
63 #define SPA_DATA_FLAG_NONE 0
64 #define SPA_DATA_FLAG_READABLE (1u<<0)
65 #define SPA_DATA_FLAG_WRITABLE (1u<<1)
66 #define SPA_DATA_FLAG_DYNAMIC (1u<<2)
67 #define SPA_DATA_FLAG_READWRITE (SPA_DATA_FLAG_READABLE|SPA_DATA_FLAG_WRITABLE)
68 #define SPA_DATA_FLAG_MAPPABLE (1u<<3)
71  uint32_t flags;
72  int64_t fd;
73  uint32_t mapoffset;
74  uint32_t maxsize;
75  void *data;
76  struct spa_chunk *chunk;
77 };
78 
80 struct spa_buffer {
81  uint32_t n_metas;
82  uint32_t n_datas;
83  struct spa_meta *metas;
84  struct spa_data *datas;
85 };
86 
88 static inline struct spa_meta *spa_buffer_find_meta(const struct spa_buffer *b, uint32_t type)
89 {
90  uint32_t i;
91 
92  for (i = 0; i < b->n_metas; i++)
93  if (b->metas[i].type == type)
94  return &b->metas[i];
95 
96  return NULL;
97 }
98 
99 static inline void *spa_buffer_find_meta_data(const struct spa_buffer *b, uint32_t type, size_t size)
100 {
101  struct spa_meta *m;
102  if ((m = spa_buffer_find_meta(b, type)) && m->size >= size)
103  return m->data;
104  return NULL;
105 }
106 
111 #ifdef __cplusplus
112 } /* extern "C" */
113 #endif
114 
115 #endif /* SPA_BUFFER_H */
spa/utils/defs.h
static void * spa_buffer_find_meta_data(const struct spa_buffer *b, uint32_t type, size_t size)
Definition: buffer.h:113
static struct spa_meta * spa_buffer_find_meta(const struct spa_buffer *b, uint32_t type)
Find metadata in a buffer.
Definition: buffer.h:102
spa_data_type
Definition: buffer.h:31
@ _SPA_DATA_LAST
not part of ABI
Definition: buffer.h:39
@ SPA_DATA_MemFd
generic fd, mmap to get to memory
Definition: buffer.h:35
@ SPA_DATA_MemPtr
pointer to memory, the data field in struct spa_data is set.
Definition: buffer.h:33
@ SPA_DATA_Invalid
Definition: buffer.h:32
@ SPA_DATA_MemId
memory is identified with an id
Definition: buffer.h:37
@ SPA_DATA_DmaBuf
fd to dmabuf memory
Definition: buffer.h:36
spa/buffer/meta.h
A Buffer.
Definition: buffer.h:94
uint32_t n_metas
number of metadata
Definition: buffer.h:95
struct spa_meta * metas
array of metadata
Definition: buffer.h:97
struct spa_data * datas
array of data members
Definition: buffer.h:98
uint32_t n_datas
number of data members
Definition: buffer.h:96
Chunk of memory, can change for each buffer.
Definition: buffer.h:43
int32_t stride
stride of valid data
Definition: buffer.h:49
uint32_t size
size of valid data.
Definition: buffer.h:47
int32_t flags
chunk flags
Definition: buffer.h:58
uint32_t offset
offset of valid data.
Definition: buffer.h:44
Data for a buffer this stays constant for a buffer.
Definition: buffer.h:62
struct spa_chunk * chunk
valid chunk of memory
Definition: buffer.h:90
int64_t fd
optional fd for data
Definition: buffer.h:86
uint32_t mapoffset
offset to map fd at
Definition: buffer.h:87
uint32_t flags
data flags
Definition: buffer.h:85
void * data
optional data pointer
Definition: buffer.h:89
uint32_t maxsize
max size of data
Definition: buffer.h:88
uint32_t type
memory type, one of enum spa_data_type, when allocating memory, the type contains a bitmask of allowe...
Definition: buffer.h:63
A metadata element.
Definition: meta.h:47
uint32_t size
size of metadata
Definition: meta.h:49
uint32_t type
metadata type, one of enum spa_meta_type
Definition: meta.h:48
void * data
pointer to metadata
Definition: meta.h:50