SoundManager.h

/*
 * Copyright (C) 2014 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef SOUNDMANAGER_H
#define SOUNDMANAGER_H

#include <QMediaPlayer>
#include <QObject>
#include <QSoundEffect>
#include <QString>
#include <QUrl>
#include "SoundEffectInstance.h"

class SoundManager : public QObject {
    Q_OBJECT

    Q_PROPERTY(bool bgmMuted READ isBGMMuted WRITE setBGMMuted NOTIFY bgmMutedChanged)
    Q_PROPERTY(bool paused READ isPaused WRITE setPaused NOTIFY pausedChanged)

public:
    Q_ENUMS(BGMPriority)
    enum BGMPriority {
        InvalidPriority = -1,
        MenuPriority,
        EnvironmentalPriority,
        MaxPriority
    };

    explicit SoundManager(QObject* parent = nullptr);

    bool isBGMMuted() const;
    void setBGMMuted(bool value);
    bool isPaused() const { return mPaused; }
    void setPaused(bool value);

    SoundEffectInstance getSoundEffect(const QString& path);
    Q_INVOKABLE void playSoundEffect(const QString& path);

    Q_INVOKABLE void clearBGMTrack(BGMPriority priority);
    Q_INVOKABLE void setBGMTrack(BGMPriority priority, const QString& path);

signals:
    void bgmMutedChanged();
    void pausedChanged();

private slots:
    void onBGMMediaStatusChanged(QMediaPlayer::MediaStatus status);

private:
    void updateCurrentBGMTrack();
    void pauseAll();
    void resumeAll();
    void applyVolume();
    QSharedPointer<QSoundEffect> cacheSoundEffect(const QString& path, bool lookupOnly);

    QMediaPlayer mBGMPlayer;
    QMap<BGMPriority, QUrl> mBGMTracks;
    QUrl mCurrentBGMTrack;
    QMap<QString, QSharedPointer<QSoundEffect>> mSoundEffectMap;

    bool mBGMMuted = false;
    bool mPaused = true;

    constexpr static const float BASE_MUSIC_GAIN = 0.30f;
    constexpr static const int QMEDIA_PLAYER_GAIN_FACTOR = 100;
};
Q_DECLARE_METATYPE(SoundManager*)

#endif // SOUNDMANAGER_H