Mercurial > sdl-ios-xcode
annotate include/SDL_cdrom.h @ 2589:1154ad945d94 gsoc2008_force_feedback
Fixed typo.
| author | Edgar Simo <bobbens@gmail.com> |
|---|---|
| date | Mon, 04 Aug 2008 17:09:45 +0000 |
| parents | c121d94672cb |
| children | 99210400e8b9 |
| rev | line source |
|---|---|
| 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 | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
23 /** |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
24 * \file SDL_cdrom.h |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
25 * |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
26 * This is the CD-audio control API for Simple DirectMedia Layer |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
27 */ |
| 0 | 28 |
| 29 #ifndef _SDL_cdrom_h | |
| 30 #define _SDL_cdrom_h | |
| 31 | |
|
1353
7ba544e2888d
Started the process of improving configure support, and merging C types
Sam Lantinga <slouken@libsdl.org>
parents:
1312
diff
changeset
|
32 #include "SDL_stdinc.h" |
|
1358
c71e05b4dc2e
More header massaging... works great on Windows. ;-)
Sam Lantinga <slouken@libsdl.org>
parents:
1356
diff
changeset
|
33 #include "SDL_error.h" |
| 0 | 34 |
| 35 #include "begin_code.h" | |
| 36 /* Set up for C function definitions, even when using C++ */ | |
| 37 #ifdef __cplusplus | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
38 /* *INDENT-OFF* */ |
| 0 | 39 extern "C" { |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
40 /* *INDENT-ON* */ |
| 0 | 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. */ | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
56 typedef enum |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
57 { |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
58 CD_TRAYEMPTY, |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
59 CD_STOPPED, |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
60 CD_PLAYING, |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
61 CD_PAUSED, |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
62 CD_ERROR = -1 |
| 0 | 63 } CDstatus; |
| 64 | |
| 65 /* 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
|
66 #define CD_INDRIVE(status) ((int)(status) > 0) |
| 0 | 67 |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
68 typedef struct SDL_CDtrack |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
69 { |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
70 Uint8 id; /* Track number */ |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
71 Uint8 type; /* Data or audio track */ |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
72 Uint16 unused; |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
73 Uint32 length; /* Length, in frames, of this track */ |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
74 Uint32 offset; /* Offset, in frames, from start of disk */ |
| 0 | 75 } SDL_CDtrack; |
| 76 | |
| 77 /* This structure is only current as of the last call to SDL_CDStatus() */ | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
78 typedef struct SDL_CD |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
79 { |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
80 int id; /* Private drive identifier */ |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
81 CDstatus status; /* Current drive status */ |
| 0 | 82 |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
83 /* The rest of this structure is only valid if there's a CD in drive */ |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
84 int numtracks; /* Number of tracks on disk */ |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
85 int cur_track; /* Current track position */ |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
86 int cur_frame; /* Current frame offset within current track */ |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
87 SDL_CDtrack track[SDL_MAX_TRACKS + 1]; |
| 0 | 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 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
107 extern DECLSPEC int SDLCALL SDL_CDNumDrives(void); |
| 0 | 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 */ | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
115 extern DECLSPEC const char *SDLCALL SDL_CDName(int drive); |
| 0 | 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 */ | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
123 extern DECLSPEC SDL_CD *SDLCALL SDL_CDOpen(int drive); |
| 0 | 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 */ | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
129 extern DECLSPEC CDstatus SDLCALL SDL_CDStatus(SDL_CD * cdrom); |
| 0 | 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 */ | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
150 extern DECLSPEC int SDLCALL SDL_CDPlayTracks(SDL_CD * cdrom, |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
151 int start_track, |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
152 int start_frame, int ntracks, |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
153 int nframes); |
| 0 | 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 */ | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
158 extern DECLSPEC int SDLCALL SDL_CDPlay(SDL_CD * cdrom, int start, int length); |
| 0 | 159 |
| 160 /* Pause play -- returns 0, or -1 on error */ | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
161 extern DECLSPEC int SDLCALL SDL_CDPause(SDL_CD * cdrom); |
| 0 | 162 |
| 163 /* Resume play -- returns 0, or -1 on error */ | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
164 extern DECLSPEC int SDLCALL SDL_CDResume(SDL_CD * cdrom); |
| 0 | 165 |
| 166 /* Stop play -- returns 0, or -1 on error */ | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
167 extern DECLSPEC int SDLCALL SDL_CDStop(SDL_CD * cdrom); |
| 0 | 168 |
| 169 /* Eject CD-ROM -- returns 0, or -1 on error */ | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
170 extern DECLSPEC int SDLCALL SDL_CDEject(SDL_CD * cdrom); |
| 0 | 171 |
| 172 /* Closes the handle for the CD-ROM drive */ | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
173 extern DECLSPEC void SDLCALL SDL_CDClose(SDL_CD * cdrom); |
| 0 | 174 |
| 175 | |
| 176 /* Ends C function definitions when using C++ */ | |
| 177 #ifdef __cplusplus | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
178 /* *INDENT-OFF* */ |
| 0 | 179 } |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
180 /* *INDENT-ON* */ |
| 0 | 181 #endif |
| 182 #include "close_code.h" | |
| 183 | |
| 184 #endif /* _SDL_video_h */ | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
185 |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
186 /* vi: set ts=4 sw=4 expandtab: */ |