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

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

namespace Audio {
class Mixer;
}

namespace OPL {
class OPL;
}

namespace MADS {

class ASound;

class SoundManager {
protected:
    Audio::Mixer *_mixer;
    bool &_soundFlag;
    OPL::OPL *_opl = nullptr;
    ASound *_driver = nullptr;
    bool _pollSoundEnabled = false;
    bool _soundPollFlag = false;
    bool _newSoundsPaused = false;
    Common::Queue<int> _queuedCommands;
    int _masterVolume = 255;

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

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

    virtual void validate() = 0;

    bool _preferRoland;

    void init(int sectionNumber);

    void closeDriver();

    void removeDriver();

    void setEnabled(bool flag);

    void pauseNewCommands();

    void startQueuedCommands();

    void setVolume(int volume);


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

    void stop();

    void noise();

};


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;

    // Phantom-specific fields
    int _field26;        // pitch delta (set in case -14, zeroed in case -3)
    int _field28;        // zeroed in case -3
    int _field2A;        // set in case -18
    int _field2B;        // volume-cap flag (suppresses upward volume changes)
    int _field2C;        // frequency counter (used with _field7 in cases -9/-10)
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 processSample();

    void updateFNumber();

    void onTimer();

protected:
    int _chanCommandCount;
    int _commandParam;

    virtual void channelCommand(byte *&pSrc, bool &updateFlag) = 0;

    void loadSample(int sampleIndex);

    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();

    byte *getDataPtr(int nearPtr);

    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);
};

} // namespace MADS

#endif