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