path: root/src/runtime/api/q3dssurfaceviewer.cpp

/****************************************************************************
**
** Copyright (C) 2018 The Qt Company Ltd.
** Contact: https://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$
**
****************************************************************************/

#include "q3dssurfaceviewer_p.h"
#include <private/q3dsengine_p.h>
#include <private/q3dslogging_p.h>
#include <QLoggingCategory>
#include <QWindow>
#include <QOffscreenSurface>
#include <QOpenGLContext>
#include <QOpenGLFunctions>
#include <QPlatformSurfaceEvent>
#include <Qt3DCore/QEntity>
#include <Qt3DRender/QRenderSurfaceSelector>
#include <Qt3DRender/private/qrendersurfaceselector_p.h>
#include <Qt3DCore/QAspectEngine>
#include <Qt3DRender/private/qrenderaspect_p.h>
#include <QtQml/QQmlFile>

QT_BEGIN_NAMESPACE

/*!
    \class Q3DSSurfaceViewer
    \inmodule 3dstudioruntime2
    \since Qt 3D Studio 2.0

    \brief Renders a Qt 3D Studio presentation on a QWindow or an offscreen
    render target using OpenGL.

    Q3DSSurfaceViewer is used to render Qt 3D Studio presentations onto a
    QSurface. In practice this means two types of uses: rendering to an
    on-screen QWindow, or rendering to an offscreen render target (typically an
    OpenGL texture via a framebuffer object and a QOffscreenSurface).

    \section2 Example Usage

    \code
    int main(int argc, char *argv[])
    {
        QGuiApplication app(argc, argv);

        QOpenGLContext context;
        context.create();

        QWindow window;
        window.setSurfaceType(QSurface::OpenGLSurface);
        window.setFormat(context.format());
        window.create();

        Q3DSSurfaceViewer viewer;
        viewer.presentation()->setSource(QUrl(QStringLiteral("qrc:/my_presentation.uip")));
        viewer.setUpdateInterval(0); // enable automatic updates

        // Register a scene object for slide management (optional)
        Q3DSSceneElement scene(viewer.presentation(), QStringLiteral("Scene"));

        // Register an element object for attribute setting (optional)
        Q3DSElement element(viewer.presentation(), QStringLiteral("myCarModel"));

        viewer.create(&window, &context);

        w.resize(1024, 768);
        w.show();

        return app.exec();
    }
    \endcode

    \sa Q3DSWidget
 */

Q3DSSurfaceViewer::Q3DSSurfaceViewer(QObject *parent)
    : QObject(*new Q3DSSurfaceViewerPrivate, parent)
{
}

Q3DSSurfaceViewer::Q3DSSurfaceViewer(Q3DSSurfaceViewerPrivate &dd, QObject *parent)
    : QObject(dd, parent)
{
}

Q3DSSurfaceViewer::~Q3DSSurfaceViewer()
{
    destroy();
}

// There are two create() variants and this is intentional: merging them is not
// possible since just using a default value of 0 for fboId would be wrong: the
// "default framebuffer" may not be 0 on some platforms (iOS) so we need to
// differentiate between the cases of "use the default fb whatever that is" and
// "use this custom FBO as-is". Changing to int would be wrong too since the ID
// is a GLuint in practice.

/*!
    Initializes Q3DSSurfaceViewer to render the presentation to the given
    \a surface using the \a context.

    The source property of the attached presentation must be set before the
    viewer can be initialized.

    Returns whether the initialization succeeded.

    \sa running, Q3DSPresentation::source, presentation()
*/
bool Q3DSSurfaceViewer::create(QSurface *surface, QOpenGLContext *context)
{
    Q_D(Q3DSSurfaceViewer);
    return d->doCreate(surface, context, 0, false);
}

