/****************************************************************************

**

** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the QtOpenGL module of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#ifndef QGL_P_H

#define QGL_P_H

//

//  W A R N I N G

//  -------------

//

// This file is not part of the Qt API.  It exists for the convenience

// of the QGLWidget class.  This header file may change from

// version to version without notice, or even be removed.

//

// We mean it.

//

#include "QtOpenGL/qgl.h"

#include "QtOpenGL/qglcolormap.h"

#include "QtCore/qmap.h"

#include "QtCore/qthread.h"

#include "QtCore/qthreadstorage.h"

#include "QtCore/qhash.h"

#include "QtCore/qatomic.h"

#include "private/qwidget_p.h"

#include "qcache.h"

#include "qglpaintdevice_p.h"

#ifndef QT_NO_EGL

#include <QtGui/private/qegl_p.h>

#endif

QT_BEGIN_NAMESPACE

class QGLContext;

class QGLOverlayWidget;

class QPixmap;

class QPixmapFilter;

#ifdef Q_WS_MAC

# ifdef qDebug

#   define old_qDebug qDebug

#   undef qDebug

# endif

QT_BEGIN_INCLUDE_NAMESPACE

#ifndef QT_MAC_USE_COCOA

# include <AGL/agl.h>

#endif

QT_END_INCLUDE_NAMESPACE

# ifdef old_qDebug

#   undef qDebug

#   define qDebug QT_QDEBUG_MACRO

#   undef old_qDebug

# endif

class QMacWindowChangeEvent;

#endif

#ifdef Q_WS_QWS

class QWSGLWindowSurface;

#endif

#ifndef QT_NO_EGL

class QEglContext;

#endif

QT_BEGIN_INCLUDE_NAMESPACE

#include <QtOpenGL/private/qglextensions_p.h>

QT_END_INCLUDE_NAMESPACE

class QGLFormatPrivate

{

public:

    QGLFormatPrivate()

        : ref(1)

    {

        opts = QGL::DoubleBuffer | QGL::DepthBuffer | QGL::Rgba | QGL::DirectRendering

             | QGL::StencilBuffer | QGL::DeprecatedFunctions;

        pln = 0;

        depthSize = accumSize = stencilSize = redSize = greenSize = blueSize = alphaSize = -1;

        numSamples = -1;

        swapInterval = -1;

        majorVersion = 1;

        minorVersion = 0;

        profile = QGLFormat::NoProfile;

    }

    QGLFormatPrivate(const QGLFormatPrivate *other)

        : ref(1),

          opts(other->opts),

          pln(other->pln),

          depthSize(other->depthSize),

          accumSize(other->accumSize),

          stencilSize(other->stencilSize),

          redSize(other->redSize),

          greenSize(other->greenSize),

          blueSize(other->blueSize),

          alphaSize(other->alphaSize),

          numSamples(other->numSamples),

          swapInterval(other->swapInterval),

          majorVersion(other->majorVersion),

          minorVersion(other->minorVersion),

          profile(other->profile)

    {

    }

    QAtomicInt ref;

    QGL::FormatOptions opts;

    int pln;

    int depthSize;

    int accumSize;

    int stencilSize;

    int redSize;

    int greenSize;

    int blueSize;

    int alphaSize;

    int numSamples;

    int swapInterval;

    int majorVersion;

    int minorVersion;

    QGLFormat::OpenGLContextProfile profile;

};

class QGLWidgetPrivate : public QWidgetPrivate

{

    Q_DECLARE_PUBLIC(QGLWidget)

public:

    QGLWidgetPrivate() : QWidgetPrivate()

                       , disable_clear_on_painter_begin(false)

#ifdef Q_WS_QWS

                       , wsurf(0)

#endif

#if defined(Q_WS_X11) && !defined(QT_NO_EGL)

                       , eglSurfaceWindowId(0)

#endif

    {

        isGLWidget = 1;

    }

    ~QGLWidgetPrivate() {}

    void init(QGLContext *context, const QGLWidget* shareWidget);

    void initContext(QGLContext *context, const QGLWidget* shareWidget);

    bool renderCxPm(QPixmap *pixmap);

    void cleanupColormaps();

    QGLContext *glcx;

    QGLWidgetGLPaintDevice glDevice;

    bool autoSwap;

    QGLColormap cmap;

#ifndef QT_OPENGL_ES

    QMap<QString, int> displayListCache;

#endif

    bool disable_clear_on_painter_begin;

#if defined(Q_WS_WIN)

    void updateColormap();

    QGLContext *olcx;

#elif defined(Q_WS_X11)

    QGLOverlayWidget *olw;

#ifndef QT_NO_EGL

    void recreateEglSurface();

    WId eglSurfaceWindowId;

#endif

#elif defined(Q_WS_MAC)

    QGLContext *olcx;

    void updatePaintDevice();

#elif defined(Q_WS_QWS)

    QWSGLWindowSurface *wsurf;

#endif

};

class QGLContextResource;

class QGLSharedResourceGuard;

typedef QHash<QString, GLuint> QGLDDSCache;

// QGLContextPrivate has the responsibility of creating context groups.

// QGLContextPrivate maintains the reference counter and destroys

// context groups when needed.

class QGLContextGroup

{

public:

    ~QGLContextGroup();

    QGLExtensionFuncs &extensionFuncs() {return m_extensionFuncs;}

    const QGLContext *context() const {return m_context;}

    bool isSharing() const { return m_shares.size() >= 2; }

    QList<const QGLContext *> shares() const { return m_shares; }

    void addGuard(QGLSharedResourceGuard *guard);

    void removeGuard(QGLSharedResourceGuard *guard);

    static void addShare(const QGLContext *context, const QGLContext *share);

    static void removeShare(const QGLContext *context);

private:

    QGLContextGroup(const QGLContext *context) : m_context(context), m_guards(0), m_refs(1) { }

    QGLExtensionFuncs m_extensionFuncs;

    const QGLContext *m_context; // context group's representative

    QList<const QGLContext *> m_shares;

    QHash<QGLContextResource *, void *> m_resources;

    QGLSharedResourceGuard *m_guards; // double-linked list of active guards.

    QAtomicInt m_refs;

    QGLDDSCache m_dds_cache;

    void cleanupResources(const QGLContext *ctx);

    friend class QGLContext;

    friend class QGLContextPrivate;

    friend class QGLContextResource;

};

// Get the context that resources for "ctx" will transfer to once

// "ctx" is destroyed.  Returns null if nothing is sharing with ctx.

Q_OPENGL_EXPORT const QGLContext *qt_gl_transfer_context(const QGLContext *);

// GL extension definitions

class QGLExtensions {

public:

    enum Extension {

        TextureRectangle        = 0x00000001,

        SampleBuffers           = 0x00000002,

        GenerateMipmap          = 0x00000004,

        TextureCompression      = 0x00000008,

        FragmentProgram         = 0x00000010,

        MirroredRepeat          = 0x00000020,

        FramebufferObject       = 0x00000040,

        StencilTwoSide          = 0x00000080,

        StencilWrap             = 0x00000100,

        PackedDepthStencil      = 0x00000200,

        NVFloatBuffer           = 0x00000400,

        PixelBufferObject       = 0x00000800,

        FramebufferBlit         = 0x00001000,

        NPOTTextures            = 0x00002000,

        BGRATextureFormat       = 0x00004000,

        DDSTextureCompression   = 0x00008000,

        ETC1TextureCompression  = 0x00010000,

        PVRTCTextureCompression = 0x00020000,

        FragmentShader          = 0x00040000

    };

    Q_DECLARE_FLAGS(Extensions, Extension)

    static Extensions glExtensions();

    static Extensions currentContextExtensions();

};

/*

    QGLTemporaryContext - the main objective of this class is to have a way of

    creating a GL context and making it current, without going via QGLWidget

    and friends. At certain points during GL initialization we need a current

    context in order decide what GL features are available, and to resolve GL

    extensions. Having a light-weight way of creating such a context saves

    initial application startup time, and it doesn't wind up creating recursive

    conflicts.

    The class currently uses a private d pointer to hide the platform specific

    types. This could possibly been done inline with #ifdef'ery, but it causes

    major headaches on e.g. X11 due to namespace pollution.

*/

