src/music/allegro_m.h

   1 /*
   2  * This file is part of OpenTTD.
   3  * 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.
   4  * 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.
   5  * 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/>.
   6  */
   7
   8 /** @file allegro_m.h Base support for playing music via allegro. */
   9
  10 #ifndef MUSIC_ALLEGRO_H
  11 #define MUSIC_ALLEGRO_H
  12
  13 #include "music_driver.hpp"
  14
  15 /** Allegro's music player. */
  16 class MusicDriver_Allegro : public MusicDriver {
  17 public:
  18         std::optional<std::string_view> Start(const StringList &param) override;
  19
  20         void Stop() override;
  21
  22         void PlaySong(const MusicSongInfo &song) override;
  23
  24         void StopSong() override;
  25
  26         bool IsSongPlaying() override;
  27
  28         void SetVolume(uint8_t vol) override;
  29         std::string_view GetName() const override { return "allegro"; }
  30 };
  31
  32 /** Factory for allegro's music player. */
  33 class FMusicDriver_Allegro : public DriverFactoryBase {
  34 public:
  35 #if !defined(WITH_SDL) && defined(WITH_ALLEGRO)
  36         /* If SDL is not compiled in but Allegro is, chances are quite big
  37          * that Allegro is going to be used. Then favour this sound driver
  38          * over extmidi because with extmidi we get crashes. */
  39         static const int PRIORITY = 9;
  40 #else
  41         static const int PRIORITY = 2;
  42 #endif
  43         FMusicDriver_Allegro() : DriverFactoryBase(Driver::DT_MUSIC, PRIORITY, "allegro", "Allegro MIDI Driver") {}
  44         Driver *CreateInstance() const override { return new MusicDriver_Allegro(); }
  45 };
  46
  47 #endif /* MUSIC_ALLEGRO_H */