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 plugins 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 QSOUNDINSTANCE_P_H 41 #define QSOUNDINSTANCE_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 <QVector3D> 55 #include <QObject> 56 #include "qsoundsource_p.h" 57 58 QT_BEGIN_NAMESPACE 59 60 class QDeclarativeSound; 61 class QDeclarativeAudioEngine; 62 63 class QSoundInstance : public QObject 64 { 65 Q_OBJECT 66 public: 67 explicit QSoundInstance(QObject *parent); 68 ~QSoundInstance(); 69 70 void play(); 71 72 enum State 73 { 74 StoppedState = QSoundSource::StoppedState, 75 PlayingState = QSoundSource::PlayingState, 76 PausedState = QSoundSource::PausedState 77 }; 78 State state() const; 79 80 void setPosition(const QVector3D& position); 81 void setDirection(const QVector3D& direction); 82 void setVelocity(const QVector3D& velocity); 83 84 //this gain and pitch is used for dynamic user control during execution 85 void setGain(qreal gain); 86 void setPitch(qreal pitch); 87 void setCone(qreal innerAngle, qreal outerAngle, qreal outerGain); 88 89 //this varPitch and varGain is calculated from config in PlayVariation 90 void updateVariationParameters(qreal varPitch, qreal varGain, bool looping); 91 92 void bindSoundDescription(QDeclarativeSound *sound); 93 94 void update3DVolume(const QVector3D& listenerPosition); 95 96 bool attenuationEnabled() const; 97 98 Q_SIGNALS: 99 void stateChanged(QSoundInstance::State state); 100 101 public Q_SLOTS: 102 void pause(); 103 void stop(); 104 105 private Q_SLOTS: 106 void resume(); 107 void bufferReady(); 108 void categoryVolumeChanged(); 109 void handleSourceStateChanged(QSoundSource::State); 110 111 private: 112 void setState(State state); 113 void prepareNewVariation(); 114 void detach(); 115 qreal categoryVolume() const; 116 void updatePitch(); 117 void updateGain(); 118 void updateConeOuterGain(); 119 120 void sourcePlay(); 121 void sourcePause(); 122 void sourceStop(); 123 124 QSoundSource *m_soundSource; 125 QSoundBuffer *m_bindBuffer; 126 127 QDeclarativeSound *m_sound; 128 int m_variationIndex; 129 130 bool m_isReady; //true if the sound source is already bound to some sound buffer 131 qreal m_gain; 132 qreal m_attenuationGain; 133 qreal m_varGain; 134 qreal m_pitch; 135 qreal m_varPitch; 136 State m_state; 137 qreal m_coneOuterGain; 138 139 QDeclarativeAudioEngine *m_engine; 140 }; 141 142 QT_END_NAMESPACE 143 144 #endif // QSOUNDINSTANCE_P_H 145