1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of the QtGui module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39 
40 #ifndef QOPENGLPROGRAMBINARYCACHE_P_H
41 #define QOPENGLPROGRAMBINARYCACHE_P_H
42 
43 //
44 //  W A R N I N G
45 //  -------------
46 //
47 // This file is not part of the Qt API. It exists purely as an
48 // implementation detail. This header file may change from version to
49 // version without notice, or even be removed.
50 //
51 // We mean it.
52 //
53 
54 #include <QtGui/qtguiglobal.h>
55 #include <QtCore/qcache.h>
56 #include <QtCore/qmutex.h>
57 #include <QtGui/private/qopenglcontext_p.h>
58 #include <QtGui/private/qshader_p.h>
59 
60 QT_BEGIN_NAMESPACE
61 
62 // These classes are also used by the OpenGL backend of QRhi. They must
63 // therefore stay independent from QOpenGLShader(Program). Must rely only on
64 // QOpenGLContext/Functions.
65 
66 class QOpenGLProgramBinaryCache
67 {
68 public:
69     struct ShaderDesc {
ShaderDescShaderDesc70         ShaderDesc() { }
71         ShaderDesc(QShader::Stage stage, const QByteArray &source = QByteArray())
stageShaderDesc72           : stage(stage), source(source)
73         { }
74         QShader::Stage stage;
75         QByteArray source;
76     };
77     struct ProgramDesc {
78         QVector<ShaderDesc> shaders;
79         QByteArray cacheKey() const;
80     };
81 
82     QOpenGLProgramBinaryCache();
83 
84     bool load(const QByteArray &cacheKey, uint programId);
85     void save(const QByteArray &cacheKey, uint programId);
86 
87 private:
88     QString cacheFileName(const QByteArray &cacheKey) const;
89     bool verifyHeader(const QByteArray &buf) const;
90     bool setProgramBinary(uint programId, uint blobFormat, const void *p, uint blobSize);
91 
92     QString m_cacheDir;
93     bool m_cacheWritable;
94     struct MemCacheEntry {
MemCacheEntryMemCacheEntry95         MemCacheEntry(const void *p, int size, uint format)
96           : blob(reinterpret_cast<const char *>(p), size),
97             format(format)
98         { }
99         QByteArray blob;
100         uint format;
101     };
102     QCache<QByteArray, MemCacheEntry> m_memCache;
103 #if defined(QT_OPENGL_ES_2)
104     void (QOPENGLF_APIENTRYP programBinaryOES)(GLuint program, GLenum binaryFormat, const GLvoid *binary, GLsizei length);
105     void (QOPENGLF_APIENTRYP getProgramBinaryOES)(GLuint program, GLsizei bufSize, GLsizei *length, GLenum *binaryFormat, GLvoid *binary);
106     void initializeProgramBinaryOES(QOpenGLContext *context);
107     bool m_programBinaryOESInitialized = false;
108 #endif
109     QMutex m_mutex;
110 };
111 
112 // While unlikely, one application can in theory use contexts with different versions
113 // or profiles. Therefore any version- or extension-specific checks must be done on a
114 // per-context basis, not just once per process. QOpenGLSharedResource enables this,
115 // although it's once-per-sharing-context-group, not per-context. Still, this should
116 // be good enough in practice.
117 class QOpenGLProgramBinarySupportCheck : public QOpenGLSharedResource
118 {
119 public:
120     QOpenGLProgramBinarySupportCheck(QOpenGLContext *context);
invalidateResource()121     void invalidateResource() override { }
freeResource(QOpenGLContext *)122     void freeResource(QOpenGLContext *) override { }
123 
isSupported()124     bool isSupported() const { return m_supported; }
125 
126 private:
127     bool m_supported;
128 };
129 
130 class QOpenGLProgramBinarySupportCheckWrapper
131 {
132 public:
get(QOpenGLContext * context)133     QOpenGLProgramBinarySupportCheck *get(QOpenGLContext *context)
134     {
135         return m_resource.value<QOpenGLProgramBinarySupportCheck>(context);
136     }
137 
138 private:
139     QOpenGLMultiGroupSharedResource m_resource;
140 };
141 
142 QT_END_NAMESPACE
143 
144 #endif
145