PipeWire  1.0.1
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  uint32_t flags;
69  int64_t fd;
70  uint32_t mapoffset;
71  uint32_t maxsize;
72  void *data;
73  struct spa_chunk *chunk;
74 };
75 
77 struct spa_buffer {
78  uint32_t n_metas;
79  uint32_t n_datas;
80  struct spa_meta *metas;
81  struct spa_data *datas;
82 };
83 
85 static inline struct spa_meta *spa_buffer_find_meta(const struct spa_buffer *b, uint32_t type)
86 {
87  uint32_t i;
88 
89  for (i = 0; i < b->n_metas; i++)
90  if (b->metas[i].type == type)
91  return &b->metas[i];
92 
93  return NULL;
94 }
95 
96 static inline void *spa_buffer_find_meta_data(const struct spa_buffer *b, uint32_t type, size_t size)
97 {
98  struct spa_meta *m;
99  if ((m = spa_buffer_find_meta(b, type)) && m->size >= size)
100  return m->data;
101  return NULL;
102 }
103 
108 #ifdef __cplusplus
109 } /* extern "C" */
110 #endif
112 #endif /* SPA_BUFFER_H */
spa/buffer/meta.h
struct spa_meta * metas
array of metadata
Definition: buffer.h:95
static struct spa_meta * spa_buffer_find_meta(const struct spa_buffer *b, uint32_t type)
Find metadata in a buffer.
Definition: buffer.h:100
spa/utils/defs.h
int32_t stride
stride of valid data
Definition: buffer.h:49
uint32_t offset
offset of valid data.
Definition: buffer.h:44
not part of ABI
Definition: buffer.h:39
fd to dmabuf memory
Definition: buffer.h:36
pointer to memory, the data field in struct spa_data is set.
Definition: buffer.h:33
spa_data_type
Definition: buffer.h:31
A Buffer.
Definition: buffer.h:92
uint32_t type
metadata type, one of enum spa_meta_type
Definition: meta.h:48
Data for a buffer this stays constant for a buffer.
Definition: buffer.h:64
Definition: buffer.h:32
generic fd, mmap to get to memory
Definition: buffer.h:35
uint32_t size
size of valid data.
Definition: buffer.h:47
int32_t flags
chunk flags
Definition: buffer.h:60
Chunk of memory, can change for each buffer.
Definition: buffer.h:43
uint32_t n_metas
number of metadata
Definition: buffer.h:93
uint32_t size
size of metadata
Definition: meta.h:49
memory is identified with an id
Definition: buffer.h:37
static void * spa_buffer_find_meta_data(const struct spa_buffer *b, uint32_t type, size_t size)
Definition: buffer.h:111
void * data
pointer to metadata
Definition: meta.h:50
A metadata element.
Definition: meta.h:47