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 KYRA_SOUND_H
#define KYRA_SOUND_H

#include "kyra/kyra_v1.h"

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

#include "audio/mixer.h"

namespace Audio {
class AudioStream;
class SeekableAudioStream;
} // End of namespace Audio

namespace Kyra {

// Helper structs to format the data passed to the various initAudioResourceInfo() implementations
struct SoundResourceInfo_PC {
    SoundResourceInfo_PC(const char *const *files, int numFiles) : fileList(files), fileListSize(numFiles) {}
    const char *const *fileList;
    uint fileListSize;
};

struct SoundResourceInfo_Towns {
    SoundResourceInfo_Towns(const char *const *files, int numFiles, const int32 *cdaTbl, int cdaTblSize) : fileList(files), fileListSize(numFiles), cdaTable(cdaTbl), cdaTableSize(cdaTblSize) {}
    const char *const *fileList;
    uint fileListSize;
    const int32 *cdaTable;
    uint cdaTableSize;
};

struct SoundResourceInfo_PC98 {
    SoundResourceInfo_PC98(const char *fileNamePattern) : pattern(fileNamePattern) {}
    const char *pattern;
};

struct SoundResourceInfo_TownsPC98V2 {
    SoundResourceInfo_TownsPC98V2(const char *const *files, int numFiles, const char *fileNamePattern, const uint16 *cdaTbl, int cdaTblSize) : fileList(files), fileListSize(numFiles), pattern(fileNamePattern), cdaTable(cdaTbl), cdaTableSize(cdaTblSize) {}
    const char *const *fileList;
    uint fileListSize;
    const char *pattern;
    const uint16 *cdaTable;
    uint cdaTableSize;
};

struct SoundResourceInfo_TownsEoB {
    SoundResourceInfo_TownsEoB(const char *const *filelist, uint numfiles, const uint8 *pcmdata, uint pcmdataSize, int pcmvolume) : fileList(filelist), numFiles(numfiles), pcmData(pcmdata), pcmDataSize(pcmdataSize), pcmVolume(pcmvolume) {}
    const uint8 *pcmData;
    uint pcmDataSize;
    int pcmVolume;
    const char *const *fileList;
    uint numFiles;
};


struct SoundResourceInfo_AmigaEoB {
    SoundResourceInfo_AmigaEoB(const char *const *files, int numFiles, const char *const *soundmap, int numSounds) : fileList(files), fileListSize(numFiles), soundList(soundmap), soundListSize(numSounds) {}
    const char *const *fileList;
    uint fileListSize;
    const char *const *soundList;
    uint soundListSize;
};

class Sound {
public:
    Sound(KyraEngine_v1 *vm, Audio::Mixer *mixer);
    virtual ~Sound();

    enum kType {
        kAdLib,
        kMidiMT32,
        kMidiGM,
        kTowns,
        kPC98,
        kPCSpkr,
        kPCjr,
        kAmiga,
        kSegaCD,
        kMac
    };

    virtual kType getMusicType() const = 0;
    virtual kType getSfxType() const;

    // This is obviously not a real implementation. The original allows disabling digital sfx (or simply not having a suitable sound card),
    // thus falling back to the music driver's sfx. We never supported this, since we don't even have a setting for it in the launcher.
    // Currently, the only purpose of this function is fixing KyraEngine_HoF::o2_playFireflyScore() (bug #10877: "Sound issues in the Legend of Kyrandia 2").
    virtual bool useDigitalSfx() const { return true; }

    virtual bool init() = 0;

    virtual void process() {}

    virtual void updateVolumeSettings() {}

    virtual void initAudioResourceInfo(int set, void *info) = 0;

    virtual void selectAudioResourceSet(int set) = 0;

    virtual bool hasSoundFile(uint file) const = 0;

    virtual void loadSoundFile(uint file) = 0;

    virtual void loadSoundFile(const Common::Path &file) = 0;

    virtual void unloadSoundFile(const Common::String &file) {}

    virtual void loadSfxFile(const Common::Path &file) {}

    virtual void playTrack(uint8 track) = 0;

    virtual void haltTrack() = 0;

    virtual void playSoundEffect(uint16 track, uint8 volume = 0xFF) = 0;

    virtual void stopAllSoundEffects() {}

    virtual bool isPlaying() const;

    virtual void beginFadeOut() = 0;
    virtual void beginFadeOut(int) { beginFadeOut(); }

    virtual void pause(bool paused) {}

    virtual void enableMusic(int enable) { _musicEnabled = enable; }
    int musicEnabled() const { return _musicEnabled; }
    void enableSFX(bool enable) { _sfxEnabled = enable; }
    bool sfxEnabled() const { return _sfxEnabled; }

    bool isVoicePresent(const char *file) const;

    virtual int32 voicePlay(const char *file, Audio::SoundHandle *handle = 0, uint8 volume = 255, uint8 priority = 255, bool isSfx = false);

    Audio::SeekableAudioStream *getVoiceStream(const char *file) const;

    bool playVoiceStream(Audio::AudioStream *stream, Audio::SoundHandle *handle = 0, uint8 volume = 255, uint8 priority = 255, bool isSfx = false);

    bool voiceIsPlaying(const Audio::SoundHandle *handle = 0) const;

    bool allVoiceChannelsPlaying() const;

    uint32 voicePlayedTime(const Audio::SoundHandle &handle) const {
        return _mixer->getSoundElapsedTime(handle);
    }

    void voiceStop(const Audio::SoundHandle *handle = 0);

    virtual int checkTrigger() { return 0; }

    virtual void resetTrigger() {}
protected:
    enum {
        kNumChannelHandles = 4
    };

    struct SoundChannel {
        SoundChannel() : handle(), priority(0) {}
        Audio::SoundHandle handle;
        int priority;
    };

    SoundChannel _soundChannels[kNumChannelHandles];

    int _musicEnabled;
    bool _sfxEnabled;

    KyraEngine_v1 *_vm;
    Audio::Mixer *_mixer;

private:
    struct SpeechCodecs {
        const char *fileext;
        Audio::SeekableAudioStream *(*streamFunc)(
            Common::SeekableReadStream *stream,
            DisposeAfterUse::Flag disposeAfterUse);
    };

    static const SpeechCodecs _supportedCodecs[];
};

class MixedSoundDriver : public Sound {
public:
    MixedSoundDriver(KyraEngine_v1 *vm, Audio::Mixer *mixer, Sound *music, Sound *sfx);
    ~MixedSoundDriver() override;

    kType getMusicType() const override;
    kType getSfxType() const override;

    bool init() override;
    void process() override;

    void updateVolumeSettings() override;

    void initAudioResourceInfo(int set, void *info) override;
    void selectAudioResourceSet(int set) override;
    bool hasSoundFile(uint file) const override;
    void loadSoundFile(uint file) override;
    void loadSoundFile(const Common::Path &file) override;

    void loadSfxFile(const Common::Path &file) override;

    void playTrack(uint8 track) override;
    void haltTrack() override;
    bool isPlaying() const override;

    void playSoundEffect(uint16 track, uint8 volume = 0xFF) override;

    void stopAllSoundEffects() override;

    void beginFadeOut() override;
    void pause(bool paused) override;
private:
    Sound *_music, *_sfx;
};

} // End of namespace Kyra

#endif