src/cdrom/SDL_syscdrom.h
author Sam Lantinga <slouken@libsdl.org>
Sun, 29 Oct 2006 14:45:46 +0000
changeset 2063 dea73e1d07b0
parent 1978 542c78b6fb12
child 2859 99210400e8b9
permissions -rw-r--r--
Merged Ryan's fix, in case we need it later.
     1 /*
     2     SDL - Simple DirectMedia Layer
     3     Copyright (C) 1997-2006 Sam Lantinga
     4 
     5     This library is SDL_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 #include "SDL_config.h"
    23 
    24 /* This is the system specific header for the SDL CD-ROM API */
    25 
    26 /* Structure of CD audio control functions */
    27 extern struct CDcaps
    28 {
    29     /* Get the name of the specified drive */
    30     const char *(*Name) (int drive);
    31 
    32     /* Open the specified drive, returning a drive id, or -1 on error */
    33     int (*Open) (int drive);
    34 
    35     /* Get table-of-contents (number of tracks + track info) for disk.
    36        The TOC information should be stored in the cdrom structure.
    37        This function should return 0 on success, or -1 on error.
    38      */
    39     int (*GetTOC) (SDL_CD * cdrom);
    40 
    41     /* Return the current status and play position, in frames, of the
    42        drive.  'position' may be NULL, and if so, should be ignored.
    43      */
    44       CDstatus(*Status) (SDL_CD * cdrom, int *position);
    45 
    46     /* Play from frame 'start' to 'start+len' */
    47     int (*Play) (SDL_CD * cdrom, int start, int len);
    48 
    49     /* Pause play */
    50     int (*Pause) (SDL_CD * cdrom);
    51 
    52     /* Resume play */
    53     int (*Resume) (SDL_CD * cdrom);
    54 
    55     /* Stop play */
    56     int (*Stop) (SDL_CD * cdrom);
    57 
    58     /* Eject the current disk */
    59     int (*Eject) (SDL_CD * cdrom);
    60 
    61     /* Close the specified drive */
    62     void (*Close) (SDL_CD * cdrom);
    63 } SDL_CDcaps;
    64 
    65 /* The number of available CD-ROM drives on the system */
    66 extern int SDL_numcds;
    67 
    68 /* Function to scan the system for CD-ROM drives and fill SDL_CDcaps.
    69  * This function should set SDL_numcds to the number of available CD
    70  * drives.  Drive 0 should be the system default CD-ROM.
    71  * It should return 0, or -1 on an unrecoverable fatal error.
    72 */
    73 extern int SDL_SYS_CDInit(void);
    74 
    75 /* Function to perform any system-specific CD-ROM related cleanup */
    76 extern void SDL_SYS_CDQuit(void);
    77 
    78 /* vi: set ts=4 sw=4 expandtab: */