OpenTTD Source 20241224-master-gee860a5c8e
dmusic.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_DMUSIC_H
11#define MUSIC_DMUSIC_H
12
13#include "music_driver.hpp"
14
17public:
18 virtual ~MusicDriver_DMusic();
19
20 std::optional<std::string_view> Start(const StringList &param) override;
21
22 void Stop() override;
23
24 void PlaySong(const MusicSongInfo &song) override;
25
26 void StopSong() override;
27
28 bool IsSongPlaying() override;
29
30 void SetVolume(uint8_t vol) override;
31 std::string_view GetName() const override { return "dmusic"; }
32};
33
36public:
37 FMusicDriver_DMusic() : DriverFactoryBase(Driver::DT_MUSIC, 10, "dmusic", "DirectMusic MIDI Driver") {}
38 Driver *CreateInstance() const override { return new MusicDriver_DMusic(); }
39};
40
41#endif /* MUSIC_DMUSIC_H */
Base for all driver factories.
Definition driver.h:57
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 the DirectX music player.
Definition dmusic.h:35
Driver * CreateInstance() const override
Create an instance of this driver-class.
Definition dmusic.h:38
Music player making use of DirectX.
Definition dmusic.h:16
void SetVolume(uint8_t vol) override
Set the volume, if possible.
Definition dmusic.cpp:1231
void StopSong() override
Stop playing the current song.
Definition dmusic.cpp:1218
std::optional< std::string_view > Start(const StringList &param) override
Start this driver.
Definition dmusic.cpp:1066
bool IsSongPlaying() override
Are we currently playing a song?
Definition dmusic.cpp:1225
void Stop() override
Stop this driver.
Definition dmusic.cpp:1157
std::string_view GetName() const override
Get the name of this driver.
Definition dmusic.h:31
void PlaySong(const MusicSongInfo &song) override
Play a particular song.
Definition dmusic.cpp:1203
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.