/*!
    Initializes Q3DSSurfaceViewer to render the presentation to the given
    \a surface using the \a context and optional framebuffer id (\a fboId). If
    \a fboId is omitted, it defaults to zero.

    The source property of the attached presentation must be set before the
    viewer can be initialized.

    Returns whether the initialization succeeded.

    \sa running, Q3DSPresentation::source, presentation()
*/
bool Q3DSSurfaceViewer::create(QSurface *surface, QOpenGLContext *context, uint fboId)
{
    Q_D(Q3DSSurfaceViewer);
    return d->doCreate(surface, context, fboId, true);
}

bool Q3DSSurfaceViewerPrivate::doCreate(QSurface *s, QOpenGLContext *c, uint id, bool idValid)
{
    if (presentation->source().isEmpty()) {
        qWarning("Q3DSSurfaceViewer: Presentation source must be set before calling create()");
        return false;
    }
    if (!s) {
        qWarning("Q3DSSurfaceViewer: Null surface passed to create()");
        return false;
    }
    if (!c) {
        qWarning("Q3DSSurfaceViewer: Null context passed to create()");
        return false;
    }

    surface = s;
    context = c;
    fbo = idValid ? id : c->defaultFramebufferObject();

    destroyEngine();

    return createEngine();
}

/*!
    Releases the presentation and all related resources.

    The Q3DSSurfaceViewer instance can be reused by calling create() again.
 */
void Q3DSSurfaceViewer::destroy()
{
    Q_D(Q3DSSurfaceViewer);
    if (d->engine)
        d->destroyEngine();

    d->surface = nullptr;
    d->context = nullptr;
    d->fbo = 0;
}

/*!
    \fn Q3DSSurfaceViewer::frameUpdate()

    This signal is emitted each time a frame has been rendered.
*/

/*!
    \fn Q3DSSurfaceViewer::presentationLoaded()

    This signal is emitted when the viewer has been initialized and the
    presentation is ready to be shown.
*/

/*!
    Returns the presentation object used by the Q3DSSurfaceViewer.
*/
Q3DSPresentation *Q3DSSurfaceViewer::presentation() const
{
    Q_D(const Q3DSSurfaceViewer);
    return d->presentation;
}

/*!
    Returns the settings object used by the Q3DSSurfaceViewer.
*/
Q3DSViewerSettings *Q3DSSurfaceViewer::settings() const
{
    Q_D(const Q3DSSurfaceViewer);
    return d->viewerSettings;
}

/*!
    \property Q3DSSurfaceViewer::error

    Contains the text for the error message that was generated during the
    loading of the presentation. When no error occurred or there is no
    presentation loaded, the value is an empty string.

    This property is read-only.
 */
QString Q3DSSurfaceViewer::error() const
{
    Q_D(const Q3DSSurfaceViewer);
    return d->error;
}

/*!
    \property Q3DSSurfaceViewer::running

    The value of this property is \c true when the viewer has been initialized
    and the presentation is running.

    This property is read-only.
*/
bool Q3DSSurfaceViewer::isRunning() const
{
    Q_D(const Q3DSSurfaceViewer);
    return d->engine && d->sourceLoaded;
}

/*!
    \property Q3DSSurfaceViewer::size

    Holds the desired size of the presentation. Relevant only when
    autoSize is set to \c false.

    \sa autoSize
*/
QSize Q3DSSurfaceViewer::size() const
{
    Q_D(const Q3DSSurfaceViewer);
    return d->requestedSize;
}

void Q3DSSurfaceViewer::setSize(const QSize &size)
{
    Q_D(Q3DSSurfaceViewer);
    if (d->requestedSize != size) {
        d->requestedSize = size;
        emit sizeChanged();
    }
}

/*!
    \property Q3DSSurfaceViewer::autoSize

    Specifies whether the viewer should change the size of the presentation
    automatically to match the surface size when surface size changes. The
    \l{Q3DSSurfaceViewer::size}{size} property is updated automatically
    whenever the viewer is \l{Q3DSSurfaceViewer::update()}{updated} if this
    property value is \c{true}.

    When rendering offscreen, via a QOffscreenSurface, this property must be
    set to \c{false} by the application since it is then up to the application
    to provide a QOpenGLFramebufferObject with the desired size. The size of
    the Q3DSSurfaceViewer must be set to the same value.

    The default value is \c{true}.
*/
bool Q3DSSurfaceViewer::autoSize() const
{
    Q_D(const Q3DSSurfaceViewer);
    return d->autoSize;
}

