PipeWire  0.3.59
video-play-fixate.c

Video input stream using pw_stream, with format fixation.

/* PipeWire
*
* Copyright © 2020 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]
Video input stream using \ref pw_stream "pw_stream", with format fixation.
[title]
*/
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <signal.h>
#include <libdrm/drm_fourcc.h>
#define WIDTH 640
#define HEIGHT 480
#define MAX_BUFFERS 64
#define MAX_MOD 8
#include "sdl.h"
struct pixel {
float r, g, b, a;
};
struct pw_version {
int major;
int minor;
int micro;
};
struct modifier_info {
uint32_t spa_format;
uint32_t n_modifiers;
uint64_t modifiers[MAX_MOD];
};
struct data {
const char *path;
SDL_Renderer *renderer;
SDL_Window *window;
SDL_Texture *texture;
SDL_Texture *cursor;
struct pw_main_loop *loop;
struct spa_source *reneg;
struct pw_stream *stream;
struct spa_hook stream_listener;
struct spa_video_info format;
int32_t stride;
struct spa_rectangle size;
uint32_t n_mod_info;
struct modifier_info mod_info[2];
int counter;
};
static struct pw_version parse_pw_version(const char* version) {
struct pw_version pw_version;
sscanf(version, "%d.%d.%d", &pw_version.major, &pw_version.minor,
&pw_version.micro);
return pw_version;
}
static bool has_pw_version(int major, int minor, int micro) {
struct pw_version pw_version = parse_pw_version(pw_get_library_version());
printf("PW Version: %d.%d.%d\n", pw_version.major, pw_version.minor,
pw_version.micro);
return major <= pw_version.major && minor <= pw_version.minor && micro <= pw_version.micro;
}
static void init_modifiers(struct data *data)
{
data->n_mod_info = 1;
data->mod_info[0].spa_format = SPA_VIDEO_FORMAT_RGB;
data->mod_info[0].n_modifiers = 2;
data->mod_info[0].modifiers[0] = DRM_FORMAT_MOD_LINEAR;
data->mod_info[0].modifiers[1] = DRM_FORMAT_MOD_INVALID;
}
static void destroy_modifiers(struct data *data)
{
data->mod_info[0].n_modifiers = 0;
}
static void strip_modifier(struct data *data, uint32_t spa_format, uint64_t modifier)
{
if (data->mod_info[0].spa_format != spa_format)
return;
struct modifier_info *mod_info = &data->mod_info[0];
uint32_t counter = 0;
// Dropping of single modifiers is only supported on PipeWire 0.3.40 and newer.
// On older PipeWire just dropping all modifiers might work on Versions newer then 0.3.33/35
if (has_pw_version(0,3,40)) {
printf("Dropping a single modifier\n");
for (uint32_t i = 0; i < mod_info->n_modifiers; i++) {
if (mod_info->modifiers[i] == modifier)
continue;
mod_info->modifiers[counter++] = mod_info->modifiers[i];
}
} else {
printf("Dropping all modifiers\n");
counter = 0;
}
mod_info->n_modifiers = counter;
}
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 struct spa_pod *build_format(struct spa_pod_builder *b, SDL_RendererInfo *info, enum spa_video_format format,
uint64_t *modifiers, int modifier_count)
{
struct spa_pod_frame f[2];
int i, c;
/* format */
/* modifiers */
if (modifier_count == 1 && modifiers[0] == DRM_FORMAT_MOD_INVALID) {
// we only support implicit modifiers, use shortpath to skip fixation phase
spa_pod_builder_long(b, modifiers[0]);
} else if (modifier_count > 0) {
// build an enumeration of modifiers
// modifiers from the array
for (i = 0, c = 0; i < modifier_count; i++) {
spa_pod_builder_long(b, modifiers[i]);
if (c++ == 0)
spa_pod_builder_long(b, modifiers[i]);
}
}
&SPA_RECTANGLE(WIDTH, HEIGHT),
&SPA_RECTANGLE(info->max_texture_width,
info->max_texture_height)),
0);
&SPA_FRACTION(25,1),
&SPA_FRACTION(0,1),
&SPA_FRACTION(30,1)),
0);
return spa_pod_builder_pop(b, &f[0]);
}
/* our data processing function is in general:
*
* struct pw_buffer *b;
* b = pw_stream_dequeue_buffer(stream);
*
* .. do stuff with buffer ...
*
* pw_stream_queue_buffer(stream, b);
*/
static void
on_process(void *_data)
{
struct data *data = _data;
struct pw_stream *stream = data->stream;
struct pw_buffer *b;
struct spa_buffer *buf;
void *sdata, *ddata;
int sstride, dstride, ostride;
uint32_t i;
uint8_t *src, *dst;
b = NULL;
/* dequeue and queue old buffers, use the last available
* buffer */
while (true) {
struct pw_buffer *t;
if ((t = pw_stream_dequeue_buffer(stream)) == NULL)
break;
if (b)
b = t;
}
if (b == NULL) {
pw_log_warn("out of buffers: %m");
return;
}
buf = b->buffer;
pw_log_info("new buffer %p", buf);
handle_events(data);
if (buf->datas[0].type == SPA_DATA_DmaBuf) {
// Simulate a failed import of a DmaBuf
// We should try another modifier
printf("Failed to import dmabuf, stripping modifier %"PRIu64"\n", data->format.info.raw.modifier);
strip_modifier(data, data->format.info.raw.format, data->format.info.raw.modifier);
pw_loop_signal_event(pw_main_loop_get_loop(data->loop), data->reneg);
goto done;
}
if ((sdata = buf->datas[0].data) == NULL)
goto done;
if (SDL_LockTexture(data->texture, NULL, &ddata, &dstride) < 0) {
fprintf(stderr, "Couldn't lock texture: %s\n", SDL_GetError());
goto done;
}
/* copy video image in texture */
sstride = buf->datas[0].chunk->stride;
ostride = SPA_MIN(sstride, dstride);
src = sdata;
dst = ddata;
for (i = 0; i < data->size.height; i++) {
memcpy(dst, src, ostride);
src += sstride;
dst += dstride;
}
SDL_UnlockTexture(data->texture);
SDL_RenderClear(data->renderer);
/* now render the video */
SDL_RenderCopy(data->renderer, data->texture, NULL, NULL);
SDL_RenderPresent(data->renderer);
done:
}
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;
fprintf(stderr, "stream state: \"%s\"\n", pw_stream_state_as_string(state));
switch (state) {
pw_main_loop_quit(data->loop);
break;
break;
default:
break;
}
}
/* Be notified when the stream param changes. We're only looking at the
* format changes.
*
* We are now supposed to call pw_stream_finish_format() with success or
* failure, depending on if we can support the format. Because we gave
* a list of supported formats, this should be ok.
*
* As part of pw_stream_finish_format() we can provide parameters that
* will control the buffer memory allocation. This includes the metadata
* that we would like on our buffer, the size, alignment, etc.
*/
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[1];
Uint32 sdl_format;
void *d;
/* NULL means to clear the format */
if (param == NULL || id != SPA_PARAM_Format)
return;
fprintf(stderr, "got format:\n");
spa_debug_format(2, NULL, param);
if (spa_format_parse(param, &data->format.media_type, &data->format.media_subtype) < 0)
return;
if (data->format.media_type != SPA_MEDIA_TYPE_video ||
data->format.media_subtype != SPA_MEDIA_SUBTYPE_raw)
return;
/* call a helper function to parse the format for us. */
spa_format_video_raw_parse(param, &data->format.info.raw);
sdl_format = id_to_sdl_format(data->format.info.raw.format);
data->size = data->format.info.raw.size;
if (sdl_format == SDL_PIXELFORMAT_UNKNOWN) {
pw_stream_set_error(stream, -EINVAL, "unknown pixel format");
return;
}
data->texture = SDL_CreateTexture(data->renderer,
sdl_format,
SDL_TEXTUREACCESS_STREAMING,
data->size.width,
data->size.height);
SDL_LockTexture(data->texture, NULL, &d, &data->stride);
SDL_UnlockTexture(data->texture);
/* a SPA_TYPE_OBJECT_ParamBuffers object defines the acceptable size,
* number, stride etc of the buffers */
SPA_PARAM_BUFFERS_size, SPA_POD_Int(data->stride * data->size.height),
/* we are done */
pw_stream_update_params(stream, params, 1);
}
/* these are the stream events we listen for */
static const struct pw_stream_events stream_events = {
.state_changed = on_stream_state_changed,
.param_changed = on_stream_param_changed,
.process = on_process,
};
static int build_formats(struct data *data, struct spa_pod_builder *b, const struct spa_pod **params)
{
SDL_RendererInfo info;
int n_params = 0;
SDL_GetRendererInfo(data->renderer, &info);
if (data->mod_info[0].n_modifiers > 0) {
params[n_params++] = build_format(b, &info, SPA_VIDEO_FORMAT_RGB, data->mod_info[0].modifiers, data->mod_info[0].n_modifiers);
}
params[n_params++] = build_format(b, &info, SPA_VIDEO_FORMAT_RGB, NULL, 0);
for (int i=0; i < n_params; i++) {
spa_debug_format(2, NULL, params[i]);
}
return n_params;
}
static void reneg_format(void *_data, uint64_t expiration)
{
struct data *data = (struct data*) _data;
uint8_t buffer[1024];
struct spa_pod_builder b = SPA_POD_BUILDER_INIT(buffer, sizeof(buffer));
const struct spa_pod *params[2];
uint32_t n_params;
if (data->format.info.raw.format == 0)
return;
fprintf(stderr, "renegotiate formats:\n");
n_params = build_formats(data, &b, params);
pw_stream_update_params(data->stream, params, n_params);
}
static void do_quit(void *userdata, int signal_number)
{
struct data *data = userdata;
pw_main_loop_quit(data->loop);
}
int main(int argc, char *argv[])
{
struct data data = { 0, };
const struct spa_pod *params[2];
uint8_t buffer[1024];
struct spa_pod_builder b = SPA_POD_BUILDER_INIT(buffer, sizeof(buffer));
struct pw_properties *props;
int res, n_params;
pw_init(&argc, &argv);
/* create a main loop */
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);
/* create a simple stream, the simple stream manages to core and remote
* objects for you if you don't need to deal with them
*
* If you plan to autoconnect your stream, you need to provide at least
* media, category and role properties
*
* Pass your events and a user_data pointer as the last arguments. This
* will inform you about the stream state. The most important event
* you need to listen to is the process event where you need to consume
* the data provided to you.
*/
PW_KEY_MEDIA_ROLE, "Camera",
NULL),
data.path = argc > 1 ? argv[1] : NULL;
if (data.path)
/* Set stream target if given on command line */
data.stream = pw_stream_new_simple(
"video-play-fixate",
props,
&stream_events,
&data);
if (SDL_Init(SDL_INIT_VIDEO) < 0) {
fprintf(stderr, "can't initialize SDL: %s\n", SDL_GetError());
return -1;
}
init_modifiers(&data);
if (SDL_CreateWindowAndRenderer
(WIDTH, HEIGHT, SDL_WINDOW_RESIZABLE, &data.window, &data.renderer)) {
fprintf(stderr, "can't create window: %s\n", SDL_GetError());
return -1;
}
/* build the extra parameters to connect with. To connect, we can provide
* a list of supported formats. We use a builder that writes the param
* object to the stack. */
printf("supported formats:\n");
n_params = build_formats(&data, &b, params);
/* now connect the stream, we need a direction (input/output),
* an optional target node to connect to, some flags and parameters
*/
if ((res = pw_stream_connect(data.stream,
PW_STREAM_FLAG_AUTOCONNECT | /* try to automatically connect this stream */
PW_STREAM_FLAG_MAP_BUFFERS, /* mmap the buffer data for us */
params, n_params)) /* extra parameters, see above */ < 0) {
fprintf(stderr, "can't connect: %s\n", spa_strerror(res));
return -1;
}
data.reneg = pw_loop_add_event(pw_main_loop_get_loop(data.loop), reneg_format, &data);
/* do things until we quit the mainloop */
pw_main_loop_run(data.loop);
pw_stream_destroy(data.stream);
destroy_modifiers(&data);
SDL_DestroyTexture(data.texture);
if (data.cursor)
SDL_DestroyTexture(data.cursor);
SDL_DestroyRenderer(data.renderer);
SDL_DestroyWindow(data.window);
return 0;
}
spa/debug/format.h
#define PW_ID_ANY
Definition: core.h:83
#define PW_KEY_MEDIA_TYPE
Media.
Definition: keys.h:438
#define PW_KEY_TARGET_OBJECT
a target object to link to
Definition: keys.h:508
#define PW_KEY_MEDIA_ROLE
Role: Movie, Music, Camera, Screen, Communication, Game, Notification, DSP, Production,...
Definition: keys.h:444
#define PW_KEY_MEDIA_CATEGORY
Media Category: Playback, Capture, Duplex, Monitor, Manager.
Definition: keys.h:441
#define pw_log_warn(...)
Definition: log.h:163
#define pw_log_info(...)
Definition: log.h:164
#define pw_loop_add_signal(l,...)
Definition: loop.h:83
#define pw_loop_signal_event(l,...)
Definition: loop.h:80
#define pw_loop_add_event(l,...)
Definition: loop.h:79
struct pw_main_loop * pw_main_loop_new(const struct spa_dict *props)
Create a new main loop.
Definition: main-loop.c:80
int pw_main_loop_quit(struct pw_main_loop *loop)
Quit a main loop.
Definition: main-loop.c:125
void pw_main_loop_destroy(struct pw_main_loop *loop)
Destroy a loop.
Definition: main-loop.c:90
int pw_main_loop_run(struct pw_main_loop *loop)
Run a main loop.
Definition: main-loop.c:139
struct pw_loop * pw_main_loop_get_loop(struct pw_main_loop *loop)
Get the loop implementation.
Definition: main-loop.c:113
void pw_init(int *argc, char **argv[])
Initialize PipeWire.
Definition: pipewire.c:580
void pw_deinit(void)
Deinitialize PipeWire.
Definition: pipewire.c:683
#define PW_DIRECTION_INPUT
Definition: port.h:65
struct pw_properties * pw_properties_new(const char *key,...) 1
Make a new properties object.
Definition: properties.c:102
int pw_properties_set(struct pw_properties *properties, const char *key, const char *value)
Set a property value.
Definition: properties.c:439
int int pw_stream_update_params(struct pw_stream *stream, const struct spa_pod **params, uint32_t n_params)
Complete the negotiation process with result code res.
Definition: stream.c:2079
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:1792
int pw_stream_set_error(struct pw_stream *stream, int res, const char *error,...) 1(3
Set the stream in error state.
struct pw_stream * pw_stream_new_simple(struct pw_loop *loop, const char *name, struct pw_properties *props, const struct pw_stream_events *events, void *data)
Definition: stream.c:1539
pw_stream_state
The state of a stream.
Definition: stream.h:200
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:2247
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:2274
const char * pw_stream_state_as_string(enum pw_stream_state state)
Convert a stream state to a readable string.
Definition: stream.c:1583
#define PW_VERSION_STREAM_EVENTS
Definition: stream.h:337
void pw_stream_destroy(struct pw_stream *stream)
Destroy a stream.
Definition: stream.c:1601
@ PW_STREAM_FLAG_MAP_BUFFERS
mmap the buffers except DmaBuf
Definition: stream.h:385
@ PW_STREAM_FLAG_AUTOCONNECT
try to automatically connect this stream
Definition: stream.h:380
@ PW_STREAM_STATE_PAUSED
paused
Definition: stream.h:204
@ PW_STREAM_STATE_UNCONNECTED
unconnected
Definition: stream.h:202
@ PW_STREAM_STATE_STREAMING
streaming
Definition: stream.h:205
@ SPA_DATA_MemPtr
pointer to memory, the data field in struct spa_data is set.
Definition: buffer.h:52
@ SPA_DATA_DmaBuf
fd to dmabuf memory
Definition: buffer.h:55
static int spa_debug_format(int indent, const struct spa_type_info *info, const struct spa_pod *format)
Definition: format.h:122
static int spa_format_parse(const struct spa_pod *format, uint32_t *media_type, uint32_t *media_subtype)
Definition: format-utils.h:47
spa_format
properties for audio SPA_TYPE_OBJECT_Format
Definition: format.h:106
static int spa_format_video_raw_parse(const struct spa_pod *format, struct spa_video_info_raw *info)
Definition: format-utils.h:47
spa_video_format
Video formats.
Definition: raw.h:63
@ SPA_MEDIA_TYPE_video
Definition: format.h:48
@ SPA_PARAM_Format
configured format as SPA_TYPE_OBJECT_Format
Definition: param.h:54
@ SPA_PARAM_EnumFormat
available formats as SPA_TYPE_OBJECT_Format
Definition: param.h:53
@ SPA_PARAM_Buffers
buffer configurations as SPA_TYPE_OBJECT_ParamBuffers
Definition: param.h:55
@ SPA_FORMAT_VIDEO_framerate
frame rate (Fraction)
Definition: format.h:131
@ SPA_FORMAT_mediaType
media type (Id enum spa_media_type)
Definition: format.h:109
@ SPA_FORMAT_VIDEO_size
size (Rectangle)
Definition: format.h:130
@ SPA_FORMAT_VIDEO_modifier
format modifier (Long) use only with DMA-BUF and omit for other buffer types
Definition: format.h:128
@ SPA_FORMAT_VIDEO_format
video format (Id enum spa_video_format)
Definition: format.h:127
@ SPA_FORMAT_mediaSubtype
media subtype (Id enum spa_media_subtype)
Definition: format.h:110
@ SPA_MEDIA_SUBTYPE_raw
Definition: format.h:58
@ SPA_VIDEO_FORMAT_RGB
Definition: raw.h:80
@ SPA_PARAM_BUFFERS_dataType
possible memory types (Int, mask of enum spa_data_type)
Definition: param.h:98
@ SPA_PARAM_BUFFERS_size
size of a data block memory (Int)
Definition: param.h:95
@ SPA_PARAM_BUFFERS_stride
stride of data block memory (Int)
Definition: param.h:96
@ SPA_PARAM_BUFFERS_blocks
number of data blocks per buffer (Int)
Definition: param.h:94
@ SPA_PARAM_BUFFERS_buffers
number of buffers (Int)
Definition: param.h:93
static int spa_pod_builder_prop(struct spa_pod_builder *builder, uint32_t key, uint32_t flags)
Definition: builder.h:470
static void * spa_pod_builder_pop(struct spa_pod_builder *builder, struct spa_pod_frame *frame)
Definition: builder.h:188
#define SPA_POD_CHOICE_RANGE_Fraction(def, min, max)
Definition: vararg.h:135
#define SPA_POD_PROP_FLAG_MANDATORY
is mandatory
Definition: pod.h:242
static int spa_pod_builder_add(struct spa_pod_builder *builder,...)
Definition: builder.h:667
#define SPA_POD_CHOICE_RANGE_Int(def, min, max)
Definition: vararg.h:78
#define SPA_POD_Id(val)
Definition: vararg.h:69
#define SPA_POD_BUILDER_INIT(buffer, size)
Definition: builder.h:82
#define SPA_POD_CHOICE_RANGE_Rectangle(def, min, max)
Definition: vararg.h:126
#define SPA_POD_PROP_FLAG_DONT_FIXATE
choices need no fixation
Definition: pod.h:244
#define spa_pod_builder_add_object(b, type, id,...)
Definition: builder.h:679
static int spa_pod_builder_push_choice(struct spa_pod_builder *builder, struct spa_pod_frame *frame, uint32_t type, uint32_t flags)
Definition: builder.h:426
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:455
static int spa_pod_builder_long(struct spa_pod_builder *builder, int64_t val)
Definition: builder.h:276
#define SPA_POD_Int(val)
Definition: vararg.h:74
#define SPA_POD_CHOICE_FLAGS_Int(flags)
Definition: vararg.h:82
@ SPA_CHOICE_Enum
list: default, alternative,...
Definition: pod.h:170
#define spa_strerror(err)
Definition: result.h:69
@ SPA_TYPE_OBJECT_ParamBuffers
Definition: type.h:97
@ SPA_TYPE_OBJECT_Format
Definition: type.h:96
#define SPA_MIN(a, b)
Definition: defs.h:167
#define SPA_FRACTION(num, denom)
Definition: defs.h:138
#define SPA_RECTANGLE(width, height)
Definition: defs.h:117
pipewire/pipewire.h
spa/utils/result.h
a buffer structure obtained from pw_stream_dequeue_buffer().
Definition: stream.h:210
struct spa_buffer * buffer
the spa buffer
Definition: stream.h:211
A main loop object.
Definition: properties.h:53
Events for a stream.
Definition: stream.h:335
A Buffer.
Definition: buffer.h:109
struct spa_data * datas
array of data members
Definition: buffer.h:113
int32_t stride
stride of valid data
Definition: buffer.h:68
struct spa_chunk * chunk
valid chunk of memory
Definition: buffer.h:105
void * data
optional data pointer
Definition: buffer.h:104
uint32_t type
memory type, one of enum spa_data_type, when allocating memory, the type contains a bitmask of allowe...
Definition: buffer.h:82
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:351
Definition: builder.h:73
Definition: iter.h:47
Definition: pod.h:63
Definition: defs.h:118
Definition: loop.h:75
Definition: format.h:45