From: Derek Foreman Date: Wed, 18 Jan 2017 14:58:20 +0000 (-0600) Subject: ecore_wl2: Auto generate dmabuf protocol X-Git-Tag: upstream/1.20.0~2398 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=163a7bb76cd1ec3b0e92a89c928f7797b703da71;p=platform%2Fupstream%2Fefl.git ecore_wl2: Auto generate dmabuf protocol Remove the server protocol file as we don't need it here. Generally a trivial change as we have a recent version in tree with no weird changes. --- diff --git a/.gitignore b/.gitignore index 8c38228..b545383 100644 --- a/.gitignore +++ b/.gitignore @@ -79,5 +79,7 @@ Session.vim /src/bin/ecore_con/efl_net_proxy_helper #Once all protocols are generated these will use wildcards +/src/lib/ecore_wl2/linux-dmabuf-unstable-v1-client-protocol.h +/src/lib/ecore_wl2/linux-dmabuf-unstable-v1-protocol.c /src/lib/ecore_wl2/session-recovery-client-protocol.h /src/lib/ecore_wl2/session-recovery-protocol.c diff --git a/src/Makefile_Ecore_Wl2.am b/src/Makefile_Ecore_Wl2.am index 7ad1662..c328ea7 100644 --- a/src/Makefile_Ecore_Wl2.am +++ b/src/Makefile_Ecore_Wl2.am @@ -38,6 +38,8 @@ lib_ecore_wl2_libecore_wl2_la_DEPENDENCIES = @ECORE_WL2_INTERNAL_LIBS@ lib_ecore_wl2_libecore_wl2_la_LDFLAGS = @EFL_LTLIBRARY_FLAGS@ BUILT_SOURCES += \ + lib/ecore_wl2/linux-dmabuf-unstable-v1-protocol.c \ + lib/ecore_wl2/linux-dmabuf-unstable-v1-client-protocol.h \ lib/ecore_wl2/session-recovery-protocol.c \ lib/ecore_wl2/session-recovery-client-protocol.h diff --git a/src/Makefile_Evas.am b/src/Makefile_Evas.am index c78a398..620f6a0 100644 --- a/src/Makefile_Evas.am +++ b/src/Makefile_Evas.am @@ -1263,6 +1263,7 @@ modules_evas_engines_wayland_shm_module_la_CPPFLAGS = -I$(top_builddir)/src/lib/ -I$(top_srcdir)/src/lib/evas/include \ -I$(top_srcdir)/src/lib/evas/cserve2 \ -I$(top_srcdir)/src/lib/ecore_wl2 \ +-I$(top_builddir)/src/lib/ecore_wl2 \ -I$(top_srcdir)/src/static_libs/libdrm \ -I$(top_srcdir)/src/modules/evas/engines/wayland_common \ @EVAS_CFLAGS@ \ diff --git a/src/lib/ecore_wl2/linux-dmabuf-unstable-v1-client-protocol.h b/src/lib/ecore_wl2/linux-dmabuf-unstable-v1-client-protocol.h deleted file mode 100644 index f96f26e..0000000 --- a/src/lib/ecore_wl2/linux-dmabuf-unstable-v1-client-protocol.h +++ /dev/null @@ -1,536 +0,0 @@ -#ifndef LINUX_DMABUF_UNSTABLE_V1_CLIENT_PROTOCOL_H -#define LINUX_DMABUF_UNSTABLE_V1_CLIENT_PROTOCOL_H - -#ifdef __cplusplus -extern "C" { -#endif - -#include -#include -#include "wayland-client.h" - -struct wl_client; -struct wl_resource; - -/** - * @page page_linux_dmabuf_unstable_v1 The linux_dmabuf_unstable_v1 protocol - * @section page_ifaces_linux_dmabuf_unstable_v1 Interfaces - * - @subpage page_iface_zwp_linux_dmabuf_v1 - factory for creating dmabuf-based wl_buffers - * - @subpage page_iface_zwp_linux_buffer_params_v1 - parameters for creating a dmabuf-based wl_buffer - * @section page_copyright_linux_dmabuf_unstable_v1 Copyright - *
- *
- * Copyright © 2014, 2015 Collabora, Ltd.
- *
- * Permission to use, copy, modify, distribute, and sell this
- * software and its documentation for any purpose is hereby granted
- * without fee, provided that the above copyright notice appear in
- * all copies and that both that copyright notice and this permission
- * notice appear in supporting documentation, and that the name of
- * the copyright holders not be used in advertising or publicity
- * pertaining to distribution of the software without specific,
- * written prior permission.  The copyright holders make no
- * representations about the suitability of this software for any
- * purpose.  It is provided "as is" without express or implied
- * warranty.
- *
- * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
- * SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
- * FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
- * SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
- * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
- * AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
- * ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
- * THIS SOFTWARE.
- * 
- */ -struct wl_buffer; -struct zwp_linux_buffer_params_v1; -struct zwp_linux_dmabuf_v1; - -/** - * @page page_iface_zwp_linux_dmabuf_v1 zwp_linux_dmabuf_v1 - * @section page_iface_zwp_linux_dmabuf_v1_desc Description - * - * Following the interfaces from: - * https://www.khronos.org/registry/egl/extensions/EXT/EGL_EXT_image_dma_buf_import.txt - * and the Linux DRM sub-system's AddFb2 ioctl. - * - * This interface offers a way to create generic dmabuf-based - * wl_buffers. Immediately after a client binds to this interface, - * the set of supported formats is sent with 'format' events. - * - * The following are required from clients: - * - * - Clients must ensure that either all data in the dma-buf is - * coherent for all subsequent read access or that coherency is - * correctly handled by the underlying kernel-side dma-buf - * implementation. - * - * - Don't make any more attachments after sending the buffer to the - * compositor. Making more attachments later increases the risk of - * the compositor not being able to use (re-import) an existing - * dmabuf-based wl_buffer. - * - * The underlying graphics stack must ensure the following: - * - * - The dmabuf file descriptors relayed to the server will stay valid - * for the whole lifetime of the wl_buffer. This means the server may - * at any time use those fds to import the dmabuf into any kernel - * sub-system that might accept it. - * - * To create a wl_buffer from one or more dmabufs, a client creates a - * zwp_linux_dmabuf_params_v1 object with zwp_linux_dmabuf_v1.create_params - * request. All planes required by the intended format are added with - * the 'add' request. Finally, 'create' request is issued. The server - * will reply with either 'created' event which provides the final - * wl_buffer or 'failed' event saying that it cannot use the dmabufs - * provided. - * - * Warning! The protocol described in this file is experimental and - * backward incompatible changes may be made. Backward compatible changes - * may be added together with the corresponding interface version bump. - * Backward incompatible changes are done by bumping the version number in - * the protocol and interface names and resetting the interface version. - * Once the protocol is to be declared stable, the 'z' prefix and the - * version number in the protocol and interface names are removed and the - * interface version number is reset. - * @section page_iface_zwp_linux_dmabuf_v1_api API - * See @ref iface_zwp_linux_dmabuf_v1. - */ -/** - * @defgroup iface_zwp_linux_dmabuf_v1 The zwp_linux_dmabuf_v1 interface - * - * Following the interfaces from: - * https://www.khronos.org/registry/egl/extensions/EXT/EGL_EXT_image_dma_buf_import.txt - * and the Linux DRM sub-system's AddFb2 ioctl. - * - * This interface offers a way to create generic dmabuf-based - * wl_buffers. Immediately after a client binds to this interface, - * the set of supported formats is sent with 'format' events. - * - * The following are required from clients: - * - * - Clients must ensure that either all data in the dma-buf is - * coherent for all subsequent read access or that coherency is - * correctly handled by the underlying kernel-side dma-buf - * implementation. - * - * - Don't make any more attachments after sending the buffer to the - * compositor. Making more attachments later increases the risk of - * the compositor not being able to use (re-import) an existing - * dmabuf-based wl_buffer. - * - * The underlying graphics stack must ensure the following: - * - * - The dmabuf file descriptors relayed to the server will stay valid - * for the whole lifetime of the wl_buffer. This means the server may - * at any time use those fds to import the dmabuf into any kernel - * sub-system that might accept it. - * - * To create a wl_buffer from one or more dmabufs, a client creates a - * zwp_linux_dmabuf_params_v1 object with zwp_linux_dmabuf_v1.create_params - * request. All planes required by the intended format are added with - * the 'add' request. Finally, 'create' request is issued. The server - * will reply with either 'created' event which provides the final - * wl_buffer or 'failed' event saying that it cannot use the dmabufs - * provided. - * - * Warning! The protocol described in this file is experimental and - * backward incompatible changes may be made. Backward compatible changes - * may be added together with the corresponding interface version bump. - * Backward incompatible changes are done by bumping the version number in - * the protocol and interface names and resetting the interface version. - * Once the protocol is to be declared stable, the 'z' prefix and the - * version number in the protocol and interface names are removed and the - * interface version number is reset. - */ -extern const struct wl_interface zwp_linux_dmabuf_v1_interface; -/** - * @page page_iface_zwp_linux_buffer_params_v1 zwp_linux_buffer_params_v1 - * @section page_iface_zwp_linux_buffer_params_v1_desc Description - * - * This temporary object is a collection of dmabufs and other - * parameters that together form a single logical buffer. The temporary - * object may eventually create one wl_buffer unless cancelled by - * destroying it before requesting 'create'. - * - * Single-planar formats only require one dmabuf, however - * multi-planar formats may require more than one dmabuf. For all - * formats, 'add' request must be called once per plane (even if the - * underlying dmabuf fd is identical). - * - * You must use consecutive plane indices ('plane_idx' argument for 'add') - * from zero to the number of planes used by the drm_fourcc format code. - * All planes required by the format must be given exactly once, but can - * be given in any order. Each plane index can be set only once. - * @section page_iface_zwp_linux_buffer_params_v1_api API - * See @ref iface_zwp_linux_buffer_params_v1. - */ -/** - * @defgroup iface_zwp_linux_buffer_params_v1 The zwp_linux_buffer_params_v1 interface - * - * This temporary object is a collection of dmabufs and other - * parameters that together form a single logical buffer. The temporary - * object may eventually create one wl_buffer unless cancelled by - * destroying it before requesting 'create'. - * - * Single-planar formats only require one dmabuf, however - * multi-planar formats may require more than one dmabuf. For all - * formats, 'add' request must be called once per plane (even if the - * underlying dmabuf fd is identical). - * - * You must use consecutive plane indices ('plane_idx' argument for 'add') - * from zero to the number of planes used by the drm_fourcc format code. - * All planes required by the format must be given exactly once, but can - * be given in any order. Each plane index can be set only once. - */ -extern const struct wl_interface zwp_linux_buffer_params_v1_interface; - -/** - * @ingroup iface_zwp_linux_dmabuf_v1 - * @struct zwp_linux_dmabuf_v1_listener - */ -struct zwp_linux_dmabuf_v1_listener { - /** - * supported buffer format - * - * This event advertises one buffer format that the server - * supports. All the supported formats are advertised once when the - * client binds to this interface. A roundtrip after binding - * guarantees, that the client has received all supported formats. - * - * For the definition of the format codes, see create request. - * - * XXX: Can a compositor ever enumerate them? - * @param format DRM_FORMAT code - */ - void (*format)(void *data, - struct zwp_linux_dmabuf_v1 *zwp_linux_dmabuf_v1, - uint32_t format); -}; - -/** - * @ingroup zwp_linux_dmabuf_v1_iface - */ -static inline int -zwp_linux_dmabuf_v1_add_listener(struct zwp_linux_dmabuf_v1 *zwp_linux_dmabuf_v1, - const struct zwp_linux_dmabuf_v1_listener *listener, void *data) -{ - return wl_proxy_add_listener((struct wl_proxy *) zwp_linux_dmabuf_v1, - (void (**)(void)) listener, data); -} - -#define ZWP_LINUX_DMABUF_V1_DESTROY 0 -#define ZWP_LINUX_DMABUF_V1_CREATE_PARAMS 1 - -/** - * @ingroup iface_zwp_linux_dmabuf_v1 - */ -#define ZWP_LINUX_DMABUF_V1_DESTROY_SINCE_VERSION 1 -/** - * @ingroup iface_zwp_linux_dmabuf_v1 - */ -#define ZWP_LINUX_DMABUF_V1_CREATE_PARAMS_SINCE_VERSION 1 - -/** @ingroup iface_zwp_linux_dmabuf_v1 */ -static inline void -zwp_linux_dmabuf_v1_set_user_data(struct zwp_linux_dmabuf_v1 *zwp_linux_dmabuf_v1, void *user_data) -{ - wl_proxy_set_user_data((struct wl_proxy *) zwp_linux_dmabuf_v1, user_data); -} - -/** @ingroup iface_zwp_linux_dmabuf_v1 */ -static inline void * -zwp_linux_dmabuf_v1_get_user_data(struct zwp_linux_dmabuf_v1 *zwp_linux_dmabuf_v1) -{ - return wl_proxy_get_user_data((struct wl_proxy *) zwp_linux_dmabuf_v1); -} - -static inline uint32_t -zwp_linux_dmabuf_v1_get_version(struct zwp_linux_dmabuf_v1 *zwp_linux_dmabuf_v1) -{ - return wl_proxy_get_version((struct wl_proxy *) zwp_linux_dmabuf_v1); -} - -/** - * @ingroup iface_zwp_linux_dmabuf_v1 - * - * Objects created through this interface, especially wl_buffers, will - * remain valid. - */ -static inline void -zwp_linux_dmabuf_v1_destroy(struct zwp_linux_dmabuf_v1 *zwp_linux_dmabuf_v1) -{ - wl_proxy_marshal((struct wl_proxy *) zwp_linux_dmabuf_v1, - ZWP_LINUX_DMABUF_V1_DESTROY); - - wl_proxy_destroy((struct wl_proxy *) zwp_linux_dmabuf_v1); -} - -/** - * @ingroup iface_zwp_linux_dmabuf_v1 - * - * This temporary object is used to collect multiple dmabuf handles into - * a single batch to create a wl_buffer. It can only be used once and - * should be destroyed after an 'created' or 'failed' event has been - * received. - */ -static inline struct zwp_linux_buffer_params_v1 * -zwp_linux_dmabuf_v1_create_params(struct zwp_linux_dmabuf_v1 *zwp_linux_dmabuf_v1) -{ - struct wl_proxy *params_id; - - params_id = wl_proxy_marshal_constructor((struct wl_proxy *) zwp_linux_dmabuf_v1, - ZWP_LINUX_DMABUF_V1_CREATE_PARAMS, &zwp_linux_buffer_params_v1_interface, NULL); - - return (struct zwp_linux_buffer_params_v1 *) params_id; -} - -#ifndef ZWP_LINUX_BUFFER_PARAMS_V1_ERROR_ENUM -#define ZWP_LINUX_BUFFER_PARAMS_V1_ERROR_ENUM -enum zwp_linux_buffer_params_v1_error { - /** - * the dmabuf_batch object has already been used to create a wl_buffer - */ - ZWP_LINUX_BUFFER_PARAMS_V1_ERROR_ALREADY_USED = 0, - /** - * plane index out of bounds - */ - ZWP_LINUX_BUFFER_PARAMS_V1_ERROR_PLANE_IDX = 1, - /** - * the plane index was already set - */ - ZWP_LINUX_BUFFER_PARAMS_V1_ERROR_PLANE_SET = 2, - /** - * missing or too many planes to create a buffer - */ - ZWP_LINUX_BUFFER_PARAMS_V1_ERROR_INCOMPLETE = 3, - /** - * format not supported - */ - ZWP_LINUX_BUFFER_PARAMS_V1_ERROR_INVALID_FORMAT = 4, - /** - * invalid width or height - */ - ZWP_LINUX_BUFFER_PARAMS_V1_ERROR_INVALID_DIMENSIONS = 5, - /** - * offset + stride * height goes out of dmabuf bounds - */ - ZWP_LINUX_BUFFER_PARAMS_V1_ERROR_OUT_OF_BOUNDS = 6, -}; -#endif /* ZWP_LINUX_BUFFER_PARAMS_V1_ERROR_ENUM */ - -#ifndef ZWP_LINUX_BUFFER_PARAMS_V1_FLAGS_ENUM -#define ZWP_LINUX_BUFFER_PARAMS_V1_FLAGS_ENUM -enum zwp_linux_buffer_params_v1_flags { - /** - * contents are y-inverted - */ - ZWP_LINUX_BUFFER_PARAMS_V1_FLAGS_Y_INVERT = 1, - /** - * content is interlaced - */ - ZWP_LINUX_BUFFER_PARAMS_V1_FLAGS_INTERLACED = 2, - /** - * bottom field first - */ - ZWP_LINUX_BUFFER_PARAMS_V1_FLAGS_BOTTOM_FIRST = 4, -}; -#endif /* ZWP_LINUX_BUFFER_PARAMS_V1_FLAGS_ENUM */ - -/** - * @ingroup iface_zwp_linux_buffer_params_v1 - * @struct zwp_linux_buffer_params_v1_listener - */ -struct zwp_linux_buffer_params_v1_listener { - /** - * buffer creation succeeded - * - * This event indicates that the attempted buffer creation was - * successful. It provides the new wl_buffer referencing the - * dmabuf(s). - * - * Upon receiving this event, the client should destroy the - * zlinux_dmabuf_params object. - * @param buffer the newly created wl_buffer - */ - void (*created)(void *data, - struct zwp_linux_buffer_params_v1 *zwp_linux_buffer_params_v1, - struct wl_buffer *buffer); - /** - * buffer creation failed - * - * This event indicates that the attempted buffer creation has - * failed. It usually means that one of the dmabuf constraints has - * not been fulfilled. - * - * Upon receiving this event, the client should destroy the - * zlinux_buffer_params object. - */ - void (*failed)(void *data, - struct zwp_linux_buffer_params_v1 *zwp_linux_buffer_params_v1); -}; - -/** - * @ingroup zwp_linux_buffer_params_v1_iface - */ -static inline int -zwp_linux_buffer_params_v1_add_listener(struct zwp_linux_buffer_params_v1 *zwp_linux_buffer_params_v1, - const struct zwp_linux_buffer_params_v1_listener *listener, void *data) -{ - return wl_proxy_add_listener((struct wl_proxy *) zwp_linux_buffer_params_v1, - (void (**)(void)) listener, data); -} - -#define ZWP_LINUX_BUFFER_PARAMS_V1_DESTROY 0 -#define ZWP_LINUX_BUFFER_PARAMS_V1_ADD 1 -#define ZWP_LINUX_BUFFER_PARAMS_V1_CREATE 2 - -/** - * @ingroup iface_zwp_linux_buffer_params_v1 - */ -#define ZWP_LINUX_BUFFER_PARAMS_V1_DESTROY_SINCE_VERSION 1 -/** - * @ingroup iface_zwp_linux_buffer_params_v1 - */ -#define ZWP_LINUX_BUFFER_PARAMS_V1_ADD_SINCE_VERSION 1 -/** - * @ingroup iface_zwp_linux_buffer_params_v1 - */ -#define ZWP_LINUX_BUFFER_PARAMS_V1_CREATE_SINCE_VERSION 1 - -/** @ingroup iface_zwp_linux_buffer_params_v1 */ -static inline void -zwp_linux_buffer_params_v1_set_user_data(struct zwp_linux_buffer_params_v1 *zwp_linux_buffer_params_v1, void *user_data) -{ - wl_proxy_set_user_data((struct wl_proxy *) zwp_linux_buffer_params_v1, user_data); -} - -/** @ingroup iface_zwp_linux_buffer_params_v1 */ -static inline void * -zwp_linux_buffer_params_v1_get_user_data(struct zwp_linux_buffer_params_v1 *zwp_linux_buffer_params_v1) -{ - return wl_proxy_get_user_data((struct wl_proxy *) zwp_linux_buffer_params_v1); -} - -static inline uint32_t -zwp_linux_buffer_params_v1_get_version(struct zwp_linux_buffer_params_v1 *zwp_linux_buffer_params_v1) -{ - return wl_proxy_get_version((struct wl_proxy *) zwp_linux_buffer_params_v1); -} - -/** - * @ingroup iface_zwp_linux_buffer_params_v1 - * - * Cleans up the temporary data sent to the server for dmabuf-based - * wl_buffer creation. - */ -static inline void -zwp_linux_buffer_params_v1_destroy(struct zwp_linux_buffer_params_v1 *zwp_linux_buffer_params_v1) -{ - wl_proxy_marshal((struct wl_proxy *) zwp_linux_buffer_params_v1, - ZWP_LINUX_BUFFER_PARAMS_V1_DESTROY); - - wl_proxy_destroy((struct wl_proxy *) zwp_linux_buffer_params_v1); -} - -/** - * @ingroup iface_zwp_linux_buffer_params_v1 - * - * This request adds one dmabuf to the set in this - * zwp_linux_buffer_params_v1. - * - * The 64-bit unsigned value combined from modifier_hi and modifier_lo - * is the dmabuf layout modifier. DRM AddFB2 ioctl calls this the - * fb modifier, which is defined in drm_mode.h of Linux UAPI. - * This is an opaque token. Drivers use this token to express tiling, - * compression, etc. driver-specific modifications to the base format - * defined by the DRM fourcc code. - * - * This request raises the PLANE_IDX error if plane_idx is too large. - * The error PLANE_SET is raised if attempting to set a plane that - * was already set. - */ -static inline void -zwp_linux_buffer_params_v1_add(struct zwp_linux_buffer_params_v1 *zwp_linux_buffer_params_v1, int32_t fd, uint32_t plane_idx, uint32_t offset, uint32_t stride, uint32_t modifier_hi, uint32_t modifier_lo) -{ - wl_proxy_marshal((struct wl_proxy *) zwp_linux_buffer_params_v1, - ZWP_LINUX_BUFFER_PARAMS_V1_ADD, fd, plane_idx, offset, stride, modifier_hi, modifier_lo); -} - -/** - * @ingroup iface_zwp_linux_buffer_params_v1 - * - * This asks for creation of a wl_buffer from the added dmabuf - * buffers. The wl_buffer is not created immediately but returned via - * the 'created' event if the dmabuf sharing succeeds. The sharing - * may fail at runtime for reasons a client cannot predict, in - * which case the 'failed' event is triggered. - * - * The 'format' argument is a DRM_FORMAT code, as defined by the - * libdrm's drm_fourcc.h. The Linux kernel's DRM sub-system is the - * authoritative source on how the format codes should work. - * - * The 'flags' is a bitfield of the flags defined in enum "flags". - * 'y_invert' means the that the image needs to be y-flipped. - * - * Flag 'interlaced' means that the frame in the buffer is not - * progressive as usual, but interlaced. An interlaced buffer as - * supported here must always contain both top and bottom fields. - * The top field always begins on the first pixel row. The temporal - * ordering between the two fields is top field first, unless - * 'bottom_first' is specified. It is undefined whether 'bottom_first' - * is ignored if 'interlaced' is not set. - * - * This protocol does not convey any information about field rate, - * duration, or timing, other than the relative ordering between the - * two fields in one buffer. A compositor may have to estimate the - * intended field rate from the incoming buffer rate. It is undefined - * whether the time of receiving wl_surface.commit with a new buffer - * attached, applying the wl_surface state, wl_surface.frame callback - * trigger, presentation, or any other point in the compositor cycle - * is used to measure the frame or field times. There is no support - * for detecting missed or late frames/fields/buffers either, and - * there is no support whatsoever for cooperating with interlaced - * compositor output. - * - * The composited image quality resulting from the use of interlaced - * buffers is explicitly undefined. A compositor may use elaborate - * hardware features or software to deinterlace and create progressive - * output frames from a sequence of interlaced input buffers, or it - * may produce substandard image quality. However, compositors that - * cannot guarantee reasonable image quality in all cases are recommended - * to just reject all interlaced buffers. - * - * Any argument errors, including non-positive width or height, - * mismatch between the number of planes and the format, bad - * format, bad offset or stride, may be indicated by fatal protocol - * errors: INCOMPLETE, INVALID_FORMAT, INVALID_DIMENSIONS, - * OUT_OF_BOUNDS. - * - * Dmabuf import errors in the server that are not obvious client - * bugs are returned via the 'failed' event as non-fatal. This - * allows attempting dmabuf sharing and falling back in the client - * if it fails. - * - * This request can be sent only once in the object's lifetime, after - * which the only legal request is destroy. This object should be - * destroyed after issuing 'create' request. Attempting to use this - * object after issuing 'create' raises ALREADY_USED protocol error. - * - * It is not mandatory to issue 'create'. If a client wants to - * cancel the buffer creation, it can just destroy this object. - */ -static inline void -zwp_linux_buffer_params_v1_create(struct zwp_linux_buffer_params_v1 *zwp_linux_buffer_params_v1, int32_t width, int32_t height, uint32_t format, uint32_t flags) -{ - wl_proxy_marshal((struct wl_proxy *) zwp_linux_buffer_params_v1, - ZWP_LINUX_BUFFER_PARAMS_V1_CREATE, width, height, format, flags); -} - -#ifdef __cplusplus -} -#endif - -#endif diff --git a/src/lib/ecore_wl2/linux-dmabuf-unstable-v1-protocol.c b/src/lib/ecore_wl2/linux-dmabuf-unstable-v1-protocol.c deleted file mode 100644 index a4c929a..0000000 --- a/src/lib/ecore_wl2/linux-dmabuf-unstable-v1-protocol.c +++ /dev/null @@ -1,75 +0,0 @@ -/* - * Copyright © 2014, 2015 Collabora, Ltd. - * - * Permission to use, copy, modify, distribute, and sell this - * software and its documentation for any purpose is hereby granted - * without fee, provided that the above copyright notice appear in - * all copies and that both that copyright notice and this permission - * notice appear in supporting documentation, and that the name of - * the copyright holders not be used in advertising or publicity - * pertaining to distribution of the software without specific, - * written prior permission. The copyright holders make no - * representations about the suitability of this software for any - * purpose. It is provided "as is" without express or implied - * warranty. - * - * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS - * SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND - * FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY - * SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES - * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN - * AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, - * ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF - * THIS SOFTWARE. - */ - -#include -#include -#include "wayland-util.h" - -extern const struct wl_interface wl_buffer_interface; -extern const struct wl_interface zwp_linux_buffer_params_v1_interface; - -static const struct wl_interface *types[] = { - NULL, - NULL, - NULL, - NULL, - NULL, - NULL, - &zwp_linux_buffer_params_v1_interface, - &wl_buffer_interface, -}; - -static const struct wl_message zwp_linux_dmabuf_v1_requests[] = { - { "destroy", "", types + 0 }, - { "create_params", "n", types + 6 }, -}; - -static const struct wl_message zwp_linux_dmabuf_v1_events[] = { - { "format", "u", types + 0 }, -}; - -WL_EXPORT const struct wl_interface zwp_linux_dmabuf_v1_interface = { - "zwp_linux_dmabuf_v1", 1, - 2, zwp_linux_dmabuf_v1_requests, - 1, zwp_linux_dmabuf_v1_events, -}; - -static const struct wl_message zwp_linux_buffer_params_v1_requests[] = { - { "destroy", "", types + 0 }, - { "add", "huuuuu", types + 0 }, - { "create", "iiuu", types + 0 }, -}; - -static const struct wl_message zwp_linux_buffer_params_v1_events[] = { - { "created", "n", types + 7 }, - { "failed", "", types + 0 }, -}; - -WL_EXPORT const struct wl_interface zwp_linux_buffer_params_v1_interface = { - "zwp_linux_buffer_params_v1", 1, - 3, zwp_linux_buffer_params_v1_requests, - 2, zwp_linux_buffer_params_v1_events, -}; - diff --git a/src/lib/ecore_wl2/linux-dmabuf-unstable-v1-server-protocol.h b/src/lib/ecore_wl2/linux-dmabuf-unstable-v1-server-protocol.h deleted file mode 100644 index ce1b93d..0000000 --- a/src/lib/ecore_wl2/linux-dmabuf-unstable-v1-server-protocol.h +++ /dev/null @@ -1,448 +0,0 @@ -#ifndef LINUX_DMABUF_UNSTABLE_V1_SERVER_PROTOCOL_H -#define LINUX_DMABUF_UNSTABLE_V1_SERVER_PROTOCOL_H - -#ifdef __cplusplus -extern "C" { -#endif - -#include -#include -#include "wayland-server.h" - -struct wl_client; -struct wl_resource; - -/** - * @page page_linux_dmabuf_unstable_v1 The linux_dmabuf_unstable_v1 protocol - * @section page_ifaces_linux_dmabuf_unstable_v1 Interfaces - * - @subpage page_iface_zwp_linux_dmabuf_v1 - factory for creating dmabuf-based wl_buffers - * - @subpage page_iface_zwp_linux_buffer_params_v1 - parameters for creating a dmabuf-based wl_buffer - * @section page_copyright_linux_dmabuf_unstable_v1 Copyright - *
- *
- * Copyright © 2014, 2015 Collabora, Ltd.
- *
- * Permission to use, copy, modify, distribute, and sell this
- * software and its documentation for any purpose is hereby granted
- * without fee, provided that the above copyright notice appear in
- * all copies and that both that copyright notice and this permission
- * notice appear in supporting documentation, and that the name of
- * the copyright holders not be used in advertising or publicity
- * pertaining to distribution of the software without specific,
- * written prior permission.  The copyright holders make no
- * representations about the suitability of this software for any
- * purpose.  It is provided "as is" without express or implied
- * warranty.
- *
- * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
- * SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
- * FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
- * SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
- * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
- * AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
- * ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
- * THIS SOFTWARE.
- * 
- */ -struct wl_buffer; -struct zwp_linux_buffer_params_v1; -struct zwp_linux_dmabuf_v1; - -/** - * @page page_iface_zwp_linux_dmabuf_v1 zwp_linux_dmabuf_v1 - * @section page_iface_zwp_linux_dmabuf_v1_desc Description - * - * Following the interfaces from: - * https://www.khronos.org/registry/egl/extensions/EXT/EGL_EXT_image_dma_buf_import.txt - * and the Linux DRM sub-system's AddFb2 ioctl. - * - * This interface offers a way to create generic dmabuf-based - * wl_buffers. Immediately after a client binds to this interface, - * the set of supported formats is sent with 'format' events. - * - * The following are required from clients: - * - * - Clients must ensure that either all data in the dma-buf is - * coherent for all subsequent read access or that coherency is - * correctly handled by the underlying kernel-side dma-buf - * implementation. - * - * - Don't make any more attachments after sending the buffer to the - * compositor. Making more attachments later increases the risk of - * the compositor not being able to use (re-import) an existing - * dmabuf-based wl_buffer. - * - * The underlying graphics stack must ensure the following: - * - * - The dmabuf file descriptors relayed to the server will stay valid - * for the whole lifetime of the wl_buffer. This means the server may - * at any time use those fds to import the dmabuf into any kernel - * sub-system that might accept it. - * - * To create a wl_buffer from one or more dmabufs, a client creates a - * zwp_linux_dmabuf_params_v1 object with zwp_linux_dmabuf_v1.create_params - * request. All planes required by the intended format are added with - * the 'add' request. Finally, 'create' request is issued. The server - * will reply with either 'created' event which provides the final - * wl_buffer or 'failed' event saying that it cannot use the dmabufs - * provided. - * - * Warning! The protocol described in this file is experimental and - * backward incompatible changes may be made. Backward compatible changes - * may be added together with the corresponding interface version bump. - * Backward incompatible changes are done by bumping the version number in - * the protocol and interface names and resetting the interface version. - * Once the protocol is to be declared stable, the 'z' prefix and the - * version number in the protocol and interface names are removed and the - * interface version number is reset. - * @section page_iface_zwp_linux_dmabuf_v1_api API - * See @ref iface_zwp_linux_dmabuf_v1. - */ -/** - * @defgroup iface_zwp_linux_dmabuf_v1 The zwp_linux_dmabuf_v1 interface - * - * Following the interfaces from: - * https://www.khronos.org/registry/egl/extensions/EXT/EGL_EXT_image_dma_buf_import.txt - * and the Linux DRM sub-system's AddFb2 ioctl. - * - * This interface offers a way to create generic dmabuf-based - * wl_buffers. Immediately after a client binds to this interface, - * the set of supported formats is sent with 'format' events. - * - * The following are required from clients: - * - * - Clients must ensure that either all data in the dma-buf is - * coherent for all subsequent read access or that coherency is - * correctly handled by the underlying kernel-side dma-buf - * implementation. - * - * - Don't make any more attachments after sending the buffer to the - * compositor. Making more attachments later increases the risk of - * the compositor not being able to use (re-import) an existing - * dmabuf-based wl_buffer. - * - * The underlying graphics stack must ensure the following: - * - * - The dmabuf file descriptors relayed to the server will stay valid - * for the whole lifetime of the wl_buffer. This means the server may - * at any time use those fds to import the dmabuf into any kernel - * sub-system that might accept it. - * - * To create a wl_buffer from one or more dmabufs, a client creates a - * zwp_linux_dmabuf_params_v1 object with zwp_linux_dmabuf_v1.create_params - * request. All planes required by the intended format are added with - * the 'add' request. Finally, 'create' request is issued. The server - * will reply with either 'created' event which provides the final - * wl_buffer or 'failed' event saying that it cannot use the dmabufs - * provided. - * - * Warning! The protocol described in this file is experimental and - * backward incompatible changes may be made. Backward compatible changes - * may be added together with the corresponding interface version bump. - * Backward incompatible changes are done by bumping the version number in - * the protocol and interface names and resetting the interface version. - * Once the protocol is to be declared stable, the 'z' prefix and the - * version number in the protocol and interface names are removed and the - * interface version number is reset. - */ -extern const struct wl_interface zwp_linux_dmabuf_v1_interface; -/** - * @page page_iface_zwp_linux_buffer_params_v1 zwp_linux_buffer_params_v1 - * @section page_iface_zwp_linux_buffer_params_v1_desc Description - * - * This temporary object is a collection of dmabufs and other - * parameters that together form a single logical buffer. The temporary - * object may eventually create one wl_buffer unless cancelled by - * destroying it before requesting 'create'. - * - * Single-planar formats only require one dmabuf, however - * multi-planar formats may require more than one dmabuf. For all - * formats, 'add' request must be called once per plane (even if the - * underlying dmabuf fd is identical). - * - * You must use consecutive plane indices ('plane_idx' argument for 'add') - * from zero to the number of planes used by the drm_fourcc format code. - * All planes required by the format must be given exactly once, but can - * be given in any order. Each plane index can be set only once. - * @section page_iface_zwp_linux_buffer_params_v1_api API - * See @ref iface_zwp_linux_buffer_params_v1. - */ -/** - * @defgroup iface_zwp_linux_buffer_params_v1 The zwp_linux_buffer_params_v1 interface - * - * This temporary object is a collection of dmabufs and other - * parameters that together form a single logical buffer. The temporary - * object may eventually create one wl_buffer unless cancelled by - * destroying it before requesting 'create'. - * - * Single-planar formats only require one dmabuf, however - * multi-planar formats may require more than one dmabuf. For all - * formats, 'add' request must be called once per plane (even if the - * underlying dmabuf fd is identical). - * - * You must use consecutive plane indices ('plane_idx' argument for 'add') - * from zero to the number of planes used by the drm_fourcc format code. - * All planes required by the format must be given exactly once, but can - * be given in any order. Each plane index can be set only once. - */ -extern const struct wl_interface zwp_linux_buffer_params_v1_interface; - -/** - * @ingroup iface_zwp_linux_dmabuf_v1 - * @struct zwp_linux_dmabuf_v1_interface - */ -struct zwp_linux_dmabuf_v1_interface { - /** - * unbind the factory - * - * Objects created through this interface, especially wl_buffers, - * will remain valid. - */ - void (*destroy)(struct wl_client *client, - struct wl_resource *resource); - /** - * create a temporary object for buffer parameters - * - * This temporary object is used to collect multiple dmabuf - * handles into a single batch to create a wl_buffer. It can only - * be used once and should be destroyed after an 'created' or - * 'failed' event has been received. - * @param params_id the new temporary - */ - void (*create_params)(struct wl_client *client, - struct wl_resource *resource, - uint32_t params_id); -}; - -#define ZWP_LINUX_DMABUF_V1_FORMAT 0 - -/** - * @ingroup iface_zwp_linux_dmabuf_v1 - */ -#define ZWP_LINUX_DMABUF_V1_FORMAT_SINCE_VERSION 1 - -/** - * @ingroup iface_zwp_linux_dmabuf_v1 - * Sends an format event to the client owning the resource. -* @param resource_ The client's resource - * @param format DRM_FORMAT code - */ -static inline void -zwp_linux_dmabuf_v1_send_format(struct wl_resource *resource_, uint32_t format) -{ - wl_resource_post_event(resource_, ZWP_LINUX_DMABUF_V1_FORMAT, format); -} - -#ifndef ZWP_LINUX_BUFFER_PARAMS_V1_ERROR_ENUM -#define ZWP_LINUX_BUFFER_PARAMS_V1_ERROR_ENUM -enum zwp_linux_buffer_params_v1_error { - /** - * the dmabuf_batch object has already been used to create a wl_buffer - */ - ZWP_LINUX_BUFFER_PARAMS_V1_ERROR_ALREADY_USED = 0, - /** - * plane index out of bounds - */ - ZWP_LINUX_BUFFER_PARAMS_V1_ERROR_PLANE_IDX = 1, - /** - * the plane index was already set - */ - ZWP_LINUX_BUFFER_PARAMS_V1_ERROR_PLANE_SET = 2, - /** - * missing or too many planes to create a buffer - */ - ZWP_LINUX_BUFFER_PARAMS_V1_ERROR_INCOMPLETE = 3, - /** - * format not supported - */ - ZWP_LINUX_BUFFER_PARAMS_V1_ERROR_INVALID_FORMAT = 4, - /** - * invalid width or height - */ - ZWP_LINUX_BUFFER_PARAMS_V1_ERROR_INVALID_DIMENSIONS = 5, - /** - * offset + stride * height goes out of dmabuf bounds - */ - ZWP_LINUX_BUFFER_PARAMS_V1_ERROR_OUT_OF_BOUNDS = 6, -}; -#endif /* ZWP_LINUX_BUFFER_PARAMS_V1_ERROR_ENUM */ - -#ifndef ZWP_LINUX_BUFFER_PARAMS_V1_FLAGS_ENUM -#define ZWP_LINUX_BUFFER_PARAMS_V1_FLAGS_ENUM -enum zwp_linux_buffer_params_v1_flags { - /** - * contents are y-inverted - */ - ZWP_LINUX_BUFFER_PARAMS_V1_FLAGS_Y_INVERT = 1, - /** - * content is interlaced - */ - ZWP_LINUX_BUFFER_PARAMS_V1_FLAGS_INTERLACED = 2, - /** - * bottom field first - */ - ZWP_LINUX_BUFFER_PARAMS_V1_FLAGS_BOTTOM_FIRST = 4, -}; -#endif /* ZWP_LINUX_BUFFER_PARAMS_V1_FLAGS_ENUM */ - -/** - * @ingroup iface_zwp_linux_buffer_params_v1 - * @struct zwp_linux_buffer_params_v1_interface - */ -struct zwp_linux_buffer_params_v1_interface { - /** - * delete this object, used or not - * - * Cleans up the temporary data sent to the server for - * dmabuf-based wl_buffer creation. - */ - void (*destroy)(struct wl_client *client, - struct wl_resource *resource); - /** - * add a dmabuf to the temporary set - * - * This request adds one dmabuf to the set in this - * zwp_linux_buffer_params_v1. - * - * The 64-bit unsigned value combined from modifier_hi and - * modifier_lo is the dmabuf layout modifier. DRM AddFB2 ioctl - * calls this the fb modifier, which is defined in drm_mode.h of - * Linux UAPI. This is an opaque token. Drivers use this token to - * express tiling, compression, etc. driver-specific modifications - * to the base format defined by the DRM fourcc code. - * - * This request raises the PLANE_IDX error if plane_idx is too - * large. The error PLANE_SET is raised if attempting to set a - * plane that was already set. - * @param fd dmabuf fd - * @param plane_idx plane index - * @param offset offset in bytes - * @param stride stride in bytes - * @param modifier_hi high 32 bits of layout modifier - * @param modifier_lo low 32 bits of layout modifier - */ - void (*add)(struct wl_client *client, - struct wl_resource *resource, - int32_t fd, - uint32_t plane_idx, - uint32_t offset, - uint32_t stride, - uint32_t modifier_hi, - uint32_t modifier_lo); - /** - * create a wl_buffer from the given dmabufs - * - * This asks for creation of a wl_buffer from the added dmabuf - * buffers. The wl_buffer is not created immediately but returned - * via the 'created' event if the dmabuf sharing succeeds. The - * sharing may fail at runtime for reasons a client cannot predict, - * in which case the 'failed' event is triggered. - * - * The 'format' argument is a DRM_FORMAT code, as defined by the - * libdrm's drm_fourcc.h. The Linux kernel's DRM sub-system is the - * authoritative source on how the format codes should work. - * - * The 'flags' is a bitfield of the flags defined in enum "flags". - * 'y_invert' means the that the image needs to be y-flipped. - * - * Flag 'interlaced' means that the frame in the buffer is not - * progressive as usual, but interlaced. An interlaced buffer as - * supported here must always contain both top and bottom fields. - * The top field always begins on the first pixel row. The temporal - * ordering between the two fields is top field first, unless - * 'bottom_first' is specified. It is undefined whether - * 'bottom_first' is ignored if 'interlaced' is not set. - * - * This protocol does not convey any information about field rate, - * duration, or timing, other than the relative ordering between - * the two fields in one buffer. A compositor may have to estimate - * the intended field rate from the incoming buffer rate. It is - * undefined whether the time of receiving wl_surface.commit with a - * new buffer attached, applying the wl_surface state, - * wl_surface.frame callback trigger, presentation, or any other - * point in the compositor cycle is used to measure the frame or - * field times. There is no support for detecting missed or late - * frames/fields/buffers either, and there is no support whatsoever - * for cooperating with interlaced compositor output. - * - * The composited image quality resulting from the use of - * interlaced buffers is explicitly undefined. A compositor may use - * elaborate hardware features or software to deinterlace and - * create progressive output frames from a sequence of interlaced - * input buffers, or it may produce substandard image quality. - * However, compositors that cannot guarantee reasonable image - * quality in all cases are recommended to just reject all - * interlaced buffers. - * - * Any argument errors, including non-positive width or height, - * mismatch between the number of planes and the format, bad - * format, bad offset or stride, may be indicated by fatal protocol - * errors: INCOMPLETE, INVALID_FORMAT, INVALID_DIMENSIONS, - * OUT_OF_BOUNDS. - * - * Dmabuf import errors in the server that are not obvious client - * bugs are returned via the 'failed' event as non-fatal. This - * allows attempting dmabuf sharing and falling back in the client - * if it fails. - * - * This request can be sent only once in the object's lifetime, - * after which the only legal request is destroy. This object - * should be destroyed after issuing 'create' request. Attempting - * to use this object after issuing 'create' raises ALREADY_USED - * protocol error. - * - * It is not mandatory to issue 'create'. If a client wants to - * cancel the buffer creation, it can just destroy this object. - * @param width base plane width in pixels - * @param height base plane height in pixels - * @param format DRM_FORMAT code - * @param flags see enum flags - */ - void (*create)(struct wl_client *client, - struct wl_resource *resource, - int32_t width, - int32_t height, - uint32_t format, - uint32_t flags); -}; - -#define ZWP_LINUX_BUFFER_PARAMS_V1_CREATED 0 -#define ZWP_LINUX_BUFFER_PARAMS_V1_FAILED 1 - -/** - * @ingroup iface_zwp_linux_buffer_params_v1 - */ -#define ZWP_LINUX_BUFFER_PARAMS_V1_CREATED_SINCE_VERSION 1 -/** - * @ingroup iface_zwp_linux_buffer_params_v1 - */ -#define ZWP_LINUX_BUFFER_PARAMS_V1_FAILED_SINCE_VERSION 1 - -/** - * @ingroup iface_zwp_linux_buffer_params_v1 - * Sends an created event to the client owning the resource. -* @param resource_ The client's resource - * @param buffer the newly created wl_buffer - */ -static inline void -zwp_linux_buffer_params_v1_send_created(struct wl_resource *resource_, struct wl_resource *buffer) -{ - wl_resource_post_event(resource_, ZWP_LINUX_BUFFER_PARAMS_V1_CREATED, buffer); -} - -/** - * @ingroup iface_zwp_linux_buffer_params_v1 - * Sends an failed event to the client owning the resource. -* @param resource_ The client's resource - */ -static inline void -zwp_linux_buffer_params_v1_send_failed(struct wl_resource *resource_) -{ - wl_resource_post_event(resource_, ZWP_LINUX_BUFFER_PARAMS_V1_FAILED); -} - -#ifdef __cplusplus -} -#endif - -#endif