sound_manager.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 MADS_CORE_SOUND_MANAGER_H
#define MADS_CORE_SOUND_MANAGER_H

#include "audio/mt32gm.h"
#include "common/array.h"
#include "common/memstream.h"
#include "common/mutex.h"
#include "common/queue.h"
#include "native_sound_timer.h"

namespace Audio {
class Mixer;
}

namespace MADS {

#define CALLBACKS_PER_SECOND 60

class SoundDriver {
protected:
    Audio::Mixer *_mixer;
    Common::Array<byte> _soundData;
    Common::Mutex _driverMutex;
    bool _paused;

    Common::MemoryReadStream getDataStream(int offset) const {
        return Common::MemoryReadStream(&_soundData[offset], _soundData.size() - offset);
    }

    explicit SoundDriver(Audio::Mixer *mixer) : _mixer(mixer), _paused(false) {}

public:
    SoundDriver(Audio::Mixer *mixer, const Common::Path &filename,
        int dataOffset, int dataSize);
    virtual ~SoundDriver() {}

    virtual int command(int commandId, int param) = 0;

    virtual int stop() = 0;

    virtual void pause(bool paused);

    virtual int poll() = 0;

    virtual void noise() = 0;

    // TODO Remove
    virtual void setVolume(int volume) { };

    virtual void stopAllNotes() { }
};

class SoundManager {
protected:
    struct QueuedCommand {
        int _commandId;
        int _param;
    };

    // Number of microseconds between driver updates (60 Hz frequency)
    static const uint32 UPDATE_DELTA;

    enum DriverType { SOUND_ADLIB, SOUND_MT32, SOUND_GM, SOUND_PCSPEAKER, SOUND_PAS };
    Audio::Mixer *_mixer;
    DriverType _driverType;
    MidiDriver_MT32GM *_midiDriver;
    uint32 _driverCallbackDelta;
    uint32 _updateDeltaRemainder;

    bool &_soundFlag;
    SoundDriver *_driver = nullptr;
    bool _newSoundsPaused = false;
    Common::Queue<QueuedCommand> _queuedCommands;

    NativeSoundTimer _hostTimer;

protected:
    virtual void loadDriver(int sectionNum) = 0;

public:
    SoundManager(Audio::Mixer *mixer, bool &soundFlag,
            bool supportsGeneralMidi = false);
    virtual ~SoundManager();

    virtual void validate() = 0;

    void init(int sectionNumber);

    bool isLoaded() const {
        return _driver != nullptr;
    }

    bool isReady();

    bool isDriverActive();

    bool usesPCSpeaker() const {
        return _driverType == SOUND_PCSPEAKER;
    }

    void closeDriver();

    void removeDriver();

    void pauseNewCommands();

    virtual void startQueuedCommands();

    void syncSoundSettings();


    int command(int commandId, int param = 0);

    void stop();

    void pause(bool pause);

    void noise();


    void onTimer();
    static void timerCallback(void *data);
};

} // namespace MADS

#endif