OpenTTD Source: src/music/win32_m.h Source File

OpenTTD Source 15.3

win32_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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
10#ifndef MUSIC_WIN32_H
11#define MUSIC_WIN32_H
12
13#include "music_driver.hpp"
14
16 class MusicDriver_Win32 : public MusicDriver {
17public:
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 "win32"; }
30};
31
33 class FMusicDriver_Win32 : public DriverFactoryBase {
34public:
35 FMusicDriver_Win32() : DriverFactoryBase(Driver::DT_MUSIC, 5, "win32", "Win32 Music Driver") {}
36 std::unique_ptr<Driver> CreateInstance() const override { return std::make_unique<MusicDriver_Win32>(); }
37};
38
39#endif /* MUSIC_WIN32_H */
DriverFactoryBase
Base for all driver factories.
Definition driver.h:57
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
FMusicDriver_Win32
Factory for Windows' music player.
Definition win32_m.h:33
FMusicDriver_Win32::CreateInstance
std::unique_ptr< Driver > CreateInstance() const override
Create an instance of this driver-class.
Definition win32_m.h:36
MusicDriver_Win32
The Windows music player.
Definition win32_m.h:16
MusicDriver_Win32::PlaySong
void PlaySong(const MusicSongInfo &song) override
Play a particular song.
Definition win32_m.cpp:324
MusicDriver_Win32::StopSong
void StopSong() override
Stop playing the current song.
Definition win32_m.cpp:349
MusicDriver_Win32::IsSongPlaying
bool IsSongPlaying() override
Are we currently playing a song?
Definition win32_m.cpp:357
MusicDriver_Win32::GetName
std::string_view GetName() const override
Get the name of this driver.
Definition win32_m.h:29
MusicDriver_Win32::SetVolume
void SetVolume(uint8_t vol) override
Set the volume, if possible.
Definition win32_m.cpp:362
MusicDriver_Win32::Stop
void Stop() override
Stop this driver.
Definition win32_m.cpp:424
MusicDriver_Win32::Start
std::optional< std::string_view > Start(const StringList &param) override
Start this driver.
Definition win32_m.cpp:368
MusicDriver
Driver for all music playback.
Definition music_driver.hpp:18
music_driver.hpp
Base for all music playback.
StringList
std::vector< std::string > StringList
Type for a list of strings.
Definition string_type.h:60
MusicSongInfo
Metadata about a music track.
Definition base_media_music.h:35