GCC Code Coverage Report
Directory: src/ Exec Total Coverage
File: src/resources/sdlmusic.h Lines: 0 2 0.0 %
Date: 2021-03-17 Branches: 0 0 0.0 %

Line Branch Exec Source
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_SDLMUSIC_H
25
#define RESOURCES_SDLMUSIC_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 music.
38
 */
39
class SDLMusic final : public Resource
40
{
41
    public:
42
        SDLMusic() :
43
            Resource(),
44
            mName(),
45
            mMusic(nullptr),
46
            mRw(nullptr)
47
        { }
48
49
        SDLMusic(Mix_Music *const music,
50
                 SDL_RWops *const rw,
51
                 const std::string &name);
52
53
        A_DELETE_COPY(SDLMusic)
54
55
        /**
56
         * Destructor.
57
         */
58
        ~SDLMusic() override final;
59
60
        /**
61
         * Plays the music.
62
         *
63
         * @param loops     Number of times to repeat the playback (-1 means
64
         *                  forever).
65
         * @param fadeIn    Duration in milliseconds to fade in the music.
66
         *
67
         * @return <code>true</code> if the playback started properly
68
         *         <code>false</code> otherwise.
69
         */
70
        bool play(const int loops,
71
                  const int fadeIn) 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_Music *mMusic;
81
        SDL_RWops *mRw;
82
};
83
84
#endif  // RESOURCES_SDLMUSIC_H