2014-10-07 22:39:00 -04:00
|
|
|
/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Copyright (C) 2014 Endless Mobile
|
|
|
|
*
|
|
|
|
* This program is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU General Public License as
|
|
|
|
* published by the Free Software Foundation; either version 2 of the
|
|
|
|
* License, or (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful, but
|
|
|
|
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
|
* General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with this program; if not, write to the Free Software
|
|
|
|
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
|
|
|
|
* 02111-1307, USA.
|
|
|
|
*
|
|
|
|
* Written by:
|
|
|
|
* Jasper St. Pierre <jstpierre@mecheye.net>
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef META_WAYLAND_BUFFER_H
|
|
|
|
#define META_WAYLAND_BUFFER_H
|
|
|
|
|
2014-10-07 22:48:49 -04:00
|
|
|
#include <cairo.h>
|
2014-10-07 22:39:00 -04:00
|
|
|
#include <wayland-server.h>
|
|
|
|
|
2018-07-10 04:36:24 -04:00
|
|
|
#include "cogl/cogl.h"
|
|
|
|
#include "wayland/meta-wayland-types.h"
|
|
|
|
#include "wayland/meta-wayland-egl-stream.h"
|
|
|
|
#include "wayland/meta-wayland-dma-buf.h"
|
2022-01-19 05:49:32 -05:00
|
|
|
#include "wayland/meta-wayland-single-pixel-buffer.h"
|
2014-10-07 22:39:00 -04:00
|
|
|
|
2016-12-08 22:15:11 -05:00
|
|
|
typedef enum _MetaWaylandBufferType
|
|
|
|
{
|
|
|
|
META_WAYLAND_BUFFER_TYPE_UNKNOWN,
|
|
|
|
META_WAYLAND_BUFFER_TYPE_SHM,
|
|
|
|
META_WAYLAND_BUFFER_TYPE_EGL_IMAGE,
|
2018-11-06 11:09:03 -05:00
|
|
|
#ifdef HAVE_WAYLAND_EGLSTREAM
|
2016-12-08 22:15:11 -05:00
|
|
|
META_WAYLAND_BUFFER_TYPE_EGL_STREAM,
|
2018-11-06 11:09:03 -05:00
|
|
|
#endif
|
2017-07-11 11:03:26 -04:00
|
|
|
META_WAYLAND_BUFFER_TYPE_DMA_BUF,
|
2022-01-19 05:49:32 -05:00
|
|
|
META_WAYLAND_BUFFER_TYPE_SINGLE_PIXEL,
|
2016-12-08 22:15:11 -05:00
|
|
|
} MetaWaylandBufferType;
|
|
|
|
|
2014-10-07 22:39:00 -04:00
|
|
|
struct _MetaWaylandBuffer
|
|
|
|
{
|
2016-02-26 04:47:21 -05:00
|
|
|
GObject parent;
|
|
|
|
|
2022-05-13 15:51:53 -04:00
|
|
|
MetaWaylandCompositor *compositor;
|
2014-10-07 22:39:00 -04:00
|
|
|
struct wl_resource *resource;
|
|
|
|
struct wl_listener destroy_listener;
|
|
|
|
|
wayland/surface: Overhaul handling of buffer use count
Move the use count from a separate MetaWaylandBufferRef struct to the
MetaWaylandBuffer class, and remove the former.
The buffer use count is now incremented already in
meta_wayland_surface_commit, since the Wayland protocol defines the
buffer to be in use by the compositor at that point. If the buffer
attachment ends up being dropped again before it is applied to the
surface state (e.g. because another buffer is committed to a
synchronized sub-surface before the parent surface is committed),
the use count is now decremented, and a buffer release event is sent if
the use count drops to 0.
Buffer release events were previously incorrectly not sent under these
circumstances. Test case: Run the weston-subsurfaces demo with the -r1
and/or -t1 command line parameter. Resize the window. Before this
change, weston-subsurfaces would freeze or abort after a few resize
operations, because mutter failed to send release events and the
client ran out of usable buffers.
v2:
* Handle NULL priv->buffer_ref in
meta_wayland_cursor_surface_apply_state.
v3:
* Remove MetaWaylandBufferRef altogether, move the use count tracking
to MetaWaylandBuffer itself. Much simpler, and doesn't run into
lifetime issues when mutter shuts down.
v4:
* Warn if use count isn't 0 in meta_wayland_buffer_finalize.
* Keep pending_buffer_resource_destroyed for attached but not yet
committed buffers. If the client attaches a buffer and then destroys
it before commit, we ignore the buffer attachement, same as before
this MR.
v5:
* Rebase on top of new commit which splits up surface->texture.
* MetaWaylandSurfaceState::buffer can only be non-NULL if
::newly_attached is TRUE, simplify accordingly.
Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/1880>
2022-06-22 12:43:11 -04:00
|
|
|
unsigned int use_count;
|
|
|
|
|
2016-10-20 03:44:27 -04:00
|
|
|
gboolean is_y_inverted;
|
2016-10-20 03:59:09 -04:00
|
|
|
|
2016-12-08 22:15:11 -05:00
|
|
|
MetaWaylandBufferType type;
|
|
|
|
|
wayland: Move surface texture ownership to MetaWaylandSurface
Prior to this commit, MetaWaylandSurface held a reference to
MetaWaylandBuffer, who owned the texture drawn by the surface. When
switching buffer, the texture change with it.
This is problematic when dealing with SHM buffer damage management, as
when having one texture per buffer, damaged regions uploaded to one,
will not follow along to the next one attached. It also wasted GPU
memory as there would be one texture per buffer, instead of one one
texture per surface.
Instead, move the texture ownership to MetaWaylandSurface, and have the
SHM buffer damage management update the surface texture. This ensures
damage is processed properly, and that we won't end up with stale
texture content when doing partial texture uploads. If the same SHM
buffer is attached to multiple surfaces, each surface will get their own
copy, and damage is tracked and uploaded separately.
Non-SHM types of buffers still has their own texture reference, as the
texture is just a representation of the GPU memory associated with the
buffer. When such a buffer is attached to a surface, instead the surface
just gets a reference to that texture, instead of a separately allocated
one.
Fixes: https://gitlab.gnome.org/GNOME/mutter/issues/199
2019-02-08 05:46:48 -05:00
|
|
|
struct {
|
|
|
|
CoglTexture *texture;
|
|
|
|
} egl_image;
|
|
|
|
|
2018-11-06 11:09:03 -05:00
|
|
|
#ifdef HAVE_WAYLAND_EGLSTREAM
|
2016-10-20 03:59:09 -04:00
|
|
|
struct {
|
|
|
|
MetaWaylandEglStream *stream;
|
wayland: Move surface texture ownership to MetaWaylandSurface
Prior to this commit, MetaWaylandSurface held a reference to
MetaWaylandBuffer, who owned the texture drawn by the surface. When
switching buffer, the texture change with it.
This is problematic when dealing with SHM buffer damage management, as
when having one texture per buffer, damaged regions uploaded to one,
will not follow along to the next one attached. It also wasted GPU
memory as there would be one texture per buffer, instead of one one
texture per surface.
Instead, move the texture ownership to MetaWaylandSurface, and have the
SHM buffer damage management update the surface texture. This ensures
damage is processed properly, and that we won't end up with stale
texture content when doing partial texture uploads. If the same SHM
buffer is attached to multiple surfaces, each surface will get their own
copy, and damage is tracked and uploaded separately.
Non-SHM types of buffers still has their own texture reference, as the
texture is just a representation of the GPU memory associated with the
buffer. When such a buffer is attached to a surface, instead the surface
just gets a reference to that texture, instead of a separately allocated
one.
Fixes: https://gitlab.gnome.org/GNOME/mutter/issues/199
2019-02-08 05:46:48 -05:00
|
|
|
CoglTexture *texture;
|
2016-10-20 03:59:09 -04:00
|
|
|
} egl_stream;
|
2018-11-06 11:09:03 -05:00
|
|
|
#endif
|
2017-07-11 11:03:26 -04:00
|
|
|
|
|
|
|
struct {
|
|
|
|
MetaWaylandDmaBufBuffer *dma_buf;
|
wayland: Move surface texture ownership to MetaWaylandSurface
Prior to this commit, MetaWaylandSurface held a reference to
MetaWaylandBuffer, who owned the texture drawn by the surface. When
switching buffer, the texture change with it.
This is problematic when dealing with SHM buffer damage management, as
when having one texture per buffer, damaged regions uploaded to one,
will not follow along to the next one attached. It also wasted GPU
memory as there would be one texture per buffer, instead of one one
texture per surface.
Instead, move the texture ownership to MetaWaylandSurface, and have the
SHM buffer damage management update the surface texture. This ensures
damage is processed properly, and that we won't end up with stale
texture content when doing partial texture uploads. If the same SHM
buffer is attached to multiple surfaces, each surface will get their own
copy, and damage is tracked and uploaded separately.
Non-SHM types of buffers still has their own texture reference, as the
texture is just a representation of the GPU memory associated with the
buffer. When such a buffer is attached to a surface, instead the surface
just gets a reference to that texture, instead of a separately allocated
one.
Fixes: https://gitlab.gnome.org/GNOME/mutter/issues/199
2019-02-08 05:46:48 -05:00
|
|
|
CoglTexture *texture;
|
2017-07-11 11:03:26 -04:00
|
|
|
} dma_buf;
|
2022-01-19 05:49:32 -05:00
|
|
|
|
|
|
|
struct {
|
|
|
|
MetaWaylandSinglePixelBuffer *single_pixel_buffer;
|
|
|
|
CoglTexture *texture;
|
|
|
|
} single_pixel;
|
2022-06-10 13:51:56 -04:00
|
|
|
|
|
|
|
GHashTable *tainted_scanout_onscreens;
|
2014-10-07 22:39:00 -04:00
|
|
|
};
|
|
|
|
|
2016-02-26 04:47:21 -05:00
|
|
|
#define META_TYPE_WAYLAND_BUFFER (meta_wayland_buffer_get_type ())
|
|
|
|
G_DECLARE_FINAL_TYPE (MetaWaylandBuffer, meta_wayland_buffer,
|
|
|
|
META, WAYLAND_BUFFER, GObject);
|
|
|
|
|
2022-05-13 15:51:53 -04:00
|
|
|
MetaWaylandBuffer * meta_wayland_buffer_from_resource (MetaWaylandCompositor *compositor,
|
|
|
|
struct wl_resource *resource);
|
2018-05-02 06:27:02 -04:00
|
|
|
struct wl_resource * meta_wayland_buffer_get_resource (MetaWaylandBuffer *buffer);
|
2017-05-05 21:41:51 -04:00
|
|
|
gboolean meta_wayland_buffer_is_realized (MetaWaylandBuffer *buffer);
|
|
|
|
gboolean meta_wayland_buffer_realize (MetaWaylandBuffer *buffer);
|
2016-10-20 03:35:29 -04:00
|
|
|
gboolean meta_wayland_buffer_attach (MetaWaylandBuffer *buffer,
|
wayland: Move surface texture ownership to MetaWaylandSurface
Prior to this commit, MetaWaylandSurface held a reference to
MetaWaylandBuffer, who owned the texture drawn by the surface. When
switching buffer, the texture change with it.
This is problematic when dealing with SHM buffer damage management, as
when having one texture per buffer, damaged regions uploaded to one,
will not follow along to the next one attached. It also wasted GPU
memory as there would be one texture per buffer, instead of one one
texture per surface.
Instead, move the texture ownership to MetaWaylandSurface, and have the
SHM buffer damage management update the surface texture. This ensures
damage is processed properly, and that we won't end up with stale
texture content when doing partial texture uploads. If the same SHM
buffer is attached to multiple surfaces, each surface will get their own
copy, and damage is tracked and uploaded separately.
Non-SHM types of buffers still has their own texture reference, as the
texture is just a representation of the GPU memory associated with the
buffer. When such a buffer is attached to a surface, instead the surface
just gets a reference to that texture, instead of a separately allocated
one.
Fixes: https://gitlab.gnome.org/GNOME/mutter/issues/199
2019-02-08 05:46:48 -05:00
|
|
|
CoglTexture **texture,
|
2016-10-20 03:35:29 -04:00
|
|
|
GError **error);
|
2016-10-20 03:59:09 -04:00
|
|
|
CoglSnippet * meta_wayland_buffer_create_snippet (MetaWaylandBuffer *buffer);
|
wayland/surface: Overhaul handling of buffer use count
Move the use count from a separate MetaWaylandBufferRef struct to the
MetaWaylandBuffer class, and remove the former.
The buffer use count is now incremented already in
meta_wayland_surface_commit, since the Wayland protocol defines the
buffer to be in use by the compositor at that point. If the buffer
attachment ends up being dropped again before it is applied to the
surface state (e.g. because another buffer is committed to a
synchronized sub-surface before the parent surface is committed),
the use count is now decremented, and a buffer release event is sent if
the use count drops to 0.
Buffer release events were previously incorrectly not sent under these
circumstances. Test case: Run the weston-subsurfaces demo with the -r1
and/or -t1 command line parameter. Resize the window. Before this
change, weston-subsurfaces would freeze or abort after a few resize
operations, because mutter failed to send release events and the
client ran out of usable buffers.
v2:
* Handle NULL priv->buffer_ref in
meta_wayland_cursor_surface_apply_state.
v3:
* Remove MetaWaylandBufferRef altogether, move the use count tracking
to MetaWaylandBuffer itself. Much simpler, and doesn't run into
lifetime issues when mutter shuts down.
v4:
* Warn if use count isn't 0 in meta_wayland_buffer_finalize.
* Keep pending_buffer_resource_destroyed for attached but not yet
committed buffers. If the client attaches a buffer and then destroys
it before commit, we ignore the buffer attachement, same as before
this MR.
v5:
* Rebase on top of new commit which splits up surface->texture.
* MetaWaylandSurfaceState::buffer can only be non-NULL if
::newly_attached is TRUE, simplify accordingly.
Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/1880>
2022-06-22 12:43:11 -04:00
|
|
|
void meta_wayland_buffer_inc_use_count (MetaWaylandBuffer *buffer);
|
|
|
|
void meta_wayland_buffer_dec_use_count (MetaWaylandBuffer *buffer);
|
2016-10-20 03:44:27 -04:00
|
|
|
gboolean meta_wayland_buffer_is_y_inverted (MetaWaylandBuffer *buffer);
|
2014-10-07 22:48:49 -04:00
|
|
|
void meta_wayland_buffer_process_damage (MetaWaylandBuffer *buffer,
|
wayland: Move surface texture ownership to MetaWaylandSurface
Prior to this commit, MetaWaylandSurface held a reference to
MetaWaylandBuffer, who owned the texture drawn by the surface. When
switching buffer, the texture change with it.
This is problematic when dealing with SHM buffer damage management, as
when having one texture per buffer, damaged regions uploaded to one,
will not follow along to the next one attached. It also wasted GPU
memory as there would be one texture per buffer, instead of one one
texture per surface.
Instead, move the texture ownership to MetaWaylandSurface, and have the
SHM buffer damage management update the surface texture. This ensures
damage is processed properly, and that we won't end up with stale
texture content when doing partial texture uploads. If the same SHM
buffer is attached to multiple surfaces, each surface will get their own
copy, and damage is tracked and uploaded separately.
Non-SHM types of buffers still has their own texture reference, as the
texture is just a representation of the GPU memory associated with the
buffer. When such a buffer is attached to a surface, instead the surface
just gets a reference to that texture, instead of a separately allocated
one.
Fixes: https://gitlab.gnome.org/GNOME/mutter/issues/199
2019-02-08 05:46:48 -05:00
|
|
|
CoglTexture *texture,
|
2014-10-07 22:48:49 -04:00
|
|
|
cairo_region_t *region);
|
2019-09-12 05:44:59 -04:00
|
|
|
CoglScanout * meta_wayland_buffer_try_acquire_scanout (MetaWaylandBuffer *buffer,
|
|
|
|
CoglOnscreen *onscreen);
|
2014-10-07 22:39:00 -04:00
|
|
|
|
2019-09-18 10:18:58 -04:00
|
|
|
void meta_wayland_init_shm (MetaWaylandCompositor *compositor);
|
|
|
|
|
2014-10-07 22:39:00 -04:00
|
|
|
#endif /* META_WAYLAND_BUFFER_H */
|