OSDLCDROMDrive.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_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 <list>
#include <map>



#if ! defined(OSDL_USES_SDL) || OSDL_USES_SDL 

// No need to include SDL header here:
struct SDL_CD ;
struct SDL_CDtrack ;

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




namespace OSDL
{
    
    
#if ! defined(OSDL_USES_SDL) || OSDL_USES_SDL 

    /*
     * No way of forward declaring LowLevelCDROM apparently:
     * we would have liked to specify 'struct LowLevelThing ;' here and in the
     * implementation file (.cc): 'typedef BackendThing LowLevelThing' but then
     * the compiler finds they are conflicting declarations.
     *
     */
    typedef ::SDL_CD LowLevelCDROM ;
    typedef ::SDL_CDtrack LowLevelCDROMTrack ;
    
#else // OSDL_USES_SDL  

    struct LowLevelCDROM {} ;
    struct LowLevelCDROMTrack {} ;
        
#endif // OSDL_USES_SDL 

    
    
    // 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 LowLevelCDROMTrack & track ) ;
            
            
            
            virtual ~CDTrack() throw() ;
            
            
            
            virtual TrackNumber getTrackNumber() const ;
            
            
            
            virtual TrackType getTrackType() const ;
            
            
            
            virtual FrameCount getLength() const ;
            
            
            
            virtual FrameCount getFrameOffset() const ;
        
        

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


        
        
        protected:
        
        
            const LowLevelCDROMTrack * _trackData ;
                    
        
                        
            
        private:    
        
        

            explicit CDTrack( const CDTrack & source ) ;
            
            
            
            CDTrack & operator = ( const CDTrack & source ) ;
            
            
    } ;
    
    
    
    
    
    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() ;
            
            
            
            virtual void close() ;
            
            
            
            virtual void eject() const ;
             
             
             
            virtual Status getStatus() ;



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

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




            
            // Static section.
            
            
            
            static std::list<std::string> GetListOfInsertedMedia() ;
            
            
            
            static FrameCount ConvertTimeToFrameCount( 
                Ceylan::System::Second duration ) ;



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




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

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


}



#endif // OSDL_CD_ROM_DRIVE_H_

---