2
SDL - Simple DirectMedia Layer
3
Copyright (C) 1997-2006 Sam Lantinga
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.
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.
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
23
/* This is the CD-audio control API for Simple DirectMedia Layer */
28
#include "SDL_stdinc.h"
29
#include "SDL_error.h"
31
#include "begin_code.h"
32
/* Set up for C function definitions, even when using C++ */
37
/* In order to use these functions, SDL_Init() must have been called
38
with the SDL_INIT_CDROM flag. This causes SDL to scan the system
39
for CD-ROM drives, and load appropriate drivers.
42
/* The maximum number of CD-ROM tracks on a disk */
43
#define SDL_MAX_TRACKS 99
45
/* The types of CD-ROM track possible */
46
#define SDL_AUDIO_TRACK 0x00
47
#define SDL_DATA_TRACK 0x04
49
/* The possible states which a CD-ROM drive can be in. */
58
/* Given a status, returns true if there's a disk in the drive */
59
#define CD_INDRIVE(status) ((int)(status) > 0)
61
typedef struct SDL_CDtrack {
62
Uint8 id; /* Track number */
63
Uint8 type; /* Data or audio track */
65
Uint32 length; /* Length, in frames, of this track */
66
Uint32 offset; /* Offset, in frames, from start of disk */
69
/* This structure is only current as of the last call to SDL_CDStatus() */
70
typedef struct SDL_CD {
71
int id; /* Private drive identifier */
72
CDstatus status; /* Current drive status */
74
/* The rest of this structure is only valid if there's a CD in drive */
75
int numtracks; /* Number of tracks on disk */
76
int cur_track; /* Current track position */
77
int cur_frame; /* Current frame offset within current track */
78
SDL_CDtrack track[SDL_MAX_TRACKS+1];
81
/* Conversion functions from frames to Minute/Second/Frames and vice versa */
83
#define FRAMES_TO_MSF(f, M,S,F) { \
85
*(F) = value%CD_FPS; \
91
#define MSF_TO_FRAMES(M, S, F) ((M)*60*CD_FPS+(S)*CD_FPS+(F))
93
/* CD-audio API functions: */
95
/* Returns the number of CD-ROM drives on the system, or -1 if
96
SDL_Init() has not been called with the SDL_INIT_CDROM flag.
98
extern DECLSPEC int SDLCALL SDL_CDNumDrives(void);
100
/* Returns a human-readable, system-dependent identifier for the CD-ROM.
104
"/dev/disk/ide/1/master"
106
extern DECLSPEC const char * SDLCALL SDL_CDName(int drive);
108
/* Opens a CD-ROM drive for access. It returns a drive handle on success,
109
or NULL if the drive was invalid or busy. This newly opened CD-ROM
110
becomes the default CD used when other CD functions are passed a NULL
112
Drives are numbered starting with 0. Drive 0 is the system default CD-ROM.
114
extern DECLSPEC SDL_CD * SDLCALL SDL_CDOpen(int drive);
116
/* This function returns the current status of the given drive.
117
If the drive has a CD in it, the table of contents of the CD and current
118
play position of the CD will be stored in the SDL_CD structure.
120
extern DECLSPEC CDstatus SDLCALL SDL_CDStatus(SDL_CD *cdrom);
122
/* Play the given CD starting at 'start_track' and 'start_frame' for 'ntracks'
123
tracks and 'nframes' frames. If both 'ntrack' and 'nframe' are 0, play
124
until the end of the CD. This function will skip data tracks.
125
This function should only be called after calling SDL_CDStatus() to
126
get track information about the CD.
129
if ( CD_INDRIVE(SDL_CDStatus(cdrom)) )
130
SDL_CDPlayTracks(cdrom, 0, 0, 0, 0);
132
if ( CD_INDRIVE(SDL_CDStatus(cdrom)) ) {
133
SDL_CDPlayTracks(cdrom, cdrom->numtracks-1, 0, 0, 0);
135
// Play first and second track and 10 seconds of third track:
136
if ( CD_INDRIVE(SDL_CDStatus(cdrom)) )
137
SDL_CDPlayTracks(cdrom, 0, 0, 2, 10);
139
This function returns 0, or -1 if there was an error.
141
extern DECLSPEC int SDLCALL SDL_CDPlayTracks(SDL_CD *cdrom,
142
int start_track, int start_frame, int ntracks, int nframes);
144
/* Play the given CD starting at 'start' frame for 'length' frames.
145
It returns 0, or -1 if there was an error.
147
extern DECLSPEC int SDLCALL SDL_CDPlay(SDL_CD *cdrom, int start, int length);
149
/* Pause play -- returns 0, or -1 on error */
150
extern DECLSPEC int SDLCALL SDL_CDPause(SDL_CD *cdrom);
152
/* Resume play -- returns 0, or -1 on error */
153
extern DECLSPEC int SDLCALL SDL_CDResume(SDL_CD *cdrom);
155
/* Stop play -- returns 0, or -1 on error */
156
extern DECLSPEC int SDLCALL SDL_CDStop(SDL_CD *cdrom);
158
/* Eject CD-ROM -- returns 0, or -1 on error */
159
extern DECLSPEC int SDLCALL SDL_CDEject(SDL_CD *cdrom);
161
/* Closes the handle for the CD-ROM drive */
162
extern DECLSPEC void SDLCALL SDL_CDClose(SDL_CD *cdrom);
165
/* Ends C function definitions when using C++ */
169
#include "close_code.h"
171
#endif /* _SDL_video_h */
added
removed
source/include/SDL_cdrom.h