class QGLTemporaryContextPrivate;

class QGLTemporaryContext {

public:

    QGLTemporaryContext(bool directRendering = true, QWidget *parent = 0);

    ~QGLTemporaryContext();

private:

    QScopedPointer<QGLTemporaryContextPrivate> d;

};

class QGLTexture;

// This probably needs to grow to GL_MAX_VERTEX_ATTRIBS, but 3 is ok for now as that's

// all the GL2 engine uses:

#define QT_GL_VERTEX_ARRAY_TRACKED_COUNT 3

class QGLContextPrivate

{

    Q_DECLARE_PUBLIC(QGLContext)

public:

    explicit QGLContextPrivate(QGLContext *context) : internal_context(false), q_ptr(context) {group = new QGLContextGroup(context);}

    ~QGLContextPrivate();

    QGLTexture *bindTexture(const QImage &image, GLenum target, GLint format,

                            QGLContext::BindOptions options);

    QGLTexture *bindTexture(const QImage &image, GLenum target, GLint format, const qint64 key,

                            QGLContext::BindOptions options);

    QGLTexture *bindTexture(const QPixmap &pixmap, GLenum target, GLint format,

                            QGLContext::BindOptions options);

    QGLTexture *textureCacheLookup(const qint64 key, GLenum target);

    void init(QPaintDevice *dev, const QGLFormat &format);

