OSDLMusicManager.h

Go to the documentation of this file.

/* 
 * Copyright (C) 2003-2009 Olivier Boudeville
 *
 * This file is part of the OSDL library.
 *
 * The OSDL library is free software: you can redistribute it and/or modify
 * it under the terms of either the GNU Lesser General Public License or
 * the GNU General Public License, as they are published by the Free Software
 * Foundation, either version 3 of these Licenses, or (at your option) 
 * any later version.
 *
 * The OSDL library 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 Lesser General Public License and the GNU General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License and of the GNU General Public License along with the OSDL library.
 * If not, see <http://www.gnu.org/licenses/>.
 *
 * Author: Olivier Boudeville (olivier.boudeville@esperide.com)
 *
 */


#ifndef OSDL_MUSIC_MANAGER_H_
#define OSDL_MUSIC_MANAGER_H_


#include "OSDLAudioCommon.h"    // for MusicManagerType, etc.
#include "OSDLAudible.h"        // for PlaybackCount


#include <string>





namespace OSDL
{


             
    namespace Audio 
    {



        // A music manager controls them:
        class Music ;
        
        
        
            
        class OSDL_DLL MusicManagerException : public AudioException
        { 
            public: 
            
                MusicManagerException( const std::string & reason ) ; 
                virtual ~MusicManagerException() throw() ; 
        } ;
            

        // Forward declaration for the next declaration:
        class MusicManager ;



        OSDL_DLL MusicManager & getExistingMusicManager() ;



        class OSDL_DLL MusicPlaybackSetting : public Ceylan::TextDisplayable
        {
        
            public:
            
            
                explicit MusicPlaybackSetting( Music & music, 
                    PlaybackCount count = 1 ) ;
                
                
                virtual ~MusicPlaybackSetting() throw() ;
                
                
                
                virtual void setFadeInStatus( bool on ) ;
                    
                    
                    
                virtual void setFadeOutStatus( bool on ) ;
                    
                    
                    
                virtual void startPlayback() ;
                
                    
                virtual void stopPlayback() ;
                
                
                
                virtual bool onPlaybackEnded() ;
                
                    
                    
                virtual const std::string toString( 
                    Ceylan::VerbosityLevels level = Ceylan::high ) const ;
    
                                
                
            
            protected:
            
            
                Music * _music ;
                
                
                PlaybackCount _count ;
                
                
                bool _fadeIn ;
                
                
                bool _fadeOut ;
                
            
            
            private:
            
            
                explicit MusicPlaybackSetting( 
                    const MusicPlaybackSetting & source ) ;
            
            
            
                MusicPlaybackSetting & operator = ( 
                    const MusicPlaybackSetting & source ) ;
                
        } ;
        
        
        
                
                                                
        class OSDL_DLL MusicManager : public Ceylan::Object
        {

            
            // To allow the audio module to remove the music manager:
            friend class AudioModule ;
            
            
            OSDL_DLL friend MusicManager & 
                OSDL::Audio::getExistingMusicManager() ;
            
            
            public:
                
                

                MusicManager() ;
                
                
                
                virtual ~MusicManager() throw() ;
        
        
                
                virtual void enqueue( Music & music, PlaybackCount count = 1,
                    bool fadeIn = false, bool fadeOut = false ) ;

        
        
                virtual bool isPlaying() const ;
                
                    
                     
                virtual const std::string toString( 
                    Ceylan::VerbosityLevels level = Ceylan::high ) const ;
    
                                
                
                
            
            protected:
            


                virtual void startNextMusicPlayback() ;



                virtual void stopCurrentMusicPlayback() ;
                
                
                
                virtual void onMusicPlaybackFinished() ;    
                                    
/* 
 * Takes care of the awful issue of Windows DLL with templates.
 *
 * @see Ceylan's developer guide and README-build-for-windows.txt 
 * to understand it, and to be aware of the associated risks. 
 * 
 */
#pragma warning( push )
#pragma warning( disable: 4251 )

                std::list<MusicPlaybackSetting *> _playList ;
        
#pragma warning( pop ) 


                MusicPlaybackSetting * _currentMusicPlayback ;
                
                
                                
                static MusicManager * _CurrentMusicManager ;
                
                
                            
            
            
            private:
    
    
                static void HandleMusicPlaybackFinishedCallback() ;
    
    
                explicit MusicManager( const MusicManager & source ) ;
            
            
            
                MusicManager & operator = ( const MusicManager & source ) ;
                
                
            
        } ;
                
        
    }   
    
}   



#endif // OSDL_MUSIC_MANAGER_H_

---