export-dmabuf: add basic and incomplete implementation
This commit is contained in:
emersion
parent
9e26808c28
commit
36bd4795d4
|
|
@ -0,0 +1,33 @@
|
|||
#ifndef WLR_TYPES_WLR_EXPORT_DMABUF_V1_H
|
||||
#define WLR_TYPES_WLR_EXPORT_DMABUF_V1_H
|
||||
|
||||
#include <wayland-server.h>
|
||||
|
||||
struct wlr_export_dmabuf_manager_v1;
|
||||
|
||||
struct wlr_export_dmabuf_frame_v1 {
|
||||
struct wl_resource *resource;
|
||||
struct wlr_export_dmabuf_manager_v1 *manager;
|
||||
struct wl_list link;
|
||||
|
||||
struct wlr_output *output;
|
||||
};
|
||||
|
||||
struct wlr_export_dmabuf_manager_v1 {
|
||||
struct wl_global *global;
|
||||
struct wl_list resources;
|
||||
struct wl_list frames;
|
||||
|
||||
struct wl_listener display_destroy;
|
||||
|
||||
struct {
|
||||
struct wl_signal destroy;
|
||||
} events;
|
||||
};
|
||||
|
||||
struct wlr_export_dmabuf_manager_v1 *wlr_export_dmabuf_manager_v1_create(
|
||||
struct wl_display *display);
|
||||
void wlr_export_dmabuf_manager_v1_destroy(
|
||||
struct wlr_export_dmabuf_manager_v1 *manager);
|
||||
|
||||
#endif
|
||||
|
|
@ -39,8 +39,9 @@ protocols = [
|
|||
'screenshooter.xml',
|
||||
'server-decoration.xml',
|
||||
'virtual-keyboard-unstable-v1.xml',
|
||||
'wlr-layer-shell-unstable-v1.xml',
|
||||
'wlr-export-dmabuf-unstable-v1.xml',
|
||||
'wlr-input-inhibitor-unstable-v1.xml',
|
||||
'wlr-layer-shell-unstable-v1.xml',
|
||||
]
|
||||
|
||||
client_protocols = [
|
||||
|
|
|
|||
|
|
@ -0,0 +1,230 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<protocol name="wlr_export_dmabuf_unstable_v1">
|
||||
|
||||
<copyright>
|
||||
Copyright © 2018 Rostislav Pehlivanov
|
||||
|
||||
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.
|
||||
</copyright>
|
||||
|
||||
<description summary="a frame ready for readout">
|
||||
An interface to capture surfaces in an efficient way.
|
||||
Overall usage:
|
||||
|
||||
1.) client registers with zwlr_screencontent_manager_v1
|
||||
2.) server sends client info about surfaces via "receive_surface_info"
|
||||
3.) client subscribes to capture a surface via the "capture" requests
|
||||
4.) server sends client events via the "zwlr_screencontent_frame" interface
|
||||
5.) client finishes and informs server via the "frame_destroy" event
|
||||
6.) client optionally resubscribes via repeating steps 3.) through 5.)
|
||||
</description>
|
||||
|
||||
<interface name="zwlr_export_dmabuf_frame_v1" version="1">
|
||||
<description summary="a frame ready for readout">
|
||||
This object represents a frame which is ready to have its resources
|
||||
fetched and used.
|
||||
|
||||
The receive callback shall be called first, followed by either the
|
||||
"dma_object" callback once per object or the "dma_layer" callback,
|
||||
once per layer. The "dma_plane" callback shall only be called after
|
||||
the "dma_layer" callback corresponding to the layer the plane belongs
|
||||
to has been called. Finally, the "ready" event is called to indicate that
|
||||
all the data has been made available for readout, as well as the time
|
||||
at which presentation happened at.
|
||||
The ownership of the frame is passed to the client, who's responsible for
|
||||
destroying it via the "destroy" event once finished.
|
||||
The data the API describes has been based off of what
|
||||
VASurfaceAttribExternalBuffers contains.
|
||||
All frames are read-only and may not be written into or altered.
|
||||
</description>
|
||||
|
||||
<enum name="frame_flags">
|
||||
<description summary="frame flags">
|
||||
Special flags that must be respected by the client.
|
||||
Transient frames indicate short lifetime frames (such as swapchain
|
||||
images from external clients). Clients are advised to copy them and do
|
||||
all processing outside of the "ready" event.
|
||||
</description>
|
||||
<entry name="transient" value="1" since="1"/>
|
||||
</enum>
|
||||
|
||||
<event name="frame">
|
||||
<description summary="main callback">
|
||||
Main callback supplying the client with information about the frame,
|
||||
as well as an object to serve as context for destruction. Always called
|
||||
first before any other events.
|
||||
|
||||
The "transform" argument describes the orientation needed to be applied
|
||||
to correctly orient the buffer. For example, a buffer rotated by 90
|
||||
degrees will have a value of "3" here, corresponding to the need to
|
||||
apply a 270 degree transpose to correctly present the buffer.
|
||||
</description>
|
||||
<arg name="width" type="uint"
|
||||
summary="frame width, scaling factor included"/>
|
||||
<arg name="height" type="uint"
|
||||
summary="frame height, scaling factor included"/>
|
||||
<arg name="scale" type="uint"
|
||||
summary="current scaling factor of the client"/>
|
||||
<arg name="transform" type="uint"
|
||||
summary="transform needed to correct the orientation, has the same
|
||||
values as wl_output::transform"/>
|
||||
<arg name="flags" type="uint"
|
||||
summary="flags which indicate properties (invert, interlacing),
|
||||
has the same values as zwp_linux_buffer_params_v1:flags"/>
|
||||
<arg name="frame_flags" type="uint" enum="frame_flags"
|
||||
summary="indicates special frame features"/>
|
||||
<arg name="mod_high" type="uint"
|
||||
summary="drm format modifier, high"/>
|
||||
<arg name="mod_low" type="uint"
|
||||
summary="drm format modifier, low"/>
|
||||
<arg name="num_objects" type="uint"
|
||||
summary="indicates how many objects (FDs) the frame has (max 4)"/>
|
||||
<arg name="num_layers" type="uint"
|
||||
summary="indicates how many layers the frame has (max 4)"/>
|
||||
</event>
|
||||
<event name="dma_object">
|
||||
<description summary="object receiving callback">
|
||||
Callback which serves to supply the client with the file descriptors
|
||||
containing the data for each object.
|
||||
</description>
|
||||
<arg name="index" type="uint"
|
||||
summary="index of the current object"/>
|
||||
<arg name="fd" type="fd"
|
||||
summary="fd of the current object"/>
|
||||
<arg name="size" type="uint"
|
||||
summary="size in bytes for the current object"/>
|
||||
</event>
|
||||
<event name="dma_layer">
|
||||
<description summary="layer receiving callback">
|
||||
Callback which serves to supply the client with information on what's
|
||||
contained in each file descriptor and how its laid out.
|
||||
Will be called after the main receive event, once per layer.
|
||||
</description>
|
||||
<arg name="index" type="uint"
|
||||
summary="index of the current plane"/>
|
||||
<arg name="format" type="uint"
|
||||
summary="format of the layer (DRM_FORMAT_*)"/>
|
||||
<arg name="num_planes" type="uint"
|
||||
summary="number of planes in the current layer (max 4)"/>
|
||||
</event>
|
||||
<event name="dma_plane">
|
||||
<description summary="plane info receiving callback">
|
||||
Callback which supplies the client with plane information for each
|
||||
layer.
|
||||
</description>
|
||||
<arg name="index" type="uint"
|
||||
summary="index of the current plane"/>
|
||||
<arg name="layer_index" type="uint"
|
||||
summary="index of the current layer"/>
|
||||
<arg name="object_index" type="uint"
|
||||
summary="index of the object the plane applies to"/>
|
||||
<arg name="offset" type="uint"
|
||||
summary="starting point for the data in the object's fd"/>
|
||||
<arg name="stride" type="uint"
|
||||
summary="line size in bytes"/>
|
||||
</event>
|
||||
<event name="ready">
|
||||
<description summary="indicates frame is available for reading">
|
||||
Called as soon as the frame is presented, indicating it is available
|
||||
for reading.
|
||||
The timestamp is expressed as tv_sec_hi, tv_sec_lo, tv_nsec triples,
|
||||
each component being an unsigned 32-bit value. Whole seconds are in
|
||||
tv_sec which is a 64-bit value combined from tv_sec_hi and tv_sec_lo,
|
||||
and the additional fractional part in tv_nsec as nanoseconds. Hence,
|
||||
for valid timestamps tv_nsec must be in [0, 999999999].
|
||||
The seconds part may have an arbitrary offset at start.
|
||||
</description>
|
||||
<arg name="tv_sec_hi" type="uint"
|
||||
summary="high 32 bits of the seconds part of the timestamp"/>
|
||||
<arg name="tv_sec_lo" type="uint"
|
||||
summary="low 32 bits of the seconds part of the timestamp"/>
|
||||
<arg name="tv_nsec" type="uint"
|
||||
summary="nanoseconds part of the timestamp"/>
|
||||
</event>
|
||||
<event name="abort">
|
||||
<description summary="indicates the frame is no longer valid">
|
||||
If the frame is no longer valid after the "frame" event has been called,
|
||||
this callback will be used to inform the client to scrap the frame.
|
||||
Source is still valid for as long as the subscription function does not
|
||||
return NULL.
|
||||
This may get called if for instance the surface is in the process of
|
||||
resizing.
|
||||
</description>
|
||||
</event>
|
||||
|
||||
<request name="destroy" type="destructor">
|
||||
<description summary="delete this object, used or not">
|
||||
Unreferences the frame, allowing it to be reused. Must be called as soon
|
||||
as its no longer used.
|
||||
</description>
|
||||
</request>
|
||||
</interface>
|
||||
|
||||
<interface name="zwlr_export_dmabuf_manager_v1" version="1">
|
||||
<description summary="manager to inform clients and begin capturing">
|
||||
This object is a manager which informs clients about capturable windows
|
||||
and is able to create callbacks from which to begin to receive content
|
||||
from. The "title" argument in the "surface_info" event shall be used
|
||||
to provide a user-readable identifier such as a window title or
|
||||
program name.
|
||||
</description>
|
||||
|
||||
<event name="surface_info">
|
||||
<description summary="get valid surfaces for capture">
|
||||
This will be called whenever a surface that's able to be captured
|
||||
appears.
|
||||
</description>
|
||||
<arg name="title" type="string"
|
||||
summary="window title or an identifier"/>
|
||||
<arg name="id" type="uint"
|
||||
summary="an identifier to create a context with"/>
|
||||
</event>
|
||||
<event name="surface_unavailable">
|
||||
<description summary="notifies of a surface being unavailable to capture">
|
||||
Called if a surface becomes unavailable to capture, for example if has
|
||||
been closed.
|
||||
</description>
|
||||
<arg name="id" type="uint"
|
||||
summary="an identifier of the surface"/>
|
||||
</event>
|
||||
|
||||
<request name="capture_client">
|
||||
<description summary="subscribe to start capturing">
|
||||
Request to start capturing from a surface with a given id.
|
||||
If an ID becomes unavailable, a NULL will be returned.
|
||||
</description>
|
||||
<arg name="frame" type="new_id"
|
||||
interface="zwlr_export_dmabuf_frame_v1"/>
|
||||
<arg name="id" type="uint"
|
||||
summary="an identifier to start capturing from"/>
|
||||
<arg name="overlay_cursor" type="int"
|
||||
summary="overlay custom client hardware cursor on top of the frame"/>
|
||||
</request>
|
||||
<request name="capture_output">
|
||||
<description summary="subscribe to start capturing">
|
||||
Request to start capturing from an entire wl_output.
|
||||
If an output becomes unavailable, a NULL will be returned.
|
||||
</description>
|
||||
<arg name="frame" type="new_id"
|
||||
interface="zwlr_export_dmabuf_frame_v1"/>
|
||||
<arg name="out" type="object" interface="wl_output" allow-null="false"/>
|
||||
</request>
|
||||
</interface>
|
||||
</protocol>
|
||||
|
|
@ -22,6 +22,7 @@ lib_wlr_types = static_library(
|
|||
'wlr_box.c',
|
||||
'wlr_compositor.c',
|
||||
'wlr_cursor.c',
|
||||
'wlr_export_dmabuf_v1.c',
|
||||
'wlr_gamma_control.c',
|
||||
'wlr_idle_inhibit_v1.c',
|
||||
'wlr_idle.c',
|
||||
|
|
|
|||
|
|
@ -0,0 +1,185 @@
|
|||
#include <assert.h>
|
||||
#include <stdlib.h>
|
||||
#include <unistd.h>
|
||||
#include <wlr/types/wlr_export_dmabuf_v1.h>
|
||||
#include <wlr/types/wlr_linux_dmabuf.h>
|
||||
#include <wlr/types/wlr_output.h>
|
||||
#include "wlr-export-dmabuf-unstable-v1-protocol.h"
|
||||
|
||||
#define EXPORT_DMABUF_MANAGER_VERSION 1
|
||||
|
||||
|
||||
static const struct zwlr_export_dmabuf_frame_v1_interface frame_impl;
|
||||
|
||||
static struct wlr_export_dmabuf_frame_v1 *frame_from_resource(
|
||||
struct wl_resource *resource) {
|
||||
assert(wl_resource_instance_of(resource,
|
||||
&zwlr_export_dmabuf_frame_v1_interface, &frame_impl));
|
||||
return wl_resource_get_user_data(resource);
|
||||
}
|
||||
|
||||
static void frame_handle_destroy(struct wl_client *client,
|
||||
struct wl_resource *resource) {
|
||||
wl_resource_destroy(resource);
|
||||
}
|
||||
|
||||
static const struct zwlr_export_dmabuf_frame_v1_interface frame_impl = {
|
||||
.destroy = frame_handle_destroy,
|
||||
};
|
||||
|
||||
static void frame_handle_resource_destroy(struct wl_resource *resource) {
|
||||
struct wlr_export_dmabuf_frame_v1 *frame = frame_from_resource(resource);
|
||||
wl_list_remove(&frame->link);
|
||||
free(frame);
|
||||
}
|
||||
|
||||
|
||||
static const struct zwlr_export_dmabuf_manager_v1_interface manager_impl;
|
||||
|
||||
static struct wlr_export_dmabuf_manager_v1 *manager_from_resource(
|
||||
struct wl_resource *resource) {
|
||||
assert(wl_resource_instance_of(resource,
|
||||
&zwlr_export_dmabuf_manager_v1_interface, &manager_impl));
|
||||
return wl_resource_get_user_data(resource);
|
||||
}
|
||||
|
||||
static void manager_handle_capture_client(struct wl_client *client,
|
||||
struct wl_resource *manager_resource, uint32_t id,
|
||||
uint32_t client_id, int32_t overlay_cursor) {
|
||||
// TODO
|
||||
}
|
||||
|
||||
static void manager_handle_capture_output(struct wl_client *client,
|
||||
struct wl_resource *manager_resource, uint32_t id,
|
||||
struct wl_resource *output_resource) {
|
||||
struct wlr_export_dmabuf_manager_v1 *manager =
|
||||
manager_from_resource(manager_resource);
|
||||
struct wlr_output *output = wlr_output_from_resource(output_resource);
|
||||
|
||||
struct wlr_export_dmabuf_frame_v1 *frame =
|
||||
calloc(1, sizeof(struct wlr_export_dmabuf_frame_v1));
|
||||
if (frame == NULL) {
|
||||
wl_resource_post_no_memory(manager_resource);
|
||||
return;
|
||||
}
|
||||
frame->manager = manager;
|
||||
frame->output = output;
|
||||
|
||||
uint32_t version = wl_resource_get_version(manager_resource);
|
||||
frame->resource = wl_resource_create(client,
|
||||
&zwlr_export_dmabuf_frame_v1_interface, version, id);
|
||||
if (frame->resource == NULL) {
|
||||
wl_client_post_no_memory(client);
|
||||
return;
|
||||
}
|
||||
wl_resource_set_implementation(frame->resource, &frame_impl, frame,
|
||||
frame_handle_resource_destroy);
|
||||
|
||||
wl_list_insert(&manager->frames, &frame->link);
|
||||
|
||||
struct wlr_dmabuf_buffer_attribs attribs;
|
||||
if (!wlr_output_export_dmabuf(output, &attribs)) {
|
||||
zwlr_export_dmabuf_frame_v1_send_abort(frame->resource);
|
||||
return;
|
||||
}
|
||||
|
||||
// TODO: multiple layers support
|
||||
|
||||
uint32_t frame_flags = 0;
|
||||
uint32_t mod_high = attribs.modifier[0] >> 32;
|
||||
uint32_t mod_low = attribs.modifier[0];
|
||||
|
||||
zwlr_export_dmabuf_frame_v1_send_frame(frame->resource,
|
||||
output->width, output->height, output->scale, output->transform,
|
||||
attribs.flags, frame_flags, mod_high, mod_low, attribs.n_planes, 1);
|
||||
|
||||
zwlr_export_dmabuf_frame_v1_send_dma_layer(frame->resource, 0,
|
||||
attribs.format, 1);
|
||||
|
||||
for (int i = 0; i < attribs.n_planes; ++i) {
|
||||
// TODO: what to do if the kernel doesn't support seek on buffer
|
||||
off_t size = lseek(attribs.fd[i], 0, SEEK_END);
|
||||
|
||||
zwlr_export_dmabuf_frame_v1_send_dma_object(frame->resource, i,
|
||||
attribs.fd[i], size);
|
||||
zwlr_export_dmabuf_frame_v1_send_dma_plane(frame->resource, i, 0, i,
|
||||
attribs.offset[i], attribs.stride[i]);
|
||||
}
|
||||
|
||||
// TODO: wait for the frame to be ready
|
||||
// TODO: timestamps
|
||||
zwlr_export_dmabuf_frame_v1_send_ready(frame->resource, 0, 0, 0);
|
||||
}
|
||||
|
||||
static const struct zwlr_export_dmabuf_manager_v1_interface manager_impl = {
|
||||
.capture_client = manager_handle_capture_client,
|
||||
.capture_output = manager_handle_capture_output,
|
||||
};
|
||||
|
||||
static void manager_handle_resource_destroy(struct wl_resource *resource) {
|
||||
wl_list_remove(wl_resource_get_link(resource));
|
||||
}
|
||||
|
||||
static void manager_bind(struct wl_client *client, void *data, uint32_t version,
|
||||
uint32_t id) {
|
||||
struct wlr_export_dmabuf_manager_v1 *manager = data;
|
||||
|
||||
struct wl_resource *resource = wl_resource_create(client,
|
||||
&zwlr_export_dmabuf_manager_v1_interface, version, id);
|
||||
if (resource == NULL) {
|
||||
wl_client_post_no_memory(client);
|
||||
return;
|
||||
}
|
||||
wl_resource_set_implementation(resource, &manager_impl, manager,
|
||||
manager_handle_resource_destroy);
|
||||
|
||||
wl_list_insert(&manager->resources, wl_resource_get_link(resource));
|
||||
}
|
||||
|
||||
static void handle_display_destroy(struct wl_listener *listener, void *data) {
|
||||
struct wlr_export_dmabuf_manager_v1 *manager =
|
||||
wl_container_of(listener, manager, display_destroy);
|
||||
wlr_export_dmabuf_manager_v1_destroy(manager);
|
||||
}
|
||||
|
||||
struct wlr_export_dmabuf_manager_v1 *wlr_export_dmabuf_manager_v1_create(
|
||||
struct wl_display *display) {
|
||||
struct wlr_export_dmabuf_manager_v1 *manager =
|
||||
calloc(1, sizeof(struct wlr_export_dmabuf_manager_v1));
|
||||
if (manager == NULL) {
|
||||
return NULL;
|
||||
}
|
||||
wl_list_init(&manager->resources);
|
||||
wl_list_init(&manager->frames);
|
||||
|
||||
manager->global = wl_global_create(display,
|
||||
&zwlr_export_dmabuf_manager_v1_interface, EXPORT_DMABUF_MANAGER_VERSION,
|
||||
manager, manager_bind);
|
||||
if (manager->global == NULL) {
|
||||
free(manager);
|
||||
return NULL;
|
||||
}
|
||||
|
||||
manager->display_destroy.notify = handle_display_destroy;
|
||||
wl_display_add_destroy_listener(display, &manager->display_destroy);
|
||||
|
||||
return manager;
|
||||
}
|
||||
|
||||
void wlr_export_dmabuf_manager_v1_destroy(
|
||||
struct wlr_export_dmabuf_manager_v1 *manager) {
|
||||
if (manager == NULL) {
|
||||
return;
|
||||
}
|
||||
wl_list_remove(&manager->display_destroy.link);
|
||||
wl_global_destroy(manager->global);
|
||||
struct wl_resource *resource, *resource_tmp;
|
||||
wl_resource_for_each_safe(resource, resource_tmp, &manager->resources) {
|
||||
wl_resource_destroy(resource);
|
||||
}
|
||||
struct wlr_export_dmabuf_frame_v1 *frame, *frame_tmp;
|
||||
wl_list_for_each_safe(frame, frame_tmp, &manager->frames, link) {
|
||||
wl_resource_destroy(frame->resource);
|
||||
}
|
||||
free(manager);
|
||||
}
|
||||
Loading…
Reference in New Issue