ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

musicplugin.h

Go to the documentation of this file.
00001 /* ScummVM - Graphic Adventure Engine
00002  *
00003  * ScummVM is the legal property of its developers, whose names
00004  * are too numerous to list here. Please refer to the COPYRIGHT
00005  * file distributed with this source distribution.
00006  *
00007  * This program is free software; you can redistribute it and/or
00008  * modify it under the terms of the GNU General Public License
00009  * as published by the Free Software Foundation; either version 2
00010  * of the License, or (at your option) any later version.
00011  *
00012  * This program is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  *
00017  * You should have received a copy of the GNU General Public License
00018  * along with this program; if not, write to the Free Software
00019  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
00020  *
00021  */
00022 
00023 #ifndef AUDIO_MUSICPLUGIN_H
00024 #define AUDIO_MUSICPLUGIN_H
00025 
00026 #include "base/plugins.h"
00027 #include "audio/mididrv.h"
00028 #include "common/list.h"
00029 
00030 namespace Common {
00031 class Error;
00032 }
00033 
00034 class MusicPluginObject;
00035 
00041 class MusicDevice {
00042 public:
00043     MusicDevice(MusicPluginObject const *musicPlugin, Common::String name, MusicType mt);
00044 
00045     Common::String &getName() { return _name; }
00046     Common::String &getMusicDriverName() { return _musicDriverName; }
00047     Common::String &getMusicDriverId() { return _musicDriverId; }
00048     MusicType getMusicType() { return _type; }
00049 
00054     Common::String getCompleteName();
00055 
00060     Common::String getCompleteId();
00061 
00062     MidiDriver::DeviceHandle getHandle();
00063 
00064 private:
00065     Common::String _name;
00066     Common::String _musicDriverName;
00067     Common::String _musicDriverId;
00068     MusicType _type;
00069 };
00070 
00072 typedef Common::List<MusicDevice> MusicDevices;
00073 
00078 class MusicPluginObject : public PluginObject {
00079 public:
00080     virtual ~MusicPluginObject() {}
00081 
00086     virtual const char *getId() const = 0;
00087 
00091     virtual MusicDevices getDevices() const = 0;
00092 
00098     virtual bool checkDevice(MidiDriver::DeviceHandle) const { return true; }
00099 
00112     virtual Common::Error createInstance(MidiDriver **mididriver, MidiDriver::DeviceHandle = 0) const = 0;
00113 };
00114 
00118 class MusicManager : public Common::Singleton<MusicManager> {
00119 private:
00120     friend class Common::Singleton<SingletonBaseType>;
00121 
00122 public:
00123     const PluginList &getPlugins() const;
00124 };
00125 
00127 #define MusicMan MusicManager::instance()
00128 
00129 #endif


Generated on Sat May 18 2019 05:01:10 for ResidualVM by doxygen 1.7.1
curved edge   curved edge