summaryrefslogtreecommitdiffstats
path: root/src/runtime/q3dsimagemanager_p.h
blob: 1c894679fcc47bfd93ddb10c9eba1a856b0d5f19 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
/****************************************************************************
**
** Copyright (C) 2018 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of Qt 3D Studio.
**
** $QT_BEGIN_LICENSE:GPL$
** 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 https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) any later version
** approved by the KDE Free Qt Foundation. The licenses are as published by
** the Free Software Foundation and appearing in the file LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef Q3DSIMAGEMANAGERER_P_H
#define Q3DSIMAGEMANAGERER_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 "q3dsruntimeglobal_p.h"
#include <QHash>
#include <QUrl>
#include <QImage>
#include <QFuture>
#include <QMutex>
#include <QThreadPool>
#include <Qt3DRender/QAbstractTexture>
#include <Qt3DRender/QTextureImageData>
#include <Qt3DRender/QParameter>

QT_BEGIN_NAMESPACE

class Q3DSProfiler;

namespace Qt3DCore {
class QEntity;
}

class ReloadableTexture
{
public:
    ReloadableTexture(Qt3DCore::QEntity *parent, bool generateIBL, const QByteArray &id,
                      const QString &profileInfo, Q3DSProfiler *profiler)
        : m_parent(parent), m_id(id), m_profileInfo(profileInfo), m_generateIBL(generateIBL),
          m_profiler(profiler)
    {

    }
    void setSource(const QUrl &source);

    template <typename Caller, typename... Params>
    void onLoad(Caller caller, Params... params)
    {
        m_loadFunc = [this, caller, params...]() {
            caller(m_texture, params...);
        };
        // onLoad call might provide new parameters when called after loading so call it now
        if (m_loaded)
            m_loadFunc();
        else
            triggerLoading();
    }

    template <typename Caller, typename... Params>
    void onUnload(Caller caller, Params... params)
    {
        m_unloadFunc = [this, caller, params...]() {
            caller(m_texture, params...);
        };
        triggerLoading();
    }

    void reload();
    void unload();

    QUrl source() const
    {
        return m_source;
    }
    void loaded(Qt3DRender::QAbstractTexture *texture);
    bool wasLoaded() const
    {
        return m_loaded;
    }
    Qt3DRender::QAbstractTexture *texture()
    {
        return m_texture;
    }

    QString info()
    {
        return m_profileInfo;
    }

    Q3DSProfiler *profiler()
    {
        return m_profiler;
    }

private:
    void triggerLoading();

    Qt3DCore::QEntity *m_parent = nullptr;
    Qt3DRender::QAbstractTexture *m_texture = nullptr;
    QByteArray m_id;
    QString m_profileInfo;
    QUrl m_source;
    bool m_generateIBL = false;
    bool m_loaded = false;
    Q3DSProfiler *m_profiler = nullptr;

    std::function<void()> m_loadFunc = nullptr;
    std::function<void()> m_unloadFunc = nullptr;
};

typedef QSharedPointer<ReloadableTexture> ReloadableTexturePtr;

class Q3DSImageManager
{
public:
    enum ImageFlag {
        GenerateMipMapsForIBL = 0x01
    };
    Q_DECLARE_FLAGS(ImageFlags, ImageFlag)

    Q3DSImageManager();

    static Q3DSImageManager &instance();
    void invalidate();

    Qt3DRender::QAbstractTexture *newTextureForImage(Qt3DCore::QEntity *parent,
                                                     ImageFlags flags,
                                                     const QByteArray &id,
                                                     Q3DSProfiler *profiler = nullptr,
                                                     const QString &profilerInfo = {});
    ReloadableTexturePtr newReloadableTextureForImage(Qt3DCore::QEntity *parent,
                                                      ImageFlags flags,
                                                      const QByteArray &id,
                                                      Q3DSProfiler *profiler = nullptr,
                                                      const char *profName = nullptr, ...);

    void setSource(Qt3DRender::QAbstractTexture *tex, const QImage &image);

    QSize size(Qt3DRender::QAbstractTexture *tex) const;
    Qt3DRender::QAbstractTexture::TextureFormat format(Qt3DRender::QAbstractTexture *tex) const;
    bool wasCached(Qt3DRender::QAbstractTexture *tex) const;

    qint64 ioTimeMsecs() const { return m_ioTime; }
    qint64 iblTimeMsecs() const { return m_iblTime; }

    void finishAsyncLoad(bool wait = true);
    void beginImageLoad(const QSet<QUrl> &imageSet);
    void beginUnload(const QSet<QUrl> &imageSet);
    bool inResourceSet(const QUrl &url) const;

private:
    void loadImageData(const QUrl &source, bool async = true);
    void setSource(Qt3DRender::QAbstractTexture *tex, const QUrl &source);
    void textureLoaded(Qt3DRender::QAbstractTexture *tex, const QUrl &source);
    QVector<Qt3DRender::QTextureImageDataPtr> load(const QUrl &source);
    int blockSizeForFormat(QOpenGLTexture::TextureFormat format);
    QByteArray generateIblMip(int w, int h, int prevW, int prevH,
                              QOpenGLTexture::TextureFormat format,
                              int blockSize, const QByteArray &prevLevelData);
    QVector<Qt3DRender::QTextureImageDataPtr> generateIblForImageData(
                                                 QVector<Qt3DRender::QTextureImageDataPtr> result);


    struct TextureInfo {
        ImageFlags flags;
        QUrl source;
        QSize size;
        Qt3DRender::QAbstractTexture::TextureFormat format = Qt3DRender::QAbstractTexture::NoFormat;
        bool wasCached = false;
    };

    struct LoadImageDataAsync
    {
        QFuture<void> future;
        QString source;
        bool preferKtx = false;
        bool done = false;
    };

    QVector<ReloadableTexturePtr> m_reloadableTextures;
    QSet<QUrl> m_resourceSet;
    QHash<Qt3DRender::QAbstractTexture *, TextureInfo> m_metadata;
    QHash<QString, QVector<Qt3DRender::QTextureImageDataPtr> > m_cache;
    QHash<QString, LoadImageDataAsync> m_loadImageDataAsync;
    QHash<QString, QVector<Qt3DRender::QAbstractTexture *> *> m_pendingSetSource;
    QThreadPool m_threadPool;
    static QMutex s_loadMutex;
    qint64 m_ioTime = 0;
    qint64 m_iblTime = 0;
    QMutex m_finishAsyncLoadLock;
    friend ReloadableTexture;
};

Q_DECLARE_OPERATORS_FOR_FLAGS(Q3DSImageManager::ImageFlags)

QT_END_NAMESPACE

#endif // Q3DSIMAGEMANAGERER_P_H