sound.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.

 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef ILLUSIONS_SOUND_H
#define ILLUSIONS_SOUND_H

#include "illusions/graphics.h"
#include "audio/audiostream.h"
#include "audio/decoders/wave.h"
#include "audio/midiplayer.h"
#include "audio/mixer.h"
#include "common/array.h"
#include "common/list.h"

namespace Illusions {

class IllusionsEngine;

class MusicPlayer {
public:
    MusicPlayer();
    ~MusicPlayer();
    void play(uint32 musicId, bool looping, int16 volume, int16 pan);
    void stop();
    bool isPlaying();
protected:
    Audio::SoundHandle _soundHandle;
    uint32 _musicId;
    uint _flags;
};

class MidiPlayer : public Audio::MidiPlayer {
public:
    MidiPlayer();
    ~MidiPlayer() override;
    bool play(uint32 musicId);
    void stop() override;
    bool isIdle() const { return _isIdle; }
protected:
    bool _isIdle;
    bool _isPlaying;
    bool _isCurrentlyPlaying;
    bool _isLooped;
    uint32 _loopedMusicId;
    uint32 _queuedMusicId;
    uint32 _loadedMusicId;
    byte *_data;
    uint _dataSize;
    bool _isGM;
    void sysMidiPlay(uint32 musicId);
    void sysMidiStop();
    void send(uint32 b) override;
    void sendToChannel(byte channel, uint32 b) override;
    void endOfTrack() override;
};

class VoicePlayer {
public:
    VoicePlayer();
    ~VoicePlayer();
    bool cue(const char *voiceName);
    void stopCueing();
    void start(int16 volume, int16 pan);
    void stop();
    void pause();
    void unpause();
    bool isPlaying();
    bool isEnabled();
    bool isCued();
protected:
    Audio::SoundHandle _soundHandle;
    Common::String _voiceName;
    uint _voiceStatus;
    bool _wasPlaying;
    bool _isPaused;
};

class Sound {
public:
    Sound(uint32 soundEffectId, uint32 soundGroupId, bool looping);
    ~Sound();
    void load();
    void unload();
    void play(int16 volume, int16 pan);
    void stop();
    bool isPlaying();
    bool isLooping();
public:
    uint32 _soundEffectId;
    uint32 _soundGroupId;
protected:
    Audio::RewindableAudioStream *_stream;
    Audio::SoundHandle _soundHandle;
    bool _looping;
};

struct MidiMusicFader {
    bool _active;
    uint _flags;
    int16 _currVolume;
    int16 _startVolume;
    int16 _finalVolume;
    int16 _startTime;
    int16 _duration;
    uint32 _notifyThreadId;
    MidiMusicFader() : _active(false), _currVolume(255) {}
};

class SoundMan {
public:
    SoundMan(IllusionsEngine *vm);
    ~SoundMan();
    void update();

    void playMusic(uint32 musicId, int16 type, int16 volume, int16 pan, uint32 notifyThreadId);
    void stopMusic();

    void playMidiMusic(uint32 musicId);
    void stopMidiMusic();
    void fadeMidiMusic(int16 finalVolume, int16 duration, uint32 notifyThreadId);
    void clearMidiMusicQueue();

    uint16 getMusicVolume();
    uint16 getSfxVolume();
    uint16 getSpeechVolume();

    void setMusicVolume(uint16 volume);
    void setSfxVolume(uint16 volume);
    void setSpeechVolume(uint16 volume);

    bool cueVoice(const char *voiceName);
    void stopCueingVoice();
    void startVoice(int16 volume, int16 pan);
    void stopVoice();
    void pauseVoice();
    void unpauseVoice();
    bool isVoicePlaying();
    bool isVoiceEnabled();
    bool isVoiceCued();

    void loadSound(uint32 soundEffectId, uint32 soundGroupId, bool looping);
    void playSound(uint32 soundEffectId, int16 volume, int16 pan);
    void stopSound(uint32 soundEffectId);
    void stopLoopingSounds();
    void unloadSounds(uint32 soundGroupId);

protected:
    typedef Common::List<Sound*> SoundList;
    typedef SoundList::iterator SoundListIterator;
    IllusionsEngine *_vm;
    uint32 _musicNotifyThreadId;
    MusicPlayer *_musicPlayer;
    MidiPlayer *_midiPlayer;
    VoicePlayer *_voicePlayer;
    SoundList _sounds;
    Common::Array<uint32> _midiMusicQueue;
    MidiMusicFader _midiMusicFader;
    Sound *getSound(uint32 soundEffectId);
    void updateMidi();
    void updateMidiMusicFader();
    uint16 calcAdjustedVolume(const Common::String &volumeConfigKey, uint16 volume);
};

} // End of namespace Illusions

#endif // ILLUSIONS_SOUND_H