music_information.hpp

//
//  SuperTuxKart - a fun racing game with go-kart
//  Copyright (C) 2008-2015 Joerg Henrichs
//
//  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 3
//  of the License, or (at your option) 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, write to the Free Software
//  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
#ifndef HEADER_MUSIC_INFORMATION_HPP
#define HEADER_MUSIC_INFORMATION_HPP
 
#include <mutex>
#include <string>
#include <stdexcept>
#include <vector>
 
#include "utils/no_copy.hpp"
#include "utils/leak_check.hpp"
 
#include <irrString.h>
using irr::core::stringw;
 
class Music;
class XMLNode;
 
class MusicInformation : public NoCopy
{
private:
    stringw                  m_composer;
    stringw                  m_title;
    std::string              m_normal_filename;
    std::string              m_fast_filename;
    std::vector<std::string> m_all_tracks;
    //int                      m_numLoops;
 
    bool                    m_music_waiting;
 
    bool                     m_enable_fast;
 
    float                    m_gain;
 
    float                    m_normal_loop_start;
    float                    m_fast_loop_start;
    float                    m_normal_loop_end;
    float                    m_fast_loop_end;
 
    float                    m_faster_time;
 
    /* Avoid the temporary volume being forgotten */
    float                    m_temporary_volume;
 
    static const int         LOOP_FOREVER=-1;
    mutable std::mutex       m_music_mutex;
    Music                   *m_normal_music,
                            *m_fast_music;
    enum {SOUND_NORMAL,     
          SOUND_FADING,     
          SOUND_FAST}       
                             m_mode;
    float                    m_time_since_faster;
 
    // The constructor is private so that the
    // static create function must be used.
    MusicInformation (const XMLNode *root, const std::string &filename);
 
    // Declare the following functions private, but allow the SFXManager 
    // to access them. This makes sure that only the sfx thread calls
    // openal/vorbis etc, and so makes it is all thread safe.
private:
    friend class SFXManager;
    void   update(float dt);
    void   startMusic();
    void   stopMusic();
    void   pauseMusic();
    void   resumeMusic();
    void   setDefaultVolume();
    void   switchToFastMusic();
    void   setTemporaryVolume(float volume);
    // ------------------------------------------------------------------------
    bool   preStart();
    // ------------------------------------------------------------------------
    void setMusicWaiting() { m_music_waiting = true; }
    // ------------------------------------------------------------------------
 
public:
    LEAK_CHECK()
 
#if (defined(WIN32) || defined(_WIN32)) && !defined(__MINGW32__)
#pragma warning(disable:4290)
#endif
                      ~MusicInformation ();
    static MusicInformation *create(const std::string &filename);
    void               addMusicToTracks();
    bool               isPlaying() const;
 
    // ------------------------------------------------------------------------
    const stringw& getComposer() const { return m_composer; }
    // ------------------------------------------------------------------------
    const stringw& getTitle() const { return m_title; }
    // ------------------------------------------------------------------------
    const std::string& getNormalFilename() const { return m_normal_filename; }
    // ------------------------------------------------------------------------
    const std::string& getFastFilename() const { return m_fast_filename; }
 
};   // MusicInformation
#endif