OSDLSound.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_SOUND_H_
#define OSDL_SOUND_H_


#include "OSDLAudible.h"     // for AudibleException, inheritance
#include "OSDLUtils.h"          // for Datastream, no easy forward declaration


#include "Ceylan.h"          // for LoadableWithContent


#include <string>



#if ! defined(OSDL_USES_SDL_MIXER) || OSDL_USES_SDL_MIXER 

// No need to include SDL_Mixer header here:
struct Mix_Chunk ; 

#endif //  ! defined(OSDL_USES_SDL_MIXER) || OSDL_USES_SDL_MIXER 




namespace OSDL
{

    
    
    namespace Audio 
    {
            


#if ! defined(OSDL_USES_SDL_MIXER) || OSDL_USES_SDL_MIXER 

        typedef ::Mix_Chunk LowLevelSound ;
        
#else // OSDL_USES_SDL_MIXER    


        struct LowLevelSound 
        {
        
        
            Ceylan::Uint16 _frequency ;


            Ceylan::Uint8 _bitDepth ;


            Ceylan::Uint8 _mode ;
            
            
            Ceylan::Byte * _samples ;
        
        
            Ceylan::Uint32 _size ;
            
                     
        } ;
        

#endif // OSDL_USES_SDL_MIXER



            
        class OSDL_DLL SoundException: public AudibleException 
        { 
            public: 
            
                SoundException( const std::string & reason ) ; 
                virtual ~SoundException() throw() ; 
        } ;
            
            
                
        // Forward-declaration for next counted pointer:
        class Sound ;
        
        
        typedef Ceylan::CountedPointer<Sound> SoundCountedPtr ;
            
            
                
                                                
        class OSDL_DLL Sound: public Audible, 
            public Ceylan::LoadableWithContent<LowLevelSound>
        {
        
        
        
            public:
                


                explicit Sound( const std::string & soundFile, 
                    bool preload = true ) ;
                
                
                
                virtual ~Sound() throw() ;
        
        
        
        
                // LoadableWithContent template instanciation.
        
                
                
                virtual bool load() ;
        
        
        
                virtual bool unload() ;
        



                // Audible implementation.
                
                
                
                virtual Volume getVolume() const ;
        
        
        
                virtual void setVolume( Volume newVolume ) ;
        
        
        
        
                /*
                 * Play section.
                 *
                 * Each subsection includes three methods:
                 *
                 * 1. one inherited from Audible with automatic channel choice,
                 * this choice not being returned
                 *
                 * 2. one with automatic channel choice, this choice being
                 * returned
                 *
                 * 3. one with the target channel being specified
                 *
                 */
                
                
                
                
                // Simple play subsection.
                
                
                
                virtual void play( PlaybackCount playCount = 1 ) ; 



                virtual ChannelNumber playReturnChannel( 
                    PlaybackCount playCount = 1 ) ; 



                virtual void play( 
                    ChannelNumber mixingChannelNumber, 
                    PlaybackCount playCount = 1 ) ; 




                // Play with time-out subsection.


        
                virtual void playForAtMost( 
                    Ceylan::System::Millisecond maxDuration, 
                    PlaybackCount playCount = 1 ) ; 
    
    
        
                virtual ChannelNumber playForAtMostReturnChannel( 
                    Ceylan::System::Millisecond maxDuration, 
                    PlaybackCount playCount = 1 ) ; 
    
    
    
                virtual void playForAtMost(
                    Ceylan::System::Millisecond maxDuration, 
                    ChannelNumber mixingChannelNumber,
                    PlaybackCount playCount = 1 ) ; 
        
        
    
        
                // Play with fade-in subsection.
        
        
        
                virtual void playWithFadeIn( 
                    Ceylan::System::Millisecond fadeInMaxDuration,
                    PlaybackCount playCount = 1 ) ; 
        
        
        
                virtual ChannelNumber playWithFadeInReturnChannel( 
                    Ceylan::System::Millisecond fadeInMaxDuration,
                    PlaybackCount playCount = 1 ) ; 
        
        
                
                virtual void playWithFadeIn( 
                    Ceylan::System::Millisecond fadeInMaxDuration,
                    ChannelNumber mixingChannelNumber,
                    PlaybackCount playCount = 1 ) ; 




                // Play with time-out and fade-in subsection.



                virtual void playWithFadeInForAtMost( 
                    Ceylan::System::Millisecond playbackMaxDuration,
                    Ceylan::System::Millisecond fadeInMaxDuration,
                    PlaybackCount playCount = 1 ) ; 



                virtual ChannelNumber playWithFadeInForAtMostReturnChannel( 
                    Ceylan::System::Millisecond playbackMaxDuration,
                    Ceylan::System::Millisecond fadeInMaxDuration,
                    PlaybackCount playCount = 1 ) ; 



                virtual void playWithFadeInForAtMost( 
                    Ceylan::System::Millisecond playbackMaxDuration,
                    Ceylan::System::Millisecond fadeInMaxDuration,
                    ChannelNumber mixingChannelNumber,
                    PlaybackCount playCount = 1 ) ; 
        
        
        
        
                virtual const std::string toString( 
                    Ceylan::VerbosityLevels level = Ceylan::high ) const ;
            
            
            
            
            
            protected:
            
            
                OSDL::Utils::DataStream * _dataStream ;
            
            
            
            
            private:

    
                explicit Sound( const Sound & source ) ;
            
            
            
                Sound & operator = ( const Sound & source ) ;
                
            
        } ;
        
        
    }   
    
}   



#endif // OSDL_SOUND_H_

---