soundengine.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/>.
 *
 */

/*
 * This code is based on Broken Sword 2.5 engine
 *
 * Copyright (c) Malte Thiesen, Daniel Queteschiner and Michael Elsdoerfer
 *
 * Licensed under GNU GPL v2
 *
 */

/*
 * BS_SoundEngine
 * -------------
 * This is the sound engine interface that contains all the methods a sound
 * engine must implement.
 * Implementations of the sound engine have to be derived from this class.
 * It should be noted that a sound engine must maintain a list of all the
 * samples it uses, and that these samples should be released when the
 * destructor is called.
 *
 * Autor: Malte Thiesen
 */

#ifndef SWORD25_SOUNDENGINE_H
#define SWORD25_SOUNDENGINE_H

#include "sword25/kernel/common.h"
#include "sword25/kernel/resservice.h"
#include "sword25/kernel/persistable.h"

#include "audio/mixer.h"

namespace Sword25 {

#define SOUND_HANDLES 32

enum sndHandleType {
    kFreeHandle,
    kAllocatedHandle
};

struct SndHandle {
    Audio::SoundHandle handle;
    sndHandleType type;
    uint32 id;

    Common::String fileName;
    int32 sndType;
    float volume;
    float pan;
    bool loop;
    int32 loopStart;
    int32 loopEnd;
    uint32 layer;

    SndHandle();
};


class SoundEngine : public ResourceService, public Persistable {
public:
    enum SOUND_TYPES {
        MUSIC = 0,
        SPEECH = 1,
        SFX = 2
    };

    typedef void (*DynamicSoundReadCallback)(void *UserData, void *Data, uint DataLength);

    SoundEngine(Kernel *pKernel);
    ~SoundEngine() override {}

    bool init(uint sampleRate, uint channels = 32);

    void update();

    void setVolume(float volume, SOUND_TYPES type);

    float getVolume(SOUND_TYPES type);

    void pauseAll();

    void resumeAll();

    void pauseLayer(uint layer);

    void resumeLayer(uint layer);

    bool playSound(const Common::String &fileName, SOUND_TYPES type, float volume = 1.0f, float pan = 0.0f, bool loop = false, int loopStart = -1, int loopEnd = -1, uint layer = 0);

    uint playSoundEx(const Common::String &fileName, SOUND_TYPES type, float volume = 1.0f, float pan = 0.0f, bool loop = false, int loopStart = -1, int loopEnd = -1, uint layer = 0, uint handleId = 0x1337);

    void setSoundVolume(uint handle, float volume);

    void setSoundPanning(uint handle, float pan);

    void pauseSound(uint handle);

    void resumeSound(uint handle);

    void stopSound(uint handle);

    bool isSoundPaused(uint handle);

    bool isSoundPlaying(uint handle);

    float getSoundVolume(uint handle);

    float getSoundPanning(uint handle);

    Resource    *loadResource(const Common::String &fileName) override;
    bool         canLoadResource(const Common::String &fileName) override;

    bool persist(OutputPersistenceBlock &writer) override;
    bool unpersist(InputPersistenceBlock &reader) override;

private:
    bool registerScriptBindings();
    SndHandle *getHandle(uint *id);
    SndHandle *findHandle(uint id);

private:
    Audio::Mixer *_mixer;
    SndHandle _handles[SOUND_HANDLES];

    uint32 _maxHandleId;

    bool _noMusic;
};

} // End of namespace Sword25

#endif