sound_nebular.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_SOUND_NEBULAR_H
#define MADS_SOUND_NEBULAR_H

#include "common/scummsys.h"
#include "common/file.h"
#include "common/mutex.h"
#include "common/queue.h"

namespace Audio {
class Mixer;
}

namespace Common {
class SeekableReadStream;
}

namespace OPL {
class OPL;
}

namespace MADS {

namespace Nebular {

class ASound;

class AdlibChannel {
public:
    ASound *_owner;

    int _activeCount;
    int _field1;
    int _field2;
    int _field3;
    int _field4;
    int _sampleIndex;
    int _volume;
    int _field7;
    int _field8;
    int _field9;
    int _fieldA;
    uint8 _fieldB;
    int _fieldC;
    int _fieldD;
    int _fieldE;
    byte *_ptr1;
    byte *_pSrc;
    byte *_ptr3;
    byte *_ptr4;
    byte *_ptrEnd;
    int _field17;
    int _field19;
    byte *_soundData;
    int _field1D;
    int _volumeOffset;
    int _field1F;

    // TODO: Only used by asound.003. Figure out usage
    byte _field20;
public:
    static bool _channelsEnabled;
public:
    AdlibChannel();

    void reset();
    void enable(int flag);
    void setPtr2(byte *pData);
    void load(byte *pData);
    void check(byte *nullPtr);
};

class AdlibChannelData {
public:
    int _field0;
    int _freqMask;
    int _freqBase;
    int _field6;
};

class AdlibSample {
public:
    int _attackRate;
    int _decayRate;
    int _sustainLevel;
    int _releaseRate;
    bool _egTyp;
    bool _ksr;
    int _totalLevel;
    int _scalingLevel;
    int _waveformSelect;
    int _freqMultiple;
    int _feedback;
    bool _ampMod;
    int _vib;
    int _alg;
    int _fieldE;
    int _freqMask;
    int _freqBase;
    int _field14;

    AdlibSample() {}
    AdlibSample(Common::SeekableReadStream &s);
};

struct RegisterValue {
    uint8 _regNum;
    uint8 _value;

    RegisterValue(int regNum, int value) {
        _regNum = regNum; _value = value;
    }
};

#define ADLIB_CHANNEL_COUNT 9
#define ADLIB_CHANNEL_MIDWAY 5
#define CALLBACKS_PER_SECOND 60

struct CachedDataEntry {
    int _offset;
    byte *_data;
    byte *_dataEnd;
};

class ASound {
private:
    Common::List<CachedDataEntry> _dataCache;
    uint16 _randomSeed;
    int _masterVolume;

    void adlibInit();

    void update();

    void pollChannels();

    void checkChannels();

    void pollActiveChannel();

    void updateOctave();

    void updateChannelState();
    void updateActiveChannel();

    void loadSample(int sampleIndex);

    void processSample();

    void updateFNumber();

    void onTimer();
protected:
    int _commandParam;

    void write(int reg, int val);

    int write2(int state, int reg, int val);

    void flush();

    void channelOn(int reg, int volume);

    void channelOff(int reg);

    void resultCheck();

    byte *loadData(int offset, int size);

    void playSound(int offset, int size);

    void playSoundData(byte *pData, int startingChannel = ADLIB_CHANNEL_MIDWAY);

    bool isSoundActive(byte *pData);

    void setFrequency(int channel, int freq);

    int getRandomNumber();

    virtual int command0();
    int command1();
    int command2();
    int command3();
    int command4();
    int command5();
    int command6();
    int command7();
    int command8();

