cpp/openttd-patchpack/source Files · src/music/music_driver.hpp

Files @ r9111:983de9c5a848

Branch filter:

Location: cpp/openttd-patchpack/source/src/music/music_driver.hpp

r9111:983de9c5a848 828 B text/x-c++hdr Show Annotation Show as Raw Download as Raw

rubidium

(svn r12971) -Documentation: add @file in files that missed them and add something more than whitespace as description of files that don't have a description.

/* $Id$ */

/** @file music_driver.hpp Base for all music playback. */

#ifndef MUSIC_MUSIC_DRIVER_HPP
#define MUSIC_MUSIC_DRIVER_HPP

#include "../driver.h"

class MusicDriver: public Driver {
public:
	virtual void PlaySong(const char *filename) = 0;

	virtual void StopSong() = 0;

	virtual bool IsSongPlaying() = 0;

	virtual void SetVolume(byte vol) = 0;
};

class MusicDriverFactoryBase: public DriverFactoryBase {
};

template <class T>
class MusicDriverFactory: public MusicDriverFactoryBase {
public:
	MusicDriverFactory() { this->RegisterDriver(((T *)this)->GetName(), Driver::DT_MUSIC, ((T *)this)->priority); }

	/**
	 * Get the long, human readable, name for the Driver-class.
	 */
	const char *GetName();
};

extern MusicDriver *_music_driver;
extern char _ini_musicdriver[32];

#endif /* MUSIC_MUSIC_DRIVER_HPP */