Merge pull request #24 from wlrfx/wlroots-0.17-rebase

Rebase to wlroots 0.17

8 files changed, 467 insertions, 113 deletions

diff --git a/include/render/egl.h b/include/render/egl.h
new file mode 100644
index 0000000..e8b8596
--- /dev/null
+++ b/include/render/egl.h
@@ -0,0 +1,117 @@
+#ifndef RENDER_EGL_H
+#define RENDER_EGL_H
+
+#include <wlr/render/egl.h>
+
+struct wlr_egl {
+	EGLDisplay display;
+	EGLContext context;
+	EGLDeviceEXT device; // may be EGL_NO_DEVICE_EXT
+	struct gbm_device *gbm_device;
+
+	struct {
+		// Display extensions
+		bool KHR_image_base;
+		bool EXT_image_dma_buf_import;
+		bool EXT_image_dma_buf_import_modifiers;
+		bool IMG_context_priority;
+		bool EXT_create_context_robustness;
+
+		// Device extensions
+		bool EXT_device_drm;
+		bool EXT_device_drm_render_node;
+
+		// Client extensions
+		bool EXT_device_query;
+		bool KHR_platform_gbm;
+		bool EXT_platform_device;
+		bool KHR_display_reference;
+	} exts;
+
+	struct {
+		PFNEGLGETPLATFORMDISPLAYEXTPROC eglGetPlatformDisplayEXT;
+		PFNEGLCREATEIMAGEKHRPROC eglCreateImageKHR;
+		PFNEGLDESTROYIMAGEKHRPROC eglDestroyImageKHR;
+		PFNEGLQUERYDMABUFFORMATSEXTPROC eglQueryDmaBufFormatsEXT;
+		PFNEGLQUERYDMABUFMODIFIERSEXTPROC eglQueryDmaBufModifiersEXT;
+		PFNEGLDEBUGMESSAGECONTROLKHRPROC eglDebugMessageControlKHR;
+		PFNEGLQUERYDISPLAYATTRIBEXTPROC eglQueryDisplayAttribEXT;
+		PFNEGLQUERYDEVICESTRINGEXTPROC eglQueryDeviceStringEXT;
+		PFNEGLQUERYDEVICESEXTPROC eglQueryDevicesEXT;
+	} procs;
+
+	bool has_modifiers;
+	struct wlr_drm_format_set dmabuf_texture_formats;
+	struct wlr_drm_format_set dmabuf_render_formats;
+};
+
+struct wlr_egl_context {
+	EGLDisplay display;
+	EGLContext context;
+	EGLSurface draw_surface;
+	EGLSurface read_surface;
+};
+
+/**
+ * Initializes an EGL context for the given DRM FD.
+ *
+ * Will attempt to load all possibly required API functions.
+ */
+struct wlr_egl *wlr_egl_create_with_drm_fd(int drm_fd);
+
+/**
+ * Frees all related EGL resources, makes the context not-current and
+ * unbinds a bound wayland display.
+ */
+void wlr_egl_destroy(struct wlr_egl *egl);
+
+/**
+ * Creates an EGL image from the given dmabuf attributes. Check usability
+ * of the dmabuf with wlr_egl_check_import_dmabuf once first.
+ */
+EGLImageKHR wlr_egl_create_image_from_dmabuf(struct wlr_egl *egl,
+	struct wlr_dmabuf_attributes *attributes, bool *external_only);
+
+/**
+ * Get DMA-BUF formats suitable for sampling usage.
+ */
+const struct wlr_drm_format_set *wlr_egl_get_dmabuf_texture_formats(
+	struct wlr_egl *egl);
+/**
+ * Get DMA-BUF formats suitable for rendering usage.
+ */
+const struct wlr_drm_format_set *wlr_egl_get_dmabuf_render_formats(
+	struct wlr_egl *egl);
+
+/**
+ * Destroys an EGL image created with the given wlr_egl.
+ */
+bool wlr_egl_destroy_image(struct wlr_egl *egl, EGLImageKHR image);
+
+int wlr_egl_dup_drm_fd(struct wlr_egl *egl);
+
+/**
+ * Save the current EGL context to the structure provided in the argument.
+ *
+ * This includes display, context, draw surface and read surface.
+ */
+void wlr_egl_save_context(struct wlr_egl_context *context);
+
+/**
+ * Restore EGL context that was previously saved using wlr_egl_save_current().
+ */
+bool wlr_egl_restore_context(struct wlr_egl_context *context);
+
+/**
+ * Make the EGL context current.
+ *
+ * Callers are expected to clear the current context when they are done by
+ * calling wlr_egl_unset_current().
+ */
+bool wlr_egl_make_current(struct wlr_egl *egl);
+
+bool wlr_egl_unset_current(struct wlr_egl *egl);
+
+bool wlr_egl_is_current(struct wlr_egl *egl);
+
+#endif
diff --git a/include/render/fx_renderer/fx_renderer.h b/include/render/fx_renderer/fx_renderer.h
index f569aa9..4d99866 100644
--- a/include/render/fx_renderer/fx_renderer.h
+++ b/include/render/fx_renderer/fx_renderer.h
@@ -4,72 +4,141 @@
 #include <GLES2/gl2.h>
 #include <GLES2/gl2ext.h>
 #include <stdbool.h>
