Refactor buffer handling

We cannot support bindToTexture() functions. On some
platforms the texture is provided by the driver. Therefore,
the HW integration must always provide a texture.

This has the added bonus of unifying the two separate code paths
that were introduced when EGLStream support was added.

Add a separate buffer manager that owns all buffers.
Don't destroy buffer objects on release. The client will probably
attach them again later. Also, release shm buffers immediately
after uploading to texture (needs to be documented that image()
will not work afterwards).

Make the old SurfaceBuffer class into an abstract base class,
so we can store state in the buffer class instead of having
to map from the wl_resource in each buffer integration. Move
the shared memory buffer handling into a separate subclass.

Change-Id: I81e471d13c92913d31ea1efe487f93fa908b5e0c
Reviewed-by: Dominik Holland <dominik.holland@pelagicore.com>
Reviewed-by: Louai Al-Khanji <louai.al-khanji@qt.io>
Reviewed-by: Johan Helsing <johan.helsing@qt.io>

1 files changed, 147 insertions, 0 deletions

diff --git a/src/compositor/wayland_wrapper/qwlclientbuffer_p.h b/src/compositor/wayland_wrapper/qwlclientbuffer_p.h
new file mode 100644
index 000000000..72c5a56e3
--- /dev/null
+++ b/src/compositor/wayland_wrapper/qwlclientbuffer_p.h
@@ -0,0 +1,147 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the QtWaylandCompositor module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL3$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPLv3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or later as published by the Free
+** Software Foundation and appearing in the file LICENSE.GPL included in
+** the packaging of this file. Please review the following information to
+** ensure the GNU General Public License version 2.0 requirements will be
+** met: http://www.gnu.org/licenses/gpl-2.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QWLCLIENTBUFFER_P_H
+#define QWLCLIENTBUFFER_P_H
+
+//
+//  W A R N I N G
+//  -------------
+//
+// This file is not part of the Qt API.  It exists purely as an
+// implementation detail.  This header file may change from version to
+// version without notice, or even be removed.
+//
+// We mean it.
+//
+
+#include <QtCore/QRect>
+#include <QtGui/qopengl.h>
+#include <QImage>
+#include <QAtomicInt>
+
+#include <QtWaylandCompositor/QWaylandSurface>
+#include <QtWaylandCompositor/QWaylandBufferRef>
+
+#include <wayland-server.h>
+
+QT_BEGIN_NAMESPACE
+
+class QWaylandClientBufferIntegration;
+class QWaylandBufferRef;
+class QWaylandCompositor;
+class QOpenGLTexture;
+
+namespace QtWayland {
+
+struct surface_buffer_destroy_listener
+{
+    struct wl_listener listener;
+    class ClientBuffer *surfaceBuffer;
+};
+
+class Q_WAYLAND_COMPOSITOR_EXPORT ClientBuffer
+{
+public:
+    ClientBuffer(struct ::wl_resource *bufferResource);
+
+    virtual ~ClientBuffer();
+
+    virtual QWaylandBufferRef::BufferFormatEgl bufferFormatEgl() const;
+    virtual QSize size() const = 0;
+    virtual QWaylandSurface::Origin origin() const = 0;
+
+    virtual void *lockNativeBuffer() { return nullptr; }
+    virtual void unlockNativeBuffer(void *native_buffer) const { Q_UNUSED(native_buffer); }
+
+    virtual QImage image() const { return QImage(); }
+
+    inline bool isCommitted() const { return m_committed; }
+    virtual void setCommitted(QRegion &damage);
+    bool isDestroyed() { return m_destroyed; }
+
+    inline struct ::wl_resource *waylandBufferHandle() const { return m_buffer; }
+
+    bool isSharedMemory() const { return wl_shm_buffer_get(m_buffer); }
+
+#ifdef QT_WAYLAND_COMPOSITOR_GL
+    virtual QOpenGLTexture *toOpenGlTexture(int plane = 0) = 0;
+#endif
+
+    static bool hasContent(ClientBuffer *buffer) { return buffer && buffer->waylandBufferHandle(); }
+
+protected:
+    void ref();
+    void deref();
+    void sendRelease();
+    void setDestroyed();
+
+    struct ::wl_resource *m_buffer;
+    QRegion m_damage;
+    bool m_textureDirty;
+
+private:
+    bool m_committed;
+    bool m_destroyed;
+
+    QAtomicInt m_refCount;
+
+    friend class ::QWaylandBufferRef;
+    friend class BufferManager;
+};
+
+class Q_WAYLAND_COMPOSITOR_EXPORT SharedMemoryBuffer : public ClientBuffer
+{
+public:
+    SharedMemoryBuffer(struct ::wl_resource *bufferResource);
+
+    QSize size() const Q_DECL_OVERRIDE;
+    QWaylandSurface::Origin origin() const  Q_DECL_OVERRIDE;
+    QImage image() const;
+
+#ifdef QT_WAYLAND_COMPOSITOR_GL
+    QOpenGLTexture *toOpenGlTexture(int plane = 0) Q_DECL_OVERRIDE;
+
+private:
+    QOpenGLTexture *m_shmTexture;
+#endif
+};
+
+}
+
+QT_END_NAMESPACE
+
+#endif // QWLCLIENTBUFFER_P_H