musicplugin.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_MUSICPLUGIN_H
#define AUDIO_MUSICPLUGIN_H

#include "base/plugins.h"
#include "audio/mididrv.h"
#include "common/list.h"

namespace Common {
class Error;
}

class MusicPluginObject;

class MusicDevice {
public:
    MusicDevice(MusicPluginObject const *musicPlugin, Common::String name, MusicType mt);

    const Common::String &getName() const { return _name; }
    const Common::String &getMusicDriverName() const { return _musicDriverName; }
    const Common::String &getMusicDriverId() const { return _musicDriverId; }
    MusicType getMusicType() const { return _type; }

    Common::String getCompleteName();

    Common::String getCompleteId();

    MidiDriver::DeviceHandle getHandle();

private:
    Common::String _name;
    Common::String _musicDriverName;
    Common::String _musicDriverId;
    MusicType _type;
};

typedef Common::List<MusicDevice> MusicDevices;

class MusicPluginObject : public PluginObject {
public:
    virtual ~MusicPluginObject() {}

    virtual const char *getId() const = 0;

    virtual MusicDevices getDevices() const = 0;

    virtual bool checkDevice(MidiDriver::DeviceHandle hdl, int checkFlags, bool quiet) const { return (checkFlags & MDCK_AUTO) == 0; }

    virtual Common::Error createInstance(MidiDriver **mididriver, MidiDriver::DeviceHandle = 0) const = 0;
};

class MusicManager : public Common::Singleton<MusicManager> {
private:
    friend class Common::Singleton<SingletonBaseType>;

public:
    const PluginList &getPlugins() const;
};

#define MusicMan MusicManager::instance()

#endif