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

OpenTTD Source 15.0-RC2

cocoa_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_MACOSX_COCOA_H
11#define MUSIC_MACOSX_COCOA_H
12
13#include "music_driver.hpp"
14
15 class MusicDriver_Cocoa : public MusicDriver {
16public:
17 std::optional<std::string_view> Start(const StringList &param) override;
18
19 void Stop() override;
20
21 void PlaySong(const MusicSongInfo &song) override;
22
23 void StopSong() override;
24
25 bool IsSongPlaying() override;
26
27 void SetVolume(uint8_t vol) override;
28 std::string_view GetName() const override { return "cocoa"; }
29};
30
31 class FMusicDriver_Cocoa : public DriverFactoryBase {
32public:
33 FMusicDriver_Cocoa() : DriverFactoryBase(Driver::DT_MUSIC, 10, "cocoa", "Cocoa MIDI Driver") {}
34 std::unique_ptr<Driver> CreateInstance() const override { return std::make_unique<MusicDriver_Cocoa>(); }
35};
36
37#endif /* MUSIC_MACOSX_COCOA_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_Cocoa
Definition cocoa_m.h:31
FMusicDriver_Cocoa::CreateInstance
std::unique_ptr< Driver > CreateInstance() const override
Create an instance of this driver-class.
Definition cocoa_m.h:34
MusicDriver_Cocoa
Definition cocoa_m.h:15
MusicDriver_Cocoa::SetVolume
void SetVolume(uint8_t vol) override
Set the volume, if possible.
MusicDriver_Cocoa::IsSongPlaying
bool IsSongPlaying() override
Are we currently playing a song?
MusicDriver_Cocoa::Stop
void Stop() override
Stop this driver.
MusicDriver_Cocoa::StopSong
void StopSong() override
Stop playing the current song.
MusicDriver_Cocoa::Start
std::optional< std::string_view > Start(const StringList &param) override
Start this driver.
MusicDriver_Cocoa::GetName
std::string_view GetName() const override
Get the name of this driver.
Definition cocoa_m.h:28
MusicDriver_Cocoa::PlaySong
void PlaySong(const MusicSongInfo &song) override
Play a particular song.
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