PipeWire: video-src-sync.c

PipeWire 1.6.8

Loading...
Searching...
No Matches
video-src-sync.c

Video source using Stream and sync_timeline.

Video source using Stream and sync_timeline.

/* PipeWire */
/* SPDX-FileCopyrightText: Copyright © 2025 Wim Taymans */
/* SPDX-License-Identifier: MIT */
/*
[title]
Video source using \ref pw_stream and sync_timeline.
[title]
*/
#include "config.h"
#include <stdio.h>
#include <errno.h>
#include <signal.h>
#include <math.h>
#include <unistd.h>
#include <fcntl.h>
#include <sys/mman.h>
#include <sys/eventfd.h>
#include <getopt.h>
#include <spa/param/video/format-utils.h>
#include <spa/param/tag-utils.h>
#include <spa/debug/pod.h>
#include <spa/debug/format.h>
#include <pipewire/pipewire.h>
#define BPP 4
#define CURSOR_WIDTH 64
#define CURSOR_HEIGHT 64
#define CURSOR_BPP 4
#define MAX_BUFFERS 64
#define M_PI_M2 ( M_PI + M_PI )
struct data {
struct pw_main_loop *loop;
struct spa_source *timer;
struct pw_context *context;
struct pw_core *core;
struct pw_stream *stream;
struct spa_hook stream_listener;
struct spa_video_info_raw format;
int32_t stride;
int counter;
uint32_t seq;
uint32_t n_buffers;
int res;
bool with_synctimeline;
bool with_synctimeline_release;
bool force_synctimeline_release;
};
static void on_process(void *userdata)
{
struct data *data = userdata;
struct pw_buffer *b;
struct spa_buffer *buf;
uint32_t i, j;
uint8_t *p;
struct spa_meta_header *h;
struct spa_meta_sync_timeline *stl;
uint64_t cmd;
if ((b = pw_stream_dequeue_buffer(data->stream)) == NULL) {
pw_log_warn("out of buffers: %m");
return;
}
buf = b->buffer;
if ((p = buf->datas[0].data) == NULL)
return;
if ((h = spa_buffer_find_meta_data(buf, SPA_META_Header, sizeof(*h)))) {
#if 0
h->pts = pw_stream_get_nsec(data->stream);
#else
h->pts = -1;
#endif
h->flags = 0;
h->seq = data->seq++;
h->dts_offset = 0;
}
if ((stl = spa_buffer_find_meta_data(buf, SPA_META_SyncTimeline, sizeof(*stl))) &&
stl->release_point) {
if (!SPA_FLAG_IS_SET(stl->flags, SPA_META_SYNC_TIMELINE_UNSCHEDULED_RELEASE)) {
/* The other end promised to schedule the release point, wait before we
* can use the buffer */
if (read(buf->datas[2].fd, &cmd, sizeof(cmd)) < 0)
pw_log_warn("release_point wait error %m");
pw_log_debug("release_point:%"PRIu64, stl->release_point);
} else if (spa_buffer_has_meta_features(buf, SPA_META_SyncTimeline,
SPA_META_FEATURE_SYNC_TIMELINE_RELEASE)) {
/* this happens when the other end did not get the buffer or
* will not trigger the release point, There is no point waiting,
* we can use the buffer right away */
pw_log_warn("release_point not scheduled:%"PRIu64, stl->release_point);
} else {
/* The other end does not support the RELEASE flag, we don't
* know if the buffer was used or not or if the release point will
* ever be scheduled, we must assume we can reuse the buffer */
pw_log_debug("assume buffer was released:%"PRIu64, stl->release_point);
}
}
for (i = 0; i < data->format.size.height; i++) {
for (j = 0; j < data->format.size.width * BPP; j++)
p[j] = data->counter + j * i;
p += data->stride;
data->counter += 13;
}
buf->datas[0].chunk->offset = 0;
buf->datas[0].chunk->size = data->format.size.height * data->stride;
buf->datas[0].chunk->stride = data->stride;
if (stl) {
/* set the UNSCHEDULED_RELEASE flag, the consumer will clear this if
* it promises to signal the release point */
SPA_FLAG_SET(stl->flags, SPA_META_SYNC_TIMELINE_UNSCHEDULED_RELEASE);
cmd = 1;
stl->acquire_point = data->seq;
stl->release_point = data->seq;
/* write the acquire point */
write(buf->datas[1].fd, &cmd, sizeof(cmd));
}
pw_stream_queue_buffer(data->stream, b);
}
static void on_timeout(void *userdata, uint64_t expirations)
{
struct data *data = userdata;
pw_log_trace("timeout");
pw_stream_trigger_process(data->stream);
}
static void on_stream_state_changed(void *_data, enum pw_stream_state old, enum pw_stream_state state,
const char *error)
{
struct data *data = _data;
printf("stream state: \"%s\" %s\n", pw_stream_state_as_string(state), error ? error : "");
switch (state) {
case PW_STREAM_STATE_ERROR:
case PW_STREAM_STATE_UNCONNECTED:
pw_main_loop_quit(data->loop);
break;
case PW_STREAM_STATE_PAUSED:
printf("node id: %d\n", pw_stream_get_node_id(data->stream));
pw_loop_update_timer(pw_main_loop_get_loop(data->loop),
data->timer, NULL, NULL, false);
break;
case PW_STREAM_STATE_STREAMING:
{
struct timespec timeout, interval;
timeout.tv_sec = 0;
timeout.tv_nsec = 1;
interval.tv_sec = 0;
interval.tv_nsec = 40 * SPA_NSEC_PER_MSEC;
printf("driving:%d\n", pw_stream_is_driving(data->stream));
if (pw_stream_is_driving(data->stream))
pw_loop_update_timer(pw_main_loop_get_loop(data->loop),
data->timer, &timeout, &interval, false);
break;
}
default:
break;
}
}
static void
on_stream_param_changed(void *_data, uint32_t id, const struct spa_pod *param)
{
struct data *data = _data;
struct pw_stream *stream = data->stream;
uint8_t params_buffer[1024];
struct spa_pod_builder b = SPA_POD_BUILDER_INIT(params_buffer, sizeof(params_buffer));
const struct spa_pod *params[5];
uint32_t n_params = 0;
struct spa_pod_frame f;
if (param != NULL && id == SPA_PARAM_Tag) {
spa_debug_pod(0, NULL, param);
return;
}
if (param == NULL || id != SPA_PARAM_Format)
return;
fprintf(stderr, "got format:\n");
spa_debug_format(2, NULL, param);
spa_format_video_raw_parse(param, &data->format);
data->stride = SPA_ROUND_UP_N(data->format.size.width * BPP, 4);
/* first add Buffer with 3 blocks (1 data, 2 sync fds). */
if (data->with_synctimeline) {
spa_pod_builder_push_object(&b, &f, SPA_TYPE_OBJECT_ParamBuffers, SPA_PARAM_Buffers);
spa_pod_builder_add(&b,
SPA_PARAM_BUFFERS_buffers, SPA_POD_CHOICE_RANGE_Int(8, 2, MAX_BUFFERS),
SPA_PARAM_BUFFERS_blocks, SPA_POD_Int(3),
SPA_PARAM_BUFFERS_size, SPA_POD_Int(data->stride * data->format.size.height),
SPA_PARAM_BUFFERS_stride, SPA_POD_Int(data->stride),
SPA_PARAM_BUFFERS_dataType, SPA_POD_CHOICE_FLAGS_Int((1<<SPA_DATA_MemFd)),
0);
/* this depends on the negotiation of the SyncTimeline metadata */
spa_pod_builder_prop(&b, SPA_PARAM_BUFFERS_metaType, SPA_POD_PROP_FLAG_MANDATORY);
spa_pod_builder_int(&b, 1<<SPA_META_SyncTimeline);
params[n_params++] = spa_pod_builder_pop(&b, &f);
/* explicit sync information */
spa_pod_builder_push_object(&b, &f, SPA_TYPE_OBJECT_ParamMeta, SPA_PARAM_Meta);
spa_pod_builder_add(&b,
SPA_PARAM_META_type, SPA_POD_Id(SPA_META_SyncTimeline),
SPA_PARAM_META_size, SPA_POD_Int(sizeof(struct spa_meta_sync_timeline)),
0);
if (data->with_synctimeline_release) {
uint32_t flags = data->force_synctimeline_release ?
/* both sides need compatible features */
SPA_POD_PROP_FLAG_MANDATORY :
/* drop features flags if not provided by both sides */
SPA_POD_PROP_FLAG_DROP;
spa_pod_builder_prop(&b, SPA_PARAM_META_features, flags);
spa_pod_builder_int(&b, SPA_META_FEATURE_SYNC_TIMELINE_RELEASE);
}
params[n_params++] = spa_pod_builder_pop(&b, &f);
}
/* fallback for when the synctimeline is not negotiated */
params[n_params++] = spa_pod_builder_add_object(&b,
SPA_TYPE_OBJECT_ParamBuffers, SPA_PARAM_Buffers,
SPA_PARAM_BUFFERS_buffers, SPA_POD_CHOICE_RANGE_Int(8, 2, MAX_BUFFERS),
SPA_PARAM_BUFFERS_blocks, SPA_POD_Int(1),
SPA_PARAM_BUFFERS_size, SPA_POD_Int(data->stride * data->format.size.height),
SPA_PARAM_BUFFERS_stride, SPA_POD_Int(data->stride),
SPA_PARAM_BUFFERS_dataType, SPA_POD_CHOICE_FLAGS_Int((1<<SPA_DATA_MemFd)));
params[n_params++] = spa_pod_builder_add_object(&b,
SPA_TYPE_OBJECT_ParamMeta, SPA_PARAM_Meta,
SPA_PARAM_META_type, SPA_POD_Id(SPA_META_Header),
SPA_PARAM_META_size, SPA_POD_Int(sizeof(struct spa_meta_header)));
pw_stream_update_params(stream, params, n_params);
}
/* we set the PW_STREAM_FLAG_ALLOC_BUFFERS flag when connecting so we need
* to provide buffer memory. */
static void on_stream_add_buffer(void *_data, struct pw_buffer *buffer)
{
struct data *data = _data;
struct spa_buffer *buf = buffer->buffer;
struct spa_data *d;
#ifdef HAVE_MEMFD_CREATE
unsigned int seals;
#endif
struct spa_meta_sync_timeline *s;
d = buf->datas;
pw_log_debug("add buffer %p", buffer);
if ((d[0].type & (1<<SPA_DATA_MemFd)) == 0) {
pw_log_error("unsupported data type %08x", d[0].type);
return;
}
/* create the memfd on the buffer, set the type and flags */
d[0].type = SPA_DATA_MemFd;
d[0].flags = SPA_DATA_FLAG_READWRITE | SPA_DATA_FLAG_MAPPABLE;
#ifdef HAVE_MEMFD_CREATE
d[0].fd = memfd_create("video-src-memfd", MFD_CLOEXEC | MFD_ALLOW_SEALING);
#else
d[0].fd = -1;
#endif
if (d[0].fd == -1) {
pw_log_error("can't create memfd: %m");
return;
}
d[0].mapoffset = 0;
d[0].maxsize = data->stride * data->format.size.height;
/* truncate to the right size before we set seals */
if (ftruncate(d[0].fd, d[0].maxsize) < 0) {
pw_log_error("can't truncate to %d: %m", d[0].maxsize);
return;
}
#ifdef HAVE_MEMFD_CREATE
/* not enforced yet but server might require SEAL_SHRINK later */
seals = F_SEAL_GROW | F_SEAL_SHRINK | F_SEAL_SEAL;
if (fcntl(d[0].fd, F_ADD_SEALS, seals) == -1) {
pw_log_warn("Failed to add seals: %m");
}
#endif
/* now mmap so we can write to it in the process function above */
d[0].data = mmap(NULL, d[0].maxsize, PROT_READ|PROT_WRITE,
MAP_SHARED, d[0].fd, d[0].mapoffset);
if (d[0].data == MAP_FAILED) {
pw_log_error("can't mmap memory: %m");
return;
}
if ((s = spa_buffer_find_meta_data(buf, SPA_META_SyncTimeline, sizeof(*s))) && buf->n_datas >= 3) {
pw_log_debug("got sync timeline");
/* acquire fd (just an example, not really syncobj here) */
d[1].type = SPA_DATA_SyncObj;
d[1].flags = SPA_DATA_FLAG_READWRITE;
d[1].fd = eventfd(0, EFD_CLOEXEC);
d[1].mapoffset = 0;
d[1].maxsize = 0;
if (d[1].fd == -1) {
pw_log_error("can't create acquire fd: %m");
return;
}
/* release fd (just an example, not really syncobj here) */
d[2].type = SPA_DATA_SyncObj;
d[2].flags = SPA_DATA_FLAG_READWRITE;
d[2].fd = eventfd(0, EFD_CLOEXEC);
d[2].mapoffset = 0;
d[2].maxsize = 0;
if (d[2].fd == -1) {
pw_log_error("can't create release fd: %m");
return;
}
}
if (data->n_buffers++ == 0) {
struct spa_dict_item items[2];
uint32_t n_items = 0;
bool reliable = false, exclusive = false;
if (s != NULL) {
/* sync timeline is always exclusive */
exclusive = true;
if (spa_buffer_has_meta_features(buf, SPA_META_SyncTimeline,
SPA_META_FEATURE_SYNC_TIMELINE_RELEASE)) {
pw_log_info("got sync timeline with release");
} else {
pw_log_info("got sync timeline");
/* we need reliable transport without release */
reliable = true;
}
}
else {
pw_log_info("did not get sync timeline");
}
items[n_items++] = SPA_DICT_ITEM(PW_KEY_NODE_EXCLUSIVE, exclusive ? "true" : "false");
items[n_items++] = SPA_DICT_ITEM(PW_KEY_NODE_RELIABLE, reliable ? "true" : "false");
pw_stream_update_properties(data->stream, &SPA_DICT(items, n_items));
}
}
/* close the memfd we set on the buffers here */
static void on_stream_remove_buffer(void *_data, struct pw_buffer *buffer)
{
struct data *data = _data;
struct spa_buffer *buf = buffer->buffer;
struct spa_data *d;
d = buf->datas;
pw_log_debug("remove buffer %p", buffer);
munmap(d[0].data, d[0].maxsize);
close(d[0].fd);
if (buf->n_datas >= 3) {
close(d[1].fd);
close(d[2].fd);
}
data->n_buffers--;
}
static const struct pw_stream_events stream_events = {
PW_VERSION_STREAM_EVENTS,
.process = on_process,
.state_changed = on_stream_state_changed,
.param_changed = on_stream_param_changed,
.add_buffer = on_stream_add_buffer,
.remove_buffer = on_stream_remove_buffer,
};
static void do_quit(void *userdata, int signal_number)
{
struct data *data = userdata;
pw_main_loop_quit(data->loop);
}
static void show_help(struct data *data, const char *name, bool is_error)
{
FILE *fp;
fp = is_error ? stderr : stdout;
fprintf(fp,
"%s [options]\n"
" -h, --help Show this help\n"
" --version Show version\n"
" -r, --remote Remote daemon name\n"
" -S, --sync Enable SyncTimeline\n"
" -R, --release Enable RELEASE feature\n"
" -F, --force-release RELEASE feature needs to be present\n"
"\n", name);
}
int main(int argc, char *argv[])
{
struct data data = { 0, };
const struct spa_pod *params[2];
uint32_t n_params = 0;
uint8_t buffer[1024];
struct spa_pod_builder b = SPA_POD_BUILDER_INIT(buffer, sizeof(buffer));
static const struct option long_options[] = {
{ "help", no_argument, NULL, 'h' },
{ "version", no_argument, NULL, 'V' },
{ "remote", required_argument, NULL, 'r' },
{ "sync", no_argument, NULL, 'S' },
{ "release", no_argument, NULL, 'R' },
{ "force-release", no_argument, NULL, 'F' },
{ NULL, 0, NULL, 0}
};
char *opt_remote = NULL;
int c;
pw_init(&argc, &argv);
while ((c = getopt_long(argc, argv, "hVr:SRF", long_options, NULL)) != -1) {
switch (c) {
case 'h':
show_help(&data, argv[0], false);
return 0;
case 'V':
printf("%s\n"
"Compiled with libpipewire %s\n"
"Linked with libpipewire %s\n",
argv[0],
pw_get_headers_version(),
pw_get_library_version());
return 0;
case 'r':
opt_remote = optarg;
break;
case 'F':
data.force_synctimeline_release = true;
SPA_FALLTHROUGH;
case 'R':
data.with_synctimeline_release = true;
SPA_FALLTHROUGH;
case 'S':
data.with_synctimeline = true;
break;
default:
show_help(&data, argv[0], true);
return -1;
}
}
data.loop = pw_main_loop_new(NULL);
pw_loop_add_signal(pw_main_loop_get_loop(data.loop), SIGINT, do_quit, &data);
pw_loop_add_signal(pw_main_loop_get_loop(data.loop), SIGTERM, do_quit, &data);
data.context = pw_context_new(pw_main_loop_get_loop(data.loop), NULL, 0);
data.timer = pw_loop_add_timer(pw_main_loop_get_loop(data.loop), on_timeout, &data);
data.core = pw_context_connect(data.context,
pw_properties_new(
PW_KEY_REMOTE_NAME, opt_remote,
NULL),
0);
if (data.core == NULL) {
fprintf(stderr, "can't connect: %m\n");
data.res = -errno;
goto cleanup;
}
data.stream = pw_stream_new(data.core, "video-src-sync",
pw_properties_new(
PW_KEY_MEDIA_CLASS, "Video/Source",
NULL));
params[n_params++] = spa_pod_builder_add_object(&b,
SPA_TYPE_OBJECT_Format, SPA_PARAM_EnumFormat,
SPA_FORMAT_mediaType, SPA_POD_Id(SPA_MEDIA_TYPE_video),
SPA_FORMAT_mediaSubtype, SPA_POD_Id(SPA_MEDIA_SUBTYPE_raw),
SPA_FORMAT_VIDEO_format, SPA_POD_Id(SPA_VIDEO_FORMAT_BGRA),
SPA_FORMAT_VIDEO_size, SPA_POD_CHOICE_RANGE_Rectangle(
&SPA_RECTANGLE(320, 240),
&SPA_RECTANGLE(1, 1),
&SPA_RECTANGLE(4096, 4096)),
SPA_FORMAT_VIDEO_framerate, SPA_POD_Fraction(&SPA_FRACTION(25, 1)));
pw_stream_add_listener(data.stream,
&data.stream_listener,
&stream_events,
&data);
pw_stream_connect(data.stream,
PW_DIRECTION_OUTPUT,
PW_ID_ANY,
PW_STREAM_FLAG_DRIVER |
PW_STREAM_FLAG_ALLOC_BUFFERS |
PW_STREAM_FLAG_MAP_BUFFERS,
params, n_params);
pw_main_loop_run(data.loop);
cleanup:
pw_context_destroy(data.context);
pw_main_loop_destroy(data.loop);
pw_deinit();
return data.res;
}
format.h
spa/debug/format.h
pod.h
spa/debug/pod.h
pw_context_destroy
void pw_context_destroy(struct pw_context *context)
destroy a context object, all resources except the main_loop will be destroyed
Definition context.c:608
pw_context_new
struct pw_context * pw_context_new(struct pw_loop *main_loop, struct pw_properties *props, size_t user_data_size)
Make a new context object for a given main_loop.
Definition context.c:395
pw_context_connect
struct pw_core * pw_context_connect(struct pw_context *context, struct pw_properties *properties, size_t user_data_size)
Connect to a PipeWire instance.
Definition core.c:410
PW_ID_ANY
#define PW_ID_ANY
Definition core.h:77
seq
uint32_t int seq
Definition core.h:432
res
uint32_t int int res
Definition core.h:433
PW_KEY_NODE_RELIABLE
#define PW_KEY_NODE_RELIABLE
node uses reliable transport 1.6.0
Definition keys.h:340
PW_KEY_REMOTE_NAME
#define PW_KEY_REMOTE_NAME
The name of the remote to connect to, default pipewire-0, overwritten by env(PIPEWIRE_REMOTE).
Definition keys.h:149
PW_KEY_NODE_EXCLUSIVE
#define PW_KEY_NODE_EXCLUSIVE
node wants exclusive access to resources
Definition keys.h:236
PW_KEY_MEDIA_CLASS
#define PW_KEY_MEDIA_CLASS
class Ex: "Video/Source"
Definition keys.h:523
pw_log_trace
#define pw_log_trace(...)
Definition log.h:182
pw_log_warn
#define pw_log_warn(...)
Definition log.h:179
pw_log_debug
#define pw_log_debug(...)
Definition log.h:181
pw_log_error
#define pw_log_error(...)
Definition log.h:178
pw_log_info
#define pw_log_info(...)
Definition log.h:180
pw_loop_update_timer
PW_API_LOOP_IMPL int pw_loop_update_timer(struct pw_loop *object, struct spa_source *source, struct timespec *value, struct timespec *interval, bool absolute)
Definition loop.h:170
pw_loop_add_signal
PW_API_LOOP_IMPL struct spa_source * pw_loop_add_signal(struct pw_loop *object, int signal_number, spa_source_signal_func_t func, void *data)
Definition loop.h:177
pw_loop_add_timer
PW_API_LOOP_IMPL struct spa_source * pw_loop_add_timer(struct pw_loop *object, spa_source_timer_func_t func, void *data)
Definition loop.h:166
pw_main_loop_quit
int pw_main_loop_quit(struct pw_main_loop *loop)
Quit a main loop.
Definition main-loop.c:108
pw_main_loop_destroy
void pw_main_loop_destroy(struct pw_main_loop *loop)
Destroy a loop.
Definition main-loop.c:73
pw_main_loop_run
int pw_main_loop_run(struct pw_main_loop *loop)
Run a main loop.
Definition main-loop.c:122
pw_main_loop_new
struct pw_main_loop * pw_main_loop_new(const struct spa_dict *props)
Create a new main loop.
Definition main-loop.c:63
pw_main_loop_get_loop
struct pw_loop * pw_main_loop_get_loop(struct pw_main_loop *loop)
Get the loop implementation.
Definition main-loop.c:96
pw_init
void pw_init(int *argc, char **argv[])
Initialize PipeWire.
Definition pipewire.c:499
pw_deinit
void pw_deinit(void)
Deinitialize PipeWire.
Definition pipewire.c:614
PW_DIRECTION_OUTPUT
#define PW_DIRECTION_OUTPUT
Definition port.h:55
pw_properties_new
struct pw_properties * pw_properties_new(const char *key,...)
Make a new properties object.
Definition properties.c:97
pw_stream_update_properties
int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict *dict)
Definition stream.c:1871
pw_stream_connect
int pw_stream_connect(struct pw_stream *stream, enum pw_direction direction, uint32_t target_id, enum pw_stream_flags flags, const struct spa_pod **params, uint32_t n_params)
Connect a stream for input or output on port_path.
Definition stream.c:1974
pw_stream_dequeue_buffer
struct pw_buffer * pw_stream_dequeue_buffer(struct pw_stream *stream)
Get a buffer that can be filled for playback streams or consumed for capture streams.
Definition stream.c:2545
pw_stream_get_node_id
uint32_t pw_stream_get_node_id(struct pw_stream *stream)
Get the node ID of the stream.
Definition stream.c:2266
pw_stream_get_nsec
uint64_t pw_stream_get_nsec(struct pw_stream *stream)
Get the current time in nanoseconds.
Definition stream.c:2519
pw_stream_is_driving
bool pw_stream_is_driving(struct pw_stream *stream)
Check if the stream is driving.
Definition stream.c:2708
pw_stream_new
struct pw_stream * pw_stream_new(struct pw_core *core, const char *name, struct pw_properties *props)
Create a new unconnected Stream.
Definition stream.c:1641
pw_stream_state_as_string
const char * pw_stream_state_as_string(enum pw_stream_state state)
Convert a stream state to a readable string.
Definition stream.c:1707
pw_stream_state
pw_stream_state
The state of a stream.
Definition stream.h:251
pw_stream_update_params
int pw_stream_update_params(struct pw_stream *stream, const struct spa_pod **params, uint32_t n_params)
Update the param exposed on the stream.
Definition stream.c:2306
pw_stream_trigger_process
int pw_stream_trigger_process(struct pw_stream *stream)
Trigger a push/pull on the stream.
Definition stream.c:2754
pw_stream_queue_buffer
int pw_stream_queue_buffer(struct pw_stream *stream, struct pw_buffer *buffer)
Submit a buffer for playback or recycle a buffer for capture.
Definition stream.c:2586
pw_stream_add_listener
void pw_stream_add_listener(struct pw_stream *stream, struct spa_hook *listener, const struct pw_stream_events *events, void *data)
Definition stream.c:1830
PW_VERSION_STREAM_EVENTS
#define PW_VERSION_STREAM_EVENTS
Definition stream.h:424
PW_STREAM_FLAG_MAP_BUFFERS
@ PW_STREAM_FLAG_MAP_BUFFERS
mmap the buffers except DmaBuf that is not explicitly marked as mappable.
Definition stream.h:476
PW_STREAM_FLAG_DRIVER
@ PW_STREAM_FLAG_DRIVER
be a driver
Definition stream.h:478
PW_STREAM_FLAG_ALLOC_BUFFERS
@ PW_STREAM_FLAG_ALLOC_BUFFERS
the application will allocate buffer memory.
Definition stream.h:487
PW_STREAM_STATE_PAUSED
@ PW_STREAM_STATE_PAUSED
paused
Definition stream.h:255
PW_STREAM_STATE_UNCONNECTED
@ PW_STREAM_STATE_UNCONNECTED
unconnected
Definition stream.h:253
PW_STREAM_STATE_ERROR
@ PW_STREAM_STATE_ERROR
the stream is in error
Definition stream.h:252
PW_STREAM_STATE_STREAMING
@ PW_STREAM_STATE_STREAMING
streaming
Definition stream.h:256
spa_buffer_has_meta_features
SPA_API_BUFFER bool spa_buffer_has_meta_features(const struct spa_buffer *b, uint32_t type, uint32_t features)
Definition buffer.h:137
SPA_DATA_FLAG_MAPPABLE
#define SPA_DATA_FLAG_MAPPABLE
data is mappable with simple mmap/munmap.
Definition buffer.h:98
SPA_DATA_FLAG_READWRITE
#define SPA_DATA_FLAG_READWRITE
Definition buffer.h:96
SPA_META_SYNC_TIMELINE_UNSCHEDULED_RELEASE
#define SPA_META_SYNC_TIMELINE_UNSCHEDULED_RELEASE
this flag is set by the producer and cleared by the consumer when it promises to signal the release p...
Definition meta.h:212
spa_buffer_find_meta_data
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_META_FEATURE_SYNC_TIMELINE_RELEASE
#define SPA_META_FEATURE_SYNC_TIMELINE_RELEASE
A timeline point for explicit sync.
Definition meta.h:208
SPA_META_SyncTimeline
@ SPA_META_SyncTimeline
struct spa_meta_sync_timeline
Definition meta.h:46
SPA_META_Header
@ SPA_META_Header
struct spa_meta_header
Definition meta.h:37
SPA_DATA_MemFd
@ SPA_DATA_MemFd
memfd, mmap to get to memory.
Definition buffer.h:45
SPA_DATA_SyncObj
@ SPA_DATA_SyncObj
a syncobj, usually requires a spa_meta_sync_timeline metadata with timeline points.
Definition buffer.h:52
spa_debug_pod
SPA_API_DEBUG_POD int spa_debug_pod(int indent, const struct spa_type_info *info, const struct spa_pod *pod)
Definition pod.h:248
spa_debug_format
SPA_API_DEBUG_FORMAT int spa_debug_format(int indent, const struct spa_type_info *info, const struct spa_pod *format)
Definition format.h:222
SPA_DICT
#define SPA_DICT(items, n_items)
Definition dict.h:60
SPA_DICT_ITEM
#define SPA_DICT_ITEM(key, value)
Definition dict.h:47
spa_format_video_raw_parse
SPA_API_VIDEO_RAW_UTILS int spa_format_video_raw_parse(const struct spa_pod *format, struct spa_video_info_raw *info)
Definition raw-utils.h:38
SPA_PARAM_META_features
@ SPA_PARAM_META_features
meta data features (Features Int)
Definition buffers.h:41
SPA_PARAM_META_size
@ SPA_PARAM_META_size
the expected maximum size the meta (Int)
Definition buffers.h:40
SPA_PARAM_META_type
@ SPA_PARAM_META_type
the metadata, one of enum spa_meta_type (Id enum spa_meta_type)
Definition buffers.h:39
SPA_MEDIA_TYPE_video
@ SPA_MEDIA_TYPE_video
Definition format.h:28
SPA_PARAM_Tag
@ SPA_PARAM_Tag
tag reporting, a SPA_TYPE_OBJECT_ParamTag.
Definition param.h:47
SPA_PARAM_Format
@ SPA_PARAM_Format
configured format as SPA_TYPE_OBJECT_Format
Definition param.h:34
SPA_PARAM_Meta
@ SPA_PARAM_Meta
allowed metadata for buffers as SPA_TYPE_OBJECT_ParamMeta
Definition param.h:36
SPA_PARAM_EnumFormat
@ SPA_PARAM_EnumFormat
available formats as SPA_TYPE_OBJECT_Format
Definition param.h:33
SPA_PARAM_Buffers
@ SPA_PARAM_Buffers
buffer configurations as SPA_TYPE_OBJECT_ParamBuffers
Definition param.h:35
SPA_FORMAT_VIDEO_framerate
@ SPA_FORMAT_VIDEO_framerate
frame rate (Fraction)
Definition format.h:134
SPA_FORMAT_mediaType
@ SPA_FORMAT_mediaType
media type (Id enum spa_media_type)
Definition format.h:99
SPA_FORMAT_VIDEO_size
@ SPA_FORMAT_VIDEO_size
size (Rectangle)
Definition format.h:133
SPA_FORMAT_VIDEO_format
@ SPA_FORMAT_VIDEO_format
video format (Id enum spa_video_format)
Definition format.h:130
SPA_FORMAT_mediaSubtype
@ SPA_FORMAT_mediaSubtype
media subtype (Id enum spa_media_subtype)
Definition format.h:100
SPA_MEDIA_SUBTYPE_raw
@ SPA_MEDIA_SUBTYPE_raw
Definition format.h:38
SPA_VIDEO_FORMAT_BGRA
@ SPA_VIDEO_FORMAT_BGRA
Definition raw.h:57
SPA_PARAM_BUFFERS_dataType
@ SPA_PARAM_BUFFERS_dataType
possible memory types (flags choice Int, mask of enum spa_data_type)
Definition buffers.h:32
SPA_PARAM_BUFFERS_size
@ SPA_PARAM_BUFFERS_size
size of a data block memory (Int)
Definition buffers.h:29
SPA_PARAM_BUFFERS_stride
@ SPA_PARAM_BUFFERS_stride
stride of data block memory (Int)
Definition buffers.h:30
SPA_PARAM_BUFFERS_blocks
@ SPA_PARAM_BUFFERS_blocks
number of data blocks per buffer (Int)
Definition buffers.h:28
SPA_PARAM_BUFFERS_buffers
@ SPA_PARAM_BUFFERS_buffers
number of buffers (Int)
Definition buffers.h:27
SPA_PARAM_BUFFERS_metaType
@ SPA_PARAM_BUFFERS_metaType
required meta data types (Int, mask of enum spa_meta_type)
Definition buffers.h:33
spa_pod_builder_pop
SPA_API_POD_BUILDER void * spa_pod_builder_pop(struct spa_pod_builder *builder, struct spa_pod_frame *frame)
Definition builder.h:213
spa_pod_builder_int
SPA_API_POD_BUILDER int spa_pod_builder_int(struct spa_pod_builder *builder, int32_t val)
Definition builder.h:296
SPA_POD_Fraction
#define SPA_POD_Fraction(val)
Definition vararg.h:119
SPA_POD_PROP_FLAG_MANDATORY
#define SPA_POD_PROP_FLAG_MANDATORY
is mandatory, when filtering, both sides need this property or filtering fails.
Definition pod.h:241
SPA_POD_PROP_FLAG_DROP
#define SPA_POD_PROP_FLAG_DROP
drop property, when filtering, both sides need the property or it will be dropped.
Definition pod.h:246
SPA_POD_CHOICE_RANGE_Int
#define SPA_POD_CHOICE_RANGE_Int(def, min, max)
Definition vararg.h:62
spa_pod_builder_add
SPA_API_POD_BUILDER int spa_pod_builder_add(struct spa_pod_builder *builder,...)
Definition builder.h:713
SPA_POD_Id
#define SPA_POD_Id(val)
Definition vararg.h:53
SPA_POD_BUILDER_INIT
#define SPA_POD_BUILDER_INIT(buffer, size)
Definition builder.h:72
SPA_POD_CHOICE_RANGE_Rectangle
#define SPA_POD_CHOICE_RANGE_Rectangle(def, min, max)
Definition vararg.h:114
spa_pod_builder_push_object
SPA_API_POD_BUILDER int spa_pod_builder_push_object(struct spa_pod_builder *builder, struct spa_pod_frame *frame, uint32_t type, uint32_t id)
Definition builder.h:475
spa_pod_builder_add_object
#define spa_pod_builder_add_object(b, type, id,...)
Definition builder.h:725
SPA_POD_Int
#define SPA_POD_Int(val)
Definition vararg.h:58
SPA_POD_CHOICE_FLAGS_Int
#define SPA_POD_CHOICE_FLAGS_Int(flags)
Definition vararg.h:66
spa_pod_builder_prop
SPA_API_POD_BUILDER int spa_pod_builder_prop(struct spa_pod_builder *builder, uint32_t key, uint32_t flags)
Definition builder.h:490
SPA_TYPE_OBJECT_ParamBuffers
@ SPA_TYPE_OBJECT_ParamBuffers
Definition type.h:88
SPA_TYPE_OBJECT_ParamMeta
@ SPA_TYPE_OBJECT_ParamMeta
Definition type.h:89
SPA_TYPE_OBJECT_Format
@ SPA_TYPE_OBJECT_Format
Definition type.h:87
SPA_FLAG_SET
#define SPA_FLAG_SET(field, flag)
Definition defs.h:93
SPA_ROUND_UP_N
#define SPA_ROUND_UP_N(num, align)
Definition defs.h:364
SPA_FRACTION
#define SPA_FRACTION(num, denom)
Definition defs.h:136
SPA_NSEC_PER_MSEC
#define SPA_NSEC_PER_MSEC
Definition defs.h:255
SPA_FLAG_IS_SET
#define SPA_FLAG_IS_SET(field, flag)
Definition defs.h:90
SPA_FALLTHROUGH
#define SPA_FALLTHROUGH
SPA_FALLTHROUGH is an annotation to suppress compiler warnings about switch cases that fall through w...
Definition defs.h:84
SPA_RECTANGLE
#define SPA_RECTANGLE(width, height)
Definition defs.h:115
pipewire.h
pipewire/pipewire.h
pw_buffer
a buffer structure obtained from pw_stream_dequeue_buffer().
Definition stream.h:261
pw_buffer::buffer
struct spa_buffer * buffer
the spa buffer
Definition stream.h:262
pw_context
pw_core
pw_main_loop
A main loop object.
pw_stream_events
Events for a stream.
Definition stream.h:422
pw_stream
spa_buffer
A Buffer.
Definition buffer.h:110
spa_buffer::datas
struct spa_data * datas
array of data members
Definition buffer.h:114
spa_buffer::n_datas
uint32_t n_datas
number of data members
Definition buffer.h:112
spa_chunk::stride
int32_t stride
stride of valid data
Definition buffer.h:65
spa_chunk::size
uint32_t size
size of valid data.
Definition buffer.h:63
spa_chunk::offset
uint32_t offset
offset of valid data.
Definition buffer.h:60
spa_data
Data for a buffer this stays constant for a buffer.
Definition buffer.h:78
spa_data::chunk
struct spa_chunk * chunk
valid chunk of memory
Definition buffer.h:106
spa_data::fd
int64_t fd
optional fd for data
Definition buffer.h:102
spa_data::mapoffset
uint32_t mapoffset
offset to map fd at, this is page aligned
Definition buffer.h:103
spa_data::flags
uint32_t flags
data flags
Definition buffer.h:101
spa_data::data
void * data
optional data pointer
Definition buffer.h:105
spa_data::maxsize
uint32_t maxsize
max size of data
Definition buffer.h:104
spa_data::type
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
spa_dict_item
Definition dict.h:41
spa_hook
A hook, contains the structure with functions and the data passed to the functions.
Definition hook.h:427
spa_meta_header
Describes essential buffer header metadata such as flags and timestamps.
Definition meta.h:85
spa_meta_header::flags
uint32_t flags
flags
Definition meta.h:98
spa_meta_header::seq
uint64_t seq
sequence number, increments with a media specific frequency
Definition meta.h:102
spa_meta_header::pts
int64_t pts
presentation timestamp in nanoseconds
Definition meta.h:100
spa_meta_header::dts_offset
int64_t dts_offset
decoding timestamp as a difference with pts
Definition meta.h:101
spa_meta_sync_timeline
Definition meta.h:210
spa_meta_sync_timeline::acquire_point
uint64_t acquire_point
the timeline acquire point, this is when the data can be accessed.
Definition meta.h:217
spa_meta_sync_timeline::release_point
uint64_t release_point
the timeline release point, this timeline point should be signaled when the data is no longer accesse...
Definition meta.h:219
spa_meta_sync_timeline::flags
uint32_t flags
Definition meta.h:215
spa_pod_builder
Definition builder.h:63
spa_pod_frame
Definition body.h:38
spa_pod_frame::flags
uint32_t flags
Definition body.h:42
spa_pod
Definition pod.h:57
spa_source
Definition loop.h:67
spa_video_info_raw
Definition raw.h:176
tag-utils.h