include/SDL_cdrom.h
author Bob Pendleton <bob@pendleton.com>
Thu, 09 Jul 2009 21:31:27 +0000
changeset 3216 48a80f2a7ff2
parent 2859 99210400e8b9
permissions -rw-r--r--
volitile... duh, yeah the variable need to be labeled volitile
     1 /*
     2     SDL - Simple DirectMedia Layer
     3     Copyright (C) 1997-2009 Sam Lantinga
     4 
     5     This library is free software; you can redistribute it and/or
     6     modify it under the terms of the GNU Lesser General Public
     7     License as published by the Free Software Foundation; either
     8     version 2.1 of the License, or (at your option) any later version.
     9 
    10     This library is distributed in the hope that it will be useful,
    11     but WITHOUT ANY WARRANTY; without even the implied warranty of
    12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    13     Lesser General Public License for more details.
    14 
    15     You should have received a copy of the GNU Lesser General Public
    16     License along with this library; if not, write to the Free Software
    17     Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
    18 
    19     Sam Lantinga
    20     slouken@libsdl.org
    21 */
    22 
    23 /**
    24  * \file SDL_cdrom.h
    25  *
    26  * This is the CD-audio control API for Simple DirectMedia Layer
    27  */
    28 
    29 #ifndef _SDL_cdrom_h
    30 #define _SDL_cdrom_h
    31 
    32 #include "SDL_stdinc.h"
    33 #include "SDL_error.h"
    34 
    35 #include "begin_code.h"
    36 /* Set up for C function definitions, even when using C++ */
    37 #ifdef __cplusplus
    38 /* *INDENT-OFF* */
    39 extern "C" {
    40 /* *INDENT-ON* */
    41 #endif
    42 
    43 /* In order to use these functions, SDL_Init() must have been called
    44    with the SDL_INIT_CDROM flag.  This causes SDL to scan the system
    45    for CD-ROM drives, and load appropriate drivers.
    46 */
    47 
    48 /* The maximum number of CD-ROM tracks on a disk */
    49 #define SDL_MAX_TRACKS	99
    50 
    51 /* The types of CD-ROM track possible */
    52 #define SDL_AUDIO_TRACK	0x00
    53 #define SDL_DATA_TRACK	0x04
    54 
    55 /* The possible states which a CD-ROM drive can be in. */
    56 typedef enum
    57 {
    58     CD_TRAYEMPTY,
    59     CD_STOPPED,
    60     CD_PLAYING,
    61     CD_PAUSED,
    62     CD_ERROR = -1
    63 } CDstatus;
    64 
    65 /* Given a status, returns true if there's a disk in the drive */
    66 #define CD_INDRIVE(status)	((int)(status) > 0)
    67 
    68 typedef struct SDL_CDtrack
    69 {
    70     Uint8 id;                   /* Track number */
    71     Uint8 type;                 /* Data or audio track */
    72     Uint16 unused;
    73     Uint32 length;              /* Length, in frames, of this track */
    74     Uint32 offset;              /* Offset, in frames, from start of disk */
    75 } SDL_CDtrack;
    76 
    77 /* This structure is only current as of the last call to SDL_CDStatus() */
    78 typedef struct SDL_CD
    79 {
    80     int id;                     /* Private drive identifier */
    81     CDstatus status;            /* Current drive status */
    82 
    83     /* The rest of this structure is only valid if there's a CD in drive */
    84     int numtracks;              /* Number of tracks on disk */
    85     int cur_track;              /* Current track position */
    86     int cur_frame;              /* Current frame offset within current track */
    87     SDL_CDtrack track[SDL_MAX_TRACKS + 1];
    88 } SDL_CD;
    89 
    90 /* Conversion functions from frames to Minute/Second/Frames and vice versa */
    91 #define CD_FPS	75
    92 #define FRAMES_TO_MSF(f, M,S,F)	{					\
    93 	int value = f;							\
    94 	*(F) = value%CD_FPS;						\
    95 	value /= CD_FPS;						\
    96 	*(S) = value%60;						\
    97 	value /= 60;							\
    98 	*(M) = value;							\
    99 }
   100 #define MSF_TO_FRAMES(M, S, F)	((M)*60*CD_FPS+(S)*CD_FPS+(F))
   101 
   102 /* CD-audio API functions: */
   103 
   104 /* Returns the number of CD-ROM drives on the system, or -1 if
   105    SDL_Init() has not been called with the SDL_INIT_CDROM flag.
   106  */
   107 extern DECLSPEC int SDLCALL SDL_CDNumDrives(void);
   108 
   109 /* Returns a human-readable, system-dependent identifier for the CD-ROM.
   110    Example:
   111 	"/dev/cdrom"
   112 	"E:"
   113 	"/dev/disk/ide/1/master"
   114 */
   115 extern DECLSPEC const char *SDLCALL SDL_CDName(int drive);
   116 
   117 /* Opens a CD-ROM drive for access.  It returns a drive handle on success,
   118    or NULL if the drive was invalid or busy.  This newly opened CD-ROM
   119    becomes the default CD used when other CD functions are passed a NULL
   120    CD-ROM handle.
   121    Drives are numbered starting with 0.  Drive 0 is the system default CD-ROM.
   122 */
   123 extern DECLSPEC SDL_CD *SDLCALL SDL_CDOpen(int drive);
   124 
   125 /* This function returns the current status of the given drive.
   126    If the drive has a CD in it, the table of contents of the CD and current
   127    play position of the CD will be stored in the SDL_CD structure.
   128 */
   129 extern DECLSPEC CDstatus SDLCALL SDL_CDStatus(SDL_CD * cdrom);
   130 
   131 /* Play the given CD starting at 'start_track' and 'start_frame' for 'ntracks'
   132    tracks and 'nframes' frames.  If both 'ntrack' and 'nframe' are 0, play 
   133    until the end of the CD.  This function will skip data tracks.
   134    This function should only be called after calling SDL_CDStatus() to 
   135    get track information about the CD.
   136    For example:
   137 	// Play entire CD:
   138 	if ( CD_INDRIVE(SDL_CDStatus(cdrom)) )
   139 		SDL_CDPlayTracks(cdrom, 0, 0, 0, 0);
   140 	// Play last track:
   141 	if ( CD_INDRIVE(SDL_CDStatus(cdrom)) ) {
   142 		SDL_CDPlayTracks(cdrom, cdrom->numtracks-1, 0, 0, 0);
   143 	}
   144 	// Play first and second track and 10 seconds of third track:
   145 	if ( CD_INDRIVE(SDL_CDStatus(cdrom)) )
   146 		SDL_CDPlayTracks(cdrom, 0, 0, 2, 10);
   147 
   148    This function returns 0, or -1 if there was an error.
   149 */
   150 extern DECLSPEC int SDLCALL SDL_CDPlayTracks(SDL_CD * cdrom,
   151                                              int start_track,
   152                                              int start_frame, int ntracks,
   153                                              int nframes);
   154 
   155 /* Play the given CD starting at 'start' frame for 'length' frames.
   156    It returns 0, or -1 if there was an error.
   157 */
   158 extern DECLSPEC int SDLCALL SDL_CDPlay(SDL_CD * cdrom, int start, int length);
   159 
   160 /* Pause play -- returns 0, or -1 on error */
   161 extern DECLSPEC int SDLCALL SDL_CDPause(SDL_CD * cdrom);
   162 
   163 /* Resume play -- returns 0, or -1 on error */
   164 extern DECLSPEC int SDLCALL SDL_CDResume(SDL_CD * cdrom);
   165 
   166 /* Stop play -- returns 0, or -1 on error */
   167 extern DECLSPEC int SDLCALL SDL_CDStop(SDL_CD * cdrom);
   168 
   169 /* Eject CD-ROM -- returns 0, or -1 on error */
   170 extern DECLSPEC int SDLCALL SDL_CDEject(SDL_CD * cdrom);
   171 
   172 /* Closes the handle for the CD-ROM drive */
   173 extern DECLSPEC void SDLCALL SDL_CDClose(SDL_CD * cdrom);
   174 
   175 
   176 /* Ends C function definitions when using C++ */
   177 #ifdef __cplusplus
   178 /* *INDENT-OFF* */
   179 }
   180 /* *INDENT-ON* */
   181 #endif
   182 #include "close_code.h"
   183 
   184 #endif /* _SDL_video_h */
   185 
   186 /* vi: set ts=4 sw=4 expandtab: */