    QImage convertToGLFormat(const QImage &image, bool force_premul, GLenum texture_format);

    int maxTextureSize();

    void cleanup();

    void setVertexAttribArrayEnabled(int arrayIndex, bool enabled = true);

    void syncGlState(); // Makes sure the GL context's state is what we think it is

#if defined(Q_WS_WIN)

    void updateFormatVersion();

#endif

#if defined(Q_WS_WIN)

    HGLRC rc;

    HDC dc;

    WId        win;

    int pixelFormatId;

    QGLCmap* cmap;

    HBITMAP hbitmap;

    HDC hbitmap_hdc;

#endif

#ifndef QT_NO_EGL

    uint ownsEglContext : 1;

    QEglContext *eglContext;

    EGLSurface eglSurface;

    void destroyEglSurfaceForDevice();

    EGLSurface eglSurfaceForDevice() const;

#elif defined(Q_WS_X11) || defined(Q_WS_MAC)

    void* cx;

#endif

#if defined(Q_WS_X11) || defined(Q_WS_MAC)

    void* vi;

#endif

#if defined(Q_WS_X11)

    void* pbuf;

    quint32 gpm;

    int screen;

    QHash<QPixmapData*, QPixmap> boundPixmaps;

    QGLTexture *bindTextureFromNativePixmap(QPixmap*, const qint64 key,

                                            QGLContext::BindOptions options);

    static void destroyGlSurfaceForPixmap(QPixmapData*);

    static void unbindPixmapFromTexture(QPixmapData*);

#endif

#if defined(Q_WS_MAC)

    bool update;

    void *tryFormat(const QGLFormat &format);

    void clearDrawable();

#endif

    QGLFormat glFormat;

    QGLFormat reqFormat;

    GLuint fbo;

    uint valid : 1;

    uint sharing : 1;

    uint initDone : 1;

    uint crWin : 1;

    uint internal_context : 1;

    uint version_flags_cached : 1;

    uint extension_flags_cached : 1;

    // workarounds for driver/hw bugs on different platforms

    uint workaround_needsFullClearOnEveryFrame : 1;

    uint workaround_brokenFBOReadBack : 1;

    uint workaroundsCached : 1;

    QPaintDevice *paintDevice;

    QColor transpColor;

    QGLContext *q_ptr;

