OSDLCDROMDrive.h

Go to the documentation of this file.

#ifndef OSDL_CD_ROM_DRIVE_H_
#define OSDL_CD_ROM_DRIVE_H_


// for OSDL::CDROMDriveException, CDROMDriveNumber :
#include "OSDLCDROMDriveHandler.h"   

#include "Ceylan.h"                  // for inheritance


#include <string>
#include <map>


// Forward declaration.
struct SDL_CD ;

// Forward declaration.
struct SDL_CDtrack ;



namespace OSDL
{
    
    
    // Tracks are parts of CD data that can be counted. 
    typedef Ceylan::Count TrackNumber ;
    
    
    typedef Ceylan::Uint32 FrameCount ;
    
    
    enum TrackType { audioTrack, dataTrack } ;
    
    
    
    class OSDL_DLL CDTrack : public Ceylan::TextDisplayable
    {
    
        
        public:
        
        
            CDTrack( const SDL_CDtrack & track ) throw() ;
            
            virtual ~CDTrack() throw() ;
            
            
            virtual TrackNumber getTrackNumber() const throw() ;
            
            virtual TrackType getTrackType() const throw() ;
            
            virtual FrameCount getLength() const throw() ;
            
            virtual FrameCount getFrameOffset() const throw() ;
        

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


        
        protected:
        
        
            const SDL_CDtrack * _trackData ;
                    
                        
            
        private:    
        

            explicit CDTrack( const CDTrack & source ) throw() ;
            
            
            CDTrack & operator = ( const CDTrack & source ) throw() ;
            
    } ;
    
    
    
    
    class OSDL_DLL CDROMDrive : public Ceylan::Object
    {
    
    
        // The CD-ROM drive handler must be able to instanciate CD-ROM drives.
        friend class CDROMDriveHandler ;
        
        
        public:
        

            static const FrameCount FramesPerSecond ;
            
            
            enum Status { TrayEmpty, Stopped, Playing, Paused, InError } ; 
            
            
            virtual void open() throw( CDROMDriveException ) ;
            
            
            virtual void close() throw( CDROMDriveException ) ;
            
            
            virtual void eject() const throw( CDROMDriveException ) ;
             
             
            virtual Status getStatus() throw( CDROMDriveException ) ;


            virtual Status getConstStatus() const throw( CDROMDriveException ) ;
            
            
            virtual bool isCDInDrive() throw( CDROMDriveException ) ;
            
            
            virtual TrackNumber getTracksCount() const 
                throw( CDROMDriveException ) ;
            
            
            virtual FrameCount getTrackDuration( TrackNumber targetTrack ) 
                const throw( CDROMDriveException ) ;
             
            
            virtual CDTrack & getTrack( TrackNumber targetTrack ) 
                const throw( CDROMDriveException ) ;
                
                
            virtual void playFrames( FrameCount startingFrame, 
                FrameCount durationInFrames ) throw( CDROMDriveException ) ;
                
                
            virtual void playTracks( 
                    TrackNumber startingTrack, 
                    TrackNumber numberOfTracks, 
                    FrameCount startingFrameOffset = 0,
                    FrameCount stoppingFrameOffset = 0 ) 
                throw( CDROMDriveException ) ;
            
            
            virtual void pause() const throw( CDROMDriveException ) ;
            
            
            virtual void resume() const throw( CDROMDriveException ) ;
            

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



            
            // Static section.
            
            
            static FrameCount ConvertTimeToFrameCount( 
                Ceylan::System::Second duration ) throw() ;


            static Ceylan::System::Second ConvertFrameCountToTime( 
                FrameCount duration ) throw() ;



        protected:
        
            
            CDROMDriveNumber _driveNumber ;
    
    
        
        private:
    
    
            bool _statusUpdated ;
            
                
            SDL_CD * _driveStatus ;
            
            
            explicit CDROMDrive( CDROMDriveNumber driveNumber ) 
                throw( CDROMDriveException ) ;
            
            
            virtual ~CDROMDrive() throw() ;
            
            

            explicit CDROMDrive( const CDROMDrive & source ) throw() ;
            
            
            CDROMDrive & operator = ( const CDROMDrive & source ) throw() ;
            
    
    } ;


}



#endif // OSDL_CD_ROM_DRIVE_H_

---