soundmanager.h

Go to the documentation of this file.

/*
 * The ManaPlus Client
 * Copyright (C) 2004-2009 The Mana World Development Team
 * Copyright (C) 2009-2010 The Mana Developers
 * Copyright (C) 2011-2019 The ManaPlus Developers
 * Copyright (C) 2019-2021 Andrei Karas
 *
 * This file is part of The ManaPlus Client.
 *
 * This program 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; either version 2 of the License, or
 * any later version.
 *
 * This program 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. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef SOUNDMANAGER_H
#define SOUNDMANAGER_H
 
#include "enums/simpletypes/skiperror.h"
 
#include "listeners/configlistener.h"
 
#include "localconsts.h"
 
PRAGMA48(GCC diagnostic push)
PRAGMA48(GCC diagnostic ignored "-Wshadow")
#include <SDL_mixer.h>
PRAGMA48(GCC diagnostic pop)
 
class SDLMusic;
 
class SoundManager final : public ConfigListener
{
 public:
 SoundManager();
 
 A_DELETE_COPY(SoundManager)
 
 ~SoundManager() override final;
 
 void optionChanged(const std::string &value) override final;
 
 void init();
 
 void testAudio();
 
 void close();
 
 void playMusic(const std::string &fileName,
 const SkipError skipError);
 
 void stopMusic();
 
// void fadeInMusic(const std::string &fileName, const int ms = 1000);
 
 void fadeOutMusic(const int ms);
 
 void fadeOutAndPlayMusic(const std::string &fileName,
 const int ms);
 
 constexpr static int getMaxVolume() A_WARN_UNUSED
 { return MIX_MAX_VOLUME; }
 
 void setMusicVolume(const int volume);
 
 void setSfxVolume(const int volume);
 
 void playSfx(const std::string &path,
 const int x,
 const int y) const;
 
 void playGuiSfx(const std::string &path);
 
 void playGuiSound(const std::string &name);
 
 void changeAudio();
 
 void volumeOff() const;
 
 void volumeRestore() const;
 
 std::string getCurrentMusicFile() const noexcept2 A_WARN_UNUSED
 { return mCurrentMusicFile; }
 
 void logic();
 
 void shutdown();
 
 void setChannels(const int channels) const;
 
 private:
 static void info();
 
 void haltMusic();
 
 std::string mNextMusicFile;
 
 bool mInstalled;
 
 int mSfxVolume;
 int mMusicVolume;
 
 std::string mCurrentMusicFile;
 SDLMusic *mMusic;
 int mGuiChannel;
 bool mPlayBattle;
 bool mPlayGui;
 bool mPlayMusic;
 bool mFadeoutMusic;
 bool mCacheSounds;
};
 
extern SoundManager soundManager;
 
#endif // SOUNDMANAGER_H