src/cdrom/SDL_syscdrom.h
author Sam Lantinga <slouken@libsdl.org>
Wed, 01 Feb 2006 06:32:25 +0000
changeset 1312 c9b51268668f
parent 769 b8d311d90021
child 1336 3692456e7b0f
permissions -rw-r--r--
Updated copyright information and removed rcs id lines (problematic in branch merges)
I batch edited these files, so please let me know if I've accidentally removed anybody's
credit here.
     1 /*
     2     SDL - Simple DirectMedia Layer
     3     Copyright (C) 1997-2006 Sam Lantinga
     4 
     5     This library is free software; you can redistribute it and/or
     6     modify it under the terms of the GNU Lesser General Public
     7     License as published by the Free Software Foundation; either
     8     version 2.1 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     Lesser General Public License for more details.
    14 
    15     You should have received a copy of the GNU Lesser General Public
    16     License along with this library; if not, write to the Free Software
    17     Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
    18 
    19     Sam Lantinga
    20     slouken@libsdl.org
    21 */
    22 
    23 /* This is the system specific header for the SDL CD-ROM API */
    24 
    25 /* Structure of CD audio control functions */
    26 extern struct CDcaps {
    27 	/* Get the name of the specified drive */
    28 	const char *(*Name)(int drive);
    29 
    30 	/* Open the specified drive, returning a drive id, or -1 on error */
    31 	int (*Open)(int drive);
    32 
    33 	/* Get table-of-contents (number of tracks + track info) for disk.
    34 	   The TOC information should be stored in the cdrom structure.
    35 	   This function should return 0 on success, or -1 on error.
    36 	 */
    37 	int (*GetTOC)(SDL_CD *cdrom);
    38 
    39 	/* Return the current status and play position, in frames, of the
    40 	   drive.  'position' may be NULL, and if so, should be ignored.
    41 	 */
    42 	CDstatus (*Status)(SDL_CD *cdrom, int *position);
    43 
    44 	/* Play from frame 'start' to 'start+len' */
    45 	int (*Play)(SDL_CD *cdrom, int start, int len); 
    46 
    47 	/* Pause play */
    48 	int (*Pause)(SDL_CD *cdrom);
    49 
    50 	/* Resume play */
    51 	int (*Resume)(SDL_CD *cdrom);
    52 
    53 	/* Stop play */
    54 	int (*Stop)(SDL_CD *cdrom);
    55 
    56 	/* Eject the current disk */
    57 	int (*Eject)(SDL_CD *cdrom);
    58 
    59 	/* Close the specified drive */
    60 	void (*Close)(SDL_CD *cdrom);
    61 } SDL_CDcaps;
    62 
    63 /* The number of available CD-ROM drives on the system */
    64 extern int SDL_numcds;
    65 
    66 /* Function to scan the system for CD-ROM drives and fill SDL_CDcaps.
    67  * This function should set SDL_numcds to the number of available CD
    68  * drives.  Drive 0 should be the system default CD-ROM.
    69  * It should return 0, or -1 on an unrecoverable fatal error.
    70 */
    71 extern int  SDL_SYS_CDInit(void);
    72 
    73 /* Function to perform any system-specific CD-ROM related cleanup */
    74 extern void SDL_SYS_CDQuit(void);
    75