PipeWire: export-source.c

PipeWire 1.6.5

Loading...
Searching...
No Matches
export-source.c

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

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

/* PipeWire */
/* SPDX-FileCopyrightText: Copyright © 2018 Wim Taymans */
/* SPDX-License-Identifier: MIT */
/*
[title]
Exporting and implementing a video source SPA node, using \ref api_pw_core.
[title]
*/
#include <errno.h>
#include <stdio.h>
#include <math.h>
#include <sys/mman.h>
#include <spa/utils/result.h>
#include <spa/param/audio/format-utils.h>
#include <spa/param/props.h>
#include <spa/node/io.h>
#include <spa/node/utils.h>
#include <spa/pod/filter.h>
#include <spa/debug/format.h>
#include <pipewire/pipewire.h>
#define M_PI_M2f (float)(M_PI + M_PI)
#define BUFFER_SAMPLES 128
#define MAX_BUFFERS 32
struct buffer {
uint32_t id;
struct spa_buffer *buffer;
struct spa_list link;
void *ptr;
bool mapped;
};
struct data {
const char *path;
struct pw_main_loop *loop;
struct pw_context *context;
struct pw_core *core;
struct spa_hook core_listener;
uint64_t info_all;
struct spa_port_info info;
struct spa_dict_item items[1];
struct spa_dict dict;
struct spa_param_info params[5];
struct spa_node impl_node;
struct spa_hook_list hooks;
struct spa_io_buffers *io;
struct spa_io_control *io_notify;
uint32_t io_notify_size;
struct spa_audio_info_raw format;
struct buffer buffers[MAX_BUFFERS];
uint32_t n_buffers;
struct spa_list empty;
float accumulator;
float volume_accum;
};
static void update_volume(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_volume, 0);
spa_pod_builder_float(&b, (sinf(data->volume_accum) / 2.0f) + 0.5f);
spa_pod_builder_pop(&b, &f[1]);
spa_pod_builder_pop(&b, &f[0]);
data->volume_accum += M_PI_M2f / 1000.0f;
if (data->volume_accum >= M_PI_M2f)
data->volume_accum -= M_PI_M2f;
}
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 = d->info_all;
spa_node_emit_port_info(&d->hooks, SPA_DIRECTION_OUTPUT, 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:
if (result.index != 0)
return 0;
param = spa_pod_builder_add_object(&b,
SPA_TYPE_OBJECT_Format, SPA_PARAM_EnumFormat,
SPA_FORMAT_mediaType, SPA_POD_Id(SPA_MEDIA_TYPE_audio),
SPA_FORMAT_mediaSubtype, SPA_POD_Id(SPA_MEDIA_SUBTYPE_raw),
SPA_FORMAT_AUDIO_format, SPA_POD_CHOICE_ENUM_Id(5,
SPA_AUDIO_FORMAT_S16,
SPA_AUDIO_FORMAT_S16P,
SPA_AUDIO_FORMAT_S16,
SPA_AUDIO_FORMAT_F32P,
SPA_AUDIO_FORMAT_F32),
SPA_FORMAT_AUDIO_channels, SPA_POD_CHOICE_RANGE_Int(2, 1, INT32_MAX),
SPA_FORMAT_AUDIO_rate, SPA_POD_CHOICE_RANGE_Int(44100, 1, INT32_MAX));
break;
case SPA_PARAM_Format:
if (result.index != 0)
return 0;
if (d->format.format == 0)
return 0;
param = spa_format_audio_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(1, 1, 32),
SPA_PARAM_BUFFERS_blocks, SPA_POD_Int(1),
SPA_PARAM_BUFFERS_size, SPA_POD_CHOICE_RANGE_Int(
BUFFER_SAMPLES * sizeof(float), 32, INT32_MAX),
SPA_PARAM_BUFFERS_stride, SPA_POD_Int(sizeof(float)));
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;
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;
if (format == NULL) {
spa_zero(d->format);
} else {
spa_debug_format(0, NULL, format);
if (spa_format_audio_raw_parse(format, &d->format) < 0)
return -EINVAL;
if (d->format.format != SPA_AUDIO_FORMAT_S16 &&
d->format.format != SPA_AUDIO_FORMAT_F32)
return -EINVAL;
if (d->format.rate == 0 ||
d->format.channels == 0)
return -EINVAL;
}
d->info.change_mask = SPA_PORT_CHANGE_MASK_PARAMS;
if (format) {
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);
} else {
d->params[3] = SPA_PARAM_INFO(SPA_PARAM_Format, SPA_PARAM_INFO_WRITE);
d->params[4] = SPA_PARAM_INFO(SPA_PARAM_Buffers, 0);
}
spa_node_emit_port_info(&d->hooks, SPA_DIRECTION_OUTPUT, 0, &d->info);
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++) {
struct buffer *b = &d->buffers[i];
struct spa_data *datas = buffers[i]->datas;
if (datas[0].data != NULL) {
b->ptr = datas[0].data;
b->mapped = false;
}
else if (datas[0].type == SPA_DATA_MemFd ||
datas[0].type == SPA_DATA_DmaBuf) {
b->ptr = mmap(NULL, datas[0].maxsize, PROT_WRITE,
MAP_SHARED, datas[0].fd, datas[0].mapoffset);
if (b->ptr == MAP_FAILED) {
pw_log_error("failed to buffer mem");
return -errno;
}
b->mapped = true;
}
else {
pw_log_error("invalid buffer mem");
return -EINVAL;
}
b->id = i;
b->buffer = buffers[i];
pw_log_debug("got buffer %d size %d", i, datas[0].maxsize);
spa_list_append(&d->empty, &b->link);
}
d->n_buffers = n_buffers;
return 0;
}
static inline void reuse_buffer(struct data *d, uint32_t id)
{
pw_log_trace("export-source %p: recycle buffer %d", d, id);
spa_list_append(&d->empty, &d->buffers[id].link);
}
static int impl_port_reuse_buffer(void *object, uint32_t port_id, uint32_t buffer_id)
{
struct data *d = object;
reuse_buffer(d, buffer_id);
return 0;
}
static void fill_f32(struct data *d, void *dest, int avail)
{
float *dst = dest;
int n_samples = avail / (sizeof(float) * d->format.channels);
int i;
uint32_t c;
for (i = 0; i < n_samples; i++) {
float val;
d->accumulator += M_PI_M2f * 440 / d->format.rate;
if (d->accumulator >= M_PI_M2f)
d->accumulator -= M_PI_M2f;
val = sinf(d->accumulator);
for (c = 0; c < d->format.channels; c++)
*dst++ = val;
}
}
static void fill_s16(struct data *d, void *dest, int avail)
{
int16_t *dst = dest;
int n_samples = avail / (sizeof(int16_t) * d->format.channels);
int i;
uint32_t c;
for (i = 0; i < n_samples; i++) {
int16_t val;
d->accumulator += M_PI_M2f * 440 / d->format.rate;
if (d->accumulator >= M_PI_M2f)
d->accumulator -= M_PI_M2f;
val = (int16_t) (sinf(d->accumulator) * 32767.0f);
for (c = 0; c < d->format.channels; c++)
*dst++ = val;
}
}
static int impl_node_process(void *object)
{
struct data *d = object;
struct buffer *b;
int avail;
struct spa_io_buffers *io = d->io;
uint32_t maxsize, index = 0;
uint32_t filled, offset;
struct spa_data *od;
if (io->buffer_id < d->n_buffers) {
reuse_buffer(d, io->buffer_id);
io->buffer_id = SPA_ID_INVALID;
}
if (spa_list_is_empty(&d->empty)) {
pw_log_error("export-source %p: out of buffers", d);
return -EPIPE;
}
b = spa_list_first(&d->empty, struct buffer, link);
spa_list_remove(&b->link);
od = b->buffer->datas;
maxsize = od[0].maxsize;
filled = 0;
index = 0;
avail = maxsize - filled;
offset = index % maxsize;
if (offset + avail > maxsize)
avail = maxsize - offset;
if (d->format.format == SPA_AUDIO_FORMAT_S16)
fill_s16(d, SPA_PTROFF(b->ptr, offset, void), avail);
else if (d->format.format == SPA_AUDIO_FORMAT_F32)
fill_f32(d, SPA_PTROFF(b->ptr, offset, void), avail);
od[0].chunk->offset = 0;
od[0].chunk->size = avail;
od[0].chunk->stride = 0;
io->buffer_id = b->id;
io->status = SPA_STATUS_HAVE_DATA;
update_volume(d);
return SPA_STATUS_HAVE_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,
.port_reuse_buffer = impl_port_reuse_buffer,
.process = impl_node_process,
};
static void make_node(struct data *data)
{
struct pw_properties *props;
props = pw_properties_new(PW_KEY_NODE_AUTOCONNECT, "true",
PW_KEY_NODE_EXCLUSIVE, "true",
PW_KEY_MEDIA_TYPE, "Audio",
PW_KEY_MEDIA_CATEGORY, "Playback",
PW_KEY_MEDIA_ROLE, "Music",
NULL);
if (data->path)
pw_properties_set(props, PW_KEY_TARGET_OBJECT, data->path);
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 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;
data.info_all = SPA_PORT_CHANGE_MASK_FLAGS |
SPA_PORT_CHANGE_MASK_PROPS |
SPA_PORT_CHANGE_MASK_PARAMS;
data.info = SPA_PORT_INFO_INIT();
data.info.flags = 0;
data.items[0] = SPA_DICT_ITEM_INIT(PW_KEY_FORMAT_DSP, "32 bit float mono audio");
data.dict = SPA_DICT_INIT_ARRAY(data.items);
data.info.props = &data.dict;
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_Format, SPA_PARAM_INFO_WRITE);
data.params[4] = SPA_PARAM_INFO(SPA_PARAM_Buffers, 0);
data.info.params = data.params;
data.info.n_params = 5;
spa_list_init(&data.empty);
spa_hook_list_init(&data.hooks);
if ((data.core = pw_context_connect(data.context, NULL, 0)) == NULL) {
printf("can't connect: %m\n");
return -1;
}
pw_core_add_listener(data.core, &data.core_listener, &core_events, &data);
make_node(&data);
pw_main_loop_run(data.loop);
pw_context_destroy(data.context);
pw_main_loop_destroy(data.loop);
return 0;
}
format-utils.h
format.h
spa/debug/format.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_ID_CORE
#define PW_ID_CORE
default ID for the core object after connect
Definition core.h:73
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_core_add_listener
PW_API_CORE_IMPL int pw_core_add_listener(struct pw_core *object, struct spa_hook *listener, const struct pw_core_events *events, void *data)
Definition core.h:389
seq
uint32_t int seq
Definition core.h:432
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:285
id
uint32_t id
Definition core.h:432
message
uint32_t int int const char * message
Definition core.h:433
res
uint32_t int int res
Definition core.h:433
PW_VERSION_CORE_EVENTS
#define PW_VERSION_CORE_EVENTS
Definition core.h:141
PW_KEY_MEDIA_TYPE
#define PW_KEY_MEDIA_TYPE
Media.
Definition keys.h:512
PW_KEY_NODE_AUTOCONNECT
#define PW_KEY_NODE_AUTOCONNECT
node wants to be automatically connected to a compatible node
Definition keys.h:238
PW_KEY_TARGET_OBJECT
#define PW_KEY_TARGET_OBJECT
a target object to link to.
Definition keys.h:579
PW_KEY_MEDIA_ROLE
#define PW_KEY_MEDIA_ROLE
Role: Movie, Music, Camera, Screen, Communication, Game, Notification, DSP, Production,...
Definition keys.h:518
PW_KEY_NODE_EXCLUSIVE
#define PW_KEY_NODE_EXCLUSIVE
node wants exclusive access to resources
Definition keys.h:236
PW_KEY_MEDIA_CATEGORY
#define PW_KEY_MEDIA_CATEGORY
Media Category: Playback, Capture, Duplex, Monitor, Manager.
Definition keys.h:515
PW_KEY_FORMAT_DSP
#define PW_KEY_FORMAT_DSP
format related properties
Definition keys.h:555
pw_log_trace
#define pw_log_trace(...)
Definition log.h:182
pw_log_debug
#define pw_log_debug(...)
Definition log.h:181
pw_log_error
#define pw_log_error(...)
Definition log.h:178
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_properties_free
void pw_properties_free(struct pw_properties *properties)
Free a properties object.
Definition properties.c:559
pw_properties_new
struct pw_properties * pw_properties_new(const char *key,...)
Make a new properties object.
Definition properties.c:97
pw_properties_set
int pw_properties_set(struct pw_properties *properties, const char *key, const char *value)
Set a property value.
Definition properties.c:586
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_DmaBuf
@ SPA_DATA_DmaBuf
fd to dmabuf memory.
Definition buffer.h:46
SPA_CONTROL_Properties
@ SPA_CONTROL_Properties
SPA_TYPE_OBJECT_Props.
Definition control.h:32
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_ITEM_INIT
#define SPA_DICT_ITEM_INIT(key, value)
Definition dict.h:49
SPA_DICT_INIT_ARRAY
#define SPA_DICT_INIT_ARRAY(items)
Definition dict.h:69
spa_hook_list_isolate
SPA_API_HOOK 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:485
spa_hook_list_join
SPA_API_HOOK void spa_hook_list_join(struct spa_hook_list *list, struct spa_hook_list *save)
Definition hook.h:499
spa_hook_list_init
SPA_API_HOOK void spa_hook_list_init(struct spa_hook_list *list)
Initialize a hook list to the empty list.
Definition hook.h:437
SPA_INTERFACE_INIT
#define SPA_INTERFACE_INIT(_type, _version, _funcs, _data)
Initialize a spa_interface.
Definition hook.h:167
spa_list_init
SPA_API_LIST void spa_list_init(struct spa_list *list)
Definition list.h:47
spa_list_first
#define spa_list_first(head, type, member)
Definition list.h:83
spa_list_remove
SPA_API_LIST void spa_list_remove(struct spa_list *elem)
Definition list.h:77
spa_list_is_empty
#define spa_list_is_empty(l)
Definition list.h:57
spa_list_append
#define spa_list_append(list, item)
Definition list.h:89
SPA_PORT_CHANGE_MASK_FLAGS
#define SPA_PORT_CHANGE_MASK_FLAGS
Definition node.h:105
SPA_PORT_CHANGE_MASK_PROPS
#define SPA_PORT_CHANGE_MASK_PROPS
Definition node.h:109
spa_node_emit_port_info
#define spa_node_emit_port_info(hooks,...)
Definition utils.h:128
SPA_PORT_INFO_INIT
#define SPA_PORT_INFO_INIT()
Definition node.h:149
SPA_STATUS_HAVE_DATA
#define SPA_STATUS_HAVE_DATA
Definition io.h:86
SPA_TYPE_INTERFACE_Node
#define SPA_TYPE_INTERFACE_Node
Definition node.h:47
SPA_VERSION_NODE
#define SPA_VERSION_NODE
Definition node.h:50
SPA_PORT_CHANGE_MASK_PARAMS
#define SPA_PORT_CHANGE_MASK_PARAMS
Definition node.h:111
SPA_RESULT_TYPE_NODE_PARAMS
#define SPA_RESULT_TYPE_NODE_PARAMS
Definition node.h:154
spa_node_emit_result
#define spa_node_emit_result(hooks,...)
Definition utils.h:129
SPA_VERSION_NODE_METHODS
#define SPA_VERSION_NODE_METHODS
Definition node.h:341
SPA_IO_Notify
@ SPA_IO_Notify
area for notify messages, struct spa_io_sequence
Definition io.h:44
SPA_IO_Buffers
@ SPA_IO_Buffers
area to exchange buffers, struct spa_io_buffers
Definition io.h:38
SPA_PARAM_INFO_WRITE
#define SPA_PARAM_INFO_WRITE
Definition param.h:64
SPA_PARAM_INFO_READ
#define SPA_PARAM_INFO_READ
Definition param.h:62
SPA_PARAM_INFO_READWRITE
#define SPA_PARAM_INFO_READWRITE
Definition param.h:66
spa_format_audio_raw_parse
SPA_API_AUDIO_RAW_UTILS int spa_format_audio_raw_parse(const struct spa_pod *format, struct spa_audio_info_raw *info)
Definition raw-utils.h:67
SPA_PARAM_INFO
#define SPA_PARAM_INFO(id, flags)
Definition param.h:76
spa_format_audio_raw_build
SPA_API_AUDIO_RAW_UTILS struct spa_pod * spa_format_audio_raw_build(struct spa_pod_builder *builder, uint32_t id, const struct spa_audio_info_raw *info)
Definition raw-utils.h:111
SPA_PROP_volume
@ SPA_PROP_volume
a volume (Float), 0.0 silence, 1.0 no attenutation
Definition props.h:70
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_audio
@ SPA_MEDIA_TYPE_audio
Definition format.h:27
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_IO
@ SPA_PARAM_IO
configurable IO areas as SPA_TYPE_OBJECT_ParamIO
Definition param.h:37
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_mediaType
@ SPA_FORMAT_mediaType
media type (Id enum spa_media_type)
Definition format.h:99
SPA_FORMAT_AUDIO_rate
@ SPA_FORMAT_AUDIO_rate
sample rate (Int)
Definition format.h:106
SPA_FORMAT_mediaSubtype
@ SPA_FORMAT_mediaSubtype
media subtype (Id enum spa_media_subtype)
Definition format.h:100
SPA_FORMAT_AUDIO_format
@ SPA_FORMAT_AUDIO_format
audio format, (Id enum spa_audio_format)
Definition format.h:104
SPA_FORMAT_AUDIO_channels
@ SPA_FORMAT_AUDIO_channels
number of audio channels (Int)
Definition format.h:107
SPA_MEDIA_SUBTYPE_raw
@ SPA_MEDIA_SUBTYPE_raw
Definition format.h:38
SPA_PARAM_IO_id
@ SPA_PARAM_IO_id
type ID, uniquely identifies the io area (Id enum spa_io_type)
Definition buffers.h:47
SPA_PARAM_IO_size
@ SPA_PARAM_IO_size
size of the io area (Int)
Definition buffers.h:48
SPA_AUDIO_FORMAT_S16P
@ SPA_AUDIO_FORMAT_S16P
Definition raw.h:76
SPA_AUDIO_FORMAT_F32P
@ SPA_AUDIO_FORMAT_F32P
Definition raw.h:80
SPA_AUDIO_FORMAT_S16
@ SPA_AUDIO_FORMAT_S16
Definition raw.h:96
SPA_AUDIO_FORMAT_F32
@ SPA_AUDIO_FORMAT_F32
Definition raw.h:108
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_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_CHOICE_ENUM_Id
#define SPA_POD_CHOICE_ENUM_Id(n_vals,...)
Definition vararg.h:55
SPA_POD_CHOICE_RANGE_Int
#define SPA_POD_CHOICE_RANGE_Int(def, min, max)
Definition vararg.h:62
spa_pod_builder_control
SPA_API_POD_BUILDER int spa_pod_builder_control(struct spa_pod_builder *builder, uint32_t offset, uint32_t type)
Definition builder.h:511
SPA_POD_Id
#define SPA_POD_Id(val)
Definition vararg.h:53
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_filter
SPA_API_POD_FILTER 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:370
spa_pod_builder_init
SPA_API_POD_BUILDER void spa_pod_builder_init(struct spa_pod_builder *builder, void *data, uint32_t size)
Definition builder.h:102
spa_pod_builder_add_object
#define spa_pod_builder_add_object(b, type, id,...)
Definition builder.h:725
spa_pod_builder_float
SPA_API_POD_BUILDER int spa_pod_builder_float(struct spa_pod_builder *builder, float val)
Definition builder.h:314
spa_pod_builder_push_sequence
SPA_API_POD_BUILDER int spa_pod_builder_push_sequence(struct spa_pod_builder *builder, struct spa_pod_frame *frame, uint32_t unit)
Definition builder.h:500
SPA_POD_Int
#define SPA_POD_Int(val)
Definition vararg.h:58
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_ParamIO
@ SPA_TYPE_OBJECT_ParamIO
Definition type.h:90
SPA_TYPE_OBJECT_Props
@ SPA_TYPE_OBJECT_Props
Definition type.h:86
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_zero
#define spa_zero(x)
Definition defs.h:512
SPA_ID_INVALID
#define SPA_ID_INVALID
Definition defs.h:250
spa_direction
spa_direction
Definition defs.h:106
SPA_PTROFF
#define SPA_PTROFF(ptr_, offset_, type_)
Return the address (buffer + offset) as pointer of type.
Definition defs.h:222
SPA_DIRECTION_OUTPUT
@ SPA_DIRECTION_OUTPUT
Definition defs.h:108
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:139
pw_core
pw_main_loop
A main loop object.
pw_properties
Definition properties.h:39
pw_properties::dict
struct spa_dict dict
dictionary of key/values
Definition properties.h:40
spa_audio_info_raw
Audio information description.
Definition raw.h:292
spa_buffer
A Buffer.
Definition buffer.h:110
spa_buffer::datas
struct spa_data * datas
array of data members
Definition buffer.h:114
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_command
Definition command.h:29
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::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_dict
Definition dict.h:51
spa_hook_list
A list of hooks.
Definition hook.h:416
spa_hook
A hook, contains the structure with functions and the data passed to the functions.
Definition hook.h:427
spa_io_buffers
IO area to exchange buffers.
Definition io.h:80
spa_io_buffers::status
int32_t status
the status code
Definition io.h:91
spa_io_buffers::buffer_id
uint32_t buffer_id
a buffer id
Definition io.h:92
spa_io_sequence
control stream, io area for SPA_IO_Control and SPA_IO_Notify
Definition io.h:237
spa_list
Definition list.h:39
spa_meta_header
Describes essential buffer header metadata such as flags and timestamps.
Definition meta.h:85
spa_node_callbacks
Node callbacks.
Definition node.h:242
spa_node_events
events from the spa_node.
Definition node.h:186
spa_node_methods
Node methods.
Definition node.h:337
spa_node
Definition node.h:51
spa_param_info
information about a parameter
Definition param.h:56
spa_pod_builder
Definition builder.h:63
spa_pod_frame
Definition body.h:38
spa_pod
Definition pod.h:57
spa_port_info
Port information structure.
Definition node.h:103
spa_result_node_params
the result of enum_params or port_enum_params.
Definition node.h:162
spa_result_node_params::next
uint32_t next
next index of iteration
Definition node.h:165
spa_result_node_params::id
uint32_t id
id of parameter
Definition node.h:163