diff 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
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/cdrom/SDL_syscdrom.h	Thu Apr 26 16:45:43 2001 +0000
@@ -0,0 +1,80 @@
+/*
+    SDL - Simple DirectMedia Layer
+    Copyright (C) 1997, 1998, 1999, 2000, 2001  Sam Lantinga
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Library General Public
+    License as published by the Free Software Foundation; either
+    version 2 of the License, or (at your option) any later version.
+
+    This library is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    Library General Public License for more details.
+
+    You should have received a copy of the GNU Library General Public
+    License along with this library; if not, write to the Free
+    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+    Sam Lantinga
+    slouken@devolution.com
+*/
+
+#ifdef SAVE_RCSID
+static char rcsid =
+ "@(#) $Id$";
+#endif
+
+/* This is the system specific header for the SDL CD-ROM API */
+
+/* Structure of CD audio control functions */
+extern struct CDcaps {
+	/* Get the name of the specified drive */
+	const char *(*Name)(int drive);
+
+	/* Open the specified drive, returning a drive id, or -1 on error */
+	int (*Open)(int drive);
+
+	/* Get table-of-contents (number of tracks + track info) for disk.
+	   The TOC information should be stored in the cdrom structure.
+	   This function should return 0 on success, or -1 on error.
+	 */
+	int (*GetTOC)(SDL_CD *cdrom);
+
+	/* Return the current status and play position, in frames, of the
+	   drive.  'position' may be NULL, and if so, should be ignored.
+	 */
+	CDstatus (*Status)(SDL_CD *cdrom, int *position);
+
+	/* Play from frame 'start' to 'start+len' */
+	int (*Play)(SDL_CD *cdrom, int start, int len); 
+
+	/* Pause play */
+	int (*Pause)(SDL_CD *cdrom);
+
+	/* Resume play */
+	int (*Resume)(SDL_CD *cdrom);
+
+	/* Stop play */
+	int (*Stop)(SDL_CD *cdrom);
+
+	/* Eject the current disk */
+	int (*Eject)(SDL_CD *cdrom);
+
+	/* Close the specified drive */
+	void (*Close)(SDL_CD *cdrom);
+} SDL_CDcaps;
+
+/* The number of available CD-ROM drives on the system */
+extern int SDL_numcds;
+
+/* Function to scan the system for CD-ROM drives and fill SDL_CDcaps.
+ * This function should set SDL_numcds to the number of available CD
+ * drives.  Drive 0 should be the system default CD-ROM.
+ * It should return 0, or -1 on an unrecoverable fatal error.
+*/
+extern int  SDL_SYS_CDInit(void);
+
+/* Function to perform any system-specific CD-ROM related cleanup */
+extern void SDL_SYS_CDQuit(void);
+