u8_music_process.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 ULTIMA8_AUDIO_U8MUSICPROCESS_H
#define ULTIMA8_AUDIO_U8MUSICPROCESS_H

#include "ultima/ultima8/audio/music_process.h"
#include "ultima/ultima8/misc/classtype.h"
#include "audio/mididrv.h"

namespace Ultima {
namespace Ultima8 {

class Debugger;
class MidiPlayer;

class U8MusicProcess : public MusicProcess {
    friend class Debugger;

    enum PlaybackStates {
        PLAYBACK_NORMAL = 1,
        PLAYBACK_TRANSITION = 2,
        PLAYBACK_PLAY_WANTED = 3
    };

public:
    struct TrackState {
        int _wanted;
        int _lastRequest;
        int _queued;

        TrackState() : _wanted(0), _lastRequest(0), _queued(0) { }
        TrackState(int wanted, int lastRequest, int queued) :
            _wanted(wanted), _lastRequest(lastRequest), _queued(queued) { }
    };

private:
    void playMusic_internal(int track) override;

    MidiPlayer *_midiPlayer;
    PlaybackStates _state;
    int _songBranches[128];

    int _currentTrack;      

    TrackState _trackState;

    TrackState *_savedTrackState;

    bool _combatMusicActive;

public:
    U8MusicProcess();
    U8MusicProcess(MidiPlayer *player); // Note that this does NOT delete the driver
    ~U8MusicProcess() override;

    ENABLE_RUNTIME_CLASSTYPE()

    
    static MusicProcess *get_instance() {
        return _theMusicProcess;
    }

    void playMusic(int track) override;
    void playCombatMusic(int track) override;
    void queueMusic(int track) override;
    void unqueueMusic() override;
    void restoreMusic() override;

    void fadeMusic(uint16 length) override;
    bool isFading() override;

    void saveTrackState() override;
    void restoreTrackState() override;

    void getTrackState(TrackState &trackState) const;

    void setTrackState(const TrackState &state);

    bool isPlaying() override;

    void pauseMusic() override;
    void unpauseMusic() override;

    void run() override;

    bool loadData(Common::ReadStream *rs, uint32 version);
    void saveData(Common::WriteStream *ws) override;
};

} // End of namespace Ultima8
} // End of namespace Ultima

#endif