player_nes.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 SCUMM_PLAYERS_PLAYER_NES_H
#define SCUMM_PLAYERS_PLAYER_NES_H

#include "common/scummsys.h"
#include "common/array.h"
#include "scumm/music.h"
#include "audio/audiostream.h"
#include "audio/mixer.h"

namespace Scumm {

class ScummEngine;
namespace APUe {
class APU;
}

static const int MAXVOLUME = 0x7F;
static const int NUMSLOTS = 3;
static const int NUMCHANS = 4;

class Player_NES : public Audio::AudioStream, public MusicEngine {
public:
    Player_NES(ScummEngine *scumm, Audio::Mixer *mixer);
    ~Player_NES() override;

    void setMusicVolume(int vol) override;
    void startSound(int sound) override;
    void stopSound(int sound) override;
    void stopAllSounds() override;
    int  getSoundStatus(int sound) const override;

    void startTitleTwinkleGroup(const byte twinkleSteps4x6[4][6]);

    // AudioStream API
    int readBuffer(int16 *buffer, const int numSamples) override;
    bool isStereo() const override { return false; }
    bool endOfData() const override { return false; }
    int getRate() const override { return _sampleRate; }

private:

    void sound_play();
    void playSFX(int nr);
    void playMusic();
    void chainCommand(int chan);
    void checkSilenceChannels(int chan);

    void APU_writeChannel(int chan, int offset, byte value);
    void APU_writeControl(byte value);
    byte APU_readStatus();

    ScummEngine *_vm;
    Audio::Mixer *_mixer;
    Audio::SoundHandle _soundHandle;
    APUe::APU *_apu;
    int _sampleRate;
    int _samples_per_frame;
    int _current_sample;
    int _maxvol;

    struct slot {
        int framesleft;
        int id;
        int type;
        byte *data;
        int offset;
    } _slot[NUMSLOTS];

    Common::Array<byte> _titleSfxBuf;
    bool _title2SfxActive;

    struct mchan {
        int command;
        int framedelay;
        int pitch;
        int volume;
        int voldelta;
        int envflags;
        int cmdlock;
    } _mchan[NUMCHANS];

    bool isSFXplaying, wasSFXplaying;

    int numNotes;
    byte *auxData1;
    byte *auxData2;
};

} // End of namespace Scumm

#endif