    QGLFormat::OpenGLVersionFlags version_flags;

    QGLExtensions::Extensions extension_flags;

    QGLContextGroup *group;

    GLint max_texture_size;

    GLuint current_fbo;

    GLuint default_fbo;

    QPaintEngine *active_engine;

    bool vertexAttributeArraysEnabledState[QT_GL_VERTEX_ARRAY_TRACKED_COUNT];

    static inline QGLContextGroup *contextGroup(const QGLContext *ctx) { return ctx->d_ptr->group; }

#ifdef Q_WS_WIN

    static inline QGLExtensionFuncs& extensionFuncs(const QGLContext *ctx) { return ctx->d_ptr->group->extensionFuncs(); }

#endif

#if defined(Q_WS_X11) || defined(Q_WS_MAC) || defined(Q_WS_QWS)

    static QGLExtensionFuncs qt_extensionFuncs;

    static inline QGLExtensionFuncs& extensionFuncs(const QGLContext *) { return qt_extensionFuncs; }

#endif

    static void setCurrentContext(QGLContext *context);

};

// ### make QGLContext a QObject in 5.0 and remove the proxy stuff

class Q_OPENGL_EXPORT QGLSignalProxy : public QObject

{

    Q_OBJECT

public:

    QGLSignalProxy() : QObject() {}

    void emitAboutToDestroyContext(const QGLContext *context) {

        emit aboutToDestroyContext(context);

    }

    static QGLSignalProxy *instance();

Q_SIGNALS:

    void aboutToDestroyContext(const QGLContext *context);

};

Q_DECLARE_OPERATORS_FOR_FLAGS(QGLExtensions::Extensions)

// Temporarily make a context current if not already current or

// shared with the current contex.  The previous context is made

// current when the object goes out of scope.

class Q_OPENGL_EXPORT QGLShareContextScope

{

public:

    QGLShareContextScope(const QGLContext *ctx)

        : m_oldContext(0)

    {

        QGLContext *currentContext = const_cast<QGLContext *>(QGLContext::currentContext());

        if (currentContext != ctx && !QGLContext::areSharing(ctx, currentContext)) {

            m_oldContext = currentContext;

            m_ctx = const_cast<QGLContext *>(ctx);

            m_ctx->makeCurrent();

        } else {

            m_ctx = currentContext;

        }

    }

    operator QGLContext *()

    {

        return m_ctx;

    }

    QGLContext *operator->()

    {

        return m_ctx;

    }

    ~QGLShareContextScope()

    {

        if (m_oldContext)

            m_oldContext->makeCurrent();

    }

private:

    QGLContext *m_oldContext;

    QGLContext *m_ctx;

};

class QGLTexture {

public:

    QGLTexture(QGLContext *ctx = 0, GLuint tx_id = 0, GLenum tx_target = GL_TEXTURE_2D,

               QGLContext::BindOptions opt = QGLContext::DefaultBindOption)

        : context(ctx),

          id(tx_id),

          target(tx_target),

          options(opt)

#if defined(Q_WS_X11)

        , boundPixmap(0)

#endif

    {}

    ~QGLTexture() {

        if (options & QGLContext::MemoryManagedBindOption) {

            Q_ASSERT(context);

            QGLShareContextScope scope(context);

#if defined(Q_WS_X11)

            // Although glXReleaseTexImage is a glX call, it must be called while there

            // is a current context - the context the pixmap was bound to a texture in.

            // Otherwise the release doesn't do anything and you get BadDrawable errors

            // when you come to delete the context.

            if (boundPixmap)

                QGLContextPrivate::unbindPixmapFromTexture(boundPixmap);

#endif

            glDeleteTextures(1, &id);

        }

     }

    QGLContext *context;

    GLuint id;

    GLenum target;

    QGLContext::BindOptions options;

#if defined(Q_WS_X11)

    QPixmapData* boundPixmap;

#endif

    bool canBindCompressedTexture

        (const char *buf, int len, const char *format, bool *hasAlpha);