Exporting and implementing a video source SPA node, using /builds/pipewire/pipewire/branch-1.2/builddir/doc/examples.dox
#include <errno.h>
#include <stdio.h>
#include <math.h>
#include <sys/mman.h>
#define M_PI_M2f (float)(M_PI + M_PI)
#define BUFFER_SAMPLES 128
#define MAX_BUFFERS 32
struct buffer {
uint32_t id;
void *ptr;
bool mapped;
};
struct data {
const char *path;
uint64_t info_all;
struct spa_io_control *io_notify;
uint32_t io_notify_size;
struct buffer buffers[MAX_BUFFERS];
uint32_t n_buffers;
float accumulator;
float volume_accum;
};
static void update_volume(struct data *data)
{
if (data->io_notify == NULL)
return;
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,
void *data)
{
struct data *d = object;
uint64_t old;
old = d->info.change_mask;
d->info.change_mask = d->info_all;
d->info.change_mask = old;
return 0;
}
static int impl_set_callbacks(void *object,
{
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) {
d->io = data;
break;
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,
uint32_t id, uint32_t start, uint32_t num,
{
struct data *d = object;
uint8_t buffer[1024];
uint32_t count = 0;
result.next = start;
result.index = result.next++;
switch (id) {
if (result.index != 0)
return 0;
break;
if (result.index != 0)
return 0;
if (d->format.format == 0)
return 0;
break;
if (result.index > 0)
return 0;
BUFFER_SAMPLES * sizeof(float), 32, INT32_MAX),
break;
switch (result.index) {
case 0:
break;
default:
return 0;
}
break;
switch (result.index) {
case 0:
break;
case 1:
break;
default:
return 0;
}
break;
default:
return -ENOENT;
}
if (++count != num)
return 0;
}
static int port_set_format(void *object,
uint32_t flags,
const struct spa_pod *format)
{
struct data *d = object;
if (format == NULL) {
} else {
return -EINVAL;
return -EINVAL;
if (d->format.rate == 0 ||
d->format.channels == 0 ||
return -EINVAL;
}
if (format) {
} else {
}
return 0;
}
static int impl_port_set_param(void *object,
uint32_t id, uint32_t flags,
{
return port_set_format(object, direction, port_id, flags, param);
}
else
return -ENOENT;
}
static int impl_port_use_buffers(void *object,
uint32_t flags,
{
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];
if (datas[0].data != NULL) {
b->mapped = false;
}
b->ptr = mmap(NULL, datas[0].
maxsize, PROT_WRITE,
if (b->ptr == MAP_FAILED) {
return -errno;
}
b->mapped = true;
}
else {
return -EINVAL;
}
b->buffer = buffers[i];
}
d->n_buffers = n_buffers;
return 0;
}
static inline void reuse_buffer(struct data *d, uint32_t id)
{
}
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;
uint32_t maxsize, index = 0;
uint32_t filled, offset;
}
return -EPIPE;
}
od = b->buffer->datas;
filled = 0;
index = 0;
fill_s16(d,
SPA_PTROFF(b->ptr, offset,
void), avail);
fill_f32(d,
SPA_PTROFF(b->ptr, offset,
void), avail);
update_volume(d);
}
.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)
{
NULL);
if (data->path)
&impl_node, data);
&props->
dict, &data->impl_node, 0);
}
static void on_core_error(void *data, uint32_t id, int seq, int res, const char *message)
{
struct data *d = data;
}
};
int main(int argc, char *argv[])
{
struct data data = { 0, };
data.path = argc > 1 ? argv[1] : NULL;
data.info.flags = 0;
data.info.props = &data.dict;
data.info.params = data.params;
data.info.n_params = 5;
printf("can't connect: %m\n");
return -1;
}
make_node(&data);
return 0;
}
void pw_context_destroy(struct pw_context *context)
destroy a context object, all resources except the main_loop will be destroyed
Definition context.c:529
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:317
#define PW_ID_CORE
default ID for the core object after connect
Definition core.h:62
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:394
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:269
#define pw_core_add_listener(c,...)
Definition core.h:384
#define PW_VERSION_CORE_EVENTS
Definition core.h:130
#define PW_KEY_MEDIA_TYPE
Media.
Definition keys.h:497
#define PW_KEY_NODE_AUTOCONNECT
node wants to be automatically connected to a compatible node
Definition keys.h:235
#define PW_KEY_TARGET_OBJECT
a target object to link to.
Definition keys.h:564
#define PW_KEY_MEDIA_ROLE
Role: Movie, Music, Camera, Screen, Communication, Game, Notification, DSP, Production,...
Definition keys.h:503
#define PW_KEY_NODE_EXCLUSIVE
node wants exclusive access to resources
Definition keys.h:233
#define PW_KEY_MEDIA_CATEGORY
Media Category: Playback, Capture, Duplex, Monitor, Manager.
Definition keys.h:500
#define PW_KEY_FORMAT_DSP
format related properties
Definition keys.h:540
#define pw_log_trace(...)
Definition log.h:182
#define pw_log_debug(...)
Definition log.h:181
#define pw_log_error(...)
Definition log.h:178
int pw_main_loop_quit(struct pw_main_loop *loop)
Quit a main loop.
Definition main-loop.c:108
void pw_main_loop_destroy(struct pw_main_loop *loop)
Destroy a loop.
Definition main-loop.c:73
int pw_main_loop_run(struct pw_main_loop *loop)
Run a main loop.
Definition main-loop.c:122
struct pw_main_loop * pw_main_loop_new(const struct spa_dict *props)
Create a new main loop.
Definition main-loop.c:63
struct pw_loop * pw_main_loop_get_loop(struct pw_main_loop *loop)
Get the loop implementation.
Definition main-loop.c:96
void pw_init(int *argc, char **argv[])
Initialize PipeWire.
Definition pipewire.c:488
void pw_properties_free(struct pw_properties *properties)
Free a properties object.
Definition properties.c:562
struct pw_properties * pw_properties_new(const char *key,...)
Make a new properties object.
Definition properties.c:96
int pw_properties_set(struct pw_properties *properties, const char *key, const char *value)
Set a property value.
Definition properties.c:589
@ SPA_META_Header
struct spa_meta_header
Definition meta.h:27
@ SPA_DATA_MemFd
memfd, mmap to get to memory.
Definition buffer.h:35
@ SPA_DATA_DmaBuf
fd to dmabuf memory.
Definition buffer.h:36
@ SPA_CONTROL_Properties
data contains a SPA_TYPE_OBJECT_Props
Definition control.h:32
static int spa_debug_format(int indent, const struct spa_type_info *info, const struct spa_pod *format)
Definition format.h:206
#define SPA_DICT_ITEM_INIT(key, value)
Definition dict.h:37
#define SPA_DICT_INIT_ARRAY(items)
Definition dict.h:50
static void spa_hook_list_join(struct spa_hook_list *list, struct spa_hook_list *save)
Definition hook.h:422
static void spa_hook_list_init(struct spa_hook_list *list)
Initialize a hook list to the empty list.
Definition hook.h:360
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
#define SPA_INTERFACE_INIT(_type, _version, _funcs, _data)
Initialize a spa_interface.
Definition hook.h:157
static void spa_list_init(struct spa_list *list)
Definition list.h:35
static void spa_list_remove(struct spa_list *elem)
Definition list.h:65
#define spa_list_first(head, type, member)
Definition list.h:71
#define spa_list_is_empty(l)
Definition list.h:45
#define spa_list_append(list, item)
Definition list.h:77
#define SPA_PORT_CHANGE_MASK_FLAGS
Definition node.h:95
#define SPA_PORT_CHANGE_MASK_PROPS
Definition node.h:99
#define spa_node_emit_port_info(hooks,...)
Definition utils.h:118
#define SPA_PORT_INFO_INIT()
Definition node.h:139
#define SPA_STATUS_HAVE_DATA
Definition io.h:86
#define SPA_TYPE_INTERFACE_Node
Definition node.h:37
#define SPA_VERSION_NODE
Definition node.h:40
#define SPA_PORT_CHANGE_MASK_PARAMS
Definition node.h:101
#define SPA_RESULT_TYPE_NODE_PARAMS
Definition node.h:144
#define spa_node_emit_result(hooks,...)
Definition utils.h:119
#define SPA_VERSION_NODE_METHODS
Definition node.h:331
@ SPA_IO_Notify
area for notify messages, struct spa_io_sequence
Definition io.h:44
@ SPA_IO_Buffers
area to exchange buffers, struct spa_io_buffers
Definition io.h:38
#define SPA_PARAM_INFO_WRITE
Definition param.h:59
static int spa_format_audio_raw_parse(const struct spa_pod *format, struct spa_audio_info_raw *info)
Definition raw-utils.h:28
static 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:47
#define SPA_PARAM_INFO_READ
Definition param.h:57
#define SPA_PARAM_INFO_READWRITE
Definition param.h:61
#define SPA_PARAM_INFO(id, flags)
Definition param.h:71
#define SPA_AUDIO_MAX_CHANNELS
Definition raw.h:29
@ SPA_PROP_volume
a volume (Float), 0.0 silence, 1.0 no attenutation
Definition props.h:67
@ SPA_PARAM_META_size
the expected maximum size the meta (Int)
Definition buffers.h:40
@ 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
Definition format.h:27
@ SPA_PARAM_Format
configured format as SPA_TYPE_OBJECT_Format
Definition param.h:34
@ SPA_PARAM_Meta
allowed metadata for buffers as SPA_TYPE_OBJECT_ParamMeta
Definition param.h:36
@ SPA_PARAM_IO
configurable IO areas as SPA_TYPE_OBJECT_ParamIO
Definition param.h:37
@ SPA_PARAM_EnumFormat
available formats as SPA_TYPE_OBJECT_Format
Definition param.h:33
@ SPA_PARAM_Buffers
buffer configurations as SPA_TYPE_OBJECT_ParamBuffers
Definition param.h:35
@ SPA_FORMAT_mediaType
media type (Id enum spa_media_type)
Definition format.h:93
@ SPA_FORMAT_AUDIO_rate
sample rate (Int)
Definition format.h:100
@ SPA_FORMAT_mediaSubtype
media subtype (Id enum spa_media_subtype)
Definition format.h:94
@ SPA_FORMAT_AUDIO_format
audio format, (Id enum spa_audio_format)
Definition format.h:98
@ SPA_FORMAT_AUDIO_channels
number of audio channels (Int)
Definition format.h:101
@ SPA_MEDIA_SUBTYPE_raw
Definition format.h:38
@ SPA_PARAM_IO_id
type ID, uniquely identifies the io area (Id enum spa_io_type)
Definition buffers.h:46
@ SPA_PARAM_IO_size
size of the io area (Int)
Definition buffers.h:47
@ SPA_AUDIO_FORMAT_S16P
Definition raw.h:74
@ SPA_AUDIO_FORMAT_F32P
Definition raw.h:78
@ SPA_AUDIO_FORMAT_S16
Definition raw.h:94
@ SPA_AUDIO_FORMAT_F32
Definition raw.h:106
@ SPA_PARAM_BUFFERS_size
size of a data block memory (Int)
Definition buffers.h:29
@ SPA_PARAM_BUFFERS_stride
stride of data block memory (Int)
Definition buffers.h:30
@ SPA_PARAM_BUFFERS_blocks
number of data blocks per buffer (Int)
Definition buffers.h:28
@ SPA_PARAM_BUFFERS_buffers
number of buffers (Int)
Definition buffers.h:27
static int spa_pod_builder_prop(struct spa_pod_builder *builder, uint32_t key, uint32_t flags)
Definition builder.h:450
static int spa_pod_builder_float(struct spa_pod_builder *builder, float val)
Definition builder.h:265
#define SPA_POD_CHOICE_ENUM_Id(n_vals,...)
Definition vararg.h:51
#define SPA_POD_CHOICE_RANGE_Int(def, min, max)
Definition vararg.h:58
static int spa_pod_builder_push_sequence(struct spa_pod_builder *builder, struct spa_pod_frame *frame, uint32_t unit)
Definition builder.h:460
#define SPA_POD_Id(val)
Definition vararg.h:49
static void * spa_pod_builder_pop(struct spa_pod_builder *builder, struct spa_pod_frame *frame)
Definition builder.h:168
static int spa_pod_builder_control(struct spa_pod_builder *builder, uint32_t offset, uint32_t type)
Definition builder.h:471
#define spa_pod_builder_add_object(b, type, id,...)
Definition builder.h:659
static void spa_pod_builder_init(struct spa_pod_builder *builder, void *data, uint32_t size)
Definition builder.h:87
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:435
#define SPA_POD_Int(val)
Definition vararg.h:54
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:431
#define spa_strerror(err)
Definition result.h:49
@ SPA_TYPE_OBJECT_ParamBuffers
Definition type.h:77
@ SPA_TYPE_OBJECT_ParamIO
Definition type.h:79
@ SPA_TYPE_OBJECT_Props
Definition type.h:75
@ SPA_TYPE_OBJECT_ParamMeta
Definition type.h:78
@ SPA_TYPE_OBJECT_Format
Definition type.h:76
#define spa_zero(x)
Definition defs.h:483
#define SPA_ID_INVALID
Definition defs.h:250
spa_direction
Definition defs.h:106
#define SPA_PTROFF(ptr_, offset_, type_)
Return the address (buffer + offset) as pointer of type.
Definition defs.h:222
@ SPA_DIRECTION_OUTPUT
Definition defs.h:108
Core events.
Definition core.h:128
void(* error)(void *data, uint32_t id, int seq, int res, const char *message)
Fatal error event.
Definition core.h:176
Definition properties.h:34
struct spa_dict dict
dictionary of key/values
Definition properties.h:35
Audio information description.
Definition raw.h:284
A Buffer.
Definition buffer.h:100
struct spa_data * datas
array of data members
Definition buffer.h:104
int32_t stride
stride of valid data
Definition buffer.h:55
uint32_t size
size of valid data.
Definition buffer.h:53
uint32_t offset
offset of valid data.
Definition buffer.h:50
Data for a buffer this stays constant for a buffer.
Definition buffer.h:68
struct spa_chunk * chunk
valid chunk of memory
Definition buffer.h:96
int64_t fd
optional fd for data
Definition buffer.h:92
uint32_t mapoffset
offset to map fd at, this is page aligned
Definition buffer.h:93
void * data
optional data pointer
Definition buffer.h:95
uint32_t maxsize
max size of data
Definition buffer.h:94
uint32_t type
memory type, one of enum spa_data_type, when allocating memory, the type contains a bitmask of allowe...
Definition buffer.h:69
A list of hooks.
Definition hook.h:339
A hook, contains the structure with functions and the data passed to the functions.
Definition hook.h:350
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
control stream, io area for SPA_IO_Control and SPA_IO_Notify
Definition io.h:198
Node callbacks.
Definition node.h:232
events from the spa_node.
Definition node.h:176
Node methods.
Definition node.h:327
int(* add_listener)(void *object, struct spa_hook *listener, const struct spa_node_events *events, void *data)
Adds an event listener on node.
Definition node.h:348
information about a parameter
Definition param.h:51
Port information structure.
Definition node.h:93
the result of enum_params or port_enum_params.
Definition node.h:152
uint32_t next
next index of iteration
Definition node.h:155
uint32_t id
id of parameter
Definition node.h:153