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