src/music/allegro_m.h

   1 /* $Id: allegro_m.h 26108 2013-11-25 14:30:22Z rubidium $ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * OpenTTD 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, version 2.
   6  * OpenTTD 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.
   7  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
   8  */
   9
  10 /** @file allegro_m.h Base support for playing music via allegro. */
  11
  12 #ifndef MUSIC_ALLEGRO_H
  13 #define MUSIC_ALLEGRO_H
  14
  15 #include "music_driver.hpp"
  16
  17 /** Allegro's music player. */
  18 class MusicDriver_Allegro : public MusicDriver {
  19 public:
  20         /* virtual */ const char *Start(const char * const *param);
  21
  22         /* virtual */ void Stop();
  23
  24         /* virtual */ void PlaySong(const char *filename);
  25
  26         /* virtual */ void StopSong();
  27
  28         /* virtual */ bool IsSongPlaying();
  29
  30         /* virtual */ void SetVolume(byte vol);
  31         /* virtual */ const char *GetName() const { return "allegro"; }
  32 };
  33
  34 /** Factory for allegro's music player. */
  35 class FMusicDriver_Allegro : public DriverFactoryBase {
  36 public:
  37 #if !defined(WITH_SDL) && defined(WITH_ALLEGRO)
  38         /* If SDL is not compiled in but Allegro is, chances are quite big
  39          * that Allegro is going to be used. Then favour this sound driver
  40          * over extmidi because with extmidi we get crashes. */
  41         static const int PRIORITY = 9;
  42 #else
  43         static const int PRIORITY = 2;
  44 #endif
  45         FMusicDriver_Allegro() : DriverFactoryBase(Driver::DT_MUSIC, PRIORITY, "allegro", "Allegro MIDI Driver") {}
  46         /* virtual */ Driver *CreateInstance() const { return new MusicDriver_Allegro(); }
  47 };
  48
  49 #endif /* MUSIC_ALLEGRO_H */