author | Sam Lantinga <slouken@libsdl.org> |
Wed, 01 Feb 2006 06:32:25 +0000 | |
changeset 1312 | c9b51268668f |
parent 1046 | f09d5edfc7a3 |
child 1353 | 7ba544e2888d |
permissions | -rw-r--r-- |
0 | 1 |
/* |
2 |
SDL - Simple DirectMedia Layer |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1046
diff
changeset
|
3 |
Copyright (C) 1997-2006 Sam Lantinga |
0 | 4 |
|
5 |
This library is free software; you can redistribute it and/or |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1046
diff
changeset
|
6 |
modify it under the terms of the GNU Lesser General Public |
0 | 7 |
License as published by the Free Software Foundation; either |
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1046
diff
changeset
|
8 |
version 2.1 of the License, or (at your option) any later version. |
0 | 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 |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1046
diff
changeset
|
13 |
Lesser General Public License for more details. |
0 | 14 |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1046
diff
changeset
|
15 |
You should have received a copy of the GNU Lesser General Public |
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1046
diff
changeset
|
16 |
License along with this library; if not, write to the Free Software |
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1046
diff
changeset
|
17 |
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
0 | 18 |
|
19 |
Sam Lantinga |
|
251
b8688cfdc232
Updated the headers with the correct e-mail address
Sam Lantinga <slouken@libsdl.org>
parents:
0
diff
changeset
|
20 |
slouken@libsdl.org |
0 | 21 |
*/ |
22 |
||
23 |
/* This is the CD-audio control API for Simple DirectMedia Layer */ |
|
24 |
||
25 |
#ifndef _SDL_cdrom_h |
|
26 |
#define _SDL_cdrom_h |
|
27 |
||
28 |
#include "SDL_types.h" |
|
29 |
||
30 |
#include "begin_code.h" |
|
31 |
/* Set up for C function definitions, even when using C++ */ |
|
32 |
#ifdef __cplusplus |
|
33 |
extern "C" { |
|
34 |
#endif |
|
35 |
||
36 |
/* In order to use these functions, SDL_Init() must have been called |
|
37 |
with the SDL_INIT_CDROM flag. This causes SDL to scan the system |
|
38 |
for CD-ROM drives, and load appropriate drivers. |
|
39 |
*/ |
|
40 |
||
41 |
/* The maximum number of CD-ROM tracks on a disk */ |
|
42 |
#define SDL_MAX_TRACKS 99 |
|
43 |
||
44 |
/* The types of CD-ROM track possible */ |
|
45 |
#define SDL_AUDIO_TRACK 0x00 |
|
46 |
#define SDL_DATA_TRACK 0x04 |
|
47 |
||
48 |
/* The possible states which a CD-ROM drive can be in. */ |
|
49 |
typedef enum { |
|
50 |
CD_TRAYEMPTY, |
|
51 |
CD_STOPPED, |
|
52 |
CD_PLAYING, |
|
53 |
CD_PAUSED, |
|
54 |
CD_ERROR = -1 |
|
55 |
} CDstatus; |
|
56 |
||
57 |
/* Given a status, returns true if there's a disk in the drive */ |
|
1046
f09d5edfc7a3
Added some parentheses for a little more macro safety. Recommended by Petri
Ryan C. Gordon <icculus@icculus.org>
parents:
911
diff
changeset
|
58 |
#define CD_INDRIVE(status) ((int)(status) > 0) |
0 | 59 |
|
911
04a403e4ccf5
Date: Mon, 3 May 2004 03:15:01 +0100
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
60 |
typedef struct SDL_CDtrack { |
0 | 61 |
Uint8 id; /* Track number */ |
62 |
Uint8 type; /* Data or audio track */ |
|
63 |
Uint16 unused; |
|
64 |
Uint32 length; /* Length, in frames, of this track */ |
|
65 |
Uint32 offset; /* Offset, in frames, from start of disk */ |
|
66 |
} SDL_CDtrack; |
|
67 |
||
68 |
/* This structure is only current as of the last call to SDL_CDStatus() */ |
|
69 |
typedef struct SDL_CD { |
|
70 |
int id; /* Private drive identifier */ |
|
71 |
CDstatus status; /* Current drive status */ |
|
72 |
||
73 |
/* The rest of this structure is only valid if there's a CD in drive */ |
|
74 |
int numtracks; /* Number of tracks on disk */ |
|
75 |
int cur_track; /* Current track position */ |
|
76 |
int cur_frame; /* Current frame offset within current track */ |
|
77 |
SDL_CDtrack track[SDL_MAX_TRACKS+1]; |
|
78 |
} SDL_CD; |
|
79 |
||
80 |
/* Conversion functions from frames to Minute/Second/Frames and vice versa */ |
|
81 |
#define CD_FPS 75 |
|
82 |
#define FRAMES_TO_MSF(f, M,S,F) { \ |
|
83 |
int value = f; \ |
|
84 |
*(F) = value%CD_FPS; \ |
|
85 |
value /= CD_FPS; \ |
|
86 |
*(S) = value%60; \ |
|
87 |
value /= 60; \ |
|
88 |
*(M) = value; \ |
|
89 |
} |
|
90 |
#define MSF_TO_FRAMES(M, S, F) ((M)*60*CD_FPS+(S)*CD_FPS+(F)) |
|
91 |
||
92 |
/* CD-audio API functions: */ |
|
93 |
||
94 |
/* Returns the number of CD-ROM drives on the system, or -1 if |
|
95 |
SDL_Init() has not been called with the SDL_INIT_CDROM flag. |
|
96 |
*/ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
97 |
extern DECLSPEC int SDLCALL SDL_CDNumDrives(void); |
0 | 98 |
|
99 |
/* Returns a human-readable, system-dependent identifier for the CD-ROM. |
|
100 |
Example: |
|
101 |
"/dev/cdrom" |
|
102 |
"E:" |
|
103 |
"/dev/disk/ide/1/master" |
|
104 |
*/ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
105 |
extern DECLSPEC const char * SDLCALL SDL_CDName(int drive); |
0 | 106 |
|
107 |
/* Opens a CD-ROM drive for access. It returns a drive handle on success, |
|
108 |
or NULL if the drive was invalid or busy. This newly opened CD-ROM |
|
109 |
becomes the default CD used when other CD functions are passed a NULL |
|
110 |
CD-ROM handle. |
|
111 |
Drives are numbered starting with 0. Drive 0 is the system default CD-ROM. |
|
112 |
*/ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
113 |
extern DECLSPEC SDL_CD * SDLCALL SDL_CDOpen(int drive); |
0 | 114 |
|
115 |
/* This function returns the current status of the given drive. |
|
116 |
If the drive has a CD in it, the table of contents of the CD and current |
|
117 |
play position of the CD will be stored in the SDL_CD structure. |
|
118 |
*/ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
119 |
extern DECLSPEC CDstatus SDLCALL SDL_CDStatus(SDL_CD *cdrom); |
0 | 120 |
|
121 |
/* Play the given CD starting at 'start_track' and 'start_frame' for 'ntracks' |
|
122 |
tracks and 'nframes' frames. If both 'ntrack' and 'nframe' are 0, play |
|
123 |
until the end of the CD. This function will skip data tracks. |
|
124 |
This function should only be called after calling SDL_CDStatus() to |
|
125 |
get track information about the CD. |
|
126 |
For example: |
|
127 |
// Play entire CD: |
|
128 |
if ( CD_INDRIVE(SDL_CDStatus(cdrom)) ) |
|
129 |
SDL_CDPlayTracks(cdrom, 0, 0, 0, 0); |
|
130 |
// Play last track: |
|
131 |
if ( CD_INDRIVE(SDL_CDStatus(cdrom)) ) { |
|
132 |
SDL_CDPlayTracks(cdrom, cdrom->numtracks-1, 0, 0, 0); |
|
133 |
} |
|
134 |
// Play first and second track and 10 seconds of third track: |
|
135 |
if ( CD_INDRIVE(SDL_CDStatus(cdrom)) ) |
|
136 |
SDL_CDPlayTracks(cdrom, 0, 0, 2, 10); |
|
137 |
||
138 |
This function returns 0, or -1 if there was an error. |
|
139 |
*/ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
140 |
extern DECLSPEC int SDLCALL SDL_CDPlayTracks(SDL_CD *cdrom, |
0 | 141 |
int start_track, int start_frame, int ntracks, int nframes); |
142 |
||
143 |
/* Play the given CD starting at 'start' frame for 'length' frames. |
|
144 |
It returns 0, or -1 if there was an error. |
|
145 |
*/ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
146 |
extern DECLSPEC int SDLCALL SDL_CDPlay(SDL_CD *cdrom, int start, int length); |
0 | 147 |
|
148 |
/* Pause play -- returns 0, or -1 on error */ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
149 |
extern DECLSPEC int SDLCALL SDL_CDPause(SDL_CD *cdrom); |
0 | 150 |
|
151 |
/* Resume play -- returns 0, or -1 on error */ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
152 |
extern DECLSPEC int SDLCALL SDL_CDResume(SDL_CD *cdrom); |
0 | 153 |
|
154 |
/* Stop play -- returns 0, or -1 on error */ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
155 |
extern DECLSPEC int SDLCALL SDL_CDStop(SDL_CD *cdrom); |
0 | 156 |
|
157 |
/* Eject CD-ROM -- returns 0, or -1 on error */ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
158 |
extern DECLSPEC int SDLCALL SDL_CDEject(SDL_CD *cdrom); |
0 | 159 |
|
160 |
/* Closes the handle for the CD-ROM drive */ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
161 |
extern DECLSPEC void SDLCALL SDL_CDClose(SDL_CD *cdrom); |
0 | 162 |
|
163 |
||
164 |
/* Ends C function definitions when using C++ */ |
|
165 |
#ifdef __cplusplus |
|
166 |
} |
|
167 |
#endif |
|
168 |
#include "close_code.h" |
|
169 |
||
170 |
#endif /* _SDL_video_h */ |