OSDLCommandManager.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_COMMAND_MANAGER_H_
#define OSDL_COMMAND_MANAGER_H_



#include "OSDLAudioCommon.h" // for BufferSize       
#include "OSDLException.h"   // for OSDL::Exception


#include "Ceylan.h"          // for inheritance

#include <string>



// Command management only needed for the Nintendo DS:
#if defined(OSDL_ARCH_NINTENDO_DS) && OSDL_ARCH_NINTENDO_DS




namespace OSDL
{

    
    
    namespace Audio
    {
    
        class Sound ;
        class Music ;
        
    }
                    
    
    
    class CommandException: public OSDL::Exception
    { 
        public: 
         
            explicit CommandException( const std::string & reason ) ;
             
            virtual ~CommandException() throw() ;
             
    } ;
    
    
    
    // Defined afterwards.
    class CommandManager ;
    
    
        
    struct CommandManagerSettings
    {
    


        CommandManager * _commandManager ;



        Audio::BufferSize _bufferSize ;



        Ceylan::Byte * _doubleBuffer ;



        Ceylan::Byte * _secondBuffer ;


    } ;

    
    
            
    class OSDL_DLL CommandManager: public Ceylan::System::FIFO
    {



        public:
        
        
        
            CommandManager() ;
            
            

            virtual ~CommandManager() throw() ;
            
            
            
            
            // Audio section.
            
            
            
            virtual void playSound( Audio::Sound & sound ) ;
            
            
            
            virtual void enableMusicSupport() ;
            
            
            
            virtual void disableMusicSupport() ;
            
            
            
            virtual Audio::BufferSize getMusicBufferSize() const ;



            virtual Ceylan::Byte * getMusicBuffer() const ;



            virtual void playMusic( Audio::Music & music ) ;
            
            
            
            virtual void playMusicWithFadeIn( Audio::Music & music, 
                Ceylan::System::Millisecond fadeInMaxDuration ) ;
            
            
            
            virtual void stopMusic() ;
            
            
            
            virtual void fadeInMusic( 
                Ceylan::System::Millisecond fadeInMaxDuration ) ;
            
            
            
            virtual void fadeOutMusic( 
                Ceylan::System::Millisecond fadeOutMaxDuration ) ;
            
            
            
            virtual void setMusicVolume( Audio::Volume newVolume ) ;



            virtual void pauseMusic() ;


            
            virtual void unpauseMusic() ;
            

            
            virtual void notifyEndOfEncodedStreamReached() ;
                
            
            
            virtual void unsetCurrentMusic( Audio::Music & music ) ;
            
            
            
            virtual std::string interpretLastARM7ErrorCode() ;

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





            // Static section.



            static bool HasExistingCommandManager() ;
            


            static CommandManager & GetExistingCommandManager() ;

            
            
            static CommandManager & GetCommandManager() ;
            




        protected:

        
        
            Audio::Music * _currentMusic ;
        
        
        
            Ceylan::Byte * _doubleBuffer ;
        
        
        
            Audio::BufferSize _bufferSize ;
        
        
        
            CommandManagerSettings * _settings ;
            
            
            
            virtual void handleReceivedIntegratingLibrarySpecificCommand(
                FIFOCommandID commandID, 
                Ceylan::System::FIFOElement firstElement ) ;
            
            
            
            static CommandManager * _IPCManager ;

            
            
            
        private:        
        
        
            explicit CommandManager( const CommandManager & source ) ;

            
            
            CommandManager & operator = ( const CommandManager & source ) ;
            
                    
        
    } ;     
    
        
    
}


#endif // defined(OSDL_ARCH_NINTENDO_DS) && OSDL_ARCH_NINTENDO_DS 


#endif // OSDL_COMMAND_MANAGER_H_

---