PipeWire 1.2.6
Loading...
Searching...
No Matches
io.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_IO_H
6#define SPA_IO_H
7
8#ifdef __cplusplus
9extern "C" {
10#endif
11
17#include <spa/utils/defs.h>
18#include <spa/pod/pod.h>
19
31enum spa_io_type {
75struct spa_io_buffers {
76#define SPA_STATUS_OK 0
77#define SPA_STATUS_NEED_DATA (1<<0)
78#define SPA_STATUS_HAVE_DATA (1<<1)
79#define SPA_STATUS_STOPPED (1<<2)
80#define SPA_STATUS_DRAINED (1<<3)
81 int32_t status;
82 uint32_t buffer_id;
83};
85#define SPA_IO_BUFFERS_INIT ((struct spa_io_buffers) { SPA_STATUS_OK, SPA_ID_INVALID, })
91 int32_t status;
92 uint32_t size;
93 void *data;
94};
95#define SPA_IO_MEMORY_INIT ((struct spa_io_memory) { SPA_STATUS_OK, 0, NULL, })
98struct spa_io_range {
99 uint64_t offset;
100 uint32_t min_size;
101 uint32_t max_size;
127struct spa_io_clock {
128#define SPA_IO_CLOCK_FLAG_FREEWHEEL (1u<<0) /* graph is freewheeling */
129#define SPA_IO_CLOCK_FLAG_XRUN_RECOVER (1u<<1) /* recovering from xrun */
130 uint32_t flags;
131 uint32_t id;
132 char name[64];
135 uint64_t nsec;
138 struct spa_fraction rate;
139 uint64_t position;
140 uint64_t duration;
141 int64_t delay;
142 double rate_diff;
144 uint64_t next_nsec;
150 uint64_t target_duration;
151 uint32_t target_seq;
153 uint32_t cycle;
154 uint64_t xrun;
157/* the size of the video in this cycle */
159#define SPA_IO_VIDEO_SIZE_VALID (1<<0)
160 uint32_t flags;
161 uint32_t stride;
162 struct spa_rectangle size;
166 uint32_t padding[4];
176 uint64_t min;
177 uint64_t max;
179
183};
184
186struct spa_io_segment_bar {
187#define SPA_IO_SEGMENT_BAR_FLAG_VALID (1<<0)
188 uint32_t flags;
189 uint32_t offset;
192 double bpm;
193 double beat;
194 double bar_start_tick;
195 double ticks_per_beat;
196 uint32_t padding[4];
198
201#define SPA_IO_SEGMENT_VIDEO_FLAG_VALID (1<<0)
202#define SPA_IO_SEGMENT_VIDEO_FLAG_DROP_FRAME (1<<1)
203#define SPA_IO_SEGMENT_VIDEO_FLAG_PULL_DOWN (1<<2)
204#define SPA_IO_SEGMENT_VIDEO_FLAG_INTERLACED (1<<3)
205 uint32_t flags;
206 uint32_t offset;
208 uint32_t hours;
209 uint32_t minutes;
210 uint32_t seconds;
211 uint32_t frames;
212 uint32_t field_count;
213 uint32_t padding[11];
214};
215
236struct spa_io_segment {
237 uint32_t version;
238#define SPA_IO_SEGMENT_FLAG_LOOPING (1<<0)
239#define SPA_IO_SEGMENT_FLAG_NO_POSITION (1<<1)
243 uint32_t flags;
244 uint64_t start;
248 uint64_t duration;
253 double rate;
255 uint64_t position;
262
267};
268
270#define SPA_IO_POSITION_MAX_SEGMENTS 8
271
289struct spa_io_position {
290 struct spa_io_clock clock;
292 struct spa_io_video_size video;
293 int64_t offset;
298 uint32_t state;
300 uint32_t n_segments;
302};
303
305struct spa_io_rate_match {
306 uint32_t delay;
307 uint32_t size;
308 double rate;
309#define SPA_IO_RATE_MATCH_FLAG_ACTIVE (1 << 0)
310 uint32_t flags;
311 uint32_t padding[7];
318};
319
324#ifdef __cplusplus
325} /* extern "C" */
326#endif
327
328#endif /* SPA_IO_H */
spa/utils/defs.h
spa_io_position_state
Definition io.h:285
spa_io_type
IO areas.
Definition io.h:36
#define SPA_IO_POSITION_MAX_SEGMENTS
the maximum number of segments visible in the future
Definition io.h:293
@ SPA_IO_POSITION_STATE_RUNNING
Definition io.h:288
@ SPA_IO_POSITION_STATE_STOPPED
Definition io.h:286
@ SPA_IO_POSITION_STATE_STARTING
Definition io.h:287
@ SPA_IO_AsyncBuffers
async area to exchange buffers, struct spa_io_async_buffers
Definition io.h:48
@ SPA_IO_Notify
area for notify messages, struct spa_io_sequence
Definition io.h:44
@ SPA_IO_Memory
memory pointer, struct spa_io_memory (currently not used in PipeWire)
Definition io.h:47
@ SPA_IO_Clock
area to update clock information, struct spa_io_clock
Definition io.h:40
@ SPA_IO_Control
area for control messages, struct spa_io_sequence
Definition io.h:43
@ SPA_IO_Latency
latency reporting, struct spa_io_latency (currently not used in PipeWire).
Definition io.h:41
@ SPA_IO_Range
expected byte range, struct spa_io_range (currently not used in PipeWire)
Definition io.h:39
@ SPA_IO_Invalid
Definition io.h:37
@ SPA_IO_Position
position information in the graph, struct spa_io_position
Definition io.h:45
@ SPA_IO_Buffers
area to exchange buffers, struct spa_io_buffers
Definition io.h:38
@ SPA_IO_RateMatch
rate matching between nodes, struct spa_io_rate_match
Definition io.h:46
spa/pod/pod.h
Definition defs.h:137
async buffers
Definition io.h:339
struct spa_io_buffers buffers[2]
async buffers, writers write to current (cycle+1)&1, readers read from (cycle)&1
Definition io.h:340
IO area to exchange buffers.
Definition io.h:80
int32_t status
the status code
Definition io.h:91
uint32_t buffer_id
a buffer id
Definition io.h:92
Absolute time reporting.
Definition io.h:139
struct spa_fraction target_rate
Target rate of next cycle.
Definition io.h:163
uint64_t next_nsec
Estimated next wakeup time in nanoseconds.
Definition io.h:158
uint64_t xrun
Estimated accumulated xrun duration.
Definition io.h:168
uint64_t position
Current position, in samples @ rate.
Definition io.h:153
uint32_t cycle
incremented each time the graph is started
Definition io.h:167
uint64_t nsec
Time in nanoseconds against monotonic clock (CLOCK_MONOTONIC).
Definition io.h:149
struct spa_fraction rate
Rate for position/duration/delay/xrun.
Definition io.h:152
double rate_diff
Rate difference between clock and monotonic time, as a ratio of clock speeds.
Definition io.h:156
uint32_t flags
Clock flags.
Definition io.h:144
uint32_t id
Unique clock id, set by host application.
Definition io.h:145
uint64_t target_duration
Target duration of next cycle.
Definition io.h:164
uint64_t duration
Duration of current cycle, in samples @ rate.
Definition io.h:154
int64_t delay
Delay between position and hardware, in samples @ rate.
Definition io.h:155
uint32_t target_seq
Seq counter.
Definition io.h:165
Latency reporting.
Definition io.h:189
uint64_t min
min latency
Definition io.h:191
uint64_t max
max latency
Definition io.h:192
struct spa_fraction rate
rate for min/max
Definition io.h:190
IO area to exchange a memory region.
Definition io.h:101
void * data
a memory pointer
Definition io.h:104
uint32_t size
the size of data
Definition io.h:103
The position information adds extra meaning to the raw clock times.
Definition io.h:312
struct spa_io_clock clock
clock position of driver, always valid and read only
Definition io.h:313
struct spa_io_video_size video
size of the video in the current cycle
Definition io.h:315
uint32_t state
one of enum spa_io_position_state
Definition io.h:321
uint32_t n_segments
number of segments
Definition io.h:323
struct spa_io_segment segments[SPA_IO_POSITION_MAX_SEGMENTS]
segments
Definition io.h:324
int64_t offset
an offset to subtract from the clock position to get a running time.
Definition io.h:316
A range, suitable for input ports that can suggest a range to output ports.
Definition io.h:110
uint64_t offset
offset in range
Definition io.h:111
uint32_t max_size
maximum size of data
Definition io.h:113
uint32_t min_size
minimum size of data
Definition io.h:112
rate matching
Definition io.h:328
uint32_t padding[7]
Definition io.h:335
uint32_t flags
extra flags
Definition io.h:334
double rate
rate for resampler
Definition io.h:331
uint32_t delay
extra delay in samples for resampler
Definition io.h:329
uint32_t size
requested input size for resampler
Definition io.h:330
bar and beat segment
Definition io.h:201
double beat
current beat in segment
Definition io.h:209
uint32_t padding[4]
Definition io.h:212
double bpm
beats per minute
Definition io.h:208
float signature_denom
time signature denominator
Definition io.h:207
double ticks_per_beat
Definition io.h:211
double bar_start_tick
Definition io.h:210
uint32_t offset
offset in segment of this beat
Definition io.h:205
float signature_num
time signature numerator
Definition io.h:206
uint32_t flags
extra flags
Definition io.h:204
video frame segment
Definition io.h:216
uint32_t seconds
Definition io.h:230
struct spa_fraction framerate
Definition io.h:227
uint32_t field_count
0 for progressive, 1 and 2 for interlaced
Definition io.h:232
uint32_t flags
flags
Definition io.h:225
uint32_t hours
Definition io.h:228
uint32_t minutes
Definition io.h:229
uint32_t padding[11]
Definition io.h:233
uint32_t frames
Definition io.h:231
uint32_t offset
offset in segment
Definition io.h:226
A segment converts a running time to a segment (stream) position.
Definition io.h:256
uint64_t duration
duration when this info becomes invalid expressed in running time.
Definition io.h:270
uint32_t flags
extra flags
Definition io.h:265
uint64_t position
The position when the running time == start.
Definition io.h:277
double rate
overall rate of the segment, can be negative for backwards time reporting.
Definition io.h:275
struct spa_io_segment_video video
Definition io.h:282
struct spa_io_segment_bar bar
Definition io.h:281
uint32_t version
Definition io.h:257
control stream, io area for SPA_IO_Control and SPA_IO_Notify
Definition io.h:196
struct spa_pod_sequence sequence
sequence of timed events
Definition io.h:197
Definition io.h:172
struct spa_fraction framerate
the minimum framerate, the cycle duration is always smaller to ensure there is only one video frame p...
Definition io.h:178
uint32_t padding[4]
Definition io.h:181
uint32_t stride
video stride in bytes
Definition io.h:176
uint32_t flags
optional flags
Definition io.h:175
struct spa_rectangle size
the video size
Definition io.h:177
a sequence of timed controls
Definition pod.h:248
Definition defs.h:116