OpenTTD Source  20240919-master-gdf0233f4c2
bemidi.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_BEMIDI_H
11 #define MUSIC_BEMIDI_H
12 
13 #include "music_driver.hpp"
14 
15 /* For BMidiSynthFile */
16 #include <MidiSynthFile.h>
17 
20 public:
21  std::optional<std::string_view> Start(const StringList &param) override;
22 
23  void Stop() override;
24 
25  void PlaySong(const MusicSongInfo &song) override;
26 
27  void StopSong() override;
28 
29  bool IsSongPlaying() override;
30 
31  void SetVolume(uint8_t vol) override;
32  std::string_view GetName() const override { return "bemidi"; }
33 
34 private:
35  BMidiSynthFile *midi_synth_file = nullptr;
36  double current_volume = 1.0;
37  bool just_started = false;
38 };
39 
42 public:
43  FMusicDriver_BeMidi() : DriverFactoryBase(Driver::DT_MUSIC, 10, "bemidi", "BeOS MIDI Driver") {}
44  Driver *CreateInstance() const override { return new MusicDriver_BeMidi(); }
45 };
46 
47 #endif /* MUSIC_BEMIDI_H */
MusicDriver_BeMidi::GetName
std::string_view GetName() const override
Get the name of this driver.
Definition: bemidi.h:32
DriverFactoryBase::DriverFactoryBase
DriverFactoryBase(Driver::Type type, int priority, const char *name, const char *description)
Construct a new DriverFactory.
Definition: driver.cpp:244
MusicDriver_BeMidi::Start
std::optional< std::string_view > Start(const StringList &param) override
Start this driver.
Definition: bemidi.cpp:21
MusicDriver_BeMidi::StopSong
void StopSong() override
Stop playing the current song.
Definition: bemidi.cpp:50
FMusicDriver_BeMidi::CreateInstance
Driver * CreateInstance() const override
Create an instance of this driver-class.
Definition: bemidi.h:44
MusicDriver_BeMidi::PlaySong
void PlaySong(const MusicSongInfo &song) override
Play a particular song.
Definition: bemidi.cpp:31
MusicSongInfo
Metadata about a music track.
Definition: base_media_base.h:325
StringList
std::vector< std::string > StringList
Type for a list of strings.
Definition: string_type.h:60
music_driver.hpp
MusicDriver_BeMidi::SetVolume
void SetVolume(uint8_t vol) override
Set the volume, if possible.
Definition: bemidi.cpp:72
MusicDriver_BeMidi::IsSongPlaying
bool IsSongPlaying() override
Are we currently playing a song?
Definition: bemidi.cpp:58
MusicDriver_BeMidi::Stop
void Stop() override
Stop this driver.
Definition: bemidi.cpp:26
FMusicDriver_BeMidi
Factory for the BeOS midi player.
Definition: bemidi.h:41
MusicDriver
Driver for all music playback.
Definition: music_driver.hpp:18
Driver
A driver for communicating with the user.
Definition: driver.h:21
Driver::DT_MUSIC
@ DT_MUSIC
A music driver, needs to be before sound to properly shut down extmidi forked music players.
Definition: driver.h:40
MusicDriver_BeMidi
The midi player for BeOS.
Definition: bemidi.h:19
DriverFactoryBase
Base for all driver factories.
Definition: driver.h:57