rsound_phantom.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_PHANTOM_SOUND_RSOUND_PHANTOM_H
#define MADS_PHANTOM_SOUND_RSOUND_PHANTOM_H

#include "mads/phantom/sound/rsound.h"

namespace MADS {
namespace Phantom {
namespace Sound {

class RSound1 : public RSound {
private:
    typedef int (RSound1:: *CommandPtr)();

    // Avoids picking the same alternative twice in a row.
    int _lastRandomAmbianceIndex = -1;

    void checkRandomAmbianceTrigger() override;

    int command16();

    // Both commands use the section-1-specific isSoundActive(0x3D98) gate.
    int command4() override;
    int command5() override;

    int command24();
    int command25();
    int command26();
    int command27();

    int command32();
    // Targets of command16's random picker (funcs_122AD in the
    // disassembly). sound1() is not a real disassembly function - see
    // the class comment.
    int command38();
    int sound1();
    int sound2();
    int sound3();
    int sound4();
    int sound5();
    int command33();
    int command34();
    int command35();
    int command36();
    int command37();
    int command39();

    int command64();
    int command65();
    int command66();
    int command67();
    int command68();
    int command69();
    int command70();
    int command71();
    int command72();
    int command73();
    int command74();
    int command75();
    int command76();

public:
    RSound1(Audio::Mixer *mixer);

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

class RSound2 : public RSound {
private:
    typedef int (RSound2:: *CommandPtr)();
    static const CommandPtr _commandList[74];

    // Both commands use the standard ungated reset/enable tails.
    int command4() override;
    int command5() override;

    int command16();
    int command24();
    int command25();
    int command26();
    int command27();
    int command32();
    int command33();
    int command34();
    int command35();
    int command64();
    int command65();
    int command66();
    int command67();
    int command68();
    int command69();
    int command70();
    int command71();
    int command72();

public:
    RSound2(Audio::Mixer *mixer);

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

class RSound3 : public RSound {
private:
    typedef int (RSound3:: *CommandPtr)();
    static const CommandPtr _commandList[77];

    int command4() override;
    int command5() override;

    int command16();

    int command24();
    int command25();
    int command26();
    int command27();

    int command32();
    int command33();
    int command34();
    int command35();
    int command36();

    int command64();
    int command65();
    int command66();
    int command67();
    int command68();
    int command69();
    int command70();
    int command71();
    int command72();
    int command73();
    int command74();
    int command75();

public:
    RSound3(Audio::Mixer *mixer);

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

class RSound4 : public RSound {
private:
    typedef int (RSound4:: *CommandPtr)();
    static const CommandPtr _commandList[72];
    bool callFunction(uint16 targetOffset) override;

    int command4() override;
    int command5() override;

    int command16();

    int command24();
    int command25();
    int command26();
    int command27();

    int command64();
    int command65();
    int command66();
    int command67();
    int command68();
    int command69();
    int command70();

public:
    RSound4(Audio::Mixer *mixer);

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

class RSound5 : public RSound {
private:
    typedef int (RSound5:: *CommandPtr)();
    static const CommandPtr _commandList[80];

    int command1();
    int command3();
    int command4() override;
    int command5() override;

    void enableChannels678();

    int command16();

    int command24();
    int command25();
    int command26();
    int command27();

    int command33();
    int command34();
    int command35();
    int command36();
    int command37();
    int command38();
    int command39();

    int command64();
    int command65();
    int command66();
    int command67();
    int command68();
    int command69();
    int command70();
    int command71();
    int command72();
    int command73();
    int command74();
    int command75();
    int command76();
    int command77();
    int command78();

public:
    RSound5(Audio::Mixer *mixer);

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

class RSound9 : public RSound {
private:
    typedef int (RSound9:: *CommandPtr)();
    static const CommandPtr _commandList[73];

    int command4() override;
    int command5() override;

    // Shared by dispatch indices 16 AND 24 (identical handler).
    int command16Or24();

    int command25();
    int command26();
    int command27();

    int command32();
    int command34();
    int command35();
    int command36();
    int command37();
    int command38();
    int command39();

    int command64();
    // Shared by dispatch indices 65 AND 66 (identical handler).
    int command65Or66();
    int command67();
    int command68();
    int command69();
    int command70();
    int command71();

public:
    RSound9(Audio::Mixer *mixer);

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

class RSoundDemo : public RSound {
protected:
    RSoundDemo(Audio::Mixer *mixer, const Common::Path &filename,
               int dataOffset, int dataSize, int sysExOffset);

    int dispatchCommonCommand(int commandId);
    int command4() override;
    int command5() override;
};

class RSoundDemoPHA final : public RSoundDemo {
private:
    bool callFunction(uint16 targetOffset) override;
    void writeRandomizedPair(uint16 firstLowOffset, uint16 secondLowOffset,
                             uint16 firstHighOffset, uint16 secondHighOffset,
                             byte firstLow, byte secondLow, byte firstHigh, byte secondHigh);

public:
    explicit RSoundDemoPHA(Audio::Mixer *mixer);

    int command(int commandId, int param) override;
    static bool validate(Common::String *reason = nullptr);
};

} // namespace Sound
} // namespace Phantom
} // namespace MADS

#endif