nkeynes@125: /**
nkeynes@561:  * $Id$
nkeynes@125:  *
nkeynes@678:  * This file defines the public structures and functions exported by the 
nkeynes@678:  * GD-Rom subsystem
nkeynes@125:  *
nkeynes@125:  * Copyright (c) 2005 Nathan Keynes.
nkeynes@125:  *
nkeynes@125:  * This program is free software; you can redistribute it and/or modify
nkeynes@125:  * it under the terms of the GNU General Public License as published by
nkeynes@125:  * the Free Software Foundation; either version 2 of the License, or
nkeynes@125:  * (at your option) any later version.
nkeynes@125:  *
nkeynes@125:  * This program is distributed in the hope that it will be useful,
nkeynes@125:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
nkeynes@125:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
nkeynes@125:  * GNU General Public License for more details.
nkeynes@125:  */
nkeynes@125: 
nkeynes@678: #ifndef lxdream_gdrom_H
nkeynes@678: #define lxdream_gdrom_H 1
nkeynes@125: 
nkeynes@678: #include "lxdream.h"
nkeynes@678: #include "hook.h"
nkeynes@678: #include <glib/glist.h>
nkeynes@342: 
nkeynes@149: typedef uint16_t gdrom_error_t;
nkeynes@149: 
nkeynes@709: 
nkeynes@709: struct gdrom_device {
nkeynes@709:     char *name;  // internal name
nkeynes@709:     char *device_name; // Human-readable device name
nkeynes@709: };
nkeynes@709: 
nkeynes@709: typedef struct gdrom_device *gdrom_device_t;
nkeynes@709: 
nkeynes@678: typedef struct gdrom_disc *gdrom_disc_t;
nkeynes@138: 
nkeynes@678: typedef gboolean (*gdrom_disc_change_hook_t)( gdrom_disc_t new_disc, const gchar *new_disc_name, void *user_data );
nkeynes@138: 
nkeynes@678: DECLARE_HOOK(gdrom_disc_change_hook, gdrom_disc_change_hook_t);
nkeynes@125: 
nkeynes@138: /**
nkeynes@138:  * Open an image file
nkeynes@138:  */
nkeynes@138: gdrom_disc_t gdrom_image_open( const gchar *filename );
nkeynes@138: 
nkeynes@138: /**
nkeynes@422:  * Dump image info
nkeynes@422:  */
nkeynes@422: void gdrom_image_dump_info( gdrom_disc_t d );
nkeynes@422: 
nkeynes@245: 
nkeynes@138: /**
nkeynes@138:  * Shortcut to open and mount an image file
nkeynes@433:  * @return true on success
nkeynes@138:  */
nkeynes@433: gboolean gdrom_mount_image( const gchar *filename );
nkeynes@138: 
nkeynes@138: void gdrom_mount_disc( gdrom_disc_t disc );
nkeynes@138: 
nkeynes@138: void gdrom_unmount_disc( void );
nkeynes@138: 
nkeynes@138: gboolean gdrom_is_mounted( void );
nkeynes@138: 
nkeynes@464: gdrom_disc_t gdrom_get_current_disc();
nkeynes@464: 
nkeynes@678: const gchar *gdrom_get_current_disc_name();
nkeynes@678: 
nkeynes@138: uint32_t gdrom_read_sectors( uint32_t sector, uint32_t sector_count,
nkeynes@422: 			     int mode, unsigned char *buf, uint32_t *length );
nkeynes@125: 
nkeynes@678: 
nkeynes@613: /**
nkeynes@678:  * Retrieve the disc table of contents, and write it into the buffer in the 
nkeynes@678:  * format expected by the DC.
nkeynes@678:  * @return 0 on success, error code on failure (eg no disc mounted)
nkeynes@613:  */
nkeynes@678: gdrom_error_t gdrom_get_toc( unsigned char *buf );
nkeynes@678: 
nkeynes@678: /**
nkeynes@678:  * Retrieve the short (6-byte) session info, and write it into the buffer.
nkeynes@678:  * @return 0 on success, error code on failure.
nkeynes@678:  */
nkeynes@678: gdrom_error_t gdrom_get_info( unsigned char *buf, int session );
nkeynes@678: 
nkeynes@678: uint8_t gdrom_get_track_no_by_lba( uint32_t lba );
nkeynes@613: 
nkeynes@709: 
nkeynes@709: /**
nkeynes@709:  * Native CD-ROM API - provided by drivers/cd_*.c
nkeynes@709:  *
nkeynes@709:  * A device name is either a system special file (most unixes) or a url of the
nkeynes@709:  * form dvd://<identifier> or cd://<identifier>, where <identifier> is a system
nkeynes@709:  * defined string that uniquely identifies a particular device.
nkeynes@709:  */
nkeynes@709: 
nkeynes@709: /**
nkeynes@709:  * Return a list of gdrom_device_t defining all CD/DVD drives in the host system.
nkeynes@709:  */
nkeynes@709: GList *cdrom_get_native_devices();
nkeynes@709: 
nkeynes@709: /**
nkeynes@709:  * Open a native device given a device name and url method. Eg, for the url dvd://1
nkeynes@709:  * this function will be invoked with method = "dvd" and name = "1"
nkeynes@709:  * 
nkeynes@709:  * @return NULL on failure, otherwise a valid gdrom_disc_t that can be mounted.
nkeynes@709:  */
nkeynes@709: gdrom_disc_t cdrom_open_device( const gchar *method, const gchar *name );
nkeynes@709: 
nkeynes@125: #endif