OpenTTD Source  20241108-master-g80f628063a
allegro_m.h
Go to the documentation of this file.
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 
10 #ifndef MUSIC_ALLEGRO_H
11 #define MUSIC_ALLEGRO_H
12 
13 #include "music_driver.hpp"
14 
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 
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 */
Base for all driver factories.
Definition: driver.h:57
DriverFactoryBase(Driver::Type type, int priority, const char *name, const char *description)
Construct a new DriverFactory.
Definition: driver.cpp:244
A driver for communicating with the user.
Definition: driver.h:21
@ DT_MUSIC
A music driver, needs to be before sound to properly shut down extmidi forked music players.
Definition: driver.h:40
Factory for allegro's music player.
Definition: allegro_m.h:33
Driver * CreateInstance() const override
Create an instance of this driver-class.
Definition: allegro_m.h:44
Allegro's music player.
Definition: allegro_m.h:16
void SetVolume(uint8_t vol) override
Set the volume, if possible.
void StopSong() override
Stop playing the current song.
std::optional< std::string_view > Start(const StringList &param) override
Start this driver.
std::string_view GetName() const override
Get the name of this driver.
Definition: allegro_m.h:29
void PlaySong(const MusicSongInfo &song) override
Play a particular song.
bool IsSongPlaying() override
Are we currently playing a song?
void Stop() override
Stop this driver.
Driver for all music playback.
Base for all music playback.
std::vector< std::string > StringList
Type for a list of strings.
Definition: string_type.h:60
Metadata about a music track.