PipeWire: export-sink.c

PipeWire 0.3.51

export-sink.c

Exporting and implementing a video sink SPA node, using Core API.

/* PipeWire
*
* Copyright © 2018 Wim Taymans
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice (including the next
* paragraph) shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*/
/*
[title]
Exporting and implementing a video sink SPA node, using \ref api_pw_core.
[title]
*/
#include <errno.h>
#include <stdio.h>
#include <sys/mman.h>
#include <spa/utils/result.h>
#include <spa/param/video/format-utils.h>
#include <spa/param/props.h>
#include <spa/node/utils.h>
#include <spa/node/io.h>
#include <spa/pod/filter.h>
#include <spa/debug/format.h>
#include <spa/debug/pod.h>
#include <pipewire/pipewire.h>
#define WIDTH 640
#define HEIGHT 480
#define BPP 3
#include "sdl.h"
#define M_PI_M2 ( M_PI + M_PI )
#define MAX_BUFFERS 64
#define DEFAULT_PARAM 0.1
struct props {
double param;
};
static void reset_props(struct props *props)
{
props->param = DEFAULT_PARAM;
}
struct data {
struct props props;
const char *path;
SDL_Renderer *renderer;
SDL_Window *window;
SDL_Texture *texture;
struct pw_main_loop *loop;
struct pw_context *context;
struct pw_core *core;
struct spa_hook core_listener;
struct spa_node impl_node;
struct spa_hook_list hooks;
struct spa_io_buffers *io;
struct spa_io_sequence *io_notify;
uint32_t io_notify_size;
double param_accum;
uint8_t buffer[1024];
struct spa_video_info_raw format;
int32_t stride;
struct spa_port_info info;
struct spa_param_info params[5];
struct spa_region region;
struct spa_buffer *buffers[MAX_BUFFERS];
uint32_t n_buffers;
};
static void handle_events(struct data *data)
{
SDL_Event event;
while (SDL_PollEvent(&event)) {
switch (event.type) {
case SDL_QUIT:
pw_main_loop_quit(data->loop);
break;
}
}
}
static void update_param(struct data *data)
{
struct spa_pod_builder b = { 0, };
struct spa_pod_frame f[2];
if (data->io_notify == NULL)
return;
spa_pod_builder_init(&b, data->io_notify, data->io_notify_size);
spa_pod_builder_push_sequence(&b, &f[0], 0);
spa_pod_builder_control(&b, 0, SPA_CONTROL_Properties);
spa_pod_builder_push_object(&b, &f[1], SPA_TYPE_OBJECT_Props, 0);
spa_pod_builder_prop(&b, SPA_PROP_contrast, 0);
spa_pod_builder_float(&b, (sin(data->param_accum) * 127.0) + 127.0);
spa_pod_builder_pop(&b, &f[1]);
spa_pod_builder_pop(&b, &f[0]);
data->param_accum += M_PI_M2 / 30.0;
if (data->param_accum >= M_PI_M2)
data->param_accum -= M_PI_M2;
}
static int impl_send_command(void *object, const struct spa_command *command)
{
return 0;
}
static int impl_add_listener(void *object,
struct spa_hook *listener,
const struct spa_node_events *events,
void *data)
{
struct data *d = object;
struct spa_hook_list save;
uint64_t old;
spa_hook_list_isolate(&d->hooks, &save, listener, events, data);
old = d->info.change_mask;
d->info.change_mask = SPA_PORT_CHANGE_MASK_FLAGS |
SPA_PORT_CHANGE_MASK_PARAMS;
spa_node_emit_port_info(&d->hooks, SPA_DIRECTION_INPUT, 0, &d->info);
d->info.change_mask = old;
spa_hook_list_join(&d->hooks, &save);
return 0;
}
static int impl_set_callbacks(void *object,
const struct spa_node_callbacks *callbacks, void *data)
{
return 0;
}
static int impl_set_io(void *object,
uint32_t id, void *data, size_t size)
{
return 0;
}
static int impl_port_set_io(void *object,
enum spa_direction direction, uint32_t port_id,
uint32_t id, void *data, size_t size)
{
struct data *d = object;
switch (id) {
case SPA_IO_Buffers:
d->io = data;
break;
case SPA_IO_Notify:
d->io_notify = data;
d->io_notify_size = size;
break;
default:
return -ENOENT;
}
return 0;
}
static int impl_port_enum_params(void *object, int seq,
enum spa_direction direction, uint32_t port_id,
uint32_t id, uint32_t start, uint32_t num,
const struct spa_pod *filter)
{
struct data *d = object;
struct spa_pod *param;
struct spa_pod_builder b = { 0 };
uint8_t buffer[1024];
struct spa_result_node_params result;
uint32_t count = 0;
result. id = id;
result.next = start;
next:
result.index = result.next++;
spa_pod_builder_init(&b, buffer, sizeof(buffer));
switch (id) {
case SPA_PARAM_EnumFormat:
{
SDL_RendererInfo info;
if (result.index != 0)
return 0;
SDL_GetRendererInfo(d->renderer, &info);
param = sdl_build_formats(&info, &b);
break;
}
case SPA_PARAM_Format:
if (result.index != 0 || d->format.format == 0)
return 0;
param = spa_format_video_raw_build(&b, id, &d->format);
break;
case SPA_PARAM_Buffers:
if (result.index != 0)
return 0;
param = spa_pod_builder_add_object(&b,
SPA_TYPE_OBJECT_ParamBuffers, id,
SPA_PARAM_BUFFERS_buffers, SPA_POD_CHOICE_RANGE_Int(2, 2, MAX_BUFFERS),
SPA_PARAM_BUFFERS_blocks, SPA_POD_Int(1),
SPA_PARAM_BUFFERS_size, SPA_POD_Int(d->stride * d->format.size.height),
SPA_PARAM_BUFFERS_stride, SPA_POD_Int(d->stride));
break;
case SPA_PARAM_Meta:
switch (result.index) {
case 0:
param = spa_pod_builder_add_object(&b,
SPA_TYPE_OBJECT_ParamMeta, id,
SPA_PARAM_META_type, SPA_POD_Id(SPA_META_Header),
SPA_PARAM_META_size, SPA_POD_Int(sizeof(struct spa_meta_header)));
break;
case 1:
param = spa_pod_builder_add_object(&b,
SPA_TYPE_OBJECT_ParamMeta, id,
SPA_PARAM_META_type, SPA_POD_Id(SPA_META_VideoDamage),
SPA_PARAM_META_size, SPA_POD_Int(sizeof(struct spa_meta_region)));
break;
default:
return 0;
}
break;
case SPA_PARAM_IO:
switch (result.index) {
case 0:
param = spa_pod_builder_add_object(&b,
SPA_TYPE_OBJECT_ParamIO, id,
SPA_PARAM_IO_id, SPA_POD_Id(SPA_IO_Buffers),
SPA_PARAM_IO_size, SPA_POD_Int(sizeof(struct spa_io_buffers)));
break;
case 1:
param = spa_pod_builder_add_object(&b,
SPA_TYPE_OBJECT_ParamIO, id,
SPA_PARAM_IO_id, SPA_POD_Id(SPA_IO_Notify),
SPA_PARAM_IO_size, SPA_POD_Int(sizeof(struct spa_io_sequence) + 1024));
break;
default:
return 0;
}
break;
default:
return -ENOENT;
}
if (spa_pod_filter(&b, &result.param, param, filter) < 0)
goto next;
spa_node_emit_result(&d->hooks, seq, 0, SPA_RESULT_TYPE_NODE_PARAMS, &result);
if (++count != num)
goto next;
return 0;
}
static int port_set_format(void *object,
enum spa_direction direction, uint32_t port_id,
uint32_t flags, const struct spa_pod *format)
{
struct data *d = object;
Uint32 sdl_format;
void *dest;
d->info.change_mask = SPA_PORT_CHANGE_MASK_PARAMS;
if (format == NULL) {
SDL_DestroyTexture(d->texture);
d->params[3] = SPA_PARAM_INFO(SPA_PARAM_Format, SPA_PARAM_INFO_WRITE);
d->params[4] = SPA_PARAM_INFO(SPA_PARAM_Buffers, 0);
} else {
spa_debug_format(0, NULL, format);
spa_format_video_raw_parse(format, &d->format);
sdl_format = id_to_sdl_format(d->format.format);
if (sdl_format == SDL_PIXELFORMAT_UNKNOWN)
return -EINVAL;
d->texture = SDL_CreateTexture(d->renderer,
sdl_format,
SDL_TEXTUREACCESS_STREAMING,
d->format.size.width,
d->format.size.height);
SDL_LockTexture(d->texture, NULL, &dest, &d->stride);
SDL_UnlockTexture(d->texture);
d->params[3] = SPA_PARAM_INFO(SPA_PARAM_Format, SPA_PARAM_INFO_READWRITE);
d->params[4] = SPA_PARAM_INFO(SPA_PARAM_Buffers, SPA_PARAM_INFO_READ);
}
spa_node_emit_port_info(&d->hooks, direction, port_id, &d->info);
d->info.change_mask = 0;
return 0;
}
static int impl_port_set_param(void *object,
enum spa_direction direction, uint32_t port_id,
uint32_t id, uint32_t flags,
const struct spa_pod *param)
{
if (id == SPA_PARAM_Format) {
return port_set_format(object, direction, port_id, flags, param);
}
else
return -ENOENT;
}
static int impl_port_use_buffers(void *object,
enum spa_direction direction, uint32_t port_id,
uint32_t flags,
struct spa_buffer **buffers, uint32_t n_buffers)
{
struct data *d = object;
uint32_t i;
if (n_buffers > MAX_BUFFERS)
return -ENOSPC;
for (i = 0; i < n_buffers; i++)
d->buffers[i] = buffers[i];
d->n_buffers = n_buffers;
return 0;
}
static int do_render(struct spa_loop *loop, bool async, uint32_t seq,
const void *_data, size_t size, void *user_data)
{
struct data *d = user_data;
const struct spa_buffer *buf = *(struct spa_buffer**)_data;
uint8_t *map;
void *sdata, *ddata;
int sstride, dstride, ostride;
uint32_t i;
uint8_t *src, *dst;
struct spa_meta *m;
struct spa_meta_region *r;
handle_events(d);
if (buf->datas[0].type == SPA_DATA_MemFd ||
buf->datas[0].type == SPA_DATA_DmaBuf) {
map = mmap(NULL, buf->datas[0].maxsize + buf->datas[0].mapoffset, PROT_READ,
MAP_PRIVATE, buf->datas[0].fd, 0);
sdata = SPA_PTROFF(map, buf->datas[0].mapoffset, uint8_t);
} else if (buf->datas[0].type == SPA_DATA_MemPtr) {
map = NULL;
sdata = buf->datas[0].data;
} else
return -EINVAL;
if (SDL_LockTexture(d->texture, NULL, &ddata, &dstride) < 0) {
fprintf(stderr, "Couldn't lock texture: %s\n", SDL_GetError());
return -EIO;
}
if ((m = spa_buffer_find_meta(buf, SPA_META_VideoDamage))) {
spa_meta_for_each(r, m) {
if (!spa_meta_region_is_valid(r))
break;
if (memcmp(&r->region, &d->region, sizeof(struct spa_region)) == 0)
break;
d->region = r->region;
fprintf(stderr, "region %dx%d->%dx%d\n",
r->region. position. x, r->region.position. y,
r->region. size. width, r->region.size. height);
}
}
sstride = buf->datas[0].chunk->stride;
ostride = SPA_MIN(sstride, dstride);
src = sdata;
dst = ddata;
for (i = 0; i < d->format.size.height; i++) {
memcpy(dst, src, ostride);
src += sstride;
dst += dstride;
}
SDL_UnlockTexture(d->texture);
SDL_RenderClear(d->renderer);
SDL_RenderCopy(d->renderer, d->texture, NULL, NULL);
SDL_RenderPresent(d->renderer);
if (map)
munmap(map, buf->datas[0].maxsize + buf->datas[0].mapoffset);
return 0;
}
static int impl_node_process(void *object)
{
struct data *d = object;
struct spa_buffer *buf;
int res;
if (d->io->status != SPA_STATUS_HAVE_DATA)
return SPA_STATUS_NEED_DATA;
if (d->io->buffer_id >= d->n_buffers)
return SPA_STATUS_NEED_DATA;
buf = d->buffers[d->io->buffer_id];
if ((res = pw_loop_invoke(pw_main_loop_get_loop(d->loop), do_render,
SPA_ID_INVALID, &buf, sizeof(struct spa_buffer *),
false, d)) < 0)
return res;
update_param(d);
return d->io->status = SPA_STATUS_NEED_DATA;
}
static const struct spa_node_methods impl_node = {
SPA_VERSION_NODE_METHODS,
.add_listener = impl_add_listener,
.set_callbacks = impl_set_callbacks,
.set_io = impl_set_io,
.send_command = impl_send_command,
.port_set_io = impl_port_set_io,
.port_enum_params = impl_port_enum_params,
.port_set_param = impl_port_set_param,
.port_use_buffers = impl_port_use_buffers,
.process = impl_node_process,
};
static void make_node(struct data *data)
{
struct pw_properties *props;
props = pw_properties_new(PW_KEY_NODE_AUTOCONNECT, "true", NULL);
if (data->path)
pw_properties_set(props, PW_KEY_NODE_TARGET, data->path);
pw_properties_set(props, PW_KEY_MEDIA_CLASS, "Stream/Input/Video");
pw_properties_set(props, PW_KEY_MEDIA_TYPE, "Video");
pw_properties_set(props, PW_KEY_MEDIA_CATEGORY, "Capture");
pw_properties_set(props, PW_KEY_MEDIA_ROLE, "Camera");
data->impl_node.iface = SPA_INTERFACE_INIT(
SPA_TYPE_INTERFACE_Node,
SPA_VERSION_NODE,
&impl_node, data);
pw_core_export(data->core, SPA_TYPE_INTERFACE_Node,
&props->dict, &data->impl_node, 0);
pw_properties_free(props);
}
static void set_permissions(struct data *data)
{
struct pw_permission permissions[2];
/* an example, set specific permissions on one object, this is the
* core object. */
permissions[0] = PW_PERMISSION_INIT(PW_ID_CORE, PW_PERM_R | PW_PERM_X);
/* remove WX from all other objects */
permissions[1] = PW_PERMISSION_INIT(PW_ID_ANY, PW_PERM_R);
pw_client_update_permissions(
pw_core_get_client(data->core),
2, permissions);
}
static void on_core_error(void *data, uint32_t id, int seq, int res, const char *message)
{
struct data *d = data;
pw_log_error("error id:%u seq:%d res:%d (%s): %s",
id, seq, res, spa_strerror(res), message);
if (id == PW_ID_CORE)
pw_main_loop_quit(d->loop);
}
static const struct pw_core_events core_events = {
PW_VERSION_CORE_EVENTS,
.error = on_core_error,
};
int main(int argc, char *argv[])
{
struct data data = { 0, };
pw_init(&argc, &argv);
data.loop = pw_main_loop_new(NULL);
data.context = pw_context_new(pw_main_loop_get_loop(data.loop), NULL, 0);
data.path = argc > 1 ? argv[1] : NULL;
spa_hook_list_init(&data.hooks);
data.info = SPA_PORT_INFO_INIT();
data.info.change_mask = SPA_PORT_CHANGE_MASK_FLAGS;
data.info.flags = 0;
data.info.change_mask |= SPA_PORT_CHANGE_MASK_PARAMS;
data.params[0] = SPA_PARAM_INFO(SPA_PARAM_EnumFormat, SPA_PARAM_INFO_READ);
data.params[1] = SPA_PARAM_INFO(SPA_PARAM_Meta, SPA_PARAM_INFO_READ);
data.params[2] = SPA_PARAM_INFO(SPA_PARAM_IO, SPA_PARAM_INFO_READ);
data.params[3] = SPA_PARAM_INFO(SPA_PARAM_Buffers, SPA_PARAM_INFO_READ);
data.params[4] = SPA_PARAM_INFO(SPA_PARAM_Format, SPA_PARAM_INFO_WRITE);
data.info.params = data.params;
data.info.n_params = 5;
reset_props(&data.props);
if (SDL_Init(SDL_INIT_VIDEO) < 0) {
printf("can't initialize SDL: %s\n", SDL_GetError());
return -1;
}
if (SDL_CreateWindowAndRenderer
(WIDTH, HEIGHT, SDL_WINDOW_RESIZABLE, &data.window, &data.renderer)) {
printf("can't create window: %s\n", SDL_GetError());
return -1;
}
data.core = pw_context_connect(data.context, NULL, 0);
if (data.core == NULL) {
printf("can't connect: %m\n");
return -1;
}
pw_core_add_listener(data.core, &data.core_listener, &core_events, &data);
set_permissions(&data);
make_node(&data);
pw_main_loop_run(data.loop);
pw_context_destroy(data.context);
pw_main_loop_destroy(data.loop);
return 0;
}
format.h
spa/debug/format.h
pod.h
spa/debug/pod.h
pw_client_update_permissions
#define pw_client_update_permissions(c,...)
Manage the permissions of the global objects for this client.
Definition: client.h:205
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:434
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:208
PW_ID_CORE
#define PW_ID_CORE
default ID for the core object after connect
Definition: core.h:79
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:402
PW_ID_ANY
#define PW_ID_ANY
Definition: core.h:83
pw_core_get_client
struct pw_client * pw_core_get_client(struct pw_core *core)
Get the client proxy of the connected core.
Definition: core.c:263
pw_core_export
struct pw_proxy * pw_core_export(struct pw_core *core, const char *type, const struct spa_dict *props, void *object, size_t user_data_size)
Export an object into the PipeWire instance associated with core.
Definition: core.c:275
pw_core_add_listener
#define pw_core_add_listener(c,...)
Definition: core.h:363
PW_VERSION_CORE_EVENTS
#define PW_VERSION_CORE_EVENTS
Definition: core.h:143
PW_KEY_MEDIA_TYPE
#define PW_KEY_MEDIA_TYPE
Media.
Definition: keys.h:429
PW_KEY_NODE_TARGET
#define PW_KEY_NODE_TARGET
node wants to be connected to the target node/session
Definition: keys.h:217
PW_KEY_NODE_AUTOCONNECT
#define PW_KEY_NODE_AUTOCONNECT
node wants to be automatically connected to a compatible node
Definition: keys.h:214
PW_KEY_MEDIA_ROLE
#define PW_KEY_MEDIA_ROLE
Role: Movie, Music, Camera, Screen, Communication, Game, Notification, DSP, Production,...
Definition: keys.h:435
PW_KEY_MEDIA_CATEGORY
#define PW_KEY_MEDIA_CATEGORY
Media Category: Playback, Capture, Duplex, Monitor, Manager.
Definition: keys.h:432
PW_KEY_MEDIA_CLASS
#define PW_KEY_MEDIA_CLASS
class Ex: "Video/Source"
Definition: keys.h:440
pw_log_error
#define pw_log_error(...)
Definition: log.h:162
pw_loop_invoke
#define pw_loop_invoke(l,...)
Definition: loop.h:67
pw_main_loop_quit
int pw_main_loop_quit(struct pw_main_loop *loop)
Quit a main loop.
Definition: main-loop.c:125
pw_main_loop_destroy
void pw_main_loop_destroy(struct pw_main_loop *loop)
Destroy a loop.
Definition: main-loop.c:90
pw_main_loop_run
int pw_main_loop_run(struct pw_main_loop *loop)
Run a main loop.
Definition: main-loop.c:139
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:80
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:113
PW_PERM_X
#define PW_PERM_X
methods can be called on the object.
Definition: permission.h:56
PW_PERM_R
#define PW_PERM_R
object can be seen and events can be received
Definition: permission.h:52
PW_PERMISSION_INIT
#define PW_PERMISSION_INIT(id, p)
Definition: permission.h:86
pw_init
void pw_init(int *argc, char **argv[])
Initialize PipeWire.
Definition: pipewire.c:583
pw_properties_free
void pw_properties_free(struct pw_properties *properties)
Free a properties object.
Definition: properties.c:368
pw_properties_new
struct pw_properties * pw_properties_new(const char *key,...) 1
Make a new properties object.
Definition: properties.c:102
pw_properties_set
int pw_properties_set(struct pw_properties *properties, const char *key, const char *value)
Set a property value.
Definition: properties.c:439
spa_buffer_find_meta
static struct spa_meta * spa_buffer_find_meta(const struct spa_buffer *b, uint32_t type)
Find metadata in a buffer.
Definition: buffer.h:113
spa_meta_region_is_valid
#define spa_meta_region_is_valid(m)
Definition: meta.h:106
spa_meta_for_each
#define spa_meta_for_each(pos, meta)
iterate all the items in a metadata
Definition: meta.h:109
SPA_META_VideoDamage
@ SPA_META_VideoDamage
array of struct spa_meta_region with damage, where an invalid entry or end-of-array marks the end.
Definition: meta.h:49
SPA_META_Header
@ SPA_META_Header
struct spa_meta_header
Definition: meta.h:47
SPA_DATA_MemFd
@ SPA_DATA_MemFd
generic fd, mmap to get to memory
Definition: buffer.h:54
SPA_DATA_MemPtr
@ SPA_DATA_MemPtr
pointer to memory, the data field in struct spa_data is set.
Definition: buffer.h:52
SPA_DATA_DmaBuf
@ SPA_DATA_DmaBuf
fd to dmabuf memory
Definition: buffer.h:55
SPA_CONTROL_Properties
@ SPA_CONTROL_Properties
data contains a SPA_TYPE_OBJECT_Props
Definition: control.h:52
spa_debug_format
static int spa_debug_format(int indent, const struct spa_type_info *info, const struct spa_pod *format)
Definition: format.h:122
spa_hook_list_join
static void spa_hook_list_join(struct spa_hook_list *list, struct spa_hook_list *save)
Definition: hook.h:422
spa_hook_list_init
static void spa_hook_list_init(struct spa_hook_list *list)
Initialize a hook list to the empty list.
Definition: hook.h:361
spa_hook_list_isolate
static void spa_hook_list_isolate(struct spa_hook_list *list, struct spa_hook_list *save, struct spa_hook *hook, const void *funcs, void *data)
Definition: hook.h:408
SPA_INTERFACE_INIT
#define SPA_INTERFACE_INIT(_type, _version, _funcs, _data)
Initialize a spa_interface.
Definition: hook.h:177
SPA_PORT_CHANGE_MASK_FLAGS
#define SPA_PORT_CHANGE_MASK_FLAGS
Definition: node.h:115
spa_node_emit_port_info
#define spa_node_emit_port_info(hooks,...)
Definition: utils.h:138
SPA_PORT_INFO_INIT
#define SPA_PORT_INFO_INIT()
Definition: node.h:159
SPA_STATUS_HAVE_DATA
#define SPA_STATUS_HAVE_DATA
Definition: io.h:104
SPA_TYPE_INTERFACE_Node
#define SPA_TYPE_INTERFACE_Node
Definition: node.h:57
SPA_STATUS_NEED_DATA
#define SPA_STATUS_NEED_DATA
Definition: io.h:102
SPA_VERSION_NODE
#define SPA_VERSION_NODE
Definition: node.h:60
SPA_PORT_CHANGE_MASK_PARAMS
#define SPA_PORT_CHANGE_MASK_PARAMS
Definition: node.h:121
SPA_RESULT_TYPE_NODE_PARAMS
#define SPA_RESULT_TYPE_NODE_PARAMS
Definition: node.h:164
spa_node_emit_result
#define spa_node_emit_result(hooks,...)
Definition: utils.h:139
SPA_VERSION_NODE_METHODS
#define SPA_VERSION_NODE_METHODS
Definition: node.h:351
SPA_IO_Notify
@ SPA_IO_Notify
area for notify messages, struct spa_io_sequence
Definition: io.h:63
SPA_IO_Buffers
@ SPA_IO_Buffers
area to exchange buffers, struct spa_io_buffers
Definition: io.h:58
SPA_PARAM_INFO_WRITE
#define SPA_PARAM_INFO_WRITE
Definition: param.h:78
SPA_PARAM_INFO_READ
#define SPA_PARAM_INFO_READ
Definition: param.h:76
SPA_PARAM_INFO_READWRITE
#define SPA_PARAM_INFO_READWRITE
Definition: param.h:80
spa_format_video_raw_build
static struct spa_pod * spa_format_video_raw_build(struct spa_pod_builder *builder, uint32_t id, struct spa_video_info_raw *info)
Definition: format-utils.h:80
spa_format_video_raw_parse
static int spa_format_video_raw_parse(const struct spa_pod *format, struct spa_video_info_raw *info)
Definition: format-utils.h:47
SPA_PARAM_INFO
#define SPA_PARAM_INFO(id, flags)
Definition: param.h:88
SPA_PROP_contrast
@ SPA_PROP_contrast
Definition: props.h:110
SPA_PARAM_META_size
@ SPA_PARAM_META_size
the expected maximum size the meta (Int)
Definition: param.h:105
SPA_PARAM_META_type
@ SPA_PARAM_META_type
the metadata, one of enum spa_meta_type (Id enum spa_meta_type)
Definition: param.h:104
SPA_PARAM_Format
@ SPA_PARAM_Format
configured format as SPA_TYPE_OBJECT_Format
Definition: param.h:54
SPA_PARAM_Meta
@ SPA_PARAM_Meta
allowed metadata for buffers as SPA_TYPE_OBJECT_ParamMeta
Definition: param.h:56
SPA_PARAM_IO
@ SPA_PARAM_IO
configurable IO areas as SPA_TYPE_OBJECT_ParamIO
Definition: param.h:57
SPA_PARAM_EnumFormat
@ SPA_PARAM_EnumFormat
available formats as SPA_TYPE_OBJECT_Format
Definition: param.h:53
SPA_PARAM_Buffers
@ SPA_PARAM_Buffers
buffer configurations as SPA_TYPE_OBJECT_ParamBuffers
Definition: param.h:55
SPA_PARAM_IO_id
@ SPA_PARAM_IO_id
type ID, uniquely identifies the io area (Id enum spa_io_type)
Definition: param.h:111
SPA_PARAM_IO_size
@ SPA_PARAM_IO_size
size of the io area (Int)
Definition: param.h:112
SPA_PARAM_BUFFERS_size
@ SPA_PARAM_BUFFERS_size
size of a data block memory (Int)
Definition: param.h:95
SPA_PARAM_BUFFERS_stride
@ SPA_PARAM_BUFFERS_stride
stride of data block memory (Int)
Definition: param.h:96
SPA_PARAM_BUFFERS_blocks
@ SPA_PARAM_BUFFERS_blocks
number of data blocks per buffer (Int)
Definition: param.h:94
SPA_PARAM_BUFFERS_buffers
@ SPA_PARAM_BUFFERS_buffers
number of buffers (Int)
Definition: param.h:93
spa_pod_builder_prop
static int spa_pod_builder_prop(struct spa_pod_builder *builder, uint32_t key, uint32_t flags)
Definition: builder.h:468
spa_pod_builder_float
static int spa_pod_builder_float(struct spa_pod_builder *builder, float val)
Definition: builder.h:283
SPA_POD_CHOICE_RANGE_Int
#define SPA_POD_CHOICE_RANGE_Int(def, min, max)
Definition: vararg.h:78
spa_pod_builder_push_sequence
static int spa_pod_builder_push_sequence(struct spa_pod_builder *builder, struct spa_pod_frame *frame, uint32_t unit)
Definition: builder.h:478
SPA_POD_Id
#define SPA_POD_Id(val)
Definition: vararg.h:69
spa_pod_builder_pop
static void * spa_pod_builder_pop(struct spa_pod_builder *builder, struct spa_pod_frame *frame)
Definition: builder.h:186
spa_pod_builder_control
static uint32_t spa_pod_builder_control(struct spa_pod_builder *builder, uint32_t offset, uint32_t type)
Definition: builder.h:489
spa_pod_builder_add_object
#define spa_pod_builder_add_object(b, type, id,...)
Definition: builder.h:677
spa_pod_builder_init
static void spa_pod_builder_init(struct spa_pod_builder *builder, void *data, uint32_t size)
Definition: builder.h:107
spa_pod_builder_push_object
static 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:453
SPA_POD_Int
#define SPA_POD_Int(val)
Definition: vararg.h:74
spa_pod_filter
static int spa_pod_filter(struct spa_pod_builder *b, struct spa_pod **result, const struct spa_pod *pod, const struct spa_pod *filter)
Definition: filter.h:392
spa_strerror
#define spa_strerror(err)
Definition: result.h:69
SPA_TYPE_OBJECT_ParamBuffers
@ SPA_TYPE_OBJECT_ParamBuffers
Definition: type.h:97
SPA_TYPE_OBJECT_ParamIO
@ SPA_TYPE_OBJECT_ParamIO
Definition: type.h:99
SPA_TYPE_OBJECT_Props
@ SPA_TYPE_OBJECT_Props
Definition: type.h:95
SPA_TYPE_OBJECT_ParamMeta
@ SPA_TYPE_OBJECT_ParamMeta
Definition: type.h:98
SPA_MIN
#define SPA_MIN(a, b)
Definition: defs.h:146
SPA_ID_INVALID
#define SPA_ID_INVALID
Definition: defs.h:217
spa_direction
spa_direction
Definition: defs.h:90
SPA_PTROFF
#define SPA_PTROFF(ptr_, offset_, type_)
Return the address (buffer + offset) as pointer of type.
Definition: defs.h:183
SPA_DIRECTION_INPUT
@ SPA_DIRECTION_INPUT
Definition: defs.h:91
io.h
spa/node/io.h
pipewire.h
pipewire/pipewire.h
props.h
result.h
spa/utils/result.h
utils.h
filter.h
spa/pod/filter.h
pw_context
pw_core_events
Core events.
Definition: core.h:141
pw_core
pw_main_loop
A main loop object.
pw_permission
Definition: permission.h:80
pw_permission::permissions
uint32_t permissions
bitmask of above permissions
Definition: permission.h:82
pw_properties
Definition: properties.h:53
pw_properties::dict
struct spa_dict dict
dictionary of key/values
Definition: properties.h:54
spa_buffer
A Buffer.
Definition: buffer.h:105
spa_buffer::datas
struct spa_data * datas
array of data members
Definition: buffer.h:109
spa_chunk::stride
int32_t stride
stride of valid data
Definition: buffer.h:68
spa_command
Definition: command.h:49
spa_data::chunk
struct spa_chunk * chunk
valid chunk of memory
Definition: buffer.h:101
spa_data::fd
int64_t fd
optional fd for data
Definition: buffer.h:97
spa_data::mapoffset
uint32_t mapoffset
offset to map fd at
Definition: buffer.h:98
spa_data::data
void * data
optional data pointer
Definition: buffer.h:100
spa_data::maxsize
uint32_t maxsize
max size of data
Definition: buffer.h:99
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:78
spa_hook_list
A list of hooks.
Definition: hook.h:340
spa_hook
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:351
spa_io_buffers
IO area to exchange buffers.
Definition: io.h:98
spa_io_sequence
control stream, io area for SPA_IO_Control and SPA_IO_Notify
Definition: io.h:184
spa_loop
Definition: loop.h:56
spa_meta_header
Describes essential buffer header metadata such as flags and timestamps.
Definition: meta.h:80
spa_meta_region
metadata structure for Region or an array of these for RegionArray
Definition: meta.h:102
spa_meta_region::region
struct spa_region region
Definition: meta.h:103
spa_meta
A metadata element.
Definition: meta.h:66
spa_node_callbacks
Node callbacks.
Definition: node.h:252
spa_node_events
events from the spa_node.
Definition: node.h:196
spa_node_methods
Node methods.
Definition: node.h:347
spa_node
Definition: node.h:61
spa_param_info
information about a parameter
Definition: param.h:70
spa_pod_builder
Definition: builder.h:73
spa_pod_frame
Definition: iter.h:47
spa_pod
Definition: pod.h:63
spa_point::y
int32_t y
Definition: defs.h:109
spa_point::x
int32_t x
Definition: defs.h:108
spa_port_info
Port information structure.
Definition: node.h:113
spa_rectangle::width
uint32_t width
Definition: defs.h:101
spa_rectangle::height
uint32_t height
Definition: defs.h:102
spa_region
Definition: defs.h:114
spa_region::position
struct spa_point position
Definition: defs.h:115
spa_region::size
struct spa_rectangle size
Definition: defs.h:116
spa_result_node_params
the result of enum_params or port_enum_params.
Definition: node.h:172
spa_result_node_params::param
struct spa_pod * param
the result param
Definition: node.h:176
spa_result_node_params::next
uint32_t next
next index of iteration
Definition: node.h:175
spa_result_node_params::id
uint32_t id
id of parameter
Definition: node.h:173
spa_video_info_raw
Definition: raw.h:194
spa_video_info_raw::format
enum spa_video_format format
the format
Definition: raw.h:195
format-utils.h