/*
	Rogue Trader.
	Copyright (c) 2007, Darragh Coy.
	All rights reserved.
	Original work(s), source code & author(s) details available at: http://www.darraghcoy.com

	Redistribution and use in source and binary forms, with or without modification, are permitted 
	provided that the following conditions are met:

		* 	Redistributions of source code must retain the above copyright notice, this list of 
			conditions and the following disclaimer.
		* 	Redistributions in binary form must reproduce the above copyright notice, this list of 
			conditions and the following disclaimer in the documentation.
		* 	Neither the name of the author nor the names of contributors may be used to endorse or 
			promote products derived from this software without specific prior written permission.
		* 	The use of any third party libraries, modules or data files provided with the source 
			form of the program must follow and respect the individual licensing terms of these 
			components. You do not have permission to modify or circumvent the licensing terms for 
			provided third party components unless the third party licenses specifically allow this. 
			If you do not agree to the terms of provided third party components then you do not have 
			permission to use them in your derived work(s).
		* 	The terms of this license do not apply to separate (but related) distributions if supplied 
			by the author(s), only to the contents of this source distribution, derived works, and the 
			binaries produced by either modified or unmodified versions of the source code. The terms 
			of this license do not also apply to any third party libraries or components provided with 
			the source distribution. Such third party elements are licensed under their own separate 
			agreements.

	THIS SOFTWARE IS PROVIDED BY DARRAGH COY ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, 
	BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
	ARE DISCLAIMED. IN NO EVENT SHALL DARRAGH COY BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
	EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 
	OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY 
	OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
	IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#ifndef MUSICSYSTEM_H
#define MUSICSYSTEM_H

//##############################################################################
// C Includes
//##############################################################################

#include <windows.h>
#include "MathLibrary.h"

class FMUSIC_MODULE;

//##############################################################################
// Stuff that can't be forward referenced
//##############################################################################

#include <string>
#include <list>

using std::list;

//##############################################################################
//##############################################################################
//##############################################################################
//##############################################################################
//
//
// Class Name:   MusicSystem
// Purpose:      Static class that provides a simple mechanism to manage and play
//               MIDI music files.
//
//##############################################################################
//##############################################################################
//##############################################################################
//##############################################################################

class MusicSystem
{

 public:

        //----------------------------------------------------------------------
        // Functions
        //----------------------------------------------------------------------

        // Setup the music system: should be done at program startup

        static void initialise();

        // Shut down the music system: should be done at program end

        static void shutdown();

        // Picks a random song to play from the song list and plays it:

        static void playMusic();

        // Stops the currently playing music

        static void stopMusic();

        // Play a specified midi file:

        static void playFile( const char * fileName );
        
        // Tells if music is enabled
        
        static bool isMusicEnabled();
        
        // Enables / disables music
        
        static void setMusicEnabled(bool enabled);

//##############################################################################
//##############################################################################
//##############################################################################
//##############################################################################

 protected:

        //----------------------------------------------------------------------
        // Structs:
        //----------------------------------------------------------------------

        // Describes a music file in the current play list

        struct MidiFile
        {
            char            name[1024];     // name of the music file
            unsigned int    playCount;      // number of times the file was played
        };

        //----------------------------------------------------------------------
        // Functions:
        //----------------------------------------------------------------------

        // Creates and populates the play list with songs:

        static void createPlaylist();

        // Clears the play list

        static void clearPlaylist();

        //----------------------------------------------------------------------
        // Variables
        //----------------------------------------------------------------------

		// Save whether the music system initialised successfully here:

		static bool initialised;

		// Pointer to currently playing music stream:

		static FMUSIC_MODULE * musicStream;

        // A list of music files to play

        static list<MidiFile*> * playlist;
        
        // True if music is enabled
        
        static bool musicEnabled;

}; // end of: class MusicSystem{}

//##############################################################################
// C++ Includes
//##############################################################################

#endif // end of: ifndef MUSICSYSTEM_H
