OSDLMusic.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_H_
#define OSDL_MUSIC_H_


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


#include "Ceylan.h"             // for LoadableWithContent


#include <string>




/*
 * No need to include SDL_Mixer header here.
 *
 * 'struct Mix_Music' could not be forward-declared, as SDL_mixer.h defines 
 * it as 'typedef struct _Mix_Music Mix_Music;' which leads to the error
 * "'struct Mix_Music' has a previous declaration as 'struct Mix_Music'",
 * as soon as an implementation file (ex: OSDLAudio.cc) includes SDL_mixer.h.
 * So we use _Mix_Music instead of Mix_Music.
 *
 */
struct _Mix_Music ;




namespace OSDL
{


// Command management only needed for the Nintendo DS:
#if defined(OSDL_ARCH_NINTENDO_DS) && OSDL_ARCH_NINTENDO_DS
    
    // Forward-declaration for friend declaration.  
    class CommandManager ;
    
    class CommandManagerSettings ;

#endif // defined(OSDL_ARCH_NINTENDO_DS) && OSDL_ARCH_NINTENDO_DS 

    
         
    namespace Audio 
    {



#if ! defined(OSDL_USES_SDL_MIXER) || OSDL_USES_SDL_MIXER 

        typedef ::_Mix_Music LowLevelMusic ;
                
#else // OSDL_USES_SDL_MIXER    

        
        
        struct LowLevelMusic
        {
        
        
            // Music-specific section.
        
            
            
            Ceylan::System::File * _musicFile ;
            
            
            Ceylan::Uint16 _frequency ;


            Ceylan::Uint8 _bitDepth ;


            Ceylan::Uint8 _mode ;



            BufferSize _size ;
            
            
            
            // Buffer-specific section.


            BufferSize _frameSizeUpperBound ;
            
        
        
            bool _requestFillOfFirstBuffer ;
                    
                        
            /*
             * Precomputes the start of the first buffer, after the delta 
             * zone.
             *
             */
            Ceylan::Byte * _startAfterDelta ;
            
            
            BufferSize _firstActualRefillSize ;
            
            
            bool _requestFillOfSecondBuffer ;
                
                
                    
            PlaybackCount _playbackCount ;
            
        } ;
        
        

#endif // OSDL_USES_SDL_MIXER


            
        class OSDL_DLL MusicException : public AudibleException
        { 
            public: 
            
                MusicException( const std::string & reason ) ; 
                virtual ~MusicException() throw() ; 
        } ;
            
                        
                            
        typedef Ceylan::Uint32 MusicPosition ;


        
                
        enum MusicType
        {
        
        
            Wave,
            
            
            MOD,
            
            
            MIDI,
            
            
            OggVorbis,
            
            
            MP3,
            
            
            CommandBased,
            
            
            NoMusic,
            
            
            Unknown
        
        
        } ;
    
        
        
        
        typedef Ceylan::Uint8 BitrateType ;
         
         
         
         
        // For constant bitrate: 
        extern OSDL_DLL const BitrateType CBR ;  
        
        
        
        // For variable bitrate: 
        extern OSDL_DLL const BitrateType VBR ;  



        // Forward-declaration for next counted pointer:
        class Music ;
        
        
        typedef Ceylan::CountedPointer<Music> MusicCountedPtr ;
        

        
                                                
        class OSDL_DLL Music : public Audible, 
            public Ceylan::LoadableWithContent<LowLevelMusic>
        {
    
#if defined(CEYLAN_ARCH_NINTENDO_DS) && CEYLAN_ARCH_NINTENDO_DS == 1

            // So that the manager can call onPlaybackEnded and al:
            friend class OSDL::CommandManager ;

#endif // defined(CEYLAN_ARCH_NINTENDO_DS) && CEYLAN_ARCH_NINTENDO_DS == 1
    
            
            
            public:
                
                

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



                // Audible implementation.
                
                
                
                virtual Volume getVolume() const ;
        
        
        
                virtual void setVolume( Volume newVolume ) ;
        
        
        
                virtual MusicType getType() const ;
        
        
        
        
                /*
                 * Play section.
                 *
                 * There is no concept of input channel here, as if one was 
                 * reserved for music.
                 *
                 */
                
                
                
                // Simple play subsection.
                
                
                
                virtual void play( PlaybackCount playCount = 1 ) ; 



    
                // Play with fade-in subsection.
        
        
                virtual void playWithFadeIn( 
                    Ceylan::System::Millisecond fadeInMaxDuration,
                    PlaybackCount playCount = 1 ) ; 
        
        
        
                virtual void playWithFadeInFromPosition( 
                    Ceylan::System::Millisecond fadeInMaxDuration,
                    MusicPosition position,
                    PlaybackCount playCount = 1 ) ; 
        


                virtual bool isPlaying() ;
                
                
                
                virtual void pause() ; 
        
        
        
                virtual void unpause() ; 
        
        
        
                virtual void rewind() ; 
        
        
        
                virtual void setPosition( MusicPosition newPosition ) ; 
        
        
        
                virtual void stop() ; 

                
                
                virtual void fadeIn( 
                    Ceylan::System::Millisecond fadeInMaxDuration ) ; 


                
                virtual void fadeOut( 
                    Ceylan::System::Millisecond fadeOutMaxDuration ) ; 

    
                 
                virtual const std::string toString( 
                    Ceylan::VerbosityLevels level = Ceylan::high ) const ;
    
            
            
#if defined(OSDL_ARCH_NINTENDO_DS) && OSDL_ARCH_NINTENDO_DS
    
                static void SetCommandManagerSettings( 
                    const CommandManagerSettings & settings ) ;
                            
#endif // defined(OSDL_ARCH_NINTENDO_DS) && OSDL_ARCH_NINTENDO_DS 
            

                static void ManageCurrentMusic() ;
                
                
                 
                static MusicType GetTypeOf( const Music * music ) ;
                    
                    
                    
                static std::string DescribeMusicType( MusicType type ) ;
                    
                    
                    
                static std::string DescribeBitrateType( BitrateType type ) ;
                                
            
                
                
            
            protected:
            
            
                OSDL::Utils::DataStream * _dataStream ;



                bool _isPlaying ;


                
#if defined(OSDL_ARCH_NINTENDO_DS) && OSDL_ARCH_NINTENDO_DS

                static const CommandManagerSettings * _CommandManagerSettings ;
                
#endif // defined(OSDL_ARCH_NINTENDO_DS) && OSDL_ARCH_NINTENDO_DS 
            
            
                
                static Music * _CurrentMusic ;
                
                
                
                
                
                virtual void onPlaybackEnded() ;
                
                
                
                virtual void managePlaybackEnded() ;

                
                
                virtual void onNoMoreCurrent() ;

                
                
                virtual void manageNoMoreCurrent() ;

                    
                
                virtual void manageBufferRefill() ;

                
                
                void fillFirstBuffer() ; 
                
                
                
                void fillSecondBuffer() ; 
                


                virtual void setAsCurrent() ;

            
            
                virtual void requestFillOfFirstBuffer() ;
                
                
                
                virtual void requestFillOfSecondBuffer() ;
                    
                
                
            private:
    
    
    
                explicit Music( const Music & source ) ;
            
            
            
                Music & operator = ( const Music & source ) ;
                
                
            
        } ;
        

        
        
    }   
    
}   



#endif // OSDL_MUSIC_H_

---