void Q3DSSurfaceViewer::setAutoSize(bool autoSize)
{
    Q_D(Q3DSSurfaceViewer);
    if (d->autoSize != autoSize) {
        d->autoSize = autoSize;
        emit autoSizeChanged();
    }
}

/*!
    \property Q3DSSurfaceViewer::updateInterval

    Holds the viewer update interval in milliseconds. If the value is negative,
    the viewer doesn't update the presentation automatically.

    The default value is -1, meaning there are no automatic updates and
    update() must be called manually.

    \sa update()
*/
int Q3DSSurfaceViewer::updateInterval() const
{
    Q_D(const Q3DSSurfaceViewer);
    return d->updateInterval;
}

void Q3DSSurfaceViewer::setUpdateInterval(int interval)
{
    Q_D(Q3DSSurfaceViewer);
    if (d->updateInterval != interval) {
        d->updateInterval = interval;
        emit updateIntervalChanged();
    }

    if (d->updateInterval >= 0) {
        d->updateTimer.setInterval(d->updateInterval);
        d->updateTimer.start();
    } else {
        d->updateTimer.stop();
    }
}

/*!
    Returns the framebuffer id given in initialization.

    \sa create()
*/
uint Q3DSSurfaceViewer::fboId() const
{
    Q_D(const Q3DSSurfaceViewer);
    return d->fbo;
}

/*!
    Returns the surface given in initialization.

    \sa create()
*/
QSurface *Q3DSSurfaceViewer::surface() const
{
    Q_D(const Q3DSSurfaceViewer);
    return d->surface;
}

/*!
    Returns the context given in initialization.

    \sa create()
*/
QOpenGLContext *Q3DSSurfaceViewer::context() const
{
    Q_D(const Q3DSSurfaceViewer);
    return d->context;
}

extern Q_GUI_EXPORT QImage qt_gl_read_framebuffer(const QSize &size, bool alpha_format, bool include_alpha);

/*!
    Updates the surface viewer with a new frame.
*/
void Q3DSSurfaceViewer::update()
{
    Q_D(Q3DSSurfaceViewer);
    if (!d->engine || !d->sourceLoaded)
        return;

    if (d->surface->surfaceClass() == QSurface::Window && !static_cast<QWindow *>(d->surface)->isExposed())
        return;

    if (!d->context->makeCurrent(d->surface)) {
        qWarning("Q3DSSurfaceViewer: Failed to make context current");
        return;
    }

    if (!d->renderAspect) {
        qCDebug(lc3DSSurface, "Creating renderer");
        d->renderAspect = new Qt3DRender::QRenderAspect(Qt3DRender::QRenderAspect::Synchronous);
        d->engine->aspectEngine()->registerAspect(d->renderAspect);
        auto renderAspectD = static_cast<Qt3DRender::QRenderAspectPrivate *>(Qt3DRender::QRenderAspectPrivate::get(d->renderAspect));
        renderAspectD->renderInitialize(d->context);
        d->context->makeCurrent(d->surface);
        d->engine->start();
    }

    const uint defaultFbo = d->context->defaultFramebufferObject();
    QSize sz;
    qreal dpr;
    // Pick the size from the window when autoSize is enabled. However, a
    // QOffscreenSize's size() is useless and must not be relied upon.
    if (d->autoSize && d->surface->surfaceClass() == QSurface::Window && d->fbo == defaultFbo) {
        QWindow *w = static_cast<QWindow *>(d->surface);
        dpr = w->devicePixelRatio();
        sz = w->size() * dpr;
        if (d->requestedSize != sz) {
            d->requestedSize = sz;
            emit sizeChanged();
        }
    } else {
        sz = d->requestedSize;
        dpr = 1.0f;
    }
    if (d->actualSize != sz) {
        d->actualSize = sz;
        d->engine->resize(sz, dpr, true);
        d->sendResizeToQt3D(sz);
    }

    QOpenGLFunctions *f = d->context->functions();
    f->glBindFramebuffer(GL_FRAMEBUFFER, d->fbo);

    auto renderAspectD = static_cast<Qt3DRender::QRenderAspectPrivate *>(Qt3DRender::QRenderAspectPrivate::get(d->renderAspect));
    renderAspectD->renderSynchronous();

    if (d->wantsGrab) {
        d->context->makeCurrent(d->surface);
        f->glBindFramebuffer(GL_FRAMEBUFFER, d->fbo);
        d->grabImage = qt_gl_read_framebuffer(d->actualSize, false, false);
    }

    emit frameUpdate();
}