+#include <time.h>
 #include <wlr/render/egl.h>
+#include <wlr/render/interface.h>
 #include <wlr/render/wlr_texture.h>
 #include <wlr/util/addon.h>
 #include <wlr/util/box.h>
-#include "render/fx_renderer/fx_stencilbuffer.h"
+
+#include "render/fx_renderer/shaders.h"
+#include "render/pass.h"
 #include "types/fx/shadow_data.h"
 
-enum fx_tex_shader_source {
-	SHADER_SOURCE_TEXTURE_RGBA = 1,
-	SHADER_SOURCE_TEXTURE_RGBX = 2,
-	SHADER_SOURCE_TEXTURE_EXTERNAL = 3,
+struct fx_pixel_format {
+	uint32_t drm_format;
+	// optional field, if empty then internalformat = format
+	GLint gl_internalformat;
+	GLint gl_format, gl_type;
+	bool has_alpha;
 };
 
-struct quad_shader {
-	GLuint program;
-	GLint proj;
-	GLint color;
-	GLint pos_attrib;
-};
+bool is_fx_pixel_format_supported(const struct fx_renderer *renderer,
+	const struct fx_pixel_format *format);
+const struct fx_pixel_format *get_fx_format_from_drm(uint32_t fmt);
+const struct fx_pixel_format *get_fx_format_from_gl(
+	GLint gl_format, GLint gl_type, bool alpha);
+const uint32_t *get_fx_shm_formats(const struct fx_renderer *renderer,
+	size_t *len);
+
+///
+/// fx_framebuffer
+///
+
+struct fx_framebuffer {
+	struct wlr_buffer *buffer;
+	struct fx_renderer *renderer;
+	struct wl_list link; // fx_renderer.buffers
+
+	EGLImageKHR image;
+	GLuint rbo;
+	GLuint fbo;
+	GLuint sb; // Stencil
 
-struct tex_shader {
-	GLuint program;
-	GLint proj;
-	GLint tex;
-	GLint alpha;
-	GLint pos_attrib;
-	GLint tex_attrib;
-	GLint size;
-	GLint position;
-	GLint radius;
+	struct wlr_addon addon;
 };
 
-struct stencil_mask_shader {
-	GLuint program;
-	GLint proj;
-	GLint color;
-	GLint pos_attrib;
-	GLint half_size;
-	GLint position;
-	GLint radius;
+struct fx_framebuffer *fx_framebuffer_get_or_create(struct fx_renderer *renderer,
+		struct wlr_buffer *wlr_buffer);
+
+void fx_framebuffer_bind(struct fx_framebuffer *buffer);
+
+void fx_framebuffer_bind_wlr_fbo(struct fx_renderer *renderer);
+
+void fx_framebuffer_destroy(struct fx_framebuffer *buffer);
+
+///
+/// fx_texture
+///
+
+struct fx_texture {
+	struct wlr_texture wlr_texture;
+	struct fx_renderer *fx_renderer;
+	struct wl_list link; // fx_renderer.textures
+
+	// Basically:
+	//   GL_TEXTURE_2D == mutable
+	//   GL_TEXTURE_EXTERNAL_OES == immutable
+	GLuint target;
+	GLuint tex;
+
+	EGLImageKHR image;
+
+	bool has_alpha;
+
+	// Only affects target == GL_TEXTURE_2D
+	uint32_t drm_format; // used to interpret upload data
+	// If imported from a wlr_buffer
+	struct wlr_buffer *buffer;
+	struct wlr_addon buffer_addon;
 };
 
-struct box_shadow_shader {
-	GLuint program;
-	GLint proj;
-	GLint color;
-	GLint pos_attrib;
-	GLint position;
-	GLint size;
-	GLint blur_sigma;
-	GLint corner_radius;
+struct fx_texture_attribs {
+	GLenum target; /* either GL_TEXTURE_2D or GL_TEXTURE_EXTERNAL_OES */
+	GLuint tex;
+
+	bool has_alpha;
 };
 
-struct fx_renderer {
-	float projection[9];
+struct fx_texture *fx_get_texture(struct wlr_texture *wlr_texture);
 
-	struct fx_stencilbuffer stencil_buffer;
+struct wlr_texture *fx_texture_from_buffer(struct wlr_renderer *wlr_renderer,
+		struct wlr_buffer *buffer);
 
-	struct wlr_addon addon;
+void fx_texture_destroy(struct fx_texture *texture);
+
+bool wlr_texture_is_fx(struct wlr_texture *wlr_texture);
 
+void fx_texture_get_attribs(struct wlr_texture *texture,
+	struct fx_texture_attribs *attribs);
+
+///
+/// fx_renderer
+///
+
+struct fx_renderer {
+	struct wlr_renderer wlr_renderer;
+
+	float projection[9];
+	struct wlr_egl *egl;
+	int drm_fd;
+
+	const char *exts_str;
 	struct {
+		bool EXT_read_format_bgra;
+		bool KHR_debug;
 		bool OES_egl_image_external;
+		bool OES_egl_image;
+		bool EXT_texture_type_2_10_10_10_REV;
+		bool OES_texture_half_float_linear;
+		bool EXT_texture_norm16;
+		bool EXT_disjoint_timer_query;
 	} exts;
 
 	struct {
 		PFNGLEGLIMAGETARGETTEXTURE2DOESPROC glEGLImageTargetTexture2DOES;
+		PFNGLDEBUGMESSAGECALLBACKKHRPROC glDebugMessageCallbackKHR;
+		PFNGLDEBUGMESSAGECONTROLKHRPROC glDebugMessageControlKHR;
+		PFNGLPOPDEBUGGROUPKHRPROC glPopDebugGroupKHR;
+		PFNGLPUSHDEBUGGROUPKHRPROC glPushDebugGroupKHR;
+		PFNGLEGLIMAGETARGETRENDERBUFFERSTORAGEOESPROC glEGLImageTargetRenderbufferStorageOES;
+		PFNGLGETGRAPHICSRESETSTATUSKHRPROC glGetGraphicsResetStatusKHR;
+		PFNGLGENQUERIESEXTPROC glGenQueriesEXT;
+		PFNGLDELETEQUERIESEXTPROC glDeleteQueriesEXT;
+		PFNGLQUERYCOUNTEREXTPROC glQueryCounterEXT;
+		PFNGLGETQUERYOBJECTIVEXTPROC glGetQueryObjectivEXT;
+		PFNGLGETQUERYOBJECTUI64VEXTPROC glGetQueryObjectui64vEXT;
+		PFNGLGETINTEGER64VEXTPROC glGetInteger64vEXT;
 	} procs;
 
 	struct {
@@ -80,48 +149,47 @@ struct fx_renderer {
 		struct box_shadow_shader box_shadow;
 		struct stencil_mask_shader stencil_mask;
 	} shaders;
-};
-
-void fx_renderer_init_addon(struct wlr_egl *egl, struct wlr_addon_set *addons,
-		const void * owner);
-
-struct fx_renderer *fx_renderer_addon_find(struct wlr_addon_set *addons,
-		const void * owner);
-
-struct fx_renderer *fx_renderer_create(struct wlr_egl *egl);
 
-void fx_renderer_fini(struct fx_renderer *renderer);
+	struct wl_list buffers; // fx_framebuffer.link
+	struct wl_list textures; // fx_texture.link
 
-void fx_renderer_begin(struct fx_renderer *renderer, int width, int height);
-
-void fx_renderer_clear(const float color[static 4]);
-
-void fx_renderer_scissor(struct wlr_box *box);
-
-// Initialize the stenciling work
-void fx_renderer_stencil_mask_init(void);
-
-// Close the mask
-void fx_renderer_stencil_mask_close(bool draw_inside_mask);
-
-// Finish stenciling and clear the buffer
-void fx_renderer_stencil_mask_fini(void);
-
-void fx_renderer_stencil_enable(void);
-
-void fx_renderer_stencil_disable(void);
-
-bool fx_render_subtexture_with_matrix(struct fx_renderer *renderer,
-		struct wlr_texture *wlr_texture, const struct wlr_fbox *src_box,
-		const struct wlr_box *dst_box, const float matrix[static 9],
-		float opacity, int corner_radius);
+	struct fx_framebuffer *current_buffer;
+	uint32_t viewport_width, viewport_height;
+};
 
-void fx_render_rect(struct fx_renderer *renderer, const struct wlr_box *box,
-		const float color[static 4], const float projection[static 9]);
+bool wlr_renderer_is_fx(struct wlr_renderer *wlr_renderer);
+
+struct fx_renderer *fx_get_renderer(
+	struct wlr_renderer *wlr_renderer);
+struct fx_render_timer *fx_get_render_timer(
+	struct wlr_render_timer *timer);
+struct fx_texture *fx_get_texture(
+	struct wlr_texture *wlr_texture);
+
+struct wlr_renderer *fx_renderer_create_with_drm_fd(int drm_fd);
+struct wlr_renderer *fx_renderer_create(struct wlr_backend *backend);
+struct wlr_renderer *fx_renderer_create_egl(struct wlr_egl *egl);
+
+struct wlr_egl *wlr_fx_renderer_get_egl(struct wlr_renderer *renderer);
+
+void push_fx_debug_(struct fx_renderer *renderer,
+	const char *file, const char *func);
+#define push_fx_debug(renderer) push_fx_debug_(renderer, _WLR_FILENAME, __func__)
+void pop_fx_debug(struct fx_renderer *renderer);
+
+///
+/// Render Timer
+///
+
+struct fx_render_timer {
+	struct wlr_render_timer base;
+	struct fx_renderer *renderer;
+	struct timespec cpu_start;
+	struct timespec cpu_end;
+	GLuint id;
+	GLint64 gl_cpu_end;
+};
 
-void fx_render_box_shadow(struct fx_renderer *renderer,
-		const struct wlr_box *box, const struct wlr_box *stencil_box,
-		const float matrix[static 9], int corner_radius,
-		struct shadow_data *shadow_data);
+bool wlr_render_timer_is_fx(struct wlr_render_timer *timer);
 
 #endif
diff --git a/include/render/fx_renderer/fx_stencilbuffer.h b/include/render/fx_renderer/fx_stencilbuffer.h
deleted file mode 100644
index 6909f96..0000000
--- a/include/render/fx_renderer/fx_stencilbuffer.h
+++ /dev/null
@@ -1,20 +0,0 @@
-#ifndef FX_STENCILBUFFER_H
-#define FX_STENCILBUFFER_H
-
-#include <GLES2/gl2.h>
-#include <stdbool.h>
-#include <wlr/render/wlr_texture.h>
-
-struct fx_stencilbuffer {
-	GLuint rb;
-	int width;
-	int height;
-};
-
-struct fx_stencilbuffer fx_stencilbuffer_create(void);
-
-void fx_stencilbuffer_init(struct fx_stencilbuffer *stencil_buffer, int width, int height);
-
-void fx_stencilbuffer_release(struct fx_stencilbuffer *stencil_buffer);
-
-#endif
diff --git a/include/render/fx_renderer/matrix.h b/include/render/fx_renderer/matrix.h
index 6931e8d..c3bae42 100644
--- a/include/render/fx_renderer/matrix.h
+++ b/include/render/fx_renderer/matrix.h
@@ -3,7 +3,13 @@
 
 #include <wlr/types/wlr_output.h>
 
+/**
+ * Writes a 2D orthographic projection matrix to mat of (width, height) with a
+ * specified wl_output_transform.
+ *
+ * Equivalent to glOrtho(0, width, 0, height, 1, -1) with the transform applied.
+ */
 void matrix_projection(float mat[static 9], int width, int height,
-		enum wl_output_transform transform);
+	enum wl_output_transform transform);
 
 #endif
diff --git a/include/render/fx_renderer/shaders.h b/include/render/fx_renderer/shaders.h
new file mode 100644
index 0000000..92a14d5
--- /dev/null
+++ b/include/render/fx_renderer/shaders.h
@@ -0,0 +1,65 @@
+#ifndef _FX_SHADERS_H
+#define _FX_SHADERS_H
+
+#include <GLES2/gl2.h>
+#include <stdbool.h>
+
+struct fx_renderer;
+
+GLuint compile_shader(GLuint type, const GLchar *src);
+
+GLuint link_program(const GLchar *frag_src);
+
+bool check_gl_ext(const char *exts, const char *ext);
+
+void load_gl_proc(void *proc_ptr, const char *name);
+
+enum fx_tex_shader_source {
+	SHADER_SOURCE_TEXTURE_RGBA = 1,
+	SHADER_SOURCE_TEXTURE_RGBX = 2,
+	SHADER_SOURCE_TEXTURE_EXTERNAL = 3,
+};
+
+struct quad_shader {
+	GLuint program;
+	GLint proj;
+	GLint color;
+	GLint pos_attrib;
+};
+
+struct tex_shader {
+	GLuint program;
+	GLint proj;
+	GLint tex_proj;
+	GLint tex;
+	GLint alpha;
+	GLint pos_attrib;
+	GLint size;
+	GLint position;
+	GLint radius;
+};
+
+struct stencil_mask_shader {
+	GLuint program;
+	GLint proj;
+	GLint color;
+	GLint pos_attrib;
+	GLint half_size;
+	GLint position;
+	GLint radius;
+};
+
+struct box_shadow_shader {
+	GLuint program;
+	GLint proj;
+	GLint color;
+	GLint pos_attrib;
+	GLint position;
+	GLint size;
+	GLint blur_sigma;
+	GLint corner_radius;
+};
+
+bool link_shaders(struct fx_renderer *renderer);
+
+#endif
diff --git a/include/render/fx_renderer/util.h b/include/render/fx_renderer/util.h
new file mode 100644
index 0000000..c0afc69
--- /dev/null
+++ b/include/render/fx_renderer/util.h
@@ -0,0 +1,11 @@
+#ifndef _FX_UTIL_H
+#define _FX_UTIL_H
+
+#include <stdbool.h>
+#include <stdlib.h>
+#include <wlr/backend/interface.h>
+
+bool open_preferred_drm_fd(struct wlr_backend *backend, int *drm_fd_ptr,
+		bool *own_drm_fd);
+
+#endif
diff --git a/include/render/pass.h b/include/render/pass.h
new file mode 100644
index 0000000..05bf1e9
--- /dev/null
+++ b/include/render/pass.h
@@ -0,0 +1,69 @@
+#ifndef FX_RENDER_PASS_H
+#define FX_RENDER_PASS_H
+
+#include <stdbool.h>
+#include <wlr/render/pass.h>
+#include <wlr/util/box.h>
+#include <wlr/render/interface.h>
+#include "types/fx/shadow_data.h"
+
+struct fx_gles_render_pass {
+	struct wlr_render_pass base;
+	struct fx_framebuffer *buffer;
+	float projection_matrix[9];
+	struct fx_render_timer *timer;
+};
+
+/**
+ * Begin a new render pass with the supplied destination buffer.
+ *
+ * Callers must call wlr_render_pass_submit() once they are done with the
+ * render pass.
+ */
+struct fx_gles_render_pass *fx_renderer_begin_buffer_pass(struct wlr_renderer *renderer,
+	struct wlr_buffer *buffer, const struct wlr_buffer_pass_options *options);
+
+struct fx_render_texture_options {
+	struct wlr_render_texture_options base;
+	float scale;
+	struct wlr_box *clip_box; // Used to clip csd. Ignored if NULL
+	int corner_radius;
+};
+
+struct fx_render_texture_options fx_render_texture_options_default(
+		const struct wlr_render_texture_options *base);
+
+struct fx_render_rect_options {
+	struct wlr_render_rect_options base;
+	float scale;
+};
+
+struct fx_render_rect_options fx_render_rect_options_default(
+		const struct wlr_render_rect_options *base);
+
+/**
+ * Render a fx texture.
+ */
+void fx_render_pass_add_texture(struct fx_gles_render_pass *render_pass,
+	const struct fx_render_texture_options *options);
+
+/**
+ * Render a rectangle.
+ */
+void fx_render_pass_add_rect(struct fx_gles_render_pass *render_pass,
+	const struct fx_render_rect_options *options);
+
+/**
+ * Render a stencil mask.
+ */
+void fx_render_pass_add_stencil_mask(struct fx_gles_render_pass *pass,
+		const struct fx_render_rect_options *fx_options, int corner_radius);
+
+/**
+ * Render a box shadow.
+ */
+void fx_render_pass_add_box_shadow(struct fx_gles_render_pass *pass,
+		const struct fx_render_rect_options *fx_options,
+		int corner_radius, struct shadow_data *shadow_data);
+
+#endif
diff --git a/include/render/pixel_format.h b/include/render/pixel_format.h
index d045b6a..6ca11f3 100644
--- a/include/render/pixel_format.h
+++ b/include/render/pixel_format.h
@@ -1,26 +1,64 @@
-#ifndef RENDER_PIXEL_FORMAT_H
-#define RENDER_PIXEL_FORMAT_H
+#ifndef FX_RENDER_PIXEL_FORMAT_H
+#define FX_RENDER_PIXEL_FORMAT_H
 
 #include <wayland-server-protocol.h>
 
+/**
+ * Information about a pixel format.
+ *
+ * A pixel format is identified via its DRM four character code (see <drm_fourcc.h>).
+ *
+ * Simple formats have a block size of 1×1 pixels and bytes_per_block contains
+ * the number of bytes per pixel (including padding).
+ *
+ * Tiled formats (e.g. sub-sampled YCbCr) are described with a block size
+ * greater than 1×1 pixels. A block is a rectangle of pixels which are stored
+ * next to each other in a byte-aligned memory region.
+ */
 struct wlr_pixel_format_info {
-  uint32_t drm_format;
+	uint32_t drm_format;
 
-  /* Equivalent of the format if it has an alpha channel,
-   * DRM_FORMAT_INVALID (0) if NA
-   */
-  uint32_t opaque_substitute;
+	/* Equivalent of the format if it has an alpha channel,
+	 * DRM_FORMAT_INVALID (0) if NA
+	 */
+	uint32_t opaque_substitute;
 
-  /* Bits per pixels */
-  uint32_t bpp;
+	/* Bytes per block (including padding) */
+	uint32_t bytes_per_block;
+	/* Size of a block in pixels (zero for 1×1) */
+	uint32_t block_width, block_height;
 
-  /* True if the format has an alpha channel */
-  bool has_alpha;
+	/* True if the format has an alpha channel */
+	bool has_alpha;
 };
 
+/**
+ * Get pixel format information from a DRM FourCC.
+ *
+ * NULL is returned if the pixel format is unknown.
+ */
 const struct wlr_pixel_format_info *drm_get_pixel_format_info(uint32_t fmt);
+/**
+ * Get the number of pixels per block for a pixel format.
+ */
+uint32_t pixel_format_info_pixels_per_block(const struct wlr_pixel_format_info *info);
+/**
+ * Get the minimum stride for a given pixel format and width.
+ */
+int32_t pixel_format_info_min_stride(const struct wlr_pixel_format_info *info, int32_t width);
+/**
+ * Check whether a stride is large enough for a given pixel format and width.
+ */
+bool pixel_format_info_check_stride(const struct wlr_pixel_format_info *info,
+	int32_t stride, int32_t width);
 
+/**
+ * Convert an enum wl_shm_format to a DRM FourCC.
+ */
 uint32_t convert_wl_shm_format_to_drm(enum wl_shm_format fmt);
+/**
+ * Convert a DRM FourCC to an enum wl_shm_format.
+ */
 enum wl_shm_format convert_drm_format_to_wl_shm(uint32_t fmt);
 
 #endif