musplayer.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/>.
 *
 *
 * This file is dual-licensed.
 * In addition to the GPLv3 license mentioned above, this code is also
 * licensed under LGPL 2.1. See LICENSES/COPYING.LGPL file for the
 * full text of the license.
 *
 */

#ifndef GOB_SOUND_MUSPLAYER_H
#define GOB_SOUND_MUSPLAYER_H

#include "common/str.h"
#include "common/array.h"

#include "gob/sound/adlib.h"

namespace Common {
    class SeekableReadStream;
}

namespace Gob {

class MUSPlayer : public AdLib {
public:
    MUSPlayer();
    ~MUSPlayer() override;

    bool loadSND(Common::SeekableReadStream &snd);
    bool loadMUS(Common::SeekableReadStream &mus);

    void unload();

    uint32 getSongID() const;
    const Common::String &getSongName() const;

protected:
    // AdLib interface
    uint32 pollMusic(bool first) override;
    void rewind() override;

private:
    struct Timbre {
        Common::String name;

        uint16 params[kOperatorsPerVoice * kParamCount];
    };

    Common::Array<Timbre> _timbres;

    byte  *_songData;
    uint32 _songDataSize;

    const byte *_playPos;

    uint32 _songID;
    Common::String _songName;

    uint8 _ticksPerBeat;
    uint8 _beatsPerMeasure;

    uint8 _soundMode;
    uint8 _pitchBendRange;

    uint16 _baseTempo;

    uint16 _tempo;

    byte _lastCommand;


    void unloadSND();
    void unloadMUS();

    bool readSNDHeader (Common::SeekableReadStream &snd, int &timbreCount, int &timbrePos);
    bool readSNDTimbres(Common::SeekableReadStream &snd, int  timbreCount, int  timbrePos);

    bool readMUSHeader(Common::SeekableReadStream &mus);
    bool readMUSSong  (Common::SeekableReadStream &mus);

    void setInstrument(uint8 voice, uint8 instrument);
    void skipToTiming();

    static bool readString(Common::SeekableReadStream &stream, Common::String &string, byte *buffer, uint size);
};

} // End of namespace Gob

#endif // GOB_SOUND_MUSPLAYER_H