sound_driver_adlib.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 MM_SHARED_XEEN_SOUND_DRIVER_ADLIB_H
#define MM_SHARED_XEEN_SOUND_DRIVER_ADLIB_H

#include "audio/mididrv.h"
#include "mm/shared/xeen/sound_driver.h"

namespace OPL {
    class OPL;
}

namespace MM {
namespace Shared {
namespace Xeen {

class SoundDriverAdlib : public SoundDriver {
    struct RegisterValue {
        uint8 _regNum;
        uint8 _value;

        RegisterValue(int regNum, int value) {
            _regNum = regNum; _value = value;
        }
    };
private:
    static const byte OPERATOR1_INDEXES[CHANNEL_COUNT];
    static const byte OPERATOR2_INDEXES[CHANNEL_COUNT];
    static const uint WAVEFORMS[24];
private:
    OPL::OPL *_opl;
    Common::Queue<RegisterValue> _queue;
    Common::Mutex _driverMutex;
    const byte *_musInstrumentPtrs[16];
    const byte *_fxInstrumentPtrs[16];
    int _field180;
    int _field181;
    int _field182;
    int _musicVolume, _sfxVolume;
private:
    void initialize();

    void write(int reg, int val);

    void onTimer();

    void flush();

    void resetFrequencies();

    void setFrequency(byte operatorNum, uint frequency);

    uint calcFrequency(byte note);

    void setOutputLevel(byte channelNum, uint level);

    void playInstrument(byte channelNum, const byte *data, bool isFx);

    byte calculateLevel(byte level, bool isFx);

protected:
    bool musSetInstrument(const byte *&srcP, byte param) override;
    bool musSetPitchWheel(const byte *&srcP, byte param) override;
    bool musSetPanning(const byte *&srcP, byte param) override;
    bool musFade(const byte *&srcP, byte param) override;
    bool musStartNote(const byte *&srcP, byte param) override;
    bool musSetVolume(const byte *&srcP, byte param) override;
    bool musInjectMidi(const byte *&srcP, byte param) override;
    bool musPlayInstrument(const byte *&srcP, byte param) override;
    bool cmdFreezeFrequency(const byte *&srcP, byte param) override;
    bool cmdChangeFrequency(const byte *&srcP, byte param) override;

    bool fxSetInstrument(const byte *&srcP, byte param) override;
    bool fxSetVolume(const byte *&srcP, byte param) override;
    bool fxMidiReset(const byte *&srcP, byte param) override;
    bool fxMidiDword(const byte *&srcP, byte param) override;
    bool fxSetPanning(const byte *&srcP, byte param) override;
    bool fxChannelOff(const byte *&srcP, byte param) override;
    bool fxFade(const byte *&srcP, byte param) override;
    bool fxStartNote(const byte *&srcP, byte param) override;
    bool fxInjectMidi(const byte *&srcP, byte param) override;
    bool fxPlayInstrument(const byte *&srcP, byte param) override;

    void pausePostProcess() override;

    void resetFX() override;

    void sysExMessage(const byte *&data) override;
public:
    SoundDriverAdlib();

    ~SoundDriverAdlib() override;

    void playFX(uint effectId, const byte *data) override;

    void playSong(const byte *data) override;

    int songCommand(uint commandId, byte musicVolume = 0, byte sfxVolume = 0) override;
};

} // namespace Xeen
} // namespace Shared
} // namespace MM

#endif