2 * $Id: gdrom.h 662 2008-03-02 11:38:08Z nkeynes $
4 * This file defines the structures and functions used by the GD-Rom
5 * disc drivers. (ie, the modules that supply a CD image to be used by the
8 * Copyright (c) 2005 Nathan Keynes.
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
21 #ifndef lxdream_gdrom_driver_H
22 #define lxdream_gdrom_driver_H 1
26 #include "gdrom/gdrom.h"
27 #include <glib/gstrfuncs.h>
29 #define MAX_SECTOR_SIZE 2352
34 uint32_t first, last, leadout;
37 #define GDROM_PREGAP 150 /* Sectors */
39 extern uint32_t gdrom_sector_size[];
40 #define GDROM_SECTOR_SIZE(x) gdrom_sector_size[x]
42 * Track data type enumeration for cd images and devices. This somewhat
43 * conflates the real track mode with the format of the image file, but
44 * it manages to make sense so far.
47 GDROM_MODE0, // Mode 0 - should never actually see this
48 /* Data-only modes (image file contains only the user data) */
49 GDROM_MODE1, // Standard CD-Rom Mode 1 data track
50 GDROM_MODE2_FORMLESS, // Mode 2 data track with no sub-structure (rare)
51 GDROM_MODE2_FORM1, // Mode 2/Form 1 data track (standard for multisession)
52 GDROM_MODE2_FORM2, // Mode 2/Form 2 data track (also fairly uncommon).
53 GDROM_CDDA, // Standard audio track
55 /* This one is somewhat special - the image file contains the 2336 bytes of
56 * "extended user data", which in turn contains either a form 1 or form 2
57 * sector. In other words it's a raw mode2 XA sector without the 16-byte header.
60 /* Raw modes (image contains the full 2352-byte sector). Split into XA/Non-XA
61 * here for convenience, although it's really a session level flag. */
66 /* The disc register indicates the current contents of the drive. When open
69 #define IDE_DISC_READY 0x01 /* ored with above */
70 #define IDE_DISC_IDLE 0x02 /* ie spun-down */
71 #define IDE_DISC_NONE 0x06
73 #define IDE_DISC_AUDIO 0x00
74 #define IDE_DISC_CDROM 0x10
75 #define IDE_DISC_CDROMXA 0x20
76 #define IDE_DISC_GDROM 0x80
78 #define TRACK_PRE_EMPHASIS 0x10
79 #define TRACK_COPY_PERMITTED 0x20
80 #define TRACK_DATA 0x40
81 #define TRACK_FOUR_CHANNEL 0x80
83 typedef struct gdrom_track {
84 gdrom_track_mode_t mode;
85 uint8_t flags; /* Track flags */
86 int session; /* session # containing this track */
87 uint32_t lba; /* start sector address */
88 uint32_t sector_size; /* For convenience, determined by mode */
89 uint32_t sector_count;
90 uint32_t offset; /* File offset of start of track - image files only */
96 * Read a single sector from the disc at the specified logical address.
97 * @param disc pointer to the disc structure
98 * @param lba logical address to read from
99 * @param mode mode field from the read command
100 * @param buf buffer to receive data (at least MAX_SECTOR_SIZE bytes)
101 * @param length unsigned int to receive the number of bytes actually read.
102 * @return PKT_ERR_OK on success, or another PKT_ERR_* code on failure.
104 gdrom_error_t (*read_sector)( struct gdrom_disc *disc,
105 uint32_t lba, int mode,
106 unsigned char *buf, uint32_t *length );
109 * Read the TOC from the disc and write it into the specified buffer.
110 * The method is responsible for returning the data in gd-rom
112 * @param disc pointer to the disc structure
113 * @param buf buffer to receive data (0x198 bytes long)
115 gdrom_error_t (*read_toc)(struct gdrom_disc *disc, unsigned char *buf);
118 * Read the information for the specified sector and return it in the
120 * @param disc pointer to the disc structure
121 * @param session of interest. If 0, return end of disc information.
122 * @param buf buffer to receive data (6 bytes)
124 gdrom_error_t (*read_session)(struct gdrom_disc *disc, int session, unsigned char *buf);
127 * Read the position information (subchannel) for the specified sector
128 * and return it in the supplied buffer. This method does not need to
129 * write the first 4 bytes of the buffer.
130 * @param disc pointer to the disc structure
131 * @param lba sector to get position information for
132 * @param buf buffer to receive data (14 bytes)
134 gdrom_error_t (*read_position)(struct gdrom_disc *disc, uint32_t lba, unsigned char *buf);
137 * Return the current disc status, expressed as a combination of the
138 * IDE_DISC_* flags above.
139 * @param disc pointer to the disc structure
140 * @return an integer status value.
142 int (*drive_status)(struct gdrom_disc *disc);
145 * Begin playing audio from the given lba address on the disc.
147 gdrom_error_t (*play_audio)(struct gdrom_disc *disc, uint32_t lba, uint32_t endlba);
150 * Executed once per time slice to perform house-keeping operations
151 * (checking disc status, media changed, etc).
153 uint32_t (*run_time_slice)( struct gdrom_disc *disc, uint32_t nanosecs );
156 * Close the disc and release any storage or resources allocated including
157 * the disc structure itself.
159 void (*close)( struct gdrom_disc *disc );
160 const gchar *name; /* Device name / Image filename */
163 typedef struct gdrom_image {
164 struct gdrom_disc disc;
167 struct gdrom_track track[99];
168 gchar mcn[14]; /* Media catalogue number */
169 FILE *file; /* Open file stream */
175 typedef struct gdrom_image_class {
177 const gchar *extension;
178 gboolean (*is_valid_file)(FILE *f);
179 gdrom_disc_t (*open_image_file)(const gchar *filename, FILE *f);
180 } *gdrom_image_class_t;
182 extern struct gdrom_image_class nrg_image_class;
183 extern struct gdrom_image_class cdi_image_class;
184 extern struct gdrom_image_class gdi_image_class;
185 extern struct gdrom_image_class cdrom_device_class;
188 * Construct a new image file using the default methods.
190 gdrom_disc_t gdrom_image_new( const gchar *filename, FILE *f );
193 * Destroy an image data structure without closing the file
194 * (Intended for use from image loaders only)
196 void gdrom_image_destroy_no_close( gdrom_disc_t d );
200 * Given a base filename (eg for a .cue file), generate the path for the given
201 * find_name relative to the original file.
202 * @return a newly allocated string.
204 gchar *gdrom_get_relative_filename( const gchar *base_name, const gchar *find_name );
206 gdrom_device_t gdrom_device_new( const gchar *name, const gchar *dev_name );
208 void gdrom_device_destroy( gdrom_device_t dev );
.