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