midiplayer.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 AUDIO_MIDIPLAYER_H
#define AUDIO_MIDIPLAYER_H

#include "common/scummsys.h"
#include "common/mutex.h"
#include "audio/mididrv.h"

class MidiParser;

namespace Audio {

class MidiPlayer : public MidiDriver_BASE {
public:
    MidiPlayer();
    ~MidiPlayer();

    // TODO: Implement ways to actually play stuff
    //virtual void play(TODO);

    // TODO: Document these
    virtual void stop();
    virtual void pause();
    virtual void resume();

    bool isPlaying() const { return _isPlaying; }

    int getVolume() const { return _masterVolume; }

    virtual void setVolume(int volume);

    void syncVolume();

    // TODO: Document this
    bool hasNativeMT32() const { return _nativeMT32; }

    // MidiDriver_BASE implementation
    void send(uint32 b) override;
    void metaEvent(byte type, byte *data, uint16 length) override;

protected:
    virtual void sendToChannel(byte ch, uint32 b);

    virtual void endOfTrack();

    // TODO: Document this
    virtual void onTimer();

    static void timerCallback(void *data);

    void createDriver(int flags = MDT_MIDI | MDT_ADLIB | MDT_PREFER_GM);

protected:
    enum {
        kNumChannels = 16
    };

    Common::Mutex _mutex;
    MidiDriver *_driver;

    MidiParser *_parser;

    byte *_midiData;

    MidiChannel *_channelsTable[kNumChannels];
    uint8 _channelsVolume[kNumChannels];

    bool _isLooping;
    bool _isPlaying;

    int _masterVolume;  // FIXME: byte or int ?

    bool _nativeMT32;
};

} // End of namespace Audio

#endif