/*!
    Grabs the data rendered to the framebuffer into an image using the given \a
    rect. The \a rect parameter is optional. If it is omitted, the whole
    framebuffer is captured.

    \note This is a potentially expensive operation.
*/
QImage Q3DSSurfaceViewer::grab(const QRect &rect)
{
    Q_D(Q3DSSurfaceViewer);
    if (!d->engine)
        return QImage();

    d->wantsGrab = true;
    update();
    d->wantsGrab = false;

    // rect is expected to be in pixels since anything else is inherently
    // broken due to surfaceviewer handling multiple different cases (window,
    // window with targeting FBO, offscreen surface with targeting FBO) with
    // different dpr concepts (window has one, the others don't).

    return rect.isValid() ? d->grabImage.copy(rect) : d->grabImage;
}

Q3DSSurfaceViewerPrivate::Q3DSSurfaceViewerPrivate()
    : presentation(new Q3DSPresentation),
      viewerSettings(new Q3DSViewerSettings)
{
    Q3DSPresentationPrivate::get(presentation)->setController(this);

    QObject::connect(viewerSettings, &Q3DSViewerSettings::showRenderStatsChanged, viewerSettings, [this] {
        if (engine)
            engine->setProfileUiVisible(viewerSettings->isShowingRenderStats());
    });
}

Q3DSSurfaceViewerPrivate::~Q3DSSurfaceViewerPrivate()
{
    delete viewerSettings;
    delete presentation;
}

bool Q3DSSurfaceViewerPrivate::createEngine()
{
    Q_Q(Q3DSSurfaceViewer);
    if (!context || !surface)
        return false;

    Q_ASSERT(!engine);

    engine = new Q3DSEngine;

    Q3DSEngine::Flags flags = Q3DSEngine::WithoutRenderAspect;
    if (sourceFlags.testFlag(Q3DSPresentationController::Profiling))
        flags |= Q3DSEngine::EnableProfiling;

    engine->setFlags(flags);
    engine->setAutoToggleProfileUi(false); // up to the app to control this via the API instead

    switch (surface->surfaceClass()) {
    case QSurface::Window:
        windowOrOffscreenSurface = static_cast<QWindow *>(surface);
        break;
    case QSurface::Offscreen:
        windowOrOffscreenSurface = static_cast<QOffscreenSurface *>(surface);
        break;
    default:
        qWarning("Q3DSSurfaceViewer: Got surface with unknown class (neither QWindow nor QOffscreenSurface)");
        return false;
    }
    engine->setSurface(windowOrOffscreenSurface);

    qCDebug(lc3DSSurface, "Created engine %p", engine);

    initializePresentationController(engine, presentation);

    const QString fn = QQmlFile::urlToLocalFileOrQrc(source);
    qCDebug(lc3DSSurface, "source is now %s", qPrintable(fn));

    actualSize = QSize();
    if (autoSize && surface->surfaceClass() == QSurface::Window) {
        actualSize = static_cast<QWindow *>(surface)->size();
        if (!actualSize.isEmpty())
            engine->resize(actualSize);
    }

    QObject::connect(engine, &Q3DSEngine::presentationLoaded, engine, [this] {
        Q_Q(Q3DSSurfaceViewer);
        if (viewerSettings->isShowingRenderStats())
            engine->setProfileUiVisible(true);
        emit q->presentationLoaded();
    });

    QString err;
    sourceLoaded = engine->setSource(fn, &err, inlineQmlSubPresentations);
    if (!sourceLoaded) {
        qWarning("Q3DSSurfaceViewer: Failed to load %s\n%s", qPrintable(fn), qPrintable(err));
        error = err;
        emit q->errorChanged();
        emit q->runningChanged();
        return false;
    }

    if (!error.isEmpty()) {
        error.clear();
        emit q->errorChanged();
    }

    if (actualSize.isEmpty())
        actualSize = engine->implicitSize();

    sendResizeToQt3D(actualSize);

    surfaceWatcher.reset(new Q3DSSurfaceWatcher(this));

    if (!updateTimerInitialized) {
        updateTimerInitialized = true;
        QObject::connect(&updateTimer, &QTimer::timeout, q, &Q3DSSurfaceViewer::update);
    }

    emit q->runningChanged();

    return true;
}

