Mercurial > sdl-ios-xcode
annotate include/SDL_cdrom.h @ 4315:d1c0ac95d023 SDL-1.2
Added missing caca files
| author | Sam Lantinga <slouken@libsdl.org> |
|---|---|
| date | Sat, 10 Oct 2009 10:17:51 +0000 |
| parents | 4c4113c2162c |
| children |
| rev | line source |
|---|---|
| 0 | 1 /* |
| 2 SDL - Simple DirectMedia Layer | |
| 4159 | 3 Copyright (C) 1997-2009 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 | |
| 4217 | 23 /** |
| 24 * @file SDL_cdrom.h | |
| 25 * This is the CD-audio control API for Simple DirectMedia Layer | |
| 26 */ | |
| 0 | 27 |
| 28 #ifndef _SDL_cdrom_h | |
| 29 #define _SDL_cdrom_h | |
| 30 | |
|
1353
7ba544e2888d
Started the process of improving configure support, and merging C types
Sam Lantinga <slouken@libsdl.org>
parents:
1312
diff
changeset
|
31 #include "SDL_stdinc.h" |
|
1358
c71e05b4dc2e
More header massaging... works great on Windows. ;-)
Sam Lantinga <slouken@libsdl.org>
parents:
1356
diff
changeset
|
32 #include "SDL_error.h" |
| 0 | 33 |
| 34 #include "begin_code.h" | |
| 35 /* Set up for C function definitions, even when using C++ */ | |
| 36 #ifdef __cplusplus | |
| 37 extern "C" { | |
| 38 #endif | |
| 39 | |
| 4217 | 40 /** |
| 41 * @file SDL_cdrom.h | |
| 42 * In order to use these functions, SDL_Init() must have been called | |
| 43 * with the SDL_INIT_CDROM flag. This causes SDL to scan the system | |
| 44 * for CD-ROM drives, and load appropriate drivers. | |
| 45 */ | |
| 0 | 46 |
| 4217 | 47 /** The maximum number of CD-ROM tracks on a disk */ |
| 0 | 48 #define SDL_MAX_TRACKS 99 |
| 49 | |
| 4217 | 50 /** @name Track Types |
| 51 * The types of CD-ROM track possible | |
| 52 */ | |
| 53 /*@{*/ | |
| 0 | 54 #define SDL_AUDIO_TRACK 0x00 |
| 55 #define SDL_DATA_TRACK 0x04 | |
| 4217 | 56 /*@}*/ |
| 0 | 57 |
| 4217 | 58 /** The possible states which a CD-ROM drive can be in. */ |
| 0 | 59 typedef enum { |
| 60 CD_TRAYEMPTY, | |
| 61 CD_STOPPED, | |
| 62 CD_PLAYING, | |
| 63 CD_PAUSED, | |
| 64 CD_ERROR = -1 | |
| 65 } CDstatus; | |
| 66 | |
| 4217 | 67 /** 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
|
68 #define CD_INDRIVE(status) ((int)(status) > 0) |
| 0 | 69 |
|
911
04a403e4ccf5
Date: Mon, 3 May 2004 03:15:01 +0100
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
70 typedef struct SDL_CDtrack { |
| 4217 | 71 Uint8 id; /**< Track number */ |
| 72 Uint8 type; /**< Data or audio track */ | |
| 0 | 73 Uint16 unused; |
| 4217 | 74 Uint32 length; /**< Length, in frames, of this track */ |
| 75 Uint32 offset; /**< Offset, in frames, from start of disk */ | |
| 0 | 76 } SDL_CDtrack; |
| 77 | |
| 4217 | 78 /** This structure is only current as of the last call to SDL_CDStatus() */ |
| 0 | 79 typedef struct SDL_CD { |
| 4217 | 80 int id; /**< Private drive identifier */ |
| 81 CDstatus status; /**< Current drive status */ | |
| 0 | 82 |
| 4217 | 83 /** The rest of this structure is only valid if there's a CD in drive */ |
| 84 /*@{*/ | |
| 85 int numtracks; /**< Number of tracks on disk */ | |
| 86 int cur_track; /**< Current track position */ | |
| 87 int cur_frame; /**< Current frame offset within current track */ | |
| 0 | 88 SDL_CDtrack track[SDL_MAX_TRACKS+1]; |
| 4217 | 89 /*@}*/ |
| 0 | 90 } SDL_CD; |
| 91 | |
| 4217 | 92 /** @name Frames / MSF Conversion Functions |
| 93 * Conversion functions from frames to Minute/Second/Frames and vice versa | |
| 94 */ | |
| 95 /*@{*/ | |
| 0 | 96 #define CD_FPS 75 |
| 97 #define FRAMES_TO_MSF(f, M,S,F) { \ | |
| 98 int value = f; \ | |
| 99 *(F) = value%CD_FPS; \ | |
| 100 value /= CD_FPS; \ | |
| 101 *(S) = value%60; \ | |
| 102 value /= 60; \ | |
| 103 *(M) = value; \ | |
| 104 } | |
| 105 #define MSF_TO_FRAMES(M, S, F) ((M)*60*CD_FPS+(S)*CD_FPS+(F)) | |
| 4217 | 106 /*@}*/ |
| 0 | 107 |
| 108 /* CD-audio API functions: */ | |
| 109 | |
| 4217 | 110 /** |
| 111 * Returns the number of CD-ROM drives on the system, or -1 if | |
| 112 * SDL_Init() has not been called with the SDL_INIT_CDROM flag. | |
| 0 | 113 */ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
114 extern DECLSPEC int SDLCALL SDL_CDNumDrives(void); |
| 0 | 115 |
| 4217 | 116 /** |
| 117 * Returns a human-readable, system-dependent identifier for the CD-ROM. | |
| 118 * Example: | |
| 119 * - "/dev/cdrom" | |
| 120 * - "E:" | |
| 121 * - "/dev/disk/ide/1/master" | |
| 122 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
123 extern DECLSPEC const char * SDLCALL SDL_CDName(int drive); |
| 0 | 124 |
| 4217 | 125 /** |
| 126 * Opens a CD-ROM drive for access. It returns a drive handle on success, | |
| 127 * or NULL if the drive was invalid or busy. This newly opened CD-ROM | |
| 128 * becomes the default CD used when other CD functions are passed a NULL | |
| 129 * CD-ROM handle. | |
| 130 * Drives are numbered starting with 0. Drive 0 is the system default CD-ROM. | |
| 131 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
132 extern DECLSPEC SDL_CD * SDLCALL SDL_CDOpen(int drive); |
| 0 | 133 |
| 4217 | 134 /** |
| 135 * This function returns the current status of the given drive. | |
| 136 * If the drive has a CD in it, the table of contents of the CD and current | |
| 137 * play position of the CD will be stored in the SDL_CD structure. | |
| 138 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
139 extern DECLSPEC CDstatus SDLCALL SDL_CDStatus(SDL_CD *cdrom); |
| 0 | 140 |
| 4217 | 141 /** |
| 142 * Play the given CD starting at 'start_track' and 'start_frame' for 'ntracks' | |
| 143 * tracks and 'nframes' frames. If both 'ntrack' and 'nframe' are 0, play | |
| 144 * until the end of the CD. This function will skip data tracks. | |
| 145 * This function should only be called after calling SDL_CDStatus() to | |
| 146 * get track information about the CD. | |
| 147 * For example: | |
| 148 * @code | |
| 149 * // Play entire CD: | |
| 150 * if ( CD_INDRIVE(SDL_CDStatus(cdrom)) ) | |
| 151 * SDL_CDPlayTracks(cdrom, 0, 0, 0, 0); | |
| 152 * // Play last track: | |
| 153 * if ( CD_INDRIVE(SDL_CDStatus(cdrom)) ) { | |
| 154 * SDL_CDPlayTracks(cdrom, cdrom->numtracks-1, 0, 0, 0); | |
| 155 * } | |
| 156 * // Play first and second track and 10 seconds of third track: | |
| 157 * if ( CD_INDRIVE(SDL_CDStatus(cdrom)) ) | |
| 158 * SDL_CDPlayTracks(cdrom, 0, 0, 2, 10); | |
| 159 * @endcode | |
| 160 * | |
| 161 * @return This function returns 0, or -1 if there was an error. | |
| 162 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
163 extern DECLSPEC int SDLCALL SDL_CDPlayTracks(SDL_CD *cdrom, |
| 0 | 164 int start_track, int start_frame, int ntracks, int nframes); |
| 165 | |
| 4217 | 166 /** |
| 167 * Play the given CD starting at 'start' frame for 'length' frames. | |
| 168 * @return It returns 0, or -1 if there was an error. | |
| 169 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
170 extern DECLSPEC int SDLCALL SDL_CDPlay(SDL_CD *cdrom, int start, int length); |
| 0 | 171 |
| 4217 | 172 /** Pause play |
| 173 * @return returns 0, or -1 on error | |
| 174 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
175 extern DECLSPEC int SDLCALL SDL_CDPause(SDL_CD *cdrom); |
| 0 | 176 |
| 4217 | 177 /** Resume play |
| 178 * @return returns 0, or -1 on error | |
| 179 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
180 extern DECLSPEC int SDLCALL SDL_CDResume(SDL_CD *cdrom); |
| 0 | 181 |
| 4217 | 182 /** Stop play |
| 183 * @return returns 0, or -1 on error | |
| 184 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
185 extern DECLSPEC int SDLCALL SDL_CDStop(SDL_CD *cdrom); |
| 0 | 186 |
| 4217 | 187 /** Eject CD-ROM |
| 188 * @return returns 0, or -1 on error | |
| 189 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
190 extern DECLSPEC int SDLCALL SDL_CDEject(SDL_CD *cdrom); |
| 0 | 191 |
| 4217 | 192 /** 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
|
193 extern DECLSPEC void SDLCALL SDL_CDClose(SDL_CD *cdrom); |
| 0 | 194 |
| 195 | |
| 196 /* Ends C function definitions when using C++ */ | |
| 197 #ifdef __cplusplus | |
| 198 } | |
| 199 #endif | |
| 200 #include "close_code.h" | |
| 201 | |
| 202 #endif /* _SDL_video_h */ |