    int nullCommand() { return 0; }
public:
    Audio::Mixer *_mixer;
    OPL::OPL *_opl;
    AdlibChannel _channels[ADLIB_CHANNEL_COUNT];
    AdlibChannel *_activeChannelPtr;
    AdlibChannelData _channelData[11];
    Common::Array<AdlibSample> _samples;
    AdlibSample *_samplePtr;
    Common::File _soundFile;
    Common::Queue<RegisterValue> _queue;
    Common::Mutex _driverMutex;
    int _dataOffset;
    int _frameCounter;
    bool _isDisabled;
    int _v1;
    int _v2;
    int _activeChannelNumber;
    int _freqMask1;
    int _freqMask2;
    int _freqBase1;
    int _freqBase2;
    int _channelNum1, _channelNum2;
    int _v7;
    int _v8;
    int _v9;
    int _v10;
    int _pollResult;
    int _resultFlag;
    byte _nullData[2];
    int _ports[256];
    bool _stateFlag;
    int _activeChannelReg;
    int _v11;
    bool _amDep, _vibDep, _splitPoint;
public:
    ASound(Audio::Mixer *mixer, OPL::OPL *opl, const Common::Path &filename, int dataOffset);

    virtual ~ASound();

    static void validate();

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

    int stop();

    int poll();

    void noise();

    int getFrameCounter() { return _frameCounter; }

    CachedDataEntry &getCachedData(byte *pData);

    void setVolume(int volume);
};

class ASound1 : public ASound {
private:
    typedef int (ASound1::*CommandPtr)();
    static const CommandPtr _commandList[42];
    bool _cmd23Toggle;

    int command9();
    int command10();
    int command11();
    int command12();
    int command13();
    int command14();
    int command15();
    int command16();
    int command17();
    int command18();
    int command19();
    int command20();
    int command21();
    int command22();
    int command23();
    int command24();
    int command25();
    int command26();
    int command27();
    int command28();
    int command29();
    int command30();
    int command31();
    int command32();
    int command33();
    int command34();
    int command35();
    int command36();
    int command37();
    int command38();
    int command39();
    int command40();
    int command41();

    void command111213();
    int command2627293032();
public:
    ASound1(Audio::Mixer *mixer, OPL::OPL *opl);

    int command(int commandId, int param) override;
};

class ASound2 : public ASound {
private:
    byte _command12Param;
private:
    typedef int (ASound2::*CommandPtr)();
    static const CommandPtr _commandList[44];

    int command0() override;
    int command9();
    int command10();
    int command11();
    int command12();
    int command13();
    int command14();
    int command15();
    int command16();
    int command17();
    int command18();
    int command19();
    int command20();
    int command21();
    int command22();
    int command23();
    int command24();
    int command25();
    int command26();
    int command27();
    int command28();
    int command29();
    int command30();
    int command31();
    int command32();
    int command33();
    int command34();
    int command35();
    int command36();
    int command37();
    int command38();
    int command39();
    int command40();
    int command41();
    int command42();
    int command43();

    void command9Randomize();
    void command9Apply(byte *data, int val, int incr);
public:
    ASound2(Audio::Mixer *mixer, OPL::OPL *opl);

    int command(int commandId, int param) override;
};

class ASound3 : public ASound {
private:
    bool _command39Flag;

    typedef int (ASound3::*CommandPtr)();
    static const CommandPtr _commandList[61];

    int command9();
    int command10();
    int command11();
    int command13();
    int command14();
    int command15();
    int command16();
    int command17();
    int command18();
    int command19();
    int command20();
    int command21();
    int command22();
    int command23();
    int command24();
    int command25();
    int command26();
    int command27();
    int command28();
    int command29();
    int command30();
    int command31();
    int command32();
    int command33();
    int command34();
    int command35();
    int command36();
    int command37();
    int command38();
    int command39();
    int command40();
    int command41();
    int command42();
    int command43();
    int command44();
    int command45();
    int command46();
    int command47();
    int command49();
    int command50();
    int command51();
    int command57();
    int command59();
    int command60();

    void command9Randomize();
    void command9Apply(byte *data, int val, int incr);
public:
    ASound3(Audio::Mixer *mixer, OPL::OPL *opl);

    int command(int commandId, int param) override;
};

class ASound4 : public ASound {
private:
    typedef int (ASound4::*CommandPtr)();
    static const CommandPtr _commandList[61];

    int command10();
    int command12();
    int command19();
    int command20();
    int command21();
    int command24();
    int command27();
    int command30();
    int command32();
    int command33();
    int command34();
    int command35();
    int command36();
    int command37();
    int command38();
    int command43();
    int command52();
    int command53();
    int command54();
    int command55();
    int command56();
    int command57();
    int command58();
    int command59();
    int command60();

