GCC Code Coverage Report
Directory: src/ Exec Total Coverage
File: src/resources/sdlmusic.h Lines: 0 2 0.0 %
Date: 2017-11-29 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-2017  The ManaPlus Developers
6
 *
7
 *  This file is part of The ManaPlus Client.
8
 *
9
 *  This program is free software; you can redistribute it and/or modify
10
 *  it under the terms of the GNU General Public License as published by
11
 *  the Free Software Foundation; either version 2 of the License, or
12
 *  any later version.
13
 *
14
 *  This program is distributed in the hope that it will be useful,
15
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
16
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17
 *  GNU General Public License for more details.
18
 *
19
 *  You should have received a copy of the GNU General Public License
20
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
21
 */
22
23
#ifndef RESOURCES_SDLMUSIC_H
24
#define RESOURCES_SDLMUSIC_H
25
26
#include "resources/resource.h"
27
28
PRAGMA48(GCC diagnostic push)
29
PRAGMA48(GCC diagnostic ignored "-Wshadow")
30
#include <SDL_mixer.h>
31
PRAGMA48(GCC diagnostic pop)
32
33
#include "localconsts.h"
34
35
/**
36
 * Defines a class for loading and storing music.
37
 */
38
class SDLMusic final : public Resource
39
{
40
    public:
41
        SDLMusic() :
42
            Resource(),
43
            mName(),
44
            mMusic(nullptr),
45
            mRw(nullptr)
46
        { }
47
48
        SDLMusic(Mix_Music *const music,
49
                 SDL_RWops *const rw,
50
                 const std::string &name);
51
52
        A_DELETE_COPY(SDLMusic)
53
54
        /**
55
         * Destructor.
56
         */
57
        ~SDLMusic();
58
59
        /**
60
         * Plays the music.
61
         *
62
         * @param loops     Number of times to repeat the playback (-1 means
63
         *                  forever).
64
         * @param fadeIn    Duration in milliseconds to fade in the music.
65
         *
66
         * @return <code>true</code> if the playback started properly
67
         *         <code>false</code> otherwise.
68
         */
69
        bool play(const int loops = -1,
70
                  const int fadeIn = 0) const;
71
72
        int calcMemoryLocal() const override final;
73
74
        std::string getCounterName() const override final
75
        { return mName; }
76
77
    protected:
78
        std::string mName;
79
        Mix_Music *mMusic;
80
        SDL_RWops *mRw;
81
};
82
83
#endif  // RESOURCES_SDLMUSIC_H