Search
lxdream.org :: lxdream/src/gdrom/gdrom.h
lxdream 0.9.1
released Jun 29
Download Now
filename src/gdrom/gdrom.h
changeset 709:18c39a8e504c
prev678:35eb00945316
next720:b5594d1ac80a
author nkeynes
date Wed Jun 25 10:40:45 2008 +0000 (14 years ago)
permissions -rw-r--r--
last change Commit OSX CD-ROM driver work-in-progress
view annotate diff log raw
     1 /**
     2  * $Id$
     3  *
     4  * This file defines the public structures and functions exported by the 
     5  * GD-Rom subsystem
     6  *
     7  * Copyright (c) 2005 Nathan Keynes.
     8  *
     9  * This program is free software; you can redistribute it and/or modify
    10  * it under the terms of the GNU General Public License as published by
    11  * the Free Software Foundation; either version 2 of the License, or
    12  * (at your option) any later version.
    13  *
    14  * This program is distributed in the hope that it will be useful,
    15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
    16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    17  * GNU General Public License for more details.
    18  */
    20 #ifndef lxdream_gdrom_H
    21 #define lxdream_gdrom_H 1
    23 #include "lxdream.h"
    24 #include "hook.h"
    25 #include <glib/glist.h>
    27 typedef uint16_t gdrom_error_t;
    30 struct gdrom_device {
    31     char *name;  // internal name
    32     char *device_name; // Human-readable device name
    33 };
    35 typedef struct gdrom_device *gdrom_device_t;
    37 typedef struct gdrom_disc *gdrom_disc_t;
    39 typedef gboolean (*gdrom_disc_change_hook_t)( gdrom_disc_t new_disc, const gchar *new_disc_name, void *user_data );
    41 DECLARE_HOOK(gdrom_disc_change_hook, gdrom_disc_change_hook_t);
    43 /**
    44  * Open an image file
    45  */
    46 gdrom_disc_t gdrom_image_open( const gchar *filename );
    48 /**
    49  * Dump image info
    50  */
    51 void gdrom_image_dump_info( gdrom_disc_t d );
    54 /**
    55  * Shortcut to open and mount an image file
    56  * @return true on success
    57  */
    58 gboolean gdrom_mount_image( const gchar *filename );
    60 void gdrom_mount_disc( gdrom_disc_t disc );
    62 void gdrom_unmount_disc( void );
    64 gboolean gdrom_is_mounted( void );
    66 gdrom_disc_t gdrom_get_current_disc();
    68 const gchar *gdrom_get_current_disc_name();
    70 uint32_t gdrom_read_sectors( uint32_t sector, uint32_t sector_count,
    71 			     int mode, unsigned char *buf, uint32_t *length );
    74 /**
    75  * Retrieve the disc table of contents, and write it into the buffer in the 
    76  * format expected by the DC.
    77  * @return 0 on success, error code on failure (eg no disc mounted)
    78  */
    79 gdrom_error_t gdrom_get_toc( unsigned char *buf );
    81 /**
    82  * Retrieve the short (6-byte) session info, and write it into the buffer.
    83  * @return 0 on success, error code on failure.
    84  */
    85 gdrom_error_t gdrom_get_info( unsigned char *buf, int session );
    87 uint8_t gdrom_get_track_no_by_lba( uint32_t lba );
    90 /**
    91  * Native CD-ROM API - provided by drivers/cd_*.c
    92  *
    93  * A device name is either a system special file (most unixes) or a url of the
    94  * form dvd://<identifier> or cd://<identifier>, where <identifier> is a system
    95  * defined string that uniquely identifies a particular device.
    96  */
    98 /**
    99  * Return a list of gdrom_device_t defining all CD/DVD drives in the host system.
   100  */
   101 GList *cdrom_get_native_devices();
   103 /**
   104  * Open a native device given a device name and url method. Eg, for the url dvd://1
   105  * this function will be invoked with method = "dvd" and name = "1"
   106  * 
   107  * @return NULL on failure, otherwise a valid gdrom_disc_t that can be mounted.
   108  */
   109 gdrom_disc_t cdrom_open_device( const gchar *method, const gchar *name );
   111 #endif
.