qt-everywhere-src-5.14.1/qtmultimedia/src/imports/audioengine/qdeclarative_audioengine_p.h

/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the plugins of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 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.LGPL3 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-3.0.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 (at your option) the GNU General
** Public license version 3 or 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.GPL2 and 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-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QDECLARATIVEAUDIOENGINE_P_H
#define QDECLARATIVEAUDIOENGINE_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 <QtQml/qqml.h>
#include <QtQml/qqmlcomponent.h>
#include <QtQml/qqmlpropertymap.h>
#include <QtCore/QMap>
#include <QtCore/QList>
#include <QTimer>
#include "qaudioengine_p.h"

QT_BEGIN_NAMESPACE

class QDeclarativeSoundInstance;
class QDeclarativeAudioListener;
class QDeclarativeAudioCategory;
class QDeclarativeAudioSample;
class QDeclarativeSound;
class QDeclarativePlayVariation;
class QAudioCategory;
class QDeclarativeAttenuationModel;
class QSoundInstance;

class QDeclarativeAudioEngine : public QObject, public QQmlParserStatus
{
    Q_OBJECT
    Q_INTERFACES(QQmlParserStatus)
    Q_PROPERTY(QQmlListProperty<QObject> bank READ bank CONSTANT)
    Q_PROPERTY(QObject* categories READ categories CONSTANT)
    Q_PROPERTY(QObject* samples READ samples CONSTANT)
    Q_PROPERTY(QObject* sounds READ sounds CONSTANT)
    Q_PROPERTY(bool loading READ isLoading NOTIFY isLoadingChanged)
    Q_PROPERTY(int liveInstances READ liveInstanceCount NOTIFY liveInstanceCountChanged)
    Q_PROPERTY(QDeclarativeAudioListener* listener READ listener CONSTANT)
    Q_PROPERTY(qreal dopplerFactor READ dopplerFactor WRITE setDopplerFactor)
    Q_PROPERTY(qreal speedOfSound READ speedOfSound WRITE setSpeedOfSound)
    Q_CLASSINFO("DefaultProperty", "bank")

public:
    QDeclarativeAudioEngine(QObject *parent = 0);
    ~QDeclarativeAudioEngine();

    void classBegin() override;
    void componentComplete() override;

    //This is used for tracking all objects declared inside AudioEngine
    //see appendFunction
    QQmlListProperty<QObject> bank();

    QObject* categories();
    QObject* samples();
    QObject* sounds();

    QDeclarativeAudioListener* listener() const;

    qreal dopplerFactor() const;
    void setDopplerFactor(qreal dopplerFactor);

    qreal speedOfSound() const;
    void setSpeedOfSound(qreal speedOfSound);

    bool isLoading() const;

    int liveInstanceCount() const;

    //for child elements
    bool isReady() const;
    QAudioEngine* engine() const;

    //if managed, then the instance should start playing immediately and will be collected
    //when the playback finished
    QDeclarativeSoundInstance* newDeclarativeSoundInstance(bool managed);

    //internal sound instance is different from declarativeSoundInstance
    //declarative instance is more like a soundInstance helper which can
    //switch to different sound instance conveniently while sound instance
    //must be mapped to one sound definition.
    QSoundInstance* newSoundInstance(const QString &name);
    void releaseSoundInstance(QSoundInstance* instance);

    Q_REVISION(1) Q_INVOKABLE void addAudioSample(QDeclarativeAudioSample *);
    Q_REVISION(1) Q_INVOKABLE void addSound(QDeclarativeSound *);
    Q_REVISION(1) Q_INVOKABLE void addAudioCategory(QDeclarativeAudioCategory *);
    Q_REVISION(1) Q_INVOKABLE void addAttenuationModel(QDeclarativeAttenuationModel *);

Q_SIGNALS:
    void ready();
    void liveInstanceCountChanged();
    void isLoadingChanged();
    void finishedLoading();

private Q_SLOTS:
    void updateSoundInstances();
    void handleLoadingChanged();

private:
    Q_DISABLE_COPY(QDeclarativeAudioEngine);
    bool m_complete;

    //see bank()
    static void appendFunction(QQmlListProperty<QObject> *property, QObject *value);

    QDeclarativeAudioListener *m_listener;
    QDeclarativeAudioCategory* m_defaultCategory;
    QQmlPropertyMap m_categories;
    QQmlPropertyMap m_samples;
    QQmlPropertyMap m_sounds;

    //Use strong type here since no need to for AttenuationModel to be accessible directly by user
    //after config stage
    QDeclarativeAttenuationModel *m_defaultAttenuationModel;
    QMap<QString, QDeclarativeAttenuationModel*> m_attenuationModels;

    QAudioEngine *m_audioEngine;

    //for execution stage management
    QList<QSoundInstance*> m_soundInstancePool;
    QList<QSoundInstance*> m_activeSoundInstances;

    QTimer m_updateTimer;
    QList<QDeclarativeSoundInstance*> m_managedDeclSoundInstances;
    QList<QDeclarativeSoundInstance*> m_managedDeclSndInstancePool;
    void releaseManagedDeclarativeSoundInstance(QDeclarativeSoundInstance* declSndInstance);

    void initAudioSample(QDeclarativeAudioSample *);
    void initSound(QDeclarativeSound *);
};

QT_END_NAMESPACE

#endif