riven_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 MOHAWK_RIVEN_SOUND_H
#define MOHAWK_RIVEN_SOUND_H

#include "common/array.h"
#include "common/str.h"

#include "audio/mixer.h"

namespace Audio {
class RewindableAudioStream;
}

namespace Mohawk {

class MohawkEngine_Riven;
class RivenSound;

struct SLSTRecord {
    uint16 index;
    Common::Array<uint16> soundIds;
    uint16 fadeFlags;
    uint16 loop;
    uint16 globalVolume;
    uint16 u0;
    uint16 suspend;
    Common::Array<uint16> volumes;
    Common::Array<int16> balances;
    Common::Array<uint16> u2;
};

class RivenSoundManager {
public:
    explicit RivenSoundManager(MohawkEngine_Riven *vm);
    ~RivenSoundManager();

    void playSound(uint16 id, uint16 volume = 255, bool playOnDraw = false);

    void playCardSound(const Common::String &name, uint16 volume = 255, bool playOnDraw = false);

    void triggerDrawSound();

    bool isEffectPlaying() const;

    void stopSound();

    void playSLST(const SLSTRecord &slstRecord);

    void stopAllSLST(bool fade = false);

    void updateSLST();

private:
    struct AmbientSound {
        RivenSound *sound;
        uint16 targetVolume;
        int16 targetBalance;

        AmbientSound();
    };

    struct AmbientSoundList {
        bool fading;
        bool suspend;
        Common::Array<AmbientSound> sounds;

        AmbientSoundList();
    };

    enum FadeFlags {
        kFadeOutPreviousSounds = 1,
        kFadeInNewSounds = 2
    };

    MohawkEngine_Riven *_vm;

    int16 _mainAmbientSoundId;
    AmbientSoundList _ambientSounds;
    AmbientSoundList _previousAmbientSounds;
    uint32 _nextFadeUpdate;

    RivenSound *_effect;
    bool _effectPlayOnDraw;

    Audio::RewindableAudioStream *makeAudioStream(uint16 id);

    // Ambient sound management
    void addAmbientSounds(const SLSTRecord &record);
    void playAmbientSounds();
    void pauseAmbientSounds();
    void moveAmbientSoundsToPreviousSounds();
    void freePreviousAmbientSounds();

    // Ambient sound fading
    void setTargetVolumes(const SLSTRecord &record);
    void applyTargetVolumes();
    void startFadingAmbientSounds(uint16 flags);
    void fadeAmbientSoundList(AmbientSoundList &list);
    bool fadeVolume(AmbientSound &ambientSound);
    bool fadeBalance(AmbientSound &ambientSound);
    void setAmbientLooping(bool loop);
};

class RivenSound {
public:
    RivenSound(MohawkEngine_Riven *vm, Audio::RewindableAudioStream *rewindStream, Audio::Mixer::SoundType mixerType);
    ~RivenSound();

    void play();

    bool isPlaying() const;

    void pause();

    uint16 getVolume() const;

    void setVolume(uint16 volume);

    int16 getBalance() const;

    void setBalance(int16 balance);

    void setLooping(bool loop);

private:
    static byte convertVolume(uint16 volume);
    static int8 convertBalance(int16 balance);

    MohawkEngine_Riven *_vm;

    Audio::SoundHandle _handle;
    Audio::Mixer::SoundType _mixerType;
    Audio::RewindableAudioStream *_stream;

    uint16 _volume;
    int16 _balance;
    bool _looping;
};

} // End of namespace Mohawk

#endif