    void method1();
public:
    ASound4(Audio::Mixer *mixer, OPL::OPL *opl);

    int command(int commandId, int param) override;
};

class ASound5 : public ASound {
private:
    typedef int (ASound5::*CommandPtr)();
    static const CommandPtr _commandList[42];

    int command9();
    int command10();
    int command11();
    int command12();
    int command13();
    int command14();
    int command15();
    int command16();
    int command17();
    int command18();
    int command19();
    int command20();
    int command21();
    int command22();
    int command23();
    int command24();
    int command25();
    int command26();
    int command27();
    int command28();
    int command29();
    int command30();
    int command31();
    int command32();
    int command33();
    int command34();
    int command35();
    int command36();
    int command37();
    int command38();
    int command39();
    int command40();
    int command41();
    int command42();
    int command43();
public:
    ASound5(Audio::Mixer *mixer, OPL::OPL *opl);

    int command(int commandId, int param) override;
};

class ASound6 : public ASound {
private:
    typedef int (ASound6::*CommandPtr)();
    static const CommandPtr _commandList[30];

    int command9();
    int command10();
    int command11();
    int command12();
    int command13();
    int command14();
    int command15();
    int command16();
    int command17();
    int command18();
    int command19();
    int command20();
    int command21();
    int command22();
    int command23();
    int command24();
    int command25();
    int command29();
public:
    ASound6(Audio::Mixer *mixer, OPL::OPL *opl);

    int command(int commandId, int param) override;
};

class ASound7 : public ASound {
private:
    typedef int (ASound7::*CommandPtr)();
    static const CommandPtr _commandList[38];

    int command9();
    int command15();
    int command16();
    int command18();
    int command19();
    int command20();
    int command21();
    int command22();
    int command23();
    int command24();
    int command25();
    int command26();
    int command27();
    int command28();
    int command30();
    int command32();
    int command33();
    int command34();
    int command35();
    int command36();
    int command37();
public:
    ASound7(Audio::Mixer *mixer, OPL::OPL *opl);

    int command(int commandId, int param) override;
};

class ASound8 : public ASound {
private:
    typedef int (ASound8::*CommandPtr)();
    static const CommandPtr _commandList[38];

    int command9();
    int command10();
    int command11();
    int command12();
    int command13();
    int command14();
    int command15();
    int command16();
    int command17();
    int command18();
    int command19();
    int command20();
    int command21();
    int command22();
    int command23();
    int command24();
    int command25();
    int command26();
    int command27();
    int command28();
    int command29();
    int command30();
    int command31();
    int command32();
    int command33();
    int command34();
    int command35();
    int command36();
    int command37();

    void method1(byte *pData);
    void adjustRange(byte *pData, byte v, int incr);
public:
    ASound8(Audio::Mixer *mixer, OPL::OPL *opl);

    int command(int commandId, int param) override;
};

class ASound9 : public ASound {
private:
    int _v1, _v2;
    byte *_soundPtr;

    typedef int (ASound9::*CommandPtr)();
    static const CommandPtr _commandList[52];

    int command9();
    int command10();
    int command11();
    int command12();
    int command13();
    int command14();
    int command15();
    int command16();
    int command17();
    int command18();
    int command19();
    int command20();
    int command21();
    int command22();
    int command23();
    int command24();
    int command25();
    int command26();
    int command27();
    int command28();
    int command29();
    int command30();
    int command31();
    int command32();
    int command33();
    int command34();
    int command35();
    int command36();
    int command37();
    int command38();
    int command39();
    int command40();
    int command41();
    int command42();
    int command43();
    int command44_46();
    int command45();
    int command47();
    int command48();
    int command49();
    int command50();
    int command51();
    int command57();
    int command59();
    int command60();
public:
    ASound9(Audio::Mixer *mixer, OPL::OPL *opl);

    int command(int commandId, int param) override;
};

} // End of namespace Nebular

} // End of namespace MADS

#endif /* MADS_SOUND_NEBULAR_H */