comparison src/cdrom/SDL_syscdrom.h @ 0:74212992fb08

Initial revision
author Sam Lantinga <slouken@lokigames.com>
date Thu, 26 Apr 2001 16:45:43 +0000
parents
children e8157fcb3114
comparison
equal deleted inserted replaced
-1:000000000000 0:74212992fb08
1 /*
2 SDL - Simple DirectMedia Layer
3 Copyright (C) 1997, 1998, 1999, 2000, 2001 Sam Lantinga
4
5 This library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Library General Public
7 License as published by the Free Software Foundation; either
8 version 2 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 Library General Public License for more details.
14
15 You should have received a copy of the GNU Library General Public
16 License along with this library; if not, write to the Free
17 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
19 Sam Lantinga
20 slouken@devolution.com
21 */
22
23 #ifdef SAVE_RCSID
24 static char rcsid =
25 "@(#) $Id$";
26 #endif
27
28 /* This is the system specific header for the SDL CD-ROM API */
29
30 /* Structure of CD audio control functions */
31 extern struct CDcaps {
32 /* Get the name of the specified drive */
33 const char *(*Name)(int drive);
34
35 /* Open the specified drive, returning a drive id, or -1 on error */
36 int (*Open)(int drive);
37
38 /* Get table-of-contents (number of tracks + track info) for disk.
39 The TOC information should be stored in the cdrom structure.
40 This function should return 0 on success, or -1 on error.
41 */
42 int (*GetTOC)(SDL_CD *cdrom);
43
44 /* Return the current status and play position, in frames, of the
45 drive. 'position' may be NULL, and if so, should be ignored.
46 */
47 CDstatus (*Status)(SDL_CD *cdrom, int *position);
48
49 /* Play from frame 'start' to 'start+len' */
50 int (*Play)(SDL_CD *cdrom, int start, int len);
51
52 /* Pause play */
53 int (*Pause)(SDL_CD *cdrom);
54
55 /* Resume play */
56 int (*Resume)(SDL_CD *cdrom);
57
58 /* Stop play */
59 int (*Stop)(SDL_CD *cdrom);
60
61 /* Eject the current disk */
62 int (*Eject)(SDL_CD *cdrom);
63
64 /* Close the specified drive */
65 void (*Close)(SDL_CD *cdrom);
66 } SDL_CDcaps;
67
68 /* The number of available CD-ROM drives on the system */
69 extern int SDL_numcds;
70
71 /* Function to scan the system for CD-ROM drives and fill SDL_CDcaps.
72 * This function should set SDL_numcds to the number of available CD
73 * drives. Drive 0 should be the system default CD-ROM.
74 * It should return 0, or -1 on an unrecoverable fatal error.
75 */
76 extern int SDL_SYS_CDInit(void);
77
78 /* Function to perform any system-specific CD-ROM related cleanup */
79 extern void SDL_SYS_CDQuit(void);
80