//
//  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;

/**
  * \brief Wrapper around an instance of the Music interface
  * Adds information like composer, song title, etc...
  * Delegates many calls to the underlying Music instance.
  * \ingroup audio
  */
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;

    /** If music is loaded but hasn't been started yet (MusicManager::startMusic()
     *  was told not to start right away). */
    bool                    m_music_waiting;

    /** If faster music is enabled at all (either separate file or using
     *  the pitch shift approach). */
    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;

    /** Either time for fading faster music in, or time to change pitch. */
    float                    m_faster_time;
    /** Maximum pitch for faster music. */
    float                    m_max_pitch;
    static const int         LOOP_FOREVER=-1;
    mutable std::mutex       m_music_mutex;
    Music                   *m_normal_music,
                            *m_fast_music;
    enum {SOUND_NORMAL,     //!< normal music is played
          SOUND_FADING,     //!< normal music fading out, faster fading in
          SOUND_FASTER,     //!< change pitch of normal music
          SOUND_FAST}       //!< playing faster music or max pitch reached
                             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();
    // ------------------------------------------------------------------------
    /** Sets the music to be waiting, i.e. startMusic still needs to be
    *  called. Used to pre-load track music during track loading time. */
    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;

    // ------------------------------------------------------------------------
    /** Returns the composer of the music. */
    const stringw& getComposer() const { return m_composer; }
    // ------------------------------------------------------------------------
    /** Returns the title of the music. */
    const stringw& getTitle() const { return m_title; }
    // ------------------------------------------------------------------------
    /** Returns the filename of the normal speed music. */
    const std::string& getNormalFilename() const { return m_normal_filename; }
    // ------------------------------------------------------------------------
    /** If available, returns the file name of the faster/last-lap music. */
    const std::string& getFastFilename() const { return m_fast_filename; }
    // ------------------------------------------------------------------------
    float getMaxPitch() const { return m_max_pitch; }

};   // MusicInformation
#endif