1 |
|
|
/* |
2 |
|
|
* The ManaPlus Client |
3 |
|
|
* Copyright (C) 2004-2009 The Mana World Development Team |
4 |
|
|
* Copyright (C) 2009-2010 The Mana Developers |
5 |
|
|
* Copyright (C) 2011-2019 The ManaPlus Developers |
6 |
|
|
* Copyright (C) 2019-2021 Andrei Karas |
7 |
|
|
* |
8 |
|
|
* This file is part of The ManaPlus Client. |
9 |
|
|
* |
10 |
|
|
* This program is free software; you can redistribute it and/or modify |
11 |
|
|
* it under the terms of the GNU General Public License as published by |
12 |
|
|
* the Free Software Foundation; either version 2 of the License, or |
13 |
|
|
* any later version. |
14 |
|
|
* |
15 |
|
|
* This program is distributed in the hope that it will be useful, |
16 |
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
17 |
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
18 |
|
|
* GNU General Public License for more details. |
19 |
|
|
* |
20 |
|
|
* You should have received a copy of the GNU General Public License |
21 |
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>. |
22 |
|
|
*/ |
23 |
|
|
|
24 |
|
|
#ifndef RESOURCES_SOUNDEFFECT_H |
25 |
|
|
#define RESOURCES_SOUNDEFFECT_H |
26 |
|
|
|
27 |
|
|
#include "resources/resource.h" |
28 |
|
|
|
29 |
|
|
PRAGMA48(GCC diagnostic push) |
30 |
|
|
PRAGMA48(GCC diagnostic ignored "-Wshadow") |
31 |
|
|
#include <SDL_mixer.h> |
32 |
|
|
PRAGMA48(GCC diagnostic pop) |
33 |
|
|
|
34 |
|
|
#include "localconsts.h" |
35 |
|
|
|
36 |
|
|
/** |
37 |
|
|
* Defines a class for loading and storing sound effects. |
38 |
|
|
*/ |
39 |
|
|
class SoundEffect final : public Resource |
40 |
|
|
{ |
41 |
|
|
public: |
42 |
|
|
/** |
43 |
|
|
* Constructor. |
44 |
|
|
*/ |
45 |
|
|
SoundEffect(Mix_Chunk *const soundEffect, |
46 |
|
|
const std::string &name) : |
47 |
|
|
Resource(), |
48 |
|
|
mName(name), |
49 |
|
|
mChunk(soundEffect) |
50 |
|
|
{ } |
51 |
|
|
|
52 |
|
|
A_DELETE_COPY(SoundEffect) |
53 |
|
|
|
54 |
|
|
/** |
55 |
|
|
* Destructor. |
56 |
|
|
*/ |
57 |
|
|
~SoundEffect() override final; |
58 |
|
|
|
59 |
|
|
/** |
60 |
|
|
* Plays the sample. |
61 |
|
|
* |
62 |
|
|
* @param loops Number of times to repeat the playback. |
63 |
|
|
* @param volume Sample playback volume. |
64 |
|
|
* @param channel Sample playback channel. |
65 |
|
|
* |
66 |
|
|
* @return <code>true</code> if the playback started properly |
67 |
|
|
* <code>false</code> otherwise. |
68 |
|
|
*/ |
69 |
|
|
bool play(const int loops, |
70 |
|
|
const int volume, |
71 |
|
|
const int channel) const; |
72 |
|
|
|
73 |
|
|
int calcMemoryLocal() const override final; |
74 |
|
|
|
75 |
|
|
std::string getCounterName() const override final |
76 |
|
|
{ return mName; } |
77 |
|
|
|
78 |
|
|
protected: |
79 |
|
|
std::string mName; |
80 |
|
|
Mix_Chunk *mChunk; |
81 |
|
|
}; |
82 |
|
|
|
83 |
|
|
#endif // RESOURCES_SOUNDEFFECT_H |