void Q3DSSurfaceViewerPrivate::destroyEngine()
{
    if (!context || !surface)
        return;

    surfaceWatcher.reset();

    context->makeCurrent(surface);

    if (renderAspect) {
        qCDebug(lc3DSSurface, "Destroying renderer");
        auto renderAspectD = static_cast<Qt3DRender::QRenderAspectPrivate *>(Qt3DRender::QRenderAspectPrivate::get(renderAspect));
        renderAspectD->renderShutdown();
        renderAspect = nullptr;
        context->makeCurrent(surface);
    }

    if (engine) {
        qCDebug(lc3DSSurface, "Destroying engine %p", engine);
        delete engine;
        engine = nullptr;
    }
}

void Q3DSSurfaceViewerPrivate::handlePresentationSource(const QUrl &newSource,
                                                        SourceFlags flags,
                                                        const QVector<Q3DSInlineQmlSubPresentation *> &inlineSubPres)
{
    if (newSource == source)
        return;

    destroyEngine();

    source = newSource;
    sourceFlags = flags;
    inlineQmlSubPresentations = inlineSubPres;

    if (surface && context)
        createEngine();
}

void Q3DSSurfaceViewerPrivate::handlePresentationReload()
{
    if (source.isEmpty())
        return;

    destroyEngine();

    if (surface && context)
        createEngine();
}

void Q3DSSurfaceViewerPrivate::sendResizeToQt3D(const QSize &size)
{
    Qt3DCore::QEntity *rootEntity = engine->rootEntity();
    if (rootEntity) {
        Qt3DRender::QRenderSurfaceSelector *surfaceSelector = Qt3DRender::QRenderSurfaceSelectorPrivate::find(rootEntity);
        qCDebug(lc3DSSurface, "Setting external render target size on surface selector %p", surfaceSelector);
        if (surfaceSelector) {
            surfaceSelector->setExternalRenderTargetSize(size);
            float dpr = 1;
            if (surface->surfaceClass() == QSurface::Window)
                dpr = float(static_cast<QWindow *>(surface)->devicePixelRatio());
            surfaceSelector->setSurfacePixelRatio(dpr);
        }
    }
}

Q3DSSurfaceWatcher::Q3DSSurfaceWatcher(Q3DSSurfaceViewerPrivate *p)
    : d(p)
{
    Q_ASSERT(d->context && d->windowOrOffscreenSurface);

    d->windowOrOffscreenSurface->installEventFilter(this);

    connect(d->context, &QOpenGLContext::aboutToBeDestroyed, this, [this]() {
        d->destroyEngine();
    });
}

bool Q3DSSurfaceWatcher::eventFilter(QObject *watched, QEvent *event)
{
    if (event->type() == QEvent::PlatformSurface) {
        QPlatformSurfaceEvent *e = static_cast<QPlatformSurfaceEvent *>(event);
        if (e->surfaceEventType() == QPlatformSurfaceEvent::SurfaceAboutToBeDestroyed)
            d->destroyEngine();
    }
    return QObject::eventFilter(watched, event);
}

QT_END_NAMESPACE